idml 0.9.0 → 0.9.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ff487a296f9cbd5b926b963c7acb7d4864d43060ffed5b1ec7438a75bac1446a
-  data.tar.gz: f4926fe3add1833a954628aace986839f101722deafde891783c54afdd509a58
+  metadata.gz: a82b32708ab694d0d794c39f33d74de7b39a9bdc38b7a6315b99a2156dcef271
+  data.tar.gz: 7eee074d6ecf3a46798139fa6ed6fc36c975bcaf93059c52e68e597e7b1a87f3
 SHA512:
-  metadata.gz: 043ed38d8ebdcf1af8506e83d8548b6590d923f0b4b1ef01687dca5c7528bc5d9a16c79c67e06dc626abe70334afd72882aefac2f15f8253c71d56bc40224274
-  data.tar.gz: 0fefb80560e396290585e3677ca395abd1096511b78321c7ff05ff3add4b5bf0242a4c21ea3321244b7da5290651e369b376696400dc19429ecc547b1c534842
+  metadata.gz: 6c561f3cd1a83d7688291a2ef3dc23d42616bce723b5ff82a77a641104fae0731247c4cbc50cae2d9d5d5aa979c31ac8e90ff0b38f107235793bdfd7fda4019a
+  data.tar.gz: e42f707ec01db8ce171244e95ba378420bdf44c4a195c1f2f285ac7d56e91777c4750f5d5f4b05dc6ac60fb2f59beebaa50755f6c1ee3bb2de13957a7b44edab

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

@@ -1,9 +1,25 @@
 # TODO PDF 13: CJK text layout
 
-## Status: PARTIAL — `Idml::TextEngine::CjkLayout` handles CJK glyph
-measurement and basic horizontal layout. Vertical writing mode,
-kinsoku shori, tate-chu-yoko, and ruby remain stretch goals as
-flagged in the original TODO. See `lib/idml/text_engine/cjk_layout.rb`.
+## Status: PARTIAL — horizontal-mode CJK complete (2026-08-17):
+CJK glyph measurement, kinsoku shori, and ruby annotations render.
+Vertical writing mode, tate-chu-yoko, and mojikumi remain OPEN
+stretch goals — they need a vertical (rotated) layout engine and
+real vertical-mode fixtures to build against. See
+`lib/idml/text_engine/cjk_layout.rb`.
+
+## Progress 2026-08-17
+
+- Kinsoku shori is now LIVE in the pipeline: LineBreaker.break
+  post-processes any run containing CJK glyphs through
+  CjkLayout.apply_kinsoku, so no rendered line starts with
+  、。，」etc. or ends with 「 etc. (previously the logic existed
+  but was never called).
+- Ruby (phonetic annotations) render: CSR RubyString /
+  RubyFontSize / RubyPosition extract onto the run; the renderer
+  emits the annotation centered above the run's first line (half
+  the base size by default; Below* positions place it under).
+  Approximation: IDML attaches ruby to a character range; we
+  annotate the whole first line.
 
 ## Goal
 

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

@@ -25,6 +25,7 @@ module Idml
       # FontMetrics is available (no shaper → no wrap → rough output).
       class TextFrameRenderer
         DEFAULT_SIZE = 12.0
+        RUBY_SIZE_FACTOR = 0.5
 
         def self.render(canvas, context)
           frame = context.item
@@ -738,15 +739,26 @@ module Idml
             left_indent: left_indent,
           )
 
-          positioned.each do |line|
+          emit_run_lines(canvas, positioned, run, context, size, font,
+                         bottom_limit, char_cursor)
+          [positioned, next_y]
+        end
+        private_class_method :layout_run
+
+        # Emits the run's positioned lines (clipped at the bottom
+        # limit), recording positions and annotating the first line
+        # with the run's ruby when present.
+        def self.emit_run_lines(canvas, positioned, run, context, size,
+                                font, bottom_limit, char_cursor)
+          positioned.each_with_index do |line, index|
             break if line.y < bottom_limit
 
             emit_line(canvas, line, run, context, size)
             record_position(context, line, size, char_cursor)
