hexapdf 0.34.1 → 0.35.0

data/lib/hexapdf/layout/style.rb

@@ -577,7 +577,7 @@ module HexaPDF
       # equivalent to the property names.
       #
       # Example:
-      #   Style.new(font_size: 15, align: :center, valign: center)
+      #   Style.new(font_size: 15, text_align: :center, text_valign: center)
       def initialize(**properties)
         update(**properties)
         @scaled_item_widths = {}.compare_by_identity
@@ -946,9 +946,9 @@ module HexaPDF
       #                 text_rendering_mode: :stroke)
 
       ##
-      # :method: align
+      # :method: text_align
       # :call-seq:
-      #   align(direction = nil)
+      #   text_align(direction = nil)
       #
       # The horizontal alignment of text, defaults to :left.
       #
@@ -964,15 +964,15 @@ module HexaPDF
       #   #>pdf-composer100
       #   text = "Lorem ipsum dolor sit amet. " * 2
       #   composer.style(:base, border: {width: 1})
-      #   composer.text(text, align: :left)
-      #   composer.text(text, align: :center)
-      #   composer.text(text, align: :right)
-      #   composer.text(text, align: :justify)
+      #   composer.text(text, text_align: :left)
+      #   composer.text(text, text_align: :center)
+      #   composer.text(text, text_align: :right)
+      #   composer.text(text, text_align: :justify)
 
       ##
-      # :method: valign
+      # :method: text_valign
       # :call-seq:
-      #   valign(direction = nil)
+      #   text_valign(direction = nil)
       #
       # The vertical alignment of items (normally text) inside a text box, defaults to :top.
       #
@@ -991,9 +991,9 @@ module HexaPDF
       #
       #   #>pdf-composer100
       #   composer.style(:base, border: {width: 1})
-      #   composer.text("Top aligned", height: 20, valign: :top)
-      #   composer.text("Center aligned", height: 20, valign: :center)
-      #   composer.text("Bottom aligned", valign: :bottom)
+      #   composer.text("Top aligned", height: 20, text_valign: :top)
+      #   composer.text("Center aligned", height: 20, text_valign: :center)
+      #   composer.text("Bottom aligned", text_valign: :bottom)
 
       ##
       # :method: text_indent
@@ -1214,84 +1214,186 @@ module HexaPDF
       # :call-seq:
       #   position(value = nil)
       #
-      # Specifies how a box should be positioned in a frame. The property #position_hint provides
-      # additional, position specific data. Defaults to :default.
+      # Specifies how a box should be positioned in a frame. Defaults to :default.
+      #
+      # The properties #align and #valign provide alignment information while #mask_mode defines how
+      # the to-be-removed region should be constructed.
       #
       # Possible values:
       #
-      # :default:: Position the box at the current position. The exact horizontal position is given
-      #            via the position hint. Space to the left/right of the box can't be used for other
-      #            boxes.
+      # :default::
+      #     Position the box at the current position. The exact horizontal and vertical position
+      #     inside the current region is given via the #align and #valign style properties.
+      #
+      #     Examples:
+      #
+      #       #>pdf-composer100
+      #       composer.box(:base, width: 40, height: 20,
+      #                    style: {align: :right, border: {width: 1}})
+      #       composer.box(:base, width: 40, height: 20,
+      #                    style: {align: :center, valign: :center, border: {width: 1}})
+      #
+      # :float::
+      #     This is the same as :default except that the used value for #mask_mode when it is set to
+      #     :default is :box instead of :fill_frame_horizontal.
+      #
+      #     Examples:
+      #
+      #       #>pdf-composer100
+      #       composer.box(:base, width: 40, height: 20,
+      #                    style: {position: :float, border: {width: 1}})
+      #       composer.box(:base, width: 40, height: 20,
+      #                    style: {position: :float, border: {color: "hp-blue", width: 1}})
+      #
+      # :flow::
+      #     Flows the content of the box inside the frame around objects.
+      #
+      #     A box needs to indicate whether it supports this value by implementing the
+      #     #supports_position_flow? method and returning +true+ if it does or +false+ if it
+      #     doesn't. If a box doesn't support this value, it is positioned as if the value :default
+      #     was set.
+      #
+      #     Note that the properties #align and #valign are not used with this value!
       #
-      # :float:: Position the box at the current position but let it "float" so that the space to
-      #          the left/right can still be used. The position hint specifies where the box should
-      #          float.
+      #     Examples:
       #
