pdf-forms 1.2.0 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 72a9789f0cd4a13555123fd0d5736cb0bb2fe8a671a501994c0880bc0f26bb05
-  data.tar.gz: cb6472a02f6779107051cdb44619ca04fced3b011b6c3fdaa5625d9274ce41c1
+  metadata.gz: 40651e7dd3bdc30c69263f76ecc3883c8be80f985e431509ee51e9d51bc0aa8d
+  data.tar.gz: 7e0ab952ddd42be27d4a58de7acdda3d7ef54d1588e889432ec3be922ac1b722
 SHA512:
-  metadata.gz: 7ab804f59b1953b84e9862bc0879dbaac34b233b85f81a64d64708c9d5a9839ac2186b48e258f908b48524f2cd28294b02b058d29be0a740ac51b9b9286d5848
-  data.tar.gz: f806a512d4a570ee1ff7bc3da5d7f6b81a95b98472784513b120e3099840fbe14f8c7bd61812efdf1ef804f43e32ca7426e3e7c4aa91bb30230151bf7a67406f
+  metadata.gz: d12c30fbdeabb1443f33d6f52af39e442241ce44158f9095ca909d3de434caef47df83156ba05ae08169d6bed5840220fb8d80dda673c441c3e414fd64ca3a8e
+  data.tar.gz: 9a7c21dc930ffe1249258f730cd628bf77a115fd64f84fef5df994fdef5e88e3be227d09e0cdcb862550a8ede7f25afb7fdb73083297f9c0958e998b748f5b6b

data/README.md

@@ -15,6 +15,31 @@ http://www.pdflabs.com/tools/pdftk-server/ and install it, or run
 After that, add `pdf-forms` to your Gemfile or manually install the gem. Nothing
 unusual here.
 
+### Using the Java port of PDFTK
+
+The PDFTK package was dropped from most (all?) current versions of major Linux distributions.
+As contributed in [this issue](https://github.com/jkraemer/pdf-forms/issues/75#issuecomment-698436643), you can use the [Java version of PDFTK](https://gitlab.com/pdftk-java/pdftk)
+with this gem, as well. Just create a small shell script:
+
+~~~shell
+#!/bin/sh
+MYSELF=`which "$0" 2>/dev/null`
+[ $? -gt 0 -a -f "$0" ] && MYSELF="./$0"
+java=java
+if test -n "$JAVA_HOME"; then
+    java="$JAVA_HOME/bin/java"
+fi
+exec "$java" $java_args -jar $MYSELF "$@"
+exit 1
+~~~
+
+Next, concatenate the wrapper script and the Jar file, and you end up with an executable that 
+can be used with pdf-forms:
+
+~~~
+cat stub.sh pdftk-all.jar > pdftk.run && chmod +x pdftk.run
+~~~
+
 
 ## Usage
 
@@ -54,7 +79,8 @@ pdftk.get_field_names 'path/to/form.pdf'
 # take form.pdf, set the 'foo' field to 'bar' and save the document to myform.pdf
 pdftk.fill_form '/path/to/form.pdf', 'myform.pdf', :foo => 'bar'
 
-# optionally, add the :flatten option to prevent editing of a filled out form
+# optionally, add the :flatten option to prevent editing of a filled out form.
+# Other supported options are :drop_xfa and :drop_xmp.
 pdftk.fill_form '/path/to/form.pdf', 'myform.pdf', {:foo => 'bar'}, :flatten => true
 
 # to enable PDF encryption, pass encrypt: true. By default, a random 'owner
@@ -75,6 +101,14 @@ In case your form's field names contain HTML entities (like
 `Straße Hausnummer`), make sure you unescape those before using them, i.e.
 `CGI.unescapeHTML(name)`.  Thanks to @phoet for figuring this out in #65.
 
+### 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`.
+
+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.
+
+Also see [UTF-8 chars are not displayed in the filled PDF](https://github.com/jkraemer/pdf-forms/issues/53)
 
 ### Prior Art
 

data/lib/pdf_forms/fdf.rb

@@ -28,6 +28,7 @@ module PdfForms
       end
     end
 
+    # pp 559 https://www.adobe.com/content/dam/acom/en/devnet/pdf/pdfs/pdf_reference_archives/PDFReference.pdf
     def header
       header = "%FDF-1.2\n\n1 0 obj\n<<\n/FDF << /Fields 2 0 R"
 
@@ -39,13 +40,16 @@ module PdfForms
       header << "/ID[" << options[:id].join << "]" if options[:id]
 
       header << ">>\n>>\nendobj\n2 0 obj\n["
-      return header
+      header
     end
 
+    # pp 561 https://www.adobe.com/content/dam/acom/en/devnet/pdf/pdfs/pdf_reference_archives/PDFReference.pdf
     def field(key, value)
-      "<</T(#{key})/V" +
-        (Array === value ? "[#{value.map{ |v|"(#{quote(v)})" }.join}]" : "(#{quote(value)})") +
-        ">>\n"
+      field = "<<"
+      field << "/T" + "(#{key})"
+      field << "/V" + (Array === value ? "[#{value.map{ |v|"(#{quote(v)})" }.join}]" : "(#{quote(value)})")
+      field << ">>\n"
+      field
     end
 
     def quote(value)

data/lib/pdf_forms/pdftk_wrapper.rb

@@ -136,10 +136,17 @@ module PdfForms
       local[attrib] || options[attrib]
     end
 
+    ALLOWED_OPTIONS = %i(
+      drop_xmp
+      drop_xfa
+      flatten
+      need_appearances
+    ).freeze
+
     def append_options(args, local_options = {})
       return args if options.empty? && local_options.empty?
       args = args.dup
-      %i(flatten drop_xfa drop_xmp).each do |option|
+      ALLOWED_OPTIONS.each do |option|
         if option_or_global(option, local_options)
           args << option.to_s
         end

data/lib/pdf_forms/version.rb

@@ -1,5 +1,5 @@
 # coding: UTF-8
 
 module PdfForms
-  VERSION = '1.2.0'
+  VERSION = '1.3.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pdf-forms
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.3.0
 platform: ruby
 authors:
 - Jens Krämer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-09-06 00:00:00.000000000 Z
+date: 2020-10-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: cliver
@@ -93,7 +93,6 @@ files:
 - lib/pdf_forms/pdftk_wrapper.rb
 - lib/pdf_forms/version.rb
 - lib/pdf_forms/xfdf.rb
-- release.md
 homepage: http://github.com/jkraemer/pdf-forms
 licenses:
 - MIT
@@ -114,7 +113,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: 1.3.6
 requirements: []
 rubyforge_project: pdf-forms
-rubygems_version: 2.7.6
+rubygems_version: 2.7.6.2
 signing_key: 
 specification_version: 4
 summary: Fill out PDF forms with pdftk (http://www.accesspdf.com/pdftk/).

data/release.md

@@ -1,12 +0,0 @@
-https://wiki.debian.org/Creating%20signed%20GitHub%20releases
-
-* edit history and lib/pdf_forms/version.rb
-* commit
-
-~~~~
-export version=1.3.0
-git tag -s ${version}
-git push --tags
-git archive --prefix="pdf-forms-${version}/" -o "../pdf-forms-${version}.tar.gz" ${version}
-gpg --armor --detach-sign "../pdf-forms-${version}.tar.gz"
-~~~~