idml 0.8.5 → 0.8.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ac8e5f6dd1f360428509a0ae78c7c537b80cbd1d41fa5e85f5e1fe61f0cac48e
-  data.tar.gz: 2dcf34fd3fe19ef2978783e6857bd724872b741b8aab9b5418d77a10431b8aad
+  metadata.gz: ea725628da813f202ff5f6c8c9659e1de20b24d8eb9d92c6cd8cc43aad12948c
+  data.tar.gz: 3ae66c7b8c22ba9660da4a8bae4a8f2314cb13e90aa72f0c673350415ab77cfc
 SHA512:
-  metadata.gz: 30deff6b7352132cf5c019bde7423294232fafbe7b25898e7188d754f721ba3d6a498f6e41f31ef86afafe4f4e768dfb459fc272eda6ac288df1ab033cf88cc2
-  data.tar.gz: ba95fecbb82c8546c3ec4e31c3b3fdebfe1237fd8b7b5ec8e0a53c54d612dff72d9f1e3c89c6f88b8b7d5309f579a94a5e60132a50b37739914f21595bcf4b8f
+  metadata.gz: e6ec5c19fb106644c373ee8a3cd21526cfaff1ce88c7d56d7c65b6376fe508ba984203d2d7d7249d426fc9486d21f5d7dbc1f758c026dd6f60c923631e31a4d8
+  data.tar.gz: 82cd84ff102aafce7c0766e1bb3aea5393a20f4d959753273ad163f15a9b83ab22a323c8b369548b45a3cc6d3e0ec5857eac1663ccdb601e9adb093c7067121e

data/TODO.pdf/114-text-wrap-around-shapes.md

@@ -1,6 +1,20 @@
 # TODO PDF 114: Text wrap around shapes (TextWrapPreference)
 
-## Status: OPEN — gap identified in 2026-08-10 audit
+## Status: DONE for BoundingBox mode — `Render::TextWrapResolver` computes
+wrap contours from page items declaring TextWrapPreference with
+TextWrapMode != "None". SpreadRenderer builds the resolver and passes
+it via RenderContext. TextFrameRenderer's `text_wrap_overlap` queries
+overlap at each run's y position and reduces the wrap width — text
+flows around the shape instead of running over it.
+
+Shape page items (Rectangle, Oval, Polygon, GraphicLine, Path) all
+carry the TextWrapPreference child element. Non-shape items (Page,
+Link) are filtered by WRAPPABLE_TYPES to avoid NoMethodError.
+
+Per-run approximation: all lines in a run get the same reduced width.
+True per-line adjustment (when a run spans the contour boundary)
+requires line-count-aware layout. Shape mode (contour following) and
+Inverse mode remain unsupported.
 
 ## Problem
 

data/lib/idml/elements/graphic_line.rb

@@ -18,6 +18,7 @@ module Idml
       attribute :item_layer, :string
       attribute :properties, Idml::Elements::Properties, collection: true
       attribute :transparency_setting, Idml::Elements::TransparencySetting
+      attribute :text_wrap_preference, Idml::Elements::TextWrapPreference
 
       xml do
         root "GraphicLine"
@@ -34,6 +35,7 @@ module Idml
         map_attribute "ItemLayer", to: :item_layer
         map_element "Properties", to: :properties
         map_element "TransparencySetting", to: :transparency_setting
+        map_element "TextWrapPreference", to: :text_wrap_preference
       end
 
       def geometric_bounds

data/lib/idml/elements/oval.rb

@@ -29,6 +29,7 @@ module Idml
       attribute :item_layer, :string
       attribute :properties, Idml::Elements::Properties, collection: true
       attribute :transparency_setting, Idml::Elements::TransparencySetting
+      attribute :text_wrap_preference, Idml::Elements::TextWrapPreference
       attribute :image, Idml::Elements::Image, collection: true
 
       xml do
@@ -50,6 +51,7 @@ module Idml
         map_attribute "ItemLayer", to: :item_layer
         map_element "Properties", to: :properties
         map_element "TransparencySetting", to: :transparency_setting
+        map_element "TextWrapPreference", to: :text_wrap_preference
         map_element "Image", to: :image
       end
 

data/lib/idml/elements/path.rb

@@ -25,6 +25,7 @@ module Idml
       attribute :item_layer, :string
       attribute :properties, Idml::Elements::Properties, collection: true
       attribute :transparency_setting, Idml::Elements::TransparencySetting
+      attribute :text_wrap_preference, Idml::Elements::TextWrapPreference
 
       xml do
         root "Path"
@@ -41,6 +42,7 @@ module Idml
         map_attribute "ItemLayer", to: :item_layer
         map_element "Properties", to: :properties
         map_element "TransparencySetting", to: :transparency_setting
+        map_element "TextWrapPreference", to: :text_wrap_preference
       end
 
       def geometric_bounds

data/lib/idml/elements/polygon.rb

