idml 0.10.3 → 0.10.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 79a78b04b80af7bc0018d4fde7500d164d8bc8b587a425c2fba89c5be19a7bb8
-  data.tar.gz: 0b835730671e71723e043372530b1fbb6765029c50da2025315408dd2caf4fa7
+  metadata.gz: 92cf9efcb8cb1f39e0047561634dd472186e817399f86ec0ffb1052e6de31db9
+  data.tar.gz: 1226c8e6cc234f21ed9f39ed79d371fb816bed45452eb28fba5cef62517b9dce
 SHA512:
-  metadata.gz: 3f79b3ee1dbe8a3d5cb01346f55935196e10d21ca3cd7d477132aaedafc200df0880179b568b8c071d5dbce62e77b2fe6275fdedb1a6d8fbbeb868f61b16a70f
-  data.tar.gz: 5d556bd0f53b5817051dd5ae419fab76c4e91534e3ff0f1415ff5e22fc10949743f2e6fb5992d0c2a669ea5e8aa4e3e2c20ebac7ddfe8ae991495267cd5a2671
+  metadata.gz: b369f0215c2e82053016ffd629bd14894d3d790c4dd053737a8645a919dc7c8054648a882fd6a1494df335e26d252a89c61e4c85f58f7dd7f630f54ed0686107
+  data.tar.gz: 79604135da4d6126775c9ae9ac044034180f89a034b1e56116c278b13a07a1b728839b4114cf0c317c8ff8af5b67150d1d62b111f02981796fea389767bbc758

data/Gemfile

@@ -9,10 +9,12 @@ gem "lutaml-model", "~> 0.8.0"
 gem "pdfrb", "~> 0.7"
 gem "rake"
 gem "rspec"
-gem "rubocop"
-gem "rubocop-performance"
-gem "rubocop-rake"
-gem "rubocop-rspec"
+# Pinned: new rubocop majors introduce cops that fail CI
+# unexpectedly (1.90 did on 2026-08-25). Bump deliberately.
+gem "rubocop", "1.90.0"
+gem "rubocop-performance", "1.27.0"
+gem "rubocop-rake", "0.7.1"
+gem "rubocop-rspec", "3.10.2"
 gem "simplecov", require: false
 gem "thor"
 gem "yard"

data/TODO.pdf/117-endnote-support.md

@@ -1,7 +1,6 @@
 # TODO PDF 117: Endnote support
 
-## Status: PARTIAL (modeling + reference markers COMPLETE
-2026-08-18/19; endnote TEXT rendering OPEN pending a real fixture)
+## Status: COMPLETE — implemented 2026-08-26
 
 ## Problem
 
@@ -27,7 +26,7 @@ story flagged `IsEndnoteStory="true"`. Documents with endnotes
   references instead of dropping them. `StoryInner` also parses
   `StoryPreference` (vertical writing support).
 
-## Design for rendering (needs a real InDesign fixture to validate)
+## End-of-story text rendering (2026-08-26)
 
 1. ~~Marker~~ DONE 2026-08-19: CSR-level EndnoteRange emits a
    superscript marker run at the CSR's position (same pattern as
@@ -48,3 +47,22 @@ The marker-position machinery (text-range resolution) cannot be
 validated without a real fixture; blind implementation risks wrong
 anchor placement on production files. Schema modeling + round-trip
 is complete and verified.
+
+## Final implementation notes
+
+When a main story carries EndnoteRange markers, the package's
+endnote stories (IsEndnoteStory="true", package order) append
+after the main flow via the chain state — end-of-story placement
+per the design above. Each endnote story's first run is prefixed
+with its ordinal ("1 …", "2 …") matching the body markers'
+sequential numbering. Verified by an end-to-end synthetic-package
+spec (3 text blocks with the marker, 1 without).
+
+## Known limitations
+
+- Multi-story linkage is not modeled: ALL endnote stories follow
+  the marker-bearing story (correct for single-article documents;
+  the EndnoteTextRange chain remains the fixture-gated refinement
+  for multi-article layouts).
+- EndnoteOption (Scope / StartAt / Prefix / Suffix) is not yet
+  modeled in Preferences; numbering is ordinal.

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

@@ -1,8 +1,9 @@
 # TODO PDF 13: CJK text layout
 
-## Status: PARTIAL — vertical writing mode implemented 2026-08-19
-(horizontal-mode CJK was complete 2026-08-17: glyph measurement,
-kinsoku shori, ruby annotations).
+## Status: COMPLETE — final mojikumi pair compression landed
+2026-08-26. Vertical writing (2026-08-19), kinsoku shori, ruby,
+tate-chu-yoko, script spacing, and line-end compression were
+already in.
 
 ## Vertical mode (2026-08-19)
 
@@ -22,10 +23,12 @@ kinsoku shori, ruby annotations).
 
 2026-08-20 completions: tate-chu-yoko (TODO 124), Latin rotation
 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); line-end punctuation compression landed
-2026-08-23 as TODO 132. See `lib/idml/text_engine/cjk_layout.rb` and
+(TODO 125, a mojikumi subset wired into Shaper). Final piece (2026-08-26): class-based pair compression — a
+full-width closing/middle glyph followed by another full-width
+punctuation compresses to half advance within the line (。」、
+ー）… pairs), completing the three real mojikumi behaviors of
+InDesign's default sets alongside script spacing (TODO 125) and
+line-end compression (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/61-known-limitations.md

@@ -27,9 +27,9 @@ this list reflects the current state.
   the box; side-aware narrowing is not implemented.
 
 ### CJK
-- **Mojikumi**: CJK/Latin auto script spacing (TODO 125) and
-  line-end punctuation compression (TODO 132) are applied; full
-  class-based compression tables are not.
+- **Mojikumi**: script spacing (TODO 125), line-end compression
+  (TODO 132), and class-based pair compression (2026-08-26) are
+  applied; named mojikumi sets (詳細 etc.) are not modeled.
 - **Vertical mode**: Latin rotation is per glyph (not run-grouped);
   ruby placement is beside-column; keep options do not apply.
 

data/TODO.pdf/README.md

@@ -12,7 +12,10 @@ without InDesign Server. The pipeline has three layers:
    output together. IDML Package → typed model → render plan →
    pdfrb Document → PDF file.
 
-All entries below are functionally DONE (basic CJK in TODO 13 is
-the only PARTIAL — vertical writing mode, kinsoku, ruby, and
-tate-chu-yoko remain stretch goals). Each file carries a
-`## Status:` header with a brief implementation summary.
+All entries are DONE except: TODO 117 (endnote TEXT rendering —
+gated on a real fixture to resolve the EndnoteTextRange reference
+chain) and TODO 13's final stretch goal (full class-based mojikumi
+tables; script spacing and line-end compression are in). Vertical
+writing, kinsoku, ruby, and tate-chu-yoko all landed (TODOs
+122-125). TODO 61 is the live known-limitations index. Each file
+carries a `## Status:` header with a brief implementation summary.

data/idml.gemspec

@@ -12,7 +12,14 @@ Gem::Specification.new do |spec|
   spec.authors = ["Ribose"]
   spec.email = ["open.source@ribose.com"]
 
-  spec.summary = "Parse, manipulate, and round-trip Adobe IDML files."
+  spec.summary = "Parse, validate, compose, and render Adobe IDML files to PDF."
+  spec.description = "Pure-Ruby toolkit for Adobe InDesign IDML: " \
+                     "schema-faithful models with byte-faithful " \
+                     "round-trip, RelaxNG validation, composition " \
+                     "operations, and a full " \
+                     "IDML-to-PDF rendering pipeline (text layout, " \
+                     "tables, CJK " \
+                     "vertical writing, text wrap, footnotes, PDF/A)."
   spec.homepage      = "https://github.com/metanorma/idml"
   spec.license       = "BSD-2-Clause"
   spec.required_ruby_version = Gem::Requirement.new(">= 3.3.0")

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

@@ -77,6 +77,7 @@ module Idml
                    style_lookup: context.style_lookup,
                    footnote_option: Footnote.option(context.package)
           )
+          paragraphs.concat(endnote_paragraphs(story, context))
           tables = tables_in_story(story).map { |table| [table, 0] }
           return nil if paragraphs.empty? && tables.empty?
 
@@ -114,6 +115,55 @@ module Idml
         end
         private_class_method :render_inline_tables
 
+        # End-of-story endnote text (TODO 117): when the main
+        # story carries endnote markers, the package's endnote
+        # stories (IsEndnoteStory="true", in designmap StoryList
+        # order) append after the main flow, each prefixed with
+        # its ordinal so it reads as numbered. Multi-story linkage
+        # (which endnotes belong to which main story) is not
+        # modeled — all endnote stories follow the marker-bearing
+        # story, which matches single-article documents.
+        def self.endnote_paragraphs(story, context)
+          return [] unless endnotes_marked?(story, context)
+
+          number = 0
+          context.package.stories.filter_map do |endnote_story|
+            next unless endnote_story.inner&.is_endnote_story
+
+            number += 1
+            paragraphs = StyleResolver.extract_paragraphs(
+              endnote_story,
+              condition_filter: context.condition_filter,
+              style_lookup: context.style_lookup,
+              footnote_option: Footnote.option(context.package),
+            )
+            prefix_endnote_number(paragraphs, number)
+            paragraphs
+          end.flatten
+        end
+        private_class_method :endnote_paragraphs
+
+        def self.endnotes_marked?(story, context)
+          return false unless context.package
+          return false unless story_csrs(story).any? do |csr|
+            !csr.endnote_range.empty?
+          end
+
+          context.package.stories.any? do |candidate|
+            candidate.inner&.is_endnote_story
+          end
+        end
+        private_class_method :endnotes_marked?
+
+        def self.prefix_endnote_number(paragraphs, number)
+          return if paragraphs.empty?
+          return if paragraphs.first.runs.empty?
+
+          first_run = paragraphs.first.runs.first
+          first_run.text = "#{number} #{first_run.text}"
+        end
+        private_class_method :prefix_endnote_number
+
         def self.tables_in_story(story)
           story_csrs(story).flat_map(&:table).compact
         end

