hexapdf 0.44.0 → 0.45.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3b30b54b90222fbcc5469b23153efc4b15083797f527af6c5b34b3f6e161832d
-  data.tar.gz: 969c67ab85591e3b7ccad17023bd3bc820ea5effa4c01e53d254915ab1626d71
+  metadata.gz: cd31e769d2a906198da2a4194085cb2a884fa3879442b75add168d7f81d67d8b
+  data.tar.gz: 43c2b4ba4df2f997d470835995f2581aa306c639c63ddc892e648d94605f3b22
 SHA512:
-  metadata.gz: b60934dd6534ccd019953b278fa188b77996634b3e3878332302b9a2acccfd13b493b57432cff2113b7cc7727f028f24301c2d050f9b908c1b43cf66fbdeebfd
-  data.tar.gz: fdd792109306bc7cf0e30bb2da770e58e81e333843e3c785a9a31873a296b7d027121b467b54a80405332735e99bdaf6b0d167c9eaf08dbc04a26922b890bb51
+  metadata.gz: f17a303dba8104974564a213c72c0f0862c520964a3255b575544489ccb5a17a468d093d3970817903c4eb798e888592410db18447d3264d535f3a01a4a94c82
+  data.tar.gz: d5727e2f2bfb5ed827ac92eecc8cd9e0ba73044150ba07d03623dccde43dc29db1cddc2fbce24bfd63268522e7965519e188271c2bc9c00162b1a660fc468b74

data/CHANGELOG.md

