idml 0.10.1 → 0.10.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e7360c896ca2b95a5fa92dd030c71e3170b0f26039f5b48938f3ba038405bc46
-  data.tar.gz: 1ce5fccd66f88f3dc5a25289e844cdfd99b391279f8bf8f659d74de9488c866e
+  metadata.gz: 40262a683342f0a9308e33ab2cce4a8bcf6b803288d6a0bc3ece3d2b376c6761
+  data.tar.gz: 78cb5495d1d9b72d5e850c6d25c8cd594622d6484476ea61a1ff239df41e9e99
 SHA512:
-  metadata.gz: e9aaaa8864f60931ebf50be726503f2b9db6313135262aa6d740d6fda4e06a57b03b8970aaaa87eddcd29a82e562cf0bd0ee56df227c2729782f276bca447e06
-  data.tar.gz: b4a07f57002002cc027fb1459b9524107f1fc309a1d34cbb23575416054488589e355b4bc0a548ee59f6d69e50225dc2a8a021f4848007d9f04820b3925af778
+  metadata.gz: b10228f8870d90e1a66f8fb9b621a26951db4a71e155a3f28165c22a3e9c44b53e7dbc17916ec4b5db0f49987403e4e645e5f0872a79cb0fe591881ff6f9caca
+  data.tar.gz: d4904d3ef2a6d0b1c4dfcd497597042fcedee1b5c3c1643ff892ac867e7b4c3f0881419a906527e5f1705a64292c8c5c5e06ae8af774b8ce725f81c8bcf9ff92

data/README.adoc

@@ -1,4 +1,64 @@
-= Ruby parser for Adobe IDML
+= idml
 
-IDML is the InDesign Markup Language from Adobe used by InDesign.
+A pure-Ruby toolkit for Adobe InDesign IDML files: parse, validate,
+round-trip, compose, and render to PDF.
 
+== What it does
+
+* **Parse & round-trip** — every IDML part is a typed
+  `Lutaml::Model` class generated from Adobe's RelaxNG schemas
+  (`reference-docs/schemas/`): byte-faithful re-serialization with
+  `ZIP_STORED` mimetype ordering preserved.
+* **Validate** — RelaxNG validation against the committed InDesign
+  2026 (DOMVersion 21.5) schemas.
+* **Compose** — `insert_idml`, `add_page_from_idml`, `prefix`,
+  `import_xml`/`export_xml` (ported from SimpleIDML).
+* **Render to PDF** — a full pure-Ruby layout + paint pipeline
+  (pdfrb): multi-frame threaded stories, justification with
+  word/letter/glyph limits, footnotes (bottom-of-frame with
+  separator rules), anchored objects, tables (row/column banding,
+  per-side cell strokes, merged cells), Bézier shape contours,
+  gradients, text wrap (bounding-box, contour, and inverse modes),
+  paragraph shading/borders/rules, drop caps, bullets & numbering,
+  CJK layout (kinsoku shori, ruby, vertical writing with
+  tate-chu-yoko and rotated Latin, script spacing, line-end
+  punctuation compression), tagged PDF, hyperlinks, bookmarks,
+  PDF/A, and font subsetting.
+
+== Install
+
+....
+gem install idml
+....
+
+`.indd` files are a proprietary binary format — export them to
+`.idml` from InDesign first (File → Export), or use InDesign Server
+for headless automation.
+
+== Quick start
+
+....
+require "idml"
+
+# Round-trip a package
+pkg  = Idml::Package.new("doc.idml")
+spec = pkg.spreads.first
+
+# Render to PDF
+Idml.render(package: pkg, to: "doc.pdf")
+....
+
+== Requirements
+
+* Ruby >= 3.3 (tested through 4.0 on macOS/Linux/Windows)
+
+== Reference material
+
+The `reference-docs/` tree carries Adobe's IDML specification, the
+Plug-in SDK's idmltools (behavioral ground truth), and the
+generated RelaxNG schemas — the attribute authority for every
+model class.
+
+== License
+
+BSD-2-Clause.

data/TODO.pdf/13-cjk-text-layout.md

@@ -24,7 +24,8 @@ kinsoku shori, ruby annotations).
 and vertical ruby (TODO 122), CJK/Latin automatic script spacing
 (TODO 125, a mojikumi subset wired into Shaper). The remaining
 stretch goal is full class-based mojikumi (per-pair punctuation
-compression tables). See `lib/idml/text_engine/cjk_layout.rb` and
+compression tables); line-end punctuation compression landed
+2026-08-23 as TODO 132. See `lib/idml/text_engine/cjk_layout.rb` and
 `lib/idml/text_engine/vertical_text_layout.rb`.
 
 ## Progress 2026-08-17

data/TODO.pdf/131-inverse-wrap.md

@@ -0,0 +1,19 @@
+# TODO PDF 131: Inverse text wrap
+
+## Status: COMPLETE — implemented 2026-08-23
+
+## What was done
+
+`TextWrapPreference Inverse="true"` flips the wrap region: text
+may only flow INSIDE the wrap shape (the avoid-region becomes
+everything outside it within the frame). Works for both the
+bounding-box contour and the Contour-mode polygon shape (TODO
+130); the inversion lives in one place — TextWrapResolver's
+overlap dispatch — and reduces by (frame width − inside width),
+so bands outside the shape block text entirely.
+
+## Known limitations
+
+- Side-aware narrowing is not implemented: the reduction shrinks
+  the wrap width from the right regardless of which side the
+  shape occupies.

data/TODO.pdf/132-line-end-compression.md

@@ -0,0 +1,22 @@
+# TODO PDF 132: Line-end punctuation compression (mojikumi subset 2)
+
+## Status: COMPLETE — implemented 2026-08-23
+
+## What was done
+
+`CjkLayout.apply_line_end_compression`: a CJK line whose final
+glyph is full-width closing punctuation (。、」』）］｝ー etc.) renders
+that glyph at half advance (行末約物半角詰め), tightening the line
+as InDesign's default mojikumi does. Applied in LineBreaker's CJK
+post-pass after kinsoku shori, so horizontal and vertical layout
+both benefit.
+
+Also fixed a latent bug the specs caught: kinsoku's return value
+(new dup'd line array) was discarded when composing the post-pass
+chain — kinsoku adjustments silently vanished once a second
+post-pass followed it.
+
+## Remaining from TODO 13
+
+Per-pair punctuation compression tables (full class-based
+mojikumi).

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

@@ -22,13 +22,14 @@ this list reflects the current state.
   (TODO 128); CapHeight / XHeight approximate as leading.
 - **StartParagraph** breaks act at frame/column granularity — no
   odd/even page parity.
-- **Text wrap**: BoundingBoxTextWrap and Contour modes render
-  (TODO 130); JumpObject/NextColumn approximate as the box;
-  Inverse mode is not implemented.
+- **Text wrap**: BoundingBoxTextWrap, Contour, and Inverse modes
+  render (TODOs 130-131); JumpObject/NextColumn approximate as
+  the box; side-aware narrowing is not implemented.
 
 ### CJK
-- **Mojikumi**: CJK/Latin auto script spacing is applied (TODO
-  125); full class-based punctuation compression tables are not.
+- **Mojikumi**: CJK/Latin auto script spacing (TODO 125) and
+  line-end punctuation compression (TODO 132) are applied; full
+  class-based compression tables are not.
 - **Vertical mode**: Latin rotation is per glyph (not run-grouped);
   ruby placement is beside-column; keep options do not apply.
 

data/lib/idml/render/text_wrap_resolver.rb

@@ -14,7 +14,7 @@ module Idml
     class TextWrapResolver
       # A wrap contour: a PDF-coordinate rectangle the text avoids.
       Contour = Struct.new(
-        :x, :y, :width, :height,
+        :x, :y, :width, :height, :inverse,
         keyword_init: true
       )
 
@@ -40,16 +40,22 @@ module Idml
       # 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.
+      # Returns 0.0 when there's no overlap. Inverse contours
+      # reduce by the frame width minus their own width (text may
+      # only flow inside).
       def overlap_width(line_y, line_height, frame_x, frame_right)
         @contours.sum do |contour|
-          if contour.is_a?(WrapContour::Shape)
-            WrapContour.overlap_width(contour, line_y, line_height,
-                                      frame_x, frame_right)
-          else
-            line_overlap(contour, line_y, line_height,
-                         frame_x, frame_right)[:width]
-          end
+          width = if contour.is_a?(WrapContour::Shape)
+                    WrapContour.overlap_width(contour, line_y,
+                                              line_height, frame_x,
+                                              frame_right)
+                  else
+                    line_overlap(contour, line_y, line_height,
+                                 frame_x, frame_right)[:width]
+                  end
+          next width unless contour.inverse
+
+          (frame_right - frame_x) - width
         end
       end
 

data/lib/idml/render/wrap_contour.rb

@@ -12,8 +12,10 @@ module Idml
       FLATTEN_STEPS = 8
 
       # A wrap shape: flattened polygons (one per subpath) plus the
-      # TextWrapOffset bounds.
-      Shape = Struct.new(:polygons, :offset, keyword_init: true)
+      # TextWrapOffset bounds. `inverse` flips the wrap region:
+      # text may only flow INSIDE the shape.
+      Shape = Struct.new(:polygons, :offset, :inverse,
+                         keyword_init: true)
 
       # Builds the wrap shape for an item's PathGeometry and wrap
       # preference. Returns nil when the item has no geometry.
@@ -21,7 +23,8 @@ module Idml
         polygons = polygons_for(item, page_height)
         return nil if polygons.empty?
 
-        Shape.new(polygons: polygons, offset: wrap_offset(pref))
+        Shape.new(polygons: polygons, offset: wrap_offset(pref),
+                  inverse: pref.inverse)
       end
 
       def self.polygons_for(item, page_height)
@@ -118,6 +121,7 @@ module Idml
 
       # Total horizontal overlap of the text line's band with the
       # shape, expanded by the offsets and clipped to the frame.
+      # The caller (TextWrapResolver) owns inverse flipping.
       def self.overlap_width(shape, line_y, line_height, frame_x,
                              frame_right)
         mid_y = line_y + (line_height / 2.0)

data/lib/idml/text_engine/cjk_layout.rb

@@ -39,6 +39,41 @@ module Idml
           (0x61..0x7A).cover?(codepoint)
       end
 
+      # Mojikumi subset 2: line-end punctuation compression —
+      # full-width closing punctuation occupying a line's final
+      # position renders at half advance (行末約物半角詰め),
+      # tightening the line as InDesign's default mojikumi does.
+      TRAILING_COMPRESSION_CODEPOINTS = [
+        0x3001, # 、 ideographic comma
+        0x3002, # 。 ideographic full stop
+        0x3009, # 〉
+        0x300B, # 》
+        0x300D, # 」
+        0x300F, # 』
+        0x3011, # 】
+        0x3015, # 〕
+        0xFF09, # ）fullwidth right paren
+        0xFF3D, # ］
+        0xFF5D, # ｝
+        0x30FC, # ー prolonged sound mark
+      ].freeze
+
+      def apply_line_end_compression(lines)
+        lines.each do |line|
+          last = line.glyphs.last
+          next unless last
+          next unless compressible?(last.codepoint)
+
+          last.width /= 2.0
+          line.width = line.glyphs.sum(&:width)
+        end
+        lines
+      end
+
+      def compressible?(codepoint)
+        TRAILING_COMPRESSION_CODEPOINTS.include?(codepoint)
+      end
+
       CJK_RANGES = [
         0x3000..0x303F, # CJK Symbols and Punctuation
         0x3040..0x309F, # Hiragana

data/lib/idml/text_engine/line_breaker.rb

@@ -14,7 +14,8 @@ module Idml
         lines = new(frame_width).break(glyphs)
         return lines unless cjk_run?(glyphs)
 
-        CjkLayout.apply_kinsoku(lines)
+        lines = CjkLayout.apply_kinsoku(lines)
+        CjkLayout.apply_line_end_compression(lines)
       end
 
       def self.cjk_run?(glyphs)

data/lib/idml/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: idml
 version: !ruby/object:Gem::Version
-  version: 0.10.1
+  version: 0.10.2
 platform: ruby
 authors:
 - Ribose
@@ -190,6 +190,8 @@ files:
 - TODO.pdf/129-justification-glyph-scaling.md
 - TODO.pdf/13-cjk-text-layout.md
 - TODO.pdf/130-contour-text-wrap.md
+- TODO.pdf/131-inverse-wrap.md
+- TODO.pdf/132-line-end-compression.md
 - TODO.pdf/14-page-item-element-models.md
 - TODO.pdf/15-wire-spread-children.md
 - TODO.pdf/16-typed-model-pipeline.md