fillable-pdf 0.6 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 2e531a833cf7701b907be49fc29b6885241bc2d5
-  data.tar.gz: e59582332f1377cd3bbef6d5fe53adf02f8e764b
+SHA256:
+  metadata.gz: 4c6c8de9fa4ada4510bb7107e520ce0d32a6723888d30aba6d76e4e398e544cf
+  data.tar.gz: cade4f5c56cca602d963121aa7f5bd4291c30f5d8f7ef4247b26af01168d1f40
 SHA512:
-  metadata.gz: c021fe8a59d2397e3e54174d1cd109e40b3aa0fe740296f39582aeaa486ef0e302139aed079ec729a0cfde465d81c90c09bd756278bcf5591cced8bc15636dc5
-  data.tar.gz: aadd836fbfa70a083dd76b71ea1766b53fb0f2eafb8bba1a5ede6267a7e13abaafbd5dc9be767de6ce962b1c1f9ad1ef3d726c23f74c0c3ced4e815efffc179a
+  metadata.gz: 9c09781488b61c8d77d0b08ce978a17d6fb0f124b22bfbb38a278973e78aaabbf8dd746e2a6c253d83e498ad045623f4662563bbd63254d004b668e120b2928a
+  data.tar.gz: 94f466d2a1af9f91d8262e3b84c482a8bda5dc2ff122fa58aa168592b93314954bfce1f8c5f454e8d38e8a1b0f0b1e5d921251703bd96cab3e0602e321d90761

data/.gitignore

@@ -10,4 +10,5 @@
 /Gemfile.lock
 /pkg/
 /spec/reports/
-/tmp/
+/tmp/
+tmp.pdf

data/.rubocop.yml

@@ -0,0 +1,35 @@
+require:
+  - rubocop-performance
+
+AllCops:
+  Exclude:
+    - .git/**/*
+
+Layout/EmptyLineAfterGuardClause:
+  Enabled: false
+
+Layout/LineLength:
+  Exclude:
+    - fillable-pdf.gemspec
+  Max: 120
+
+Layout/SpaceInsideHashLiteralBraces:
+  Enabled: false
+
+Naming/AccessorMethodName:
+  Enabled: false
+
+Naming/FileName:
+  Enabled: false
+
+Style/Documentation:
+  Enabled: false
+
+Style/FrozenStringLiteralComment:
+  Enabled: false
+
+Style/GuardClause:
+  Enabled: false
+
+Style/MutableConstant:
+  Enabled: false

data/.travis.yml

@@ -0,0 +1,10 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.4
+jdk:
+  - openjdk8
+before_install:
+  - gem install bundler -v 2.0.2

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

@@ -1,15 +1,16 @@
+
 # 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)
 
 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-9.0.1.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:
@@ -38,108 +39,134 @@ First of all, you should open a fillable PDF file:
 pdf = FillablePDF.new 'input.pdf'
 ```
 
-An instance of `FillablePDF` has the following methods at its disposal:
-
-```ruby
-# return true if the form has any fillable fields
-# output example: true
-pdf.any_fields?
-```
-
-```ruby
-# get the total number of fillable form fields
-# output example: 10
-pdf.num_fields
-```
-
-```ruby
-# retrieve a single field value by field name
-# output example: 'Richard'
-pdf.get_field(:full_name)
-```
-
-```ruby
-# retrieve a numeric field type by field value
-# numeric types should 
-# output example: 4
-pdf.get_field_type(:football)
-
-# list of all field types
-Field::CHECKBOX
-Field::COMBO
-Field::LIST
-Field::NONE
-Field::PUSHBUTTON
-Field::RADIOBUTTON
-Field::SIGNATURE
-Field::TEXT
-```
-
-```ruby
-# retrieve a hash of field name and values
-# output example: {:last_name=>"Rahl", :first_name=>"Richard"}
-pdf.get_fields
-```
-
-```ruby
-# set the value of a single field by field name
-# result: changes the value of 'first_name' to 'Richard'
-pdf.set_field(:first_name, 'Richard')
-```
+> **Always remember to close your document once you're finished working with it in order to avoid memory leaks:**
 
 ```ruby
