pdf_ravager 0.1.0 → 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 78b00f06cc54b5f044001f621fc30d284a02410e
+  data.tar.gz: b9fac87df32a1e3033d2e73f622b0665e761b3da
+SHA512:
+  metadata.gz: 8dc1d7f6bca130cb731862d507463df813775abc7cbff40a7f5313fe28e92b5e327677cc2103718621bbc0ae12687d88e692146428b93863e7bd5cec81ec1043
+  data.tar.gz: cba64b43ca4100a42d7b10e77daa5112fcac7ec4df066e2b2cdfe57c42dc1dc349c62c14a1e382d7315039763f29d8d69a2bad39a3618bbafb919604e3ff595c

data/.gitignore

@@ -2,3 +2,4 @@ Gemfile.lock
 pkg/
 *.gem
 .bundle
+coverage/

data/.rspec

@@ -0,0 +1,3 @@
+--tty
+--color
+--profile

data/CHANGELOG.md

@@ -0,0 +1,8 @@
+## 0.2.0
+
+Features:
+
+  - Deprecate global `pdf` convenience method
+  - Deprecate name option to `PDFRavager::Template.new`
+  - Move PDF population methods into strategies
+  - Speed up PDF population by default (i.e. :smart strategy) by avoiding XFA

data/Gemfile

@@ -5,9 +5,7 @@ gemspec
 platforms :jruby do
   # Necessary for `rake release` on JRuby
   gem "jruby-openssl", "~> 0.7.7"
+  gem 'bouncy-castle-java'
 end
 
-group :test do
-  # Formats and colorizes test output
-  gem "turn", "~> 0.9.6", :require => false
-end
+gem "simplecov", "~> 0.8", :require => false

data/README.md

@@ -1,21 +1,21 @@
 # PDF Ravager [![Build Status](https://secure.travis-ci.org/abevoelker/pdf_ravager.png)](http://travis-ci.org/abevoelker/pdf_ravager)
 
-Provides a simple DSL for easily filling out AcroForms PDF or XFA documents.
+JRuby-only DSL for filling out AcroForms PDF or XFA documents.
 
 ## Description
 
 This library uses a combination of a simple DSL and a minimal façade over the
-last free version of the iText library to aid in filling out AcroForms PDF or
-XFA documents.
+last free version of the Java iText library to aid in filling out AcroForms PDF
+or XFA documents.
 
 ## Synopsis
 
 ```ruby
-require 'pdf_ravager/kernel'
+require 'pdf_ravager'
 
-data = {name: 'Bob', gender: 'm', relation: 'Uncle' }
+data = { name: 'Bob', gender: 'm', relation: 'Uncle' }
 
-template = pdf do |p|
+template = PDFRavager::Template.new do |p|
   p.text      'name', data[:name]
   p.rich_text 'name_stylized', "<b>#{data[:name]}</b>"
   p.radio_group 'sex' do |rg|
@@ -40,20 +40,24 @@ template.ravage '/tmp/info.pdf', out_file: '/tmp/info_filled.pdf'
 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:
+Although not recommended due to the pollution of the global namespace, in the
+interest of brevity you can introduce a shorthand `pdf` method that is
+equivalent to `PDFRavager::Template.new` by requiring `pdf_ravager/kernel`
+instead of `pdf_ravager`:
 
 ```ruby
-require 'pdf_ravager'
+require 'pdf_ravager/kernel'
 
 data = {name: 'Bob', gender: 'm', relation: 'Uncle' }
 
