hexapdf 0.30.0 → 0.32.0

data/test/hexapdf/layout/test_text_box.rb

@@ -139,12 +139,15 @@ describe HexaPDF::Layout::TextBox do
       assert_operators(@canvas.contents, [[:save_graphics_state],
                                           [:restore_graphics_state],
                                           [:save_graphics_state],
-                                          [:append_rectangle, [5, 10, 10, 10]],
+                                          [:concatenate_matrix, [1, 0, 0, 1, 5, 10]],
+                                          [:save_graphics_state],
+                                          [:append_rectangle, [0, 0, 10, 10]],
                                           [:clip_path_non_zero],
                                           [:end_path],
-                                          [:append_rectangle, [5.5, 10.5, 9, 9]],
+                                          [:append_rectangle, [0.5, 0.5, 9.0, 9.0]],
                                           [:stroke_path],
                                           [:restore_graphics_state],
+                                          [:restore_graphics_state],
                                           [:save_graphics_state],
                                           [:restore_graphics_state]])
     end

data/test/hexapdf/layout/test_text_layouter.rb

@@ -7,13 +7,13 @@ require 'hexapdf/document'
 module TestTextLayouterHelpers
   def boxes(*dims)
     dims.map do |width, height|
-      box = HexaPDF::Layout::InlineBox.create(width: width, height: height || 0) {}
+      box = HexaPDF::Layout::InlineBox.create(width: width, height: height || 10) {}
       HexaPDF::Layout::TextLayouter::Box.new(box)
     end
   end
 
   def glue(width)
-    HexaPDF::Layout::TextLayouter::Glue.new(HexaPDF::Layout::InlineBox.create(width: width) {})
+    HexaPDF::Layout::TextLayouter::Glue.new(HexaPDF::Layout::InlineBox.create(width: width, height: 10) {})
   end
 
   def penalty(penalty, item = nil)
@@ -136,16 +136,8 @@ describe HexaPDF::Layout::TextLayouter::SimpleTextSegmentation do
     [1, 3, 5, 7, 9, 11, 13, 17, 19].each do |index|
       assert_penalty(result[index],
                      HexaPDF::Layout::TextLayouter::Penalty::PARAGRAPH_BREAK)
-      assert_equal([], result[index].item.items)
-      assert(result[index].item.items.frozen?)
-      assert_same(frag.style, result[index].item.style)
-      assert_equal(frag.properties, result[index].item.properties)
     end
     assert_penalty(result[15], HexaPDF::Layout::TextLayouter::Penalty::LINE_BREAK)
-    assert_equal([], result[15].item.items)
-    assert(result[15].item.items.frozen?)
-    assert_same(frag.style, result[15].item.style)
-    assert_equal(frag.properties, result[15].item.properties)
   end
 
   it "insert a standard penalty after a hyphen" do
@@ -624,7 +616,7 @@ describe HexaPDF::Layout::TextLayouter do
 
     describe "horizontal alignment" do
       before do
-        @items = boxes(*[[20, 20]] * 4) + [glue(10), penalty(-5000, boxes(0).first.item)]
+        @items = boxes(*[[20, 20]] * 4) + [glue(10), penalty(-5000)]
       end
 
       it "aligns the contents to the left" do
@@ -789,8 +781,11 @@ describe HexaPDF::Layout::TextLayouter do
                                           [:restore_graphics_state],
                                           [:save_graphics_state],
                                           [:concatenate_matrix, [1, 0, 0, 1, 10, -40]],
+                                          [:save_graphics_state],
+                                          [:concatenate_matrix, [1, 0, 0, 1, 0, 0]],
                                           [:set_line_width, [2]],
                                           [:restore_graphics_state],
+                                          [:restore_graphics_state],
                                           [:save_graphics_state],
                                           [:restore_graphics_state]])
     end

data/test/hexapdf/task/test_optimize.rb

@@ -81,8 +81,10 @@ describe HexaPDF::Task::Optimize do
     end
 
     it "compacts and deletes xref streams" do
-      @doc.revisions.all[0].add(@doc.wrap({Type: :XRef}, oid: @doc.revisions.next_oid))
-      @doc.revisions.all[1].add(@doc.wrap({Type: :XRef}, oid: @doc.revisions.next_oid))
+      @doc.revisions.all[0].add(@doc.wrap({}, type: HexaPDF::Type::XRefStream,
+                                          oid: @doc.revisions.next_oid))
+      @doc.revisions.all[1].add(@doc.wrap({}, type: HexaPDF::Type::XRefStream,
+                                          oid: @doc.revisions.next_oid))
       @doc.task(:optimize, compact: true, xref_streams: :delete)
       assert_no_xrefstms
       assert_default_deleted