-# set the values of multiple fields by field names
-# result: changes the values of 'first_name' and 'last_name'
-pdf.set_fields(first_name: 'Richard', last_name: 'Rahl')
+pdf.close
 ```
 
-```ruby
-# rename field (i.e. change the name of the field)
-# this action also moves the field to the end of the hash 
-# result: renames field name 'last_name' to 'surname'
-pdf.rename_field(:last_name, :surname)
-```
-
-```ruby
-# remove field (i.e. delete field and its value)
-# result: physically removes field 'last_name' from document
-pdf.remove_field(:last_name)
-```
-
-```ruby
-# get an array of all field names in the document
-# output example: [:first_name, :last_name]
-pdf.keys
-```
+## Instance Methods
 
-```ruby
-# get an array of all field values in the document
-# output example: ["Rahl", "Richard"]
-pdf.values
-```
-
-Once the PDF is filled out you can either overwrite it or save it as another file:
-
-```ruby
-pdf.save
-
-pdf.save_as('output.pdf')
-```
-
-Or if you prefer to flatten the file (i.e. make it non-editable), you can instead use:
-
-```ruby
-pdf.save(true)
-
-pdf.save_as('output.pdf', true)
-```
+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
+	```
+
+* `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'
+	```
+
+* `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
+	```
+
+* `fields`
+	*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'
+	```
+
+* `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'
+	```
+
+* `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 
+	```
+
+* `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
+	```
+
+* `names`
+	*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"]
+	```
+
+* `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
+	```
+
+* `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
+	```
+
+	**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
+	```
 
 ## Example
 
-The following example [test.rb](test/test.rb) and the input file [input.pdf](test/input.pdf) are located in the `test` directory. It uses all of the methods that are described above and generates the output file [output.pdf](test/output.pdf).
+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).
 
 ```ruby
+require 'fillable-pdf'
+
 # opening a fillable PDF
 pdf = FillablePDF.new('input.pdf')
 
@@ -159,12 +186,12 @@ pdf.set_fields(football: 'Yes', baseball: 'Yes',
 pdf.set_field(:date, Time.now.strftime('%B %e, %Y'))
 
 # list of fields
-puts "Fields hash: #{pdf.get_fields}"
+puts "Fields hash: #{pdf.fields}"
 
 puts
 
-# list of field keys
-puts "Keys: #{pdf.keys}"
+# list of field names
+puts "Keys: #{pdf.names}"
 
 puts
 
@@ -174,10 +201,10 @@ puts "Values: #{pdf.values}"
 puts
 
 # Checking field type
-if pdf.get_field_type(:football) == Field::CHECKBOX
-  puts "Field 'football' is of type CHECKBOX"
+if pdf.field_type(:football) == Field::BUTTON
+  puts "Field 'football' is of type BUTTON"
 else
-  puts "Field 'football' is not of type CHECKBOX"
+  puts "Field 'football' is not of type BUTTON"
 end
 
 puts
@@ -185,45 +212,47 @@ puts
 # Renaming field
 pdf.rename_field :last_name, :surname
 puts "Renamed field 'last_name' to 'surname'"
-puts "New keys: #{pdf.keys}"
 
 puts
 
 # Removing field
 pdf.remove_field :nascar
 puts "Removed field 'nascar'"
-puts "New keys: #{pdf.keys}"
-
 puts
 
 # printing the name of the person used inside the PDF
-puts "Signatory: #{pdf.get_field(:first_name)} #{pdf.get_field(:last_name)}"
+puts "Signatory: #{pdf.field(:first_name)} #{pdf.field(:last_name)}"
+
+# saving the filled out PDF in another file
+pdf.save_as('output.pdf')
+
+# saving another copy of the filled out PDF in another file and making it non-editable
+pdf = FillablePDF.new('output.pdf')
+pdf.save_as 'output.flat.pdf', flatten: true
+
+# closing the document
+pdf.close
+```
 
-# saving the filled out PDF in another file and making it non-editable
-pdf.save_as('output.pdf', true)
+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.
 
-The example above produces the following output and also generates the output file [output.pdf](test/output.pdf).
-
-    The form has a total of 8 fields.
-    
-    Fields hash: {:last_name=>"Rahl", :first_name=>"Richard", :football=>"Yes", :baseball=>"Yes", :basketball=>"Yes", :nascar=>"Yes", :hockey=>"Yes", :date=>"July 19, 2017"}
-    
-    Keys: [:last_name, :first_name, :football, :baseball, :basketball, :nascar, :hockey, :date]
-    
-    Values: ["Rahl", "Richard", "Yes", "Yes", "Yes", "Yes", "Yes", "July 19, 2017"]
-    
-    Field 'football' is of type CHECKBOX
-    
-    Renamed field 'last_name' to 'surname'
-    New keys: [:first_name, :football, :baseball, :basketball, :nascar, :hockey, :date, :surname]
-    
-    Removed field 'nascar'
-    New keys: [:first_name, :football, :baseball, :basketball, :hockey, :date, :surname]
-    
-    Signatory: Richard
+Fields hash: {:last_name=>"Rahl", :first_name=>"Richard", :football=>"Yes", :baseball=>"Yes", :basketball=>"Yes", :nascar=>"Yes", :hockey=>"Yes", :date=>"August 30, 2019"}
 
+Keys: [:last_name, :first_name, :football, :baseball, :basketball, :nascar, :hockey, :date]
+
+Values: ["Rahl", "Richard", "Yes", "Yes", "Yes", "Yes", "Yes", "August 30, 2019"]
+
+Field 'football' is of type BUTTON
+
+Renamed field 'last_name' to 'surname'
+
+Removed field 'nascar'
+
+Signatory: Richard Rahl
+```
 
 ## Contributing
 
@@ -236,4 +265,6 @@ The example above produces the following output and also generates the output fi
 
 ## License
 
-The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+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,2 +1,10 @@
 require 'bundler/gem_tasks'
-task default: :spec
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.libs << 'lib'
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task default: :test

data/fillable-pdf.gemspec

@@ -1,4 +1,4 @@
-lib = File.expand_path('../lib', __FILE__)
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'fillable-pdf/version'
 
@@ -13,11 +13,16 @@ Gem::Specification.new do |spec|
   spec.homepage      = 'https://github.com/vkononov/fillable-pdf'
   spec.license       = 'MIT'
 
-  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(example|test|spec|features)/}) }
+  end
   spec.bindir        = 'exe'
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = %w[ext lib]
 
-  spec.requirements << '>= JDK 5.0'
-  spec.add_runtime_dependency 'rjb', '~> 1.5'
+  spec.add_development_dependency 'bundler', '~> 2.0'
+  spec.add_development_dependency 'minitest', '~> 5.0'
+  spec.add_development_dependency 'rake', '~> 10.0'
+
+  spec.add_runtime_dependency 'rjb', '~> 1.6'
 end

data/lib/field.rb

@@ -1,14 +1,15 @@
 require_relative 'fillable-pdf/itext'
+require_relative 'kernel'
 
 class Field
-  ACRO_FIELDS = Rjb.import('com.itextpdf.text.pdf.AcroFields')
+  # 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') }
 
-  CHECKBOX    = ACRO_FIELDS.FIELD_TYPE_CHECKBOX
-  COMBO       = ACRO_FIELDS.FIELD_TYPE_COMBO
-  LIST        = ACRO_FIELDS.FIELD_TYPE_LIST
-  NONE        = ACRO_FIELDS.FIELD_TYPE_NONE
-  PUSHBUTTON  = ACRO_FIELDS.FIELD_TYPE_PUSHBUTTON
-  RADIOBUTTON = ACRO_FIELDS.FIELD_TYPE_RADIOBUTTON
-  SIGNATURE   = ACRO_FIELDS.FIELD_TYPE_SIGNATURE
-  TEXT        = ACRO_FIELDS.FIELD_TYPE_TEXT
-end
+  BUTTON = PDF_NAME.Btn.toString
+  CHOICE = PDF_NAME.Ch.toString
+  SIGNATURE = PDF_NAME.Sig.toString
+  TEXT = PDF_NAME.Tx.toString
+end

data/lib/fillable-pdf.rb

@@ -4,20 +4,31 @@ require 'securerandom'
 
 class FillablePDF
   # required Java imports
-  BYTE_STREAM = Rjb.import('java.io.ByteArrayOutputStream')
-  FILE_READER = Rjb.import('com.itextpdf.text.pdf.PdfReader')
-  PDF_STAMPER = Rjb.import('com.itextpdf.text.pdf.PdfStamper')
+  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'
 
   ##
-  # Opens a given fillable PDF file and prepares it for modification.
-  #
-  #   @param [String] file the name of the PDF file or file path
-  #
-  def initialize(file)
-    @file = file
-    @byte_stream = BYTE_STREAM.new
-    @pdf_stamper = PDF_STAMPER.new FILE_READER.new(@file), @byte_stream
-    @acro_fields = @pdf_stamper.getAcroFields
+  # 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)
+    @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)
+      @form_fields = @pdf_form.getFormFields
+    rescue StandardError => ex
+      raise "#{ex.message} (input file may be corrupt, incompatible, or may not have any forms)"
+    end
   end
 
   ##