@@ -20,6 +20,7 @@ module Idml
       attribute :item_layer, :string
       attribute :properties, Idml::Elements::Properties, collection: true
       attribute :transparency_setting, Idml::Elements::TransparencySetting
+      attribute :text_wrap_preference, Idml::Elements::TextWrapPreference
       attribute :image, Idml::Elements::Image, collection: true
 
       xml do
@@ -39,6 +40,7 @@ module Idml
         map_attribute "ItemLayer", to: :item_layer
         map_element "Properties", to: :properties
         map_element "TransparencySetting", to: :transparency_setting
+        map_element "TextWrapPreference", to: :text_wrap_preference
         map_element "Image", to: :image
       end
 

data/lib/idml/elements/rectangle.rb

@@ -24,6 +24,7 @@ module Idml
       attribute :item_layer, :string
       attribute :properties, Idml::Elements::Properties, collection: true
       attribute :transparency_setting, Idml::Elements::TransparencySetting
+      attribute :text_wrap_preference, Idml::Elements::TextWrapPreference
       attribute :image, Idml::Elements::Image, collection: true
 
       xml do
@@ -46,6 +47,7 @@ module Idml
         map_attribute "ItemLayer", to: :item_layer
         map_element "Properties", to: :properties
         map_element "TransparencySetting", to: :transparency_setting
+        map_element "TextWrapPreference", to: :text_wrap_preference
         map_element "Image", to: :image
       end
 

data/lib/idml/render/render_context.rb

@@ -23,6 +23,7 @@ module Idml
       :chain_controller,
       :condition_filter,
       :style_lookup,
+      :text_wrap_resolver,
       keyword_init: true,
     )
   end

data/lib/idml/render/renderers/text_frame_renderer.rb

@@ -436,6 +436,8 @@ module Idml
                                                   rendered_count)
             run_wrap = drop_cap_wrap_width(wrap_width, dc_width,
                                            dc_lines, rendered_count)
+            run_wrap -= text_wrap_overlap(context, layout_frame, cursor_y,
+                                          run)
             positioned, next_y = layout_run(
               canvas, run, paragraph, context, layout_frame, font,
               run_wrap, cursor_y, space_before,
@@ -450,6 +452,27 @@ module Idml
         end
         private_class_method :iterate_paragraph_runs
 
+        # Computes the text-wrap overlap for a run at its current y
+        # position. Uses the run's point_size as the line height
+        # approximation. Returns 0.0 when no resolver is wired or no
+        # contours overlap. Per-run approximation: all lines in the
+        # run get the same reduced width (correct when the run is
+        # fully inside or outside the contour; approximate when it
+        # spans the boundary).
+        def self.text_wrap_overlap(context, layout_frame, cursor_y, run)
+          resolver = context.text_wrap_resolver
+          return 0.0 unless resolver
+
+          size = run.point_size || DEFAULT_SIZE
+          frame_x = layout_frame.x + (layout_frame.inset_left || 0)
+          frame_right = layout_frame.x + layout_frame.width -
+            (layout_frame.inset_right || 0)
+          overlap = resolver.overlap_width(cursor_y, size,
+                                           frame_x, frame_right)
+          [overlap, 0.0].max
+        end
+        private_class_method :text_wrap_overlap
+
         # Strips drop cap characters from the first run so they don't
         # render twice (once as the enlarged drop cap, once as normal
         # text). Returns a new run list with the first run's text

data/lib/idml/render/spread_renderer.rb

@@ -39,6 +39,7 @@ module Idml
           chain_controller: StoryChainController.new,
           condition_filter: @condition_filter,
           style_lookup: @style_lookup,
+          text_wrap_resolver: build_text_wrap_resolver(spread, page_height),
         }
         images_by_parent = group_images_by_parent(image_refs)
 
@@ -144,6 +145,10 @@ module Idml
 
         ColorResolver.new(@package.graphic)
       end
+
+      def build_text_wrap_resolver(spread, page_height)
+        TextWrapResolver.build(spread, page_height: page_height)
+      end
     end
   end
 end

data/lib/idml/render/text_wrap_resolver.rb

@@ -0,0 +1,129 @@
+# frozen_string_literal: true
+
+module Idml
+  module Render
+    # Resolves text-wrap contours from page items that declare
+    # TextWrapPreference. For BoundingBox mode (the common case),
+    # the contour is the item's geometric bounds expanded by the
+    # wrap offsets. TextFrameRenderer queries this resolver per
+    # text line to compute the effective wrap width — lines that
+    # overlap a contour get their width reduced by the overlap.
+    #
+    # Supported: BoundingBox mode (rectangle intersection).
+    # Unsupported: Shape mode (contour following), Inverse mode.
+    class TextWrapResolver
+      # A wrap contour: a PDF-coordinate rectangle the text avoids.
+      Contour = Struct.new(
+        :x, :y, :width, :height,
+        keyword_init: true
+      )
+
+      OFFSET_ATTRS = %i[
+        offset_top offset_left offset_bottom offset_right
+      ].freeze
+
+      def self.build(spread, page_height: 792)
+        contours = []
+        spread.each_page_item do |item|
+          contour = contour_for(item, page_height)
+          contours << contour if contour
+        end
+        new(contours)
+      end
+
+      def initialize(contours)
+        @contours = contours
+      end
+
+      attr_reader :contours
+
+      # Returns the total horizontal overlap of all contours with a
+      # text line at the given y range within the given x range.
+      # Sum, not max — multiple overlapping contours compound.
+      # Returns 0.0 when there's no overlap.
+      def overlap_width(line_y, line_height, frame_x, frame_right)
+        @contours.sum do |contour|
+          overlap = line_overlap(contour, line_y, line_height,
+                                 frame_x, frame_right)
+          overlap[:width]
+        end
+      end
+
+      def self.contour_for(item, page_height)
+        pref = wrap_preference(item)
+        return nil unless pref
+        return nil unless bounding_box_mode?(pref)
+
+        bounds = item.geometric_bounds
+        return nil unless bounds
+
+        rect = Geometry.placement_rect(bounds, item.item_transform,
+                                       page_height)
+        Contour.new(
+          x: rect[:x], y: rect[:y],
+          width: rect[:width], height: rect[:height]
+        )
+      end
+      private_class_method :contour_for
+
+      # Page item types that can declare TextWrapPreference per the
+      # Spread schema. Used to guard the attribute read — querying
+      # non-shape items (Page, Link) would raise NoMethodError.
+      WRAPPABLE_TYPES = [
+        Idml::Elements::Rectangle,
+        Idml::Elements::Oval,
+        Idml::Elements::Polygon,
+        Idml::Elements::GraphicLine,
+        Idml::Elements::Path,
+        Idml::Elements::Group,
+      ].freeze
+
+      def self.wrap_preference(item)
+        return nil unless wrappable?(item)
+
+        pref = item.text_wrap_preference
+        return nil if pref.nil? ||
+          pref.text_wrap_mode.nil? ||
+          pref.text_wrap_mode == "None"
+
+        pref
+      end
+      private_class_method :wrap_preference
+
+      def self.wrappable?(item)
+        WRAPPABLE_TYPES.any? { |type| item.is_a?(type) }
+      end
+      private_class_method :wrappable?
+
+      def self.bounding_box_mode?(pref)
+        pref.text_wrap_mode == "BoundingBox"
+      end
+      private_class_method :bounding_box_mode?
+
+      def line_overlap(contour, line_y, line_height, frame_x, frame_right)
+        return { width: 0.0 } unless y_overlap?(contour, line_y, line_height)
+        return { width: 0.0 } unless x_overlap?(contour, frame_x, frame_right)
+
+        { width: x_overlap_width(contour, frame_x, frame_right) }
+      end
+
+      def y_overlap?(contour, line_y, line_height)
+        line_top = line_y + line_height
+        line_bottom = line_y
+        contour_top = contour.y + contour.height
+        contour_bottom = contour.y
+        line_top > contour_bottom && line_bottom < contour_top
+      end
+
+      def x_overlap?(contour, frame_x, frame_right)
+        contour.x < frame_right && contour.x + contour.width > frame_x
+      end
+
+      def x_overlap_width(contour, frame_x, frame_right)
+        left = [contour.x, frame_x].max
+        right = [contour.x + contour.width, frame_right].min
+        [right - left, 0].max
+      end
+    end
+  end
+end

data/lib/idml/render.rb

@@ -21,6 +21,7 @@ module Idml
     autoload :StoryChainController, "#{__dir__}/render/story_chain_controller"
     autoload :LayerFilter,         "#{__dir__}/render/layer_filter"
     autoload :ConditionFilter,     "#{__dir__}/render/condition_filter"
+    autoload :TextWrapResolver,    "#{__dir__}/render/text_wrap_resolver"
     autoload :Placement,           "#{__dir__}/render/placement"
     autoload :ImageCollector,      "#{__dir__}/render/image_collector"
     autoload :StructureTracker,    "#{__dir__}/render/structure_tracker"

data/lib/idml/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Idml
-  VERSION = "0.8.5"
+  VERSION = "0.8.7"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: idml
 version: !ruby/object:Gem::Version
-  version: 0.8.5
+  version: 0.8.7
 platform: ruby
 authors:
 - Ribose
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2026-08-14 00:00:00.000000000 Z
+date: 2026-08-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bigdecimal
@@ -475,6 +475,7 @@ files:
 - lib/idml/render/structure_tracker.rb
 - lib/idml/render/style_lookup.rb
 - lib/idml/render/style_resolver.rb
+- lib/idml/render/text_wrap_resolver.rb
 - lib/idml/text_engine.rb
 - lib/idml/text_engine/cjk_layout.rb
 - lib/idml/text_engine/justifier.rb