pdf-forms 0.5.7 → 0.5.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d0cba3a0ac8871160ec4debf8ebb41c22402685c
-  data.tar.gz: 01df74572ed005083a33a5d8d8ab815db1d8a522
+  metadata.gz: 239cd68e0051c755b0197679386bbf0ce23f77da
+  data.tar.gz: 0fcd9c4ff9c7ae8f9adbe3d0ad7976cfcaa63b0b
 SHA512:
-  metadata.gz: 1dbb857efa9d1e37d9b060b6a811812cabcc687be51ba8a53726455d1a1af75a2b135d7ccae5586b22dd6ee96b6ad05cfe6f33279514a73a0e9af9d3effdbd70
-  data.tar.gz: 33b13326e82a0f7089de22171da9aaa1a30e90126b547921e0e04a85843281af5f049baca0f650dfefa6d9be244f3fcc2fea75eab94d69d7bfb500110a0ff9dd
+  metadata.gz: d05df9821b1df134640b448ca9888b7e5926cef2fc7ad9193d26cc3d8579dd1c396e61c905ef7d326fdae4c3f70a0a52e7951d4ca54986469a80484fe3b2911d
+  data.tar.gz: e2a3c1880c92aecbf6a4532dc5bd437c5a20cf3a7cda5c31dab4c75b815d18cb56160bb1df0d7c3a1015889283d51a10d2176aa300b0941d248e360e5f7eba1e

data/README.md

