pdf_ravager 0.0.8 → 0.1.0

data/.travis.yml

@@ -1,14 +1,9 @@
 language: ruby
 rvm:
-  - "1.9.2"
-  - "1.9.3"
+  - jruby-18mode
   - jruby-19mode
-  - rbx-19mode
-matrix:
-  allow_failures:
-    - rvm: jruby-19mode
+  - jruby-head
 before_install:
   - sudo add-apt-repository "deb http://archive.canonical.com/ $(lsb_release -sc) partner" -y
   - sudo apt-get update -y
   - sudo apt-get install acroread ghostscript -y
-

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright 2012 Abe Voelker
+Copyright 2012-2013 Abe Voelker
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.md

@@ -11,33 +11,47 @@ XFA documents.
 ## Synopsis
 
 ```ruby
-require 'pdf_ravager'
+require 'pdf_ravager/kernel'
 
-data = {:name => 'Bob', :gender => 'm', :relation => 'Uncle' }
+data = {name: 'Bob', gender: 'm', relation: 'Uncle' }
 
-info = pdf do
-  text 'name', data[:name]
-  text 'name_stylized', "<b>#{data[:name]}</b>", :rich => true
-  radio_group 'sex' do
-    fill 'male'   if data[:gender] == 'm'
-    fill 'female' if data[:gender] == 'f'
+template = pdf do |p|
+  p.text      'name', data[:name]
+  p.rich_text 'name_stylized', "<b>#{data[:name]}</b>"
+  p.radio_group 'sex' do |rg|
+    rg.fill 'male'   if data[:gender] == 'm'
+    rg.fill 'female' if data[:gender] == 'f'
   end
-  check 'related' if data[:relation]
-  checkbox_group 'relation' do
+  p.check 'related' if data[:relation]
+  p.checkbox_group 'relation' do |cg|
     case data[:relation]
     when 'Mom', 'Dad'
-      check 'parent'
+      cg.check 'parent'
     when 'Brother', 'Sister'
-      check 'sibling'
+      cg.check 'sibling'
     else
-      check 'other'
+      cg.check 'other'
     end
   end
 end
 
-info.ravage '/tmp/info.pdf', :out_file => '/tmp/info_filled.pdf'
+template.ravage '/tmp/info.pdf', out_file: '/tmp/info_filled.pdf'
 # if you'd like the populated form to be read-only:
-info.ravage '/tmp/info.pdf', :out_file => '/tmp/info_filled.pdf', :read_only => true
+template.ravage '/tmp/info.pdf', out_file: '/tmp/info_filled.pdf', read_only: true
+```
+
+If you don't want the global `pdf` method, the default `require 'pdf_ravager'`
+actually doesn't add it. You just need to be more wordy in this case:
+
+```ruby
+require 'pdf_ravager'
+
+data = {name: 'Bob', gender: 'm', relation: 'Uncle' }
+
+template = PDFRavager::Template.new do |p|
+  p.text 'name', data[:name]
+  # ...
+end
 ```
 
 ## Usage
@@ -66,20 +80,24 @@ Because there is no such thing as a "checkbox group," the
 example,
 
 ```ruby
-checkbox_group 'relation' do
-  check 'parent'
+pdf do |p|
+  p.checkbox_group 'relation' do |cg|
+    cg.check 'parent'
+  end
 end
 ```
 
 is equivalent to
 
 ```ruby
-check 'relation.parent'
+pdf do |p|
+  p.check 'relation.parent'
+end
 ```
 
 ## Copyright
 
-Copyright (c) 2012 Abe Voelker. Released under the terms of the
+Copyright (c) 2012-2013 Abe Voelker. Released under the terms of the
 MIT license. See LICENSE for details.
 
 The [version of iText][2] vendored is licensed under the LGPL.

data/Rakefile

@@ -20,6 +20,6 @@ else
   task :spec => ['spec:unit']
 end
 
-task :default => :spec
+task :default => 'spec:unit'
 
 Bundler::GemHelper.install_tasks

data/lib/pdf_ravager.rb

@@ -1,3 +1,2 @@
 require 'pdf_ravager/version'
-require 'pdf_ravager/pdf'
-require 'pdf_ravager/ravager' if RUBY_PLATFORM =~ /java/
+require 'pdf_ravager/template'

data/lib/pdf_ravager/field_types/acro_form.rb

@@ -0,0 +1,36 @@
+require 'java'
+require File.dirname(__FILE__)  + '/../../../vendor/iText-4.2.0'
+
+module PDFRavager
+  module FieldTypes
+    module AcroForm
+
+      module SOM
+        def self.short_name(str)
+          com.lowagie.text.pdf.XfaForm::Xml2Som.getShortName(self.escape(str))
+        end
+
+        def self.escape(str)
+          com.lowagie.text.pdf.XfaForm::Xml2Som.escapeSom(str) # just does: str.gsub(/\./) { '\\.' }
+        end
+      end
+
+      def acro_form_name
+        @name
+      end
+
+      def acro_form_value
+        @value.to_s
+      end
+
+      def set_acro_form_value(acro_fields)
+        begin
+          acro_fields.setField(SOM.short_name(acro_form_name), acro_form_value)
+        rescue java.lang.NullPointerException
+          false
+        end
+      end
+
+    end
+  end
+end

