pdf_ravager 0.0.3-java → 0.0.4-java

data/README.md

@@ -4,7 +4,7 @@ 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
+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.
 
@@ -17,6 +17,7 @@ data = {:name => 'Bob', :gender => 'm', :relation => 'Uncle' }
 
 info = pdf do
   text 'name', data[:name]
+  html 'name_stylized', "<b>#{data[:name]}</b>" # warning: HTML is not escaped
   radio_group 'sex' do
     fill 'male',   :if => data[:gender] == 'm'
     fill 'female', :if => data[:gender] == 'f'
@@ -43,9 +44,13 @@ 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.
+To find the names of the fields, use a tool such as Adobe LiveCycle. The
+`html` type is a subset of XHTML defined by [Adobe's XFA standard][1] - full
+HTML support isn't available.
 
 ## Copyright
 
 Copyright (c) 2012 Abe Voelker. Released under the terms of the
-MIT license. See LICENSE for details.
+MIT license. See LICENSE for details.
+
+[1]: http://partners.adobe.com/public/developer/xml/index_arch.html

data/lib/pdf_ravager/pdf.rb

@@ -17,6 +17,13 @@ module PDFRavager
       @fields << {:name => name, :value => value, :type => :text}
     end
 
+    def html(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 => :html}
+    end
+
     def check(name, opts={})
       return if opts.has_key?(:when)   && !opts[:when]
       return if opts.has_key?(:if)     && !opts[:if]
@@ -64,7 +71,7 @@ module PDFRavager
             else
               f[:value]
             end
-            pdf.set_field_value(f[:name], value)
+            pdf.set_field_value(f[:name], value, f[:type])
           end
         end
       end

data/lib/pdf_ravager/ravager.rb

@@ -1,17 +1,17 @@
 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"
+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
@@ -31,19 +31,24 @@ module PDFRavager
       out
     end
 
-    def set_field_value(name, value)
+    def set_field_value(name, value, type=nil)
+      return set_html_field(name, value) if type == :html
       # 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)
+        # 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 basically like this: "<value><text>#{value}</text></value>"
           Nokogiri::XML::Builder.with(node) do |xml|
-            xml.value_ do |v|
-              v.text_ value
-            end
+            xml.value_ {
+              xml.text_ {
+                xml.text value
+              }
+            }
           end
         end
         @xfa.setDomDocument(doc.to_java)
@@ -76,6 +81,23 @@ module PDFRavager
       @som_template = @xfa.getTemplateSom
     end
 
+    def set_html_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
+
   end
 
   class SOM

data/lib/pdf_ravager/version.rb

@@ -1,3 +1,3 @@
 module PDFRavager
-  VERSION = "0.0.3"
+  VERSION = "0.0.4"
 end

data/spec/pdf_spec.rb

@@ -11,6 +11,7 @@ class TestPDF < MiniTest::Unit::TestCase
       text 'text_if_false',     'foo', :if => false
       text 'text_unless_true',  'foo', :unless => true
       text 'text_unless_false', 'foo', :unless => false
+      html 'html', '<b>foo</b>'
       check 'checkbox'
       radio_group 'radio_group_always_filled' do
         fill 'foo'
@@ -79,6 +80,10 @@ class TestPDF < MiniTest::Unit::TestCase
     assert_includes @pdf.fields, {:name => 'text_unless_false', :value => 'foo', :type => :text}
   end
 
+  def test_that_html_is_set
+    assert_includes @pdf.fields, {:name => 'html', :value => '<b>foo</b>', :type => :html}
+  end
+
   def test_that_checkbox_is_set
     assert_includes @pdf.fields, {:name => 'checkbox', :value => true, :type => :checkbox}
   end

metadata

@@ -2,7 +2,7 @@
 name: pdf_ravager
 version: !ruby/object:Gem::Version
   prerelease:
-  version: 0.0.3
+  version: 0.0.4
 platform: java
 authors:
 - Abe Voelker