@@ -1,3 +1,22 @@
+## 0.45.0 - 2024-06-18
+
+### Added
+
+* [HexaPDF::Document::Layout#styles] and [HexaPDF::Composer#styles] for defining
+  multiple styles at once
+
+### Changed
+
+* [HexaPDF::Layout::Box#fit] to set width/height correctly for boxes with
+  position `:flow`
+
+### Fixed
+
+* Regression in [HexaPDF::Layout::ListBox] that leads to missing markers
+* [HexaPDF::Content::CanvasComposer#draw_box] to handle truncated boxes
+* [HexaPDF::Layout::TableBox::Cell] to handle too-big content in all cases
+
+
 ## 0.44.0 - 2024-06-05
 
 ### Added

data/examples/027-composer_optional_content.rb

@@ -16,8 +16,10 @@
 require 'hexapdf'
 
 HexaPDF::Composer.create('composer_optional_content.pdf') do |composer|
-  composer.style(:question, font_size: 16, margin: [0, 0, 16], fill_color: 'hp-blue')
-  composer.style(:answer, font: 'ZapfDingbats', fill_color: "green")
+  composer.styles(
+    question: {font_size: 16, margin: [0, 0, 16], fill_color: 'hp-blue'},
+    answer: {font: 'ZapfDingbats', fill_color: "green"},
+  )
 
   all = composer.document.optional_content.ocg('All answers')
   a1 = composer.document.optional_content.ocg('Answer 1')
@@ -38,7 +40,7 @@ HexaPDF::Composer.create('composer_optional_content.pdf') do |composer|
           answers.text('Guido van Rossum')
           answers.multiple do |answer|
             answer.text('Yukihiro “Matz” Matsumoto', position: :float)
-            answer.text("\u{a0}\u{a0}4", style: :answer,
+            answer.text("\u{a0}\u{a0}✔", style: :answer,
                         properties: {'optional_content' => a1})
           end
           answers.text('Rob Pike')
@@ -54,7 +56,7 @@ HexaPDF::Composer.create('composer_optional_content.pdf') do |composer|
           answers.text('1992')
           answers.multiple do |answer|
             answer.text('1993', position: :float)
-            answer.text("\u{a0}\u{a0}4", style: :answer,
+            answer.text("\u{a0}\u{a0}✔", style: :answer,
                         properties: {'optional_content' => a2})
           end
         end

data/examples/030-pdfa.rb

@@ -28,17 +28,18 @@ HexaPDF::Composer.create('pdfa.pdf') do |composer|
   }
 
   # Define all styles
-  composer.style(:base, font: 'Lato', font_size: 10, line_spacing: 1.3)
-  composer.style(:top, font_size: 8)
-  composer.style(:top_box, padding: [100, 0, 0], margin: [0, 0, 10], border: {width: [0, 0, 1]})
-  composer.style(:header, font: 'Lato bold', font_size: 20, margin: [50, 0, 20])
-  composer.style(:line_items, border: {width: 1, color: "eee"}, margin: [20, 0])
-  composer.style(:line_item_cell, font_size: 8)
-  composer.style(:footer, border: {width: [1, 0, 0], color: "darkgrey"},
-                 padding: [5, 0, 0], valign: :bottom)
-  composer.style(:footer_heading, font: 'Lato bold',
-                 font_size: 8, padding: [0, 0, 8])
-  composer.style(:footer_text,  font_size: 8, fill_color: "darkgrey")
+  composer.styles(
+    base: {font: 'Lato', font_size: 10, line_spacing: 1.3},
+    top: {font_size: 8},
+    top_box: {padding: [100, 0, 0], margin: [0, 0, 10], border: {width: [0, 0, 1]}},
+    header: {font: 'Lato bold', font_size: 20, margin: [50, 0, 20]},
+    line_items: {border: {width: 1, color: "eee"}, margin: [20, 0]},
+    line_item_cell: {font_size: 8},
+    footer: {border: {width: [1, 0, 0], color: "darkgrey"}, padding: [5, 0, 0],
+             valign: :bottom},
+    footer_heading: {font: 'Lato bold', font_size: 8, padding: [0, 0, 8]},
+    footer_text: {font_size: 8, fill_color: "darkgrey"},
+  )
 
   # Top part
   composer.box(:container, style: :top_box) do |container|

data/lib/hexapdf/composer.rb

@@ -254,6 +254,28 @@ module HexaPDF
       @document.layout.style(name, base: base, **properties)
     end
 
+    # :call-seq:
+    #    composer.styles              -> styles
+    #    composer.styles(**mapping)   -> styles
+    #
+    # Creates multiple named styles at once if +mapping+ is provided, and returns the style mapping.
+    #
+    # See HexaPDF::Document::Layout#styles for details; this method is just a thin wrapper around
+    # that method.
+    #
+    # Example:
+    #
+    #   composer.styles(
+    #     base: {font_size: 12, leading: 1.2},
+    #     header: {font: 'Helvetica', fill_color: "008"},
+    #     header1: {base: :header, font_size: 30}
+    #   )
+    #
+    # See: HexaPDF::Layout::Style
+    def styles(**mapping)
+      @document.layout.styles(**mapping)
+    end
+
     # :call-seq:
     #    composer.page_style(name)                                 -> page_style
     #    composer.page_style(name, **attributes, &template_block)  -> page_style

data/lib/hexapdf/content/canvas.rb

@@ -1127,7 +1127,7 @@ module HexaPDF
       #   canvas.rectangle(x, y, width, height, radius: 0)       => canvas
       #
       # Appends a rectangle to the current path as a complete subpath (drawn in counterclockwise
-      # direction), with the bottom left corner specified by +x+ and +y+ and the given +width+ and
+      # direction), with the bottom-left corner specified by +x+ and +y+ and the given +width+ and
       # +height+. Returns +self+.
       #
       # If +radius+ is greater than 0, the corners are rounded with the given radius.
@@ -1137,7 +1137,7 @@ module HexaPDF
       #
       # If there is no current path when the method is invoked, a new path is automatically begun.
       #
-      # The current point is set to the bottom left corner if +radius+ is zero, otherwise it is set
+      # The current point is set to the bottom-left corner if +radius+ is zero, otherwise it is set
       # to (x, y + radius).
       #
       # Examples:
@@ -1720,7 +1720,7 @@ module HexaPDF
       # If the filename or the IO specifies a PDF file, the first page of this file is used to
       # create a form XObject which is then drawn.
       #
-      # The +at+ argument has to be an array containing two numbers specifying the bottom left
+      # The +at+ argument has to be an array containing two numbers specifying the bottom-left
       # corner at which to draw the XObject.
       #
       # If +width+ and +height+ are specified, the drawn XObject will have exactly these

data/lib/hexapdf/content/canvas_composer.rb

@@ -96,6 +96,7 @@ module HexaPDF
             draw_box, box = @frame.split(result)
             if draw_box
               @frame.draw(@canvas, result)
+              (box = draw_box; break) unless box
             elsif !@frame.find_next_region
               raise HexaPDF::Error, "Frame for canvas composer is full and box doesn't fit anymore"
             end

data/lib/hexapdf/document/layout.rb

@@ -175,9 +175,6 @@ module HexaPDF
 
       end
 
-      # The mapping of style name (a Symbol) to Layout::Style instance.
-      attr_reader :styles
-
       # Creates a new Layout object for the given PDF document.
       def initialize(document)
         @document = document
@@ -219,6 +216,21 @@ module HexaPDF
         style
       end
 
+      # :call-seq:
+      #    layout.styles            -> styles
+      #    layout.styles(**mapping)   -> styles
+      #
+      # Returns the mapping of style names to Layout::Style instances. If +mapping+ is provided,
+      # also defines the given styles using #style.
+      #
+      # The argument +mapping+ needs to be a hash mapping a style name (a Symbol) to style
+      # properties. The special key +:base+ can be used to define the base style. For details see
+      # #style.
+      def styles(**mapping)
+        mapping.each {|name, properties| style(name, **properties) } unless mapping.empty?
+        @styles
+      end
+
       # Creates an inline box for use together with text fragments.
       #
       # The +valign+ argument ist used to specify the vertical alignment of the box within the text

data/lib/hexapdf/font/type1/character_metrics.rb

@@ -51,7 +51,7 @@ module HexaPDF
         attr_accessor :name
 
         # Character bounding box as array of four numbers, specifying the x- and y-coordinates of
-        # the bottom left corner and the x- and y-coordinates of the top right corner.
+        # the bottom-left corner and the x- and y-coordinates of the top-right corner.
         attr_accessor :bbox
 
       end

data/lib/hexapdf/font/type1/font_metrics.rb

@@ -63,7 +63,7 @@ module HexaPDF
         attr_accessor :weight
 
         # The font bounding box as array of four numbers, specifying the x- and y-coordinates of the
-        # bottom left corner and the x- and y-coordinates of the top right corner.
+        # bottom-left corner and the x- and y-coordinates of the top-right corner.
         attr_accessor :bounding_box
 
         # The y-value of the top of the capital H (or 0 or nil if the font doesn't contain a capital

data/lib/hexapdf/layout/box.rb

@@ -323,10 +323,12 @@ module HexaPDF
       # current region of the frame, adjusted for this box. The frame itself is provided as third
       # argument.
       #
-      # The default implementation uses the given available width and height for the box width and
-      # height if they were initially set to 0. Otherwise the intially specified dimensions are
-      # used. The method returns early if the thus configured box already doesn't fit. Otherwise,
-      # the #fit_content method is called which allows sub-classes to fit their content.
+      # If the box uses flow positioning, the width is set to the frame's width and the height to
+      # the remaining height in the frame. Otherwise the given available width and height are used
+      # for the width and height if they were initially set to 0. Otherwise the intially specified
+      # dimensions are used. The method returns early if the thus configured box already doesn't
+      # fit. Otherwise, the #fit_content method is called which allows sub-classes to fit their
+      # content.
       #
       # The following variables are set that may later be used during splitting or drawing:
       #
@@ -334,10 +336,23 @@ module HexaPDF
       #   used to adjust the drawing position in #draw_content if necessary.
       def fit(available_width, available_height, frame)
         @fit_result.reset(frame)
-        @width = (@initial_width > 0 ? @initial_width : available_width)
-        @height = (@initial_height > 0 ? @initial_height : available_height)
-        return @fit_result if style.position != :flow && (float_compare(@width, available_width) > 0 ||
-                                                          float_compare(@height, available_height) > 0)
+        position_flow = supports_position_flow? && style.position == :flow
+        @width = if @initial_width > 0
+                   @initial_width
+                 elsif position_flow
+                   frame.width
+                 else
+                   available_width
+                 end
+        @height = if @initial_height > 0
+                    @initial_height
+                  elsif position_flow
+                    frame.y - frame.bottom
+                  else
+                    available_height
+                  end
+        return @fit_result if !position_flow && (float_compare(@width, available_width) > 0 ||
+                                                 float_compare(@height, available_height) > 0)
 
         fit_content(available_width, available_height, frame)
 
@@ -379,7 +394,7 @@ module HexaPDF
       # system is translated so that the origin is at the bottom left corner of the **content box**.
       #
       # Subclasses should not rely on the +@draw_block+ but implement the #draw_content method. The
-      # coordinates passed to it are also modified to represent the bottom left corner of the
+      # coordinates passed to it are also modified to represent the bottom-left corner of the
       # content box but the coordinate system is not translated.
       def draw(canvas, x, y)
         if @fit_result.overflow? && @initial_height > 0 && style.overflow == :error

data/lib/hexapdf/layout/column_box.rb

@@ -142,19 +142,11 @@ module HexaPDF
 
       # Fits the column box into the current region of the frame.
       #
-      def fit_content(available_width, available_height, frame)
+      def fit_content(_available_width, _available_height, frame)
         initial_fit_successful = (@equal_height && @columns.size > 1 ? nil : false)
         tries = 0
-        width = if style.position == :flow
-                  (@initial_width > 0 ? @initial_width : frame.width) - reserved_width
-                else
-                  (@initial_width > 0 ? @initial_width : available_width) - reserved_width
-                end
-        height = if style.position == :flow
-                   (@initial_height > 0 ? @initial_height : frame.y - frame.bottom) - reserved_height
-                 else
-                   (@initial_height > 0 ? @initial_height : available_height) - reserved_height
-                 end
+        width = @width - reserved_width
+        height = @height - reserved_height
 
         columns = calculate_columns(width)
         return if columns.empty?

data/lib/hexapdf/layout/container_box.rb

@@ -52,7 +52,7 @@ module HexaPDF
     # setting the style properties 'mask_mode', 'align' and 'valign', it is possible to lay out the
     # children bottom to top, left to right, or right to left:
     #
-    # * The standard top to bottom layout:
+    # * The standard top-to-bottom layout:
     #
     #     #>pdf-composer100
     #     composer.container do |container|
@@ -61,7 +61,7 @@ module HexaPDF
     #       container.box(:base, height: 20, style: {background_color: "hp-blue-light"})
     #     end
     #
-    # * The bottom to top layout (using valign = :bottom to fill up from the bottom and mask_mode =
+    # * The bottom-to-top layout (using valign = :bottom to fill up from the bottom and mask_mode =
     #   :fill_horizontal to only remove the area to the left and right of the box):
     #
     #     #>pdf-composer100
@@ -74,7 +74,7 @@ module HexaPDF
     #                                                mask_mode: :fill_horizontal, valign: :bottom})
     #     end
     #
-    # * The left to right layout (using mask_mode = :fill_vertical to fill the area to the top and
+    # * The left-to-right layout (using mask_mode = :fill_vertical to fill the area to the top and
     #   bottom of the box):
     #
     #     #>pdf-composer100
@@ -87,7 +87,7 @@ module HexaPDF
     #                                               mask_mode: :fill_vertical})
     #     end
     #
-    # * The right to left layout (using align = :right to fill up from the right and mask_mode =
+    # * The right-to-left layout (using align = :right to fill up from the right and mask_mode =
     #   :fill_vertical to fill the area to the top and bottom of the box):
     #
     #     #>pdf-composer100

data/lib/hexapdf/layout/frame.rb

@@ -54,7 +54,7 @@ module HexaPDF
     #
     #   The method #fit is also called for absolutely positioned boxes but since these boxes are not
     #   subject to the normal constraints, the provided available width and height are the width and
-    #   height inside the frame to the right and top of the bottom left corner of the box.
+    #   height inside the frame to the right and top of the bottom-left corner of the box.
     #
     # * If the box didn't fit, call #find_next_region to determine the next region for placing the
     #   box. If a new region was found, start over with #fit. Otherwise the frame has no more space
@@ -84,10 +84,10 @@ module HexaPDF
 
       include HexaPDF::Utils
 
-      # The x-coordinate of the bottom left corner.
+      # The x-coordinate of the bottom-left corner.
       attr_reader :left
 
-      # The y-coordinate of the bottom left corner.
+      # The y-coordinate of the bottom-left corner.
       attr_reader :bottom
 
       # The width of the frame.
@@ -127,7 +127,7 @@ module HexaPDF
 
       # An array of box objects representing the parent boxes.
       #
-      # The immediate parent is the last array entry, the top most parent the first one. All boxes
+      # The immediate parent is the last array entry, the top-most parent the first one. All boxes
       # that are fitted into this frame have to be child boxes of the immediate parent box.
       attr_reader :parent_boxes
 
@@ -216,6 +216,7 @@ module HexaPDF
           end
 
           fit_result = box.fit(aw, ah, self)
+          return fit_result if fit_result.failure?
 
           width = box.width
           height = box.height
@@ -382,7 +383,7 @@ module HexaPDF
       # Since not all text may start at the top of the frame, the offset argument can be used to
       # specify a vertical offset from the top of the frame where layouting should start.
       #
-      # To be compatible with TextLayouter, the top left corner of the bounding box of the frame's
+      # To be compatible with TextLayouter, the top-left corner of the bounding box of the frame's
       # shape is the origin of the coordinate system for the width specification, with positive
       # x-values to the right and positive y-values downwards.
       #

data/lib/hexapdf/layout/list_box.rb

@@ -189,19 +189,9 @@ module HexaPDF
       private
 
       # Fits the list box into the current region of the frame.
-      def fit_content(available_width, available_height, frame)
-        @width = if @initial_width > 0
-                   @initial_width
-                 else
-                   (style.position == :flow ? frame.width : available_width)
-                 end
-        height = if @initial_height > 0
-                   @initial_height - reserved_height
-                 else
-                   (style.position == :flow ? frame.y - frame.bottom : available_height) - reserved_height
-                 end
-
+      def fit_content(_available_width, _available_height, frame)
         width = @width - reserved_width
+        height = @height - reserved_height
         left = (style.position == :flow ? frame.left : frame.x) + reserved_width_left
         top = frame.y - reserved_height_top
 
@@ -245,7 +235,7 @@ module HexaPDF
           Array(child).each {|ibox| box_fitter.fit(ibox) }
           item_result.box_fitter = box_fitter
           item_result.height = [item_result.height.to_i, box_fitter.content_heights[0]].max
-          @results << item_result
+          @results << item_result unless box_fitter.fit_results.empty?
 
           top -= item_result.height + item_spacing
           height -= item_result.height + item_spacing

data/lib/hexapdf/layout/style.rb

@@ -393,7 +393,7 @@ module HexaPDF
       # The object resolved in this way needs to respond to #call(canvas, box) where +canvas+ is the
       # HexaPDF::Content::Canvas object on which it should be drawn and +box+ is a box-like object
       # (e.g. Box or TextFragment). The coordinate system is translated so that the origin is at the
-      # bottom left corner of the box during the drawing operations.
+      # bottom-left corner of the box during the drawing operations.
       class Layers
 
         # Creates a new Layers object popuplated with the given +layers+.
@@ -1268,8 +1268,8 @@ module HexaPDF
       #       composer.lorem_ipsum(position: :flow)
       #
       # [x, y]::
-      #     Position the box with the bottom left corner at the given absolute position relative to
-      #     the bottom left corner of the frame.
+      #     Position the box with the bottom-left corner at the given absolute position relative to
+      #     the bottom-left corner of the frame.
       #
       #     Examples:
       #

data/lib/hexapdf/layout/table_box.rb

@@ -228,18 +228,22 @@ module HexaPDF
           case children
           when Box
             child_result = frame.fit(children)
-            @preferred_width = child_result.x + child_result.box.width + reserved_width
-            @height = @preferred_height = child_result.box.height + reserved_height
-            @fit_results = [child_result]
-            fit_result.success! if child_result.success?
+            if child_result.success?
+              @preferred_width = child_result.x + child_result.box.width + reserved_width
+              @height = @preferred_height = child_result.box.height + reserved_height
+              @fit_results = [child_result]
+              fit_result.success!
+            end
           when Array
             box_fitter = BoxFitter.new([frame])
             children.each {|box| box_fitter.fit(box) }
-            max_x_result = box_fitter.fit_results.max_by {|result| result.x + result.box.width }
-            @preferred_width = max_x_result.x + max_x_result.box.width + reserved_width
-            @height = @preferred_height = box_fitter.content_heights[0] + reserved_height
-            @fit_results = box_fitter.fit_results
-            fit_result.success! if box_fitter.success?
+            if box_fitter.success?
+              max_x_result = box_fitter.fit_results.max_by {|result| result.x + result.box.width }
+              @preferred_width = max_x_result.x + max_x_result.box.width + reserved_width
+              @height = @preferred_height = box_fitter.content_heights[0] + reserved_height
+              @fit_results = box_fitter.fit_results
+              fit_result.success!
+            end
           else
             @preferred_width = reserved_width
             @height = @preferred_height = reserved_height
@@ -590,7 +594,7 @@ module HexaPDF
       def fit_content(_available_width, _available_height, frame)
         # Adjust reserved width/height to include space used by the edge cells for their border
         # since cell borders are drawn on the bounds and not inside.
-        # This uses the top left and bottom right cells and so might not be correct in all cases.
+        # This uses the top-left and bottom-right cells and so might not be correct in all cases.
         @cell_tl_border_width = @cells[0, 0].style.border.width
         cell_br_border_width = @cells[-1, -1].style.border.width
         rw = (@cell_tl_border_width.left + cell_br_border_width.right) / 2.0

data/lib/hexapdf/layout/text_box.rb

@@ -42,12 +42,46 @@ module HexaPDF
     # A TextBox is used for drawing text, either inside a rectangular box or by flowing it around
     # objects of a Frame.
     #
+    # The standard usage is through the helper methods Document::Layout#text and
+    # Document::Layout#formatted_text.
+    #
     # This class uses TextLayouter behind the scenes to do the hard work.
     #
     # == Used Box Properties
     #
     # The spacing after the last line can be controlled via the style property +last_line_gap+. Also
     # see TextLayouter#style for other style properties taken into account.
+    #
+    # == Limitations
+    #
+    # When setting the style property 'position' to +:flow+, padding and border to the left and
+    # right as well as a predefined fixed width are not respected and the result will look wrong.
+    #
+    # == Examples
+    #
+    # Showing some text:
+    #
+    #   #>pdf-composer
+    #   composer.box(:text, items: layout.text_fragments("This is some text."))
+    #   # Or easier with the provided convenience method
+    #   composer.text("This is also some text")
+    #
+    # It is possible to flow the text around other objects by using the style property
+    # 'position' with the value +:flow+:
+    #
+    #   #>pdf-composer
+    #   composer.box(:base, width: 30, height: 30,
+    #                style: {margin: 5, position: :float, background_color: "hp-blue-light"})
+    #   composer.text("This is some text. " * 20, position: :flow)
+    #
+    # While top and bottom padding and border can be used with flow positioning, left and right
+    # padding and border are not supported and the result will look wrong:
+    #
+    #   #>pdf-composer
+    #   composer.box(:base, width: 30, height: 30,
+    #                style: {margin: 5, position: :float, background_color: "hp-blue-light"})
+    #   composer.text("This is some text. " * 20, padding: 10, position: :flow,
+    #                 text_align: :justify)
     class TextBox < Box
 
       # Creates a new TextBox object with the given inline items (e.g. TextFragment and InlineBox
@@ -89,40 +123,34 @@ module HexaPDF
       # Depending on the 'position' style property, the text is either fit into the current region
       # of the frame using +available_width+ and +available_height+, or fit to the shape of the
       # frame starting from the top (when 'position' is set to :flow).
-      def fit_content(available_width, available_height, frame)
+      def fit_content(_available_width, _available_height, frame)
         frame = frame.child_frame(box: self)
-        @width = @x_offset = @height = 0
+        @x_offset = 0
 
-        @result = if style.position == :flow
-                    @tl.fit(@items, frame.width_specification, frame.shape.bbox.height,
+        if style.position == :flow
+          height = (@initial_height > 0 ? @initial_height : frame.shape.bbox.height) - reserved_height
+          @result = @tl.fit(@items, frame.width_specification(reserved_height_top), height,
                             apply_first_text_indent: !split_box?, frame: frame)
-                  else
-                    @width = reserved_width
-                    @height = reserved_height
-                    width = (@initial_width > 0 ? @initial_width : available_width) - @width
-                    height = (@initial_height > 0 ? @initial_height : available_height) - @height
-                    @tl.fit(@items, width, height, apply_first_text_indent: !split_box?, frame: frame)
-                  end
-
-        @width += if @initial_width > 0 || style.text_align == :center || style.text_align == :right
-                    width
-                  elsif style.position == :flow
-                    min_x = +Float::INFINITY
-                    max_x = -Float::INFINITY
-                    @result.lines.each do |line|
-                      min_x = [min_x, line.x_offset].min
-                      max_x = [max_x, line.x_offset + line.width].max
-                    end
-                    min_x.finite? ? (@x_offset = min_x; max_x - min_x) : 0
-                  else
-                    @result.lines.max_by(&:width)&.width || 0
-                  end
-        @height += if @initial_height > 0 || style.text_valign == :center || style.text_valign == :bottom
-                     height
-                   else
-                     @result.height
-                   end
-        if style.last_line_gap && @result.lines.last
+          min_x = +Float::INFINITY
+          max_x = -Float::INFINITY
+          @result.lines.each do |line|
+            min_x = [min_x, line.x_offset].min
+            max_x = [max_x, line.x_offset + line.width].max
+          end
+          @width = (min_x.finite? ? (@x_offset = min_x; max_x - min_x) : 0) + reserved_width
+          @height = @initial_height > 0 ? @initial_height : @result.height + reserved_height
+        else
+          @result = @tl.fit(@items, @width - reserved_width, @height - reserved_height,
+                            apply_first_text_indent: !split_box?, frame: frame)
+          if style.text_align == :left && @initial_width == 0
+            @width = (@result.lines.max_by(&:width)&.width || 0) + reserved_width
+          end
+          if style.text_valign == :top && @initial_height == 0
+            @height = @result.height + reserved_height
+          end
+        end
+
+        if style.last_line_gap && @result.lines.last && @initial_height == 0
           @height += style.line_spacing.gap(@result.lines.last, @result.lines.last)
         end
 

data/lib/hexapdf/layout/text_fragment.rb

@@ -52,7 +52,7 @@ module HexaPDF
     # The items of a text fragment may be frozen to indicate that the fragment is potentially used
     # multiple times.
     #
-    # The rectangle with the bottom left corner (#x_min, #y_min) and the top right corner (#x_max,
+    # The rectangle with the bottom-left corner (#x_min, #y_min) and the top-right corner (#x_max,
     # #y_max) describes the minimum bounding box of the whole text fragment and is usually *not*
     # equal to the box (0, 0)-(#width, #height).
     class TextFragment

data/lib/hexapdf/layout/text_layouter.rb

@@ -218,7 +218,10 @@ module HexaPDF
 
         # Breaks are detected at: space, tab, zero-width-space, non-breaking space, hyphen,
         # soft-hypen and any valid Unicode newline separator
-        BREAK_RE = /[ \u{A}-\u{D}\u{85}\u{2028}\u{2029}\t\u{200B}\u{00AD}\u{00A0}-]/
+        BREAK_CHARS = {}
+        " \u{A}\u{B}\u{C}\u{D}\u{85}\u{2028}\u{2029}\t\u{200B}\u{00AD}\u{00A0}-".each_char do |c|
+          BREAK_CHARS[c] = true
+        end
 
         # Breaks the items (an array of InlineBox and TextFragment objects) into atomic pieces
         # wrapped by Box, Glue or Penalty items, and returns those as an array.
@@ -235,7 +238,7 @@ module HexaPDF
                 # Collect characters and kerning values until break character is encountered
                 box_items = []
                 while (glyph = item.items[i]) &&
-                    (glyph.kind_of?(Numeric) || !BREAK_RE.match?(glyph.str))
+                    (glyph.kind_of?(Numeric) || !BREAK_CHARS.key?(glyph.str))
                   box_items << glyph
                   i += 1
                 end
@@ -428,9 +431,7 @@ module HexaPDF
           end
 
           line = create_unjustified_line
-          last_line_used = true
-          last_line_used = yield(line, nil) if item.nil? && !line.items.empty?
-
+          last_line_used = (item.nil? && !line.items.empty? ? yield(line, nil) : true)
           item.nil? && last_line_used ? [] : @items[@beginning_of_line_index..-1]
         end
 
@@ -500,9 +501,7 @@ module HexaPDF
           end
 
           line = create_unjustified_line
-          last_line_used = true
-          last_line_used = yield(line, nil) if item.nil? && !line.items.empty?
-
+          last_line_used = (item.nil? && !line.items.empty? ? yield(line, nil) : true)
           item.nil? && last_line_used ? [] : @items[@beginning_of_line_index..-1]
         end
 

data/lib/hexapdf/rectangle.rb

@@ -48,8 +48,8 @@ module HexaPDF
   #
   #   [left, bottom, right, top]
   #
-  # where +left+ is the bottom left x-coordinate, +bottom+ is the bottom left y-coordinate, +right+
-  # is the top right x-coordinate and +top+ is the top right y-coordinate.
+  # where +left+ is the bottom-left x-coordinate, +bottom+ is the bottom-left y-coordinate, +right+
+  # is the top-right x-coordinate and +top+ is the top-right y-coordinate.
   #
   # See: PDF2.0 s7.9.5
   class Rectangle < HexaPDF::PDFArray
@@ -119,8 +119,8 @@ module HexaPDF
     #:nodoc:
     RECTANGLE_ERROR_MSG = "A PDF rectangle structure must contain an array of four numbers"
 
-    # Ensures that the value is an array containing four numbers that specify the bottom left and
-    # top right corner.
+    # Ensures that the value is an array containing four numbers that specify the bottom-left and
+    # top-right corners.
     def after_data_change
       super
       unless value.size == 4 && all? {|v| v.kind_of?(Numeric) }

data/lib/hexapdf/type/form.rb

@@ -159,8 +159,8 @@ module HexaPDF
       # retained without the need for parsing its contents.
       #
       # If the bounding box of the form XObject doesn't have its origin at (0, 0), the canvas origin
-      # is translated into the bottom left corner so that this detail doesn't matter when using the
-      # canvas. This means that the canvas' origin is always at the bottom left corner of the
+      # is translated into the bottom-left corner so that this detail doesn't matter when using the
+      # canvas. This means that the canvas' origin is always at the bottom-left corner of the
       # bounding box.
       #
       # *Note* that a canvas can only be retrieved for initially empty form XObjects!

data/lib/hexapdf/version.rb

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

data/test/hexapdf/content/test_canvas_composer.rb

@@ -47,21 +47,20 @@ describe HexaPDF::Content::CanvasComposer do
     end
 
     it "splits the box if possible" do
-      @composer.draw_box(create_box(width: 400, style: {position: :float}))
-      box = create_box(width: 400, height: 100)
-      box.define_singleton_method(:split) do |*|
-        [box, HexaPDF::Layout::Box.new(height: 100) {}]
-      end
+      @composer.draw_box(create_box(width: 300, height: 300, style: {position: :float}))
+      box = create_box(style: {mask_mode: :box})
+      box.define_singleton_method(:fit_content) {|*| fit_result.overflow! }
+      box.define_singleton_method(:split_content) { [box, HexaPDF::Layout::Box.new(height: 100) {}] }
       @composer.draw_box(box)
       assert_operators(@composer.canvas.contents,
                        [[:save_graphics_state],
-                        [:concatenate_matrix, [1, 0, 0, 1, 0, 0]],
+                        [:concatenate_matrix, [1, 0, 0, 1, 0, 541.889764]],
                         [:restore_graphics_state],
                         [:save_graphics_state],
-                        [:concatenate_matrix, [1, 0, 0, 1, 400, 741.889764]],
+                        [:concatenate_matrix, [1, 0, 0, 1, 300, 0]],
                         [:restore_graphics_state],
                         [:save_graphics_state],
-                        [:concatenate_matrix, [1, 0, 0, 1, 400, 641.889764]],
+                        [:concatenate_matrix, [1, 0, 0, 1, 0, 441.889764]],
                         [:restore_graphics_state]])
     end
 
@@ -77,6 +76,12 @@ describe HexaPDF::Content::CanvasComposer do
                         [:restore_graphics_state]])
     end
 
+    it "handles truncated boxes correctly" do
+      box = create_box(height: 400, style: {overflow: :truncate})
+      box.define_singleton_method(:fit_content) {|*| fit_result.overflow! }
+      assert_same(box, @composer.draw_box(box))
+    end
+
     it "returns the last drawn box" do
       box = create_box(height: 400)
       assert_same(box, @composer.draw_box(box))

data/test/hexapdf/document/test_layout.rb

@@ -141,6 +141,22 @@ describe HexaPDF::Document::Layout do
     end
   end
 
+  describe "styles" do
+    it "returns the existing styles" do
+      @layout.style(:test, font_size: 20)
+      assert_equal([:base, :test], @layout.styles.keys)
+    end
+
+    it "sets multiple styles at once" do
+      styles = @layout.styles(
+        test: {font_size: 20},
+        test2: {font_size: 30},
+      )
+      assert_same(styles, @layout.styles)
+      assert_equal([:base, :test, :test2], @layout.styles.keys)
+    end
+  end
+
   describe "inline_box" do
     it "takes a box as argument" do
       box = HexaPDF::Layout::Box.create(width: 10, height: 10)

data/test/hexapdf/layout/test_box.rb

@@ -40,6 +40,9 @@ describe HexaPDF::Layout::Box do
     @frame = Object.new
     def @frame.x; 0; end
     def @frame.y; 100; end
+    def @frame.bottom; 40; end
+    def @frame.width; 150; end
+    def @frame.height; 150; end
   end
 
   def create_box(**args, &block)
@@ -130,6 +133,14 @@ describe HexaPDF::Layout::Box do
       assert_equal(100, box.height)
     end
 
+    it "use the frame's width and its remaining height for position=:flow boxes" do
+      box = create_box(style: {position: :flow})
+      box.define_singleton_method(:supports_position_flow?) { true }
+      assert(box.fit(100, 100, @frame).success?)
+      assert_equal(150, box.width)
+      assert_equal(60, box.height)
+    end
+
     it "uses float comparison" do
       box = create_box(width: 50.0000002, height: 49.9999996)
       assert(box.fit(50, 50, @frame).success?)

data/test/hexapdf/layout/test_frame.rb

@@ -423,6 +423,15 @@ describe HexaPDF::Layout::Frame do
       box = HexaPDF::Layout::Box.create
       refute(@frame.fit(box).success?)
     end
+
+    it "doesn't do post-fitting tasks if fitting is a failure" do
+      box = HexaPDF::Layout::Box.create(width: 400)
+      result = @frame.fit(box)
+      assert(result.failure?)
+      assert_nil(result.x)
+      assert_nil(result.y)
+      assert_nil(result.mask)
+    end
   end
 
   describe "split" do

data/test/hexapdf/layout/test_list_box.rb

@@ -134,13 +134,13 @@ describe HexaPDF::Layout::ListBox do
 
   describe "split" do
     it "splits before a list item if no part of it will fit" do
-      box = create_box(children: @text_boxes[0, 2])
-      assert(box.fit(100, 20, @frame).overflow?)
+      box = create_box(children: @text_boxes[0, 3])
+      assert(box.fit(100, 22, @frame).overflow?)
       box_a, box_b = box.split
       assert_same(box, box_a)
       assert_equal(:show_first_marker, box_b.split_box?)
       assert_equal(1, box_a.instance_variable_get(:@results)[0].box_fitter.fit_results.size)
-      assert_equal(1, box_b.children.size)
+      assert_equal(2, box_b.children.size)
       assert_equal(2, box_b.start_number)
     end
 

data/test/hexapdf/layout/test_table_box.rb

@@ -116,7 +116,14 @@ describe HexaPDF::Layout::TableBox::Cell do
       assert_equal(12, cell.preferred_height)
     end
 
-    it "doesn't fit anything if the available width or height are too small" do
+    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?)
+      cell = create_cell(children: [HexaPDF::Layout::Box.create(width: 300, height: 20)])
+      assert(cell.fit(100, 100, @frame).failure?)
+    end
+
+    it "doesn't fit anything if the available width or height are too small even if there are no children" do
       cell = create_cell(children: nil)
       assert(cell.fit(10, 100, @frame).failure?)
       assert(cell.fit(100, 10, @frame).failure?)

data/test/hexapdf/layout/test_text_box.rb

@@ -42,31 +42,32 @@ describe HexaPDF::Layout::TextBox do
     end
 
     it "respects the set width and height" do
-      box = create_box([@inline_box], width: 40, height: 50, style: {padding: 10})
+      box = create_box([@inline_box] * 5, width: 44, height: 50,
+                       style: {padding: 10, text_align: :right, text_valign: :bottom})
       assert(box.fit(100, 100, @frame).success?)
-      assert_equal(40, box.width)
+      assert_equal(44, box.width)
       assert_equal(50, box.height)
-      assert_equal([10], box.instance_variable_get(:@result).lines.map(&:width))
+      assert_equal([20, 20, 10], box.instance_variable_get(:@result).lines.map(&:width))
     end
 
-    it "fits into the frame's outline" do
-      @frame.remove_area(Geom2D::Rectangle(0, 80, 20, 20))
-      @frame.remove_area(Geom2D::Rectangle(80, 70, 20, 20))
-      box = create_box([@inline_box] * 20, style: {position: :flow})
-      assert(box.fit(100, 100, @frame).success?)
-      assert_equal(100, box.width)
-      assert_equal(30, box.height)
-    end
+    describe "style option last_line_gap" do
+      it "is taken into account" do
+        box = create_box([@inline_box] * 5, style: {last_line_gap: true, line_spacing: :double})
+        assert(box.fit(100, 100, @frame).success?)
+        assert_equal(50, box.width)
+        assert_equal(20, box.height)
+      end
 
-    it "takes the style option last_line_gap into account" do
-      box = create_box([@inline_box] * 5, style: {last_line_gap: true, line_spacing: :double})
-      assert(box.fit(100, 100, @frame).success?)
-      assert_equal(50, box.width)
-      assert_equal(20, box.height)
+      it "will have no effect for fixed-height boxes" do
+        box = create_box([@inline_box] * 5, height: 40, style: {last_line_gap: true, line_spacing: :double})
+        assert(box.fit(100, 100, @frame).success?)
+        assert_equal(50, box.width)
+        assert_equal(40, box.height)
+      end
     end
 
-    it "uses the whole available width when aligning to the center or right" do
-      [:center, :right].each do |align|
+    it "uses the whole available width when aligning to the center, right or justified" do
+      [:center, :right, :justify].each do |align|
         box = create_box([@inline_box], style: {text_align: align})
         assert(box.fit(100, 100, @frame).success?)
         assert_equal(100, box.width)
@@ -103,6 +104,33 @@ describe HexaPDF::Layout::TextBox do
       assert(box.fit(100, 100, @frame).success?)
     end
 
+    describe "position :flow" do
+      it "fits into the frame's outline" do
+        @frame.remove_area(Geom2D::Rectangle(0, 80, 20, 20))
+        @frame.remove_area(Geom2D::Rectangle(80, 70, 20, 20))
+        box = create_box([@inline_box] * 20, style: {position: :flow})
+        assert(box.fit(100, 100, @frame).success?)
+        assert_equal(100, box.width)
+        assert_equal(30, box.height)
+      end
+
+      it "respects a set initial height" do
+        box = create_box([@inline_box] * 20, height: 13, style: {position: :flow})
+        assert(box.fit(100, 100, @frame).overflow?)
+        assert_equal(100, box.width)
+        assert_equal(13, box.height)
+      end
+
+      it "respects top/bottom padding/border" do
+        @frame.remove_area(Geom2D::Rectangle(0, 80, 20, 20))
+        box = create_box([@inline_box] * 20, style: {position: :flow, padding: 10, border: {width: 2}})
+        assert(box.fit(100, 100, @frame).success?)
+        assert_equal(124, box.width)
+        assert_equal(54, box.height)
+        assert_equal([80, 100, 20], box.instance_variable_get(:@result).lines.map(&:width))
+      end
+    end
+
     it "fails if no item of the text box fits due to the width" do
       box = create_box([@inline_box])
       assert(box.fit(5, 20, @frame).failure?)
@@ -167,12 +195,12 @@ describe HexaPDF::Layout::TextBox do
       @frame.remove_area(Geom2D::Rectangle(0, 0, 40, 100))
       box = create_box([@inline_box], style: {position: :flow, border: {width: 1}})
       box.fit(60, 100, @frame)
-      box.draw(@canvas, 0, 90)
+      box.draw(@canvas, 0, 88)
       assert_operators(@canvas.contents, [[:save_graphics_state],
-                                          [:append_rectangle, [40, 90, 10, 10]],
+                                          [:append_rectangle, [40, 88, 12, 12]],
                                           [:clip_path_non_zero],
                                           [:end_path],
-                                          [:append_rectangle, [40.5, 90.5, 9.0, 9.0]],
+                                          [:append_rectangle, [40.5, 88.5, 11.0, 11.0]],
                                           [:stroke_path],
                                           [:restore_graphics_state],
                                           [:save_graphics_state],

data/test/hexapdf/test_composer.rb

@@ -119,6 +119,13 @@ describe HexaPDF::Composer do
     end
   end
 
+  describe "styles" do
+    it "delegates to layout.styles" do
+      @composer.styles(base: {font_size: 30}, other: {font_size: 40})
+      assert_equal([:base, :other], @composer.document.layout.styles.keys)
+    end
+  end
+
   describe "page_style" do
     it "returns the page style if no argument or block is given" do
       page_style = @composer.page_style(:default)
@@ -225,8 +232,9 @@ describe HexaPDF::Composer do
       first_page_contents = @composer.canvas.contents
       @composer.draw_box(create_box(height: 400))
 
-      box = create_box(height: 400)
-      box.define_singleton_method(:split) do |*|
+      box = create_box
+      box.define_singleton_method(:fit_content) {|*| fit_result.overflow! }
+      box.define_singleton_method(:split_content) do |*|
         [box, HexaPDF::Layout::Box.new(height: 100) {}]
       end
       @composer.draw_box(box)
@@ -235,7 +243,7 @@ describe HexaPDF::Composer do
                         [:concatenate_matrix, [1, 0, 0, 1, 36, 405.889764]],
                         [:restore_graphics_state],
                         [:save_graphics_state],
-                        [:concatenate_matrix, [1, 0, 0, 1, 36, 5.889764]],
+                        [:concatenate_matrix, [1, 0, 0, 1, 36, 36]],
                         [:restore_graphics_state]])
       assert_operators(@composer.canvas.contents,
                        [[:save_graphics_state],
@@ -273,9 +281,10 @@ describe HexaPDF::Composer do
       box = create_box(height: 400)
       assert_same(box, @composer.draw_box(box))
 
-      box = create_box(height: 400)
       split_box = create_box(height: 100)
-      box.define_singleton_method(:split) {|*| [box, split_box] }
+      box = create_box
+      box.define_singleton_method(:fit_content) {|*| fit_result.overflow! }
+      box.define_singleton_method(:split_content) {|*| [box, split_box] }
       assert_same(split_box, @composer.draw_box(box))
     end
 

data/test/hexapdf/test_serializer.rb

@@ -89,6 +89,7 @@ describe HexaPDF::Serializer do
     assert_serialized('/ ', :"")
     assert_serialized('/H#c3#b6#c3#9fgang', :Hößgang)
     assert_serialized('/H#e8lp', "H\xE8lp".force_encoding('BINARY').intern)
+    assert_serialized('/#00#09#0a#0c#0d#20', :"\x00\t\n\f\r ")
   end
 
   it "serializes arrays" do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hexapdf
 version: !ruby/object:Gem::Version
-  version: 0.44.0
+  version: 0.45.0
 platform: ruby
 authors:
 - Thomas Leitner
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-06-05 00:00:00.000000000 Z
+date: 2024-06-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: cmdparse