idml 0.8.6 → 0.8.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '04038941020b897a48513a0386fe33c4108384351a40e47e4ea50c2f09709611'
-  data.tar.gz: 5e79b2dc7e0ec38818d06b74196bfb61227e4cb80c2e5989f8b836858469db70
+  metadata.gz: ea725628da813f202ff5f6c8c9659e1de20b24d8eb9d92c6cd8cc43aad12948c
+  data.tar.gz: 3ae66c7b8c22ba9660da4a8bae4a8f2314cb13e90aa72f0c673350415ab77cfc
 SHA512:
-  metadata.gz: 115565aeb1f5c1da58d7a94337b3a8243da2303b4e12b25516582a7cc94065752d54df398a4f02632067b3a2b9495449911b43ee85b410d23b6a90d27e33c2ca
-  data.tar.gz: 3754116e6abce4fb0481f8fdb02edb3452df9a0a6f7ff0417ca9500ab80155b91ceea0336a37d9defe41c75963c7040b75a2774f096fc5217285d57e19e6a41a
+  metadata.gz: e6ec5c19fb106644c373ee8a3cd21526cfaff1ce88c7d56d7c65b6376fe508ba984203d2d7d7249d426fc9486d21f5d7dbc1f758c026dd6f60c923631e31a4d8
+  data.tar.gz: 82cd84ff102aafce7c0766e1bb3aea5393a20f4d959753273ad163f15a9b83ab22a323c8b369548b45a3cc6d3e0ec5857eac1663ccdb601e9adb093c7067121e

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

@@ -1,12 +1,20 @@
 # TODO PDF 114: Text wrap around shapes (TextWrapPreference)
 
-## Status: PARTIAL — `Render::TextWrapResolver` computes BoundingBox-mode
-contours from page items declaring TextWrapPreference.
-`overlap_width(line_y, line_height, frame_x, frame_right)` returns the
-horizontal overlap for a text line. Rectangle now carries the
-TextWrapPreference child. Integration with TextFrameRenderer
-(per-line wrap width adjustment during layout) is the remaining work —
-requires line-by-line contour queries in the layout pipeline.
+## 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/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

@@ -66,16 +66,35 @@ module Idml
       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)
-        pref = item.text_wrap_preference if item.is_a?(Lutaml::Model::Serializable)
-        return nil unless pref
-        return nil if pref.text_wrap_mode.nil? ||
+        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

data/lib/idml/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: idml
 version: !ruby/object:Gem::Version
-  version: 0.8.6
+  version: 0.8.7
 platform: ruby
 authors:
 - Ribose