hexapdf 0.12.0 → 0.14.0

data/test/hexapdf/type/acro_form/test_button_field.rb

@@ -140,7 +140,7 @@ describe HexaPDF::Type::AcroForm::ButtonField do
     it "sets a correct field value" do
       @field.create_widget(@doc.pages.add, value: :button1)
 
-      @field.field_value = :button1
+      @field.field_value = "button1"
       assert_equal(:button1, @field[:V])
       @field.field_value = nil
       assert_equal(:Off, @field[:V])
@@ -158,7 +158,7 @@ describe HexaPDF::Type::AcroForm::ButtonField do
     end
 
     it "returns an array of possible values" do
-      @field.create_widget(@doc.pages.add, value: :Test)
+      @field.create_widget(@doc.pages.add, value: "Test")
       @field.create_widget(@doc.pages.add, value: :x)
       @field.create_widget(@doc.pages.add, value: :y)
       assert_equal([:Test, :x, :y], @field.radio_button_values)
@@ -172,6 +172,7 @@ describe HexaPDF::Type::AcroForm::ButtonField do
       assert_equal(:solid, border_style.style)
       assert_equal([1], widget.background_color.components)
       assert_equal(:circle, widget.marker_style.style)
+      assert_equal({test: nil, Off: nil}, widget[:AP][:N].value)
     end
 
     it "always creates standalone widgets" do
@@ -181,6 +182,10 @@ describe HexaPDF::Type::AcroForm::ButtonField do
     it "fails if the value argument is not provided for create_widget" do
       assert_raises(ArgumentError) { @field.create_widget(@doc.pages.add) }
     end
+
+    it "fails if the value argument for create_widget doesn't respond to to_sym" do
+      assert_raises(ArgumentError) { @field.create_widget(@doc.pages.add, value: 5) }
+    end
   end
 
   it "returns a default field value" do
@@ -228,6 +233,14 @@ describe HexaPDF::Type::AcroForm::ButtonField do
       refute_same(off, widget.appearance.normal_appearance[:Off])
     end
 
+    it "always generates appearances if force is true" do
+      widget = @field.create_widget(@doc.pages.add, Rect: [0, 0, 0, 0])
+      @field.create_appearances
+      yes = widget.appearance.normal_appearance[:Yes]
+      @field.create_appearances(force: true)
+      refute_same(yes, widget.appearance.normal_appearance[:Yes])
+    end
+
     it "fails for unsupported button types" do
       @field.flag(:push_button)
       @field.create_widget(@doc.pages.add, Rect: [0, 0, 0, 0])
@@ -258,6 +271,13 @@ describe HexaPDF::Type::AcroForm::ButtonField do
       @field.update_widgets
       assert_equal(:Yes, widget[:AS])
     end
+
+    it "creates the appearances if necessary" do
+      widget = @field.create_widget(@doc.pages.add, Rect: [0, 0, 0, 0])
+      assert_nil(widget[:AP][:N][:Yes])
+      @field.update_widgets
+      assert(widget[:AP][:N][:Yes])
+    end
   end
 
   describe "validation" do

data/test/hexapdf/type/acro_form/test_choice_field.rb

@@ -36,23 +36,34 @@ describe HexaPDF::Type::AcroForm::ChoiceField do
 
   describe "field_value=" do
     before do
-      @field.option_items = ["test", "other"]
+      @field.option_items = ["test", "something", "other", "neu"]
+    end
+
+    it "updates the widgets to reflect the changed value" do
+      @field.initialize_as_combo_box
+      widget = @field.create_widget(@doc.pages.add, Rect: [0, 0, 0, 0])
+      @field.set_default_appearance_string
+      @field.field_value = 'test'
+      assert(widget[:AP][:N])
     end
 
     describe "combo_box" do
       before do
         @field.initialize_as_combo_box
+        @field[:I] = 2
       end
 
       it "can set the value for an uneditable combo box" do
         @field.field_value = 'test'
         assert_equal("test", @field[:V])
+        assert_nil(@field[:I])
       end
 
       it "can set the value for an editable combo box" do
         @field.flag(:edit)
         @field.field_value = 'another'
         assert_equal("another", @field[:V])
+        assert_nil(@field[:I])
       end
 
       it "fails if mulitple values are provided for a combo box" do
@@ -76,8 +87,18 @@ describe HexaPDF::Type::AcroForm::ChoiceField do
 
       it "can set a multiple values if the list box is a multi-select" do
         @field.flag(:multi_select)
-        @field.field_value = ['test', 'other']
-        assert_equal(['test', 'other'], @field[:V].value)
+        @field.field_value = ['other', 'test']
+        assert_equal(['other', 'test'], @field[:V].value)
+        assert_equal([0, 2], @field[:I].value)
+      end
+
+      it "can read and set the top index" do
+        assert_raises(ArgumentError) { @field.list_box_top_index = 4 }
+        @field.delete(:Opt)
+        assert_raises(ArgumentError) { @field.list_box_top_index = 0 }
+        @field.option_items = [1, 2, 3, 4]
+        @field.list_box_top_index = 2
+        assert_equal(2, @field.list_box_top_index)
       end
 
       it "fails if mulitple values are provided but the list box is not a multi-select" do
@@ -97,10 +118,29 @@ describe HexaPDF::Type::AcroForm::ChoiceField do
     assert_raises(HexaPDF::Error) { @field.default_field_value = 'unknown' }
   end
 
-  it "sets and returns the array with the option items" do
-    assert_equal([], @field.option_items)
-    @field.option_items = ["H\xe4llo".b, "\xFE\xFF".b << "Töne".encode('UTF-16BE').b]
-    assert_equal(["Hällo", "Töne"], @field.option_items)
+  describe "option items" do
+    before do
+      @items = [["a", "Zx"], "\xFE\xFF".b << "Töne".encode('UTF-16BE').b, "H\xe4llo".b,]
+    end
+
+    it "sets the option items" do
+      @field.option_items = @items
+      assert_equal(@items, @field[:Opt].value)
+
+      @field.flag(:sort)
+      @field.option_items = @items
+      assert_equal(@items.values_at(2, 1, 0), @field[:Opt].value)
+    end
+
+    it "can retrieve the option items" do
+      @field[:Opt] = @items
+      assert_equal(["Zx", "Töne", "Hällo"], @field.option_items)
+    end
+
+    it "can retrieve the export values" do
+      @field[:Opt] = @items
+      assert_equal(["a", "Töne", "Hällo"], @field.export_values)
+    end
   end
 
   it "returns the correct concrete field type" do
@@ -121,8 +161,51 @@ describe HexaPDF::Type::AcroForm::ChoiceField do
       assert(@field[:AP][:N])
     end
 
-    it "fails for list boxes" do
-      assert_raises(HexaPDF::Error) { @field.create_appearances }
+    it "works for list box fields" do
+      @field.initialize_as_list_box
+      @field.set_default_appearance_string
+      @field.create_appearances
+      assert(@field[:AP][:N])
+    end
+
+    it "only creates a new appearance if the involved dictionary values have changed per widget" do
+      @field.initialize_as_list_box
+      @field.set_default_appearance_string
+      @field.create_appearances
+      appearance_stream = @field[:AP][:N].raw_stream
+
+      @field.create_appearances
+      assert_same(appearance_stream, @field[:AP][:N].raw_stream)
+
+      do_check = lambda do
+        @field.create_appearances
+        refute_same(appearance_stream, @field[:AP][:N].raw_stream)
+        appearance_stream = @field[:AP][:N].raw_stream
+      end
+
+      @field.option_items = ['a', 'b', 'c']
+      do_check.call
+
+      @field.list_box_top_index = 2
+      do_check.call
+
+      @field.field_value = 'b'
+      do_check.call
+
+      widget = @field.create_widget(@doc.pages.add, Rect: [0, 0, 0, 0])
+      assert_nil(widget[:AP])
+      @field.create_appearances
+      refute_nil(widget[:AP][:N])
+    end
+
+    it "force the creation of appearance streams when force: true" do
+      @field.initialize_as_list_box
+      @field.set_default_appearance_string
+      @field.create_appearances
+      appearance_stream = @field[:AP][:N].raw_stream
+
+      @field.create_appearances(force: true)
+      refute_same(appearance_stream, @field[:AP][:N].raw_stream)
     end
   end
 

data/test/hexapdf/type/acro_form/test_field.rb

@@ -99,6 +99,12 @@ describe HexaPDF::Type::AcroForm::Field do
     refute(@field.terminal_field?)
   end
 
+  it "can check whether a widget is embedded in the field" do
+    refute(@field.embedded_widget?)
+    @field[:Subtype] = :Wdiget
+    assert(@field.embedded_widget?)
+  end
+
   describe "each_widget" do
     it "yields a wrapped instance of self if a single widget is embedded" do
       @field[:Subtype] = :Widget
@@ -175,6 +181,39 @@ describe HexaPDF::Type::AcroForm::Field do
     end
   end
 
+  describe "delete_widget" do
+    before do
+      @page = @doc.pages.add
+    end
+
+    it "does nothing if the provided widget doesn't belong to the field" do
+      wrong_widget = @doc.add({Subtype: :Widget})
+
+      @field.create_widget(@page)
+      @field.delete_widget(wrong_widget)
+      assert_equal(:Widget, @field[:Subtype])
+
+      @field.create_widget(@page)
+      @field.delete_widget(wrong_widget)
+      assert_equal(2, @field[:Kids].size)
+    end
+
+    it "deletes the widget if it is embedded" do
+      widget = @field.create_widget(@page)
+      @field.delete_widget(widget)
+      refute(@field.key?(:Subtype))
+      assert(@page[:Annots].empty?)
+    end
+
+    it "deletes the widget if it is not embedded" do
+      @field.create_widget(@page)
+      widget2 = @field.create_widget(@page)
+      @field.delete_widget(widget2)
+      assert_equal(1, @field[:Kids].size)
+      assert_equal(@field[:Kids].value, @page[:Annots].value)
+    end
+  end
+
   describe "perform_validation" do
     before do
       @field[:FT] = :Tx

data/test/hexapdf/type/acro_form/test_form.rb

@@ -7,7 +7,7 @@ require 'hexapdf/type/acro_form/form'
 describe HexaPDF::Type::AcroForm::Form do
   before do
     @doc = HexaPDF::Document.new
-    @acro_form = @doc.add({}, type: :XXAcroForm)
+    @acro_form = @doc.add({Fields: []}, type: :XXAcroForm)
   end
 
   describe "signature flags" do
@@ -49,7 +49,7 @@ describe HexaPDF::Type::AcroForm::Form do
     root_fields = @acro_form.find_root_fields
     assert_equal(result, root_fields.map(&:value))
     assert_kind_of(HexaPDF::Type::AcroForm::TextField, root_fields[0])
-    refute(@acro_form.key?(:Fields))
+    assert_equal([], @acro_form[:Fields].value)
 
     @acro_form.find_root_fields!
     assert_equal(result, @acro_form[:Fields].value.map(&:value))
@@ -115,6 +115,10 @@ describe HexaPDF::Type::AcroForm::Form do
   end
 
   describe "create fields" do
+    before do
+      @acro_form = @doc.acro_form(create: true)
+    end
+
     describe "handles the general case" do
       it "works for names with a dot" do
         @acro_form[:Fields] = [{T: "root"}]
@@ -134,9 +138,57 @@ describe HexaPDF::Type::AcroForm::Form do
       end
     end
 
+    def applies_variable_text_properties(method, **args)
+      field = @acro_form.send(method, "field", **args, font: 'Times')
+      font_name, font_size = field.parse_default_appearance_string
+      assert_equal(:'Times-Roman', @acro_form.default_resources.font(font_name)[:BaseFont])
+      assert_equal(0, font_size)
+
+      field = @acro_form.send(method, "field", **args, font_size: 10)
+      font_name, font_size = field.parse_default_appearance_string
+      assert_equal(:Helvetica, @acro_form.default_resources.font(font_name)[:BaseFont])
+      assert_equal(10, font_size)
+
+      field = @acro_form.send(method, "field", **args, font: 'Courier', font_size: 10, align: :center)
+      font_name, font_size = field.parse_default_appearance_string
+      assert_equal(:Courier, @acro_form.default_resources.font(font_name)[:BaseFont])
+      assert_equal(10, font_size)
+      assert_equal(:center, field.text_alignment)
+    end
+
     it "creates a text field" do
       field = @acro_form.create_text_field("field")
       assert_equal(:Tx, field.field_type)
+      applies_variable_text_properties(:create_text_field)
+    end
+
+    it "creates a multiline text field" do
+      field = @acro_form.create_multiline_text_field("field")
+      assert_equal(:Tx, field.field_type)
+      assert(field.multiline_text_field?)
+      applies_variable_text_properties(:create_multiline_text_field)
+    end
+
+    it "creates a comb text field" do
+      field = @acro_form.create_comb_text_field("field", max_chars: 9)
+      assert_equal(:Tx, field.field_type)
+      assert_equal(9, field[:MaxLen])
+      assert(field.comb_text_field?)
+      applies_variable_text_properties(:create_comb_text_field, max_chars: 9)
+    end
+
+    it "creates a password field" do
+      field = @acro_form.create_password_field("field")
+      assert_equal(:Tx, field.field_type)
+      assert(field.password_field?)
+      applies_variable_text_properties(:create_password_field)
+    end
+
+    it "creates a file select field" do
+      field = @acro_form.create_file_select_field("field")
+      assert_equal(:Tx, field.field_type)
+      assert(field.file_select_field?)
+      applies_variable_text_properties(:create_file_select_field)
     end
 
     it "creates a check box" do
@@ -150,13 +202,19 @@ describe HexaPDF::Type::AcroForm::Form do
     end
 
     it "creates a combo box" do
-      field = @acro_form.create_combo_box("field")
+      field = @acro_form.create_combo_box("field", option_items: ['a', 'b', 'c'], editable: true)
       assert(field.combo_box?)
+      assert_equal(['a', 'b', 'c'], field.option_items)
+      assert(field.flagged?(:edit))
+      applies_variable_text_properties(:create_combo_box)
     end
 
     it "creates a list box" do
-      field = @acro_form.create_list_box("field")
+      field = @acro_form.create_list_box("field", option_items: ['a', 'b', 'c'], multi_select: true)
       assert(field.list_box?)
+      assert_equal(['a', 'b', 'c'], field.option_items)
+      assert(field.flagged?(:multi_select))
+      applies_variable_text_properties(:create_list_box)
     end
   end
 
@@ -185,15 +243,29 @@ describe HexaPDF::Type::AcroForm::Form do
     assert(@acro_form[:NeedAppearances])
   end
 
-  it "creates the appearances of all field widgets if necessary" do
-    tf = @acro_form.create_text_field('test')
-    tf.set_default_appearance_string
-    tf.create_widget(@doc.pages.add)
-    cb = @acro_form.create_check_box('test2')
-    cb.create_widget(@doc.pages.add)
-    @acro_form.create_appearances
-    assert(tf.each_widget.all? {|w| w.appearance.normal_appearance.kind_of?(HexaPDF::Stream) })
-    assert(cb.each_widget.all? {|w| w.appearance.normal_appearance[:Yes].kind_of?(HexaPDF::Stream) })
+  describe "create_appearances" do
+    before do
+      @tf = @acro_form.create_text_field('test')
+      @tf.set_default_appearance_string
+      @tf.create_widget(@doc.pages.add)
+      @cb = @acro_form.create_check_box('test2')
+      @cb.create_widget(@doc.pages.add)
+    end
+
+    it "creates the appearances of all field widgets if necessary" do
+      @acro_form.create_appearances
+      assert(@tf.each_widget.all? {|w| w.appearance.normal_appearance.kind_of?(HexaPDF::Stream) })
+      assert(@cb.each_widget.all? {|w| w.appearance.normal_appearance[:Yes].kind_of?(HexaPDF::Stream) })
+    end
+
+    it "force the creation of appearances if force is true" do
+      @acro_form.create_appearances
+      text_stream = @tf[:AP][:N].raw_stream
+      @acro_form.create_appearances
+      assert_same(text_stream, @tf[:AP][:N].raw_stream)
+      @acro_form.create_appearances(force: true)
+      refute_same(text_stream, @tf[:AP][:N].raw_stream)
+    end
   end
 
   describe "perform_validation" do
@@ -204,9 +276,9 @@ describe HexaPDF::Type::AcroForm::Form do
 
     it "checks whether the font used in /DA is available in /DR" do
       @acro_form[:DA] = '/F2 0 Tf /F1 0 Tf'
-      refute(@acro_form.validate {|msg, c| assert_match(/DR must also be present/, msg) })
+      refute(@acro_form.validate {|msg| assert_match(/DR must also be present/, msg) })
       @acro_form.default_resources[:Font] = {}
-      refute(@acro_form.validate {|msg, c| assert_match(/font.*is not.*resource/, msg) })
+      refute(@acro_form.validate {|msg| assert_match(/font.*is not.*resource/, msg) })
       @acro_form.default_resources[:Font][:F1] = :yes
       assert(@acro_form.validate)
     end

data/test/hexapdf/type/acro_form/test_text_field.rb

@@ -21,6 +21,56 @@ describe HexaPDF::Type::AcroForm::TextField do
     assert_equal(6, @field[:MaxLen])
   end
 
+  it "can be initialized as a multiline text field" do
+    @field.flag(:comb)
+    @field.initialize_as_multiline_text_field
+    assert(@field.multiline_text_field?)
+  end
+
+  it "can be initialized as comb text field" do
+    @field.flag(:multiline)
+    @field.initialize_as_comb_text_field
+    assert(@field.comb_text_field?)
+  end
+
+  it "can be initialized as password field" do
+    @field.flag(:multiline)
+    @field[:V] = 'test'
+    @field.initialize_as_password_field
+    assert_nil(@field[:V])
+    assert(@field.password_field?)
+  end
+
+  it "can be initialized as a file select field" do
+    @field.flag(:multiline)
+    @field.initialize_as_file_select_field
+    assert(@field.file_select_field?)
+  end
+
+  it "can check whether the field is a multiline text field" do
+    refute(@field.multiline_text_field?)
+    @field.flag(:multiline)
+    assert(@field.multiline_text_field?)
+  end
+
+  it "can check whether the field is a comb text field" do
+    refute(@field.comb_text_field?)
+    @field.flag(:comb)
+    assert(@field.comb_text_field?)
+  end
+
+  it "can check whether the field is a password field" do
+    refute(@field.password_field?)
+    @field.flag(:password)
+    assert(@field.password_field?)
+  end
+
+  it "can check whether the field is a file select field" do
+    refute(@field.file_select_field?)
+    @field.flag(:file_select)
+    assert(@field.file_select_field?)
+  end
+
   describe "field_value" do
     it "handles unset values" do
       assert_nil(@field.field_value)
@@ -81,14 +131,38 @@ describe HexaPDF::Type::AcroForm::TextField do
   end
 
   describe "create_appearances" do
-    it "creates the needed streams" do
+    before do
       @doc.acro_form(create: true)
       @field.create_widget(@doc.pages.add, Rect: [0, 0, 0, 0])
       @field.set_default_appearance_string
+    end
+
+    it "creates the needed streams" do
       @field.create_appearances
       assert(@field[:AP][:N])
     end
 
+    it "doesn't create a new appearance stream if the field value hasn't changed, checked per widget" do
+      @field.create_appearances
+      stream = @field[:AP][:N].raw_stream
+      @field.create_appearances
+      assert_same(stream, @field[:AP][:N].raw_stream)
+      @field.field_value = 'test'
+      refute_same(stream, @field[:AP][:N].raw_stream)
+
+      widget = @field.create_widget(@doc.pages.add, Rect: [0, 0, 0, 0])
+      assert_nil(widget[:AP])
+      @field.create_appearances
+      refute_nil(widget[:AP][:N])
+    end
+
+    it "always creates a new appearance stream if force is true" do
+      @field.create_appearances
+      stream = @field[:AP][:N].raw_stream
+      @field.create_appearances(force: true)
+      refute_same(stream, @field[:AP][:N].raw_stream)
+    end
+
     it "uses the configuration option acro_form.appearance_generator" do
       @doc.config['acro_form.appearance_generator'] = 'NonExistent'
       assert_raises(Exception) { @field.create_appearances }
@@ -114,6 +188,8 @@ describe HexaPDF::Type::AcroForm::TextField do
       assert(@field.validate)
       @field[:MaxLen] = 2
       refute(@field.validate)
+      @field[:V] = nil
+      assert(@field.validate)
     end
   end
 end