pdf_ravager 0.0.4-java → 0.0.5-java

data/README.md

@@ -17,17 +17,13 @@ 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
+  rich_text 'name_stylized', "<b>#{data[:name]}</b>" # warning: text is not HTML-escaped!
   radio_group 'sex' do
-    fill 'male',   :if => data[:gender] == 'm'
-    fill 'female', :if => data[:gender] == 'f'
+    fill 'male'   if data[:gender] == 'm'
+    fill 'female' if data[:gender] == 'f'
   end
   check 'related' if data[:relation]
   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'
@@ -44,9 +40,36 @@ 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. The
-`html` type is a subset of XHTML defined by [Adobe's XFA standard][1] - full
-HTML support isn't available.
+### Field Names
+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
+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.
+
+### 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
 

data/lib/pdf_ravager/pdf.rb

@@ -11,23 +11,14 @@ module PDFRavager
     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 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}
+    def rich_text(name, value, opts={})
+      @fields << {:name => name, :value => value, :type => :rich_text}
     end
 
     def check(name, 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 => true, :type => :checkbox}
     end
 
@@ -36,9 +27,6 @@ module PDFRavager
       # TODO: replace w/ singleton method?
       PDF.instance_eval do
         send(:define_method, :fill) do |name, 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 => gname, :value => name, :type => :radio}
         end
         blk.call

data/lib/pdf_ravager/ravager.rb

@@ -32,9 +32,9 @@ module PDFRavager
     end
 
     def set_field_value(name, value, type=nil)
-      return set_html_field(name, value) if type == :html
-      # First use AcroForms method
+      return set_rich_text_field(name, value) if type == :rich_text
       begin
+        # First try AcroForms method of setting value
         @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
@@ -42,7 +42,7 @@ module PDFRavager
         # 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>"
+          # 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_ {
@@ -56,15 +56,6 @@ module PDFRavager
       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
@@ -81,7 +72,7 @@ module PDFRavager
       @som_template = @xfa.getTemplateSom
     end
 
-    def set_html_field(name, value)
+    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|

data/lib/pdf_ravager/version.rb

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

data/spec/pdf_spec.rb

@@ -4,44 +4,14 @@ 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
-      html 'html', '<b>foo</b>'
-      check 'checkbox'
-      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
+      text      'text', 'foo'
+      rich_text 'rich_text', '<b>foo</b>'
+      check     'checkbox'
+      checkbox_group 'checkbox_group' 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
+      radio_group 'radio_group' do
+        fill 'foo'
       end
     end
 
@@ -53,95 +23,23 @@ class TestPDF < MiniTest::Unit::TestCase
   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}
+    assert_includes @pdf.fields, {:name => 'text', :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_html_is_set
-    assert_includes @pdf.fields, {:name => 'html', :value => '<b>foo</b>', :type => :html}
+  def test_that_rich_text_is_set
+    assert_includes @pdf.fields, {:name => 'rich_text', :value => '<b>foo</b>', :type => :rich_text}
   end
 
   def test_that_checkbox_is_set
     assert_includes @pdf.fields, {:name => 'checkbox', :value => true, :type => :checkbox}
   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.foo', :value => true, :type => :checkbox}
-  end
-
-  def test_that_checkbox_group_when_true_is_set
-    assert_includes @pdf.fields, {:name => 'checkbox_group_when.true', :value => true, :type => :checkbox}
-  end
-
-  def test_that_checkbox_group_when_false_is_not_set
-    refute_includes @pdf.fields, {:name => 'checkbox_group_when.false', :value => true, :type => :checkbox}
-  end
-
-  def test_that_checkbox_group_if_true_is_set
-    assert_includes @pdf.fields, {:name => 'checkbox_group_if.true', :value => true, :type => :checkbox}
-  end
-
-  def test_that_checkbox_group_if_false_is_not_set
-    refute_includes @pdf.fields, {:name => 'checkbox_group_if.false', :value => true, :type => :checkbox}
-  end
-
-  def test_that_checkbox_group_unless_true_is_not_set
-    refute_includes @pdf.fields, {:name => 'checkbox_group_unless.true', :value => true, :type => :checkbox}
+  def test_that_checkbox_group_is_set
+    assert_includes @pdf.fields, {:name => 'checkbox_group.foo', :value => true, :type => :checkbox}
   end
 
-  def test_that_checkbox_group_unless_false_is_set
-    assert_includes @pdf.fields, {:name => 'checkbox_group_unless.false', :value => true, :type => :checkbox}
+  def test_that_radio_group_is_set
+    assert_includes @pdf.fields, {:name => 'radio_group', :value => 'foo', :type => :radio}
   end
 
   def test_json_serialization

metadata

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