pdf-forms 0.5.5 → 0.5.6

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b38b51cb4c9b3164c52041260accc25b36cb1bdb
+  data.tar.gz: 590aeedcdc7d0481d6102b5d82468a46c80912c5
+SHA512:
+  metadata.gz: ca665b990d61e8a9f7510d6b6580620ececf6b4d4ad2994a095be3dc719a92a2356a9314501dcab392ee0c0aab951239d2585048a94257a669cd5a9db4f51d07
+  data.tar.gz: 5bcb0c643f3f8d20acea518730ba7a69977284a14910fc40006c9d026f0d7f99be500ed89dd91bfb279184b39e6cebc4cd1f9a1280ea1c16faefda03212c5f79

data/README.rdoc

@@ -1,4 +1,4 @@
-= pdf-forms 
+= pdf-forms
   http://github.com/jkraemer/pdf-forms/
   by Jens Kraemer, jk@jkraemer.net
 
@@ -8,31 +8,36 @@ Fill out PDF forms with pdftk (http://www.accesspdf.com/pdftk/).
 
 == EXAMPLE:
 
-=== FDF creation
+=== FDF/XFdf creation
 
   require 'pdf_forms'
   fdf = PdfForms::Fdf.new :key => 'value', :other_key => 'other value'
-  # use to_fdf if you just want the fdf data, without writing it to a file
-  puts fdf.to_fdf
+  # 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')
-  
+
+  add :data_format => 'XFdf' option to generate XFDF instead of FDF when filling a form
+
   # 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'
-  
-  
+
+
 
 == INSTALL:
 
@@ -48,4 +53,4 @@ The FDF generation part is a straight port of Steffen Schwigon's PDF::FDF::Simpl
 
 == LICENSE:
 
-see LICENSE
+see LICENSE

data/lib/pdf_forms.rb

@@ -2,7 +2,9 @@
 
 require 'pdf_forms/version'
 require 'pdf_forms/safe_path'
+require 'pdf_forms/data_format'
 require 'pdf_forms/fdf'
+require 'pdf_forms/xfdf'
 require 'pdf_forms/pdf'
 require 'pdf_forms/pdftk_wrapper'
 

data/lib/pdf_forms/data_format.rb

@@ -0,0 +1,46 @@
+# coding UTF-8
+
+module PdfForms
+  class DataFormat
+    attr_reader :options
+
+    def initialize(data = {}, options = {})
+      @data = data
+      @options = {
+        :file => nil,
+        :ufile => nil,
+        :id => nil
+      }.merge(options)
+    end
+
+    # generate PDF content in this data format
+    def to_pdf_data
+      pdf_data = header
+
+      @data.each do |key, value|
+        if Hash === value
+          value.each do |sub_key, sub_value|
+            pdf_data << field("#{key}_#{sub_key}", sub_value)
+          end
+        else
+          pdf_data << field(key, value)
+        end
+      end
+
+      pdf_data << footer
+      return encode_data(pdf_data)
+    end
+
+    alias_method :to_fdf, :to_pdf_data
+
+    # write fdf content to path
+    def save_to(path)
+      (File.open(path, 'wb') << to_fdf).close
+    end
+
+    protected
+    def encode_data(data)
+      data
+    end
+  end
+end

data/lib/pdf_forms/fdf.rb

@@ -6,34 +6,15 @@ module PdfForms
   #
   # Straight port of Perl's PDF::FDF::Simple by Steffen Schwigon.
   # Parsing FDF files is not supported (yet).
-  class Fdf
-
-    attr_reader :options
+  class Fdf < DataFormat
 
     def initialize(data = {}, options = {})
-      @data = data
-      @options = {
-        :file => nil,
-        :ufile => nil,
-        :id => nil
-      }.merge(options)
+      super
     end
 
-    # generate FDF content
-    def to_fdf
-      fdf = header
-
-      @data.each do |key, value|
-        if Hash === value
-          value.each do |sub_key, sub_value|
-            fdf << field("#{key}_#{sub_key}", sub_value)
-          end
-        else
-          fdf << field(key, value)
-        end
-      end
+    protected
 
-      fdf << footer
+    def encode_data(fdf)
       # I have yet to see a version of pdftk which can handle UTF8 input,
       # so we convert to ISO-8859-15 here, replacing unknown / invalid chars
       # with the default replacement which is '?'.
@@ -43,18 +24,10 @@ module PdfForms
       else
         # pre 1.9
         require 'iconv'
-        fdf = Iconv.conv('ISO-8859-15//IGNORE', 'utf-8', fdf)
+        Iconv.conv('ISO-8859-15//IGNORE', 'utf-8', fdf)
       end
-      return fdf
     end
 
-    # write fdf content to path
-    def save_to(path)
-      (File.open(path, 'wb') << to_fdf).close
-    end
-
-    protected
-
     def header
       header = "%FDF-1.2\n\n1 0 obj\n<<\n/FDF << /Fields 2 0 R"
 

data/lib/pdf_forms/pdftk_wrapper.rb

@@ -23,7 +23,7 @@ module PdfForms
     def fill_form(template, destination, data = {})
       q_template = safe_path(template)
       q_destination = safe_path(destination)
-      fdf = Fdf.new(data)
+      fdf = data_format(data)
       tmp = Tempfile.new('pdf_forms-fdf')
       tmp.close
       fdf.save_to tmp.path
@@ -72,6 +72,11 @@ module PdfForms
 
     protected
 
+    def data_format(data)
+      data_format = options[:data_format] || 'Fdf'
+      PdfForms.const_get(data_format).new(data)
+    end
+
     def pdftk_command(*args)
       quote_path(pdftk) + " #{args.flatten.compact.join ' '} 2>&1"
     end
@@ -87,8 +92,5 @@ module PdfForms
       end
       opt_args
     end
-
-
-
   end
 end

data/lib/pdf_forms/version.rb

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

data/lib/pdf_forms/xfdf.rb

@@ -0,0 +1,36 @@
+# coding: UTF-8
+
+module PdfForms
+  # Map keys and values to Adobe's XFDF format.
+  class XFdf < DataFormat
+    def initialize(data = {}, options = {})
+      super
+    end
+
+    protected
+
+    def encode_data(pdf_data)
+      pdf_data
+    end
+
+    def quote(value)
+      require 'rexml/document'
+      REXML::Text.new(value.to_s).to_s
+    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>"
+    end
+
+    def footer
+      "</fields></xfdf>"
+    end
+  end
+end

metadata

@@ -1,15 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pdf-forms
 version: !ruby/object:Gem::Version
-  version: 0.5.5
-  prerelease: 
+  version: 0.5.6
 platform: ruby
 authors:
 - Jens Krämer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-05-05 00:00:00.000000000 Z
+date: 2014-02-28 00:00:00.000000000 Z
 dependencies: []
 description: Fill out PDF forms with pdftk (http://www.accesspdf.com/pdftk/).
 email:
@@ -19,37 +18,39 @@ extensions: []
 extra_rdoc_files: []
 files:
 - lib/pdf-forms.rb
-- lib/pdf_forms/fdf.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/pdftk_wrapper.rb
-- lib/pdf_forms/safe_path.rb
+- lib/pdf_forms/data_format.rb
 - lib/pdf_forms/version.rb
-- lib/pdf_forms.rb
+- lib/pdf_forms/fdf.rb
+- lib/pdf_forms/pdftk_wrapper.rb
 - LICENSE
 - README.rdoc
 homepage: http://github.com/jkraemer/pdf-forms
 licenses: []
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: 1.3.6
 requirements: []
 rubyforge_project: pdf-forms
-rubygems_version: 1.8.23
+rubygems_version: 2.0.3
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Fill out PDF forms with pdftk (http://www.accesspdf.com/pdftk/).
 test_files: []
+has_rdoc: