pdf_ravager 0.0.5-java → 0.0.6-java

data/README.md

@@ -17,7 +17,7 @@ data = {:name => 'Bob', :gender => 'm', :relation => 'Uncle' }
 
 info = pdf do
   text 'name', data[:name]
-  rich_text 'name_stylized', "<b>#{data[:name]}</b>" # warning: text is not HTML-escaped!
+  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'
@@ -45,14 +45,18 @@ To query and modify a form's field names, use a tool such as Adobe
 LiveCycle.
 
 ### Rich Text
-The `rich_text` type 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
+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

data/lib/pdf_ravager/pdf.rb

@@ -11,11 +11,11 @@ module PDFRavager
     end
 
     def text(name, value, opts={})
-      @fields << {:name => name, :value => value, :type => :text}
-    end
-
-    def rich_text(name, value, opts={})
-      @fields << {:name => name, :value => value, :type => :rich_text}
+      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={})
@@ -59,7 +59,7 @@ module PDFRavager
             else
               f[:value]
             end
-            pdf.set_field_value(f[:name], value, f[:type])
+            pdf.set_field_value(f[:name], value, f[:type], f[:options])
           end
         end
       end
@@ -82,9 +82,13 @@ module PDFRavager
 
     def self.json_create(obj)
       fields = obj["data"]["fields"].map do |f|
-        # symbolize the keys
+        # 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)

data/lib/pdf_ravager/ravager.rb

@@ -31,8 +31,8 @@ module PDFRavager
       out
     end
 
-    def set_field_value(name, value, type=nil)
-      return set_rich_text_field(name, value) if type == :rich_text
+    def set_field_value(name, value, type=nil, options={})
+      return set_rich_text_field(name, value) if type == :text && options[:rich] == true
       begin
         # First try AcroForms method of setting value
         @afields.setField(XfaForm::Xml2Som::getShortName(SOM.escape(name)), value)

data/lib/pdf_ravager/version.rb

@@ -1,3 +1,3 @@
 module PDFRavager
-  VERSION = "0.0.5"
+  VERSION = "0.0.6"
 end

data/spec/pdf_spec.rb

@@ -4,9 +4,9 @@ require 'pdf_ravager/pdf'
 class TestPDF < MiniTest::Unit::TestCase
   def setup
     @pdf = pdf 'foo.pdf' do
-      text      'text', 'foo'
-      rich_text 'rich_text', '<b>foo</b>'
-      check     'checkbox'
+      text  'text',      'foo'
+      text  'rich_text', '<b>foo</b>', :rich => true
+      check 'checkbox'
       checkbox_group 'checkbox_group' do
         check 'foo'
       end
@@ -27,7 +27,7 @@ class TestPDF < MiniTest::Unit::TestCase
   end
 
   def test_that_rich_text_is_set
-    assert_includes @pdf.fields, {:name => 'rich_text', :value => '<b>foo</b>', :type => :rich_text}
+    assert_includes @pdf.fields, {:name => 'rich_text', :value => '<b>foo</b>', :type => :text, :options => {:rich => true}}
   end
 
   def test_that_checkbox_is_set

metadata

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