hexapdf 0.34.1 → 0.35.0

data/test/hexapdf/layout/test_text_layouter.rb

@@ -651,7 +651,7 @@ describe HexaPDF::Layout::TextLayouter do
       end
 
       it "aligns the contents to the left" do
-        @style.align = :left
+        @style.text_align = :left
         result = @layouter.fit(@items, 100, 100)
         assert_equal(0, result.lines[0].x_offset)
         assert_equal(80, result.lines[0].width)
@@ -661,7 +661,7 @@ describe HexaPDF::Layout::TextLayouter do
       end
 
       it "aligns the contents to the center" do
-        @style.align = :center
+        @style.text_align = :center
         result = @layouter.fit(@items, 100, 100)
         assert_equal(10, result.lines[0].x_offset)
         result = @layouter.fit(@items, proc { 100 }, 100)
@@ -669,7 +669,7 @@ describe HexaPDF::Layout::TextLayouter do
       end
 
       it "aligns the contents to the right" do
-        @style.align = :right
+        @style.text_align = :right
         result = @layouter.fit(@items, 100, 100)
         assert_equal(20, result.lines[0].x_offset)
         result = @layouter.fit(@items, proc { 100 }, 100)
@@ -683,28 +683,28 @@ describe HexaPDF::Layout::TextLayouter do
       end
 
       it "aligns the contents to the top" do
-        @style.valign = :top
+        @style.text_valign = :top
         result = @layouter.fit(@items, 40, 100)
         assert_equal(result.lines[0].y_max, result.lines[0].y_offset)
         assert_equal(40, result.height)
       end
 
       it "aligns the contents to the center" do
-        @style.valign = :center
+        @style.text_valign = :center
         result = @layouter.fit(@items, 40, 100)
         assert_equal((100 - 40) / 2 + 20, result.lines[0].y_offset)
         assert_equal(70, result.height)
       end
 
       it "aligns the contents to the bottom" do
-        @style.valign = :bottom
+        @style.text_valign = :bottom
         result = @layouter.fit(@items, 40, 100)
         assert_equal(100 - 20 * 2 + 20, result.lines[0].y_offset)
         assert_equal(100, result.height)
       end
 
       it "doesn't vertically align when layouting in variable-width mode" do
-        @style.valign = :bottom
+        @style.text_valign = :bottom
         result = @layouter.fit(@items, proc { 40 }, 100)
         assert_equal(result.lines[0].y_max, result.lines[0].y_offset)
         assert_equal(40, result.height)
@@ -723,7 +723,7 @@ describe HexaPDF::Layout::TextLayouter do
       # Missing width: 100 - 90 = 10
       # -> Each space must be doubled!
 
-      @style.align = :justify
+      @style.text_align = :justify
       result = @layouter.fit(items, 100, 100)
       assert(result.remaining_items.empty?)
       assert_equal(:success, result.status)
@@ -770,8 +770,8 @@ describe HexaPDF::Layout::TextLayouter do
 
     it "respects the x- and y-offsets" do
       top = 100
-      @layouter.style.valign = :center
-      @layouter.style.align = :center
+      @layouter.style.text_valign = :center
+      @layouter.style.text_align = :center
 
       result = @layouter.fit([@frag], @width, top)
       result.draw(@canvas, 5, top)

data/test/hexapdf/test_configuration.rb

@@ -2,6 +2,7 @@
 
 require 'test_helper'
 require 'hexapdf/configuration'
+require 'hexapdf/document'
 
 describe HexaPDF::Configuration do
   before do
@@ -91,3 +92,51 @@ describe HexaPDF::Configuration do
     end
   end
 end
+
+describe "HexaPDF.font_on_invalid_glyph" do
+  before do
+    @doc = HexaPDF::Document.new
+    @font = @doc.fonts.add('Helvetica')
+  end
+
+  def assert_glyph(font, codepoint, font_name, glyph_name)
+    invalid_glyph = HexaPDF::Font::InvalidGlyph.new(font, codepoint.chr("UTF-8"))
+    glyph = HexaPDF.font_on_invalid_glyph(codepoint, invalid_glyph)
+
+    assert_equal(1, glyph.size)
+    glyph = glyph.first
+    assert(glyph.valid?)
+    assert_equal(font_name, glyph.font_wrapper.wrapped_font.font_name)
+    assert_equal(glyph_name, glyph.name)
+    glyph
+  end
+
+  it "tries each fallback font and uses the first valid glyph" do
+    assert_glyph(@font, 10102, "ZapfDingbats", :a130)
+    assert_glyph(@font, 8855, "Symbol", :circlemultiply)
+  end
+
+  it "takes the font variant into account" do
+    @doc.config['font.fallback'] = ['Times']
+
+    glyph = assert_glyph(@doc.fonts.add("Helvetica", variant: :bold), 65, "Times-Bold", :A)
+    assert(glyph.font_wrapper.bold?)
+
+    glyph = assert_glyph(@doc.fonts.add("Helvetica", variant: :italic), 65, "Times-Italic", :A)
+    assert(glyph.font_wrapper.italic?)
+
+    glyph = assert_glyph(@doc.fonts.add("Helvetica", variant: :bold_italic), 65, "Times-BoldItalic", :A)
+    assert(glyph.font_wrapper.bold?)
+    assert(glyph.font_wrapper.italic?)
+  end
+
+  it "falls back to the :none variant of a fallback font if a more specific one doesn't exist" do
+    assert_glyph(@doc.fonts.add("Helvetica", variant: :bold), 9985, "ZapfDingbats", :a1)
+  end
+
+  it "returns the given invalid glyph if no fallback glyph could be found" do
+    @doc.config['font.fallback'] = []
+    invalid_glyph = HexaPDF::Font::InvalidGlyph.new(@font, "A")
+    assert_equal([invalid_glyph], HexaPDF.font_on_invalid_glyph(65, invalid_glyph))
+  end
+end

data/test/hexapdf/test_dictionary.rb

@@ -204,7 +204,7 @@ describe HexaPDF::Dictionary do
     end
   end
 
-  describe "validate_fields" do
+  describe "perform_validation" do
     before do
       @test_class.define_field(:Inherited, type: [Array, Symbol], required: true, indirect: false)
       @test_class.define_field(:AllowedValues, type: Integer, allowed_values: [1, 5])

data/test/hexapdf/test_object.rb

@@ -186,6 +186,19 @@ describe HexaPDF::Object do
       refute(@obj.validate(auto_correct: false))
       assert_equal([:before], invoked)
     end
+
+    it "re-raises caught HexaPDF::Error exceptions" do
+      @obj.define_singleton_method(:perform_validation) { raise HexaPDF::Error, "Unknown" }
+      invoked = []
+      assert_raises(HexaPDF::Error) { @obj.validate {|*a| invoked << a } }
+    end
+
+    it "catches errors raised in perform_validation and produces an appropriate message" 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)
+    end
   end
 
   it "can represent itself during inspection" do
@@ -286,17 +299,5 @@ describe HexaPDF::Object do
       obj.validate
       assert_equal(1, obj.oid)
     end
-
-    it "validates collection values" do
-      x = HexaPDF::Object.new(:x, document: @doc)
-      x.must_be_indirect = true
-      y = HexaPDF::Object.new(:y, document: @doc)
-      y.must_be_indirect = true
-
-      obj = HexaPDF::Object.new([1, 2, 3, [4, x], {X: [y, 5]}])
-      obj.validate
-      assert_equal(1, x.oid)
-      assert_equal(1, y.oid)
-    end
   end
 end

data/test/hexapdf/test_pdf_array.rb

@@ -166,4 +166,13 @@ describe HexaPDF::PDFArray do
   it "can be converted to a simple array" do
     assert_equal([1, :data, "deref", @array[3]], @array.to_ary)
   end
+
+  describe "perform_validation" do
+    it "validates nested objects" do
+      @array.value << HexaPDF::PDFArray.new([HexaPDF::Reference.new(1, 0)], document: self)
+      assert(@array.validate)
+      assert_kind_of(HexaPDF::Object, @array.value[2])
+      assert_kind_of(HexaPDF::Object, @array.value.last.value[0])
+    end
+  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.34.1)>>
+      <</Producer(HexaPDF version 0.35.0)>>
       endobj
       xref
       3 1
@@ -72,7 +72,7 @@ describe HexaPDF::Writer do
       141
       %%EOF
       6 0 obj
-      <</Producer(HexaPDF version 0.34.1)>>
+      <</Producer(HexaPDF version 0.35.0)>>
       endobj
       2 0 obj
       <</Length 10>>stream
@@ -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.34.1)>>
+      <</Producer(HexaPDF version 0.35.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/acro_form/test_appearance_generator.rb

@@ -453,7 +453,7 @@ describe HexaPDF::Type::AcroForm::AppearanceGenerator do
       before do
         @widget[:Rect].height = 20
         @widget[:Rect].width = 100
-        @field.field_value = ''
+        @field[:V] = ''
       end
 
       it "uses the non-zero font size" do
@@ -477,7 +477,7 @@ describe HexaPDF::Type::AcroForm::AppearanceGenerator do
       end
 
       it "shrinks the font size if necessary to fit the rectangle width" do
-        @field.field_value = "This is some arbitrary, long text"
+        @field[:V] = "This is some arbitrary, long text"
         @generator.create_appearances
         assert_operators(@widget[:AP][:N].stream,
                          [:set_font_and_size, [:F1, 6.909955]],
@@ -498,7 +498,7 @@ describe HexaPDF::Type::AcroForm::AppearanceGenerator do
     describe "single line text fields" do
       describe "quadding e.g. text alignment" do
         before do
-          @field.field_value = 'Test'
+          @field[:V] = 'Test'
           @field.set_default_appearance_string(font_size: 10)
           @widget[:Rect].height = 20
         end
@@ -551,7 +551,7 @@ describe HexaPDF::Type::AcroForm::AppearanceGenerator do
 
       describe "Javascript action AFNumber_Format" do
         before do
-          @field.field_value = '1234567.898765'
+          @field[:V] = '1234567.898765'
           @action = {S: :JavaScript, JS: ''}
           @field[:AA] = {F: @action}
         end
@@ -576,7 +576,8 @@ describe HexaPDF::Type::AcroForm::AppearanceGenerator do
         end
 
         it "respects the negative value styling" do
-          @field.field_value = '-1234567.898'
+          @field[:V] = '-1234567.898'
+          @widget[:Rect].height = 11.25
           ["-E1234567,90", "E1234567,90", "(E1234567,90)", "(E1234567,90)"].each_with_index do |result, style|
             assert_format("2, 3, #{style}, 0, \"E\", true",
                           [[:set_device_rgb_non_stroking_color, [style % 2, 0.0, 0.0]],
@@ -597,8 +598,11 @@ describe HexaPDF::Type::AcroForm::AppearanceGenerator do
       end
 
       it "creates the /N appearance stream according to the set string" do
-        @field.field_value = 'Text'
+        @doc.config['font.on_invalid_glyph'] = lambda do |codepoint, _|
+          [@doc.fonts.add('ZapfDingbats').decode_codepoint(codepoint)]
+        end
         @field.set_default_appearance_string(font_color: "red")
+        @field[:V] = 'Te ✂ xt'
         @generator.create_appearances
         assert_operators(@widget[:AP][:N].stream,
                          [[:begin_marked_content, [:Tx]],
@@ -606,11 +610,17 @@ describe HexaPDF::Type::AcroForm::AppearanceGenerator do
                           [:append_rectangle, [1, 1, 98, 9.25]],
                           [:clip_path_non_zero],
                           [:end_path],
-                          [:set_font_and_size, [:F1, 6.801471]],
+                          [:set_font_and_size, [:F1, 10]],
                           [:set_device_rgb_non_stroking_color, [1.0, 0.0, 0.0]],
                           [:begin_text],
-                          [:set_text_matrix, [1, 0, 0, 1, 2, 3.183272]],
-                          [:show_text, ["Text"]],
+                          [:set_text_matrix, [1, 0, 0, 1, 2, 2.035]],
+                          [:show_text, ["Te "]],
+                          [:set_font_and_size, [:F2, 10]],
+                          [:move_text, [14.45, 0]],
+                          [:show_text, ["\""]],
+                          [:set_font_and_size, [:F1, 10]],
+                          [:move_text, [9.61, 0]],
+                          [:show_text, [" xt"]],
                           [:end_text],
                           [:restore_graphics_state],
                           [:end_marked_content]])
@@ -656,7 +666,7 @@ describe HexaPDF::Type::AcroForm::AppearanceGenerator do
       end
 
       it "creates the /N appearance stream according to the set string" do
-        @field.field_value = "Test\nValue"
+        @field[:V] = "Test\nValue"
         @field.set_default_appearance_string(font_size: 10, font_color: "red")
         @generator.create_appearances
         assert_operators(@widget[:AP][:N].stream,
@@ -679,7 +689,7 @@ describe HexaPDF::Type::AcroForm::AppearanceGenerator do
                           [:restore_graphics_state],
                           [:end_marked_content]])
 
-        @field.field_value = "Test\nTest\nTest"
+        @field[:V] = "Test\nTest\nTest"
         @field.set_default_appearance_string(font_size: 0)
         @generator.create_appearances
         assert_operators(@widget[:AP][:N].stream,
@@ -744,7 +754,7 @@ describe HexaPDF::Type::AcroForm::AppearanceGenerator do
         end
 
         it "handles centering like Adobe, e.g. shift left, when text cannot be completely centered" do
-          @field.field_value = 'Hello'
+          @field[:V] = 'Hello'
           @field.text_alignment(:center)
           @generator.create_appearances
           assert_operators(@widget[:AP][:N].stream,
@@ -754,7 +764,7 @@ describe HexaPDF::Type::AcroForm::AppearanceGenerator do
       end
 
       it "creates the /N appearance stream according to the set string" do
-        @field.field_value = 'Text'
+        @field[:V] = 'Text'
         @field.set_default_appearance_string(font_size: 10, font_color: "red")
         @generator.create_appearances
         assert_operators(@widget[:AP][:N].stream,
@@ -773,11 +783,29 @@ describe HexaPDF::Type::AcroForm::AppearanceGenerator do
                           [:end_marked_content]])
       end
 
+      it "works for empty strings" do
+        @field[:V] = ''
+        @generator.create_appearances
+        assert_operators(@widget[:AP][:N].stream,
+                         [[:begin_text],
+                          [:set_text_matrix, [1, 0, 0, 1, 2, 6.41]],
+                          [:end_text]], range: 6..8)
+      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
+
+      it "fails if fallback glyphs are needed for rendering" do
+        @doc.config['font.on_invalid_glyph'] = lambda do |codepoint, _|
+          [@doc.fonts.add('ZapfDingbats').decode_codepoint(codepoint)]
+        end
+        @field[:V] = 'Test ✂'
+        ex = assert_raises(HexaPDF::Error) { @generator.create_appearances }
+        assert_match(/Fallback glyphs/, ex.message)
+      end
     end
 
     describe "choice fields" do

data/test/hexapdf/utils/test_sorted_tree_node.rb

@@ -209,7 +209,7 @@ describe HexaPDF::Utils::SortedTreeNode do
       @root[:Kids][0] = ref
       @kid1.oid = 0
       assert(@root.validate do |message, c|
-               assert_match(/must be indirect objects/, message)
+               assert_match(/must be an indirect object/, message)
                assert(c)
              end)
       assert(@kid1.indirect?)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hexapdf
 version: !ruby/object:Gem::Version
-  version: 0.34.1
+  version: 0.35.0
 platform: ruby
 authors:
 - Thomas Leitner
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-11-01 00:00:00.000000000 Z
+date: 2024-01-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: cmdparse
@@ -301,6 +301,8 @@ files:
 - examples/025-table_box.rb
 - examples/026-optional_content.rb
 - examples/027-composer_optional_content.rb
+- examples/028-frame_mask_mode.rb
+- examples/029-composer_fallback_fonts.rb
 - examples/emoji-smile.png
 - examples/emoji-wink.png
 - examples/machupicchu.jpg
@@ -324,6 +326,7 @@ files:
 - lib/hexapdf/configuration.rb
 - lib/hexapdf/content.rb
 - lib/hexapdf/content/canvas.rb
+- lib/hexapdf/content/canvas_composer.rb
 - lib/hexapdf/content/color_space.rb
 - lib/hexapdf/content/graphic_object.rb
 - lib/hexapdf/content/graphic_object/arc.rb
@@ -603,6 +606,7 @@ files:
 - test/hexapdf/content/graphic_object/test_geom2d.rb
 - test/hexapdf/content/graphic_object/test_solid_arc.rb
 - test/hexapdf/content/test_canvas.rb
+- test/hexapdf/content/test_canvas_composer.rb
 - test/hexapdf/content/test_color_space.rb
 - test/hexapdf/content/test_graphics_state.rb
 - test/hexapdf/content/test_operator.rb
@@ -795,7 +799,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.10
+rubygems_version: 3.5.3
 signing_key:
 specification_version: 4
 summary: HexaPDF - A Versatile PDF Creation and Manipulation Library For Ruby