fillable-pdf 0.9.4 → 0.9.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3295f6a5e77e53fb9ae16f59cb1456483daecf203857cd903fd84622336f9d35
-  data.tar.gz: 4bb925c8f5908f663d36f93afb701c2dc5dcd744f476a50b2bf17fc73ff97f6d
+  metadata.gz: 9cc8f575f9b31b18057031e15fc16d37fd65b41e28668bc9e11a8dba241d9722
+  data.tar.gz: 74f1e13956bf1c555c449602456fa01c237c0d3853934741f7c03e914c488a42
 SHA512:
-  metadata.gz: ae5c10683e12cda0c209126d256b6f223d2b4194c85b06be9af9e76c12a710c8fe5d8fe6b3ff646d0b285ff93d0f97a8a0bd0c655474b52746a7c43460fd7925
-  data.tar.gz: a793a4b88d8034f9d3194fd19c07244c4d1083477f9004307208c1b9b23764fc0dde863f6f2a54c0abb264c90f5b2d05360b850fbc074afe9f259d4f51a449cf
+  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,30 +2,34 @@
 # 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.
+4. Read-only, write-protected or encrypted PDF files are currently not supported.
+
+5. Adobe generated field arrays (i.e. fields with names such as `array.0` or `array.1.0`) are not supported. 
 
 
 ## Installation
 
 **Prerequisites:** Java SE Development Kit v8, v11
 
-- Ensure that your `JAVA_HOME` variable is set before installing this gem (see examples below).**
+- 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`
@@ -135,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)
@@ -148,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.*
 

data/lib/fillable-pdf/version.rb

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

data/lib/fillable-pdf.rb

@@ -10,7 +10,7 @@ class FillablePDF # rubocop:disable Metrics/ClassLength
   #
   #   @param [String|Symbol] file_path the name of the PDF file or file path
   #
-  def initialize(file_path) # rubocop:disable Metrics/MethodLength
+  def initialize(file_path)
     raise IOError, "File <#{file_path}> is not found" unless File.exist?(file_path)
     @file_path = file_path
     begin
@@ -20,7 +20,6 @@ class FillablePDF # rubocop:disable Metrics/ClassLength
       @pdf_doc = ITEXT::PdfDocument.new @pdf_reader, @pdf_writer
       @pdf_form = ITEXT::PdfAcroForm.getAcroForm(@pdf_doc, true)
       @form_fields = @pdf_form.getFormFields
-      @pdf_form.setGenerateAppearance false
     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
@@ -58,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
   #
@@ -90,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
 
   ##

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fillable-pdf
 version: !ruby/object:Gem::Version
-  version: 0.9.4
+  version: 0.9.5
 platform: ruby
 authors:
 - Vadim Kononov
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-07-14 00:00:00.000000000 Z
+date: 2022-09-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -145,9 +145,9 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/test.yml"
 - ".gitignore"
 - ".rubocop.yml"
-- ".travis.yml"
 - Gemfile
 - LICENSE.md
 - README.md
@@ -190,7 +190,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements:
 - JDK 8.x - 11.x
-rubygems_version: 3.3.7
+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