FillablePdf

Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file lib/fillable_pdf. To experiment with that code, run bin/console for an interactive prompt.

Development is in progress

Installation

Add this line to your application's Gemfile:

gem 'fillable_pdf'

And then execute:

$ bundle

Or install it yourself as:

$ gem install fillable_pdf

Usage

class ContractPdf < FillablePdf::Document
  attr_reader :customer

  def initialize(customer)
    @customer = customer
    super(File.joins('/path/to/template'))
    fill_out(data)
  end

  protected

  def data
    {
      last_name:  customer.last_name,
      first_name: customer.first_name,
      address:    customer.address
    }
  end
end

@customer     = User::Customer.find(20)
@contract_pdf = ContractPdf.new(@customer)

@contract_pdf.write # => tempfile
@contract_pdf.read  # => file blob

  document = FillablePdf::Document.new('/path/to/template')

  document.fill :first_name, 'John'
  document.fill :last_name, 'Smith'
  # OR
  document.fill_out { first_name: 'John', last_name: 'Smith' }

  document.write # => return tempfile
  document.read # => return file blob

TODO: Write usage instructions here

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]/fillable_pdf. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant 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 FillablePdf project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.