-      # :flow:: Flows the content of the box inside the frame around objects.
+      #       #>pdf-composer100
+      #       composer.box(:base, width: 40, height: 20,
+      #                    style: {position: :float, border: {width: 1}})
+      #       composer.lorem_ipsum(position: :flow)
       #
-      #         A box needs to indicate whether it supports this value by implementing the
-      #         #supports_position_flow? method and returning +true+ if it does or +false+ if it
-      #         doesn't.
+      # [x, y]::
+      #     Position the box with the bottom left corner at the given absolute position relative to
+      #     the bottom left corner of the frame.
       #
-      # :absolute:: Position the box at an absolute position relative to the frame. The coordinates
-      #             are given via the position hint.
+      #     Examples:
       #
-      # See #position_hint for examples
+      #       #>pdf-composer100
+      #       composer.text('Absolute', position: [50, 50], border: {width: 1})
+      #       draw_current_frame_shape("red")
 
       ##
-      # :method: position_hint
+      # :method: align
       # :call-seq:
-      #   position_hint(value = nil)
+      #   align(value = nil)
+      #
+      # Specifies the horizontal alignment of a box inside the current region. Defaults to :left.
+      #
+      # Possible values:
+      #
+      # :left:: Align the box to the left side of the current region.
+      # :center:: Horizontally center the box in the current region.
+      # :right:: Align the box to the right side of the current region.
+      #
+      # Examples:
       #
-      # Specifies additional information on how a box should be positioned in a frame. The exact
-      # meaning depends on the value of the #position property.
+      #   #>pdf-composer100
+      #   composer.text("Left", border: {width: 1})
+      #   draw_current_frame_shape("hp-blue")
+      #   composer.text("Center", align: :center, border: {width: 1})
+      #   draw_current_frame_shape("hp-orange")
+      #   composer.text("Right", align: :right, border: {width: 1})
+      #   draw_current_frame_shape("hp-teal")
+
+      ##
+      # :method: valign
+      # :call-seq:
+      #   valign(value = nil)
       #
-      # Possible values depending on the #position property:
+      # Specifies the vertical alignment of a box inside the current region. Defaults to :top.
+      #
+      # Possible values:
+      #
+      # :top:: Align the box to the top side of the current region.
+      # :center:: Vertically center the box in the current region.
+      # :bottom:: Align the box to the bottom side of the current region.
+      #
+      # Examples:
+      #
+      #   #>pdf-composer100
+      #   composer.text("Top", mask_mode: :fill_vertical, border: {width: 1})
+      #   composer.text("Center", valign: :center, mask_mode: :fill_vertical, border: {width: 1})
+      #   composer.text("Bottom", valign: :bottom, border: {width: 1})
+
+      ##
+      # :method: mask_mode
+      # :call-seq:
+      #   mask_mode(value = nil)
+      #
+      # Specifies how the mask defining the to-be-removed region should be constructed. Defaults to
+      # :default.
+      #
+      # Possible values:
       #
       # :default::
+      #     The actually used value depends on the value of #position:
       #
-      #   :left:: (default) Align the box to the left side of the available region.
-      #   :center:: Horizontally center the box in the available region.
-      #   :right:: Align the box to the right side of the available region.
+      #     * For :default the used value is :fill_frame_horizontal.
+      #     * For :float the used value is :box.
+      #     * For :flow the used value is :fill_frame_horizontal.
+      #     * For :absolute the used value is :box.
       #
-      #   Examples:
+      # :none::
+      #     The mask covers nothing (useful for layering boxes over each other).
       #
-      #     #>pdf-composer100
-      #     composer.text("Left", border: {width: 1})
-      #     draw_current_frame_shape("red")
-      #     composer.text("Center", position_hint: :center, border: {width: 1})
-      #     draw_current_frame_shape("blue")
-      #     composer.text("Right", position_hint: :right, border: {width: 1})
-      #     draw_current_frame_shape("green")
+      #     Examples:
       #
-      # :float::
+      #       #>pdf-composer100
+      #       composer.text('Text on bottom', mask_mode: :none)
+      #       composer.text('Text on top', fill_color: 'hp-blue')
+      #
+      # :box::
+      #     The mask covers the box including the margin around the box.
+      #
+      #     Examples:
+      #
+      #       #>pdf-composer100
+      #       composer.text('Box only mask', mask_mode: :box)
+      #       draw_current_frame_shape('hp-blue')
+      #       composer.text('Text to the right')
+      #
+      # :fill_horizontal::
+      #     The mask covers the box including the margin around the box and the space to the left
+      #     and right in the current region.
       #
