fillable-pdf-th 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: '0883aae0f2aa55f745ae1a862fd387900434694853fb0b5420742fcb140697b0'
+  data.tar.gz: 948d65d76a5fcf0a4cd11d7db614e46675841913e04d2c69709332da2af7c990
+SHA512:
+  metadata.gz: 782a06991cf25df8a9506fa2a1b748c3cc327f653ad993c71f414e2c16b5ed875ae566b97c31248cc1e1ff8cc415257bd9d8d52e0424081612ca3e1e75a3798c
+  data.tar.gz: 845ac00ff2db6fa63d9fbb98b382a47b9382ab5439a9c94cc9e2f140a9d0e7e5e1df701c4791eaf7cdb16580b51badd7923eb412e7974f8c97bdd41ff3ea803e

data/.gitignore

@@ -0,0 +1,14 @@
+*.DS_Store
+*thumbs.db
+/*.gem
+/.bundle/
+/.idea/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/Gemfile.lock
+/pkg/
+/spec/reports/
+/tmp/
+tmp.pdf

data/.rubocop.yml

@@ -0,0 +1,35 @@
+require:
+  - rubocop-performance
+
+AllCops:
+  Exclude:
+    - .git/**/*
+
+Layout/EmptyLineAfterGuardClause:
+  Enabled: false
+
+Layout/SpaceInsideHashLiteralBraces:
+  Enabled: false
+
+Metrics/LineLength:
+  Exclude:
+    - fillable-pdf.gemspec
+  Max: 120
+
+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/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Vadim Kononov
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,248 @@
+# 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-12.0.2.jdk/Contents/Home`  
+* Ubuntu/CentOS: `/usr/lib/jvm/java-1.8.0-openjdk`
+
+Add this line to your application's Gemfile:
+
+    gem 'fillable-pdf'
+
+And then execute:
+
+    bundle
+
+Or install it yourself as:
+
+    gem install fillable-pdf
+
+If you are using this gem in a script, you need to require it manually:
+
+```ruby
+require 'fillable-pdf'
+```
+
+## Usage
+
+First of all, you should open a fillable PDF file:
+
+```ruby
+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
+```
+
+```ruby
+# set font in pdf form
+# default is angsana_new.tiff
+# your font path: 'font/path/myfont.tiff'
+pdf.set_font(your_font_path)
+```
+
+```ruby
+# set font size in pdf form
+# default is 12.00
+pdf.set_size(15)
+```
+
+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(flatten: true)
+pdf.save_as('output.pdf', flatten: true)
+```
+
+**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. 
+
+## Example
+
+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')
+
+# total number of fields
+if pdf.any_fields?
+  puts "The form has a total of #{pdf.num_fields} fields."
+else
+  puts 'The form is not fillable.'
+end
+
+puts
+
+# setting form fields
+pdf.set_fields(first_name: 'Richard', last_name: 'Rahl')
+pdf.set_fields(football: 'Yes', baseball: 'Yes',
+               basketball: 'Yes', nascar: 'Yes', hockey: 'Yes')
+pdf.set_field(:date, Time.now.strftime('%B %e, %Y'))
+
+# list of fields
+puts "Fields hash: #{pdf.fields}"
+
+puts
+
+# list of field names
+puts "Keys: #{pdf.names}"
+
+puts
+
+# list of field values
+puts "Values: #{pdf.values}"
+
+puts
+
+# Checking field type
+if pdf.field_type(:football) == Field::BUTTON
+  puts "Field 'football' is of type BUTTON"
+else
+  puts "Field 'football' is not of type BUTTON"
+end
+
+puts
+
+# Renaming field
+pdf.rename_field :last_name, :surname
+puts "Renamed field 'last_name' to 'surname'"
+
+puts
+
+# Removing field
+pdf.remove_field :nascar
+puts "Removed field 'nascar'"
+puts
+
+# printing the name of the person used inside the PDF
+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
+```
+
+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.
+
+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
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,10 @@
+require 'bundler/gem_tasks'
+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/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'fillable-pdf'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require 'pry'
+# Pry.start
+
+require 'irb'
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/fillable-pdf-th.gemspec

@@ -0,0 +1,28 @@
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'fillable-pdf/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'fillable-pdf-th'
+  spec.version       = FillablePDF::VERSION
+  spec.authors       = ['Swiftlet']
+  spec.email         = ['swiftlet.dev@gmail.com']
+
+  spec.summary       = 'Fill out or extract field values from simple fillable PDF forms using iText.'
+  spec.description   = 'fillable-pdf-th is an extension from fillable-pdf(vkononov) but supported Thai language.'
+  spec.homepage      = 'https://github.com/swiftlet-dev/fillable-pdf-th'
+  spec.license       = 'MIT'
+
+  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.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

@@ -0,0 +1,25 @@
+require_relative 'fillable-pdf/itext'
+
+class Field
+  class << self
+    def pdf_name
+      @pdf_nanme ||= Rjb.import('com.itextpdf.kernel.pdf.PdfName')
+    end
+
+    def button
+      @button = pdf_name.Btn.toString
+    end
+
+    def choice
+      @choice = pdf_name.Ch.toString
+    end
+
+    def signature
+      @signature = pdf_name.Sig.toString
+    end
+
+    def text
+      @text = pdf_name.Tx.toString
+    end
+  end
+end

data/lib/fillable-pdf.rb

@@ -0,0 +1,203 @@
+require_relative 'fillable-pdf/itext'
+require_relative 'field'
+require 'securerandom'
+
+class FillablePDF
+  # required Java imports
+  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'
+  PDF_FONT_ENCODE = Rjb.import 'com.itextpdf.io.font.PdfEncodings'
+  PDF_FONT = Rjb.import 'com.itextpdf.kernel.font.PdfFont'
+  PDF_FONT_FACTORY = Rjb.import 'com.itextpdf.kernel.font.PdfFontFactory'
+  FONT = './default-font/angsana_new.ttf'
+  ##
+  # 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
+    @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)
+    @size = 12.00
+    set_font
+    @form_fields = @pdf_form.getFormFields
+  end
+
+  ##
+  # Set font in PDF file
+  #
+  def set_font(font_path=FONT)
+    @pdf_font = PDF_FONT_FACTORY.createFont(font_path, PDF_FONT_ENCODE.IDENTITY_H)
+  end
+
+  def set_size(size=@size)
+    @size = size.to_f
+  end
+  ##
+  # Determines whether the form has any fields.
+  #
+  #   @return true if form has fields, false otherwise
+  #
+  def any_fields?
+    num_fields.positive?
+  end
+
+  ##
+  # Returns the total number of form fields.
+  #
+  #   @return the number of fields
+  #
+  def num_fields
+    @form_fields.size
+  end
+
+  ##
+  # Retrieves the value of a field given its unique field name.
+  #
+  #   @param [String|Symbol] key the field name
+  #
+  #   @return the value of the field
+  #
+  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|Symbol] key the field name
+  #
+  #   @return the type of the field
+  #
+  def field_type(key)
+    pdf_field(key).getFormType.toString
+  end
+
+  ##
+  # Retrieves a hash of all fields and their values.
+  #
+  #   @return the hash of field keys and values
+  #
+  def fields
+    iterator = @form_fields.keySet.iterator
+    map = {}
+    while iterator.hasNext
+      key = iterator.next.toString
+      map[key.to_sym] = field(key)
+    end
+    map
+  end
+
+  ##
+  # Sets the value of a field given its unique field name and value.
+  #
+  #   @param [String|Symbol] key the field name
+  #   @param [String|Symbol] value the field value
+  #
+  def set_field(key, value)
+    pdf_field(key).setValue(value.to_s, @pdf_font, @size)
+  end
+
+  ##
+  # Sets the values of multiple fields given a set of unique field names and values.
+  #
+  #   @param [Hash] fields the set of field names and values
+  #
+  def set_fields(fields)
+    fields.each { |key, value| set_field key, value }
+  end
+
+  ##
+  # Renames a field given its unique field name and the new 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)
+    pdf_field(old_key).setFieldName(new_key.to_s)
+  end
+
+  ##
+  # Removes a field from the document given its unique field name.
+  #
+  #   @param [String|Symbol] key the field name
+  #
+  def remove_field(key)
+    @pdf_form.removeField(key.to_s)
+  end
+
+  ##
+  # Returns a list of all field keys used in the document.
+  #
+  #   @return array of field names
+  #
+  def names
+    iterator = @form_fields.keySet.iterator
+    set = []
+    set << iterator.next.toString.to_sym while iterator.hasNext
+    set
+  end
+
+  ##
+  # Returns a list of all field values used in the document.
+  #
+  #   @return array of field values
+  #
+  def values
+    iterator = @form_fields.keySet.iterator
+    set = []
+    set << field(iterator.next.toString) while iterator.hasNext
+    set
+  end
+
+  ##
+  # Overwrites the previously opened PDF file 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
+  end
+
+  ##
+  # Saves the filled out PDF file with a given file 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 }
+  end
+
+  private
+
+  ##
+  # Writes the contents of the modified fields to the previously opened PDF file.
+  #
+  #   @param [Hash] flatten: true if PDF should be flattened, false otherwise
+  #
+  def finalize(flatten: false)
+    @pdf_form.flattenFields if flatten
+    @pdf_doc.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

@@ -0,0 +1,3 @@
+require 'rjb'
+
+Rjb.load(Dir.glob(File.expand_path('../../ext/*.jar', __dir__)).join(':'))

data/lib/fillable-pdf/version.rb

@@ -0,0 +1,3 @@
+class FillablePDF
+  VERSION = '1.0.0'
+end

metadata

@@ -0,0 +1,123 @@
+--- !ruby/object:Gem::Specification
+name: fillable-pdf-th
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Swiftlet
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-10-14 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.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+description: fillable-pdf-th is an extension from fillable-pdf(vkononov) but supported
+  Thai language.
+email:
+- swiftlet.dev@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rubocop.yml"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- 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
+- fillable-pdf-th.gemspec
+- lib/default-font/angsana_new.ttf
+- lib/field.rb
+- lib/fillable-pdf.rb
+- lib/fillable-pdf/itext.rb
+- lib/fillable-pdf/version.rb
+homepage: https://github.com/swiftlet-dev/fillable-pdf-th
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- ext
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.9
+signing_key: 
+specification_version: 4
+summary: Fill out or extract field values from simple fillable PDF forms using iText.
+test_files: []