@@ -0,0 +1,66 @@
+# pdf-forms [![Build Status](https://travis-ci.org/jkraemer/pdf-forms.png?branch=master)](https://travis-ci.org/jkraemer/pdf-forms)
+
+http://github.com/jkraemer/pdf-forms/
+
+## Description
+
+Fill out PDF forms with [pdftk](http://www.pdflabs.com/tools/pdftk-server/).
+
+## Installation
+
+You'll need a working `pdftk` binary. Either get a binary package from
+http://www.pdflabs.com/tools/pdftk-server/ and install it, or run
+`apt-get install pdftk` if you're on Debian or similar.
+[Homebrew Cask](http://caskroom.io) also has a pftk formula.
+
+After that, add `pdf-forms` to your Gemfile or manually install the gem. Nothing
+unusual here.
+
+
+## Usage
+
+### FDF/XFdf creation
+
+```ruby
+require 'pdf_forms'
+fdf # PdfForms::Fdf.new :key #> 'value', :other_key #> 'other value'
+# use to_pdf_data if you just want the fdf data, without writing it to a file
+puts fdf.to_pdf_data
+# write fdf file
+fdf.save_to 'path/to/file.fdf'
+```
+
+To generate XFDF instead of FDF instantiate `PdfForms::XFdf` instead of `PdfForms::Fdf`
+
+### Query form fields and fill out PDF forms with pdftk
+
+```ruby
+require 'pdf_forms'
+
+# adjust the pdftk path to suit your pdftk installation
+# add :data_format #> 'XFdf' option to generate XFDF instead of FDF when
+# filling a form (XFDF is supposed to have better support for non-western
+# encodings)
+# add :utf8_fields #> true in order to get UTF8 encoded field metadata (this
+# will use dump_data_fields_utf8 instead of dump_data_fields in the call to
+# pdftk)
+pdftk # PdfForms.new('/usr/local/bin/pdftk')
+
+# find out the field names that are present in form.pdf
+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
+pdftk.fill_form '/path/to/form.pdf', 'myform.pdf', {:foo #> 'bar'}, :flatten #> true
+```
+
+### Prior Art
+
+The FDF generation part is a straight port of Steffen Schwigon's PDF::FDF::Simple perl module. Didn't port the FDF parsing, though ;-)
+
+## License
+
+Created by [Jens Kraemer](http://jkraemer.net/) and licensed under the MIT Liense.
+

data/lib/pdf_forms/field.rb

@@ -17,12 +17,15 @@ module PdfForms
         when /FieldStateOption:\s*(.*?)\s*$/
           (@options ||= []) << $1
         else
-          key, value = line.chomp.split(':').map(&:strip)
-          var_name = key.gsub(/Field/, '').downcase
-          unless self.respond_to?(var_name)
-            self.class.send(:define_method, var_name.to_sym, Proc.new{ instance_variable_get("@#{var_name}".to_sym) } ) # in case new or unknown fields crop up...
+          if match = line.match(/^\s*(?<key>[^:]+):\s*(?<value>.*)$/)
+            key = match[:key].to_s.strip
+            value = match[:value].to_s
+            var_name = key.gsub(/Field/, '').downcase
+            unless self.respond_to?(var_name)
+              self.class.send(:define_method, var_name.to_sym, Proc.new{ instance_variable_get("@#{var_name}".to_sym) } ) # in case new or unknown fields crop up...
+            end
+            instance_variable_set("@#{key.gsub(/Field/, '').downcase}".to_sym, value)
           end
-          instance_variable_set("@#{key.gsub(/Field/, '').downcase}".to_sym, value)
         end
       end
     end

data/lib/pdf_forms/pdf.rb

@@ -7,15 +7,19 @@ module PdfForms
 
     include SafePath
 
-    attr_reader :path
+    attr_reader :path, :options
 
-    def initialize(path, pdftk)
+    def initialize(path, pdftk, options = {})
+      @options = options
       @path = file_path(path)
       raise IOError unless File.readable?(@path)
       @pdftk = pdftk
     end
 
     # list of field objects for all defined fields
+    #
+    # Initialize the object with utf8_fields: true to get utf8 encoded field
+    # names.
     def fields
       @fields ||= read_fields
     end
@@ -28,7 +32,8 @@ module PdfForms
     protected
 
     def read_fields
-      field_output = @pdftk.call_pdftk quote_path(path), 'dump_data_fields'
+      dump_method = options[:utf8_fields] ? 'dump_data_fields_utf8' : 'dump_data_fields'
+      field_output = @pdftk.call_pdftk quote_path(path), dump_method
       @fields = field_output.split(/^---\n/).map do |field_text|
         Field.new field_text if field_text =~ /FieldName:/
       end.compact

data/lib/pdf_forms/pdftk_wrapper.rb

@@ -27,6 +27,7 @@ module PdfForms
       tmp = Tempfile.new('pdf_forms-fdf')
       tmp.close
       fdf.save_to tmp.path
+      fill_options = {:tmp_path => tmp.path}.merge(fill_options)
       command = pdftk_command q_template, 'fill_form', safe_path(tmp.path), 'output', q_destination, add_options(fill_options)
       output = %x{#{command}}
       unless File.readable?(destination) && File.size(destination) > 0
@@ -46,13 +47,21 @@ module PdfForms
     # pdftk.read '/path/to/form.pdf'
     # returns an instance of PdfForms::Pdf representing the given template
     def read(path)
-      Pdf.new path, self
+      Pdf.new path, self, options
     end
 
+    # Get field metadata for template
+    #
+    # Initialize the object with utf8_fields: true to get utf8 encoded field
+    # metadata.
     def get_fields(template)
       read(template).fields
     end
 
+    # get field names for template
+    #
+    # Initialize the object with utf8_fields: true to get utf8 encoded field
+    # names.
     def get_field_names(template)
       read(template).fields.map{|f| f.name}
     end
@@ -93,6 +102,7 @@ module PdfForms
       end
       if option_or_global(:encrypt, local_options)
         encrypt_pass = option_or_global(:encrypt_password, local_options)
+        encrypt_pass ||= option_or_global(:tmp_path, local_options)
         encrypt_options = option_or_global(:encrypt_options, local_options)
         opt_args.concat ['encrypt_128bit', 'owner_pw', encrypt_pass, encrypt_options]
       end

data/lib/pdf_forms/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pdf-forms
 version: !ruby/object:Gem::Version
-  version: 0.5.7
+  version: 0.5.8
 platform: ruby
 authors:
 - Jens Krämer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-04-06 00:00:00.000000000 Z
+date: 2014-08-07 00:00:00.000000000 Z
 dependencies: []
 description: A Ruby frontend to the pdftk binary, including FDF and XFDF creation.
   Just pass your template and a hash of data to fill in.
@@ -18,18 +18,18 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- LICENSE
+- README.md
 - lib/pdf-forms.rb
 - lib/pdf_forms.rb
-- lib/pdf_forms/safe_path.rb
-- lib/pdf_forms/field.rb
-- lib/pdf_forms/xfdf.rb
-- lib/pdf_forms/pdf.rb
 - lib/pdf_forms/data_format.rb
-- lib/pdf_forms/version.rb
 - lib/pdf_forms/fdf.rb
+- lib/pdf_forms/field.rb
+- lib/pdf_forms/pdf.rb
 - lib/pdf_forms/pdftk_wrapper.rb
-- LICENSE
-- README.rdoc
+- lib/pdf_forms/safe_path.rb
+- lib/pdf_forms/version.rb
+- lib/pdf_forms/xfdf.rb
 homepage: http://github.com/jkraemer/pdf-forms
 licenses:
 - MIT
@@ -40,17 +40,17 @@ require_paths:
 - 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: 1.3.6
 requirements: []
 rubyforge_project: pdf-forms
-rubygems_version: 2.0.3
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: Fill out PDF forms with pdftk (http://www.accesspdf.com/pdftk/).

data/README.rdoc

@@ -1,58 +0,0 @@
-= pdf-forms
-  http://github.com/jkraemer/pdf-forms/
-  by Jens Kraemer, jk@jkraemer.net
-
-== DESCRIPTION:
-
-Fill out PDF forms with pdftk (http://www.accesspdf.com/pdftk/).
-
-== EXAMPLE:
-
-=== FDF/XFdf creation
-
-  require 'pdf_forms'
-  fdf = PdfForms::Fdf.new :key => 'value', :other_key => 'other value'
-  # use to_pdf_data if you just want the fdf data, without writing it to a file
-  puts fdf.to_pdf_data
-  # write fdf file
-  fdf.save_to 'path/to/file.fdf'
-
-  # To generate XFDF instead of FDF instantiate PdfForms::XFdf instead of PdfForms::Fdf
-
-=== Query form fields and fill out PDF forms with pdftk
-
-First get pdftk from http://www.accesspdf.com/pdftk/ and install it.
-
-  require 'pdf_forms'
-
-  # adjust the pdftk path to suit your pdftk installation
-  # add :data_format => 'XFdf' option to generate XFDF instead of FDF when filling a form
-  pdftk = PdfForms.new('/usr/local/bin/pdftk')
-
-  # find out the field names that are present in form.pdf
-  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
-  pdftk.fill_form '/path/to/form.pdf', 'myform.pdf', {:foo => 'bar'}, :flatten => true
-
-
-
-
-== INSTALL:
-
-  $ gem install pdf-forms
-
-== CODE:
-
-  $ git clone http://github.com/jkraemer/pdf-forms.git
-
-== Prior Art
-
-The FDF generation part is a straight port of Steffen Schwigon's PDF::FDF::Simple perl module. Didn't port the FDF parsing, though ;-)
-
-== LICENSE:
-
-see LICENSE