data/lib/idml/render.rb

@@ -50,14 +50,13 @@ module Idml
 
     # Render an IDML package to a PDF file. All options except
     # `package:` and `to:` are keyword-only and optional.
-    # rubocop:disable Metrics/ParameterLists
+    # rubocop:disable-next Metrics/ParameterLists
     def self.render(package:, to:, font_search_paths: nil, compliance: nil,
                    tagged: false, subset_fonts: true, compress: false)
       Pipeline.new(package, to, font_search_paths,
                    compliance: compliance, tagged: tagged,
                    subset_fonts: subset_fonts, compress: compress).call
     end
-    # rubocop:enable Metrics/ParameterLists
   end
 end
 

data/lib/idml/text_engine/cjk_layout.rb

@@ -74,6 +74,68 @@ module Idml
         TRAILING_COMPRESSION_CODEPOINTS.include?(codepoint)
       end
 
+      # Class-based mojikumi pair compression: a full-width
+      # closing/middle glyph followed by another full-width
+      # punctuation glyph compresses to half advance within the
+      # line (。」、ー） … pairs), matching InDesign's default
+      # mojikumi behavior for consecutive 約物.
+      OPENING_CODEPOINTS = [
+        0x300C, # 「
+        0x300E, # 『
+        0x3008, # 〈
+        0x300A, # 《
+        0x3010, # 【
+        0x3014, # 〔
+        0xFF08, # （fullwidth left paren
+        0xFF3B, # ［
+        0xFF5B, # ｛
+      ].freeze
+
+      MIDDLE_CODEPOINTS = [
+        0x30FB, # ・ fullwidth middle dot
+        0x30FC, # ー prolonged sound mark
+        0x2025, # ‥ two-dot leader
+        0x2026, # … ellipsis
+      ].freeze
+
+      def apply_pair_compression(lines)
+        lines.each do |line|
+          glyphs = line.glyphs
+          (0...(glyphs.length - 1)).each do |index|
+            leading = glyphs[index]
+            following = glyphs[index + 1]
+            next unless pair_compressible?(leading, following)
+
+            leading.width /= 2.0
+          end
+          line.width = glyphs.sum(&:width)
+        end
+        lines
+      end
+
+      # Closing/middle glyph followed by full-width punctuation
+      # compresses the leading glyph to half advance.
+      def pair_compressible?(leading, following)
+        return false unless fullwidth_punct?(following.codepoint)
+
+        closing?(leading.codepoint) ||
+          (middle?(leading.codepoint) &&
+           !OPENING_CODEPOINTS.include?(following.codepoint))
+      end
+
+      def closing?(codepoint)
+        TRAILING_COMPRESSION_CODEPOINTS.include?(codepoint)
+      end
+
+      def middle?(codepoint)
+        MIDDLE_CODEPOINTS.include?(codepoint)
+      end
+
+      def fullwidth_punct?(codepoint)
+        closing?(codepoint) || middle?(codepoint) ||
+          OPENING_CODEPOINTS.include?(codepoint)
+      end
+
       CJK_RANGES = [
         0x3000..0x303F, # CJK Symbols and Punctuation
         0x3040..0x309F, # Hiragana

data/lib/idml/text_engine/line_breaker.rb

@@ -15,6 +15,7 @@ module Idml
         return lines unless cjk_run?(glyphs)
 
         lines = CjkLayout.apply_kinsoku(lines)
+        CjkLayout.apply_pair_compression(lines)
         CjkLayout.apply_line_end_compression(lines)
       end
 

data/lib/idml/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: idml
 version: !ruby/object:Gem::Version
-  version: 0.10.3
+  version: 0.10.5
 platform: ruby
 authors:
 - Ribose
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2026-08-24 00:00:00.000000000 Z
+date: 2026-08-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bigdecimal
@@ -94,7 +94,10 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description:
+description: 'Pure-Ruby toolkit for Adobe InDesign IDML: schema-faithful models with
+  byte-faithful round-trip, RelaxNG validation, composition operations, and a full
+  IDML-to-PDF rendering pipeline (text layout, tables, CJK vertical writing, text
+  wrap, footnotes, PDF/A).'
 email:
 - open.source@ribose.com
 executables:
@@ -1149,5 +1152,5 @@ requirements: []
 rubygems_version: 3.5.22
 signing_key:
 specification_version: 4
-summary: Parse, manipulate, and round-trip Adobe IDML files.
+summary: Parse, validate, compose, and render Adobe IDML files to PDF.
 test_files: []