@@ -26,38 +37,40 @@ class FillablePDF
   #   @return true if form has fields, false otherwise
   #
   def any_fields?
-    num_fields > 0
+    num_fields.positive?
   end
 
   ##
-  # Returns the total number of form fields.
+  # Returns the total number of fillable form fields.
   #
   #   @return the number of fields
   #
   def num_fields
-    @acro_fields.getFields.size
+    @form_fields.size
   end
 
   ##
   # Retrieves the value of a field given its unique field name.
   #
-  #   @param [String] key the field name
+  #   @param [String|Symbol] key the field name
   #
   #   @return the value of the field
   #
-  def get_field(key)
-    @acro_fields.getField key.to_s
+  def field(key)
+    pdf_field(key).getValueAsString
+  rescue NoMethodError
+    raise "unknown key name `#{key}'"
   end
 
   ##
   # Retrieves the numeric type of a field given its unique field name.
   #
-  #   @param [String] key the field name
+  #   @param [String|Symbol] key the field name
   #
   #   @return the type of the field
   #
-  def get_field_type(key)
-    @acro_fields.getFieldType key.to_s
+  def field_type(key)
+    pdf_field(key).getFormType.toString
   end
 
   ##
@@ -65,12 +78,12 @@ class FillablePDF
   #
   #   @return the hash of field keys and values
   #
-  def get_fields
-    iterator = @acro_fields.getFields.keySet.iterator
+  def fields
+    iterator = @form_fields.keySet.iterator
     map = {}
     while iterator.hasNext
       key = iterator.next.toString
-      map[key.to_sym] = get_field key
+      map[key.to_sym] = field(key)
     end
     map
   end
@@ -78,11 +91,11 @@ class FillablePDF
   ##
   # Sets the value of a field given its unique field name and value.
   #
-  #   @param [String] key the field name
-  #   @param [String] value the field value
+  #   @param [String|Symbol] key the field name
+  #   @param [String|Symbol] value the field value
   #
   def set_field(key, value)
-    @acro_fields.setField key.to_s, value.to_s
+    pdf_field(key).setValue(value.to_s)
   end
 
   ##
@@ -97,20 +110,20 @@ class FillablePDF
   ##
   # Renames a field given its unique field name and the new field name.
   #
-  #   @param [String] old_key the field name
-  #   @param [String] new_key the field name
+  #   @param [String|Symbol] old_key the field name
+  #   @param [String|Symbol] new_key the field name
   #
   def rename_field(old_key, new_key)
-    @acro_fields.renameField old_key.to_s, new_key.to_s
+    pdf_field(old_key).setFieldName(new_key.to_s)
   end
 
   ##
   # Removes a field from the document given its unique field name.
   #
-  #   @param [String] key the field name
+  #   @param [String|Symbol] key the field name
   #
   def remove_field(key)
-    @acro_fields.removeField key.to_s
+    @pdf_form.removeField(key.to_s)
   end
 
   ##
@@ -118,8 +131,8 @@ class FillablePDF
   #
   #   @return array of field names
   #
-  def keys
-    iterator = @acro_fields.getFields.keySet.iterator
+  def names
+    iterator = @form_fields.keySet.iterator
     set = []
     set << iterator.next.toString.to_sym while iterator.hasNext
     set
@@ -131,31 +144,45 @@ class FillablePDF
   #   @return array of field values
   #
   def values
-    iterator = @acro_fields.getFields.keySet.iterator
+    iterator = @form_fields.keySet.iterator
     set = []
-    set << get_field(iterator.next.toString) while iterator.hasNext
+    set << field(iterator.next.toString) while iterator.hasNext
     set
   end
 
   ##
-  # Overwrites the previously opened PDF file and flattens it if requested.
+  # Overwrites the previously opened PDF document and flattens it if requested.
   #
   #   @param [bool] flatten true if PDF should be flattened, false otherwise
   #
-  def save(flatten = false)
+  def save(flatten: false)
     tmp_file = SecureRandom.uuid
-    save_as(tmp_file, flatten)
-    File.rename tmp_file, @file
+    save_as(tmp_file, flatten: flatten)
+    File.rename tmp_file, @file_path
   end
 
   ##