-      #   :left:: (default) Float the box to the left side of the available region.
-      #   :center:: Float the box to the center of the available region.
-      #   :right::  Float the box to the right side of the available region.
+      #     Examples:
       #
-      #   Examples:
+      #       #>pdf-composer100
+      #       composer.text('Standard, whole horizontal space')
+      #       draw_current_frame_shape('hp-blue')
+      #       composer.text('Text underneath')
       #
-      #     #>pdf-composer100
-      #     composer.style(:base, position: :float, border: {width: 1})
-      #     composer.text("Left", position_hint: :left)
-      #     draw_current_frame_shape("red")
-      #     composer.text("Center", position_hint: :center)
-      #     draw_current_frame_shape("blue")
-      #     composer.text("Right", position_hint: :right)
-      #     draw_current_frame_shape("green")
+      # :fill_frame_horizontal::
+      #     The mask covers the box including the margin around the box and the space to the left
+      #     and right in the frame.
       #
-      # :absolute::
+      #     Examples:
       #
-      #    An array with the x- and y-coordinates of the bottom left corner of the absolutely
-      #    positioned box. The coordinates are taken as being relative to the bottom left corner of
-      #    the frame into which the box is drawn.
+      #       #>pdf-composer100
+      #       composer.frame.remove_area(Geom2D::Rectangle(100, 50, 10, 50))
+      #       composer.text('Mask covers frame horizontally', mask_mode: :fill_frame_horizontal)
+      #       draw_current_frame_shape('hp-blue')
+      #       composer.text('Text underneath')
       #
-      #    Examples:
+      # :fill_vertical::
+      #     The mask covers the box including the margin around the box and the space to the top
+      #     and bottom in the current region.
       #
