hexapdf 0.12.0 → 0.14.0

data/test/hexapdf/test_pdf_array.rb

@@ -107,6 +107,13 @@ describe HexaPDF::PDFArray do
     assert_equal([1, :data, @array[2]], @array[0, 5])
   end
 
+  it "allows deleting an object" do
+    obj = @array.value[1]
+    assert_same(obj, @array.delete(obj))
+    ref = HexaPDF::Object.new(:test, oid: 1)
+    assert_equal(ref, @array.delete(ref))
+  end
+
   describe "slice!" do
     it "allows deleting a single element" do
       @array.slice!(2)
@@ -157,6 +164,6 @@ describe HexaPDF::PDFArray do
   end
 
   it "can be converted to a simple array" do
-    assert_equal(@array.value, @array.to_ary)
+    assert_equal([1, :data, "deref", @array[3]], @array.to_ary)
   end
 end

data/test/hexapdf/test_revisions.rb

@@ -158,4 +158,39 @@ describe HexaPDF::Revisions do
     doc = HexaPDF::Document.new(io: io)
     assert_equal(2, doc.revisions.count)
   end
+
+  it "uses the reconstructed revision if errors are found when loading from an IO" do
+    io = StringIO.new(<<~EOF)
+      %PDF-1.7
+      1 0 obj
+      10
+      endobj
+
+      xref
+      0 2
+      0000000000 65535 f 
+      0000000009 00000 n 
+      trailer
+      << /Size 5 >>
+      startxref
+      28
+      %%EOF
+
+      2 0 obj
+      300
+      endobj
+
+      xref
+      2 1
+      0000000301 00000 n 
+        trailer
+      << /Size 3 /Prev 100>>
+      startxref
+      139
+      %%EOF
+    EOF
+    doc = HexaPDF::Document.new(io: io)
+    assert_equal(2, doc.revisions.count)
+    assert_same(doc.revisions[0].trailer.value, doc.revisions[1].trailer.value)
+  end
 end

data/test/hexapdf/test_writer.rb

@@ -40,7 +40,7 @@ describe HexaPDF::Writer do
       219
       %%EOF
       3 0 obj
-      <</Producer(HexaPDF version 0.12.0)>>
+      <</Producer(HexaPDF version 0.14.0)>>
       endobj
       xref
       3 1
@@ -72,7 +72,7 @@ describe HexaPDF::Writer do
       141
       %%EOF
       6 0 obj
-      <</Producer(HexaPDF version 0.12.0)>>
+      <</Producer(HexaPDF version 0.14.0)>>
       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,58 @@ 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
 
-        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_same(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 +511,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,27 +678,93 @@ 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
-        def (@form.default_resources.font(:F1)).font_wrapper; nil; end
-        @field.field_value = 'Test'
+        @doc.config['acro_form.fallback_font'] = ['Times', {variant: :none}]
+        @field[:V] = 'Test'
       end
 
-      it "uses the fallback font if configured" do
-        @doc.config['acro_form.fallback_font'] = ['Times', variant: :none]
+      it "uses the fallback font if the font is not usable" do
+        def (@form.default_resources.font(:F1)).font_wrapper; nil; end
         @generator.create_appearances
         assert_equal(:'Times-Roman', @widget[:AP][:N][:Resources][:Font][:F2][:BaseFont])
       end
 
+      it "uses the fallback font if the font is not found" do
+        @form.default_resources[:Font].delete(:F1)
+        @generator.create_appearances
+        assert_equal(:'Times-Roman', @widget[:AP][:N][:Resources][:Font][:F1][:BaseFont])
+      end
+
       it "fails if fallback fonts are disabled" do
         @doc.config['acro_form.fallback_font'] = nil
+        @form.default_resources[:Font].delete(:F1)
         msg = assert_raises(HexaPDF::Error) { @generator.create_appearances }
         assert_match(/Font.*not usable/, msg.message)
       end