pdf_ravager 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 78b00f06cc54b5f044001f621fc30d284a02410e
-  data.tar.gz: b9fac87df32a1e3033d2e73f622b0665e761b3da
+  metadata.gz: af97c49b1e6876971dd1d81e67f5169044970df8
+  data.tar.gz: e5575521306846de1411f15f4b23ca1b601d5e65
 SHA512:
-  metadata.gz: 8dc1d7f6bca130cb731862d507463df813775abc7cbff40a7f5313fe28e92b5e327677cc2103718621bbc0ae12687d88e692146428b93863e7bd5cec81ec1043
-  data.tar.gz: cba64b43ca4100a42d7b10e77daa5112fcac7ec4df066e2b2cdfe57c42dc1dc349c62c14a1e382d7315039763f29d8d69a2bad39a3618bbafb919604e3ff595c
+  metadata.gz: 36993a4b30050636d312d5df41d4542e7fbc6722c0da83fbe87d41e042aab3c4cc30735275ef35a9a67c791abb47c9c629b9847784c8db391190401421a13e9c
+  data.tar.gz: bc2d3c2348865ac36164344aab42027374d62d2cdb6890ab14a0dc21a954deb89c12e979d43c7b1648ef21f585ea29710ff6ab2959adcb12a614c1aa6822fc23

data/.travis.yml

@@ -3,6 +3,9 @@ rvm:
   - jruby-18mode
   - jruby-19mode
   - jruby-head
+matrix:
+  allow_failures:
+    - rvm: jruby-head
 before_install:
   - sudo add-apt-repository "deb http://archive.canonical.com/ $(lsb_release -sc) partner" -y
   - sudo apt-get update -y

data/Gemfile

@@ -4,8 +4,7 @@ gemspec
 
 platforms :jruby do
   # Necessary for `rake release` on JRuby
-  gem "jruby-openssl", "~> 0.7.7"
-  gem 'bouncy-castle-java'
+  gem 'jruby-openssl', '~> 0.9'
 end
 
-gem "simplecov", "~> 0.8", :require => false
+gem 'simplecov', '~> 0.8', :require => false

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright 2012-2013 Abe Voelker
+Copyright 2012-2014 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

