fillable-pdf 0.8.0 → 0.9.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d5ab7087bc8f229f961c0da0082be323be426d8ec7ab4b2393f40bc802f4d43a
-  data.tar.gz: bb1470fd017ec78765c4fe4885ab946bd94167e01c28b7768d0fcca7e490729a
+  metadata.gz: 7043c6e7b7149563d54e87952727cbd2b769d7ab6cbdf6eebfbea91c89e0e6f8
+  data.tar.gz: cad339bef276e6baf84473ff4e496b9e44e2a0ea487262850e27954cc29a4df4
 SHA512:
-  metadata.gz: '0058f8ca36432a67568682669156536accd1da68bf345617289ac0b1defab458f6f47ab69ebc08ea872d60ad5573e8fab743904e8bbb71620eff25c4511a727a'
-  data.tar.gz: b77167e17b342c26e3e0003ab468016947e06567f042aef227175bfa368dc062728803347fc75565a81c871fde4a2a0807d1f3bf35e28a773477ea26022a893b
+  metadata.gz: f5df81f03db25731784a1c16d132d0d08366a60e02374c1c4d16a1611a45520270d5f91c4fb1fa351a1f05f1d2881400e5cf304c2965063b9fc71cbce617edf2
+  data.tar.gz: 7cedf3ff9e49d09c7d3fc4467baa5ec7f8bf2761bc247dd03b70d0e620cba5d121aedf33e725e8a79088f601ec77282c491447ae5f149d01c316f70bbc7df60f

data/.rubocop.yml

@@ -1,21 +1,45 @@
 require:
+  - rubocop-md
+  - rubocop-minitest
   - rubocop-performance
+  - rubocop-rake
 
 AllCops:
+  NewCops: enable
   Exclude:
     - .git/**/*
+    - vendor/bundle/**/*
+
+Gemspec/RequiredRubyVersion:
+  Enabled: false
 
 Layout/EmptyLineAfterGuardClause:
   Enabled: false
 
+Layout/IndentationConsistency:
+  Exclude:
+    - README.md
+
+Layout/InitialIndentation:
+  Exclude:
+    - README.md
+
 Layout/LineLength:
   Exclude:
+    - README.md
     - fillable-pdf.gemspec
   Max: 120
 
 Layout/SpaceInsideHashLiteralBraces:
   Enabled: false
 
+Lint/ConstantDefinitionInBlock:
+  Exclude:
+    - lib/fillable-pdf/itext.rb
+
+Metrics/MethodLength:
+  Max: 12
+
 Naming/AccessorMethodName:
   Enabled: false
 

data/.travis.yml

@@ -3,8 +3,8 @@ sudo: false
 language: ruby
 cache: bundler
 rvm:
-  - 2.6.4
+  - 3.0.3
 jdk:
   - openjdk8
 before_install:
-  - gem install bundler -v 2.0.2
+  - gem install bundler

data/{LICENSE.txt → LICENSE.md}

