pdf_ravager 0.0.7

data/.gitignore

@@ -0,0 +1,4 @@
+Gemfile.lock
+pkg/
+*.gem
+.bundle

data/.travis.yml

@@ -0,0 +1,8 @@
+language: ruby
+rvm:
+  - "1.9.2"
+  - "1.9.3"
+  - jruby-19mode # JRuby in 1.9 mode
+  - rbx-19mode
+# uncomment this line if your project needs to run something other than `rake`:
+script: bundle exec rake test

data/Gemfile

@@ -0,0 +1,13 @@
+source 'https://rubygems.org'
+
+gemspec
+
+platforms :jruby do
+  # Necessary for `rake release` on JRuby
+  gem "jruby-openssl", "~> 0.7.7"
+end
+
+group :test do
+  # Formats and colorizes test output
+  gem "turn", "~> 0.9.6", :require => false
+end

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright 2012 Abe Voelker
+
+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.md

@@ -0,0 +1,85 @@
+# 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.
+
+## 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.
+
+## Synopsis
+
+```ruby
+require 'pdf_ravager'
+
+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'
+  end
+  check 'related' if data[:relation]
+  checkbox_group 'relation' do
+    case data[:relation]
+    when 'Mom', 'Dad'
+      check 'parent'
+    when 'Brother', 'Sister'
+      check 'sibling'
+    else
+      check 'other'
+    end
+  end
+end
+
+info.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
+```
+
+## Usage
+
+### Field Names
+To query and modify a form's field names, use a tool such as Adobe
+LiveCycle.
+
+### Rich Text
+Rich text is specific to XFA forms. To understand how it should be used,
+see the "Rich Text Reference" section of [Adobe's XFA standard][1].
+Rich Text is defined there as a subset of
+XHTML and CSS which uses some custom restrictions and extensions by
+Adobe. The minimum XHTML and CSS elements that a standards-compliant
+XFA processor (e.g. Adobe Reader) must support are also listed there
+and can be used as a guide.
+
+**Note**: Rich text values are not HTML-escaped or sanitized in any
+way. It is suggested that you call `CGI.escape_html` on user-supplied
+input.
+
+### Checkbox Groups
+Because there is no such thing as a "checkbox group," the
+`checkbox_group` syntax is simply syntactic sugar for calling
+`check` with the group name and a `.` prepended to the name. For
+example,
+
+```ruby
+checkbox_group 'relation' do
+  check 'parent'
+end
+```
+
+is equivalent to
+
+```ruby
+check 'relation.parent'
+```
+
+## Copyright
+
+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

data/Rakefile

@@ -0,0 +1,10 @@
+require 'rspec'
+require 'rake/testtask'
+require 'bundler'
+
+Rake::TestTask.new do |t|
+  t.libs << ["lib", "spec"]
+  t.pattern = "spec/*_spec.rb" 
+end 
+
+Bundler::GemHelper.install_tasks

data/lib/pdf_ravager.rb

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

data/lib/pdf_ravager/pdf.rb

@@ -0,0 +1,105 @@
+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/lib/pdf_ravager/ravager.rb

@@ -0,0 +1,126 @@
+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)
+      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
+      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
+        # 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>"
+          Nokogiri::XML::Builder.with(node) do |xml|
+            xml.value_ {
+              xml.text_ {
+                xml.text value
+              }
+            }
+          end
+        end
+        @xfa.setDomDocument(doc.to_java)
+        @xfa.setChanged(true)
+      end
+    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])
+      @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 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
+            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
+      @xfa.setDomDocument(doc.to_java)
+      @xfa.setChanged(true)
+    end
+
+    def 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)
+        end
+      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/version.rb

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

data/pdf_ravager.gemspec

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/pdf_ravager/version', __FILE__)
+
+Gem::Specification.new do |s|
+  s.name        = "pdf_ravager"
+  s.version     = PDFRavager::VERSION
+  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.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.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/pdf_spec.rb

@@ -0,0 +1,48 @@
+require 'spec_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

data/spec/spec_helper.rb

@@ -0,0 +1 @@
+require 'turn/autorun'

metadata

@@ -0,0 +1,155 @@
+--- !ruby/object:Gem::Specification
+name: pdf_ravager
+version: !ruby/object:Gem::Version
+  prerelease:
+  version: 0.0.7
+platform: ruby
+authors:
+- Abe Voelker
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2012-10-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: json
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+    none: false
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+    none: false
+  prerelease: false
+  type: :runtime
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+    none: false
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+    none: false
+  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
+description: DSL to aid filling out AcroForms PDF and XFA documents
+email: abe@abevoelker.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .travis.yml
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/pdf_ravager.rb
+- lib/pdf_ravager/pdf.rb
+- lib/pdf_ravager/ravager.rb
+- lib/pdf_ravager/version.rb
+- pdf_ravager.gemspec
+- spec/pdf_spec.rb
+- spec/spec_helper.rb
+- vendor/iText-4.2.0.jar
+homepage: https://github.com/abevoelker/pdf_ravager
+licenses: []
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+  none: false
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+  none: false
+requirements: []
+rubyforge_project:
+rubygems_version: 1.8.24
+signing_key:
+specification_version: 3
+summary: DSL to aid filling out AcroForms PDF and XFA documents
+test_files: []
+...