data/lib/pdf_ravager/field_types/xfa.rb

@@ -0,0 +1,65 @@
+require 'nokogiri'
+
+module PDFRavager
+  module FieldTypes
+    module XFA
+
+      def xfa_node_type
+        'text'
+      end
+
+      def xfa_name
+        @name
+      end
+
+      def xfa_value
+        @value.to_s
+      end
+
+      def set_xfa_value(xfa)
+        # the double-load is to work around a Nokogiri bug I found:
+        # https://github.com/sparklemotion/nokogiri/issues/781
+        doc = Nokogiri::XML(Nokogiri::XML::Document.wrap(xfa.getDomDocument).to_xml)
+        # first, assume the user-provided field name is an xpath and use it directly:
+        strict_match =
+          begin
+            doc.xpath(xfa_name)
+          rescue Nokogiri::XML::XPath::SyntaxError
+            []
+          end
+        # otherwise, we'll loosely match the field name anywhere in the document:
+        loose_match = doc.xpath("//*[local-name()='field'][@name='#{xfa_name}']")
+        matched_nodes = strict_match.any? ? strict_match : loose_match
+        matched_nodes.each do |node|
+          value_node = node.at_xpath("*[local-name()='value']")
+          if value_node
+            text_node = value_node.at_xpath("*[local-name()='#{xfa_node_type}']")
+            if text_node
+              # Complete node structure already exists - just set the value
+              text_node.content = xfa_value
+            else
+              # <value> node exists, but without child <text> node
+              Nokogiri::XML::Builder.with(value_node) do |xml|
+                xml.text_ {
+                  xml.send("#{xfa_node_type}_", xfa_value)
+                }
+              end
+            end
+          else
+            # No <value> node exists - create whole structure
+            Nokogiri::XML::Builder.with(node) do |xml|
+              xml.value_ {
+                xml.send("#{xfa_node_type}_") {
+                  xml.text xfa_value
+                }
+              }
+            end
+          end
+        end
+        xfa.setDomDocument(doc.to_java)
+        xfa.setChanged(true)
+      end
+
+    end
+  end
+end

data/lib/pdf_ravager/fields/checkbox.rb

@@ -0,0 +1,36 @@
+require 'pdf_ravager/field_types/acro_form'
+require 'pdf_ravager/field_types/xfa'
+
+module PDFRavager
+  module Fields
+    class Checkbox
+      include FieldTypes::AcroForm
+      include FieldTypes::XFA
+
+      attr_reader :name, :value
+
+      def initialize(name, value, opts={})
+        @name, @value = name, value
+        @true_value = opts[:true_value] ? opts[:true_value] : '1'
+        @false_value = opts[:false_value] ? opts[:false_value] : '0'
+      end
+
+      def ==(other)
+        self.name == other.name && self.value == other.value
+      end
+
+      def xfa_node_type
+        'integer'
+      end
+
+      def xfa_value
+        @value ? @true_value : @false_value
+      end
+
+      def acro_form_value
+        @value ? @true_value : @false_value
+      end
+
+    end
+  end
+end

data/lib/pdf_ravager/fields/radio.rb

@@ -0,0 +1,38 @@
+require 'pdf_ravager/field_types/acro_form'
+require 'pdf_ravager/field_types/xfa'
+
+module PDFRavager
+  module Fields
+    class Radio
+      include FieldTypes::AcroForm
+      include FieldTypes::XFA
+
+      attr_reader :group_name, :name
+
+      def initialize(group_name, name)
+        @group_name, @name = group_name, name
+      end
+
+      def ==(other)
+        self.group_name == other.group_name && self.name == other.name
+      end
+
+      def acro_form_name
+        @group_name
+      end
+
+      def xfa_name
+        @group_name
+      end
+
+      def acro_form_value
+        @name
+      end
+
+      def xfa_value
+        @name
+      end
+
+    end
+  end
+end

data/lib/pdf_ravager/fields/rich_text.rb

@@ -0,0 +1,62 @@
+require 'pdf_ravager/field_types/xfa'
+
+module PDFRavager
+  module Fields
+    class RichText
+      include FieldTypes::XFA
+
+      attr_reader :name, :value
+
+      def initialize(name, value)
+        @name, @value = name, value
+      end
+
+      def ==(other)
+        self.name == other.name && self.value == other.value
+      end
+
+      def set_xfa_value(xfa)
+        # the double-load is to work around a Nokogiri bug I found:
+        # https://github.com/sparklemotion/nokogiri/issues/781
+        doc = Nokogiri::XML(Nokogiri::XML::Document.wrap(xfa.getDomDocument).to_xml)
+        # first, assume the user-provided field name is an xpath and use it directly:
+        strict_match =
+          begin
+            doc.xpath(xfa_name)
+          rescue Nokogiri::XML::XPath::SyntaxError
+            []
+          end
+        # otherwise, we'll loosely match the field name anywhere in the document:
+        loose_match = doc.xpath("//*[local-name()='field'][@name='#{xfa_name}']")
+        matched_nodes = strict_match.any? ? strict_match : loose_match
+        matched_nodes.each do |node|
+          value_node = node.at_xpath("*[local-name()='value']")
+          if value_node
+            # <value> node exists - just create <exData>
+            Nokogiri::XML::Builder.with(value_node) do |xml|
+              xml.exData('contentType' => 'text/html') do
+                xml.body_('xmlns' => "http://www.w3.org/1999/xhtml", 'xmlns:xfa' => "http://www.xfa.org/schema/xfa-data/1.0/") do
+                  xml << xfa_value # Note: this value is not sanitized/escaped!
+                end
+              end
+            end
+          else
+            # No <value> node exists - create whole structure
+            Nokogiri::XML::Builder.with(node) do |xml|
+              xml.value_ do
+                xml.exData('contentType' => 'text/html') do
+                  xml.body_('xmlns' => "http://www.w3.org/1999/xhtml", 'xmlns:xfa' => "http://www.xfa.org/schema/xfa-data/1.0/") do
+                    xml << xfa_value # Note: this value is not sanitized/escaped!
+                  end
+                end
+              end
+            end
+          end
+        end
+        xfa.setDomDocument(doc.to_java)
+        xfa.setChanged(true)
+      end
+
+    end
+  end
+end

data/lib/pdf_ravager/fields/text.rb

@@ -0,0 +1,22 @@
+require 'pdf_ravager/field_types/acro_form'
+require 'pdf_ravager/field_types/xfa'
+
+module PDFRavager
+  module Fields
+    class Text
+      include FieldTypes::AcroForm
+      include FieldTypes::XFA
+
+      attr_reader :name, :value
+
+      def initialize(name, value)
+        @name, @value = name, value
+      end
+
+      def ==(other)
+        self.name == other.name && self.value == other.value
+      end
+
+    end
+  end
+end

data/lib/pdf_ravager/fieldsets/checkbox_group.rb

@@ -0,0 +1,20 @@
+module PDFRavager
+  module Fieldsets
+    class CheckboxGroup
+
+      def initialize(template, name)
+        @template, @name = template, name
+        yield self if block_given?
+      end
+
+      def check(name, opts={})
+        @template.check("#{@name}.#{name}", opts)
+      end
+
+      def uncheck(name, opts={})
+        @template.uncheck("#{@name}.#{name}", opts)
+      end
+
+    end
+  end
+end

data/lib/pdf_ravager/fieldsets/radio_group.rb

@@ -0,0 +1,16 @@
+module PDFRavager
+  module Fieldsets
+    class RadioGroup
+
+      def initialize(template, name)
+        @template, @name = template, name
+        yield self if block_given?
+      end
+
+      def fill(name)
+        @template.fill(@name, name)
+      end
+
+    end
+  end
+end

data/lib/pdf_ravager/kernel.rb

@@ -0,0 +1,7 @@
+require 'pdf_ravager/template'
+
+module Kernel
+  def pdf(*args, &blk)
+    PDFRavager::Template.new(*args, &blk)
+  end
+end

data/lib/pdf_ravager/ravager.rb

@@ -1,90 +1,38 @@
+unless RUBY_PLATFORM =~ /java/
+  raise "You can only ravage PDFs using JRuby, not #{RUBY_PLATFORM}!"
+end
+
 require 'java'
 require 'nokogiri'
 require File.dirname(__FILE__)  + '/../../vendor/iText-4.2.0'
 
-java_import "com.lowagie.text.pdf.AcroFields"
-java_import "com.lowagie.text.pdf.PdfArray"
-java_import "com.lowagie.text.pdf.PdfDictionary"
-java_import "com.lowagie.text.pdf.PdfName"
-java_import "com.lowagie.text.pdf.PdfObject"
-java_import "com.lowagie.text.pdf.PdfReader"
-java_import "com.lowagie.text.pdf.PdfStamper"
-java_import "com.lowagie.text.pdf.PdfStream"
-java_import "com.lowagie.text.pdf.PdfWriter"
-java_import "com.lowagie.text.pdf.XfaForm"
-java_import "com.lowagie.text.pdf.XfdfReader"
-
 module PDFRavager
   class Ravager
     private_class_method :new
 
-    def self.open(opts={}, &block)
+    def self.ravage(template, opts={})
       opts = {:in_file => opts} if opts.is_a? String
       out = if opts[:out_file]
         java.io.FileOutputStream.new(opts[:out_file])
       else
         java.io.ByteArrayOutputStream.new
       end