-  # Saves the filled out PDF file with a given file and flattens it if requested.
+  # Saves the filled out PDF document in a given path and flattens it if requested.
   #
-  #   @param [String] file the name of the PDF file or file path
-  #   @param [bool] flatten true if PDF should be flattened, false otherwise
+  #   @param [String] file_path the name of the PDF file or file path
+  #   @param [Hash] flatten: true if PDF should be flattened, false otherwise
   #
-  def save_as(file, flatten = false)
-    File.open(file, 'wb') { |f| f.write(finalize(flatten)) && f.close }
+  def save_as(file_path, flatten: false)
+    if @file_path == file_path
+      save(flatten: flatten)
+    else
+      File.open(file_path, 'wb') { |f| f.write(finalize(flatten: flatten)) && f.close }
+    end
+  end
+
+  ##
+  # Closes the PDF document discarding all unsaved changes.
+  #
+  # @return [Boolean] true if document is closed, false otherwise
+  #
+  def close
+    @pdf_doc.close
+    @pdf_doc.isClosed
   end
 
   private
@@ -163,11 +190,17 @@ class FillablePDF
   ##
   # Writes the contents of the modified fields to the previously opened PDF file.
   #
-  #   @param [bool] flatten true if PDF should be flattened, false otherwise
+  #   @param [Hash] flatten: true if PDF should be flattened, false otherwise
   #
-  def finalize(flatten)
-    @pdf_stamper.setFormFlattening flatten
-    @pdf_stamper.close
+  def finalize(flatten: false)
+    @pdf_form.flattenFields if flatten
+    close
     @byte_stream.toByteArray
   end
+
+  def pdf_field(key)
+    field = @form_fields.get(key.to_s)
+    raise "unknown key name `#{key}'" if field.nil?
+    field
+  end
 end

data/lib/fillable-pdf/itext.rb

@@ -1,4 +1,3 @@
 require 'rjb'
 
-# http://github.com/itext/itextpdf/releases/latest
-Rjb.load(File.expand_path('../../ext/itext5-itextpdf-5.5.12.jar', __dir__))
+Rjb.load(Dir.glob(File.expand_path('../../ext/*.jar', __dir__)).join(':'))

data/lib/fillable-pdf/version.rb

@@ -1,3 +1,3 @@
-module FillablePDF
-  VERSION = '0.6'.freeze
+class FillablePDF
+  VERSION = '0.9.0'
 end

data/lib/kernel.rb

@@ -0,0 +1,9 @@
+module Kernel
+  def suppress_warnings
+    original_verbosity = $VERBOSE
+    $VERBOSE = nil
+    result = yield
+    $VERBOSE = original_verbosity
+    result
+  end
+end

metadata

@@ -1,29 +1,71 @@
 --- !ruby/object:Gem::Specification
 name: fillable-pdf
 version: !ruby/object:Gem::Version
-  version: '0.6'
+  version: 0.9.0
 platform: ruby
 authors:
 - Vadim Kononov
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-12-12 00:00:00.000000000 Z
+date: 2020-05-25 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'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
 - !ruby/object:Gem::Dependency
   name: rjb
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.5'
+        version: '1.6'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.5'
+        version: '1.6'
 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.
@@ -34,18 +76,27 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".rubocop.yml"
+- ".travis.yml"
 - Gemfile
-- LICENSE.txt
+- LICENSE.md
 - README.md
 - Rakefile
 - bin/console
 - bin/setup
-- ext/itext5-itextpdf-5.5.12.jar
+- ext/font-asian-7.1.12.jar
+- ext/forms-7.1.12.jar
+- ext/io-7.1.12.jar
+- ext/kernel-7.1.12.jar
+- ext/layout-7.1.12.jar
+- ext/slf4j-api-1.7.29.jar
+- ext/slf4j-simple-1.7.29.jar
 - fillable-pdf.gemspec
 - lib/field.rb
 - lib/fillable-pdf.rb
 - lib/fillable-pdf/itext.rb
 - lib/fillable-pdf/version.rb
+- lib/kernel.rb
 homepage: https://github.com/vkononov/fillable-pdf
 licenses:
 - MIT
@@ -65,10 +116,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
-requirements:
-- ">= JDK 5.0"
-rubyforge_project: 
-rubygems_version: 2.6.13
+requirements: []
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: Fill out or extract field values from simple fillable PDF forms using iText.