@@ -1,14 +1,26 @@
-# PDF Ravager [![Build Status](https://secure.travis-ci.org/abevoelker/pdf_ravager.png)](http://travis-ci.org/abevoelker/pdf_ravager)
+PDF Ravager
+===========
+[![Gem Version](https://badge.fury.io/rb/pdf_ravager.png)][gem]
+[![Build Status](https://secure.travis-ci.org/abevoelker/pdf_ravager.png)][travis]
+[![Code Climate](https://codeclimate.com/github/abevoelker/pdf_ravager.png)][codeclimate]
+[![Dependency Status](https://gemnasium.com/abevoelker/pdf_ravager.svg)][gemnasium]
+
+[gem]: https://rubygems.org/gems/pdf_ravager
+[travis]: http://travis-ci.org/abevoelker/pdf_ravager
+[codeclimate]: https://codeclimate.com/github/abevoelker/pdf_ravager
+[gemnasium]: https://gemnasium.com/abevoelker/pdf_ravager
 
 JRuby-only DSL for filling out AcroForms PDF or XFA documents.
 
-## Description
+Description
+-----------
 
 This library uses a combination of a simple DSL and a minimal façade over the
 last free version of the Java iText library to aid in filling out AcroForms PDF
 or XFA documents.
 
-## Synopsis
+Synopsis
+--------
 
 ```ruby
 require 'pdf_ravager'
@@ -58,7 +70,28 @@ end
 
 Note: `pdf` has been deprecated and will be removed in a future release.
 
-## Usage
+Usage
+-----
+
+### Strategies
+
+By default, PDF Ravager uses a `:smart` strategy for populating PDFs which
+first attempts to fill fields using the `:acro_forms` strategy, then
+applies the `:xfa` strategy to fields that were unable to be populated with
+`:acro_forms`.  If you know which strategy you want ahead of time (e.g. your
+form is strictly a static AcroForm or a dynamic XFA), you can set it in
+the template initializer like so:
+
+```ruby
+template = PDFRavager::Template.new(strategy: :xfa) do |p|
+  # ...
+end
+```
+
+Valid options are:
+* `:smart`
+* `:acro_forms`
+* `:xfa`
 
 ### Field Names
 To query and modify a form's field names, use a tool such as Adobe
@@ -99,9 +132,10 @@ pdf do |p|
 end
 ```
 
-## Copyright
+Copyright
+---------
 
-Copyright (c) 2012-2013 Abe Voelker. Released under the terms of the
+Copyright (c) 2012-2014 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/lib/pdf_ravager/field_types/xfa.rb

@@ -16,48 +16,27 @@ module PDFRavager
         @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
+      def set_xfa_value(node)
+        value_node = node.at_xpath("*[local-name()='value']")
+        if value_node
+          child_node = value_node.at_xpath("*[local-name()='#{xfa_node_type}']")
+          if child_node
+            # Complete node structure already exists - just set the value
+            child_node.content = xfa_value
           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
-                }
-              }
+            # Must create child <#{xfa_node_type}> node
+            Nokogiri::XML::Builder.with(value_node) do |xml|
+              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}_", xfa_value)
+            }
+          end
         end
-        xfa.setDomDocument(doc.to_java)
-        xfa.setChanged(true)
       end
 
     end

data/lib/pdf_ravager/fields/rich_text.rb

@@ -15,46 +15,19 @@ module PDFRavager
         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
+      def set_xfa_value(node)
+        value_node = node.at_xpath("*[local-name()='value']")
+        value_node && value_node.remove # we will replace the whole <value> node
+        Nokogiri::XML::Builder.with(node) do |xml|
+          xml.value_ {
+            xml.exData('contentType' => 'text/html') {
+              xml.body_('xmlns'     => "http://www.w3.org/1999/xhtml",
+                        'xmlns:xfa' => "http://www.xfa.org/schema/xfa-data/1.0/") {
+                xml << xfa_value
+              }
+            }
+          }
         end
-        xfa.setDomDocument(doc.to_java)
-        xfa.setChanged(true)
       end
 
     end

data/lib/pdf_ravager/strategies/smart.rb

@@ -4,6 +4,16 @@ module PDFRavager
       def initialize(stamper)
         @acro_form = Strategies::AcroForm.new(stamper)
         @xfa       = Strategies::XFA.new(stamper)
+        afields    = stamper.getAcroFields
+        @type = if afields.getXfa.isXfaPresent
+          if afields.getFields.empty?
+            :dynamic_xfa
+          else
+            :static_xfa
+          end
+        else
+          :acro_form
+        end
       end
 
       def set_field_values(template)
@@ -15,7 +25,12 @@ module PDFRavager
       end
 
       def set_read_only
-        [@acro_form, @xfa].each(&:set_read_only)
+        case @type
+        when :acro_form, :static_xfa
+          @acro_form.set_read_only
+        when :dynamic_xfa
+          @xfa.set_read_only
+        end
       end
     end
   end

data/lib/pdf_ravager/strategies/xfa.rb

@@ -6,9 +6,7 @@ module PDFRavager
       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)
+        doc = to_nokogiri_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 =
@@ -17,44 +15,20 @@ module PDFRavager
             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
+          if strict_match.any?
+            strict_match.each{|node| f.set_xfa_value(node) }
+          else
+            # otherwise, we'll loosely match the field name anywhere in the document:
+            loose_match = doc.xpath("//*[local-name()='field'][@name='#{f.xfa_name}']")
+            loose_match.each{|node| f.set_xfa_value(node) }
           end
         end
-        @xfa.tap do |x|
-          x.setDomDocument(doc.to_java)
-          x.setChanged(true)
-        end
+        @xfa.setDomDocument(doc.to_java)
+        @xfa.setChanged(true)
       end
 
       def set_read_only
-        doc = Nokogiri::XML(Nokogiri::XML::Document.wrap(@xfa.getDomDocument).to_xml)
+        doc = to_nokogiri_xml
         doc.xpath("//*[local-name()='field']").each do |node|
           node["access"] = "readOnly"
         end
@@ -62,6 +36,14 @@ module PDFRavager
         @xfa.setChanged(true)
       end
 
+      private
+
+      def to_nokogiri_xml
+        # the double-load is to work around a Nokogiri bug I found:
+        # https://github.com/sparklemotion/nokogiri/issues/781
+        Nokogiri::XML(Nokogiri::XML::Document.wrap(@xfa.getDomDocument).to_xml)
+      end
+
     end
   end
 end

data/lib/pdf_ravager/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pdf_ravager
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Abe Voelker
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2014-03-31 00:00:00.000000000 Z
+date: 2014-04-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri