hexapdf 0.39.1 → 0.40.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 07f7fd9468ec9c36993f4b1f2189704d65c1c73f7fa1ea30d44f6cb0a67fa92c
-  data.tar.gz: 1cad88a48910fd65a9dae7a90dcfe6ac34ef5ba9f69172a18bd52052fb10b99c
+  metadata.gz: 2dab266d2115bdd9a7c9caf6a7512b56da77c14b8fe080d631d270c89a67e49f
+  data.tar.gz: c05acdf542d3b65e2c763f9aa84e21de4ad4f6800a48a4b4ca6873832089a0e2
 SHA512:
-  metadata.gz: eeee46c22616abbca812ef441100e33534384db831aadf04df9b9382920aa58105be04046a76a9da76951c1d0bc39126e4ef33c43fa3401077c34604ff414acc
-  data.tar.gz: 1cd42546ff96980f6fbfeaae450a7f8657350ce3b23692b508b87718028e68fe50acd9ca8b744bc755f9b79029ecd41f5cb1cedc046209336594c3fba5a1807b
+  metadata.gz: 0e63528c1c604b06a8f07a53852ebfc2f5172a9aee43320942e4088f8aaf68953acc6f9e6017c4215591a8bb7a428b61fa20bd6e4ea180af39c62058de5b04db
+  data.tar.gz: 8b648570a98fcd5f1688c97ead5c05a0da6918cba49b3905bd70f526a65ddf376618e5d533c6bb04823117fc892839a600d0ba63d006699205e1ef399e0b64f5

data/CHANGELOG.md

@@ -1,3 +1,17 @@
+## 0.40.0 - 2024-03-23
+
+### Changed
+
+* **Breaking change**: Style property 'text_overflow' is now called 'overflow'
+
+### Fixed
+
+* [HexaPDF::Layout::ListBox] to hide marker in case of splitting list items with
+  multiple boxes
+* [HexaPDF::Layout::ListBox] to create independent marker boxes for all markers
+* [HexaPDF::Layout::ListBox] to correctly respect a set height
+
+
 ## 0.39.1 - 2024-03-20
 
 ### Fixed

data/lib/hexapdf/layout/list_box.rb

@@ -255,7 +255,9 @@ module HexaPDF
 
         @draw_pos_x = frame.x + reserved_width_left
         @draw_pos_y = frame.y - @height + reserved_height_bottom
-        @fit_successful = @results.all? {|r| r.box_fitter.fit_successful? } && @results.size == @children.size
+        @all_items_fitted = @results.all? {|r| r.box_fitter.fit_successful? } &&
+          @results.size == @children.size
+        @fit_successful = @all_items_fitted || (@initial_height > 0 && style.overflow == :truncate)
       end
 
       private
@@ -307,7 +309,7 @@ module HexaPDF
       # Splits the content of the list box. This method is called from Box#split.
       def split_content(_available_width, _available_height, _frame)
         remaining_boxes = @results[-1].box_fitter.remaining_boxes
-        first_is_split_box = remaining_boxes.first&.split_box?
+        first_is_split_box = !remaining_boxes.empty?
         children = (remaining_boxes.empty? ? [] : [remaining_boxes]) + @children[@results.size..-1]
 
         box = create_split_box(split_box_value: first_is_split_box ? :hide_first_marker : :show_first_marker)
@@ -323,42 +325,47 @@ module HexaPDF
       # its contents.
       def item_marker_box(document, index)
         return @marker_type.call(document, self, index) if @marker_type.kind_of?(Proc)
-        return @item_marker_box if defined?(@item_marker_box)
-
-        marker_style = {
-          font: style.font? ? style.font : document.fonts.add("Times"),
-          font_size: style.font_size || 10, fill_color: style.fill_color
-        }
-        fragment = case @marker_type
-                   when :disc
-                     TextFragment.create("•", marker_style)
-                   when :circle
-                     unless marker_style[:font].decode_codepoint("❍".ord).valid?
-                       marker_style[:font] = document.fonts.add("ZapfDingbats")
-                     end
-                     TextFragment.create("❍", **marker_style,
-                                         font_size: style.font_size / 2.0,
-                                         text_rise: -style.font_size / 1.8)
-                   when :square
-                     unless marker_style[:font].decode_codepoint("■".ord).valid?
-                       marker_style[:font] = document.fonts.add("ZapfDingbats")
+
+        unless (fragment = @item_marker_fragment)
+          marker_style = {
+            font: style.font? ? style.font : document.fonts.add("Times"),
+            font_size: style.font_size || 10, fill_color: style.fill_color
+          }
+          fragment = case @marker_type
+                     when :disc
+                       TextFragment.create("•", marker_style)
+                     when :circle
+                       unless marker_style[:font].decode_codepoint("❍".ord).valid?
+                         marker_style[:font] = document.fonts.add("ZapfDingbats")
+                       end
+                       TextFragment.create("❍", **marker_style,
+                                           font_size: style.font_size / 2.0,
+                                           text_rise: -style.font_size / 1.8)
+                     when :square
+                       unless marker_style[:font].decode_codepoint("■".ord).valid?
+                         marker_style[:font] = document.fonts.add("ZapfDingbats")
+                       end
+                       TextFragment.create("■", **marker_style,
+                                           font_size: style.font_size / 2.0,
+                                           text_rise: -style.font_size / 1.8)
+                     when :decimal
+                       text = (@start_number + index).to_s << "."
+                       TextFragment.create(text, marker_style)
+                     else
+                       raise HexaPDF::Error, "Unknown list marker type #{@marker_type.inspect}"
                      end
-                     TextFragment.create("■", **marker_style,
-                                         font_size: style.font_size / 2.0,
-                                         text_rise: -style.font_size / 1.8)
-                   when :decimal
-                     text = (@start_number + index).to_s << "."
-                     TextFragment.create(text, marker_style)
-                   else
-                     raise HexaPDF::Error, "Unknown list marker type #{@marker_type.inspect}"
-                   end
-        box = TextBox.new(items: [fragment], style: {text_align: :right, padding: [0, 5, 0, 0]})
-        @item_marker_box = box unless @marker_type == :decimal
-        box
+          @item_marker_fragment = fragment unless @marker_type == :decimal
+        end
+        TextBox.new(items: [fragment], style: {text_align: :right, padding: [0, 5, 0, 0]})
       end
 
       # Draws the list items onto the canvas at position [x, y].
       def draw_content(canvas, x, y)
+        if !@all_items_fitted && (@initial_height > 0 && style.overflow == :error)
+          raise HexaPDF::Error, "Some items don't fit into box with limited height and " \
+            "style property overflow is set to :error"
+        end
+
         translate = style.position != :flow && (x != @draw_pos_x || y != @draw_pos_y)
 
         if translate

data/lib/hexapdf/layout/style.rb

@@ -1084,25 +1084,6 @@ module HexaPDF
       #                            'Centered',
       #                            {text: "\u{00a0}", fill_horizontal: 1, overlays: overlays}])
 
-      ##
-      # :method: text_overflow
-      # :call-seq:
-      #   text_overflow(mode = nil)
-      #
-      # Specifies how text overflowing a box with a given initial height should be handled:
-      #
-      # Possible values:
-      #
-      # :error::    An error is raised (default).
-      # :truncate:: Truncates the overflowing text.
-      #
-      # Examples:
-      #
-      #   #>pdf-composer100
-      #   composer.text("This is some longer text that does appear in two lines.")
-      #   composer.text("This is some longer text that does not appear in two lines.",
-      #                 height: 15, text_overflow: :truncate)
-
       ##
       # :method: background_color
       # :call-seq:
@@ -1414,6 +1395,26 @@ module HexaPDF
       #       composer.text('Mask covers everything', mask_mode: :fill)
       #       composer.text('On the next page')
 
+      ##
+      # :method: overflow
+      # :call-seq:
+      #   overflow(mode = nil)
+      #
+      # Specifies how overflowing boxes (e.g. the text of a box or the children of a container) with
+      # a given initial height should be handled:
+      #
+      # Possible values:
+      #
+      # :error::    An error is raised (default).
+      # :truncate:: Truncates the overflowing parts.
+      #
+      # Examples:
+      #
+      #   #>pdf-composer100
+      #   composer.text("This is some longer text that does appear in two lines.")
+      #   composer.text("This is some longer text that does not appear in two lines.",
+      #                 height: 15, text_overflow: :truncate)
+
       [
         [:font, "raise HexaPDF::Error, 'No font set'"],
         [:font_size, 10],
@@ -1454,7 +1455,6 @@ module HexaPDF
           extra_args: ", extra_arg = nil"}],
         [:last_line_gap, false, {valid_values: [true, false]}],
         [:fill_horizontal, nil],
-        [:text_overflow, :error],
         [:background_color, nil],
         [:background_alpha, 1],
         [:padding, "Quad.new(0)", {setter: "Quad.new(value)"}],
@@ -1467,6 +1467,7 @@ module HexaPDF
         [:valign, :top, {valid_values: [:top, :center, :bottom]}],
         [:mask_mode, :default, {valid_values: [:default, :none, :box, :fill_horizontal,
                                                :fill_frame_horizontal, :fill_vertical, :fill]}],
+        [:overflow, :error],
       ].each do |name, default, options = {}|
         default = default.inspect unless default.kind_of?(String)
         setter = options.delete(:setter) || "value"

data/lib/hexapdf/layout/text_box.rb

@@ -106,7 +106,7 @@ module HexaPDF
         end
 
         @result.status == :success ||
-          (@result.status == :height && @initial_height > 0 && style.text_overflow == :truncate)
+          (@result.status == :height && @initial_height > 0 && style.overflow == :truncate)
       end
 
       # Splits the text box into two boxes if necessary and possible.
@@ -136,9 +136,9 @@ module HexaPDF
       def draw_content(canvas, x, y)
         return unless @result
 
-        if @result.status == :height && @initial_height > 0 && style.text_overflow == :error
+        if @result.status == :height && @initial_height > 0 && style.overflow == :error
           raise HexaPDF::Error, "Text doesn't fit into box with limited height and " \
-            "style property text_overflow is set to :error"
+            "style property overflow is set to :error"
         end
 
         return if @result.lines.empty?

data/lib/hexapdf/version.rb

@@ -37,6 +37,6 @@
 module HexaPDF
 
   # The version of HexaPDF.
-  VERSION = '0.39.1'
+  VERSION = '0.40.0'
 
 end

data/test/hexapdf/layout/test_list_box.rb

@@ -73,6 +73,12 @@ describe HexaPDF::Layout::ListBox do
         check_box(box, 100, 40)
       end
 
+      it "respects the set initial height and the property overflow=:truncate" do
+        box = create_box(children: @text_boxes[0, 2], height: 20,
+                         style: {overflow: :truncate, position: position})
+        check_box(box, 100, 20)
+      end
+
       it "respects the border and padding around all list items, position #{position}" do
         box = create_box(children: @text_boxes[0, 2],
                          style: {border: {width: [5, 4, 3, 2]}, padding: [5, 4, 3, 2], position: position})
@@ -108,7 +114,14 @@ describe HexaPDF::Layout::ListBox do
       check_box(box, 100, 70, [[10, 80], [10, 30]])
     end
 
-    it "fails for unknown item types" do
+    it "creates a new box for each marker even if the marker is the same" do
+      box = create_box(children: @text_boxes[0, 2])
+      check_box(box, 100, 40)
+      results = box.instance_variable_get(:@results)
+      refute_same(results[0].marker, results[1].marker)
+    end
+
+    it "fails for unknown marker types" do
       box = create_box(children: @text_boxes[0, 1], marker_type: :unknown)
       assert_raises(HexaPDF::Error) { box.fit(100, 100, @frame) }
     end
@@ -136,6 +149,17 @@ describe HexaPDF::Layout::ListBox do
       assert_equal(2, box_b.children.size)
       assert_equal(1, box_b.start_number)
     end
+
+    it "splits a list item containg multiple boxes along box lines" do
+      box = create_box(children: [@text_boxes[0], @text_boxes[1, 2]])
+      box.fit(100, 40, @frame)
+      box_a, box_b = box.split(100, 40, @frame)
+      assert_same(box, box_a)
+      assert_equal(:hide_first_marker, box_b.split_box?)
+      assert_equal(1, box_a.instance_variable_get(:@results)[1].box_fitter.fit_results.size)
+      assert_equal(1, box_b.children.size)
+      assert_equal(2, box_b.start_number)
+    end
   end
 
   describe "draw" do
@@ -315,5 +339,10 @@ describe HexaPDF::Layout::ListBox do
       assert_equal(:ZapfDingbats, @canvas.resources.font(:F1)[:BaseFont])
     end
 
+    it "fails if the initial height is set and property overflow is set to :error" do
+      box = create_box(children: @fixed_size_boxes[0, 2], height: 10)
+      box.fit(100, 100, @frame)
+      assert_raises(HexaPDF::Error) { box.draw(@canvas, 0, 100 - box.height) }
+    end
   end
 end

data/test/hexapdf/layout/test_style.rb

@@ -783,7 +783,7 @@ describe HexaPDF::Layout::Style do
     refute(@style.superscript)
     refute(@style.last_line_gap)
     refute(@style.fill_horizontal)
-    assert_equal(:error, @style.text_overflow)
+    assert_equal(:error, @style.overflow)
     assert_kind_of(HexaPDF::Layout::Style::Layers, @style.underlays)
     assert_kind_of(HexaPDF::Layout::Style::Layers, @style.overlays)
     assert_equal(:default, @style.position)

data/test/hexapdf/layout/test_text_box.rb

@@ -79,13 +79,13 @@ describe HexaPDF::Layout::TextBox do
       end
     end
 
-    it "respects the style property text_overflow when fitting too much text" do
+    it "respects the style property overflow when fitting too much text" do
       box = create_box([@inline_box] * 20, height: 15)
       refute(box.fit(100, 100, @frame))
-      box.style.text_overflow = :truncate
+      box.style.overflow = :truncate
       assert(box.fit(100, 100, @frame))
 
-      box = create_box([@inline_box] * 20, style: {text_overflow: :truncate})
+      box = create_box([@inline_box] * 20, style: {overflow: :truncate})
       refute(box.fit(100, 15, @frame))
     end
 
@@ -196,7 +196,7 @@ describe HexaPDF::Layout::TextBox do
       assert_operators(@canvas.contents, [])
     end
 
-    it "raises an error if there is too much content for a set height with text_overlow=:error" do
+    it "raises an error if there is too much content for a set height with overflow=:error" do
       box = create_box([@inline_box] * 20, height: 15)
       box.fit(100, 100, @frame)
       assert_raises(HexaPDF::Error) { box.draw(@canvas, 0, 0) }

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hexapdf
 version: !ruby/object:Gem::Version
-  version: 0.39.1
+  version: 0.40.0
 platform: ruby
 authors:
 - Thomas Leitner
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-03-19 00:00:00.000000000 Z
+date: 2024-03-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: cmdparse