hexapdf 0.35.1 → 0.37.0

data/test/hexapdf/document/test_metadata.rb

@@ -0,0 +1,192 @@
+# -*- encoding: utf-8 -*-
+
+require 'test_helper'
+require 'stringio'
+require 'hexapdf/document'
+
+describe HexaPDF::Document::Metadata do
+  before do
+    @doc = HexaPDF::Document.new
+    @doc.trailer.info[:Title] = 'Title'
+    @metadata = @doc.metadata
+  end
+
+  it "parses the info dictionary on creation" do
+    assert_equal('Title', @metadata.title)
+    @doc.trailer.info[:Trapped] = :Unknown
+    assert_nil(HexaPDF::Document::Metadata.new(@doc).trapped)
+    @doc.trailer.info[:Trapped] = :True
+    assert_equal(true, HexaPDF::Document::Metadata.new(@doc).trapped)
+    @doc.trailer.info[:Trapped] = :False
+    assert_equal(false, HexaPDF::Document::Metadata.new(@doc).trapped)
+  end
+
+  describe "default_language" do
+    it "use the document's language as default" do
+      @doc.catalog[:Lang] = 'de'
+      assert_equal("de", HexaPDF::Document::Metadata.new(@doc).default_language)
+    end
+
+    it "falls back to English if the document doesn't have a default language set" do
+      assert_equal('en', @metadata.default_language)
+    end
+
+    it "allows changing the default language" do
+      @metadata.default_language('de')
+      assert_equal('de', @metadata.default_language)
+    end
+  end
+
+  it "enables writing the info dict by default" do
+    assert(@metadata.write_info_dict?)
+  end
+
+  it "allows setting whether the info dict is written" do
+    @metadata.write_info_dict(false)
+    refute(@metadata.write_info_dict?)
+  end
+
+  it "enables writing the metadata stream by default" do
+    assert(@metadata.write_metadata_stream?)
+  end
+
+  it "allows setting whether the metadata stream is written" do
+    @metadata.write_metadata_stream(false)
+    refute(@metadata.write_metadata_stream?)
+  end
+
+  it "resolves namespace URI via a prefix" do
+    assert_equal('http://www.w3.org/1999/02/22-rdf-syntax-ns#', @metadata.namespace('rdf'))
+  end
+
+  it "allows registering prefixes for namespaces" do
+    err = assert_raises(HexaPDF::Error) { @metadata.namespace('hexa') }
+    assert_match(/prefix.*hexa.*not registered/, err.message)
+    @metadata.register_namespace('hexa', 'hexa:')
+    assert_equal('hexa:', @metadata.namespace('hexa'))
+  end
+
+  it "allows registering property types" do
+    @metadata.register_property_type('dc', 'title', 'Boolean')
+    assert_equal('Boolean', @metadata.instance_variable_get(:@properties)[@metadata.namespace('dc')]['title'])
+  end
+
+  it "allows reading and setting properties" do
+    assert_equal('Title', @metadata.property('dc', 'title'))
+    @metadata.property('dc', 'title', 'another')
+    assert_equal('another', @metadata.property('dc', 'title'))
+    @metadata.property('dc', 'title', nil)
+    assert_nil(@metadata.property('dc', 'title'))
+    refute(@metadata.instance_variable_get(:@metadata)[@metadata.namespace('dc')].key?('title'))
+  end
+
+  it "allows reading and setting all info dictionary properties" do
+    [['title', 'dc', 'title'], ['author', 'dc', 'creator'], ['subject', 'dc', 'description'],
+     ['keywords', 'pdf', 'Keywords'], ['creator', 'xmp', 'CreatorTool'],
+     ['producer', 'pdf', 'Producer'], ['creation_date', 'xmp', 'CreateDate'],
+     ['modification_date', 'xmp', 'ModifyDate'], ['trapped', 'pdf', 'Trapped']].each do |name, ns, property|
+      @metadata.property(ns, property, 'value')
+      assert_equal('value', @metadata.send(name), name)
+      @metadata.send(name, 'modified')
+      assert_equal('modified', @metadata.property(ns, property), name)
+    end
+  end
+
+  describe "metadata writing" do
+    before do
+      @time = Time.now.floor
+      @metadata.title('Title')
+      @metadata.author('Author')
+      @metadata.subject('Subject')
+      @metadata.keywords('Keywords')
+      @metadata.creator('Creator')
+      @metadata.producer('Producer')
+      @metadata.creation_date(@time)
+      @metadata.modification_date(@time)
+      @metadata.trapped(true)
+    end
+
+    it "writes the info dictionary properties" do
+      info = @doc.trailer.info
+      @doc.write(StringIO.new, update_fields: false)
+      assert_equal('Title', info[:Title])
+      assert_equal('Author', info[:Author])
+      assert_equal('Subject', info[:Subject])
+      assert_equal('Keywords', info[:Keywords])
+      assert_equal('Creator', info[:Creator])
+      assert_match(/HexaPDF/, info[:Producer])
+      assert_same(@time, info[:CreationDate])
+      assert_same(@time, info[:ModDate])
+      assert_equal(:True, info[:Trapped])
+    end
+
+    it "uses a correctly updated modification date if set so by Document#write" do
+      info = @doc.trailer.info
+      sleep(0.1)
+      @doc.write(StringIO.new)
+      assert_same(@time, info[:CreationDate])
+      refute_same(@time, info[:ModDate])
+      assert(@time < info[:ModDate])
+    end
+
+    it "correctly handles array values for title, author, and subject for info dictionary" do
+      @metadata.title(['Title', 'Another'])
+      @metadata.author(['Author', 'Author2'])
+      @metadata.subject(['Subject', 'Another'])
+      @doc.write(StringIO.new)
+      info = @doc.trailer.info
+      assert_equal('Title', info[:Title])
+      assert_equal('Author, Author2', info[:Author])
+      assert_equal('Subject', info[:Subject])
+    end
+
+    it "writes the XMP metadata" do
+      title = HexaPDF::Document::Metadata::LocalizedString.new('Der Titel')
+      title.language = 'de'
+      @metadata.title(['Title', title])
+      @metadata.author(['Author 1', 'Author 2'])
+      @metadata.register_property_type('dc', 'other', 'URI')
+      @metadata.property('dc', 'other', 'https://test.org/example')
+      @doc.write(StringIO.new, update_fields: false)
+      metadata = <<~XMP
+      <?xpacket begin="" id=""?>
+      <rdf:RDF xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#">
+      <rdf:Description rdf:about="" xmlns:dc="http://purl.org/dc/elements/1.1/">
+      <dc:title><rdf:Alt>
+      <rdf:li xml:lang="en">Title</rdf:li>
+      <rdf:li xml:lang="de">Der Titel</rdf:li>
+      </rdf:Alt></dc:title>
+      <dc:creator><rdf:Seq>
+      <rdf:li>Author 1</rdf:li>
+      <rdf:li>Author 2</rdf:li>
+      </rdf:Seq></dc:creator>
+      <dc:description><rdf:Alt>
+      <rdf:li xml:lang="en">Subject</rdf:li>
+      </rdf:Alt></dc:description>
+      <dc:other rdf:resource="https://test.org/example" />
+      </rdf:Description>
+      <rdf:Description rdf:about="" xmlns:pdf="http://ns.adobe.com/pdf/1.3/">
+      <pdf:Keywords>Keywords</pdf:Keywords>
+      <pdf:Producer>Producer</pdf:Producer>
+      <pdf:Trapped>True</pdf:Trapped>
+      </rdf:Description>
+      <rdf:Description rdf:about="" xmlns:xmp="http://ns.adobe.com/xap/1.0/">
+      <xmp:CreatorTool>Creator</xmp:CreatorTool>
+      <xmp:CreateDate>#{@metadata.send(:xmp_date, @time)}</xmp:CreateDate>
+      <xmp:ModifyDate>#{@metadata.send(:xmp_date, @time)}</xmp:ModifyDate>
+      </rdf:Description>
+      </rdf:RDF>
+      <?xpacket end="r"?>
+      XMP
+      assert_equal(metadata, @doc.catalog[:Metadata].stream.sub(/(?<=id=")\w+/, ''))
+    end
+
+    it "respects the write settings for info dictionary and metadata stream" do
+      @metadata.write_info_dict(false)
+      @metadata.write_metadata_stream(false)
+      @doc.write(StringIO.new)
+      assert_nil(@doc.trailer.info[:Author])
+      refute(@doc.catalog.key?(:Metadata))
+    end
+  end
+end

data/test/hexapdf/layout/test_box.rb

@@ -5,6 +5,12 @@ require 'hexapdf/document'
 require 'hexapdf/layout/box'
 
 describe HexaPDF::Layout::Box do
+  before do
+    @frame = Object.new
+    def @frame.x; 0; end
+    def @frame.y; 100; end
+  end
+
   def create_box(**args, &block)
     HexaPDF::Layout::Box.new(**args, &block)
   end
@@ -70,15 +76,13 @@ describe HexaPDF::Layout::Box do
   end
 
   describe "fit" do
-    before do
-      @frame = Object.new
-    end
-
     it "fits a fixed sized box" do
-      box = create_box(width: 50, height: 50)
+      box = create_box(width: 50, height: 50, style: {padding: 5})
       assert(box.fit(100, 100, @frame))
       assert_equal(50, box.width)
       assert_equal(50, box.height)
+      assert_equal(5, box.instance_variable_get(:@fit_x))
+      assert_equal(55, box.instance_variable_get(:@fit_y))
     end
 
     it "uses the maximum available width" do
@@ -106,49 +110,71 @@ describe HexaPDF::Layout::Box do
       box = create_box(width: 101)
       refute(box.fit(100, 100, @frame))
     end
+
+    it "can use the #content_width/#content_height helper methods" do
+      box = create_box
+      box.define_singleton_method(:fit_content) do |aw, ah, frame|
+        update_content_width { 10 }
+        update_content_height { 20 }
+        true
+      end
+      assert(box.fit(100, 100, @frame))
+      assert_equal(10, box.width)
+      assert_equal(20, box.height)
+
+      box = create_box(width: 30, height: 50)
+      box.define_singleton_method(:fit_content) do |aw, ah, frame|
+        update_content_width { 10 }
+        update_content_height { 20 }
+        true
+      end
+      assert(box.fit(100, 100, @frame))
+      assert_equal(30, box.width)
+      assert_equal(50, box.height)
+    end
   end
 
   describe "split" do
     before do
       @box = create_box(width: 100, height: 100)
-      @box.fit(100, 100, nil)
+      @box.fit(100, 100, @frame)
     end
 
     it "doesn't need to be split if it completely fits" do
-      assert_equal([@box, nil], @box.split(100, 100, nil))
+      assert_equal([@box, nil], @box.split(100, 100, @frame))
     end
 
     it "can't be split if it doesn't (completely) fit and its width is greater than the available width" do
       @box.fit(90, 100, nil)
-      assert_equal([nil, @box], @box.split(50, 150, nil))
+      assert_equal([nil, @box], @box.split(50, 150, @frame))
     end
 
     it "can't be split if it doesn't (completely) fit and its height is greater than the available height" do
       @box.fit(90, 100, nil)
-      assert_equal([nil, @box], @box.split(150, 50, nil))
+      assert_equal([nil, @box], @box.split(150, 50, @frame))
     end
 
     it "can't be split if it doesn't (completely) fit and its content width is zero" do
       box = create_box(width: 0, height: 100)
-      assert_equal([nil, box], box.split(150, 150, nil))
+      assert_equal([nil, box], box.split(150, 150, @frame))
     end
 
     it "can't be split if it doesn't (completely) fit and its content height is zero" do
       box = create_box(width: 100, height: 0)
-      assert_equal([nil, box], box.split(150, 150, nil))
+      assert_equal([nil, box], box.split(150, 150, @frame))
     end
 
     it "can't be split if it doesn't (completely) fit as the default implementation " \
       "knows nothing about the content" do
       @box.style.position = :flow # make sure we would generally be splitable
       @box.fit(90, 100, nil)
-      assert_equal([nil, @box], @box.split(150, 150, nil))
+      assert_equal([nil, @box], @box.split(150, 150, @frame))
     end
   end
 
   it "can create a cloned box for splitting" do
     box = create_box
-    box.fit(100, 100, nil)
+    box.fit(100, 100, @frame)
     cloned_box = box.send(:create_split_box)
     assert(cloned_box.split_box?)
     refute(cloned_box.instance_variable_get(:@fit_successful))

data/test/hexapdf/layout/test_container_box.rb

@@ -0,0 +1,84 @@
+# -*- encoding: utf-8 -*-
+
+require 'test_helper'
+require 'hexapdf/document'
+require 'hexapdf/layout/container_box'
+
+describe HexaPDF::Layout::ContainerBox do
+  before do
+    @doc = HexaPDF::Document.new
+    @frame = HexaPDF::Layout::Frame.new(0, 0, 100, 100)
+  end
+
+  def create_box(children, **kwargs)
+    HexaPDF::Layout::ContainerBox.new(children: Array(children), **kwargs)
+  end
+
+  def check_box(box, width, height, fit_pos = nil)
+    assert(box.fit(@frame.available_width, @frame.available_height, @frame), "box didn't fit")
+    assert_equal(width, box.width, "box width")
+    assert_equal(height, box.height, "box height")
+    if fit_pos
+      box_fitter = box.instance_variable_get(:@box_fitter)
+      assert_equal(fit_pos.size, box_fitter.fit_results.size)
+      fit_pos.each_with_index do |(x, y), index|
+        assert_equal(x, box_fitter.fit_results[index].x, "result[#{index}].x")
+        assert_equal(y, box_fitter.fit_results[index].y, "result[#{index}].y")
+      end
+    end
+  end
+
+  describe "empty?" do
+    it "is empty if nothing is fit yet" do
+      assert(create_box([]).empty?)
+    end
+
+    it "is empty if no box fits" do
+      box = create_box(@doc.layout.box(width: 110))
+      box.fit(@frame.available_width, @frame.available_height, @frame)
+      assert(box.empty?)
+    end
+
+    it "is not empty if at least one box fits" do
+      box = create_box(@doc.layout.box(width: 50, height: 20))
+      check_box(box, 100, 20)
+      refute(box.empty?)
+    end
+  end
+
+  describe "fit_content" do
+    it "fits the children according to their mask_mode, valign, and align style properties" do
+      box = create_box([@doc.layout.box(height: 20),
+                        @doc.layout.box(height: 20, style: {valign: :bottom, mask_mode: :fill_horizontal}),
+                        @doc.layout.box(width: 20, style: {align: :right, mask_mode: :fill_vertical})])
+      check_box(box, 100, 100, [[0, 80], [0, 0], [80, 20]])
+    end
+
+    it "respects the initially set width/height as well as border/padding" do
+      box = create_box(@doc.layout.box(height: 20), height: 50, width: 40,
+                       style: {padding: 2, border: {width: 3}})
+      check_box(box, 40, 50, [[5, 75]])
+    end
+  end
+
+  describe "draw_content" do
+    before do
+      @canvas = @doc.pages.add.canvas
+    end
+
+    it "draws the result onto the canvas" do
+      child_box = @doc.layout.box(height: 20) do |canvas, b|
+        canvas.line(0, 0, b.content_width, b.content_height).end_path
+      end
+      box = create_box(child_box)
+      box.fit(100, 100, @frame)
+      box.draw(@canvas, 0, 50)
+      assert_operators(@canvas.contents, [[:save_graphics_state],
+                                          [:concatenate_matrix, [1, 0, 0, 1, 0, 50]],
+                                          [:move_to, [0, 0]],
+                                          [:line_to, [100, 20]],
+                                          [:end_path],
+                                          [:restore_graphics_state]])
+    end
+  end
+end

data/test/hexapdf/layout/test_frame.rb

@@ -13,10 +13,11 @@ describe HexaPDF::Layout::Frame::FitResult do
     result = HexaPDF::Layout::Frame::FitResult.new(box)
     result.mask = Geom2D::Rectangle(0, 0, 20, 20)
     result.x = result.y = 0
-    result.draw(canvas)
+    result.draw(canvas, dx: 10, dy: 15)
     assert_equal(<<~CONTENTS, canvas.contents)
       /OC /P1 BDC
       q
+      1 0 0 1 10 15 cm
       0.0 0.501961 0.0 rg
       0.0 0.392157 0.0 RG
       /GS1 gs
@@ -25,7 +26,7 @@ describe HexaPDF::Layout::Frame::FitResult do
       Q
       EMC
       q
-      1 0 0 1 0 0 cm
+      1 0 0 1 10 15 cm
       Q
     CONTENTS
     ocg = doc.optional_content.ocgs.first

data/test/hexapdf/test_filter.rb

@@ -18,6 +18,12 @@ describe HexaPDF::Filter do
       assert_equal(@str, collector(fib))
       assert_equal('', collector(fib))
     end
+
+    it "returns the correct length of the fiber" do
+      str = "\u{FEFF}Öl"
+      fib = @obj.source_from_proc { str }
+      assert_equal(6, fib.length)
+    end
   end
 
   describe "source_from_string" do
@@ -30,6 +36,12 @@ describe HexaPDF::Filter do
     it "returns the whole string" do
       assert_equal(@str, collector(@obj.source_from_string(@str)))
     end
+
+    it "returns the correct size of the fiber" do
+      str = "\u{FEFF}Öl"
+      fib = @obj.source_from_string(str)
+      assert_equal(6, fib.length)
+    end
   end
 
   describe "source_from_io" do

data/test/hexapdf/test_writer.rb

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

data/test/hexapdf/type/test_font_simple.rb

@@ -116,9 +116,17 @@ describe HexaPDF::Type::FontSimple do
       assert_equal(" ", @font.to_utf8(32))
     end
 
+    it "swallows errors during retrieving the font's encoding" do
+      @font.delete(:ToUnicode)
+      @font.delete(:Encoding)
+      err = assert_raises(HexaPDF::Error) { @font.to_utf8(32) }
+      assert_match(/No Unicode mapping/, err.message)
+    end
+
     it "calls the configured proc if no correct mapping could be found" do
       @font.delete(:ToUnicode)
-      assert_raises(HexaPDF::Error) { @font.to_utf8(0) }
+      err = assert_raises(HexaPDF::Error) { @font.to_utf8(0) }
+      assert_match(/No Unicode mapping/, err.message)
     end
   end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hexapdf
 version: !ruby/object:Gem::Version
-  version: 0.35.1
+  version: 0.37.0
 platform: ruby
 authors:
 - Thomas Leitner
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-01-10 00:00:00.000000000 Z
+date: 2024-01-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: cmdparse
@@ -358,6 +358,7 @@ files:
 - lib/hexapdf/document/fonts.rb
 - lib/hexapdf/document/images.rb
 - lib/hexapdf/document/layout.rb
+- lib/hexapdf/document/metadata.rb
 - lib/hexapdf/document/pages.rb
 - lib/hexapdf/encryption.rb
 - lib/hexapdf/encryption/aes.rb
@@ -434,6 +435,7 @@ files:
 - lib/hexapdf/layout/box.rb
 - lib/hexapdf/layout/box_fitter.rb
 - lib/hexapdf/layout/column_box.rb
+- lib/hexapdf/layout/container_box.rb
 - lib/hexapdf/layout/frame.rb
 - lib/hexapdf/layout/image_box.rb
 - lib/hexapdf/layout/inline_box.rb
@@ -504,6 +506,7 @@ files:
 - lib/hexapdf/type/image.rb
 - lib/hexapdf/type/info.rb
 - lib/hexapdf/type/mark_information.rb
+- lib/hexapdf/type/metadata.rb
 - lib/hexapdf/type/names.rb
 - lib/hexapdf/type/object_stream.rb
 - lib/hexapdf/type/optional_content_configuration.rb
@@ -630,6 +633,7 @@ files:
 - test/hexapdf/document/test_fonts.rb
 - test/hexapdf/document/test_images.rb
 - test/hexapdf/document/test_layout.rb
+- test/hexapdf/document/test_metadata.rb
 - test/hexapdf/document/test_pages.rb
 - test/hexapdf/encryption/common.rb
 - test/hexapdf/encryption/test_aes.rb
@@ -695,6 +699,7 @@ files:
 - test/hexapdf/layout/test_box.rb
 - test/hexapdf/layout/test_box_fitter.rb
 - test/hexapdf/layout/test_column_box.rb
+- test/hexapdf/layout/test_container_box.rb
 - test/hexapdf/layout/test_frame.rb
 - test/hexapdf/layout/test_image_box.rb
 - test/hexapdf/layout/test_inline_box.rb
@@ -794,7 +799,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.6'
+      version: '2.7'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="