@@ -92,8 +94,8 @@ describe HexaPDF::Task::Optimize do
   describe "object_streams" do
     def reload_document_with_objstm_from_io
       io = StringIO.new
-      objstm = @doc.add({Type: :ObjStm})
-      @doc.add({Type: :XRef})
+      objstm = @doc.add({}, type: HexaPDF::Type::ObjectStream)
+      @doc.add({}, type: HexaPDF::Type::XRefStream)
       objstm.add_object(@doc.add({Type: :Test}))
       @doc.write(io)
       io.rewind
@@ -102,7 +104,7 @@ describe HexaPDF::Task::Optimize do
 
     it "generates object streams" do
       210.times { @doc.add(5) }
-      objstm = @doc.add({Type: :ObjStm})
+      objstm = @doc.add({}, type: HexaPDF::Type::ObjectStream)
       reload_document_with_objstm_from_io
       @doc.task(:optimize, object_streams: :generate)
       assert_objstms_generated
@@ -122,8 +124,8 @@ describe HexaPDF::Task::Optimize do
     end
 
     it "deletes object and generates xref streams" do
-      @doc.add({Type: :ObjStm})
-      xref = @doc.add({Type: :XRef})
+      @doc.add({}, type: HexaPDF::Type::ObjectStream)
+      xref = @doc.add({}, type: HexaPDF::Type::XRefStream)
       @doc.task(:optimize, object_streams: :delete, xref_streams: :generate)
       assert_no_objstms
       assert_xrefstms_generated
@@ -140,13 +142,13 @@ describe HexaPDF::Task::Optimize do
     end
 
     it "reuses an xref stream in generatation mode" do
-      @doc.add({Type: :XRef})
+      @doc.add({}, type: HexaPDF::Type::XRefStream)
       @doc.task(:optimize, xref_streams: :generate)
       assert_xrefstms_generated
     end
 
     it "deletes xref streams" do
-      @doc.add({Type: :XRef})
+      @doc.add({}, type: HexaPDF::Type::XRefStream)
       @doc.task(:optimize, xref_streams: :delete)
       assert_no_xrefstms
       assert_default_deleted

data/test/hexapdf/test_composer.rb

@@ -39,6 +39,14 @@ describe HexaPDF::Composer do
       assert_equal(682, composer.frame.height)
     end
 
+    it "allows skipping the initial page creation" do
+      composer = HexaPDF::Composer.new(skip_page_creation: true)
+      assert_nil(composer.page)
+      assert_nil(composer.canvas)
+      assert_nil(composer.frame)
+      assert_nil(composer.page_style(:default))
+    end
+
     it "yields itself" do
       yielded = nil
       composer = HexaPDF::Composer.new {|c| yielded = c }
@@ -56,7 +64,7 @@ describe HexaPDF::Composer do
   end
 
   describe "new_page" do
-    it "creates a new page with the stored information" do
+    it "creates a new page" do
       c = HexaPDF::Composer.new(page_size: [0, 0, 50, 100], margin: 10)
       c.new_page
       assert_equal([0, 0, 50, 100], c.page.box.value)
@@ -64,16 +72,33 @@ describe HexaPDF::Composer do
       assert_equal(10, c.frame.bottom)
     end
 
-    it "uses the provided information for the new and all following pages" do
-      @composer.new_page(page_size: [0, 0, 50, 100], margin: 10)
-      assert_equal([0, 0, 50, 100], @composer.page.box.value)
-      assert_equal(10, @composer.frame.left)
-      assert_equal(10, @composer.frame.bottom)
+    it "uses the named page style for the new page" do
+      @composer.page_style(:other, page_size: [0, 0, 100, 100])
+      @composer.new_page(:other)
+      assert_equal([0, 0, 100, 100], @composer.page.box.value)
+    end
+
+    it "sets the next page's style to the next_style value of the used page style" do
+      @composer.page_style(:one, page_size: [0, 0, 1, 1]).next_style = :two
+      @composer.page_style(:two, page_size: [0, 0, 2, 2]).next_style = :one
+      @composer.new_page(:one)
+      assert_equal([0, 0, 1, 1], @composer.page.box.value)
+      @composer.new_page
+      assert_equal([0, 0, 2, 2], @composer.page.box.value)
       @composer.new_page
-      assert_same(@composer.document.pages[2], @composer.page)
-      assert_equal([0, 0, 50, 100], @composer.page.box.value)
-      assert_equal(10, @composer.frame.left)
-      assert_equal(10, @composer.frame.bottom)
+      assert_equal([0, 0, 1, 1], @composer.page.box.value)
+    end
+
+    it "uses the current page style for new pages if no next_style value is set" do
+      @composer.page_style(:one, page_size: [0, 0, 1, 1])
+      @composer.new_page(:one)
+      assert_equal([0, 0, 1, 1], @composer.page.box.value)
+      @composer.new_page
+      assert_equal([0, 0, 1, 1], @composer.page.box.value)
+    end
+
+    it "fails if the specified page style has not been defined" do
+      assert_raises(ArgumentError) { @composer.new_page(:unknown) }
     end
   end
 
@@ -94,7 +119,7 @@ describe HexaPDF::Composer do
     end
   end
 
-  describe "text/formatted_text/image/box" do
+  describe "text/formatted_text/image/box/method_missing" do
     before do
       test_self = self
       @composer.define_singleton_method(:draw_box) do |arg|
@@ -133,6 +158,19 @@ describe HexaPDF::Composer do
       assert_equal(20, @box.width)
       assert_same(image, @box.children[0].image)
     end
+
+    it "delegates missing methods to layout if they are box creation methods" do
+      @composer.column(width: 10)
+      assert_equal(10, @box.width)
+    end
+
+    it "fails for missing methods that can't be delegated to layout" do
+      assert_raises(NameError) { @composer.unknown_box }
+    end
+
+    it "can be asked whether a missing method is supported" do
+      assert(@composer.respond_to?(:column))
+    end
   end
 
   describe "draw_box" do

data/test/hexapdf/test_tokenizer.rb

@@ -37,6 +37,11 @@ describe HexaPDF::Tokenizer do
     end
   end
 
+  it "next_token: should not fail for strings due to use of an internal buffer" do
+    create_tokenizer("(" << ("a" * 8189) << "\\006)")
+    assert_equal("a" * 8189 << "\x06", @tokenizer.next_token)
+  end
+
   it "has a special token scanning method for use with xref reconstruction" do
     create_tokenizer(<<-EOF.chomp.gsub(/^ {8}/, ''))
         % Comment

data/test/hexapdf/test_writer.rb

@@ -40,7 +40,7 @@ describe HexaPDF::Writer do
       219
       %%EOF
       3 0 obj
-      <</Producer(HexaPDF version 0.30.0)>>
+      <</Producer(HexaPDF version 0.32.0)>>
       endobj
       xref
       3 1
@@ -72,7 +72,7 @@ describe HexaPDF::Writer do
       141
       %%EOF
       6 0 obj
-      <</Producer(HexaPDF version 0.30.0)>>
+      <</Producer(HexaPDF version 0.32.0)>>
       endobj
       2 0 obj
       <</Length 10>>stream
@@ -171,7 +171,7 @@ describe HexaPDF::Writer do
 
   it "creates an xref stream if no xref stream is in a revision but object streams are" do
     document = HexaPDF::Document.new
-    document.add({Type: :ObjStm})
+    document.add({}, type: HexaPDF::Type::ObjectStream)
     HexaPDF::Writer.new(document, StringIO.new).write
     assert_equal(:XRef, document.object(4).type)
   end
@@ -184,7 +184,7 @@ describe HexaPDF::Writer do
 
     document = HexaPDF::Document.new(io: io)
     document.pages.add
-    document.add({Type: :ObjStm})
+    document.add({}, type: HexaPDF::Type::ObjectStream)
     io2 = StringIO.new
     HexaPDF::Writer.new(document, io2).write_incremental
 
@@ -214,7 +214,7 @@ describe HexaPDF::Writer do
       <</Type/Page/MediaBox[0 0 595 842]/Parent 2 0 R/Resources<<>>>>
       endobj
       5 0 obj
-      <</Producer(HexaPDF version 0.30.0)>>
+      <</Producer(HexaPDF version 0.32.0)>>
       endobj
       4 0 obj
       <</Root 1 0 R/Info 5 0 R/Size 6/Type/XRef/W[1 1 2]/Index[0 6]/Filter/FlateDecode/DecodeParms<</Columns 4/Predictor 12>>/Length 33>>stream

data/test/hexapdf/type/test_object_stream.rb

@@ -123,12 +123,21 @@ describe HexaPDF::Type::ObjectStream do
     end
   end
 
-  it "fails validation if gen != 0" do
-    assert(@obj.validate(auto_correct: false))
-    @obj.gen = 1
-    refute(@obj.validate(auto_correct: false) do |msg, correctable|
-             assert_match(/invalid generation/, msg)
-             refute(correctable)
-           end)
+  describe "perform_validation" do
+    it "fails validation if gen != 0" do
+      assert(@obj.validate(auto_correct: false))
+      @obj.gen = 1
+      refute(@obj.validate(auto_correct: false) do |msg, correctable|
+        assert_match(/invalid generation/, msg)
+        refute(correctable)
+      end)
+    end
+
+    it "sets the /N and /First entries to dummy values so that validation works" do
+      @obj = HexaPDF::Type::ObjectStream.new({}, oid: 1, document: @doc)
+      assert(@obj.validate(auto_correct: false))
+      assert_equal(0, @obj[:N])
+      assert_equal(0, @obj[:First])
+    end
   end
 end

data/test/hexapdf/type/test_outline.rb

@@ -30,11 +30,12 @@ describe HexaPDF::Type::Outline do
 
   describe "perform_validation" do
     before do
-      5.times { @outline.add_item("Test1") }
+      @outline_items = 5.times.map { @outline.add_item("Test1") }
     end
 
     it "fixes a missing /First entry" do
       @outline.delete(:First)
+      @outline_items[0][:Prev] = HexaPDF::Reference.new(100)
       called = false
       @outline.validate do |msg, correctable, _|
         called = true
@@ -46,6 +47,7 @@ describe HexaPDF::Type::Outline do
 
     it "fixes a missing /Last entry" do
       @outline.delete(:Last)
+      @outline_items[4][:Next] = HexaPDF::Reference.new(100)
       called = false
       @outline.validate do |msg, correctable, _|
         called = true

data/test/hexapdf/type/test_outline_item.rb

@@ -98,6 +98,24 @@ describe HexaPDF::Type::OutlineItem do
     end
   end
 
+  describe "open?" do
+    it "returns true if the outline item is open" do
+      refute(@item.open?)
+      @item.add_item("test")
+      assert_equal(true, @item.open?)
+    end
+
+    it "returns false if the outline item is closed" do
+      @item.delete(:Count)
+      @item.add_item("test")
+      assert_equal(false, @item.open?)
+    end
+
+    it "returns nil if the outline item doesn't have any child items" do
+      assert_nil(@item.open?)
+    end
+  end
+
   describe "destination_page" do
     it "returns the page of a set destination" do
       @item[:Dest] = [5, :Fit]
@@ -276,12 +294,13 @@ describe HexaPDF::Type::OutlineItem do
 
   describe "perform_validation" do
     before do
-      5.times { @item.add_item("Test1") }
+      @outline_items = 5.times.map { @item.add_item("Test1") }
       @item[:Parent] = @doc.add({})
     end
 
     it "fixes a missing /First entry" do
       @item.delete(:First)
+      @outline_items[0][:Prev] = HexaPDF::Reference.new(100)
       called = false
       @item.validate do |msg, correctable, _|
         called = true
@@ -293,6 +312,7 @@ describe HexaPDF::Type::OutlineItem do
 
     it "fixes a missing /Last entry" do
       @item.delete(:Last)
+      @outline_items[4][:Next] = HexaPDF::Reference.new(100)
       called = false
       @item.validate do |msg, correctable, _|
         called = true

data/test/hexapdf/type/test_page.rb

@@ -19,9 +19,21 @@ describe HexaPDF::Type::Page do
       assert_equal([0, 0, 842, 595], HexaPDF::Type::Page.media_box(:A4, orientation: :landscape))
     end
 
+    it "works with a paper size array" do
+      assert_equal([0, 0, 842, 595], HexaPDF::Type::Page.media_box([0, 0, 842, 595]))
+    end
+
     it "fails if the paper size is unknown" do
       assert_raises(HexaPDF::Error) { HexaPDF::Type::Page.media_box(:Unknown) }
     end
+
+    it "fails if the array doesn't contain four numbers" do
+      assert_raises(HexaPDF::Error) { HexaPDF::Type::Page.media_box([0, 1, 2]) }
+    end
+
+    it "fails if the array doesn't contain only numbers" do
+      assert_raises(HexaPDF::Error) { HexaPDF::Type::Page.media_box([0, 1, 2, 'a']) }
+    end
   end
 
   # Asserts that the page's contents contains the operators.
@@ -70,22 +82,41 @@ describe HexaPDF::Type::Page do
     end
   end
 
-  describe "validation" do
+  describe "perform_validation" do
     it "only does validation if the page is in the document's page tree" do
       page = @doc.add({Type: :Page})