@@ -1,3 +1,7 @@
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+
+However, you must also adhere to the [iText License](https://github.com/itext/itext7) when using this gem in your project.
+
 The MIT License (MIT)
 
 Copyright (c) 2016 Vadim Kononov

data/README.md

@@ -2,28 +2,108 @@
 # FillablePDF
 
 [![Gem Version](https://badge.fury.io/rb/fillable-pdf.svg)](https://rubygems.org/gems/fillable-pdf)
-[![Build Status](https://api.travis-ci.org/vkononov/fillable-pdf.svg?branch=master)](http://travis-ci.org/vkononov/fillable-pdf)
+[![Build Status](https://app.travis-ci.com/vkononov/fillable-pdf.svg?branch=master)](http://travis-ci.org/vkononov/fillable-pdf)
+
+FillablePDF is an extremely simple and lightweight utility that bridges iText and Ruby in order to fill out fillable PDF forms or extract field values from previously filled out PDF forms.
+
+
+## Known Issues
+
+1. This gem currently does not work with Phusion Passenger's [smart spawning](https://www.phusionpassenger.com/library/indepth/ruby/spawn_methods/#the-smart-spawning-method). Please see [Deployment with Phusion Passenger + Nginx](#deployment-with-phusion-passenger--nginx) for more information.
+
+2. If the gem hangs in `development`, removing the following gems may fix the issue:
+
+    ```ruby
+    gem 'spring'
+    gem 'spring-watcher-listen'
+    ```
+
+3. Read-only, write-protected or encrypted PDF files are currently not supported.
+
+## Deployment with Heroku
+
+When deploying to Heroku, be sure to install the following build packs (in this order):
+
+```bash
+heroku buildpacks:add heroku/jvm
+heroku buildpacks:add heroku/ruby
+```
+
+## Deployment with Phusion Passenger + Nginx
+
+The way the gem is currently built makes it [fundamentally incompatible](https://github.com/phusion/passenger/issues/223#issuecomment-44504029) with Phusion Passenger's [smart spawning](https://www.phusionpassenger.com/library/indepth/ruby/spawn_methods/#the-smart-spawning-method). You must turn off smart spawning, or else your application will freeze as soon Ruby tries to access the Java bridge.
+
+Below is an example of a simple Nginx virtual host configuration (note the use of `passenger_spawn_method`):
+
+```nginx
+server {
+    server_name my-rails-app.com;
+    listen 443 ssl http2;
+    listen [::]:443 ssl http2;
+    passenger_enabled on;
+    passenger_spawn_method direct;
+    root /home/system/my-rails-app/public;
+}
+```
+
+If you absolutely must have smart spawning, I recommend using `fillable-pdf` as a service that runs independently of your Rails application.
+
+
+## Deployment with Puma + Nginx
+
+In order to use Puma in production, you need to configure a reverse proxy in your Nginx virtual host. Here is simple naive example:
+
+```nginx
+server {
+    server_name my-rails-app.com;
+    listen 443 ssl http2;
+    listen [::]:443 ssl http2;
+    location / {
+        proxy_pass http://127.0.0.1:8888;
+        proxy_redirect off;
+        proxy_set_header Connection "upgrade";
+        proxy_set_header Host $http_host;
+        proxy_set_header Upgrade $http_upgrade;
+        proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
+        proxy_set_header X-Forwarded-Proto https;
+        proxy_set_header X-Real-IP $remote_addr;
+    }
+}
+```
+
+Then you'll have to start Puma in production daemon mode as follows:
+
+```bash
+RAILS_ENV=production bin/rails server -p 8888 --daemon
+```
+
+Naturally, there are many downsides (in terms of efficiency, scalability, security, etc) to running your application in production in this manner, so please use the above as an example only.
 
-FillablePDF is an extremely simple and lightweight utility that bridges iText and Ruby in order to fill out fillable PDF forms or extract field values from previously filled out PDF forms. 
 
 ## Installation
 
 **Ensure that your `JAVA_HOME` variable is set before installing this gem (see examples below).**
- 
-* OSX: `/Library/Java/JavaVirtualMachines/jdk-12.0.2.jdk/Contents/Home`  
+
+* OSX: `/Library/Java/JavaVirtualMachines/jdk-12.0.2.jdk/Contents/Home`
 * Ubuntu/CentOS: `/usr/lib/jvm/java-1.8.0-openjdk`
 
 Add this line to your application's Gemfile:
 
-    gem 'fillable-pdf'
+```ruby
+gem 'fillable-pdf'
+```
 
 And then execute:
 
-    bundle
+```bash
+bundle
+```
 
 Or install it yourself as:
 
-    gem install fillable-pdf
+```bash
+gem install fillable-pdf
+```
 
 If you are using this gem in a script, you need to require it manually:
 
@@ -45,127 +125,197 @@ pdf = FillablePDF.new 'input.pdf'
 pdf.close
 ```
 
-## Instance Methods
+### Checking / Unchecking Checkboxes
+
+Use the values `'Yes'` and `'Off'` to check and uncheck checkboxes, respectively. For example:
+
+```ruby
+pdf.set_field(:newsletter, 'Yes')
+pdf.set_field(:newsletter, 'Off')
+```
+
+### Checking / Unchecking Radio Buttons
+
+Suppose you have the following a radio button field name `language` with the following options:
+
+  - Ruby (`ruby`)
+  - Python (`python`)
+  - Dart (`dart`)
+  - Other (`other`)
+
+To select one of these options (or change the current option) use:
+
+```ruby
+pdf.set_field(:language, 'dart')
+```
+
+To unset the radio button use the `'Off'` string:
+
+```ruby
+pdf.set_field(:language, 'Off')
+```
+
+### Adding Signatures or Images
+
+Digital signatures are not supported, but you can place an image or a base64 encoded image within the bounds of any form field.
+
+SVG images are not supported. You will have to convert them to a JPG or PNG first.
+
+See methods `set_image` and `set_image_base64` below.
+
+### Instance Methods
 
 An instance of `FillablePDF` has the following methods at its disposal:
 
 * `any_fields?`
-	*Determines whether the form has any fields.*
-	```ruby
-	pdf.any_fields?
-	# output example: true
-	```
+    *Determines whether the form has any fields.*
+
+    ```ruby
+    pdf.any_fields?
+    # output example: true
+    ```
 
 * `num_fields`
-	*Returns the total number of fillable form fields.*
-	```ruby
-	# output example: 10
-	pdf.num_fields
-	```
+    *Returns the total number of fillable form fields.*
+
+    ```ruby
+    # output example: 10
+    pdf.num_fields
+    ```
 
 * `field`
-	*Retrieves the value of a field given its unique field name.*
-	```ruby
-	pdf.field(:full_name)
-	# output example: 'Richard'
-	```
+    *Retrieves the value of a field given its unique field name.*
+
+    ```ruby
+    pdf.field(:full_name)
+    # output example: 'Richard'
+    ```
 
 * `field_type`
-	*Retrieves the numeric type of a field given its unique field name.*
-	```ruby
-	pdf.field_type(:football)
-	# output example: 4
-
-	# list of all field types
-	Field::BUTTON
-	Field::CHOICE
-	Field::SIGNATURE
-	Field::TEXT
-	```
+    *Retrieves the numeric type of a field given its unique field name.*
+
+    ```ruby
+    pdf.field_type(:football)
+    # output example: '/Btn'
+
+    # list of all field types
+    Field::BUTTON ('/Btn')
+    Field::CHOICE ('/Ch')
+    Field::SIGNATURE ('/Sig')
+    Field::TEXT ('/Tx')
+    ```
 
 * `fields`
-	*Retrieves a hash of all fields and their values.*
-	```ruby
-	pdf.fields
-	# output example: {first_name: "Richard", last_name: "Rahl"}
-	```
+    *Retrieves a hash of all fields and their values.*
+
+    ```ruby
+    pdf.fields
+    # output example: {first_name: "Richard", last_name: "Rahl"}
+    ```
 
 * `set_field`
-	*Sets the value of a field given its unique field name and value.*
-	```ruby
-	pdf.set_field(:first_name, 'Richard')
-	# result: changes the value of 'first_name' to 'Richard'
-	```
+    *Sets the value of a field given its unique field name and value.*
+
+    ```ruby
+    pdf.set_field(:first_name, 'Richard')
+    # result: changes the value of 'first_name' to 'Richard'
+    ```
 
 * `set_fields`
-	*Sets the values of multiple fields given a set of unique field names and values.*
-	```ruby
-	pdf.set_fields(first_name: 'Richard', last_name: 'Rahl')
-	# result: changes the values of 'first_name' and 'last_name'
-	```
+    *Sets the values of multiple fields given a set of unique field names and values.*
+
+    ```ruby
+    pdf.set_fields(first_name: 'Richard', last_name: 'Rahl')
+    # result: changes the values of 'first_name' and 'last_name'
+    ```
+
+* `set_image`
+  *Places an image file within the rectangular bounding box of the given form field.*
+
+    ```ruby
+    pdf.set_image(:signature, 'signature.png')
+    # result: the image 'signature.png' is shown in the foreground of the form field
+    ```
+
+* `set_image_base64`
+  *Places a base64 encoded image within the rectangular bounding box of the given form field.*
+
+    ```ruby
+    pdf.set_image_base64(:signature, 'iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAADUlEQVR42mNk+M9QDwADhgGAWjR9awAAAABJRU5ErkJggg==')
+    # result: the base64 encoded image is shown in the foreground of the form field
+    ```
 
 * `rename_field`
-	*Renames a field given its unique field name and the new field name.*
-	```ruby
-	pdf.rename_field(:last_name, :surname)
-	# result: renames field name 'last_name' to 'surname'
-	# NOTE: this action does not take effect until the document is saved 
-	```
+    *Renames a field given its unique field name and the new field name.*
+
+    ```ruby
+    pdf.rename_field(:last_name, :surname)
+    # result: renames field name 'last_name' to 'surname'
+    # NOTE: this action does not take effect until the document is saved
+    ```
 
 * `remove_field`
-	*Removes a field from the document given its unique field name.*
-	```ruby
-	pdf.remove_field(:last_name)
-	# result: physically removes field 'last_name' from document
-	```
+    *Removes a field from the document given its unique field name.*
+
+    ```ruby
+    pdf.remove_field(:last_name)
+    # result: physically removes field 'last_name' from document
+    ```
 
 * `names`
-	*Returns a list of all field keys used in the document.*
-	```ruby
-	pdf.names
-	# output example: [:first_name, :last_name]
-	```
+    *Returns a list of all field keys used in the document.*
+
+    ```ruby
+    pdf.names
+    # output example: [:first_name, :last_name]
+    ```
 
 * `values`
-	*Returns a list of all field values used in the document.*
-	```ruby
-	pdf.values
-	# output example: ["Rahl", "Richard"]
-	```
+    *Returns a list of all field values used in the document.*
+
+    ```ruby
+    pdf.values
+    # output example: ["Rahl", "Richard"]
+    ```
 
 * `save`
-	*Overwrites the previously opened PDF document and flattens it if requested.*
-	```ruby
-	pdf.save
-	# result: document is saved without flatenning
-	pdf.save_as(flatten: true)
-	# result: document is saved with flatenning
-	```
+    *Overwrites the previously opened PDF document and flattens it if requested.*
+
+    ```ruby
+    pdf.save
+    # result: document is saved without flattening
+    pdf.save_as(flatten: true)
+    # result: document is saved with flattening
+    ```
 
 * `save_as`
-	*Saves the filled out PDF document in a given path and flattens it if requested.*
-	```ruby
-	pdf.save_as('output.pdf')
-	# result: document is saved in a given path without flatenning
-	pdf.save_as('output.pdf', flatten: true)
-	# result: document is saved in a given path with flatenning
-	```
+    *Saves the filled out PDF document in a given path and flattens it if requested.*
 
-	**NOTE:** Saving the file automatically closes the input file, so you would need to reinitialize the `FillabePDF` class before making any more changes or saving another copy. 
+    ```ruby
+    pdf.save_as('output.pdf')
+    # result: document is saved in a given path without flattening
+    pdf.save_as('output.pdf', flatten: true)
+    # result: document is saved in a given path with flattening
+    ```
+
+    **NOTE:** Saving the file automatically closes the input file, so you would need to reinitialize the `FillabePDF` class before making any more changes or saving another copy.
 
 * `close`
-	*Closes the PDF document discarding all unsaved changes.*
-	```ruby
-	pdf.close
-	# result: document is closed
-	```
+    *Closes the PDF document discarding all unsaved changes.*
+
+    ```ruby
+    pdf.close
+    # result: document is closed
+    ```
 
 ## Example
 
-The following example [example.rb](example/run.rb) and the input file [input.pdf](example/input.pdf) are located in the `test` directory. It uses all of the methods that are described above and generates the output files [output.pdf](example/output.pdf) and [output.flat.pdf](example/output.flat.pdf).
+The following [example.rb](example/run.rb) with [input.pdf](example/input.pdf) is located in the [example](example) directory. It uses all of the methods that are described above and generates the output files [output.pdf](example/output.pdf) and [output.flat.pdf](example/output.flat.pdf).
 
 ```ruby
-require 'fillable-pdf'
+require_relative '../lib/fillable-pdf'
+
+BASE64_PHOTO = 'iVBORw0KGgoAAAANSUhEUgAAAAUAAAAFCAYAAACNbyblAAAAHElEQVQI12P4//8/w38GIAXDIBKE0DHxgljNBAAO9TXL0Y4OHwAAAABJRU5ErkJggg==' # rubocop:disable Layout/LineLength
 
 # opening a fillable PDF
 pdf = FillablePDF.new('input.pdf')
@@ -181,9 +331,12 @@ puts
 
 # setting form fields
 pdf.set_fields(first_name: 'Richard', last_name: 'Rahl')
-pdf.set_fields(football: 'Yes', baseball: 'Yes',
-               basketball: 'Yes', nascar: 'Yes', hockey: 'Yes')
+pdf.set_fields(football: 'Yes', baseball: 'Yes', basketball: 'Yes', nascar: 'Yes', hockey: 'Yes')
 pdf.set_field(:date, Time.now.strftime('%B %e, %Y'))
+pdf.set_field(:newsletter, 'Off') # uncheck the checkbox
+pdf.set_field(:language, 'dart') # select a radio button option
+pdf.set_image_base64(:photo, BASE64_PHOTO)
+pdf.set_image(:signature, 'signature.png')
 
 # list of fields
 puts "Fields hash: #{pdf.fields}"
@@ -218,10 +371,6 @@ puts
 # Removing field
 pdf.remove_field :nascar
 puts "Removed field 'nascar'"
-puts
-
-# printing the name of the person used inside the PDF
-puts "Signatory: #{pdf.field(:first_name)} #{pdf.field(:last_name)}"
 
 # saving the filled out PDF in another file
 pdf.save_as('output.pdf')
@@ -236,22 +385,20 @@ pdf.close
 
 The example above produces the following output and also generates the output file [output.pdf](example/output.pdf).
 
-```
-The form has a total of 8 fields.
+```text
+The form has a total of 16 fields.
 
-Fields hash: {:last_name=>"Rahl", :first_name=>"Richard", :football=>"Yes", :baseball=>"Yes", :basketball=>"Yes", :nascar=>"Yes", :hockey=>"Yes", :date=>"August 30, 2019"}
+Fields hash: {:last_name=>"Rahl", :first_name=>"Richard", :football=>"Yes", :baseball=>"Yes", :basketball=>"Yes", :hockey=>"Yes", :date=>"November 16, 2021", :newsletter=>"Off", :nascar=>"Yes", :language=>"dart", :"language.1"=>"dart", :"language.2"=>"dart", :"language.3"=>"dart", :"language.4"=>"dart", :signature=>"", :photo=>""}
 
-Keys: [:last_name, :first_name, :football, :baseball, :basketball, :nascar, :hockey, :date]
+Keys: [:last_name, :first_name, :football, :baseball, :basketball, :hockey, :date, :newsletter, :nascar, :language, :"language.1", :"language.2", :"language.3", :"language.4", :signature, :photo]
 
-Values: ["Rahl", "Richard", "Yes", "Yes", "Yes", "Yes", "Yes", "August 30, 2019"]
+Values: ["Rahl", "Richard", "Yes", "Yes", "Yes", "Yes", "November 16, 2021", "Off", "Yes", "dart", "dart", "dart", "dart", "dart", "", ""]
 
 Field 'football' is of type BUTTON
 
 Renamed field 'last_name' to 'surname'
 
 Removed field 'nascar'
-
-Signatory: Richard Rahl
 ```
 
 ## Contributing
@@ -266,3 +413,5 @@ Signatory: Richard Rahl
 ## License
 
 The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+
+However, you must also adhere to the [iText License](https://github.com/itext/itext7) when using this gem in your project.

data/Rakefile

@@ -1,5 +1,6 @@
 require 'bundler/gem_tasks'
 require 'rake/testtask'
+require 'rubocop/rake_task'
 
 Rake::TestTask.new(:test) do |t|
   t.libs << 'test'
@@ -7,4 +8,6 @@ Rake::TestTask.new(:test) do |t|
   t.test_files = FileList['test/**/*_test.rb']
 end
 
-task default: :test
+RuboCop::RakeTask.new
+
+task default: %i[test rubocop]

data/fillable-pdf.gemspec

@@ -12,6 +12,7 @@ Gem::Specification.new do |spec|
   spec.description   = 'FillablePDF is an extremely simple and lightweight utility that bridges iText and Ruby in order to fill out fillable PDF forms or extract field values from previously filled out PDF forms.'
   spec.homepage      = 'https://github.com/vkononov/fillable-pdf'
   spec.license       = 'MIT'
+  spec.required_ruby_version = Gem::Requirement.new('>= 2.4.0')
 
   spec.files = Dir.chdir(File.expand_path(__dir__)) do
     `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(example|test|spec|features)/}) }
@@ -20,9 +21,18 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = %w[ext lib]
 
-  spec.add_development_dependency 'bundler', '~> 2.0'
-  spec.add_development_dependency 'minitest', '~> 5.0'
-  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'bundler'
+  spec.add_development_dependency 'minitest'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rubocop'
+  spec.add_development_dependency 'rubocop-md'
+  spec.add_development_dependency 'rubocop-minitest'
+  spec.add_development_dependency 'rubocop-performance'
+  spec.add_development_dependency 'rubocop-rake'
 
-  spec.add_runtime_dependency 'rjb', '~> 1.6'
+  spec.add_runtime_dependency 'rjb', '1.6.2'
+
+  spec.metadata = {
+    'rubygems_mfa_required' => 'true'
+  }
 end

data/lib/field.rb

@@ -1,15 +1,13 @@
 require_relative 'fillable-pdf/itext'
-require_relative 'kernel'
 
 class Field
   # PdfName has a constant "A" and a constant "a". Unfortunately, RJB does not differentiate
   # between these constants and tries to create the same constant ("A") for both, which causes
   # an annoying warning "already initialized constant Rjb::Com_itextpdf_kernel_pdf_PdfName::A".
   # As long as RJB has not fixed this issue, this warning will remain suppressed.
-  suppress_warnings { PDF_NAME = Rjb.import('com.itextpdf.kernel.pdf.PdfName') }
 
-  BUTTON = PDF_NAME.Btn.toString
-  CHOICE = PDF_NAME.Ch.toString
-  SIGNATURE = PDF_NAME.Sig.toString
-  TEXT = PDF_NAME.Tx.toString
-end
+  BUTTON = ITEXT::PdfName.Btn.toString
+  CHOICE = ITEXT::PdfName.Ch.toString
+  SIGNATURE = ITEXT::PdfName.Sig.toString
+  TEXT = ITEXT::PdfName.Tx.toString
+end

data/lib/fillable-pdf/itext.rb

@@ -1,3 +1,24 @@
+require_relative 'kernel'
 require 'rjb'
 
 Rjb.load(Dir.glob(File.expand_path('../../ext/*.jar', __dir__)).join(':'))
+
+module ITEXT
+  suppress_warnings do
+    ByteArrayOutputStream = Rjb.import 'com.itextpdf.io.source.ByteArrayOutputStream'
+    Canvas = Rjb.import 'com.itextpdf.layout.Canvas'
+    Div = Rjb.import 'com.itextpdf.layout.element.Div'
+    HorizontalAlignment = Rjb.import 'com.itextpdf.layout.property.HorizontalAlignment'
+    Image = Rjb.import 'com.itextpdf.layout.element.Image'
+    ImageDataFactory = Rjb.import 'com.itextpdf.io.image.ImageDataFactory'
+    PdfAcroForm = Rjb.import 'com.itextpdf.forms.PdfAcroForm'
+    PdfDictionary = Rjb.import 'com.itextpdf.kernel.pdf.PdfDictionary'
+    PdfDocument = Rjb.import 'com.itextpdf.kernel.pdf.PdfDocument'
+    PdfFormXObject = Rjb.import 'com.itextpdf.kernel.pdf.xobject.PdfFormXObject'
+    PdfName = Rjb.import 'com.itextpdf.kernel.pdf.PdfName'
+    PdfReader = Rjb.import 'com.itextpdf.kernel.pdf.PdfReader'
+    PdfWriter = Rjb.import 'com.itextpdf.kernel.pdf.PdfWriter'
+    Rectangle = Rjb.import 'com.itextpdf.kernel.geom.Rectangle'
+    VerticalAlignment = Rjb.import 'com.itextpdf.layout.property.VerticalAlignment'
+  end
+end

data/lib/{kernel.rb → fillable-pdf/kernel.rb}

@@ -6,4 +6,4 @@ module Kernel
     $VERBOSE = original_verbosity
     result
   end
-end
+end

data/lib/fillable-pdf/version.rb

@@ -1,3 +1,3 @@
 class FillablePDF
-  VERSION = '0.8.0'
+  VERSION = '0.9.3'
 end

data/lib/fillable-pdf.rb

@@ -1,33 +1,27 @@
 require_relative 'fillable-pdf/itext'
 require_relative 'field'
+require 'base64'
+require 'fileutils'
 require 'securerandom'
 
-class FillablePDF
-  # required Java imports
-  BYTE_STREAM = Rjb.import 'com.itextpdf.io.source.ByteArrayOutputStream'
-  PDF_READER = Rjb.import 'com.itextpdf.kernel.pdf.PdfReader'
-  PDF_WRITER = Rjb.import 'com.itextpdf.kernel.pdf.PdfWriter'
-  PDF_DOCUMENT = Rjb.import 'com.itextpdf.kernel.pdf.PdfDocument'
-  PDF_ACRO_FORM = Rjb.import 'com.itextpdf.forms.PdfAcroForm'
-  PDF_FORM_FIELD = Rjb.import 'com.itextpdf.forms.fields.PdfFormField'
-
+class FillablePDF # rubocop:disable Metrics/ClassLength
   ##
   # Opens a given fillable-pdf PDF file and prepares it for modification.
   #
   #   @param [String|Symbol] file_path the name of the PDF file or file path
   #
   def initialize(file_path)
-    raise IOError, "File at `#{file_path}' is not found" unless File.exist?(file_path)
+    raise IOError, "File <#{file_path}> is not found" unless File.exist?(file_path)
     @file_path = file_path
     begin
-      @byte_stream = BYTE_STREAM.new
-      @pdf_reader = PDF_READER.new @file_path
-      @pdf_writer = PDF_WRITER.new @byte_stream
-      @pdf_doc = PDF_DOCUMENT.new @pdf_reader, @pdf_writer
-      @pdf_form = PDF_ACRO_FORM.getAcroForm(@pdf_doc, true)
+      @byte_stream = ITEXT::ByteArrayOutputStream.new
+      @pdf_reader = ITEXT::PdfReader.new @file_path.to_s
+      @pdf_writer = ITEXT::PdfWriter.new @byte_stream
+      @pdf_doc = ITEXT::PdfDocument.new @pdf_reader, @pdf_writer
+      @pdf_form = ITEXT::PdfAcroForm.getAcroForm(@pdf_doc, true)
       @form_fields = @pdf_form.getFormFields
-    rescue StandardError => ex
-      raise "#{ex.message} (input file may be corrupt, incompatible, or may not have any forms)"
+    rescue StandardError => e
+      raise "#{e.message} (Input file may be corrupt, incompatible, read-only, write-protected, encrypted, or may not have any form fields)" # rubocop:disable Layout/LineLength
     end
   end
 
@@ -98,6 +92,64 @@ class FillablePDF
     pdf_field(key).setValue(value.to_s)
   end
 
+  ##
+  # Sets an image within the bounds of the given form field. It doesn't matter
+  # what type of form field it is (signature, image, etc). The image will be scaled
+  # to fill the available space while preserving its aspect ratio. All previous
+  # content will be removed, which means you cannot have both text and image.
+  #
+  #   @param [String|Symbol] key the field name
+  #   @param [String|Symbol] file_path the name of the image file or image path
+  #
+  def set_image(key, file_path) # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
+    raise IOError, "File <#{file_path}> is not found" unless File.exist?(file_path)
+    field = pdf_field(key)
+    widgets = field.getWidgets
+    widget_dict = suppress_warnings { widgets.isEmpty ? field.getPdfObject : widgets.get(0).getPdfObject }
+    orig_rect = widget_dict.getAsRectangle(ITEXT::PdfName.Rect)
+    border_width = field.getBorderWidth
+    bounding_rectangle = ITEXT::Rectangle.new(
+      orig_rect.getWidth - (border_width * 2),
+      orig_rect.getHeight - (border_width * 2)
+    )
+
+    pdf_form_x_object = ITEXT::PdfFormXObject.new(bounding_rectangle)
+    canvas = ITEXT::Canvas.new(pdf_form_x_object, @pdf_doc)
+    image = ITEXT::Image.new(ITEXT::ImageDataFactory.create(file_path.to_s))
+                        .setAutoScale(true)
+                        .setHorizontalAlignment(ITEXT::HorizontalAlignment.CENTER)
+    container = ITEXT::Div.new
+                          .setMargin(border_width).add(image)
+                          .setVerticalAlignment(ITEXT::VerticalAlignment.MIDDLE)
+                          .setFillAvailableArea(true)
+    canvas.add(container)
+    canvas.close
+
+    pdf_dict = ITEXT::PdfDictionary.new
+    widget_dict.put(ITEXT::PdfName.AP, pdf_dict)
+    pdf_dict.put(ITEXT::PdfName.N, pdf_form_x_object.getPdfObject)
+    widget_dict.setModified
+  rescue StandardError => e
+    raise "#{e.message} (there may be something wrong with your image)"
+  end
+
+  ##
+  # Sets an image within the bounds of the given form field. It doesn't matter
+  # what type of form field it is (signature, image, etc). The image will be scaled
+  # to fill the available space while preserving its aspect ratio. All previous
+  # content will be removed, which means you cannot have both text and image.
+  #
+  #   @param [String|Symbol] key the field name
+  #   @param [String|Symbol] base64_image_data base64 encoded data image
+  #
+  def set_image_base64(key, base64_image_data)
+    tmp_file = SecureRandom.uuid
+    File.open(tmp_file, 'wb') { |f| f.write(Base64.decode64(base64_image_data)) }
+    set_image(key, tmp_file)
+  ensure
+    FileUtils.rm tmp_file
+  end
+
   ##
   # Sets the values of multiple fields given a set of unique field names and values.
   #
@@ -158,7 +210,7 @@ class FillablePDF
   def save(flatten: false)
     tmp_file = SecureRandom.uuid
     save_as(tmp_file, flatten: flatten)
-    File.rename tmp_file, @file_path
+    FileUtils.mv tmp_file, @file_path
   end
 
   ##

metadata

@@ -1,71 +1,141 @@
 --- !ruby/object:Gem::Specification
 name: fillable-pdf
 version: !ruby/object:Gem::Version
-  version: 0.8.0
+  version: 0.9.3
 platform: ruby
 authors:
 - Vadim Kononov
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-01-16 00:00:00.000000000 Z
+date: 2021-12-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-md
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-performance
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rjb
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: '1.6'
+        version: 1.6.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: '1.6'
+        version: 1.6.2
 description: FillablePDF is an extremely simple and lightweight utility that bridges
   iText and Ruby in order to fill out fillable PDF forms or extract field values from
   previously filled out PDF forms.
@@ -79,29 +149,30 @@ files:
 - ".rubocop.yml"
 - ".travis.yml"
 - Gemfile
-- LICENSE.txt
+- LICENSE.md
 - README.md
 - Rakefile
 - bin/console
 - bin/setup
-- ext/font-asian-7.1.9.jar
-- ext/forms-7.1.9.jar
-- ext/io-7.1.9.jar
-- ext/kernel-7.1.9.jar
-- ext/layout-7.1.9.jar
-- ext/slf4j-api-1.7.29.jar
-- ext/slf4j-simple-1.7.29.jar
+- ext/font-asian-7.1.17.jar
+- ext/forms-7.1.17.jar
+- ext/io-7.1.17.jar
+- ext/kernel-7.1.17.jar
+- ext/layout-7.1.17.jar
+- ext/slf4j-api-1.7.32.jar
+- ext/slf4j-simple-1.7.32.jar
 - fillable-pdf.gemspec
 - lib/field.rb
 - lib/fillable-pdf.rb
 - lib/fillable-pdf/itext.rb
+- lib/fillable-pdf/kernel.rb
 - lib/fillable-pdf/version.rb
-- lib/kernel.rb
 homepage: https://github.com/vkononov/fillable-pdf
 licenses:
 - MIT
-metadata: {}
-post_install_message: 
+metadata:
+  rubygems_mfa_required: 'true'
+post_install_message:
 rdoc_options: []
 require_paths:
 - ext
@@ -110,15 +181,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.4.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
-signing_key: 
+rubygems_version: 3.2.22
+signing_key:
 specification_version: 4
 summary: Fill out or extract field values from simple fillable PDF forms using iText.
 test_files: []