fillable-pdf 0.9.3 → 0.9.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7043c6e7b7149563d54e87952727cbd2b769d7ab6cbdf6eebfbea91c89e0e6f8
-  data.tar.gz: cad339bef276e6baf84473ff4e496b9e44e2a0ea487262850e27954cc29a4df4
+  metadata.gz: 9cc8f575f9b31b18057031e15fc16d37fd65b41e28668bc9e11a8dba241d9722
+  data.tar.gz: 74f1e13956bf1c555c449602456fa01c237c0d3853934741f7c03e914c488a42
 SHA512:
-  metadata.gz: f5df81f03db25731784a1c16d132d0d08366a60e02374c1c4d16a1611a45520270d5f91c4fb1fa351a1f05f1d2881400e5cf304c2965063b9fc71cbce617edf2
-  data.tar.gz: 7cedf3ff9e49d09c7d3fc4467baa5ec7f8bf2761bc247dd03b70d0e620cba5d121aedf33e725e8a79088f601ec77282c491447ae5f149d01c316f70bbc7df60f
+  metadata.gz: 7543225bc5bacb607026100289a2c3ab349bced197d9077b2f00eb1c2a13c48da21979d007f7c02b1bbbd81caa036102d2ed15e4e1cc0f1b625153f5be90202b
+  data.tar.gz: 65d5d86a9e48494a5adcb168e063d0e73e1e4ff8eb85900571341f1c90ed32cc4a24d103c7f455b1a2ebffb8a70832443d5bef09f2779549326ed6c0e0a9f0a5

data/.github/workflows/test.yml

@@ -0,0 +1,32 @@
+# This workflow uses actions that are not certified by GitHub.
+# They are provided by a third-party and are governed by
+# separate terms of service, privacy policy, and support
+# documentation.
+
+# GitHub recommends pinning actions to a commit SHA.
+# To get a newer version, you will need to update the SHA.
+# You can also reference a tag or branch, but the action may change without warning.
+
+name: test
+
+on: [push, pull_request]
+
+jobs:
+  test:
+
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        ruby-version: ['3.1', '3.0', '2.7', '2.6', '2.5', '2.4']
+
+    steps:
+      - uses: actions/checkout@v3
+      - name: Set up Ruby ${{ matrix.ruby-version }}
+        uses: ruby/setup-ruby@359bebbc29cbe6c87da6bc9ea3bc930432750108
+        with:
+          ruby-version: ${{ matrix.ruby-version }}
+      - name: Install dependencies
+        run: bundle install
+      - name: Run tests
+        run: bundle exec rake test

data/.rubocop.yml

@@ -55,5 +55,8 @@ Style/FrozenStringLiteralComment:
 Style/GuardClause:
   Enabled: false
 
+Style/HashSyntax:
+  Enabled: false
+
 Style/MutableConstant:
   Enabled: false

data/README.md

