hexapdf 0.46.0 → 1.6.0

data/test/hexapdf/layout/test_table_box.rb

@@ -116,6 +116,18 @@ describe HexaPDF::Layout::TableBox::Cell do
       assert_equal(12, cell.preferred_height)
     end
 
+    it "respects the set minimum height of the cell" do
+      cell = create_cell(children: HexaPDF::Layout::Box.create(width: 20, height: 10), min_height: 30)
+      assert(cell.fit(100, 25, @frame).failure?)
+
+      assert(cell.fit(100, 100, @frame).success?)
+      assert_equal(30, cell.height)
+
+      cell = create_cell(children: HexaPDF::Layout::Box.create(width: 20, height: 20), min_height: 2)
+      assert(cell.fit(100, 100, @frame).success?)
+      assert_equal(32, cell.height)
+    end
+
     it "doesn't fit children that are too big" do
       cell = create_cell(children: HexaPDF::Layout::Box.create(width: 300, height: 20))
       assert(cell.fit(100, 100, @frame).failure?)
@@ -143,9 +155,6 @@ describe HexaPDF::Layout::TableBox::Cell do
       box.fit(100, 100, @frame)
       box.draw(@canvas, 10, 75)
       operators = [[:save_graphics_state],
-                   [:append_rectangle, [9.5, 74.5, 101.0, 38.0]],
-                   [:clip_path_non_zero],
-                   [:end_path],
                    [:append_rectangle, [10.0, 75.0, 100.0, 37.0]],
                    [:stroke_path],
                    [:restore_graphics_state],
@@ -265,7 +274,7 @@ describe HexaPDF::Layout::TableBox::Cells do
     end
 
     it "sets the correct information on the created cells" do
-      cells = create_cells([[:a, {col_span: 2, content: :b}],
+      cells = create_cells([[:a, {col_span: 2, content: :b, min_height: 30}],
                             [{col_span: 2, row_span: 2, content: :c}, {row_span: 2, content: :d}]])
       assert_equal(0, cells[0, 0].row)
       assert_equal(0, cells[0, 0].column)
@@ -275,6 +284,7 @@ describe HexaPDF::Layout::TableBox::Cells do
       assert_equal(1, cells[0, 1].column)
       assert_equal(1, cells[0, 1].row_span)
       assert_equal(2, cells[0, 1].col_span)
+      assert_equal(30, cells[0, 1].instance_variable_get(:@min_height))
       assert_equal(1, cells[1, 0].row)
       assert_equal(0, cells[1, 0].column)
       assert_equal(2, cells[1, 0].row_span)
@@ -511,6 +521,58 @@ describe HexaPDF::Layout::TableBox do
                  [0, 66, 39.75, 22], [39.75, 66, 39.75, 22], [79.5, 44, 39.75, 44], [119.25, 66, 39.75, 22]])
     end
 
+    describe "row spans" do
+      # ----------
+      # | a | b  |
+      # | a |    |
+      # | a |----|
+      # | a | c  |
+      # | a |    |
+      # ----------
+      it "works if content of a row span cell is larger than the rows" do
+        cells = [[{row_span: 2, content: @fixed_size_boxes[0..2]}, @fixed_size_boxes[3]],
+                 [@fixed_size_boxes[4]]]
+        check_box(create_box(cells: cells, cell_style: {padding: 0, border: {width: 0}}),
+                  :success, 160, 30,
+                  [[0, 0, 80, 30], [80, 0, 80, 15], [0, 0, 80, 30], [80, 15, 80, 15]])
+      end
+
+      # ----------
+      # | a | b  |
+      # |   |----|
+      # |   | c  |
+      # ----------
+      it "works if content of a row span cell is smaller than the rows" do
+        cells = [[{row_span: 2, content: @fixed_size_boxes[0]}, @fixed_size_boxes[3]],
+                 [@fixed_size_boxes[4]]]
+        check_box(create_box(cells: cells, cell_style: {padding: 0, border: {width: 0}}),
+                  :success, 160, 20,
+                  [[0, 0, 80, 20], [80, 0, 80, 10], [0, 0, 80, 20], [80, 10, 80, 10]])
+      end
+
+      # -----------------
+      # | a | b | c | d |
+      # | a | b |---| d |
+      # | a | b | e |   |
+      # | a |   | e |   |
+      # --------| e |   |
+      # | f | g | e |   |
+      # ----------------
+      it "works if multiple, possibly overlapping row spans are involved" do
+        cells = [[{row_span: 2, content: @fixed_size_boxes[0..2]},
+                  {row_span: 2, content: @fixed_size_boxes[3..4]},
+                  @fixed_size_boxes[5],
+                  {row_span: 3, content: @fixed_size_boxes[6..7]}],
+                 [{row_span: 2, content: @fixed_size_boxes[8, 3]}],
+                 [@fixed_size_boxes[11], @fixed_size_boxes[12]]]
+        check_box(create_box(cells: cells, cell_style: {padding: 0, border: {width: 0}}),
+                  :success, 160, 40,
+                  [[0, 0, 40, 30], [40, 0, 40, 30], [80, 0, 40, 10], [120, 0, 40, 40],
+                   [0, 0, 40, 30], [40, 0, 40, 30], [80, 10, 40, 30], [120, 0, 40, 40],
+                   [0, 30, 40, 10], [40, 30, 40, 10], [80, 10, 40, 30], [120, 0, 40, 40]])
+      end
+    end
+
     it "fits a table with header rows" do
       result = [[0, 0, 80, 10], [80, 0, 80, 10], [0, 10, 80, 10], [80, 10, 80, 10]]
       header = lambda {|_| [@fixed_size_boxes[10, 2], @fixed_size_boxes[12, 2]] }
@@ -622,9 +684,6 @@ describe HexaPDF::Layout::TableBox do
       box.fit(100, 100, @frame)
       box.draw(@canvas, 20, 10)
       operators = [[:save_graphics_state],
-                   [:append_rectangle, [20.0, 32.0, 50.5, 23.0]],
-                   [:clip_path_non_zero],
-                   [:end_path],
                    [:append_rectangle, [20.5, 32.5, 49.5, 22.0]],
                    [:stroke_path],
                    [:restore_graphics_state],
@@ -634,9 +693,6 @@ describe HexaPDF::Layout::TableBox do
                    [:end_path],
                    [:restore_graphics_state],
                    [:save_graphics_state],
-                   [:append_rectangle, [69.5, 32.0, 50.5, 23.0]],
-                   [:clip_path_non_zero],
-                   [:end_path],
                    [:append_rectangle, [70.0, 32.5, 49.5, 22.0]],
                    [:stroke_path],
                    [:restore_graphics_state],
@@ -646,9 +702,6 @@ describe HexaPDF::Layout::TableBox do
                    [:end_path],
                    [:restore_graphics_state],
                    [:save_graphics_state],
-                   [:append_rectangle, [20.0, 10.0, 50.5, 23.0]],
-                   [:clip_path_non_zero],
-                   [:end_path],
                    [:append_rectangle, [20.5, 10.5, 49.5, 22.0]],
                    [:stroke_path],
                    [:restore_graphics_state],
@@ -658,9 +711,6 @@ describe HexaPDF::Layout::TableBox do
                    [:end_path],
                    [:restore_graphics_state],
                    [:save_graphics_state],
-                   [:append_rectangle, [69.5, 10.0, 50.5, 23.0]],
-                   [:clip_path_non_zero],
-                   [:end_path],
                    [:append_rectangle, [70.0, 10.5, 49.5, 22.0]],
                    [:stroke_path],
                    [:restore_graphics_state],

data/test/hexapdf/layout/test_text_box.rb

@@ -178,9 +178,6 @@ describe HexaPDF::Layout::TextBox do
       assert_operators(@canvas.contents, [[:save_graphics_state],
                                           [:restore_graphics_state],
                                           [:save_graphics_state],
-                                          [:append_rectangle, [5, 10, 10, 10]],
-                                          [:clip_path_non_zero],
-                                          [:end_path],
                                           [:append_rectangle, [5.5, 10.5, 9.0, 9.0]],
                                           [:stroke_path],
                                           [:restore_graphics_state],
@@ -194,9 +191,6 @@ describe HexaPDF::Layout::TextBox do
       box.fit(60, 100, @frame)
       box.draw(@canvas, 40, 88)
       assert_operators(@canvas.contents, [[:save_graphics_state],
-                                          [:append_rectangle, [40, 88, 12, 12]],
-                                          [:clip_path_non_zero],
-                                          [:end_path],
                                           [:append_rectangle, [40.5, 88.5, 11.0, 11.0]],
                                           [:stroke_path],
                                           [:restore_graphics_state],

data/test/hexapdf/layout/test_text_fragment.rb

@@ -139,7 +139,7 @@ describe HexaPDF::Layout::TextFragment do
         [:set_text_rise, [2]],
         *middle,
         [:begin_text],
-        [:set_text_matrix, [1, 0, 0, 1, 10, 15]],
+        [:move_text, [10, 15]],
         [:show_text, ['!']],
         *back,
       ].compact
@@ -156,7 +156,7 @@ describe HexaPDF::Layout::TextFragment do
       @canvas = @doc.pages.add.canvas
       @fragment.draw(@canvas, 10, 15, ignore_text_properties: true)
       assert_operators(@canvas.contents, [[:begin_text],
-                                          [:set_text_matrix, [1, 0, 0, 1, 10, 15]]])
+                                          [:move_text, [10, 15]]])
     end
 
     describe "uses an appropriate text position setter" do
@@ -188,7 +188,7 @@ describe HexaPDF::Layout::TextFragment do
       it "horizontal and vertical movement" do
         @fragment.draw(@canvas, 10, 10, ignore_text_properties: true)
         assert_operators(@canvas.contents, [[:begin_text],
-                                            [:set_text_matrix, [1, 0, 0, 1, 10, 10]]])
+                                            [:move_text, [10, 10]]])
       end
     end
 

data/test/hexapdf/layout/test_text_layouter.rb

@@ -743,10 +743,12 @@ describe HexaPDF::Layout::TextLayouter do
       result = processor.recorded_ops
       leading = (result.select {|name, _| name == :set_leading } || [0]).map(&:last).flatten.first
       pos = [0, 0]
-      result.select! {|name, _| name == :set_text_matrix || name == :move_text_next_line }.
-        map! do |name, ops|
+      result.select! do |name, _|
+        name == :set_text_matrix || name == :move_text || name == :move_text_next_line
+      end.map! do |name, ops|
         case name
         when :set_text_matrix then pos = ops[-2, 2]
+        when :move_text then pos = ops
         when :move_text_next_line then pos[1] -= leading
         end
         pos.dup

data/test/hexapdf/task/test_merge_acro_form.rb

@@ -0,0 +1,104 @@
+# -*- encoding: utf-8 -*-
+
+require 'test_helper'
+require 'hexapdf/document'
+require 'hexapdf/task/merge_acro_form'
+
+describe HexaPDF::Task::MergeAcroForm do
+  before do
+    @doc = HexaPDF::Document.new
+    @doc.pages.add
+    @doc.pages.add
+    form = @doc.acro_form(create: true)
+    field = form.create_text_field("Text")
+    field.create_widget(@doc.pages[0], Rect: [0, 0, 0, 0])
+    field.create_widget(@doc.pages[1], Rect: [0, 0, 0, 0])
+
+    form.create_text_field("Calc.Field a")
+    form.create_text_field("Calc.Field b")
+    field = form.create_text_field('Other.Calculation 1')
+    field.set_calculate_action(:sum, fields: ["Calc.Field a", "Calc.Field b"])
+    field.create_widget(@doc.pages[1])
+    field = form.create_text_field('Other.Calculation 2')
+    field.set_calculate_action(:sfn, fields: "Calc.Field\\ a + Calc.Field\\ b")
+    field.create_widget(@doc.pages[1])
+
+    @root_fields = @doc.acro_form.root_fields
+
+    @doc.dispatch_message(:complete_objects)
+    @doc.validate
+    @doc1 = @doc.duplicate
+    @pages = []
+    @pages << @doc.pages.add(@doc.import(@doc1.pages[0]))
+    @pages << @doc.pages.add(@doc.import(@doc1.pages[1]))
+  end
+
+  it "selects a unique name for the root field" do
+    @doc.task(:merge_acro_form, source: @doc1, pages: @pages)
+    assert_equal('merged_1', @root_fields[3][:T])
+
+    @root_fields << @doc.wrap({T: 'merged_23'})
+    @doc.task(:merge_acro_form, source: @doc1, pages: @pages)
+    assert_equal('merged_24', @root_fields[5][:T])
+  end
+
+  it "merges the /DR entry of the main AcroForm dictionary" do
+    @doc.task(:merge_acro_form, source: @doc1, pages: @pages)
+    assert(@doc.acro_form.default_resources[:Font].key?(:F2))
+  end
+
+  it "updates the /SigFlags if necessary" do
+    @doc.task(:merge_acro_form, source: @doc1, pages: [@pages[0]])
+    refute(@doc.acro_form.signature_flag?(:signatures_exist))
+
+    @pages[0][:Annots][0].form_field[:FT] = :Sig
+    @doc.task(:merge_acro_form, source: @doc1, pages: [@pages[0]])
+    refute(@doc.acro_form.signature_flag?(:signatures_exist))
+
+    @doc1.acro_form.signature_flag(:signatures_exist)
+    @doc.task(:merge_acro_form, source: @doc1, pages: [@pages[0]])
+    assert(@doc.acro_form.signature_flag?(:signatures_exist))
+  end
+
+  it "applies the /DA and /Q entries of the source AcroForm to the created root field" do
+    @doc1.acro_form.set_default_appearance_string
+    @doc1.acro_form[:Q] = @doc1.add(5)
+    @doc.task(:merge_acro_form, source: @doc1, pages: [@pages[0]])
+    assert_equal('0.0 g /F2 0 Tf', @root_fields[3][:DA])
+    assert_equal(5, @root_fields[3][:Q])
+  end
+
+  it "merges only the fields references in the given pages" do
+    @doc.task(:merge_acro_form, source: @doc1, pages: [@pages[0]])
+    assert_equal('merged_1', @root_fields[3][:T])
+    assert_equal(1, @root_fields[3][:Kids].size)
+  end
+
+  it "only merges fields that have at least one widget" do
+    @doc.task(:merge_acro_form, source: @doc1, pages: @pages)
+    assert_equal(2, @root_fields[3][:Kids].size)
+    assert_nil(@doc.acro_form.field_by_name('merged_1.Calc'))
+  end
+
+  it "updates the /DA entries of widgets and fields" do
+    @pages[0][:Annots][0][:DA] = +'/F1 10 Tf'
+    @doc.task(:merge_acro_form, source: @doc1, pages: @pages)
+    field = @doc.acro_form.field_by_name('merged_1.Text')
+    assert_equal('0.0 g /F2 0 Tf', field[:DA])
+    assert_equal('/F2 10 Tf', field.each_widget.to_a[0][:DA])
+  end
+
+  it "doesn't update the calculation actions if no field with one is merged" do
+    @doc.task(:merge_acro_form, source: @doc1, pages: [@pages[0]])
+    assert_equal(2, @doc.acro_form[:CO].size)
+  end
+
+  it "updates the field names in known calculation actions" do
+    @doc.task(:merge_acro_form, source: @doc1, pages: @pages)
+    assert_equal(4, @doc.acro_form[:CO].size)
+    js = @doc.acro_form.field_by_name('merged_1.Other.Calculation 1')[:AA][:C][:JS]
+    assert_match(/merged_1.Calc.Field a/, js)
+    js = @doc.acro_form.field_by_name('merged_1.Other.Calculation 2')[:AA][:C][:JS]
+    assert_match(/merged_1.Calc.Field a/, js)
+  end
+end

data/test/hexapdf/task/test_optimize.rb

@@ -8,6 +8,7 @@ describe HexaPDF::Task::Optimize do
   class TestType < HexaPDF::Dictionary
 
     define_type :Test
+    define_field :Type, type: Symbol, default: type
     define_field :Optional, type: Symbol, default: :Optional
 
   end
@@ -46,6 +47,7 @@ describe HexaPDF::Task::Optimize do
   end
 
   def assert_default_deleted
+    assert(@doc.object(1).key?(:Type))
     refute(@doc.object(1).key?(:Optional))
   end
 
@@ -97,7 +99,7 @@ describe HexaPDF::Task::Optimize do
       objstm = @doc.add({}, type: HexaPDF::Type::ObjectStream)
       @doc.add({}, type: HexaPDF::Type::XRefStream)
       objstm.add_object(@doc.add({Type: :Test}))
-      @doc.write(io)
+      @doc.write(io, compact: false)
       io.rewind
       @doc = HexaPDF::Document.new(io: io)
     end

data/test/hexapdf/test_composer.rb

@@ -63,6 +63,14 @@ describe HexaPDF::Composer do
     end
   end
 
+  it "writes the document to a string" do
+    pdf = HexaPDF::Composer.new
+    pdf.new_page
+    str = pdf.write_to_string
+    doc = HexaPDF::Document.new(io: StringIO.new(str))
+    assert_equal(2, doc.pages.count)
+  end
+
   describe "new_page" do
     it "creates a new page" do
       c = HexaPDF::Composer.new(page_size: [0, 0, 50, 100], margin: 10)
@@ -119,6 +127,13 @@ describe HexaPDF::Composer do
     end
   end
 
+  describe "style?" do
+    it "delegates to layout.style?" do
+      @composer.document.layout.style(:header, font_size: 20)
+      assert(@composer.style?(:header))
+    end
+  end
+
   describe "styles" do
     it "delegates to layout.styles" do
       @composer.styles(base: {font_size: 30}, other: {font_size: 40})

data/test/hexapdf/test_dictionary.rb

@@ -251,8 +251,23 @@ describe HexaPDF::Dictionary do
       refute(@obj.validate(auto_correct: false))
       assert(@obj.validate(auto_correct: true))
       @obj.value[:NameField] = "string"
+      refute(@obj.validate(auto_correct: false))
       assert(@obj.validate(auto_correct: true))
+
+      @test_class.define_field(:RequiredDefault, type: String, required: true, default: 'str')
+      @obj.value[:RequiredDefault] = 20
+      refute(@obj.validate(auto_correct: false))
+      assert_equal(20, @obj.value[:RequiredDefault])
       assert(@obj.validate(auto_correct: true))
+      assert_equal("str", @obj.value[:RequiredDefault])
+
+      @obj.value[:AllowedValues] = '20'
+      assert(@obj.validate(auto_correct: true))
+      refute(@obj.key?(:AllowedValues))
+
+      @obj.value[:Inherited] = 20
+      refute(@obj.validate(auto_correct: true))
+      refute(@obj.key?(:Inherited))
     end
 
     it "checks whether the value is an allowed one" do

data/test/hexapdf/test_dictionary_fields.rb

@@ -193,6 +193,7 @@ describe HexaPDF::DictionaryFields do
         ["D:19981223195210Z00'00", [1998, 12, 23, 19, 52, 10, "+00:00"]],
         ["D:19981223195210-08", [1998, 12, 23, 19, 52, 10, "-08:00"]], # missing '
         ["D:19981223195210-08'00", [1998, 12, 23, 19, 52, 10, "-08:00"]], # no trailing ', as per PDF 2.0
+        ["D:19981223195210-08'00''", [1998, 12, 23, 19, 52, 10, "-08:00"]], # two trailing '
         ["D:19981223195210-54'00", [1998, 12, 23, 19, 52, 10, "-23:59:59"]], #  TZ hour too large
         ["D:19981223195210+10'65", [1998, 12, 23, 19, 52, 10, "+11:05"]], # TZ min too large
         ["D:19982423195210-08'00'", [1998, 12, 23, 19, 52, 10, "-08:00"]], # months too large

data/test/hexapdf/test_document.rb

@@ -54,7 +54,7 @@ describe HexaPDF::Document do
   describe "::open" do
     before do
       @file = Tempfile.new('hexapdf-document')
-      @io_doc.write(@file)
+      @io_doc.write(@file, compact: false)
       @file.close
     end
 
@@ -347,7 +347,7 @@ describe HexaPDF::Document do
 
     it "validates the trailer object" do
       @doc.trailer[:ID] = :Symbol
-      refute(@doc.validate {|_, _, obj| assert_same(@doc.trailer, obj) })
+      assert(@doc.validate {|_a, _b, obj| assert_same(@doc.trailer, obj) })
     end
 
     it "validates only loaded objects" do
@@ -370,7 +370,7 @@ describe HexaPDF::Document do
     it "writes the document to a file" do
       file = Tempfile.new('hexapdf-write')
       file.close
-      @io_doc.write(file.path)
+      @io_doc.write(file.path, compact: false)
       HexaPDF::Document.open(file.path) do |doc|
         assert_equal(200, doc.object(2).value)
       end
@@ -391,7 +391,7 @@ describe HexaPDF::Document do
     end
 
     it "fails if the document is not valid" do
-      @doc.trailer[:Size] = :Symbol
+      @doc.catalog[:PageLayout] = :invalid_value
       assert_raises(HexaPDF::Error) { @doc.write(StringIO.new(''.b)) }
     end
 
@@ -422,10 +422,18 @@ describe HexaPDF::Document do
 
     it "allows optimizing the file by using object streams" do
       io = StringIO.new(''.b)
-      @io_doc.write(io, optimize: true)
+      @io_doc.write(io, optimize: true, compact: false)
       doc = HexaPDF::Document.new(io: io)
       assert_equal(2, doc.each.count {|o| o.type == :ObjStm })
     end
+
+    it "automatically compacts the file" do
+      io = StringIO.new(''.b)
+      @io_doc.write(io)
+      doc = HexaPDF::Document.new(io: io)
+      assert_equal(1, doc.revisions.count)
+      assert_equal(4, doc.each.count)
+    end
   end
 
   describe "version" do
@@ -497,10 +505,10 @@ describe HexaPDF::Document do
 
     it "returns all signature fields of the document" do
       form = @doc.acro_form(create: true)
-      sig1 = @doc.add({FT: :Sig, T: 'sig1', V: :sig1})
-      sig2 = @doc.add({FT: :Sig, T: 'sig2', V: :sig2})
+      sig1 = @doc.add({FT: :Sig, T: 'sig1', V: {k: :sig1}})
+      sig2 = @doc.add({FT: :Sig, T: 'sig2', V: {k: :sig2}})
       form.root_fields << sig1 << sig2
-      assert_equal([:sig1, :sig2], @doc.signatures.to_a)
+      assert_equal([{k: :sig1}, {k: :sig2}], @doc.signatures.to_a)
     end
 
     it "allows to conveniently sign a document" do
@@ -595,4 +603,14 @@ describe HexaPDF::Document do
       refute(dupped.encrypted?)
     end
   end
+
+  it "writes the document to a string" do
+    doc = HexaPDF::Document.new
+    doc.trailer.info[:test] = :test
+    str = doc.write_to_string(update_fields: false)
+    assert_equal(Encoding::ASCII_8BIT, str.encoding)
+    doc = HexaPDF::Document.new(io: StringIO.new(str))
+    assert_equal(:test, doc.trailer.info[:test])
+    assert_nil(doc.trailer.info[:ModDate])
+  end
 end

data/test/hexapdf/test_filter.rb

@@ -8,7 +8,7 @@ require 'tempfile'
 describe HexaPDF::Filter do
   before do
     @obj = HexaPDF::Filter
-    @str = ''
+    @str = +''
     40.times { @str << [rand(2**32)].pack('N') }
   end
 

data/test/hexapdf/test_importer.rb

@@ -147,6 +147,13 @@ describe HexaPDF::Importer do
       assert_nil(obj[:pages])
     end
 
+    it "handles null values correctly" do
+      @source.add(@hash)
+      @source.delete(@hash)
+      obj = @importer.import(@obj)
+      assert_nil(obj[:hash])
+    end
+
     it "imports Page objects correctly by copying the inherited values" do
       page = @importer.import(@source.pages[0])
       assert_equal(90, page[:Rotate])

data/test/hexapdf/test_object.rb

@@ -197,7 +197,7 @@ describe HexaPDF::Object do
       @obj.define_singleton_method(:perform_validation) { raise "Unknown" }
       invoked = []
       refute(@obj.validate {|*a| invoked << a })
-      assert_equal([["Error: Unexpected value encountered", false, @obj]], invoked)
+      assert_equal([["Unexpected error encountered: Unknown", false, @obj]], invoked)
     end
   end