pdf_ravager 0.0.1-java

data/.gitignore

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

data/Gemfile

@@ -0,0 +1,8 @@
+source :rubygems
+
+group :development, :test do
+  gem "minitest", "~> 4.1.0"
+  gem "rspec",    "~> 2.11.0"
+  gem "turn",     "~> 0.9.6", :require => false
+  gem "bundler",  "~> 1.2.1"
+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,50 @@
+# 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 veneer 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]
+  radio_group 'sex' do
+    fill 'male',   :if => data[:gender] == 'm'
+    fill 'female', :if => data[:gender] == 'f'
+  end
+  checkbox_group 'relation' do
+    check 'parent',  :if => ['Mom', 'Dad'].include?(data[:relation])
+    check 'sibling', :if => ['Brother', 'Sister'].include?(data[:relation])
+    check 'other',   :unless => ['Brother', 'Sister', 'Mom', 'Dad'].include?(data[:relation])
+    # OR
+    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'
+```
+
+## Usage
+
+To find the names of the fields, use a tool such as Adobe LiveCycle.
+
+## Copyright
+
+Copyright (c) 2012 Abe Voelker. Released under the terms of the
+MIT license. See LICENSE for details.

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,97 @@
+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={})
+      return if opts.has_key?(:when)   && !opts[:when]
+      return if opts.has_key?(:if)     && !opts[:if]
+      return if opts.has_key?(:unless) && opts[:unless]
+      @fields << {:name => name, :value => value, :type => :text}
+    end
+
+    def radio_group(name, &blk)
+      fields = []
+      # TODO: replace w/ singleton method?
+      PDF.instance_eval do
+        send(:define_method, :fill) do |value, opts={}|
+          return if opts.has_key?(:when)   && !opts[:when]
+          return if opts.has_key?(:if)     && !opts[:if]
+          return if opts.has_key?(:unless) && opts[:unless]
+          fields << {:name => name, :value => value, :type => :radio}
+        end
+        blk.call
+        send(:undef_method, :fill)
+      end
+
+      @fields += fields
+    end
+
+    def checkbox_group(name, &blk)
+      fields = []
+      # TODO: replace w/ singleton method?
+      PDF.instance_eval do
+        send(:define_method, :check) do |value, opts={}|
+          return if opts.has_key?(:when)   && !opts[:when]
+          return if opts.has_key?(:if)     && !opts[:if]
+          return if opts.has_key?(:unless) && opts[:unless]
+          fields << {:name => name, :value => value, :type => :checkbox}
+        end
+        blk.call
+        send(:undef_method, :check)
+      end
+
+      @fields += fields
+    end
+
+    if RUBY_PLATFORM =~ /java/
+      def ravage(file, opts={})
+        PDFRavager::Ravager.open(opts.merge(:in_file => file)) do |pdf|
+          @fields.each do |f|
+            pdf.set_field_value(f[:name], f[:value])
+          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 keys
+        f = f.inject({}){|h,(k,v)| h[k.to_sym] = v; h}
+        f[:type] = f[:type].to_sym if f[:type]
+        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,90 @@
+require 'java'
+require File.dirname(__FILE__)  + '/../../vendor/iText-4.2.0'
+
+include_class "com.lowagie.text.pdf.AcroFields"
+include_class "com.lowagie.text.pdf.PdfArray"
+include_class "com.lowagie.text.pdf.PdfDictionary"
+include_class "com.lowagie.text.pdf.PdfName"
+include_class "com.lowagie.text.pdf.PdfObject"
+include_class "com.lowagie.text.pdf.PdfReader"
+include_class "com.lowagie.text.pdf.PdfStamper"
+include_class "com.lowagie.text.pdf.PdfStream"
+include_class "com.lowagie.text.pdf.PdfWriter"
+include_class "com.lowagie.text.pdf.XfaForm"
+include_class "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[:in_file], out)
+      yield ravager
+      ravager.destroy
+      out
+    end
+
+    def set_field_value(name, value)
+      # Transform boolean checkbox value to 1 or 0 char
+      if get_field_type(name) == AcroFields::FIELD_TYPE_CHECKBOX && !!value
+        value = value == true ? '1' : '0'
+      end
+      # First use AcroForms method
+      begin
+        @afields.setField(XfaForm::Xml2Som::getShortName(SOM.escape(name)), value)
+      rescue java.lang.NullPointerException
+        # If the AcroForms method doesn't work, we'll set the XDP
+        doc = Nokogiri::XML::Document.wrap(@xfa.getDomDocument)
+        doc.xpath("//*[local-name()='field'][@name='#{name}']").each do |node|
+          # Create an XML node in the XDP basically like this: "<value><text>#{value}</text></value>"
+          Nokogiri::XML::Builder.with(node) do |xml|
+            xml.value_ do |v|
+              v.text_ value
+            end
+          end
+        end
+        @xfa.setDomDocument(doc.to_java)
+        @xfa.setChanged(true)
+      end
+    end
+
+    def get_field_type(name)
+      short_name = XfaForm::Xml2Som::getShortName(SOM.escape(name))
+      begin
+        @afields.getFieldType(short_name)
+      rescue java.lang.NullPointerException
+        nil
+      end
+    end
+
+    def destroy
+      @stamper.close
+    end
+
+    private
+
+    def initialize(in_file, out)
+      @reader = PdfReader.new(in_file)
+      @out = out
+      @stamper = PdfStamper.new(@reader, @out)
+      @afields = @stamper.getAcroFields
+      @xfa = @afields.getXfa
+      @som = @xfa.getDatasetsSom
+      @som_template = @xfa.getTemplateSom
+    end
+
+  end
+
+  class SOM
+    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.1"
+end

data/pdf_ravager.gemspec

@@ -0,0 +1,22 @@
+# -*- 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.platform    = 'java'
+  s.authors     = ['Abe Voelker']
+  s.email       = 'abe@abevoelker.com'
+  s.date        = '2012-10-17'
+  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_runtime_dependency "json"
+  s.add_development_dependency "bundler", ">= 1.0.0"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+end

data/spec/pdf_spec.rb

@@ -0,0 +1,140 @@
+require 'spec_helper'
+require 'pdf_ravager/pdf'
+
+class TestPDF < MiniTest::Unit::TestCase
+  def setup
+    @pdf = pdf 'foo.pdf' do
+      text 'text_always',       'foo'
+      text 'text_when_true',    'foo', :when => true
+      text 'text_when_false',   'foo', :when => false
+      text 'text_if_true',      'foo', :if => true
+      text 'text_if_false',     'foo', :if => false
+      text 'text_unless_true',  'foo', :unless => true
+      text 'text_unless_false', 'foo', :unless => false
+      radio_group 'radio_group_always_filled' do
+        fill 'foo'
+      end
+      radio_group 'radio_group_if' do
+        fill 'true',  :if => true
+        fill 'false', :if => false
+      end
+      radio_group 'radio_group_when' do
+        fill 'true',  :when => true
+        fill 'false', :when => false
+      end
+      radio_group 'radio_group_unless' do
+        fill 'true',  :unless => true
+        fill 'false', :unless => false
+      end
+      checkbox_group 'checkbox_group_always_checked' do
+        check 'foo'
+      end
+      checkbox_group 'checkbox_group_if' do
+        check 'true',  :if => true
+        check 'false', :if => false
+      end
+      checkbox_group 'checkbox_group_when' do
+        check 'true',  :when => true
+        check 'false', :when => false
+      end
+      checkbox_group 'checkbox_group_unless' do
+        check 'true',  :unless => true
+        check 'false', :unless => false
+      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_always', :value => 'foo', :type => :text}
+  end
+
+  def test_that_text_when_true_is_set
+    assert_includes @pdf.fields, {:name => 'text_when_true', :value => 'foo', :type => :text}
+  end
+
+  def test_that_text_when_false_is_not_set
+    refute_includes @pdf.fields, {:name => 'text_when_false', :value => 'foo', :type => :text}
+  end
+
+  def test_that_text_if_true_is_set
+    assert_includes @pdf.fields, {:name => 'text_if_true', :value => 'foo', :type => :text}
+  end
+
+  def test_that_text_if_false_is_not_set
+    refute_includes @pdf.fields, {:name => 'text_if_false', :value => 'foo', :type => :text}
+  end
+
+  def test_that_text_unless_true_is_not_set
+    refute_includes @pdf.fields, {:name => 'text_unless_true', :value => 'foo', :type => :text}
+  end
+
+  def test_that_text_unless_false_is_set
+    assert_includes @pdf.fields, {:name => 'text_unless_false', :value => 'foo', :type => :text}
+  end
+
+  def test_that_radio_group_always_filled_is_filled
+    assert_includes @pdf.fields, {:name => 'radio_group_always_filled', :value => 'foo', :type => :radio}
+  end
+
+  def test_that_radio_group_when_true_is_set
+    assert_includes @pdf.fields, {:name => 'radio_group_when', :value => 'true', :type => :radio}
+  end
+
+  def test_that_radio_group_when_false_is_not_set
+    refute_includes @pdf.fields, {:name => 'radio_group_when', :value => 'false', :type => :radio}
+  end
+
+  def test_that_radio_group_if_true_is_set
+    assert_includes @pdf.fields, {:name => 'radio_group_if', :value => 'true', :type => :radio}
+  end
+
+  def test_that_radio_group_if_false_is_not_set
+    refute_includes @pdf.fields, {:name => 'radio_group_if', :value => 'false', :type => :radio}
+  end
+
+  def test_that_radio_group_unless_true_is_not_set
+    refute_includes @pdf.fields, {:name => 'radio_group_unless', :value => 'true', :type => :radio}
+  end
+
+  def test_that_radio_group_unless_false_is_set
+    assert_includes @pdf.fields, {:name => 'radio_group_unless', :value => 'false', :type => :radio}
+  end
+
+  def test_that_checkbox_group_always_checked_is_checked
+    assert_includes @pdf.fields, {:name => 'checkbox_group_always_checked', :value => 'foo', :type => :checkbox}
+  end
+
+  def test_that_checkbox_group_when_true_is_set
+    assert_includes @pdf.fields, {:name => 'checkbox_group_when', :value => 'true', :type => :checkbox}
+  end
+
+  def test_that_checkbox_group_when_false_is_not_set
+    refute_includes @pdf.fields, {:name => 'checkbox_group_when', :value => 'false', :type => :checkbox}
+  end
+
+  def test_that_checkbox_group_if_true_is_set
+    assert_includes @pdf.fields, {:name => 'checkbox_group_if', :value => 'true', :type => :checkbox}
+  end
+
+  def test_that_checkbox_group_if_false_is_not_set
+    refute_includes @pdf.fields, {:name => 'checkbox_group_if', :value => 'false', :type => :checkbox}
+  end
+
+  def test_that_checkbox_group_unless_true_is_not_set
+    refute_includes @pdf.fields, {:name => 'checkbox_group_unless', :value => 'true', :type => :checkbox}
+  end
+
+  def test_that_checkbox_group_unless_false_is_set
+    assert_includes @pdf.fields, {:name => 'checkbox_group_unless', :value => 'false', :type => :checkbox}
+  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,90 @@
+--- !ruby/object:Gem::Specification
+name: pdf_ravager
+version: !ruby/object:Gem::Version
+  prerelease:
+  version: 0.0.1
+platform: java
+authors:
+- Abe Voelker
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2012-10-17 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: bundler
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+    none: false
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+    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
+- 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: []
+...