-template = PDFRavager::Template.new do |p|
+template = pdf do |p|
   p.text 'name', data[:name]
   # ...
 end
 ```
 
+Note: `pdf` has been deprecated and will be removed in a future release.
+
 ## Usage
 
 ### Field Names

data/Rakefile

@@ -5,13 +5,13 @@ require 'bundler'
 
 Rake::TestTask.new('spec:unit') do |t|
   t.libs << ["lib", "spec"]
-  t.pattern = "spec/**/*_spec.rb"
+  t.pattern = "spec/unit/**/*_spec.rb"
 end
 
 if RUBY_PLATFORM =~ /java/
   # Integration tests can only run on JRuby
   RSpec::Core::RakeTask.new('spec:integration') do |spec|
-    spec.pattern = "spec/**/*spec.rb"
+    spec.pattern = "spec/integration/**/*spec.rb"
     spec.rspec_opts = ['--backtrace']
   end
 

data/lib/pdf_ravager/field_types/acro_form.rb

@@ -23,14 +23,6 @@ module PDFRavager
         @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/kernel.rb

@@ -2,6 +2,7 @@ require 'pdf_ravager/template'
 
 module Kernel
   def pdf(*args, &blk)
+    warn "[DEPRECATION] Please use `PDFRavager::Template.new` instead of `pdf`"
     PDFRavager::Template.new(*args, &blk)
   end
 end

data/lib/pdf_ravager/ravager.rb

@@ -1,3 +1,7 @@
+require 'pdf_ravager/strategies/xfa'
+require 'pdf_ravager/strategies/acro_form'
+require 'pdf_ravager/strategies/smart'
+
 unless RUBY_PLATFORM =~ /java/
   raise "You can only ravage PDFs using JRuby, not #{RUBY_PLATFORM}!"
 end
@@ -8,71 +12,38 @@ require File.dirname(__FILE__)  + '/../../vendor/iText-4.2.0'
 
 module PDFRavager
   class Ravager
-    private_class_method :new
+    def self.ravage(*args, &blk)
+      warn "[DEPRECATION] Please use PDFRavager::Ravager's instance " +
+           "methods instead of the `::ravage` method"
+      new(*args, &blk).ravage
+    end
 
-    def self.ravage(template, opts={})
+    def initialize(template, opts={})
+      @opts = opts
       opts = {:in_file => opts} if opts.is_a? String
-      out = if opts[:out_file]
+      @out = if opts[:out_file]
         java.io.FileOutputStream.new(opts[:out_file])
       else
         java.io.ByteArrayOutputStream.new
       end
-      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
-
-    private
-
-    # 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
-      @som_template = @xfa.getTemplateSom
-      @type = @xfa.isXfaPresent ? :xfa : :acro_forms
-      if @type == :xfa
-        @xfa_type = @afields.getFields.empty? ? :dynamic : :static
-      end
-    end
-
-    def destroy
-      @stamper.close
-    end
-
-    def set_field_values
-      case @type
+      @template = template
+      reader = com.lowagie.text.pdf.PdfReader.new(opts[:in_file])
+      @stamper = com.lowagie.text.pdf.PdfStamper.new(reader, @out)
+      @strategy = case template.strategy
       when :acro_forms
-        @template.fields.each{|f| f.set_acro_form_value(@afields) }
+        Strategies::AcroForm.new(@stamper)
       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
+        Strategies::XFA.new(@stamper)
+      when :smart
+        Strategies::Smart.new(@stamper)
       end
     end
 
-    def set_read_only
-      case @type
-      when :acro_forms
-        @stamper.setFormFlattening(true)
-      when :xfa
-        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
+    def ravage
+      @strategy.set_field_values(@template)
+      @strategy.set_read_only if @opts[:read_only]
+      @stamper.close
+      @out
     end
-
   end
-
 end

data/lib/pdf_ravager/strategies/acro_form.rb

@@ -0,0 +1,25 @@
+module PDFRavager
+  module Strategies
+    class AcroForm
+      def initialize(stamper)
+        @stamper = stamper
+        @afields = stamper.getAcroFields
+      end
+
+      def set_field_values(template)
+        template.fields.select{|f| f.respond_to?(:acro_form_value)}.select do |f|
+          begin
+            @afields.setField(FieldTypes::AcroForm::SOM.short_name(f.acro_form_name), f.acro_form_value)
+          rescue java.lang.NullPointerException
+            false
+          end
+        end
+      end
+
+      def set_read_only
+        @stamper.setFormFlattening(true)
+      end
+
+    end
+  end
+end

data/lib/pdf_ravager/strategies/smart.rb

@@ -0,0 +1,22 @@
+module PDFRavager
+  module Strategies
+    class Smart
+      def initialize(stamper)
+        @acro_form = Strategies::AcroForm.new(stamper)
+        @xfa       = Strategies::XFA.new(stamper)
+      end
+
+      def set_field_values(template)
+        parsed_fields = @acro_form.set_field_values(template)
+        unparsed_fields = template.fields - parsed_fields
+        if unparsed_fields.any?
+          @xfa.set_field_values(Template.new{|t| t.fields = unparsed_fields })
+        end
+      end
+
+      def set_read_only
+        [@acro_form, @xfa].each(&:set_read_only)
+      end
+    end
+  end
+end

data/lib/pdf_ravager/strategies/xfa.rb

@@ -0,0 +1,67 @@
+module PDFRavager
+  module Strategies
+    class XFA
+      def initialize(stamper)
+        @xfa = stamper.getAcroFields.getXfa
+      end
+
+      def set_field_values(template)
+        # 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)
+        template.fields.select{|f| f.respond_to?(:set_xfa_value)}.each do |f|
+          # first, assume the user-provided field name is an xpath and use it directly:
+          strict_match =
+            begin
+              doc.xpath(f.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='#{f.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()='#{f.xfa_node_type}']")
+              if text_node
+                # Complete node structure already exists - just set the value
+                text_node.content = f.xfa_value
+              else
+                # <value> node exists, but without child <text> node
+                Nokogiri::XML::Builder.with(value_node) do |xml|
+                  xml.text_ {
+                    xml.send("#{f.xfa_node_type}_", f.xfa_value)
+                  }
+                end
+              end
+            else
+              # No <value> node exists - create whole structure
+              Nokogiri::XML::Builder.with(node) do |xml|
+                xml.value_ {
+                  xml.send("#{f.xfa_node_type}_") {
+                    xml.text f.xfa_value
+                  }
+                }
+              end
+            end
+          end
+        end
+        @xfa.tap do |x|
+          x.setDomDocument(doc.to_java)
+          x.setChanged(true)
+        end
+      end
+
+      def set_read_only
+        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
+end

data/lib/pdf_ravager/template.rb

@@ -8,10 +8,20 @@ require 'pdf_ravager/ravager' if RUBY_PLATFORM =~ /java/
 
 module PDFRavager
   class Template
-    attr_reader :name, :fields
+    attr_reader   :name, :strategy
+    attr_accessor :fields
 
-    def initialize(name=nil)
-      @name, @fields = name, []
+    def initialize(opts={})
+      opts = {:name => opts} if opts.respond_to?(:to_sym)
+      unless opts[:name].nil?
+        warn "[DEPRECATION] Passing a name to `PDFRavager::Template.new` " +
+             "is deprecated and will be removed in 1.0.0"
+      end
+      @name, @strategy = opts[:name], (opts[:strategy] || :smart)
+      unless [:smart, :acro_forms, :xfa].include?(@strategy)
+        raise "Bad strategy '#{@strategy}'"
+      end
+      @fields = []
       yield self if block_given?
     end
 
@@ -45,7 +55,7 @@ module PDFRavager
 
     if RUBY_PLATFORM =~ /java/
       def ravage(file, opts={})
-        PDFRavager::Ravager.ravage(self, opts.merge({:in_file => file}))
+        PDFRavager::Ravager.new(self, opts.merge({:in_file => file})).ravage
       end
     else
       def ravage(file, opts={})

data/lib/pdf_ravager/version.rb

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

data/pdf_ravager.gemspec

@@ -7,13 +7,12 @@ Gem::Specification.new do |s|
   s.authors     = ['Abe Voelker']
   s.email       = 'abe@abevoelker.com'
   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.summary     = %q{JRuby-only DSL for filling out AcroForms PDF and XFA documents}
+  s.description = %q{JRuby-only DSL for filling out AcroForms PDF and XFA documents}
   s.license     = 'MIT'
 
   s.add_dependency "nokogiri"
   s.add_development_dependency "bundler",    "~> 1.0"
-  s.add_development_dependency "minitest",   "~> 4.1"
   s.add_development_dependency "rspec",      "~> 2.11"
   s.add_development_dependency "rake",       "~> 0.9"
   s.add_development_dependency "chunky_png", "~> 1.2"

data/spec/integration/checkbox_field/spec.rb

@@ -0,0 +1,31 @@
+require File.dirname(__FILE__) + '/../integration_helper'
+
+describe 'a PDF with a checkbox field' do
+  let(:input_pdf) { File.join(File.dirname(__FILE__), "pdf") }
+
+  context 'unchecked' do
+    let(:template) {
+      PDFRavager::Template.new
+    }
+    let(:expected) { File.join(File.dirname(__FILE__), "unchecked.png") }
+
+    it 'matches unchecked.png when rendered' do
+      pix_diff, _ = compare_pdf_to_png(ravage_to_temp_file(template, input_pdf), expected)
+      expect(pix_diff).to eq(0)
+    end
+  end
+
+  context 'checked' do
+    let(:template) {
+      PDFRavager::Template.new do |t|
+        t.check 'CheckBox1'
+      end
+    }
+    let(:expected) { File.join(File.dirname(__FILE__), "checked.png") }
+
+    it 'matches checked.png when rendered' do
+      pix_diff, _ = compare_pdf_to_png(ravage_to_temp_file(template, input_pdf), expected)
+      expect(pix_diff).to eq(0)
+    end
+  end
+end

data/spec/integration/checkbox_group/spec.rb

@@ -0,0 +1,49 @@
+require File.dirname(__FILE__) + '/../integration_helper'
+
+describe 'a PDF with a checkbox group' do
+  let(:input_pdf) { File.join(File.dirname(__FILE__), "pdf") }
+
+  context 'nothing checked' do
+    let(:template) {
+      PDFRavager::Template.new
+    }
+    let(:expected) { File.join(File.dirname(__FILE__), "unchecked.png") }
+
+    it 'matches unchecked.png when rendered' do
+      pix_diff, _ = compare_pdf_to_png(ravage_to_temp_file(template, input_pdf), expected)
+      expect(pix_diff).to eq(0)
+    end
+  end
+
+  context 'CheckBoxGroup.foo checked' do
+    let(:template) {
+      PDFRavager::Template.new do |t|
+        t.checkbox_group 'CheckBoxGroup' do |g|
+          g.check 'foo'
+        end
+      end
+    }
+    let(:expected) { File.join(File.dirname(__FILE__), "foo.png") }
+
+    it 'matches foo.png when rendered' do
+      pix_diff, _ = compare_pdf_to_png(ravage_to_temp_file(template, input_pdf), expected)
+      expect(pix_diff).to eq(0)
+    end
+  end
+
+  context 'CheckBoxGroup.bar checked' do
+    let(:template) {
+      PDFRavager::Template.new do |t|
+        t.checkbox_group 'CheckBoxGroup' do |g|
+          g.check 'bar'
+        end
+      end
+    }
+    let(:expected) { File.join(File.dirname(__FILE__), "bar.png") }
+
+    it 'matches bar.png when rendered' do
+      pix_diff, _ = compare_pdf_to_png(ravage_to_temp_file(template, input_pdf), expected)
+      expect(pix_diff).to eq(0)
+    end
+  end
+end

data/spec/integration/integration_helper.rb

@@ -1,12 +1,13 @@
 require File.dirname(__FILE__) + '/../spec_helper'
-require 'rspec'
-require 'pdf_ravager'
 require 'securerandom'
 require 'chunky_png'
 require 'tempfile'
 
 def mktemp(ext)
-  Tempfile.new(['', ext]).path
+  f = Tempfile.new(['', ext])
+  (@@prevent_gc ||= []) << f # prevents file from getting deleted until all tests are done
+  f.close
+  f.path
 end
 
 def pdf_to_ps(pdf_file, out_file=nil)
@@ -25,6 +26,16 @@ def pdf_to_png(pdf_file)
   ps_to_png(pdf_to_ps(pdf_file))
 end
 
+def ravage_to_temp_file(template, input_pdf)
+  file = mktemp('.pdf')
+  template.ravage input_pdf, :out_file => file
+  file
+end
+
+def compare_pdf_to_png(input_pdf, png)
+  png_diff(pdf_to_png(input_pdf), png)
+end
+
 # code taken from http://jeffkreeftmeijer.com/2011/comparing-images-and-creating-image-diffs/
 def png_diff(img1, img2)
   images = [

data/spec/integration/multiline_text_field/spec.rb

@@ -1,20 +1,19 @@
 require File.dirname(__FILE__) + '/../integration_helper'
 
 describe 'a PDF with a multiline text field' do
-  describe 'filled with FOO' do
-    before(:each) do
-      p = PDFRavager::Template.new do |t|
+  let(:input_pdf) { File.join(File.dirname(__FILE__), "pdf") }
+
+  context 'filled with FOO' do
+    let(:template) {
+      PDFRavager::Template.new do |t|
         t.text 'multilinetext', 'FOO' * 10000
       end
-      pdf_file = File.join(File.dirname(__FILE__), "pdf")
-      @pdf_file = mktemp('.pdf')
-      @pdf = p.ravage pdf_file, :out_file => @pdf_file
-    end
+    }
+    let(:expected) { File.join(File.dirname(__FILE__), "expected.png") }
 
-    it 'should match expected.png when rendered' do
-      png = pdf_to_png(@pdf_file)
-      pix_diff, pct_diff = png_diff(png, File.join(File.dirname(__FILE__), "expected.png"))
-      pix_diff.should == 0
+    it 'matches expected.png when rendered' do
+      pix_diff, _ = compare_pdf_to_png(ravage_to_temp_file(template, input_pdf), expected)
+      expect(pix_diff).to eq(0)
     end
   end
 end

data/spec/integration/radio_field/spec.rb

@@ -0,0 +1,45 @@
+require File.dirname(__FILE__) + '/../integration_helper'
+
+describe 'a PDF with a radio field' do
+  let(:input_pdf) { File.join(File.dirname(__FILE__), "pdf") }
+
+  context 'with nothing filled in' do
+    let(:template) {
+      PDFRavager::Template.new
+    }
+    let(:expected) { File.join(File.dirname(__FILE__), "empty.png") }
+
+    it 'matches empty.png when rendered' do
+      pix_diff, _ = compare_pdf_to_png(ravage_to_temp_file(template, input_pdf), expected)
+      expect(pix_diff).to eq(0)
+    end
+  end
+
+  context 'with "Yes" filled in' do
+    let(:template) {
+      PDFRavager::Template.new do |t|
+        t.fill 'RadioButtonList', 'Yes'
+      end
+    }
+    let(:expected) { File.join(File.dirname(__FILE__), "yes.png") }
+
+    it 'matches yes.png when rendered' do
+      pix_diff, _ = compare_pdf_to_png(ravage_to_temp_file(template, input_pdf), expected)
+      expect(pix_diff).to eq(0)
+    end
+  end
+
+  context 'with "No" filled in' do
+    let(:template) {
+      PDFRavager::Template.new do |t|
+        t.fill 'RadioButtonList', 'No'
+      end
+    }
+    let(:expected) { File.join(File.dirname(__FILE__), "no.png") }
+
+    it 'matches no.png when rendered' do
+      pix_diff, _ = compare_pdf_to_png(ravage_to_temp_file(template, input_pdf), expected)
+      expect(pix_diff).to eq(0)
+    end
+  end
+end

data/spec/integration/text_field/spec.rb

@@ -1,20 +1,19 @@
-require 'integration/integration_helper'
+require File.dirname(__FILE__) + '/../integration_helper'
 
 describe 'a PDF with a text field' do
-  describe 'filled with foo' do
-    before(:each) do
-      p = PDFRavager::Template.new do |t|
+  let(:input_pdf) { File.join(File.dirname(__FILE__), "pdf") }
+
+  context 'filled with foo' do
+    let(:template) {
+      PDFRavager::Template.new do |t|
         t.text 'text_field', 'foo'
       end
-      pdf_file = File.join(File.dirname(__FILE__), "pdf")
-      @pdf_file = mktemp('.pdf')
-      @pdf = p.ravage pdf_file, :out_file => @pdf_file
-    end
+    }
+    let(:expected) { File.join(File.dirname(__FILE__), "expected.png") }
 
-    it 'should match expected.png when rendered' do
-      png = pdf_to_png(@pdf_file)
-      pix_diff, pct_diff = png_diff(png, File.join(File.dirname(__FILE__), "expected.png"))
-      pix_diff.should be 0
+    it 'matches expected.png when rendered' do
+      pix_diff, _ = compare_pdf_to_png(ravage_to_temp_file(template, input_pdf), expected)
+      expect(pix_diff).to eq(0)
     end
   end
 end

data/spec/spec_helper.rb

@@ -1 +1,4 @@
-require 'turn/autorun'
+require 'simplecov'
+SimpleCov.start
+require 'rspec'
+require 'pdf_ravager'

data/spec/unit/fields/checkbox_spec.rb

@@ -1,27 +1,36 @@
 require File.dirname(__FILE__) + '/fields_helper'
-require 'pdf_ravager/template'
 
-class TestCheckbox < MiniTest::Unit::TestCase
+describe PDFRavager::Fields::Checkbox do
 
-  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
+  let(:checked)   { PDFRavager::Fields::Checkbox.new('checkbox1', true,  :true_value => 'foo', :false_value => 'bar') }
+  let(:unchecked) { PDFRavager::Fields::Checkbox.new('checkbox2', false, :true_value => 'foo', :false_value => 'bar') }
 
-  def test_that_custom_checked_acro_form_value_is_set
-    assert_equal @checked.acro_form_value, 'foo'
-  end
+  context 'checked' do
+    context 'AcroForm value' do
+      it 'sets value properly' do
+        expect(checked.xfa_value).to eq('foo')
+      end
+    end
 
-  def test_that_custom_checked_xfa_value_is_set
-    assert_equal @checked.xfa_value, 'foo'
+    context 'XFA value' do
+      it 'sets value properly' do
+        expect(checked.xfa_value).to eq('foo')
+      end
+    end
   end
 
-  def test_that_custom_unchecked_acro_form_value_is_set
-    assert_equal @unchecked.acro_form_value, 'bar'
-  end
+  context 'unchecked' do
+    context 'AcroForm value' do
+      it 'sets value properly' do
+        expect(unchecked.xfa_value).to eq('bar')
+      end
+    end
 
-  def test_that_custom_unchecked_xfa_value_is_set
-    assert_equal @unchecked.xfa_value, 'bar'
+    context 'XFA value' do
+      it 'sets value properly' do
+        expect(unchecked.xfa_value).to eq('bar')
+      end
+    end
   end
 
 end

data/spec/unit/kernel_spec.rb

@@ -1,27 +1,33 @@
 require File.dirname(__FILE__) + '/unit_helper'
 require 'pdf_ravager/kernel'
 
-class TestKernelIntegration < MiniTest::Unit::TestCase
-
-  def setup
-    @template = pdf do |p|
+describe Kernel do
+  let(: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|
+  let(:longform_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
+  }
+
+  context 'equality' do
+    context 'a shorthand and longform template with equal options' do
+      it 'is equal' do
+        expect(template).to eq(longform_template)
+      end
+    end
   end
 
 end

data/spec/unit/template_spec.rb

@@ -1,61 +1,111 @@
 require File.dirname(__FILE__) + '/unit_helper'
-require 'pdf_ravager/template'
 
-class TestTemplate < MiniTest::Unit::TestCase
+describe PDFRavager::Template do
 
-  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'
+  context 'initialization' do
+    context 'template with a name' do
+      let(:template) { PDFRavager::Template.new('template') }
+
+      it 'sets the name' do
+        expect(template.name).to eq('template')
       end
-      t.fill      'radio_group', 'button'
-      t.radio_group 'better_radio_group' do |rg|
-        rg.fill 'button'
+    end
+
+    context 'template without a name' do
+      let(:template) { PDFRavager::Template.new }
+
+      it 'does not set the name' do
+        expect(template.name).to be_nil
       end
     end
 
-    @template_with_name = PDFRavager::Template.new('template'){}
-  end
+    context 'setting strategy' do
+      context 'with a valid strategy' do
+        let(:template) { PDFRavager::Template.new(:strategy => :xfa) }
 
-  def test_that_text_is_set
-    assert_includes @template.fields, PDFRavager::Fields::Text.new('text', 'foo')
-  end
+        it 'sets the strategy' do
+          expect(template.strategy).to eq(:xfa)
+        end
+      end
 
-  def test_that_rich_text_is_set
-    assert_includes @template.fields, PDFRavager::Fields::RichText.new('rich_text', '<b>foo</b>')
+      context 'with an invalid strategy' do
+        it 'raises an error' do
+          expect { PDFRavager::Template.new(:strategy => :foo) }.to raise_error
+        end
+      end
+    end
   end
 
-  def test_that_checkbox_is_set
-    assert_includes @template.fields, PDFRavager::Fields::Checkbox.new('checkbox1', true)
-  end
+  context 'setting template values' do
 
-  def test_that_checkbox_is_unset
-    assert_includes @template.fields, PDFRavager::Fields::Checkbox.new('checkbox2', false)
-  end
+    let(: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
+    }
 
-  def test_that_radio_button_is_filled
-    assert_includes @template.fields, PDFRavager::Fields::Radio.new('radio_group', 'button')
-  end
+    context 'text' do
+      it 'is set' do
+        expect(template.fields).to include(PDFRavager::Fields::Text.new('text', 'foo'))
+      end
+    end
 
-  def test_that_name_is_set
-    assert_equal @template_with_name.name, 'template'
-  end
+    context 'rich_text' do
+      it 'is set' do
+        expect(template.fields).to include(PDFRavager::Fields::RichText.new('rich_text', '<b>foo</b>'))
+      end
+    end
 
-  def test_that_checkbox_group_box_is_checked
-    assert_includes @template.fields, PDFRavager::Fields::Checkbox.new('cbox_group.checked', true)
-  end
+    context 'checkbox1' do
+      it 'is set' do
+        expect(template.fields).to include(PDFRavager::Fields::Checkbox.new('checkbox1', true))
+      end
+    end
 
-  def test_that_checkbox_group_box_is_unchecked
-    assert_includes @template.fields, PDFRavager::Fields::Checkbox.new('cbox_group.unchecked', false)
-  end
+    context 'checkbox2' do
+      it 'is unset' do
+        expect(template.fields).to include(PDFRavager::Fields::Checkbox.new('checkbox2', false))
+      end
+    end
+
+    context 'cbox_group' do
+      context '.checked' do
+        it 'is checked' do
+          expect(template.fields).to include(PDFRavager::Fields::Checkbox.new('cbox_group.checked', true))
+        end
+      end
+
+      context '.unchecked' do
+        it 'is unchecked' do
+          expect(template.fields).to include(PDFRavager::Fields::Checkbox.new('cbox_group.unchecked', false))
+        end
+      end
+    end
 
-  def test_that_radio_group_button_is_filled
-    assert_includes @template.fields, PDFRavager::Fields::Radio.new('better_radio_group', 'button')
+    context 'radio buttons' do
+      context 'one-line syntax' do
+        it 'fills the radio_group button' do
+          expect(template.fields).to include(PDFRavager::Fields::Radio.new('radio_group', 'button'))
+        end
+      end
+
+      context 'block syntax' do
+        it 'fills the better_radio_group button' do
+          expect(template.fields).to include(PDFRavager::Fields::Radio.new('better_radio_group', 'button'))
+        end
+      end
+    end
   end
 
 end

data/spec/unit/unit_helper.rb

@@ -1,2 +1,2 @@
 require File.dirname(__FILE__) + '/../spec_helper'
-require 'minitest/autorun'
+require 'rspec/autorun'

metadata

@@ -1,122 +1,95 @@
 --- !ruby/object:Gem::Specification
 name: pdf_ravager
 version: !ruby/object:Gem::Version
-  version: 0.1.0
-  prerelease:
+  version: 0.2.0
 platform: ruby
 authors:
 - Abe Voelker
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2013-05-10 00:00:00.000000000 Z
+date: 2014-03-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
-        version: !binary |-
-          MA==
-    none: false
+        version: '0'
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
-        version: !binary |-
-          MA==
-    none: false
+        version: '0'
   prerelease: false
   type: :runtime
 - !ruby/object:Gem::Dependency
   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
-  prerelease: false
-  type: :development
-- !ruby/object:Gem::Dependency
-  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
   prerelease: false
   type: :development
 - !ruby/object:Gem::Dependency
   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
   prerelease: false
   type: :development
 - !ruby/object:Gem::Dependency
   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
   prerelease: false
   type: :development
 - !ruby/object:Gem::Dependency
   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
   prerelease: false
   type: :development
-description: DSL to aid filling out AcroForms PDF and XFA documents
+description: JRuby-only DSL for filling out AcroForms PDF and XFA documents
 email: abe@abevoelker.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitignore"
-- ".travis.yml"
+- .gitignore
+- .rspec
+- .travis.yml
+- CHANGELOG.md
 - Gemfile
 - LICENSE
 - README.md
@@ -132,13 +105,30 @@ files:
 - lib/pdf_ravager/fieldsets/radio_group.rb
 - lib/pdf_ravager/kernel.rb
 - lib/pdf_ravager/ravager.rb
+- lib/pdf_ravager/strategies/acro_form.rb
+- lib/pdf_ravager/strategies/smart.rb
+- lib/pdf_ravager/strategies/xfa.rb
 - lib/pdf_ravager/template.rb
 - lib/pdf_ravager/version.rb
 - pdf_ravager.gemspec
+- spec/integration/checkbox_field/checked.png
+- spec/integration/checkbox_field/pdf
+- spec/integration/checkbox_field/spec.rb
+- spec/integration/checkbox_field/unchecked.png
+- spec/integration/checkbox_group/bar.png
+- spec/integration/checkbox_group/foo.png
+- spec/integration/checkbox_group/pdf
+- spec/integration/checkbox_group/spec.rb
+- spec/integration/checkbox_group/unchecked.png
 - 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/radio_field/empty.png
+- spec/integration/radio_field/no.png
+- spec/integration/radio_field/pdf
+- spec/integration/radio_field/spec.rb
+- spec/integration/radio_field/yes.png
 - spec/integration/text_field/expected.png
 - spec/integration/text_field/pdf
 - spec/integration/text_field/spec.rb
@@ -152,41 +142,46 @@ files:
 homepage: https://github.com/abevoelker/pdf_ravager
 licenses:
 - MIT
+metadata: {}
 post_install_message:
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - '>='
     - !ruby/object:Gem::Version
-      segments:
-      - 0
-      version: !binary |-
-        MA==
-      hash: 2
-  none: false
+      version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - '>='
     - !ruby/object:Gem::Version
-      segments:
-      - 0
-      version: !binary |-
-        MA==
-      hash: 2
-  none: false
+      version: '0'
 requirements: []
 rubyforge_project:
-rubygems_version: 1.8.24
+rubygems_version: 2.1.9
 signing_key:
-specification_version: 3
-summary: DSL to aid filling out AcroForms PDF and XFA documents
+specification_version: 4
+summary: JRuby-only DSL for filling out AcroForms PDF and XFA documents
 test_files:
+- spec/integration/checkbox_field/checked.png
+- spec/integration/checkbox_field/pdf
+- spec/integration/checkbox_field/spec.rb
+- spec/integration/checkbox_field/unchecked.png
+- spec/integration/checkbox_group/bar.png
+- spec/integration/checkbox_group/foo.png
+- spec/integration/checkbox_group/pdf
+- spec/integration/checkbox_group/spec.rb
+- spec/integration/checkbox_group/unchecked.png
 - 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/radio_field/empty.png
+- spec/integration/radio_field/no.png
+- spec/integration/radio_field/pdf
+- spec/integration/radio_field/spec.rb
+- spec/integration/radio_field/yes.png
 - spec/integration/text_field/expected.png
 - spec/integration/text_field/pdf
 - spec/integration/text_field/spec.rb