fillable-pdf 0.7 → 0.9.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6f75be2cd9e29a9a3d77a62387db476166b59e2fd6b74da3c15f54a46fecb152
-  data.tar.gz: b1aa52a24db820d00fbf5a8bcf2419f63c5a9e4f7c08429cff2d8e05cae9639f
+  metadata.gz: 998124f748072a08e1a2f98593b85ba4297952c414bb800c7f05df607d76d1a7
+  data.tar.gz: d9f16c8942b1c167b476bcc5c630724f631c40285fe05cae20894d542b2daeb7
 SHA512:
-  metadata.gz: 2634346658842e6c27d5be651085443771b5c70c32616dd85fd5aae8d2e0a5f2adee348405cfab7fdd74384f00a8a65726b6b04c2051320f9d74a75f86f9255c
-  data.tar.gz: 6028a2dd57e7e22a6f7fa1215b5efe72949480d55c9e13db882d6d7932931269ad251cfe3b84f197359039255bee556d2e2fe0aac26d2cbd665ff32302944f6f
+  metadata.gz: 8e864663a4319fc61ee01448839615ab6125960c5e7a4a39585baa0ce14a339701b748332ffe7dd35bcf7a69fbcc271435e883ee8be86438b818d00d8a034595
+  data.tar.gz: 485287c89ed9073a01b97afc72d1ab96eec27b2024891c90b69fb2243d25409b14b22b76046ec0fcd2b4b2ed27262b8752f9d0037baff3bcf7a7004617ac83a3

data/.rubocop.yml

@@ -1,21 +1,27 @@
 require:
+  - rubocop-minitest
   - rubocop-performance
+  - rubocop-rake
 
 AllCops:
+  NewCops: enable
   Exclude:
     - .git/**/*
 
 Layout/EmptyLineAfterGuardClause:
   Enabled: false
 
-Layout/SpaceInsideHashLiteralBraces:
-  Enabled: false
-
-Metrics/LineLength:
+Layout/LineLength:
   Exclude:
     - fillable-pdf.gemspec
   Max: 120
 
+Layout/SpaceInsideHashLiteralBraces:
+  Enabled: false
+
+Metrics/MethodLength:
+  Max: 12
+
 Naming/AccessorMethodName:
   Enabled: false
 

data/.travis.yml

@@ -3,5 +3,8 @@ sudo: false
 language: ruby
 cache: bundler
 rvm:
-  - 2.6.4
-before_install: gem install bundler -v 2.0.2
+  - 3.0.0
+jdk:
+  - openjdk8
+before_install:
+  - 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

