hexapdf 0.12.3 → 0.14.3

data/test/hexapdf/test_writer.rb

@@ -40,7 +40,7 @@ describe HexaPDF::Writer do
       219
       %%EOF
       3 0 obj
-      <</Producer(HexaPDF version 0.12.3)>>
+      <</Producer(HexaPDF version 0.14.3)>>
       endobj
       xref
       3 1
@@ -72,7 +72,7 @@ describe HexaPDF::Writer do
       141
       %%EOF
       6 0 obj
-      <</Producer(HexaPDF version 0.12.3)>>
+      <</Producer(HexaPDF version 0.14.3)>>
       endobj
       2 0 obj
       <</Length 10>>stream

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

@@ -25,14 +25,6 @@ describe HexaPDF::Type::AcroForm::AppearanceGenerator do
       assert_raises(HexaPDF::Error) { @generator.create_appearances }
     end
 
-    it "fails for unsupported choice fields" do
-      @field = @doc.wrap(@field, type: :XXAcroFormField, subtype: :Ch)
-      @field[:FT] = :Ch
-      @field.initialize_as_list_box
-      @generator = HexaPDF::Type::AcroForm::AppearanceGenerator.new(@widget)
-      assert_raises(HexaPDF::Error) { @generator.create_appearances }
-    end
-
     it "fails for unsupported field types" do
       @field[:FT] = :Unknown
       assert_raises(HexaPDF::Error) { @generator.create_appearances }
@@ -121,6 +113,24 @@ describe HexaPDF::Type::AcroForm::AppearanceGenerator do
                         [:curve_to, [8.236068, 7.249543, 9.0, 8.572712, 9.0, 10.0]],
                         [:stroke_path], [:restore_graphics_state]])
     end
+
+    it "handles the special case of a comb field" do
+      @field = @doc.add({FT: :Tx, MaxLen: 4}, type: :XXAcroFormField, subtype: :Tx)
+      @field.initialize_as_comb_text_field
+      @widget = @field.create_widget(@page, Rect: [0, 0, 10, 20])
+      @xform = @doc.add({Type: :XObject, Subtype: :Form, BBox: @widget[:Rect]})
+      @generator = HexaPDF::Type::AcroForm::AppearanceGenerator.new(@widget)
+      @widget.border_style(width: 2)
+      execute
+      assert_operators(@xform.stream,
+                       [[:save_graphics_state],
+                        [:set_line_width, [2]],
+                        [:append_rectangle, [1, 1, 8, 18]],
+                        [:move_to, [2.5, 2]], [:line_to, [2.5, 20.0]],
+                        [:move_to, [5.0, 2]], [:line_to, [5.0, 20.0]],
+                        [:move_to, [7.5, 2]], [:line_to, [7.5, 20.0]],
+                        [:stroke_path], [:restore_graphics_state]])
+    end
   end
 
   describe "draw_marker" do
@@ -342,7 +352,7 @@ describe HexaPDF::Type::AcroForm::AppearanceGenerator do
     end
   end
 
-  describe "text field" do
+  describe "text fields" do
     before do
       @form.set_default_appearance_string
       @field = @doc.add({FT: :Tx}, type: :XXAcroFormField, subtype: :Tx)
@@ -392,35 +402,60 @@ describe HexaPDF::Type::AcroForm::AppearanceGenerator do
       assert_equal(@doc.acro_form.default_resources[:Font][:F1], form[:Resources][:Font][:F1])
     end
 
-    describe "single line text fields" do
-      describe "font size calculation" do
-        before do
-          @widget[:Rect].height = 20
-          @widget[:Rect].width = 100
-          @field.field_value = ''
-        end
+    it "re-uses the existing form XObject" do
+      @field[:V] = 'test'
+      @generator.create_appearances
+      form = @widget[:AP][:N]
+      form[:key] = :value
+      form.delete(:Subtype)
+      @widget[:AP][:N] = @doc.wrap(form, type: HexaPDF::Dictionary)
 
-        it "uses the non-zero font size" do
-          @field.set_default_appearance_string(font_size: 10)
-          @generator.create_appearances
-          assert_operators(@widget[:AP][:N].stream,
-                           [:set_font_and_size, [:F1, 10]],
-                           range: 5)
-        end
+      @field[:V] = 'test1'
+      @generator.create_appearances
+      assert_equal(form, @widget[:AP][:N])
+      refute(form.key?(:key))
+      assert_match(/test1/, form.contents)
+    end
 
-        it "calculates the font size based on the rectangle height and border width" do
-          @generator.create_appearances
-          assert_operators(@widget[:AP][:N].stream,
-                           [:set_font_and_size, [:F1, 12.923875]],
-                           range: 5)
-          @widget.border_style(width: 2, color: :transparent)
-          @generator.create_appearances
-          assert_operators(@widget[:AP][:N].stream,
-                           [:set_font_and_size, [:F1, 11.487889]],
-                           range: 5)
-        end
+    describe "font size calculation" do
+      before do
+        @widget[:Rect].height = 20
+        @widget[:Rect].width = 100
+        @field.field_value = ''
+      end
+
+      it "uses the non-zero font size" do
+        @field.set_default_appearance_string(font_size: 10)
+        @generator.create_appearances
+        assert_operators(@widget[:AP][:N].stream,
+                         [:set_font_and_size, [:F1, 10]],
+                         range: 5)
       end
 
+      it "calculates the font size based on the rectangle height and border width" do
+        @generator.create_appearances
+        assert_operators(@widget[:AP][:N].stream,
+                         [:set_font_and_size, [:F1, 12.923875]],
+                         range: 5)
+        @widget.border_style(width: 2, color: :transparent)
+        @generator.create_appearances
+        assert_operators(@widget[:AP][:N].stream,
+                         [:set_font_and_size, [:F1, 11.487889]],
+                         range: 5)
+      end
+
+      it " in case of mulitline auto-sizing" do
+        @field.initialize_as_multiline_text_field
+        @field[:V] = 'a'
+        @field.set_default_appearance_string(font_size: 0)
+        @generator.create_appearances
+        assert_operators(@widget[:AP][:N].stream,
+                         [:set_font_and_size, [:F1, 12]],
+                         range: 6)
+      end
+    end
+
+    describe "single line text fields" do
       describe "quadding e.g. text alignment" do
         before do
           @field.field_value = 'Test'
@@ -478,7 +513,166 @@ describe HexaPDF::Type::AcroForm::AppearanceGenerator do
                           [:restore_graphics_state],
                           [:end_marked_content]])
       end
+    end
+
+    describe "multiline text fields" do
+      before do
+        @field.set_default_appearance_string(font_size: 10)
+        @field.initialize_as_multiline_text_field
+        @widget[:Rect].height = 30
+        @widget[:Rect].width = 100
+      end
+
+      describe "quadding e.g. text alignment" do
+        before do
+          @field[:V] = "Test\nValue"
+        end
+
+        it "works for left aligned text" do
+          @field.text_alignment(:left)
+          @generator.create_appearances
+          assert_operators(@widget[:AP][:N].stream,
+                           [:set_text_matrix, [1, 0, 0, 1, 2, 16.195]],
+                           range: 9)
+        end
+
+        it "works for right aligned text" do
+          @field.text_alignment(:right)
+          @generator.create_appearances
+          assert_operators(@widget[:AP][:N].stream,
+                           [:set_text_matrix, [1, 0, 0, 1, 78.55, 16.195]],
+                           range: 9)
+        end
+
+        it "works for center aligned text" do
+          @field.text_alignment(:center)
+          @generator.create_appearances
+          assert_operators(@widget[:AP][:N].stream,
+                           [:set_text_matrix, [1, 0, 0, 1, 40.275, 16.195]],
+                           range: 9)
+        end
+      end
+
+      it "creates the /N appearance stream according to the set string" do
+        @field.field_value = "Test\nValue"
+        @generator.create_appearances
+        assert_operators(@widget[:AP][:N].stream,
+                         [[:begin_marked_content, [:Tx]],
+                          [:save_graphics_state],
+                          [:append_rectangle, [1, 1, 98, 28]],
+                          [:clip_path_non_zero],
+                          [:end_path],
+                          [:save_graphics_state],
+                          [:set_leading, [11.5625]],
+                          [:set_font_and_size, [:F1, 10]],
+                          [:begin_text],
+                          [:set_text_matrix, [1, 0, 0, 1, 2, 16.195]],
+                          [:show_text, ['Test']],
+                          [:move_text_next_line],
+                          [:show_text, ['Value']],
+                          [:end_text],
+                          [:restore_graphics_state],
+                          [:restore_graphics_state],
+                          [:end_marked_content]])
+
+        @field.field_value = "Test\nTest\nTest"
+        @field.set_default_appearance_string(font_size: 0)
+        @generator.create_appearances
+        assert_operators(@widget[:AP][:N].stream,
+                         [[:begin_marked_content, [:Tx]],
+                          [:save_graphics_state],
+                          [:append_rectangle, [1, 1, 98, 28]],
+                          [:clip_path_non_zero],
+                          [:end_path],
+                          [:save_graphics_state],
+                          [:set_leading, [9.25]],
+                          [:set_font_and_size, [:F1, 8]],
+                          [:begin_text],
+                          [:set_text_matrix, [1, 0, 0, 1, 2, 18.556]],
+                          [:show_text, ['Test']],
+                          [:move_text_next_line],
+                          [:show_text, ['Test']],
+                          [:move_text_next_line],
+                          [:show_text, ['Test']],
+                          [:end_text],
+                          [:restore_graphics_state],
+                          [:restore_graphics_state],
+                          [:end_marked_content]],
+                        )
+      end
+    end
+
+    describe "comb text fields" do
+      before do
+        @field.set_default_appearance_string(font_size: 10)
+        @field.initialize_as_comb_text_field
+        @field[:MaxLen] = 10
+        @widget[:Rect].height = 20
+        @widget[:Rect].width = 100
+      end
 
+      describe "quadding e.g. text alignment" do
+        before do
+          @field[:V] = 'Test'
+        end
+
+        it "works for left aligned text" do
+          @field.text_alignment(:left)
+          @generator.create_appearances
+          assert_operators(@widget[:AP][:N].stream,
+                           [:set_text_matrix, [1, 0, 0, 1, 2.945, 6.41]],
+                           range: 7)
+        end
+
+        it "works for right aligned text" do
+          @field.text_alignment(:right)
+          @generator.create_appearances
+          assert_operators(@widget[:AP][:N].stream,
+                           [:set_text_matrix, [1, 0, 0, 1, 62.945, 6.41]],
+                           range: 7)
+        end
+
+        it "works for center aligned text" do
+          @field.text_alignment(:center)
+          @generator.create_appearances
+          assert_operators(@widget[:AP][:N].stream,
+                           [:set_text_matrix, [1, 0, 0, 1, 32.945, 6.41]],
+                           range: 7)
+        end
+
+        it "handles centering like Adobe, e.g. shift left, when text cannot be completely centered" do
+          @field.field_value = 'Hello'
+          @field.text_alignment(:center)
+          @generator.create_appearances
+          assert_operators(@widget[:AP][:N].stream,
+                           [:set_text_matrix, [1, 0, 0, 1, 22.39, 6.41]],
+                           range: 7)
+        end
+      end
+
+      it "creates the /N appearance stream according to the set string" do
+        @field.field_value = 'Text'
+        @generator.create_appearances
+        assert_operators(@widget[:AP][:N].stream,
+                         [[:begin_marked_content, [:Tx]],
+                          [:save_graphics_state],
+                          [:append_rectangle, [1, 1, 98, 18]],
+                          [:clip_path_non_zero],
+                          [:end_path],
+                          [:set_font_and_size, [:F1, 10]],
+                          [:begin_text],
+                          [:set_text_matrix, [1, 0, 0, 1, 2.945, 6.41]],
+                          [:show_text_with_positioning, [['T', -416.5, 'e', -472, 'x', -611, 't']]],
+                          [:end_text],
+                          [:restore_graphics_state],
+                          [:end_marked_content]])
+      end
+
+      it "fails if the /MaxLen key is not set" do
+        @field.delete(:MaxLen)
+        @field[:V] = 't'
+        assert_raises(HexaPDF::Error) { @generator.create_appearances }
+      end
     end
 
     describe "choice fields" do
@@ -486,16 +680,75 @@ describe HexaPDF::Type::AcroForm::AppearanceGenerator do
         @form.set_default_appearance_string
         field = @doc.add({FT: :Ch}, type: :XXAcroFormField, subtype: :Ch)
         field.initialize_as_combo_box
+        field.flag(:edit)
+        field.field_value = 'Test'
         widget = field.create_widget(@page, Rect: [0, 0, 0, 0])
         generator = HexaPDF::Type::AcroForm::AppearanceGenerator.new(widget)
         generator.create_appearances
         assert_kind_of(HexaPDF::Type::Form, widget[:AP][:N])
       end
+
+      describe "list boxes" do
+        before do
+          @field = @doc.add({FT: :Ch}, type: :XXAcroFormField, subtype: :Ch)
+          @field.initialize_as_list_box
+          @field.flag(:multi_select)
+          @field.option_items = ['a', 'b', 'c']
+          @widget = @field.create_widget(@page, Rect: [0, 0, 90, 36])
+          @generator = HexaPDF::Type::AcroForm::AppearanceGenerator.new(@widget)
+        end
+
+        it "uses a fixed font size for list box items if auto-sizing is used" do
+          @field.set_default_appearance_string(font_size: 0)
+          @generator.create_appearances
+          assert_operators(@widget[:AP][:N].stream,
+                           [:set_font_and_size, [:F1, 12]],
+                           range: 8)
+        end
+
+        it "uses the set values instead of the ones from /I if in conflict" do
+          @field[:I] = [0, 1]
+          @field[:V] = ['b']
+          @generator.create_appearances
+          assert_operators(@widget[:AP][:N].stream,
+                           [[:set_device_rgb_non_stroking_color, [0.6, 0.756863, 0.854902]],
+                            [:append_rectangle, [1, 7.25, 88, 13.875]],
+                            [:fill_path_non_zero]],
+                           range: 5..7)
+        end
+
+        it "creates the /N appearance stream" do
+          @field[:I] = [1, 2]
+          @field[:V] = ['b', 'c']
+          @generator.create_appearances
+          assert_operators(@widget[:AP][:N].stream,
+                           [[:begin_marked_content, [:Tx]],
+                            [:save_graphics_state],
+                            [:append_rectangle, [1, 1, 88, 34]],
+                            [:clip_path_non_zero], [:end_path],
+                            [:set_device_rgb_non_stroking_color, [0.6, 0.756863, 0.854902]],
+                            [:append_rectangle, [1, 7.25, 88, 13.875]],
+                            [:append_rectangle, [1, -6.625, 88, 13.875]],
+                            [:fill_path_non_zero],
+                            [:save_graphics_state],
+                            [:set_leading, [13.875]],
+                            [:set_font_and_size, [:F1, 12]],
+                            [:set_device_gray_non_stroking_color, [0.0]],
+                            [:begin_text],
+                            [:set_text_matrix, [1, 0, 0, 1, 2, 23.609]],
+                            [:show_text, ["a"]],
+                            [:move_text_next_line],
+                            [:show_text, ["b"]],
+                            [:end_text],
+                            [:restore_graphics_state], [:restore_graphics_state],
+                            [:end_marked_content]])
+        end
+      end
     end
 
     describe "font resolution in case the referenced font is not usable" do
       before do
-        @doc.config['acro_form.fallback_font'] = ['Times', variant: :none]
+        @doc.config['acro_form.fallback_font'] = ['Times', {variant: :none}]
         @field[:V] = 'Test'
       end
 

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

@@ -233,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])
@@ -263,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