fillable-pdf 0.9.5.2 → 0.9.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e0217f9c6c445e4d79c0a8af4514547beb6297ef401659993097a5bb4be57b14
-  data.tar.gz: 6478016e8553f280217c0bc7f0a633f2cf8ac8aba6030639ef1a691d8b6d8aa7
+  metadata.gz: 29550c61e1d22f57a0df5eb9d2de4c01c49bed9f1ae36f96a7fd18889484d70d
+  data.tar.gz: a3616692065ea659cc7eb582450def4645d90e6c4cea87d74e35dfb3e68650df
 SHA512:
-  metadata.gz: ff0ce41331cabc1b0cffc8aca6d5560e0a86855ad9cf1a705a1e5b15345c57e1e165c2a77b50f7fdc6c38e49f89308c1ffff851a98d14a9dbb0bdb735e994abd
-  data.tar.gz: 3a2e98246b9d7ddbd617bfd0552e2e4891dac0d6ba241f85d23603cc139b88eb2c6a2d0570e73d1a5178dffd1b3e3923f0e9ca0b47b5d7d34c5bfa622e23f996
+  metadata.gz: 9d40a617f23bd04c4f36853e79131d5d378573c37ca71c97aed293fc55c0c39dbc38b28a2d3c7cb56c7be11c0dc8a0d207cce30a75677076787fb9a7caaedb07
+  data.tar.gz: b7c08116d5ea9721fb5b5a44be38b9ba7488b65e0b8020d148b5ae467b8b1c3319452871a7c61c1dbdca049c1ec55be41a68221fae1d943f72838c9d1c433b87

data/.github/workflows/lint.yml

@@ -0,0 +1,24 @@
+name: Lint
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    name: Rubocop
+
+    steps:
+      - uses: actions/checkout@v3
+      - name: Set up Ruby 3.2
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: 3.2
+          bundler-cache: true
+      - name: Install dependencies
+        run: bundle install
+      - name: Run Rubocop
+        run: bin/lint --no-fix

data/.github/workflows/test.yml

@@ -1,31 +1,26 @@
-# 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.
+name: Test
 
-# 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]
+on:
+  push:
+    branches:
+      - main
+  pull_request:
 
 jobs:
   test:
-
     runs-on: ubuntu-latest
-
+    name: Ruby ${{ matrix.ruby }}
     strategy:
       matrix:
-        ruby-version: ['3.1', '3.0', '2.7', '2.6', '2.5', '2.4']
+        ruby: [ '3.2', '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
+      - name: Set up Ruby ${{ matrix.ruby }}
+        uses: ruby/setup-ruby@v1
         with:
-          ruby-version: ${{ matrix.ruby-version }}
+          ruby-version: ${{ matrix.ruby }}
+          bundler-cache: true
       - name: Install dependencies
         run: bundle install
       - name: Run tests

data/.rubocop.yml

@@ -5,6 +5,7 @@ require:
   - rubocop-rake
 
 AllCops:
+  TargetRubyVersion: 2.4.0
   NewCops: enable
   Exclude:
     - .git/**/*

data/Gemfile

@@ -1,3 +1,18 @@
 source 'https://rubygems.org'
 
 gemspec
+
+group :development do
+  gem 'rake'
+
+  # Code Linting
+  gem 'rubocop', require: false
+  gem 'rubocop-md', require: false
+  gem 'rubocop-minitest', require: false
+  gem 'rubocop-performance', require: false
+  gem 'rubocop-rake', require: false
+end
+
+group :test do
+  gem 'minitest'
+end

data/README.md

@@ -2,7 +2,8 @@
 # FillablePDF
 
 [![Gem Version](https://badge.fury.io/rb/fillable-pdf.svg)](https://rubygems.org/gems/fillable-pdf)
-[![Test Status](https://github.com/vkononov/fillable-pdf/actions/workflows/test.yml/badge.svg)](https://github.com/vkononov/fillable-pdf/actions)
+[![Lint Status](https://github.com/vkononov/fillable-pdf/actions/workflows/lint.yml/badge.svg)](https://github.com/vkononov/fillable-pdf/actions/workflows/lint.yml)
+[![Test Status](https://github.com/vkononov/fillable-pdf/actions/workflows/test.yml/badge.svg)](https://github.com/vkononov/fillable-pdf/actions/workflows/test.yml)
 
 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.
 
@@ -38,7 +39,7 @@ FillablePDF is an extremely simple and lightweight utility that bridges iText an
 
   ![Blank](images/checked.png)
 
-If only of the fields are blank, try setting the `generate_appearance` flag to `true` when calling `set_field` or `set_fields`.
+If all of the fields are blank, try setting the `generate_appearance` flag to `true` when calling `set_field` or `set_fields`.
 
 ### Invalid Checkbox Appearances
 
@@ -175,17 +176,17 @@ An instance of `FillablePDF` has the following methods at its disposal:
     # output example: '/Btn'
 
     # list of all field types
-    Field::BUTTON ('/Btn')
-    Field::CHOICE ('/Ch')
-    Field::SIGNATURE ('/Sig')
-    Field::TEXT ('/Tx')
+    FillablePDF::Field::BUTTON ('/Btn')
+    FillablePDF::Field::CHOICE ('/Ch')
+    FillablePDF::Field::SIGNATURE ('/Sig')
+    FillablePDF::Field::TEXT ('/Tx')
     ```
 
     You can check the field type by using:
 
     ```ruby
-    pdf.field_type(:football) == Field::BUTTON
-    pdf.field_type('football') == Field::BUTTON
+    pdf.field_type(:football) == FillablePDF::Field::BUTTON
+    pdf.field_type('football') == FillablePDF::Field::BUTTON
     ```
 
 * `fields`
@@ -416,7 +417,7 @@ puts "Values: #{pdf.values}"
 puts
 
 # Checking field type
-if pdf.field_type(:rugby) == Field::BUTTON
+if pdf.field_type(:rugby) == FillablePDF::Field::BUTTON
   puts "Field 'football' is of type BUTTON"
 else
   puts "Field 'football' is not of type BUTTON"
@@ -476,4 +477,4 @@ Removed field 'nascar'
 
 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.
+However, you must also adhere to the [iText License](https://github.com/itext/itext7) when using this gem in your project.

data/bin/lint

@@ -0,0 +1,30 @@
+#!/usr/bin/env bash
+
+RESET_COLOR='\033[0m'
+HIGHLIGHT_COLOR='\033[0;35m'
+SUCCESS_COLOR='\033[0;32m'
+ERROR_COLOR='\033[0;31m'
+
+clear
+
+# linter configuration paths
+RUBOCOP_CONFIG=.rubocop.yml
+
+# Checking for existence of configuration files...
+test -e ${RUBOCOP_CONFIG} || { echo -e "${ERROR_COLOR}"ERROR: ${RUBOCOP_CONFIG} not found."${RESET_COLOR}"; exit 1; }
+
+# Running linters
+echo -e "${HIGHLIGHT_COLOR}"Linting Ruby on Rails using RuboCop..."${RESET_COLOR}"
+if [[ "$1" == "--no-fix" ]]; then
+        bundle exec rubocop || { valid=false; }
+else
+        bundle exec rubocop --autocorrect-all  || { valid=false; }
+fi
+
+# Printing summary
+if [[ "$valid" == false ]]; then
+  echo -e "${ERROR_COLOR}"ERROR: Lint errors have been found in your code."${RESET_COLOR}"
+  exit 1
+else
+  echo -e "${SUCCESS_COLOR}"SUCCESS: All lints have completed without errors."${RESET_COLOR}"
+fi

data/fillable-pdf.gemspec

@@ -21,15 +21,6 @@ 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'
-  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.requirements << 'JDK 8.x - 11.x'
 

data/lib/fillable-pdf/field.rb

@@ -0,0 +1,15 @@
+require_relative 'itext'
+
+class FillablePDF
+  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.
+
+    BUTTON = ITEXT::PdfName.Btn.toString
+    CHOICE = ITEXT::PdfName.Ch.toString
+    SIGNATURE = ITEXT::PdfName.Sig.toString
+    TEXT = ITEXT::PdfName.Tx.toString
+  end
+end

data/lib/fillable-pdf/itext.rb

@@ -1,24 +1,28 @@
-require_relative 'kernel'
+require_relative 'suppress_warnings'
 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.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'
-    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.properties.VerticalAlignment'
+class FillablePDF
+  module ITEXT
+    extend FillablePDF::SuppressWarnings
+
+    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.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'
+      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.properties.VerticalAlignment'
+    end
   end
 end

data/lib/fillable-pdf/suppress_warnings.rb

@@ -0,0 +1,11 @@
+class FillablePDF
+  module SuppressWarnings
+    def suppress_warnings
+      original_verbosity = $VERBOSE
+      $VERBOSE = nil
+      result = yield
+      $VERBOSE = original_verbosity
+      result
+    end
+  end
+end

data/lib/fillable-pdf/version.rb

@@ -1,3 +1,3 @@
 class FillablePDF
-  VERSION = '0.9.5.2'
+  VERSION = '0.9.6'
 end

data/lib/fillable-pdf.rb

@@ -1,10 +1,13 @@
 require_relative 'fillable-pdf/itext'
-require_relative 'field'
+require_relative 'fillable-pdf/suppress_warnings'
+require_relative 'fillable-pdf/field'
 require 'base64'
 require 'securerandom'
 require 'tmpdir'
 
 class FillablePDF # rubocop:disable Metrics/ClassLength
+  include SuppressWarnings
+
   ##
   # Opens a given fillable-pdf PDF file and prepares it for modification.
   #

metadata

@@ -1,127 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: fillable-pdf
 version: !ruby/object:Gem::Version
-  version: 0.9.5.2
+  version: 0.9.6
 platform: ruby
 authors:
 - Vadim Kononov
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-12-05 00:00:00.000000000 Z
+date: 2023-07-12 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: bundler
-  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: 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: 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: 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
@@ -145,6 +33,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/lint.yml"
 - ".github/workflows/test.yml"
 - ".gitignore"
 - ".rubocop.yml"
@@ -153,6 +42,7 @@ files:
 - README.md
 - Rakefile
 - bin/console
+- bin/lint
 - bin/setup
 - ext/commons-7.2.4.jar
 - ext/font-asian-7.2.4.jar
@@ -166,10 +56,10 @@ files:
 - images/blank.png
 - images/checked.png
 - images/distinct.png
-- lib/field.rb
 - lib/fillable-pdf.rb
+- lib/fillable-pdf/field.rb
 - lib/fillable-pdf/itext.rb
-- lib/fillable-pdf/kernel.rb
+- lib/fillable-pdf/suppress_warnings.rb
 - lib/fillable-pdf/version.rb
 homepage: https://github.com/vkononov/fillable-pdf
 licenses:
@@ -193,7 +83,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements:
 - JDK 8.x - 11.x
-rubygems_version: 3.3.7
+rubygems_version: 3.4.16
 signing_key:
 specification_version: 4
 summary: Fill out or extract field values from simple fillable PDF forms using iText.

data/lib/field.rb

@@ -1,13 +0,0 @@
-require_relative 'fillable-pdf/itext'
-
-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.
-
-  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/kernel.rb

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