@@ -2,90 +2,37 @@
 # FillablePDF
 
 [![Gem Version](https://badge.fury.io/rb/fillable-pdf.svg)](https://rubygems.org/gems/fillable-pdf)
-[![Build Status](https://app.travis-ci.com/vkononov/fillable-pdf.svg?branch=master)](http://travis-ci.org/vkononov/fillable-pdf)
+[![Test Status](https://github.com/vkononov/fillable-pdf/actions/workflows/test.yml/badge.svg)](https://github.com/vkononov/fillable-pdf/actions)
 
 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.
+1. Phusion Passenger's [smart spawning](https://www.phusionpassenger.com/library/indepth/ruby/spawn_methods/#the-smart-spawning-method) is not supported. 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:
+2. Puma workers (process forking) is not supposed due to an [issue](https://github.com/arton/rjb/issues/88) with the [rjb](https://github.com/arton/rjb) gem dependency.
+
+3. 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
+4. Read-only, write-protected or encrypted PDF files are currently not supported.
 
-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.
+5. Adobe generated field arrays (i.e. fields with names such as `array.0` or `array.1.0`) are not supported. 
 
 
 ## Installation
 
-**Ensure that your `JAVA_HOME` variable is set before installing this gem (see examples below).**
+**Prerequisites:** Java SE Development Kit v8, v11
 
-* OSX: `/Library/Java/JavaVirtualMachines/jdk-12.0.2.jdk/Contents/Home`
-* Ubuntu/CentOS: `/usr/lib/jvm/java-1.8.0-openjdk`
+- Ensure that your `JAVA_HOME` variable is set before installing this gem (see examples below).
+
+  * OSX: `/Library/Java/JavaVirtualMachines/jdk-11.0.2.jdk/Contents/Home`
+  * Ubuntu/CentOS: `/usr/lib/jvm/java-1.8.0-openjdk`
 
 Add this line to your application's Gemfile:
 
@@ -192,7 +139,7 @@ An instance of `FillablePDF` has the following methods at its disposal:
     ```
 
 * `field_type`
-    *Retrieves the numeric type of a field given its unique field name.*
+    *Retrieves the string type of a field given its unique field name.*
 
     ```ruby
     pdf.field_type(:football)
@@ -205,6 +152,12 @@ An instance of `FillablePDF` has the following methods at its disposal:
     Field::TEXT ('/Tx')
     ```
 
+    You can check the field type by using:
+
+    ```ruby
+    pdf.field_type(:football) == Field::BUTTON
+    ```
+
 * `fields`
     *Retrieves a hash of all fields and their values.*
 
@@ -308,6 +261,66 @@ An instance of `FillablePDF` has the following methods at its disposal:
     # result: document is closed
     ```
 
+
+## 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.
+
+
 ## Example
 
 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).

data/fillable-pdf.gemspec

@@ -30,7 +30,8 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'rubocop-performance'
   spec.add_development_dependency 'rubocop-rake'
 
-  spec.add_runtime_dependency 'rjb', '1.6.2'
+  spec.add_runtime_dependency 'rjb', '~> 1.6'
+  spec.requirements << 'JDK 8.x - 11.x'
 
   spec.metadata = {
     'rubygems_mfa_required' => 'true'

data/lib/fillable-pdf/itext.rb

@@ -8,7 +8,7 @@ module ITEXT
     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'
+    HorizontalAlignment = Rjb.import 'com.itextpdf.layout.properties.HorizontalAlignment'
     Image = Rjb.import 'com.itextpdf.layout.element.Image'
     ImageDataFactory = Rjb.import 'com.itextpdf.io.image.ImageDataFactory'
     PdfAcroForm = Rjb.import 'com.itextpdf.forms.PdfAcroForm'
@@ -19,6 +19,6 @@ module ITEXT
     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'
+    VerticalAlignment = Rjb.import 'com.itextpdf.layout.properties.VerticalAlignment'
   end
 end

data/lib/fillable-pdf/version.rb

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

data/lib/fillable-pdf.rb

@@ -57,7 +57,7 @@ class FillablePDF # rubocop:disable Metrics/ClassLength
   end
 
   ##
-  # Retrieves the numeric type of a field given its unique field name.
+  # Retrieves the string type of a field given its unique field name.
   #
   #   @param [String|Symbol] key the field name
   #
@@ -89,7 +89,10 @@ class FillablePDF # rubocop:disable Metrics/ClassLength
   #   @param [String|Symbol] value the field value
   #
   def set_field(key, value)
-    pdf_field(key).setValue(value.to_s)
+    # we set generate_appearance to false for buttons to ensure that the chosen
+    # appearance for checkboxes (i.e. check, circle, diamond) is not changed
+    generate_appearance = field_type(key) != Field::BUTTON
+    pdf_field(key).setValue(value.to_s, generate_appearance)
   end
 
   ##
@@ -144,7 +147,7 @@ class FillablePDF # rubocop:disable Metrics/ClassLength
   #
   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)) }
+    File.binwrite(tmp_file, Base64.decode64(base64_image_data))
     set_image(key, tmp_file)
   ensure
     FileUtils.rm tmp_file

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fillable-pdf
 version: !ruby/object:Gem::Version
-  version: 0.9.3
+  version: 0.9.5
 platform: ruby
 authors:
 - Vadim Kononov
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-12-02 00:00:00.000000000 Z
+date: 2022-09-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -126,16 +126,16 @@ dependencies:
   name: rjb
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.6.2
+        version: '1.6'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.6.2
+        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.
@@ -145,20 +145,21 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/test.yml"
 - ".gitignore"
 - ".rubocop.yml"
-- ".travis.yml"
 - Gemfile
 - LICENSE.md
 - README.md
 - Rakefile
 - bin/console
 - bin/setup
-- 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/commons-7.2.3.jar
+- ext/font-asian-7.2.3.jar
+- ext/forms-7.2.3.jar
+- ext/io-7.2.3.jar
+- ext/kernel-7.2.3.jar
+- ext/layout-7.2.3.jar
 - ext/slf4j-api-1.7.32.jar
 - ext/slf4j-simple-1.7.32.jar
 - fillable-pdf.gemspec
@@ -187,8 +188,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
-requirements: []
-rubygems_version: 3.2.22
+requirements:
+- JDK 8.x - 11.x
+rubygems_version: 3.1.4
 signing_key:
 specification_version: 4
 summary: Fill out or extract field values from simple fillable PDF forms using iText.

data/.travis.yml

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