-      raise "You must pass a block" unless block_given?
-      ravager = new(opts.merge({:out => out}))
-      yield ravager
-      ravager.destroy
+      ravager = new(template, opts.merge({:out => out}))
+      ravager.send(:set_field_values)
+      ravager.send(:set_read_only) if opts[:read_only]
+      ravager.send(:destroy)
       out
     end
 
-    def set_field_value(name, value, type=nil, options={})
-      return set_rich_text_field(name, value) if options && options[:rich]
-      begin
-        # First try AcroForms method of setting value
-        @afields.setField(SOM.short_name(name), value)
-      rescue java.lang.NullPointerException
-      end
-      # Also look for the XDP node and set that value
-      # Note: the double-load is to work around a Nokogiri bug I found:
-      # https://github.com/sparklemotion/nokogiri/issues/781
-      doc = Nokogiri::XML(Nokogiri::XML::Document.wrap(@xfa.getDomDocument).to_xml)
-      node_type = type == :checkbox ? 'integer' : 'text'
-      doc.xpath("//*[local-name()='field'][@name='#{name}']").each do |node|
-        value_node = node.at_xpath("*[local-name()='value']")
-        if value_node
-          text_node = value_node.at_xpath("*[local-name()='#{node_type}']")
-          if text_node
-            # Complete node structure already exists - just set the value
-            text_node.content = value
-          else
-            # <value> node exists, but without child <text> node
-            Nokogiri::XML::Builder.with(value_node) do |xml|
-              xml.text_ {
-                xml.send("#{node_type}_", value)
-              }
-            end
-          end
-        else
-          # No <value> node exists - create whole structure
-          Nokogiri::XML::Builder.with(node) do |xml|
-            xml.value_ {
-              xml.send("#{node_type}_") {
-                xml.text value
-              }
-            }
-          end
-        end
-      end
-      @xfa.setDomDocument(doc.to_java)
-      @xfa.setChanged(true)
-    end
-
-    def destroy
-      read_only! if @opts[:read_only]
-      @stamper.close
-    end
-
     private
 
-    def initialize(opts={})
-      @opts = opts
-      @reader = PdfReader.new(opts[:in_file])
-      @stamper = PdfStamper.new(@reader, opts[:out])
+    # instantiation is private because there is a lot of state mutation
+    # and some invariants that need to be cleaned up. therefore, Ravager's
+    # lifecycle is managed by the public class method `ravage`.
+    def initialize(template, opts={})
+      @template, @opts = template, opts
+      @reader = com.lowagie.text.pdf.PdfReader.new(opts[:in_file])
+      @stamper = com.lowagie.text.pdf.PdfStamper.new(@reader, opts[:out])
       @afields = @stamper.getAcroFields
       @xfa = @afields.getXfa
       @som = @xfa.getDatasetsSom
@@ -95,62 +43,36 @@ module PDFRavager
       end
     end
 
-    def set_rich_text_field(name, value)
-      doc = Nokogiri::XML(Nokogiri::XML::Document.wrap(@xfa.getDomDocument).to_xml)
-      doc.xpath("//*[local-name()='field'][@name='#{name}']").each do |node|
-        value_node = node.at_xpath("*[local-name()='value']")
-        if value_node
-          # <value> node exists - just create <exData>
-          Nokogiri::XML::Builder.with(value_node) do |xml|
-            xml.exData('contentType' => 'text/html') do
-              xml.body_('xmlns' => "http://www.w3.org/1999/xhtml", 'xmlns:xfa' => "http://www.xfa.org/schema/xfa-data/1.0/") do
-                xml << value # Note: this value is not sanitized/escaped!
-              end
-            end
-          end
-        else
-          # No <value> node exists - create whole structure
-          Nokogiri::XML::Builder.with(node) do |xml|
-            xml.value_ do
-              xml.exData('contentType' => 'text/html') do
-                xml.body_('xmlns' => "http://www.w3.org/1999/xhtml", 'xmlns:xfa' => "http://www.xfa.org/schema/xfa-data/1.0/") do
-                  xml << value # Note: this value is not sanitized/escaped!
-                end
-              end
-            end
-          end
+    def destroy
+      @stamper.close
+    end
+
+    def set_field_values
+      case @type
+      when :acro_forms
+        @template.fields.each{|f| f.set_acro_form_value(@afields) }
+      when :xfa
+        @template.fields.each do |f|
+          f.set_acro_form_value(@afields) if f.respond_to? :set_acro_form_value
+          f.set_xfa_value(@xfa) if f.respond_to? :set_xfa_value
         end
       end
-      @xfa.setDomDocument(doc.to_java)
-      @xfa.setChanged(true)
     end
 
-    def read_only!
+    def set_read_only
       case @type
       when :acro_forms
         @stamper.setFormFlattening(true)
       when :xfa
-        if @xfa_type == :static
-          @stamper.setFormFlattening(true)
-        else
-          doc = Nokogiri::XML(Nokogiri::XML::Document.wrap(@xfa.getDomDocument).to_xml)
-          doc.xpath("//*[local-name()='field']").each do |node|
-            node["access"] = "readOnly"
-          end
-          @xfa.setDomDocument(doc.to_java)
-          @xfa.setChanged(true)
+        doc = Nokogiri::XML(Nokogiri::XML::Document.wrap(@xfa.getDomDocument).to_xml)
+        doc.xpath("//*[local-name()='field']").each do |node|
+          node["access"] = "readOnly"
         end
+        @xfa.setDomDocument(doc.to_java)
+        @xfa.setChanged(true)
       end
     end
-  end
-
-  class SOM
-    def self.short_name(str)
-      XfaForm::Xml2Som.getShortName(self.escape(str))
-    end
 
-    def self.escape(str)
-      XfaForm::Xml2Som.escapeSom(str) # just does: str.gsub(/\./) { '\\.' }
-    end
   end
+
 end

data/lib/pdf_ravager/template.rb

@@ -0,0 +1,61 @@
+require 'pdf_ravager/fields/text'
+require 'pdf_ravager/fields/rich_text'
+require 'pdf_ravager/fields/checkbox'
+require 'pdf_ravager/fields/radio'
+require 'pdf_ravager/fieldsets/checkbox_group'
+require 'pdf_ravager/fieldsets/radio_group'
+require 'pdf_ravager/ravager' if RUBY_PLATFORM =~ /java/
+
+module PDFRavager
+  class Template
+    attr_reader :name, :fields
+
+    def initialize(name=nil)
+      @name, @fields = name, []
+      yield self if block_given?
+    end
+
+    def text(name, value)
+      @fields << PDFRavager::Fields::Text.new(name, value)
+    end
+
+    def rich_text(name, value)
+      @fields << PDFRavager::Fields::RichText.new(name, value)
+    end
+
+    def check(name, opts={})
+      @fields << PDFRavager::Fields::Checkbox.new(name, true, opts)
+    end
+
+    def uncheck(name, opts={})
+      @fields << PDFRavager::Fields::Checkbox.new(name, false, opts)
+    end
+
+    def fill(group_name, name)
+      @fields << PDFRavager::Fields::Radio.new(group_name, name)
+    end
+
+    def checkbox_group(group_name, &blk)
+      PDFRavager::Fieldsets::CheckboxGroup.new(self, group_name, &blk)
+    end
+
+    def radio_group(group_name, &blk)
+      PDFRavager::Fieldsets::RadioGroup.new(self, group_name, &blk)
+    end
+
+    if RUBY_PLATFORM =~ /java/
+      def ravage(file, opts={})
+        PDFRavager::Ravager.ravage(self, opts.merge({:in_file => file}))
+      end
+    else
+      def ravage(file, opts={})
+        raise "You can only ravage PDFs using JRuby, not #{RUBY_PLATFORM}!"
+      end
+    end
+
+    def ==(other)
+      self.fields == other.fields
+    end
+
+  end
+end

data/lib/pdf_ravager/version.rb

@@ -1,3 +1,3 @@
 module PDFRavager
-  VERSION = "0.0.8"
-end
+  VERSION = "0.1.0"
+end

data/pdf_ravager.gemspec

@@ -9,8 +9,8 @@ Gem::Specification.new do |s|
   s.homepage    = 'https://github.com/abevoelker/pdf_ravager'
   s.summary     = %q{DSL to aid filling out AcroForms PDF and XFA documents}
   s.description = %q{DSL to aid filling out AcroForms PDF and XFA documents}
+  s.license     = 'MIT'
 
-  s.add_dependency "json"
   s.add_dependency "nokogiri"
   s.add_development_dependency "bundler",    "~> 1.0"
   s.add_development_dependency "minitest",   "~> 4.1"
@@ -19,7 +19,7 @@ Gem::Specification.new do |s|
   s.add_development_dependency "chunky_png", "~> 1.2"
 
   s.files         = `git ls-files`.split("\n")
-  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.test_files    = ['test','spec','features'].map{|d| `git ls-files -- #{d}/*`.split("\n")}.flatten
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   s.require_paths = ["lib"]
 end

data/spec/integration/integration_helper.rb

@@ -3,20 +3,20 @@ require 'rspec'
 require 'pdf_ravager'
 require 'securerandom'
 require 'chunky_png'
+require 'tempfile'
 
-def mktemp
-  # the tests are already dependent on Linux, so /tmp/ usage should be OK
-  "/tmp/#{SecureRandom.uuid}"
+def mktemp(ext)
+  Tempfile.new(['', ext]).path
 end
 
 def pdf_to_ps(pdf_file, out_file=nil)
-  out_file ||= "#{mktemp}.ps"
+  out_file ||= mktemp('.ps')
   system("acroread -toPostScript -markupsOn -pairs #{pdf_file} #{out_file} >/dev/null 2>&1")
   out_file
 end
 
 def ps_to_png(ps_file, out_file=nil)
-  out_file ||= "#{mktemp}.png"
+  out_file ||= mktemp('.png')
   system("gs -dSAFER -dBATCH -dNOPAUSE -r150 -sDEVICE=png16m -dTextAlphaBits=4 -sOutputFile=#{out_file} #{ps_file} >/dev/null 2>&1")
   out_file
 end

data/spec/integration/multiline_text_field/spec.rb

@@ -3,11 +3,11 @@ require File.dirname(__FILE__) + '/../integration_helper'
 describe 'a PDF with a multiline text field' do
   describe 'filled with FOO' do
     before(:each) do
-      p = pdf do
-        text 'multilinetext', 'FOO' * 10000
+      p = PDFRavager::Template.new do |t|
+        t.text 'multilinetext', 'FOO' * 10000
       end
       pdf_file = File.join(File.dirname(__FILE__), "pdf")
-      @pdf_file = "#{mktemp}.pdf"
+      @pdf_file = mktemp('.pdf')
       @pdf = p.ravage pdf_file, :out_file => @pdf_file
     end
 

data/spec/integration/text_field/spec.rb

@@ -3,11 +3,11 @@ require 'integration/integration_helper'
 describe 'a PDF with a text field' do
   describe 'filled with foo' do
     before(:each) do
-      p = pdf do
-        text 'text_field', 'foo'
+      p = PDFRavager::Template.new do |t|
+        t.text 'text_field', 'foo'
       end
       pdf_file = File.join(File.dirname(__FILE__), "pdf")
-      @pdf_file = "#{mktemp}.pdf"
+      @pdf_file = mktemp('.pdf')
       @pdf = p.ravage pdf_file, :out_file => @pdf_file
     end
 

data/spec/unit/fields/checkbox_spec.rb

@@ -0,0 +1,27 @@
+require File.dirname(__FILE__) + '/fields_helper'
+require 'pdf_ravager/template'
+
+class TestCheckbox < MiniTest::Unit::TestCase
+
+  def setup
+    @checked   = PDFRavager::Fields::Checkbox.new('checkbox1', true,  :true_value => 'foo', :false_value => 'bar')
+    @unchecked = PDFRavager::Fields::Checkbox.new('checkbox2', false, :true_value => 'foo', :false_value => 'bar')
+  end
+
+  def test_that_custom_checked_acro_form_value_is_set
+    assert_equal @checked.acro_form_value, 'foo'
+  end
+
+  def test_that_custom_checked_xfa_value_is_set
+    assert_equal @checked.xfa_value, 'foo'
+  end
+
+  def test_that_custom_unchecked_acro_form_value_is_set
+    assert_equal @unchecked.acro_form_value, 'bar'
+  end
+
+  def test_that_custom_unchecked_xfa_value_is_set
+    assert_equal @unchecked.xfa_value, 'bar'
+  end
+
+end

data/spec/unit/fields/fields_helper.rb

@@ -0,0 +1 @@
+require File.dirname(__FILE__) + '/../unit_helper'

data/spec/unit/kernel_spec.rb

@@ -0,0 +1,27 @@
+require File.dirname(__FILE__) + '/unit_helper'
+require 'pdf_ravager/kernel'
+
+class TestKernelIntegration < MiniTest::Unit::TestCase
+
+  def setup
+    @template = pdf do |p|
+      p.text      'text',        'foo'
+      p.rich_text 'rich_text',   '<b>foo</b>'
+      p.check     'checkbox1'
+      p.uncheck   'checkbox2'
+      p.fill      'radio_group', 'button'
+    end
+  end
+
+  def test_that_dsl_template_equals_longform_template
+    template = PDFRavager::Template.new do |t|
+      t.text      'text',        'foo'
+      t.rich_text 'rich_text',   '<b>foo</b>'
+      t.check     'checkbox1'
+      t.uncheck   'checkbox2'
+      t.fill      'radio_group', 'button'
+    end
+    assert_equal @template, template
+  end
+
+end

data/spec/unit/template_spec.rb

