idml 0.10.13 → 0.10.14

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2f2a7b73c56645a87269780fc0cab9f998f5a6bf0d167b0ce9433dba9a8019cd
-  data.tar.gz: e4bb1522273937a4c2cf5631de1927f4583f63d16f2b351f893921407d89dc88
+  metadata.gz: 00f5eb099cc78c69be52672e179bc0d2c10b102554bb74b28272b04d0ed904c6
+  data.tar.gz: c7936ca3c76fef90639d532cc70c0deb7423b2dcd9cd3d73ce6b88bff5a1257c
 SHA512:
-  metadata.gz: 83756750d549a02ff7080686509ac45acce77405db6c9d3ba0ee6dae3643622b8eb89198d28fead77047dac50bdcf9491bdab05b7e03d02e18560f1021fa5360
-  data.tar.gz: 8a9fc59030029b4342019b205f9fe7da46ae6296729d641c49c199391cd5765ffea195dfca6cde46ff0df6518f496dcf9a1b66dc5dad0b808503230be8057107
+  metadata.gz: 354bb00de55fe629d84853a8e1dfdc2c8b821f708fc15584cf9ac509ba3489a56f92f48f71698cfcf9b28c9f3814b4c0366f3a88d40aa3e2e05b33b242e20a60
+  data.tar.gz: 52cc665c20cdf7c8c766593e38fd18b847f15da0ac3a09b1accfd5dbbe2b48614a7eadb5452b8f4b295bff1870c7a2acb1a48a0c03174f15916f681d62c4a16c

data/TODO.pdf/152-rtl-alignment.md

@@ -0,0 +1,27 @@
+# TODO PDF 152: RTL paragraph alignment
+
+## Status: COMPLETE — implemented 2026-08-31
+
+## Problem
+
+ParagraphDirection (LeftToRightDirection /
+RightToLeftDirection) was parsed but unused: RTL paragraphs
+aligned left/right by LTR convention, so Arabic/Hebrew text sat
+on the wrong edge.
+
+## Solution
+
+`StyleResolver::Paragraph` carries `paragraph_direction` (PSR or
+paragraph style); `TextEngine::Justifier` gains a `direction:`
+argument that mirrors the visual alignment under
+RightToLeftDirection — left↔right, start↔end; center and
+justified unchanged. Both justify call sites (frame renderer and
+footnote layout) pass the paragraph's direction.
+
+## Files
+
+- `lib/idml/text_engine/justifier.rb`
+- `lib/idml/render/style_resolver.rb`
+- `lib/idml/render/renderers/text_frame_renderer.rb`
+- `lib/idml/render/footnote.rb`
+- `spec/idml/text_engine/text_engine_spec.rb`

data/TODO.pdf/153-vertical-keeps.md

@@ -0,0 +1,31 @@
+# TODO PDF 153: Keep options in vertical writing
+
+## Status: COMPLETE (approximation) — implemented 2026-08-31
+
+## Problem
+
+Keep options (TODOs 123/127/133) applied only to the horizontal
+engine; vertical paragraphs split across frames regardless of
+KeepAllLinesTogether / KeepWithNext.
+
+## Solution
+
+`VerticalEmit.vertical_render` consults a keep check BEFORE
+placing each paragraph (deferral after placement cannot un-emit):
+
+- **KeepAllLinesTogether** defers the paragraph wholly to the
+  next frame when its column need exceeds the remaining columns.
+- **KeepWithNext** also defers when the follower's forced break
+  or column need would strand it.
+- Never defers the frame's first paragraph — the same progress
+  guarantee as KeepPolicy (shared: `KeepPolicy.paragraph_break?`).
+
+Approximation: column need = runs count (one column per run),
+which under-estimates runs spanning several columns — deferral
+errs toward placing. KeepFirstLines/KeepLastLines windows remain
+horizontal-only (they are line-window concepts).
+
+## Files
+
+- `lib/idml/render/renderers/vertical_emit.rb`
+- `spec/idml/render/vertical_render_spec.rb`

data/TODO.pdf/61-known-limitations.md

@@ -1,6 +1,6 @@
 # TODO PDF 61: Known limitations and future work
 
-## Status: DOCUMENTED — refreshed 2026-08-28
+## Status: DOCUMENTED — refreshed 2026-08-31
 
 Previously listed limitations (font embedding, tagged PDF, per-run
 styling, dead code) were resolved by TODOs 52/53/55/67/76 long ago;
@@ -14,8 +14,9 @@ this list reflects the current state.
   wrap after explicit hyphens (TODO 139).
 - **Justification**: word/letter spacing caps apply (TODO 119),
   MaximumGlyphScaling stretches (TODO 129) and MinimumGlyphScaling
-  compresses overlong lines (TODO 135); ToBinding / RTL binding
-  alignment is not applied.
+  compresses overlong lines (TODO 135); RTL paragraphs mirror
+  left/right alignment (TODO 152); ToBinding / kashida-based
+  Arabic justification is not applied.
 - **Keep options**: KeepAllLinesTogether (TODO 123), KeepWithNext
   (TODO 127), and the KeepFirstLines / KeepLastLines windows
   (TODO 133, line-count approximation) are honored.
@@ -39,8 +40,9 @@ this list reflects the current state.
   Desired applies per class pair) are applied; Minimum/Maximum
   aki bounds and CompressionPriority are parsed but unused.
 - **Vertical mode**: Latin runs rotate as one group per segment
-  (TODO 142); ruby placement is beside-column; keep options do
-  not apply.
+  (TODO 142); ruby placement is beside-column; KeepAllLines /
+  KeepWithNext apply with a column-count approximation (TODO 153);
+  keep windows are horizontal-only.
 
 ### Structural features
 - **Endnotes** (TODO 117): reference markers render and endnote TEXT
@@ -62,5 +64,5 @@ this list reflects the current state.
 - Hyphenation dictionary integration
 - NextColumn wrap via column-jump chaining (multi-column frames)
 - Minimum/Maximum mojikumi aki bounds + CompressionPriority
-- ToBinding / RTL binding alignment
-- Vertical-mode keep options
+- ToBinding / kashida Arabic justification
+- Vertical keep windows (KeepFirstLines / KeepLastLines)

data/lib/idml/render/footnote.rb

@@ -138,6 +138,7 @@ module Idml
             TextEngine::Justifier.justify(
               line: line, frame_width: wrap_width,
               alignment: paragraph.alignment || :left,
+              direction: paragraph.paragraph_direction,
               last_line: last_line?(paragraph, run, index, lines),
               limits: limits
             )

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

@@ -853,7 +853,8 @@ module Idml
               line: line, frame_width: wrap_width,
               alignment: paragraph.alignment || :left,
               last_line: paragraph_last && index == lines.length - 1,
-              limits: limits
+              limits: limits,
+              direction: paragraph.paragraph_direction
             )
           end
         end

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

@@ -24,10 +24,20 @@ module Idml
           layout_frame = layout_frame(context.item, box)
           left_limit = layout_frame.x + (layout_frame.inset_left || 0)
           resume_vertical_paragraph(state)
-          next_column = state.column_offset || 0
+          entry_offset = state.column_offset || 0
+          next_column = entry_offset
           pending = 0
 
-          state.paragraphs.each do |paragraph|
+          state.paragraphs.each_with_index do |paragraph, index|
+            if vertical_keep_deferred?(paragraph, state.paragraphs[index + 1],
+                                       layout_frame, font, left_limit,
+                                       next_column, pending, entry_offset)
+              state.current_paragraph = nil
+              state.runs_remaining = []
+              state.column_offset = 0
+              break
+            end
+
             remaining_runs, next_column = vertical_paragraph(
               canvas, paragraph, context, layout_frame, font,
               left_limit, next_column
@@ -45,6 +55,64 @@ module Idml
           state.paragraphs = state.paragraphs[pending..]
         end
 
+        # Keep options in vertical mode (TODO 153, column-count
+        # approximation — one column per run under-estimates runs
+        # that span several columns, so deferral errs toward
+        # placing): KeepAllLinesTogether defers the paragraph
+        # wholly to the next frame; KeepWithNext also defers when
+        # the follower (or its forced break) would strand. Never
+        # defers the frame's first paragraph — the progress
+        # guarantee, shared with KeepPolicy.
+        def vertical_keep_deferred?(paragraph, next_paragraph,
+                                    layout_frame, _font, left_limit,
+                                    next_column, pending, entry_offset)
+          placed = pending.positive? || entry_offset.positive?
+          return false unless placed
+          return false unless keep_flagged?(paragraph)
+
+          needed = [paragraph.runs.length, 1].max
+          return true if paragraph.keep_all_lines_together &&
+            needed > vertical_room(layout_frame, paragraph, left_limit,
+                                   next_column)
+
+          with_next_deferred?(paragraph, next_paragraph, layout_frame,
+                              left_limit, next_column, needed)
+        end
+
+        def keep_flagged?(paragraph)
+          paragraph.keep_all_lines_together ||
+            !paragraph.keep_with_next.nil?
+        end
+
+        def with_next_deferred?(paragraph, next_paragraph, layout_frame,
+                                left_limit, next_column, needed)
+          return false if paragraph.keep_with_next.nil?
+
+          follower_needed = [next_paragraph&.runs&.length || 1, 1].max
+          follower_break = KeepPolicy.paragraph_break?(next_paragraph)
+          room = vertical_room(layout_frame, paragraph, left_limit,
+                               next_column)
+          follower_break || needed + follower_needed > room
+        end
+
+        def vertical_room(layout_frame, paragraph, left_limit,
+                          next_column)
+          leading = TextEngine::VerticalLayout.leading_for(
+            paragraph.auto_leading,
+            paragraph.runs.first&.point_size ||
+              TextFrameRenderer::DEFAULT_SIZE,
+          )
+          vertical_available_columns(layout_frame, leading, left_limit,
+                                     next_column)
+        end
+
+        def vertical_available_columns(layout_frame, leading, left_limit,
+                                       next_column)
+          right = layout_frame.x + layout_frame.width -
+            (layout_frame.inset_right || 0)
+          (((right - left_limit) / leading).floor - next_column).to_i
+        end
+
         # Folds a chain-resumed paragraph (runs_remaining) back to
         # the head of the paragraph list so the vertical path sees a
         # uniform sequence. The consumed column offset persists in

data/lib/idml/render/style_resolver.rb

@@ -70,6 +70,9 @@ module Idml
         :maximum_letter_spacing,
         :maximum_glyph_scaling,
         :minimum_glyph_scaling,
+        # ParagraphDirection (LeftToRightDirection /
+        # RightToLeftDirection) — mirrors alignment under RTL.
+        :paragraph_direction,
         # Forced paragraph break (StartParagraph: NextPage /
         # NextColumn / NextFrame / NextOddPage / NextEvenPage).
         :start_paragraph,
@@ -197,6 +200,9 @@ module Idml
           paragraph = Paragraph.new(
             runs: runs,
             alignment: runs.first.alignment,
+            paragraph_direction: resolve_attr(
+              style_lookup, psr, :paragraph_direction
+            ),
             space_before: resolve_attr(style_lookup, psr, :space_before),
             space_after: resolve_attr(style_lookup, psr, :space_after),
             first_line_indent: resolve_attr(style_lookup, psr,

data/lib/idml/text_engine/justifier.rb

@@ -21,13 +21,13 @@ module Idml
       DEFAULT_MIN_GLYPH_SCALING = 100.0
 
       def self.justify(line:, frame_width:, alignment: :left,
-                       last_line: false, limits: nil)
-        new(frame_width, alignment, last_line, limits).justify(line)
+                       last_line: false, limits: nil, direction: nil)
+        new(frame_width, alignment, last_line, limits, direction).justify(line)
       end
 
-      def initialize(frame_width, alignment, last_line, limits)
+      def initialize(frame_width, alignment, last_line, limits, direction)
         @frame_width = frame_width
-        @alignment = alignment
+        @alignment = mirrored_alignment(alignment, direction)
         @last_line = last_line
         @limits = limits
       end
@@ -44,7 +44,18 @@ module Idml
         line
       end
 
-      private
+      RTL_ALIGNMENT_MIRROR = {
+        left: :right, right: :left,
+        start: :end, end: :start
+      }.freeze
+
+      # RightToLeftDirection mirrors the visual alignment: what is
+      # "left" in an LTR paragraph sits right in an RTL one.
+      def mirrored_alignment(alignment, direction)
+        return alignment unless direction == "RightToLeftDirection"
+
+        RTL_ALIGNMENT_MIRROR[alignment] || alignment
+      end
 
       # The paragraph's last line stays ragged under full
       # justification.

data/lib/idml/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: idml
 version: !ruby/object:Gem::Version
-  version: 0.10.13
+  version: 0.10.14
 platform: ruby
 authors:
 - Ribose
@@ -216,6 +216,8 @@ files:
 - TODO.pdf/15-wire-spread-children.md
 - TODO.pdf/150-architecture-round-three.md
 - TODO.pdf/151-schema-conformance.md
+- TODO.pdf/152-rtl-alignment.md
+- TODO.pdf/153-vertical-keeps.md
 - TODO.pdf/16-typed-model-pipeline.md
 - TODO.pdf/17-shape-rendering.md
 - TODO.pdf/18-text-rendering.md