pdf_ravager 0.0.7 → 0.0.8

data/.travis.yml

@@ -2,7 +2,13 @@ language: ruby
 rvm:
   - "1.9.2"
   - "1.9.3"
-  - jruby-19mode # JRuby in 1.9 mode
+  - jruby-19mode
   - rbx-19mode
-# uncomment this line if your project needs to run something other than `rake`:
-script: bundle exec rake test
+matrix:
+  allow_failures:
+    - rvm: jruby-19mode
+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/README.md

@@ -82,4 +82,7 @@ check 'relation.parent'
 Copyright (c) 2012 Abe Voelker. Released under the terms of the
 MIT license. See LICENSE for details.
 
-[1]: http://partners.adobe.com/public/developer/xml/index_arch.html
+The [version of iText][2] vendored is licensed under the LGPL.
+
+[1]: http://partners.adobe.com/public/developer/xml/index_arch.html
+[2]: http://itext.svn.sourceforge.net/viewvc/itext/tags/iText_4_2_0/

data/Rakefile

@@ -1,10 +1,25 @@
 require 'rspec'
+require 'rspec/core/rake_task'
 require 'rake/testtask'
 require 'bundler'
 
-Rake::TestTask.new do |t|
+Rake::TestTask.new('spec:unit') do |t|
   t.libs << ["lib", "spec"]
-  t.pattern = "spec/*_spec.rb" 
-end 
+  t.pattern = "spec/**/*_spec.rb"
+end
 
-Bundler::GemHelper.install_tasks
+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.rspec_opts = ['--backtrace']
+  end
+
+  task :spec => ['spec:unit', 'spec:integration']
+else
+  task :spec => ['spec:unit']
+end
+
+task :default => :spec
+
+Bundler::GemHelper.install_tasks

data/lib/pdf_ravager/ravager.rb

@@ -38,23 +38,40 @@ module PDFRavager
         # First try AcroForms method of setting value
         @afields.setField(SOM.short_name(name), value)
       rescue java.lang.NullPointerException
-        # If the AcroForms method doesn't work, we'll set the XDP
-        # 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)
-        doc.xpath("//*[local-name()='field'][@name='#{name}']").each do |node|
-          # Create an XML node in the XDP like this: "<value><text>#{value}</text></value>"
+      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.text_ {
+              xml.send("#{node_type}_") {
                 xml.text value
               }
             }
           end
         end
-        @xfa.setDomDocument(doc.to_java)
-        @xfa.setChanged(true)
       end
+      @xfa.setDomDocument(doc.to_java)
+      @xfa.setChanged(true)
     end
 
     def destroy
@@ -81,14 +98,27 @@ module PDFRavager
     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|
-        Nokogiri::XML::Builder.with(node) do |xml|
-          xml.value_ do
+        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
         end
       end
       @xfa.setDomDocument(doc.to_java)

data/lib/pdf_ravager/version.rb

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

data/pdf_ravager.gemspec

@@ -12,10 +12,11 @@ Gem::Specification.new do |s|
 
   s.add_dependency "json"
   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 "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"
 
   s.files         = `git ls-files`.split("\n")
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")

data/spec/integration/integration_helper.rb