@@ -0,0 +1,61 @@
+require File.dirname(__FILE__) + '/unit_helper'
+require 'pdf_ravager/template'
+
+class TestTemplate < MiniTest::Unit::TestCase
+
+  def setup
+    @template = PDFRavager::Template.new do |t|
+      t.text      'text',        'foo'
+      t.rich_text 'rich_text',   '<b>foo</b>'
+      t.check     'checkbox1'
+      t.uncheck   'checkbox2'
+      t.checkbox_group 'cbox_group' do |cb|
+        cb.check   'checked'
+        cb.uncheck 'unchecked'
+      end
+      t.fill      'radio_group', 'button'
+      t.radio_group 'better_radio_group' do |rg|
+        rg.fill 'button'
+      end
+    end
+
+    @template_with_name = PDFRavager::Template.new('template'){}
+  end
+
+  def test_that_text_is_set
+    assert_includes @template.fields, PDFRavager::Fields::Text.new('text', 'foo')
+  end
+
+  def test_that_rich_text_is_set
+    assert_includes @template.fields, PDFRavager::Fields::RichText.new('rich_text', '<b>foo</b>')
+  end
+
+  def test_that_checkbox_is_set
+    assert_includes @template.fields, PDFRavager::Fields::Checkbox.new('checkbox1', true)
+  end
+
+  def test_that_checkbox_is_unset
+    assert_includes @template.fields, PDFRavager::Fields::Checkbox.new('checkbox2', false)
+  end
+
+  def test_that_radio_button_is_filled
+    assert_includes @template.fields, PDFRavager::Fields::Radio.new('radio_group', 'button')
+  end
+
+  def test_that_name_is_set
+    assert_equal @template_with_name.name, 'template'
+  end
+
+  def test_that_checkbox_group_box_is_checked
+    assert_includes @template.fields, PDFRavager::Fields::Checkbox.new('cbox_group.checked', true)
+  end
+
+  def test_that_checkbox_group_box_is_unchecked
+    assert_includes @template.fields, PDFRavager::Fields::Checkbox.new('cbox_group.unchecked', false)
+  end
+
+  def test_that_radio_group_button_is_filled
+    assert_includes @template.fields, PDFRavager::Fields::Radio.new('better_radio_group', 'button')
+  end
+
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pdf_ravager
 version: !ruby/object:Gem::Version
-  version: 0.0.8
+  version: 0.1.0
   prerelease:
 platform: ruby
 authors:
@@ -9,38 +9,20 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2012-11-07 00:00:00.000000000 Z
+date: 2013-05-10 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: json
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: !binary |-
-          MA==
-    none: false
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: !binary |-
-          MA==
-    none: false
-  prerelease: false
-  type: :runtime
 - !ruby/object:Gem::Dependency
   name: nokogiri
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: !binary |-
           MA==
     none: false
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: !binary |-
           MA==
@@ -51,13 +33,13 @@ dependencies:
   name: bundler
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
     none: false
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
     none: false
@@ -67,13 +49,13 @@ dependencies:
   name: minitest
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '4.1'
     none: false
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '4.1'
     none: false
@@ -83,13 +65,13 @@ dependencies:
   name: rspec
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '2.11'
     none: false
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '2.11'
     none: false
@@ -99,13 +81,13 @@ dependencies:
   name: rake
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0.9'
     none: false
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0.9'
     none: false
@@ -115,13 +97,13 @@ dependencies:
   name: chunky_png
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.2'
     none: false
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.2'
     none: false
@@ -133,15 +115,24 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .travis.yml
+- ".gitignore"
+- ".travis.yml"
 - Gemfile
 - LICENSE
 - README.md
 - Rakefile
 - lib/pdf_ravager.rb
-- lib/pdf_ravager/pdf.rb
+- lib/pdf_ravager/field_types/acro_form.rb
+- lib/pdf_ravager/field_types/xfa.rb
+- lib/pdf_ravager/fields/checkbox.rb
+- lib/pdf_ravager/fields/radio.rb
+- lib/pdf_ravager/fields/rich_text.rb
+- lib/pdf_ravager/fields/text.rb
+- lib/pdf_ravager/fieldsets/checkbox_group.rb
+- lib/pdf_ravager/fieldsets/radio_group.rb
+- lib/pdf_ravager/kernel.rb
 - lib/pdf_ravager/ravager.rb
+- lib/pdf_ravager/template.rb
 - lib/pdf_ravager/version.rb
 - pdf_ravager.gemspec
 - spec/integration/integration_helper.rb
@@ -152,18 +143,22 @@ files:
 - spec/integration/text_field/pdf
 - spec/integration/text_field/spec.rb
 - spec/spec_helper.rb
-- spec/unit/pdf_spec.rb
+- spec/unit/fields/checkbox_spec.rb
+- spec/unit/fields/fields_helper.rb
+- spec/unit/kernel_spec.rb
+- spec/unit/template_spec.rb
 - spec/unit/unit_helper.rb
 - vendor/iText-4.2.0.jar
 homepage: https://github.com/abevoelker/pdf_ravager
-licenses: []
+licenses:
+- MIT
 post_install_message:
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       segments:
       - 0
@@ -173,7 +168,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   none: false
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       segments:
       - 0
@@ -187,4 +182,17 @@ rubygems_version: 1.8.24
 signing_key:
 specification_version: 3
 summary: DSL to aid filling out AcroForms PDF and XFA documents
-test_files: []
+test_files:
+- spec/integration/integration_helper.rb
+- spec/integration/multiline_text_field/expected.png
+- spec/integration/multiline_text_field/pdf
+- spec/integration/multiline_text_field/spec.rb
+- spec/integration/text_field/expected.png
+- spec/integration/text_field/pdf
+- spec/integration/text_field/spec.rb
+- spec/spec_helper.rb
+- spec/unit/fields/checkbox_spec.rb
+- spec/unit/fields/fields_helper.rb
+- spec/unit/kernel_spec.rb
+- spec/unit/template_spec.rb
+- spec/unit/unit_helper.rb

