DocxReplacor

An ruby library extending docx gem's #substitute method. You can use %variable% declare a replacable text.

Installation

Add this line to your application's Gemfile:

gem 'docx_replacor'

And then execute:

$ bundle install

Or install it yourself as:

$ gem install docx_replacor

Usage

require 'docx'

# Create a DocxReplacor::Document object for our existing docx file
doc = DocxReplacor::Document.open('example.docx')

# get all the text in the document
doc.document_texts

# check if there are replacable variables in the document (returns an array of matched variables)
doc.match([:variable])

#replace the declared variables in the document
doc.substitute({name: "Jus Portal", profession: "Writer"})

Development

After checking out the repo, run bin/setup to install dependencies. Then, run rake spec to run the tests. You can also run bin/console for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run bundle exec rake install. To release a new version, update the version number in version.rb, and then run bundle exec rake release, which will create a git tag for the version, push git commits and tags, and push the .gem file to rubygems.org.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/docx_replacor. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the code of conduct.

License

The gem is available as open source under the terms of the MIT License.

Code of Conduct

Everyone interacting in the DocxReplacor project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.