@@ -0,0 +1,58 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+require 'rspec'
+require 'pdf_ravager'
+require 'securerandom'
+require 'chunky_png'
+
+def mktemp
+  # the tests are already dependent on Linux, so /tmp/ usage should be OK
+  "/tmp/#{SecureRandom.uuid}"
+end
+
+def pdf_to_ps(pdf_file, out_file=nil)
+  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"
+  system("gs -dSAFER -dBATCH -dNOPAUSE -r150 -sDEVICE=png16m -dTextAlphaBits=4 -sOutputFile=#{out_file} #{ps_file} >/dev/null 2>&1")
+  out_file
+end
+
+def pdf_to_png(pdf_file)
+  ps_to_png(pdf_to_ps(pdf_file))
+end
+
+# code taken from http://jeffkreeftmeijer.com/2011/comparing-images-and-creating-image-diffs/
+def png_diff(img1, img2)
+  images = [
+    ChunkyPNG::Image.from_file(img1),
+    ChunkyPNG::Image.from_file(img2)
+  ]
+
+  output = ChunkyPNG::Image.new(images.first.width, images.last.width, ChunkyPNG::Color::WHITE)
+
+  diff = []
+
+  images.first.height.times do |y|
+    images.first.row(y).each_with_index do |pixel, x|
+      unless pixel == images.last[x,y]
+        score = Math.sqrt(
+          (ChunkyPNG::Color::r(images.last[x,y]) - ChunkyPNG::Color::r(pixel)) ** 2 +
+          (ChunkyPNG::Color::g(images.last[x,y]) - ChunkyPNG::Color::g(pixel)) ** 2 +
+          (ChunkyPNG::Color::b(images.last[x,y]) - ChunkyPNG::Color::b(pixel)) ** 2
+        ) / Math.sqrt(ChunkyPNG::Color::MAX ** 2 * 3)
+
+        output[x,y] = ChunkyPNG::Color::grayscale(ChunkyPNG::Color::MAX - (score * ChunkyPNG::Color::MAX).round)
+        diff << score
+      end
+    end
+  end
+
+  num_pixels_changed = diff.length
+  pct_changed = (num_pixels_changed == 0) ? 0 : (diff.inject(:+) / images.first.pixels.length) * 100
+
+  [num_pixels_changed, pct_changed]
+end

data/spec/integration/multiline_text_field/spec.rb

@@ -0,0 +1,20 @@
+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
+      end
+      pdf_file = File.join(File.dirname(__FILE__), "pdf")
+      @pdf_file = "#{mktemp}.pdf"
+      @pdf = p.ravage pdf_file, :out_file => @pdf_file
+    end
+
+    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
+    end
+  end
+end

data/spec/integration/text_field/spec.rb

@@ -0,0 +1,20 @@
+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'
+      end
+      pdf_file = File.join(File.dirname(__FILE__), "pdf")
+      @pdf_file = "#{mktemp}.pdf"
+      @pdf = p.ravage pdf_file, :out_file => @pdf_file
+    end
+
+    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
+    end
+  end
+end

data/spec/{pdf_spec.rb → unit/pdf_spec.rb}

@@ -1,4 +1,4 @@
-require 'spec_helper'
+require File.dirname(__FILE__) + '/unit_helper'
 require 'pdf_ravager/pdf'
 
 class TestPDF < MiniTest::Unit::TestCase

data/spec/unit/unit_helper.rb

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

metadata

@@ -1,15 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: pdf_ravager
 version: !ruby/object:Gem::Version
+  version: 0.0.8
   prerelease:
-  version: 0.0.7
 platform: ruby
 authors:
 - Abe Voelker
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2012-10-30 00:00:00.000000000 Z
+date: 2012-11-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -17,13 +17,15 @@ dependencies:
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: !binary |-
+          MA==
     none: false
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: !binary |-
+          MA==
     none: false
   prerelease: false
   type: :runtime
@@ -33,13 +35,15 @@ dependencies:
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: !binary |-
+          MA==
     none: false
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: !binary |-
+          MA==
     none: false
   prerelease: false
   type: :runtime
@@ -107,6 +111,22 @@ dependencies:
     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
 email: abe@abevoelker.com
 executables: []
@@ -124,8 +144,16 @@ files:
 - lib/pdf_ravager/ravager.rb
 - lib/pdf_ravager/version.rb
 - pdf_ravager.gemspec
-- spec/pdf_spec.rb
+- 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/pdf_spec.rb
+- spec/unit/unit_helper.rb
 - vendor/iText-4.2.0.jar
 homepage: https://github.com/abevoelker/pdf_ravager
 licenses: []
@@ -137,13 +165,21 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
-      version: '0'
+      segments:
+      - 0
+      version: !binary |-
+        MA==
+      hash: 2
   none: false
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
-      version: '0'
+      segments:
+      - 0
+      version: !binary |-
+        MA==
+      hash: 2
   none: false
 requirements: []
 rubyforge_project:
@@ -152,4 +188,3 @@ signing_key:
 specification_version: 3
 summary: DSL to aid filling out AcroForms PDF and XFA documents
 test_files: []
-...