data/lib/pdf_ravager/pdf.rb

@@ -1,105 +0,0 @@
-require 'json'
-require 'pdf_ravager/ravager' if RUBY_PLATFORM =~ /java/
-
-module PDFRavager
-  class PDF
-    attr_reader :name, :fields
-
-    def initialize(name=nil, opts={})
-      @name = name if name
-      @fields = opts[:fields] || []
-    end
-
-    def text(name, value, opts={})
-      if opts.empty?
-        @fields << {:name => name, :value => value, :type => :text}
-      else
-        @fields << {:name => name, :value => value, :type => :text, :options => opts}
-      end
-    end
-
-    def check(name, opts={})
-      @fields << {:name => name, :value => true, :type => :checkbox}
-    end
-
-    def radio_group(gname, &blk)
-      fields = []
-      # TODO: replace w/ singleton method?
-      PDF.instance_eval do
-        send(:define_method, :fill) do |name, opts={}|
-          fields << {:name => gname, :value => name, :type => :radio}
-        end
-        blk.call
-        send(:undef_method, :fill)
-      end
-
-      @fields += fields
-    end
-
-    def checkbox_group(gname, &blk)
-      # TODO: replace w/ singleton method?
-      PDF.instance_eval do
-        alias_method :__check_original__, :check
-        send(:define_method, :check) do |name, opts={}|
-          __check_original__("#{gname}.#{name}", opts)
-        end
-        blk.call
-        # restore check method back to normal
-        alias_method :check, :__check_original__
-        send(:undef_method, :__check_original__)
-      end
-    end
-
-    if RUBY_PLATFORM =~ /java/
-      def ravage(file, opts={})
-        PDFRavager::Ravager.open(opts.merge(:in_file => file)) do |pdf|
-          @fields.each do |f|
-            value = if f[:type] == :checkbox
-              !!f[:value] ? '1' : '0' # Checkbox default string values
-            else
-              f[:value]
-            end
-            pdf.set_field_value(f[:name], value, f[:type], f[:options])
-          end
-        end
-      end
-    else
-      def ravage(file, opts={})
-        raise "You can only ravage .pdfs using JRuby, not #{RUBY_PLATFORM}!"
-      end
-    end
-
-    def ==(other)
-      self.name == other.name && self.fields == other.fields
-    end
-
-    def to_json(*args)
-      {
-        "json_class"   => self.class.name,
-        "data"         => {"name" => @name, "fields" => @fields }
-      }.to_json(*args)
-    end
-
-    def self.json_create(obj)
-      fields = obj["data"]["fields"].map do |f|
-        # symbolize the root keys
-        f = f.inject({}){|h,(k,v)| h[k.to_sym] = v; h}
-        f[:type] = f[:type].to_sym if f[:type]
-        # symbolize the :options keys
-        if f[:options]
-          f[:options] = f[:options].inject({}){|h,(k,v)| h[k.to_sym] = v; h}
-        end
-        f
-      end
-      o = new(obj["data"]["name"], :fields => fields)
-    end
-  end
-end
-
-module Kernel
-  def pdf(name=nil, opts={}, &blk)
-    r = PDFRavager::PDF.new(name, opts)
-    r.instance_eval(&blk)
-    r
-  end
-end

data/spec/unit/pdf_spec.rb

@@ -1,48 +0,0 @@
-require File.dirname(__FILE__) + '/unit_helper'
-require 'pdf_ravager/pdf'
-
-class TestPDF < MiniTest::Unit::TestCase
-  def setup
-    @pdf = pdf 'foo.pdf' do
-      text  'text',      'foo'
-      text  'rich_text', '<b>foo</b>', :rich => true
-      check 'checkbox'
-      checkbox_group 'checkbox_group' do
-        check 'foo'
-      end
-      radio_group 'radio_group' do
-        fill 'foo'
-      end
-    end
-
-    @pdf_from_json = JSON.parse(@pdf.to_json)
-  end
-
-  def test_that_name_is_set
-    assert_equal @pdf.name, 'foo.pdf'
-  end
-
-  def test_that_text_is_set
-    assert_includes @pdf.fields, {:name => 'text', :value => 'foo', :type => :text}
-  end
-
-  def test_that_rich_text_is_set
-    assert_includes @pdf.fields, {:name => 'rich_text', :value => '<b>foo</b>', :type => :text, :options => {:rich => true}}
-  end
-
-  def test_that_checkbox_is_set
-    assert_includes @pdf.fields, {:name => 'checkbox', :value => true, :type => :checkbox}
-  end
-
-  def test_that_checkbox_group_is_set
-    assert_includes @pdf.fields, {:name => 'checkbox_group.foo', :value => true, :type => :checkbox}
-  end
-
-  def test_that_radio_group_is_set
-    assert_includes @pdf.fields, {:name => 'radio_group', :value => 'foo', :type => :radio}
-  end
-
-  def test_json_serialization
-    assert_equal @pdf, @pdf_from_json
-  end
-end