+      assert(page.validate(auto_correct: false))
+      page[:Parent] = @doc.add({Type: :Pages, Kids: [page], Count: 1})
+      assert(page.validate(auto_correct: false))
+      @doc.pages.add(page)
+      refute(page.validate(auto_correct: false))
+    end
+
+    it "validates that the required inheritable field /Resources is set" do
+      page = @doc.pages.add
+      page.delete(:Resources)
+      refute(page.validate(auto_correct: false))
       assert(page.validate)
-      page[:Parent] = @doc.add({Type: :Pages, Kids: [page]})
-      assert(page.validate)
-      page[:Parent] = @doc.catalog.pages
-      refute(page.validate)
+      assert_kind_of(HexaPDF::Dictionary, page[:Resources])
     end
 
-    it "fails if a required inheritable field is not set" do
-      root = @doc.catalog[:Pages] = @doc.add({Type: :Pages})
-      page = @doc.add({Type: :Page, Parent: root})
-      message = ''
-      refute(page.validate {|m, _| message = m })
-      assert_match(/inheritable.*MediaBox/i, message)
+    it "validates that the required inheritable field /MediaBox is set" do
+      page1 = @doc.pages.add(:Letter)
+      page2 = @doc.pages.add(:Letter)
+      page3 = @doc.pages.add(:Letter)
+
+      [page1, page2, page3].each do |page|
+        page.delete(:MediaBox)
+        refute(page.validate(auto_correct: false))
+        assert(page.validate)
+        assert_equal([0, 0, 612, 792], page[:MediaBox])
+      end
+
+      page2.delete(:MediaBox)
+      page1[:MediaBox] = [0, 0, 1, 1]
+      refute(page2.validate(auto_correct: false))
+      assert(page2.validate)
+      assert_equal([0, 0, 595, 842], page2[:MediaBox])
     end
   end
 
@@ -611,6 +642,22 @@ describe HexaPDF::Type::Page do
                                           [:restore_graphics_state]])
     end
 
+    it "handles degenerate cases when the appearance's bounding box has zero width" do
+      @appearance[:BBox] = [10, 10, 10, 20]
+      result = @page.flatten_annotations
+      assert(result.empty?)
+      assert(@annot1.null?)
+      assert_operators(@canvas.contents, [])
+    end
+
+    it "handles degenerate cases when the appearance's bounding box has zero height" do
+      @appearance[:BBox] = [10, 10, 20, 10]
+      result = @page.flatten_annotations
+      assert(result.empty?)
+      assert(@annot1.null?)
+      assert_operators(@canvas.contents, [])
+    end
+
     it "potentially adjusts the origin so that it is always in (0,0)" do
       @canvas.translate(-15, -15)
       @page.flatten_annotations

data/test/hexapdf/type/test_xref_stream.rb

@@ -6,9 +6,10 @@ require 'hexapdf/type/xref_stream'
 describe HexaPDF::Type::XRefStream do
   before do
     @doc = Object.new
+    @doc.instance_variable_set(:@version, '1.5')
     def (@doc).deref(obj); obj; end
     def (@doc).wrap(obj, **); obj; end
-    @obj = HexaPDF::Type::XRefStream.new({}, oid: 1, document: @doc)
+    @obj = HexaPDF::Type::XRefStream.new({}, oid: 1, document: @doc, stream: '')
   end
 
   describe "xref_section" do
@@ -141,4 +142,8 @@ describe HexaPDF::Type::XRefStream do
       assert_raises(HexaPDF::Error) { @obj.update_with_xref_section_and_trailer(@section, {}) }
     end
   end
+
+  it "sets /Size and /W to dummy values to make validation work" do
+    assert(@obj.validate(auto_correct: false))
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hexapdf
 version: !ruby/object:Gem::Version
-  version: 0.30.0
+  version: 0.32.0
 platform: ruby
 authors:
 - Thomas Leitner
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-02-13 00:00:00.000000000 Z
+date: 2023-03-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: cmdparse
@@ -428,6 +428,7 @@ files:
 - lib/hexapdf/layout/line.rb
 - lib/hexapdf/layout/list_box.rb
 - lib/hexapdf/layout/numeric_refinements.rb
+- lib/hexapdf/layout/page_style.rb
 - lib/hexapdf/layout/style.rb
 - lib/hexapdf/layout/text_box.rb
 - lib/hexapdf/layout/text_fragment.rb
@@ -679,6 +680,7 @@ files:
 - test/hexapdf/layout/test_inline_box.rb
 - test/hexapdf/layout/test_line.rb
 - test/hexapdf/layout/test_list_box.rb
+- test/hexapdf/layout/test_page_style.rb
 - test/hexapdf/layout/test_style.rb
 - test/hexapdf/layout/test_text_box.rb
 - test/hexapdf/layout/test_text_fragment.rb