pdf-forms 1.4.0 → 1.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6f7ed295a6b7127c97a398655de313fcce3950b3ea32b62b31ecafb72993315e
-  data.tar.gz: 432d25045b4cc7383aa2500cc66da6f7ca058be803965be1fab3dd202be1eff8
+  metadata.gz: 822913ae5ddafd1351543d61153398662cbe52506d5b766f2bd385075c105aba
+  data.tar.gz: 9795775687461877705fd8168381bf02b02bb89324cd54e8f4b5735a4cb0b5ef
 SHA512:
-  metadata.gz: 439a63e18b1ee43256ca559f6fcd7a34faa9ac2db6ccb807ec91c2378c16bc5db840bb772d6ba59690cd856cb82e98bc814cdade458800dcb6744c3ace4aaaee
-  data.tar.gz: e6e7e593801b25ad4912e8d3eaf647d27f6ca1aad08ca8a170cee702c9d5781a3353f3fcc7af56f9f94c28a8bcb9b98c6320d9452f05e3c5fea17d86bbd51904
+  metadata.gz: 305bc7b8ef657981e25b34dc67ff7565b7d3536b1b9e5fc5a2c7e2d0ec27371648370ef8bfe79d586a311aa0cdd9d438180b2a4336a4fc7274be4a339cbd9f19
+  data.tar.gz: c2d08fae7eb158ed9229cdae6443cae0c0ff37f491424e901f89108ddce49473881770fb55c507a464b8436bed1615cc7ee69a0fca9321bfb000c9fbcbd8cd1f

data/README.md

@@ -1,4 +1,4 @@
-# pdf-forms [![Build Status](https://travis-ci.org/jkraemer/pdf-forms.png?branch=master)](https://travis-ci.org/jkraemer/pdf-forms)
+# pdf-forms ![Build Status](https://github.com/jkraemer/pdf-forms/actions/workflows/run_tests.yml/badge.svg)
 
 http://github.com/jkraemer/pdf-forms/
 
@@ -89,6 +89,9 @@ pdftk.fill_form '/path/to/form.pdf', 'myform.pdf', {foo: 'bar'}, encrypt: true,
 
 # you can also protect the PDF even from opening by specifying an additional user_pw option:
 pdftk.fill_form '/path/to/form.pdf', 'myform.pdf', {foo: 'bar'}, encrypt: true, encrypt_options: 'user_pw secret'
+
+# if you are facing font issues with your pdf, you can specify :replacement_font option:
+pdftk.fill_form '/path/to/form.pdf', 'myform.pdf', {foo: 'bar'}, replacement_font: '/path/to/font'
 ```
 
 Any options shown above can also be set when initializing the PdfForms
@@ -103,7 +106,8 @@ In case your form's field names contain HTML entities (like
 
 ### Non-ASCII Characters (UTF8 etc) are not displayed in the filled out PDF
 
-First, check if the field value has been stored properly in the output PDF using `pdftk output.pdf dump_data_fields_utf8`.
+First, try to use the `replacement_font` option and specify the font that's not being displayed.
+If it doesn't work, check if the field value has been stored properly in the output PDF using `pdftk output.pdf dump_data_fields_utf8`.
 
 If it has been stored but is not rendered, your input PDF lacks the proper font for your kind of characters. Re-create it and embed any necessary fonts.
 If the value has not been stored, there is a problem with filling out the form, either on your side, of with this gem.

data/lib/pdf_forms/pdftk_wrapper.rb

@@ -84,8 +84,20 @@ module PdfForms
 
     # returns the commands output, check general execution success with
     # $?.success?
+    #
+    # The method will throw a PdftkError if pdftk returns with a non-zero exit
+    # code *and* the output contains the word "Error" (case insensitive).
+    #
+    # This is to satisfy both the requirements of not failing silently in case of
+    # PDFtk errors (https://github.com/jkraemer/pdf-forms/issues/80) as well as
+    # tolerating non-zero exit codes that are merely warnings
+    # (https://github.com/jkraemer/pdf-forms/issues/86)
     def call_pdftk(*args)
-      SafeShell.execute! pdftk, *(args.flatten)
+      output = SafeShell.execute pdftk, *(args.flatten)
+      if !$?.success? and output.to_s =~ /Error/i
+        raise PdftkError.new("pdftk failed with command\n#{pdftk} #{args.flatten.compact.join ' '}\ncommand output was:\n#{output}")
+      end
+      return output
     end
 
     # concatenate documents, can optionally specify page ranges
@@ -158,6 +170,9 @@ module PdfForms
         encrypt_options = encrypt_options.split if String === encrypt_options
         args << ['encrypt_128bit', 'owner_pw', encrypt_pass, encrypt_options]
       end
+      if option_or_global(:replacement_font, local_options)
+        args << ['replacement_font', option_or_global(:replacement_font, local_options)]
+      end
       args.flatten!
       args.compact!
       args

data/lib/pdf_forms/version.rb

@@ -1,5 +1,3 @@
-# coding: UTF-8
-
 module PdfForms
-  VERSION = '1.4.0'
+  VERSION = '1.5.1'
 end

data/lib/pdf_forms/xfdf.rb

@@ -19,15 +19,19 @@ module PdfForms
       REXML::Text.new(value.to_s).to_s
     end
 
+    def escape(value)
+      Array(value).map{ |v| quote(v) }.join(" ")
+    end
+
     def header
       '<?xml version="1.0" encoding="UTF-8"?>
         <xfdf xmlns="http://ns.adobe.com/xfdf/" xml:space="preserve">
           <fields>
       '
     end
-
+    
     def field(key, value)
-      "<field name=\"#{key}\"><value>#{Array(value).map{ |v| quote(v) }.join(" ")}</value></field>"
+      "<field name=\"#{escape(key)}\"><value>#{escape(value)}</value></field>"
     end
 
     def footer

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pdf-forms
 version: !ruby/object:Gem::Version
-  version: 1.4.0
+  version: 1.5.1
 platform: ruby
 authors:
 - Jens Krämer
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-11-09 00:00:00.000000000 Z
+date: 2024-06-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: cliver
@@ -44,6 +44,26 @@ dependencies:
     - - "<"
       - !ruby/object:Gem::Version
         version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rexml
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.2.6
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.2.6
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -98,7 +118,7 @@ homepage: http://github.com/jkraemer/pdf-forms
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -113,8 +133,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: 1.3.6
 requirements: []
-rubygems_version: 3.0.3
-signing_key: 
+rubygems_version: 3.3.26
+signing_key:
 specification_version: 4
 summary: Fill out PDF forms with pdftk (http://www.accesspdf.com/pdftk/).
 test_files: []