pdftk_forms 0.1.0

data/.gitignore

@@ -0,0 +1,25 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC
+Gemfile.lock
+*.gem
+pkg/*
+.bundle

data/CHANGELOG.rdoc

@@ -0,0 +1,13 @@
+= Changelog
+
+== v 0.1.0 - 05/09/11
+
+* Initial Release of the new gem
+* Combined the 2 projects here:
+  1. https://github.com/devfu/pdftk
+  2. https://github.com/jkraemer/pdf-forms
+* Added xfdf support for generating the combined pdf
+* Added a bunch of field helper methods that make creating forms much easier
+  1. #field_type (returns a string of 'text_field', 'text_area', 'check_box', 'radio_button', 'select' or 'push button')
+  2. #required?
+  3. #multiline? (for text_areas)

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in pdftk_forms.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Tom Cocca
+
+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.rdoc

@@ -0,0 +1,92 @@
+= PdftkForms
+
+This gem is intended to be a wrapper for the PDFTK command line utility for working with pdfs, mainly editable pdfs.
+
+You must have PDFTK (http://www.pdflabs.com/tools/pdftk-the-pdf-toolkit/) installed.
+
+Currently this gem is intended to make the following much easier with pdftk:
+  1. Get all the form fields on the pdf along with the important information for those fields such as 'type', 'required?', options (for selects), etc..
+  2. Pass 'answers' for those form fields to be inserted into a new compressed pdf and returned
+
+
+== Props
+
+Props to this gem go out to jkraemer (Jens Krämer) for creating https://github.com/jkraemer/pdf-forms and devfu (Dev Fu!) for creating https://github.com/devfu/pdftk.
+
+This gem is based on the work of those two projects and expands upon their functionality.
+
+
+== Installation
+
+  gem install pdftk_forms
+
+In a rails 2.3.x app
+
+  config.gem 'pdftk_forms'
+
+
+== Usage
+
+=== PdftkForms::Wrapper
+
+This is the class you will interact with.  You can optionally pass a full path to your 'pdftk' library or the gem assumes pdftk is in your path by default:
+
+  @pdftk = PdftkForms::Wrapper.new
+  @pdftk.path # => 'pdftk'
+  
+  @pdftk = PdftkForms::Wrapper.new('/usr/local/bin/pdftk')
+  @pdftk.path # => '/usr/local/bin/pdftk'
+
+==== To get the fields from a form:
+
+  @pdftk.fields('/path/to/form.pdf')
+
+This will return an array of PdftkForms::Field objects. Each field responds to the following methods
+
+  #field_type => returns one of 'text_field', 'text_area', 'check_box', 'radio_button', 'select' or 'push button'.  All pdf Choice fields (combo box or list box) come back as 'select'.
+  #required? => returns true if the field is a required field
+  #options => returns an array of options if the field is a 'select', 'check_box' or 'radio_button'
+
+There are also some useful fields used internally but that are exposed for determing the field_type
+  #multiline? => returns true if the field is a Text field and is specified as multiline (used to determine text_field vs. text_area)
+  #push_button?, #radio_button, #check_box? => Used to determine the different types of field based on the field flags when the original field type is 'Button'
+
+Finally there are methods to get the original PDF field data:
+  #name => returns the FieldName from the pdf field
+  #type => returns the original FieldType (one of 'Text', 'Button', 'Choice')
+  #value => returns the original FieldValue for pre-filled text or options
+  #flags => returns the original FieldFlags a number that is used to determine information on the form such as required, radio vs. check box, multiline, etc ...
+  #alt_name => returns the FieldNameAlt data
+
+==== To fill out a form with answers
+
+The method for filling out the form take 3 required parameters, the path to the form, the destination for the new flattened pdf, the answer data.
+
+Also, there is a 4th optional param, whether or not to use an xfdf template to fill out the form, it defaults to true. PDFTK added support for xfdf in version 1.40 released on September 19, 2006.
+
+You can pass false in as a 4th param if your pdftk version does not support xfdf to use the standard fdf format.
+
+  @pdftk.fill_form('/path/to/form.pdf', '/path/to/destination_file.pdf', {'field_one' => 'value1', 'field_two' => 'value2'})
+
+or
+
+  @pdftk.fill_form('/path/to/form.pdf', '/path/to/destination_file.pdf', {'field_one' => 'value1', 'field_two' => 'value2'}, false)
+
+The data (3rd param) is a hash where the keys are the #name of the field and the value is the answer you are submitting for that field.
+This method submits the data and created a flattened uneditable version of the completed pdf and puts it in your destination path.
+
+
+== Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+
+== Copyright
+
+Copyright (c) 2010-2011 Tom Cocca. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,18 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)
+
+task :test => :spec
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "rash #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/lib/pdftk_forms.rb

@@ -0,0 +1,5 @@
+require 'builder'
+require 'pdftk_forms/field'
+require 'pdftk_forms/fdf'
+require 'pdftk_forms/xfdf'
+require 'pdftk_forms/wrapper'

data/lib/pdftk_forms/fdf.rb

@@ -0,0 +1,89 @@
+module PdftkForms
+  
+  # Map keys and values to Adobe's FDF format.
+  #
+  # Straight port of Perl's PDF::FDF::Simple by Steffen Schwigon.
+  # Parsing FDF files is not supported (yet).
+  class Fdf
+    
+    attr_reader :options
+    
+    def initialize(data = {}, options = {})
+      @data = data
+      @options = {
+        :file => nil,
+        :ufile => nil,
+        :id => nil
+      }.merge(options)
+    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
+
+      fdf << footer
+      return fdf
+    end
+    
+    # write fdf content to path
+    def save_to(path)
+      (File.open(path, 'w') << to_fdf).close
+    end
+    
+    protected
+    
+    def header
+      header = "%FDF-1.2\n\n1 0 obj\n<<\n/FDF << /Fields 2 0 R"
+      
+      # /F
+      header << "/F (#{options[:file]})" if options[:file]
+      # /UF
+      header << "/UF (#{options[:ufile]})" if options[:ufile]
+      # /ID
+      header << "/ID[" << options[:id].join << "]" if options[:id]
+      
+      header << ">>\n>>\nendobj\n2 0 obj\n["
+      return header
+    end
+
+    def field(key, value)
+      "<</T(#{key})/V" +
+        (Array === value ? "[#{value.map{ |v|"(#{quote(v)})" }.join}]" : "(#{quote(value)})") +
+        ">>\n"
+    end
+    
+    def quote(value)
+      value.to_s.strip.
+        gsub( /\\/, '\\' ).
+        gsub( /\(/, '\(' ).
+        gsub( /\)/, '\)' ).
+        gsub( /\n/, '\r' )
+    end
+    
+    FOOTER =<<-EOFOOTER
+]
+endobj
+trailer
+<<
+/Root 1 0 R
+
+>>
+%%EOF
+EOFOOTER
+    
+    def footer
+      FOOTER
+    end
+    
+  end
+end

data/lib/pdftk_forms/field.rb

@@ -0,0 +1,72 @@
+module PdftkForms
+  # Represents a fillable form field on a particular PDF
+  class Field
+    
+    attr_accessor :attributes
+    
+    def initialize(attributes)
+      @attributes = attributes
+    end
+    
+    def required?
+      check_bit_true(2, 2)
+    end
+    
+    def multiline?
+      self.type == 'Text' && check_bit_true(4096, 13)
+    end
+    
+    def push_button?
+      self.type == 'Button' && check_bit_true(65536, 17)
+    end
+    
+    def radio_button?
+      self.type == 'Button' && !push_button? && check_bit_true(32768, 16)
+    end
+    
+    def check_box?
+      self.type == 'Button' && !push_button? && !radio_button?
+    end
+    
+    def field_type
+      if self.type == 'Button'
+        if push_button?
+          'push_button'
+        elsif radio_button?
+          'radio_button'
+        else
+          'check_box'
+        end
+      elsif self.type == 'Text'
+        multiline? ? 'text_area' : 'text_field'
+      elsif self.type == 'Choice'
+        'select'
+      else
+        self.type.downcase
+      end
+    end
+    
+    def self.alias_attribute method_name, attribute_name
+      define_method(method_name) do
+        attributes[attribute_name]
+      end
+      define_method("#{method_name}=") do |value|
+        attributes[attribute_name] = value
+      end
+    end
+    
+    alias_attribute :name,  'FieldName'
+    alias_attribute :type,  'FieldType'
+    alias_attribute :value, 'FieldValue'
+    alias_attribute :flags, 'FieldFlags'
+    alias_attribute :alt_name, 'FieldNameAlt'
+    alias_attribute :options, 'FieldStateOption'
+    
+    private
+    
+    def check_bit_true(min_value, bit_position)
+      self.flags.to_i >= min_value && self.flags.to_i.to_s(2)[-bit_position].chr == "1"
+    end
+    
+  end
+end

data/lib/pdftk_forms/version.rb

@@ -0,0 +1,3 @@
+module PdftkForms
+  VERSION = "0.1.0"
+end

data/lib/pdftk_forms/wrapper.rb

@@ -0,0 +1,61 @@
+require 'tempfile'
+module PdftkForms
+  # Wraps calls to PdfTk
+  class Wrapper
+    
+    attr_reader :path, :options
+    
+    # PdftkWrapper.new('/usr/bin/pdftk', :encrypt => true, :encrypt_options => 'allow Printing')
+    # Or
+    # PdftkWrapper.new  #assumes 'pdftk' is in the users path
+    def initialize(pdftk_path = nil, options = {})
+      @path = pdftk_path || "pdftk"
+      @options = options
+    end
+    
+    # pdftk.fill_form('/path/to/form.pdf', '/path/to/destination.pdf', :field1 => 'value 1')
+    # if your version of pdftk does not support xfdf then call
+    # pdftk.fill_form('/path/to/form.pdf', '/path/to/destination.pdf', {:field1 => 'value 1'}, false)
+    def fill_form(template, destination, data = {}, xfdf_input = true)
+      input = xfdf_input ? Xfdf.new(data) : Fdf.new(data)
+      tmp = Tempfile.new('pdf_forms_input')
+      tmp.close
+      input.save_to tmp.path
+      call_pdftk template, 'fill_form', tmp.path, 'output', destination, 'flatten', encrypt_options(tmp.path)
+      tmp.unlink
+    end
+    
+    def fields(template_path)
+      unless @all_fields
+        field_output = call_pdftk(template_path, 'dump_data_fields')
+        raw_fields = field_output.split(/^---\n/).reject {|text| text.empty? }
+        @all_fields = raw_fields.map do |field_text|
+          attributes = {}
+          field_text.scan(/^(\w+): (.*)$/) do |key, value|
+            if key == "FieldStateOption"
+              attributes[key] ||= []
+              attributes[key] << value
+            else
+              attributes[key] = value
+            end
+          end
+          Field.new(attributes)
+        end
+      end
+      @all_fields
+    end
+    
+    protected
+    
+    def encrypt_options(pwd)
+      if options[:encrypt]
+        ['encrypt_128bit', 'owner_pw', pwd, options[:encrypt_options]]
+      end
+    end
+    
+    def call_pdftk(*args)
+      %x{#{path} #{args.flatten.compact.join ' '}}
+    end
+    
+  end
+end

data/lib/pdftk_forms/xfdf.rb

@@ -0,0 +1,37 @@
+module PdftkForms
+  class Xfdf
+    
+    def initialize(data = {})
+      @data = data
+    end
+    
+    def to_xfdf
+      xfdf = Builder::XmlMarkup.new
+      xfdf.instruct!
+      xfdf.xfdf(:xmlns => "http://ns.adobe.com/xfdf/", :"xml:space" => "preserve") do
+        xfdf.fields do
+          @data.each do |key, value|
+            if Hash === value
+              value.each do |sub_key, sub_value|
+                xfdf.field(:name => "#{key}_#{sub_key}") do
+                  xfdf.value sub_value
+                end
+              end
+            else
+              xfdf.field(:name => key) do
+                xfdf.value value
+              end
+            end
+          end
+        end
+      end
+      xfdf
+    end
+    
+    def save_to(path)
+      xml = to_xfdf.target!
+      (File.open(path, 'w') << xml).close
+    end
+    
+  end
+end

data/pdftk_forms.gemspec

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "pdftk_forms/version"
+
+Gem::Specification.new do |s|
+  s.name        = "pdftk_forms"
+  s.version     = PdftkForms::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Tom Cocca"]
+  s.email       = ["tom.cocca@gmail.com"]
+  s.homepage    = "http://github.com/tcocca/pdftk_forms"
+  s.summary     = "Fill out PDF forms with pdftk."
+  s.description = "Fill out editable PDF forms with pdftk (http://www.accesspdf.com/pdftk/)."
+
+  s.rubyforge_project = "pdftk_forms"
+  
+  s.add_dependency "builder", '>= 2.1.2'
+  s.add_development_dependency "rspec", "~> 2.5.0"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+end

data/spec/pdftk_forms/fdf_spec.rb

@@ -0,0 +1,35 @@
+require 'spec_helper'
+
+describe PdftkForms::Fdf do
+  context "multiple fields" do
+    before do
+      @fdf = PdftkForms::Fdf.new :field1 => 'fieldvalue1', :other_field => 'some other value'
+      @fdf_text = @fdf.to_fdf
+    end
+    
+    it { @fdf_text.should_not be_nil }
+    it { @fdf_text.should match(%r{<</T\(field1\)/V\(fieldvalue1\)>>}) }
+    it { @fdf_text.should match(%r{<</T\(other_field\)/V\(some other value\)>>}) }
+  end
+  
+  context "quoting fields" do
+    before do
+      @fdf = PdftkForms::Fdf.new :field1 => 'field(va)lue1'
+      @fdf_text = @fdf.to_fdf
+    end
+    
+    it { @fdf_text.should_not be_nil }
+    it { @fdf_text.should match(%r{<</T\(field1\)/V\(field\\\(va\\\)lue1\)>>}) }
+  end
+  
+  context "multi-value fields" do
+    before do
+      @fdf = PdftkForms::Fdf.new :field1 => %w(one two)
+      @fdf_text = @fdf.to_fdf
+    end
+    
+    it { @fdf_text.should_not be_nil }
+    it { @fdf_text.should match(%r{<</T\(field1\)/V\[\(one\)\(two\)\]>>}) }
+  end
+  
+end

data/spec/pdftk_forms/field_spec.rb

@@ -0,0 +1,216 @@
+require 'spec_helper'
+
+describe PdftkForms::Field do
+  
+  context "aliased attributes" do
+    before do
+      @field = PdftkForms::Field.new(
+        'FieldName' => 'test',
+        'FieldType' => 'Text',
+        'FieldValue' => '',
+        'FieldFlags' => 4096
+      )
+    end
+    
+    it "should respond to" do
+      @field.should respond_to(:name)
+      @field.should respond_to(:type)
+      @field.should respond_to(:value)
+      @field.should respond_to(:flags)
+      @field.should respond_to(:alt_name)
+      @field.should respond_to(:options)
+    end
+    
+    it "should return the attribute values for the aliased methods" do
+      @field.name.should == 'test'
+      @field.type.should == 'Text'
+      @field.value.should == ''
+      @field.flags.should == 4096
+      @field.alt_name.should be_nil
+      @field.options.should be_nil
+    end
+  end
+  
+  context 'required?' do
+    before do
+      @attributes = {
+        'FieldName' => 'test',
+        'FieldType' => 'Text',
+        'FieldValue' => '',
+        'FieldFlags' => 0
+      }
+    end
+    
+    it "should be false" do
+      @field1 = PdftkForms::Field.new(@attributes)
+      @field1.required?.should be_false
+      @field2 = PdftkForms::Field.new(@attributes.merge('FieldFlags' => 1))
+      @field2.required?.should be_false
+      @field3 = PdftkForms::Field.new(@attributes.merge('FieldFlags' => 4))
+      @field3.required?.should be_false
+    end
+    
+    it "should be true" do
+      @field1 = PdftkForms::Field.new(@attributes.merge('FieldFlags' => 2))
+      @field1.required?.should be_true
+      @field2 = PdftkForms::Field.new(@attributes.merge('FieldFlags' => 3))
+      @field2.required?.should be_true
+    end
+  end
+  
+  context 'multiline? text fields' do
+    before do
+      @attributes = {
+        'FieldName' => 'test',
+        'FieldType' => 'Text',
+        'FieldValue' => '',
+        'FieldFlags' => 0
+      }
+    end
+    
+    it "should be false" do
+      @field1 = PdftkForms::Field.new(@attributes)
+      @field1.multiline?.should be_false
+      @field2 = PdftkForms::Field.new(@attributes.merge('FieldType' => 'Button', 'FieldFlags' => 4096))
+      @field2.multiline?.should be_false
+      @field3 = PdftkForms::Field.new(@attributes.merge('FieldFlags' => 4095))
+      @field3.multiline?.should be_false
+      @field3 = PdftkForms::Field.new(@attributes.merge('FieldFlags' => 8192))
+      @field3.multiline?.should be_false
+    end
+    
+    it "should be true" do
+      @field1 = PdftkForms::Field.new(@attributes.merge('FieldFlags' => 4096))
+      @field1.multiline?.should be_true
+      @field2 = PdftkForms::Field.new(@attributes.merge('FieldFlags' => 12288))
+      @field2.multiline?.should be_true
+    end
+  end
+  
+  context 'push_button?' do
+    before do
+      @attributes = {
+        'FieldName' => 'test',
+        'FieldType' => 'Button',
+        'FieldValue' => '',
+        'FieldFlags' => 0
+      }
+    end
+    
+    it "should be false" do
+      @field1 = PdftkForms::Field.new(@attributes)
+      @field1.push_button?.should be_false
+      @field2 = PdftkForms::Field.new(@attributes.merge('FieldType' => 'Button', 'FieldFlags' => 32768))
+      @field2.push_button?.should be_false
+      @field3 = PdftkForms::Field.new(@attributes.merge('FieldType' => 'Button', 'FieldFlags' => 131072))
+      @field3.push_button?.should be_false
+    end
+    
+    it "should be true" do
+      @field1 = PdftkForms::Field.new(@attributes.merge('FieldFlags' => 65536))
+      @field1.push_button?.should be_true
+      @field2 = PdftkForms::Field.new(@attributes.merge('FieldFlags' => 196608))
+      @field2.push_button?.should be_true
+    end
+  end
+  
+  context 'radio_button?' do
+    before do
+      @attributes = {
+        'FieldName' => 'test',
+        'FieldType' => 'Button',
+        'FieldValue' => '',
+        'FieldFlags' => 0
+      }
+    end
+    
+    it "should be false" do
+      @field1 = PdftkForms::Field.new(@attributes)
+      @field1.radio_button?.should be_false
+      @field2 = PdftkForms::Field.new(@attributes.merge('FieldType' => 'Button', 'FieldFlags' => 65536))
+      @field2.radio_button?.should be_false
+      @field3 = PdftkForms::Field.new(@attributes.merge('FieldType' => 'Button', 'FieldFlags' => 32767))
+      @field3.radio_button?.should be_false
+      @field4 = PdftkForms::Field.new(@attributes.merge('FieldFlags' => 98304))
+      @field4.radio_button?.should be_false
+    end
+    
+    it "should be true" do
+      @field1 = PdftkForms::Field.new(@attributes.merge('FieldFlags' => 32768))
+      @field1.radio_button?.should be_true
+      @field2 = PdftkForms::Field.new(@attributes.merge('FieldFlags' => 49153))
+      @field2.radio_button?.should be_true
+    end
+  end
+  
+  context 'check_box?' do
+    before do
+      @attributes = {
+        'FieldName' => 'test',
+        'FieldType' => 'Button',
+        'FieldValue' => '',
+        'FieldFlags' => 0
+      }
+    end
+    
+    it "should be false" do
+      @field2 = PdftkForms::Field.new(@attributes.merge('FieldType' => 'Button', 'FieldFlags' => 65536))
+      @field2.check_box?.should be_false
+      @field3 = PdftkForms::Field.new(@attributes.merge('FieldType' => 'Button', 'FieldFlags' => 32768))
+      @field3.check_box?.should be_false
+    end
+    
+    it "should be true" do
+      @field1 = PdftkForms::Field.new(@attributes.merge('FieldFlags' => 0))
+      @field1.check_box?.should be_true
+      @field2 = PdftkForms::Field.new(@attributes.merge('FieldFlags' => 32767))
+      @field2.check_box?.should be_true
+    end
+  end
+  
+  context 'field_type' do
+    before do
+      @attributes = {
+        'FieldName' => 'test',
+        'FieldValue' => '',
+        'FieldFlags' => 0
+      }
+    end
+    
+    it "should reutrn check_box" do
+      @field = PdftkForms::Field.new(@attributes.merge('FieldType' => 'Button'))
+      @field.field_type.should == "check_box"
+    end
+    
+    it "should return radio_button" do
+      @field = PdftkForms::Field.new(@attributes.merge('FieldType' => 'Button', 'FieldFlags' => 32768))
+      @field.field_type.should == "radio_button"
+    end
+    
+    it "should return push_button" do
+      @field = PdftkForms::Field.new(@attributes.merge('FieldType' => 'Button', 'FieldFlags' => 65536))
+      @field.field_type.should == "push_button"
+    end
+    
+    it "should return text_field" do
+      @field = PdftkForms::Field.new(@attributes.merge('FieldType' => 'Text'))
+      @field.field_type.should == "text_field"
+    end
+    
+    it "should return text_area" do
+      @field = PdftkForms::Field.new(@attributes.merge('FieldType' => 'Text', 'FieldFlags' => 4096))
+      @field.field_type.should == "text_area"
+    end
+    
+    it "should return select" do
+      @field = PdftkForms::Field.new(@attributes.merge('FieldType' => 'Choice'))
+      @field.field_type.should == "select"
+    end
+    
+    it "should return lowercased FieldType" do
+      @field = PdftkForms::Field.new(@attributes.merge('FieldType' => 'Something'))
+      @field.field_type.should == "something"
+    end
+  end
+  
+end

data/spec/pdftk_forms/wrapper_spec.rb

@@ -0,0 +1,104 @@
+require 'spec_helper'
+
+describe PdftkForms::Wrapper do
+  
+  context "new" do
+    it "should set the default path" do
+      @pdftk = PdftkForms::Wrapper.new
+      @pdftk.path.should == "pdftk"
+    end
+    
+    it "should allow for custom paths" do
+      @pdftk = PdftkForms::Wrapper.new('/usr/local/bin/pdftk')
+      @pdftk.path.should == "/usr/local/bin/pdftk"
+    end
+  end
+  
+  context "fields" do
+    before do
+      @pdftk = PdftkForms::Wrapper.new
+      @fields = @pdftk.fields(path_to_pdf('fields'))
+    end
+    
+    it "should get the total number of fields" do
+      @fields.size.should == 8
+    end
+    
+    it "should return an array of PdftkForms::Field objects" do
+      @fields.each do |field|
+        field.should be_kind_of(PdftkForms::Field)
+      end
+    end
+    
+    it "should set the field data" do
+      @fields[0].name.should == "text_not_required"
+      @fields[0].value.should == nil
+      @fields[0].type.should == "Text"
+      @fields[0].flags.should == "0"
+      @fields[0].alt_name.should == nil
+      @fields[0].options.should == nil
+      @fields[0].field_type.should == "text_field"
+      
+      @fields[1].name.should == "combo_box"
+      @fields[1].value.should == nil
+      @fields[1].type.should == "Choice"
+      @fields[1].flags.should == "131072"
+      @fields[1].alt_name.should == nil
+      @fields[1].options.should == ["Jason", "Tom"]
+      @fields[1].field_type.should == "select"
+      
+      @fields[2].name.should == "text_required"
+      @fields[2].value.should == nil
+      @fields[2].type.should == "Text"
+      @fields[2].flags.should == "2"
+      @fields[2].alt_name.should == nil
+      @fields[2].options.should == nil
+      @fields[2].field_type.should == "text_field"
+      
+      @fields[3].name.should == "check_box"
+      @fields[3].value.should == nil
+      @fields[3].type.should == "Button"
+      @fields[3].flags.should == "0"
+      @fields[3].alt_name.should == nil
+      @fields[3].options.should == ["Off", "Yes"]
+      @fields[3].field_type.should == "check_box"
+      
+      @fields[4].name.should == "radio_button"
+      @fields[4].value.should == nil
+      @fields[4].type.should == "Button"
+      @fields[4].flags.should == "49152"
+      @fields[4].alt_name.should == nil
+      @fields[4].options.should == ["No", "Off", "Yes"]
+      @fields[4].field_type.should == "radio_button"
+      
+      @fields[5].name.should == "list_box"
+      @fields[5].value.should == "sam"
+      @fields[5].type.should == "Choice"
+      @fields[5].flags.should == "0"
+      @fields[5].alt_name.should == nil
+      @fields[5].options.should == ["dave", "sam"]
+      @fields[5].field_type.should == "select"
+      
+      @fields[6].name.should == "button"
+      @fields[6].value.should == nil
+      @fields[6].type.should == "Button"
+      @fields[6].flags.should == "65536"
+      @fields[6].alt_name.should == nil
+      @fields[6].options.should == nil
+      @fields[6].field_type.should == "push_button"
+      
+      @fields[7].name.should == "text_area"
+      @fields[7].value.should == nil
+      @fields[7].type.should == "Text"
+      @fields[7].flags.should == "4096"
+      @fields[7].alt_name.should == nil
+      @fields[7].options.should == nil
+      @fields[7].field_type.should == "text_area"
+    end
+  end
+  
+  def path_to_pdf(filename)
+    File.join File.dirname(__FILE__), '../', 'test_pdfs', "#{filename}.pdf"
+  end
+  
+end

data/spec/pdftk_forms/xfdf_spec.rb

@@ -0,0 +1,13 @@
+require 'spec_helper'
+
+describe PdftkForms::Xfdf do
+  
+  context "generate xfdf" do
+    before do
+      @xfdf = PdftkForms::Xfdf.new(:test => "one", :user => "tom")
+    end
+    
+    it { @xfdf.to_xfdf.should == valid_xfdf }
+  end
+  
+end

data/spec/spec_helper.rb

@@ -0,0 +1,5 @@
+require File.expand_path('../../lib/pdftk_forms', __FILE__)
+
+require 'rspec'
+
+Dir[File.expand_path(File.join(File.dirname(__FILE__),'support','**','*.rb'))].each {|f| require f}

data/spec/support/xfdf_helper.rb

@@ -0,0 +1,15 @@
+def valid_xfdf
+  xfdf = Builder::XmlMarkup.new
+  xfdf.instruct!
+  xfdf.xfdf(:xmlns => "http://ns.adobe.com/xfdf/", :"xml:space" => "preserve") do
+    xfdf.fields do
+      xfdf.field(:name => :test) do
+        xfdf.value "one"
+      end
+      xfdf.field(:name => :user) do
+        xfdf.value "tom"
+      end
+    end
+  end
+  xfdf
+end

metadata

@@ -0,0 +1,125 @@
+--- !ruby/object:Gem::Specification 
+name: pdftk_forms
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: 
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Tom Cocca
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-05-09 00:00:00 -04:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: builder
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 15
+        segments: 
+        - 2
+        - 1
+        - 2
+        version: 2.1.2
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 27
+        segments: 
+        - 2
+        - 5
+        - 0
+        version: 2.5.0
+  type: :development
+  version_requirements: *id002
+description: Fill out editable PDF forms with pdftk (http://www.accesspdf.com/pdftk/).
+email: 
+- tom.cocca@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- CHANGELOG.rdoc
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.rdoc
+- Rakefile
+- lib/pdftk_forms.rb
+- lib/pdftk_forms/fdf.rb
+- lib/pdftk_forms/field.rb
+- lib/pdftk_forms/version.rb
+- lib/pdftk_forms/wrapper.rb
+- lib/pdftk_forms/xfdf.rb
+- pdftk_forms.gemspec
+- spec/pdftk_forms/fdf_spec.rb
+- spec/pdftk_forms/field_spec.rb
+- spec/pdftk_forms/wrapper_spec.rb
+- spec/pdftk_forms/xfdf_spec.rb
+- spec/spec_helper.rb
+- spec/support/xfdf_helper.rb
+- spec/test_pdfs/fields.pdf
+has_rdoc: true
+homepage: http://github.com/tcocca/pdftk_forms
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: pdftk_forms
+rubygems_version: 1.4.2
+signing_key: 
+specification_version: 3
+summary: Fill out PDF forms with pdftk.
+test_files: 
+- spec/pdftk_forms/fdf_spec.rb
+- spec/pdftk_forms/field_spec.rb
+- spec/pdftk_forms/wrapper_spec.rb
+- spec/pdftk_forms/xfdf_spec.rb
+- spec/spec_helper.rb
+- spec/support/xfdf_helper.rb
+- spec/test_pdfs/fields.pdf