+            emit_ruby(canvas, run, line, size, font, context) if index.zero?
           end
-          [positioned, next_y]
         end
-        private_class_method :layout_run
+        private_class_method :emit_run_lines
 
         # Emits one positioned line: applies character-level styling
         # (fill color + tint, capitalization, position, tracking,
@@ -779,6 +791,36 @@ module Idml
         end
         private_class_method :emit_line
 
+        # Emits the run's ruby (phonetic annotation) above the first
+        # line of the annotated run, centered over the line's width.
+        # RubyFontSize defaults to half the base size; RubyPosition
+        # values containing "Below" place it under the base text.
+        # Approximation: IDML attaches ruby to a character range;
+        # we annotate the whole first line.
+        def self.emit_ruby(canvas, run, line, base_size, font, context)
+          ruby_text = run.ruby_string
+          return if ruby_text.nil? || ruby_text.empty?
+
+          ruby_size = run.ruby_font_size || (base_size * RUBY_SIZE_FACTOR)
+          glyphs = TextEngine::Shaper.shape(text: ruby_text, font: font,
+                                            size: ruby_size)
+          ruby_width = glyphs.sum(&:width)
+          x = line.x + ((line.width - ruby_width) / 2)
+          y = ruby_y(run, line, base_size, ruby_size)
+          canvas.text(ruby_text, at: [x, y],
+                                 font: font_for_run(run, context), size: ruby_size)
+        end
+        private_class_method :emit_ruby
+
+        def self.ruby_y(run, line, base_size, ruby_size)
+          if run.ruby_position.to_s.include?("Below")
+            line.y - (base_size * 0.25) - ruby_size
+          else
+            line.y + (base_size * 0.45) + ruby_size
+          end
+        end
+        private_class_method :ruby_y
+
         def self.leading_for(paragraph, size)
           TextEngine::VerticalLayout.leading_for(paragraph.auto_leading, size)
         end

data/lib/idml/render/style_resolver.rb

@@ -43,6 +43,11 @@ module Idml
         :baseline_shift,
         :footnote_number,
         :footnote_paragraphs,
+        # Ruby (phonetic annotation) — from the CSR's Ruby*
+        # attributes. Present only on runs with a RubyString.
+        :ruby_string,
+        :ruby_font_size,
+        :ruby_position,
         keyword_init: true,
       )
 
@@ -348,6 +353,9 @@ module Idml
                                         :horizontal_scale),
           vertical_scale: resolve_csr(style_lookup, csr, :vertical_scale),
           baseline_shift: resolve_csr(style_lookup, csr, :baseline_shift),
+          ruby_string: resolve_csr(style_lookup, csr, :ruby_string),
+          ruby_font_size: resolve_csr(style_lookup, csr, :ruby_font_size),
+          ruby_position: resolve_csr(style_lookup, csr, :ruby_position),
         )
       end
       private_class_method :text_run

data/lib/idml/text_engine/line_breaker.rb

@@ -7,10 +7,20 @@ module Idml
 
     # Greedy word-wrap line breaker. Accumulates glyphs until
     # exceeding the frame width, then breaks at the last space.
+    # CJK runs get a kinsoku shori post-pass (no line starts or
+    # ends with a forbidden character).
     class LineBreaker
       def self.break(glyphs:, frame_width:)
-        new(frame_width).break(glyphs)
+        lines = new(frame_width).break(glyphs)
+        return lines unless cjk_run?(glyphs)
+
+        CjkLayout.apply_kinsoku(lines)
+      end
+
+      def self.cjk_run?(glyphs)
+        glyphs.any? { |glyph| CjkLayout.cjk?(glyph.codepoint) }
       end
+      private_class_method :cjk_run?
 
       def initialize(frame_width)
         @frame_width = frame_width

data/lib/idml/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: idml
 version: !ruby/object:Gem::Version
-  version: 0.9.0
+  version: 0.9.1
 platform: ruby
 authors:
 - Ribose
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2026-08-17 00:00:00.000000000 Z
+date: 2026-08-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bigdecimal