@@ -1,13 +1,22 @@
+
 # FillablePDF
 
 [![Gem Version](https://badge.fury.io/rb/fillable-pdf.svg)](https://rubygems.org/gems/fillable-pdf)
-[![Build Status](https://api.travis-ci.org/plataformatec/fillable-pdf.svg?branch=master)](http://travis-ci.org/plataformatec/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. 
 
-## Known Bugs (Rails + Passenger Phusion only)
+## Known Issues
+
+If the gem hangs in `development`, removing the following gems may fix the issue:
+
+```ruby
+gem 'spring'
+gem 'spring-watcher-listen'
+```
+
+If the gem hangs in `production`, you could try to use `puma` with a reverse proxy to host the application.
 
-if you are using Rails and hosting the app with Passenger Phusion (be it standalone or as a plugin for Apache or Nginx), the Java code within this gem simply hangs without any errors and warnings. If you need to deploy your Rails application, do not use Passenger Phusion. I have tested Puma, and it works fine. Not sure about other webservers.
 
 ## Installation
 
@@ -42,97 +51,126 @@ 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
-fillable-pdf
-# 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.field(:full_name)
-```
-
-```ruby
-# retrieve a field type by field name
-# numeric types should 
-# output example: 4
-pdf.field_type(:football)
-
-# list of all field types
-Field::BUTTON
-Field::CHOICE
-Field::SIGNATURE
-Field::TEXT
-```
-
-```ruby
-# retrieve a hash of field name and values
-# output example: {:last_name=>"Rahl", :first_name=>"Richard"}
-pdf.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')
-```
-
-```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')
-```
-
-```ruby
-# rename field (i.e. change the name of the field)
-# result: renames field name 'last_name' to 'surname'
-# NOTE: this action does not take effect until the document is saved 
-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.names
-```
-
-```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:
+> **Always remember to close your document once you're finished working with it in order to avoid memory leaks:**
 
 ```ruby
-pdf.save
-pdf.save_as('output.pdf')
+pdf.close
 ```
 
-Or if you prefer to flatten the file (i.e. make it non-editable), you can instead use:
+## Instance Methods
 
-```ruby
-pdf.save(flatten: true)
-pdf.save_as('output.pdf', flatten: true)
-```
+An instance of `FillablePDF` has the following methods at its disposal:
 
-**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. 
+* `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
 
@@ -203,6 +241,9 @@ 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
 ```
 
 The example above produces the following output and also generates the output file [output.pdf](example/output.pdf).
@@ -236,4 +277,6 @@ Signatory: Richard Rahl
 
 ## 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,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

@@ -1,4 +1,4 @@
-lib = File.expand_path('../lib', __dir__)
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'fillable-pdf/version'
 
@@ -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,14 @@ 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'
 end

data/lib/field.rb

@@ -1,7 +1,12 @@
 require_relative 'fillable-pdf/itext'
+require_relative 'kernel'
 
 class Field
-  PDF_NAME = Rjb.import('com.itextpdf.kernel.pdf.PdfName')
+  # 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') } # rubocop:disable Lint/ConstantDefinitionInBlock
 
   BUTTON = PDF_NAME.Btn.toString
   CHOICE = PDF_NAME.Ch.toString

data/lib/fillable-pdf.rb

@@ -1,5 +1,6 @@
 require_relative 'fillable-pdf/itext'
 require_relative 'field'
+require 'fileutils'
 require 'securerandom'
 
 class FillablePDF
@@ -19,12 +20,16 @@ class FillablePDF
   def initialize(file_path)
     raise IOError, "File at `#{file_path}' is not found" unless File.exist?(file_path)
     @file_path = file_path
-    @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
+    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 => e
+      raise "#{e.message} (input file may be corrupt, incompatible, or may not have any forms)"
+    end
   end
 
   ##
@@ -37,7 +42,7 @@ class FillablePDF
   end
 
   ##
-  # Returns the total number of form fields.
+  # Returns the total number of fillable form fields.
   #
   #   @return the number of fields
   #
@@ -147,24 +152,38 @@ class FillablePDF
   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)
     tmp_file = SecureRandom.uuid
     save_as(tmp_file, flatten: flatten)
-    File.rename tmp_file, @file_path
+    FileUtils.mv 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_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_path, flatten: false)
-    File.open(file_path, 'wb') { |f| f.write(finalize(flatten: flatten)) && f.close }
+    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
@@ -176,7 +195,7 @@ class FillablePDF
   #
   def finalize(flatten: false)
     @pdf_form.flattenFields if flatten
-    @pdf_doc.close
+    close
     @byte_stream.toByteArray
   end
 

data/lib/fillable-pdf/version.rb

@@ -1,3 +1,3 @@
 class FillablePDF
-  VERSION = '0.7'
+  VERSION = '0.9.1'
 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,57 +1,127 @@
 --- !ruby/object:Gem::Specification
 name: fillable-pdf
 version: !ruby/object:Gem::Version
-  version: '0.7'
+  version: 0.9.1
 platform: ruby
 authors:
 - Vadim Kononov
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2019-08-31 00:00:00.000000000 Z
+date: 2020-12-30 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: '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: '10.0'
+        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
@@ -79,27 +149,29 @@ files:
 - ".rubocop.yml"
 - ".travis.yml"
 - Gemfile
-- LICENSE.txt
+- LICENSE.md
 - README.md
 - Rakefile
 - bin/console
 - bin/setup
-- ext/forms-7.1.7.jar
-- ext/io-7.1.7.jar
-- ext/kernel-7.1.7.jar
-- ext/layout-7.1.7.jar
-- ext/slf4j-api-1.7.28.jar
-- ext/slf4j-simple-1.7.28.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
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - ext
@@ -108,15 +180,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.0.3
-signing_key: 
+rubygems_version: 3.2.3
+signing_key:
 specification_version: 4
 summary: Fill out or extract field values from simple fillable PDF forms using iText.
 test_files: []