-      #      #>pdf-composer100
-      #      composer.text("Absolute", position: :absolute, position_hint: [30, 40])
-      #      draw_current_frame_shape("red")
+      #     Examples:
+      #
+      #       #>pdf-composer100
+      #       composer.text('Mask covers vertical space', mask_mode: :fill_vertical)
+      #       draw_current_frame_shape('hp-blue')
+      #       composer.text('Text to the right')
+      #
+      # :fill::
+      #     The mask covers the current region completely.
+      #
+      #     Examples:
+      #
+      #       #>pdf-composer100
+      #       composer.text('Mask covers everything', mask_mode: :fill)
+      #       composer.text('On the next page')
 
       [
         [:font, "raise HexaPDF::Error, 'No font set'"],
@@ -1324,8 +1426,8 @@ module HexaPDF
         [:stroke_miter_limit, 10.0],
         [:stroke_dash_pattern, "Content::LineDashPattern.new",
          {setter: "Content::LineDashPattern.normalize(value, phase)", extra_args: ", phase = 0"}],
-        [:align, :left, {valid_values: [:left, :center, :right, :justify]}],
-        [:valign, :top, {valid_values: [:top, :center, :bottom]}],
+        [:text_align, :left, {valid_values: [:left, :center, :right, :justify]}],
+        [:text_valign, :top, {valid_values: [:top, :center, :bottom]}],
         [:text_indent, 0],
         [:line_spacing, "LineSpacing.new(type: :single)",
          {setter: "LineSpacing.new(**(value.kind_of?(Symbol) || value.kind_of?(Numeric) ? " \
@@ -1340,8 +1442,11 @@ module HexaPDF
         [:border, "Border.new", {setter: "Border.new(**value)"}],
         [:overlays, "Layers.new", {setter: "Layers.new(value)"}],
         [:underlays, "Layers.new", {setter: "Layers.new(value)"}],
-        [:position, :default, {valid_values: [:default, :float, :flow, :absolute]}],
-        [:position_hint, nil],
+        [:position, :default],
+        [:align, :left, {valid_values: [:left, :center, :right]}],
+        [:valign, :top, {valid_values: [:top, :center, :bottom]}],
+        [:mask_mode, :default, {valid_values: [:default, :none, :box, :fill_horizontal,
+                                               :fill_frame_horizontal, :fill_vertical, :fill]}],
       ].each do |name, default, options = {}|
         default = default.inspect unless default.kind_of?(String)
         setter = options.delete(:setter) || "value"

data/lib/hexapdf/layout/table_box.rb

@@ -112,8 +112,8 @@ module HexaPDF
     # Each table can have header rows and footer rows which are shown for all split parts:
     #
     #  #>pdf-composer
-    #  header = lambda {|tb| [[{content: layout.text('Header', align: :center), col_span: 2}]] }
-    #  footer = lambda {|tb| [[layout.text('left'), layout.text('right', align: :right)]] }
+    #  header = lambda {|tb| [[{content: layout.text('Header', text_align: :center), col_span: 2}]] }
+    #  footer = lambda {|tb| [[layout.text('left'), layout.text('right', text_align: :right)]] }
     #  cells = [[layout.text('A'), layout.text('B')],
     #           [layout.text('C'), layout.text('D')],
     #           [layout.text('E'), layout.text('F')]]
@@ -588,7 +588,7 @@ module HexaPDF
         super && (!@last_fitted_row_index || @last_fitted_row_index < 0)
       end
 
-      # Fits the table into the available space.
+      # Fits the table into the current region of the frame.
       def fit(available_width, available_height, frame)
         return false if (@initial_width > 0 && @initial_width > available_width) ||
           (@initial_height > 0 && @initial_height > available_height)

data/lib/hexapdf/layout/text_box.rb

@@ -68,9 +68,9 @@ module HexaPDF
 
       # Fits the text box into the Frame.
       #
-      # Depending on the 'position' style property, the text is either fit into the rectangular area
-      # given by +available_width+ and +available_height+, or fit to the outline of the frame
-      # starting from the top (when 'position' is set to :flow).
+      # 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).
       #
       # The spacing after the last line can be controlled via the style property +last_line_gap+.
       #
@@ -90,12 +90,12 @@ module HexaPDF
                     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.align == :center || style.align == :right
+        @width += if @initial_width > 0 || style.text_align == :center || style.text_align == :right
                     width
                   else
                     @result.lines.max_by(&:width)&.width || 0
                   end
-        @height += if @initial_height > 0 || style.valign == :center || style.valign == :bottom
+        @height += if @initial_height > 0 || style.text_valign == :center || style.text_valign == :bottom
                      height
                    else
                      @result.height

data/lib/hexapdf/layout/text_fragment.rb

@@ -70,6 +70,56 @@ module HexaPDF
         TextShaper.new.shape_text(fragment)
       end
 
+      # :call-seq:
+      #   TextFragment.create_with_fallback_glyphs(text, style)                      -> [frag]
+      #   TextFragment.create_with_fallback_glyphs(text, style) {|codepoint| block } -> [frag1, frag2, ...]
+      #
+      # Creates one or more TextFragment objects for the given text - possibly using glyphs from
+      # fallback fonts -, shapes them and returns them.
+      #
+      # If no block is given, the method works like #create but returns the text fragment inside an
+      # array.
+      #
+      # If a block is given, the text is split on codepoints for which there is no glyph in the
+      # style's font. For the parts with valid glyphs TextFragment objects are created like with
+      # #create. Each codepoint without a valid glyph is yielded to the given block together with
+      # the associated HexaPDF::Font::InvalidGlyph object as arguments. The block needs to return an
+      # array of either HexaPDF::Font::Type1Wrapper::Glyph or HexaPDF::Font::TrueTypeWrapper::Glyph
+      # objects. This array is then used for creating a TextFragment object.
+      #
+      # The needed style of the text fragments is specified by the +style+ argument (see
+      # Style::create for details). Note that the resulting style object needs at least the font
+      # set.
+      def self.create_with_fallback_glyphs(text, style)
+        return [create(text, style)] if !block_given? || text.empty?
+
+        style = Style.create(style)
+        styles = Hash.new {|h, k| h[k] = style.dup.font(k) }
+        styles[style.font] = style
+
+        result = []
+        items = []
+        shaper = TextShaper.new
+        font = style.font
+        text.each_codepoint do |codepoint|
+          glyph = font.decode_codepoint(codepoint)
+          if glyph.valid? || glyph.control_char?
+            items << glyph
+          else
+            unless items.empty?
+              result << shaper.shape_text(new(items, style))
+              items = []
+            end
+            fallback = yield(codepoint, glyph)
+            unless fallback.empty?
+              result << shaper.shape_text(new(fallback, styles[fallback.first.font_wrapper]))
+            end
+          end
+        end
+        result << shaper.shape_text(new(items, style)) unless items.empty?
+        result
+      end
+
       # The items (glyphs and kerning values) of the text fragment.
       attr_accessor :items
 

data/lib/hexapdf/layout/text_layouter.rb

@@ -662,8 +662,9 @@ module HexaPDF
 
       # The style to be applied.
       #
-      # Only the following properties are used: Style#text_indent, Style#align, Style#valign,
-      # Style#line_spacing, Style#text_segmentation_algorithm, Style#text_line_wrapping_algorithm
+      # Only the following properties are used: Style#text_indent, Style#text_align,
+      # Style#text_valign, Style#line_spacing, Style#fill_horizontal,
+      # Style#text_segmentation_algorithm, Style#text_line_wrapping_algorithm
       attr_reader :style
 
       # Creates a new TextLayouter object with the given style.
@@ -910,9 +911,9 @@ module HexaPDF
         end
       end
 
-      # Returns the initial baseline offset from the top, based on the valign style option.
+      # Returns the initial baseline offset from the top, based on the text_valign style property.
       def initial_baseline_offset(lines, height, actual_height)
-        case style.valign
+        case style.text_valign
         when :top
           lines.first.y_max
         when :center
@@ -922,9 +923,9 @@ module HexaPDF
         end
       end
 
-      # Returns the horizontal offset from the left side, based on the align style option.
+      # Returns the horizontal offset from the left side, based on the text_align style property.
       def horizontal_alignment_offset(line, available_width)
-        case style.align
+        case style.text_align
         when :left then 0
         when :center then (available_width - line.width) / 2
         when :right then available_width - line.width

data/lib/hexapdf/object.rb

@@ -303,6 +303,11 @@ module HexaPDF
         return false unless auto_correct
       end
       result
+    rescue HexaPDF::Error
+      raise
+    rescue
+      yield("Error: Unexpected value encountered", false, self) if block_given?
+      false
     end
 
     # Makes a deep copy of the source PDF object and resets the object identifier.
@@ -424,8 +429,6 @@ module HexaPDF
         yield("Object must be an indirect object", true)
         document.add(self)
       end
-
-      validate_nested(value, &block)
     end
 
     # Validates all nested values of the object, i.e. values inside collection objects.

data/lib/hexapdf/pdf_array.rb

@@ -212,6 +212,11 @@ module HexaPDF
       data
     end
 
+    def perform_validation(&block) # :nodoc:
+      super
+      each {|element| validate_nested(element, &block) }
+    end
+
   end
 
 end

data/lib/hexapdf/type/acro_form/appearance_generator.rb

@@ -361,12 +361,16 @@ module HexaPDF
           value, text_color = apply_javascript_formatting(@field.field_value)
           style.fill_color = text_color if text_color
           calculate_and_apply_font_size(value, style, width, height, padding)
-          fragment = HexaPDF::Layout::TextFragment.create(value, style)
+          line = HexaPDF::Layout::Line.new(@document.layout.text_fragments(value, style: style))
 
-          if @field.concrete_field_type == :comb_text_field
+          if @field.concrete_field_type == :comb_text_field && !value.empty?
             unless @field.key?(:MaxLen)
               raise HexaPDF::Error, "Missing or invalid dictionary field /MaxLen for comb text field"
             end
+            unless line.items.size == 1
+              raise HexaPDF::Error, "Fallback glyphs are not yet supported with comb text fields"
+            end
+            fragment = line.items[0]
             new_items = []
             cell_width = width.to_f / @field[:MaxLen]
             scaled_cell_width = cell_width / style.scaled_font_size.to_f
@@ -376,6 +380,7 @@ module HexaPDF
             new_items << fragment.items.last
             fragment.items.replace(new_items)
             fragment.clear_cache
+            line.clear_cache
             # Adobe always seems to add 1 to the first offset...
             x_offset = 1 + (cell_width - style.scaled_item_width(fragment.items[0])) / 2.0
             x = case @field.text_alignment
@@ -387,8 +392,8 @@ module HexaPDF
             # Adobe seems to be left/right-aligning based on twice the border width
             x = case @field.text_alignment
                 when :left then 2 * padding
-                when :right then [width - 2 * padding - fragment.width, 2 * padding].max
-                when :center then [(width - fragment.width) / 2.0, 2 * padding].max
+                when :right then [width - 2 * padding - line.width, 2 * padding].max
+                when :center then [(width - line.width) / 2.0, 2 * padding].max
                 end
           end
 
@@ -400,14 +405,14 @@ module HexaPDF
             style.font_size
           y = padding + (height - 2 * padding - cap_height) / 2.0
           y = padding - style.scaled_font_descender if y < 0
-          fragment.draw(canvas, x, y)
+          line.each {|fragment, fx, _| fragment.draw(canvas, x + fx, y) }
         end
 
         # Draws multiple lines  of text inside the widget's rectangle.
         def draw_multiline_text(canvas, width, height, style, padding)
-          items = [Layout::TextFragment.create(@field.field_value, style)]
+          items = @document.layout.text_fragments(@field.field_value, style: style)
           layouter = Layout::TextLayouter.new(style)
-          layouter.style.align(@field.text_alignment).line_spacing(:proportional, 1.25)
+          layouter.style.text_align(@field.text_alignment).line_spacing(:proportional, 1.25)
 
           result = nil
           if style.font_size == 0 # need to auto-size text
@@ -437,12 +442,12 @@ module HexaPDF
 
           option_items = @field.option_items
           top_index = @field.list_box_top_index
-          items = [Layout::TextFragment.create(option_items[top_index..-1].join("\n"), style)]
+          items = @document.layout.text_fragments(option_items[top_index..-1].join("\n"), style: style)
           # Should use /I but if it differs from /V, we need to use /V; so just use /V...
           indices = [@field.field_value].flatten.compact.map {|val| option_items.index(val) }
 
           layouter = Layout::TextLayouter.new(style)
-          layouter.style.align(@field.text_alignment).line_spacing(:proportional, 1.25)
+          layouter.style.text_align(@field.text_alignment).line_spacing(:proportional, 1.25)
           result = layouter.fit(items, width - 4 * padding, height)
 
           unless result.lines.empty?
@@ -490,8 +495,8 @@ module HexaPDF
             font.scaling_factor / 1000.0
           # The constant factor was found empirically by checking what Adobe Reader etc. do
           style.font_size = (height - 2 * padding) / unit_font_size * 0.85
-          fragment = HexaPDF::Layout::TextFragment.create(value, style)
-          style.font_size = [style.font_size, style.font_size * (width - 4 * padding) / fragment.width].min
+          calc_width = @document.layout.text_fragments(value, style: style).sum(&:width)
+          style.font_size = [style.font_size, style.font_size * (width - 4 * padding) / calc_width].min
           style.clear_cache
         end
 

data/lib/hexapdf/utils/sorted_tree_node.rb

@@ -307,16 +307,6 @@ module HexaPDF
         super
         container_name = leaf_node_container_name
 
-        # All kids entries must be indirect objects
-        if key?(:Kids)
-          self[:Kids].each_with_index do |kid, index|
-            unless kid.kind_of?(HexaPDF::Object) && kid.indirect?
-              yield("Child entries of sorted tree nodes must be indirect objects", true)
-              value[:Kids][index] = document.add(kid)
-            end
-          end
-        end
-
         # All keys of the container must be lexically ordered strings and the container must be
         # correctly formatted
         if key?(container_name)

data/lib/hexapdf/version.rb

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

data/test/hexapdf/content/test_canvas.rb

@@ -756,6 +756,28 @@ describe HexaPDF::Content::Canvas do
     end
   end
 
+  describe "form" do
+    it "uses the context dimensions if none are given" do
+      form = @canvas.form
+      assert_equal(@canvas.context.box.value, form.box.value)
+    end
+
+    it "uses the provided dimensions" do
+      form = @canvas.form(300, 200)
+      assert_equal([0, 0, 300, 200], form.box.value)
+    end
+
+    it "yields the canvas for defining the form's content" do
+      yielded_canvas = nil
+      form = @canvas.form {|canvas| yielded_canvas = canvas }
+      assert_equal(form.canvas, yielded_canvas)
+    end
+
+    it "raises an ArgumentError if only one of width/height is provided" do
+      assert_raises(ArgumentError) { @canvas.form(20) }
+    end
+  end
+
   describe "graphic_object" do
     it "returns a new graphic object given a name" do
       arc = @canvas.graphic_object(:arc)
@@ -1329,6 +1351,21 @@ describe HexaPDF::Content::Canvas do
     end
   end
 
+  describe "composer" do
+    it "creates a CanvasComposer, yields it and returns it" do
+      comp1 = nil
+      comp2 = @canvas.composer {|composer| comp1 = composer }
+      assert_kind_of(HexaPDF::Content::CanvasComposer, comp1)
+      assert_same(comp1, comp2)
+      assert_same(@canvas, comp1.canvas)
+    end
+
+    it "passes on the margin argument" do
+      comp = @canvas.composer(margin: 20)
+      assert_equal(20, comp.frame.x)
+    end
+  end
+
   describe "color_from_specification "do
     it "accepts a color string" do
       assert_equal([1, 0, 0], @canvas.color_from_specification("red").components)