idml 0.10.12 → 0.10.13

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 49122b9c9f5974361567afb8fc2e063602e370141f0d5990f8de156275c312c4
-  data.tar.gz: c4f21424d6cd5d2f9345801aeb53be0b78d26f3d0c423b8ad20b179dff4ef38f
+  metadata.gz: 2f2a7b73c56645a87269780fc0cab9f998f5a6bf0d167b0ce9433dba9a8019cd
+  data.tar.gz: e4bb1522273937a4c2cf5631de1927f4583f63d16f2b351f893921407d89dc88
 SHA512:
-  metadata.gz: 6c06eb1149c2fed295382a4ce65504d12c821d884ffa6cd145f9ac96e0837c82b1dbfdd16abd082e84366dd6c0bfd6edc8670e187d71785f1de0e7a415cc9892
-  data.tar.gz: 12352d559b36427ec1be4ce71e31cfc149e24ec52a1fe70b65c3ecc720575c1a4f7a9aab8b96e67329747f33bc2005494c6f0c2034508b642edf37ba917a45ca
+  metadata.gz: 83756750d549a02ff7080686509ac45acce77405db6c9d3ba0ee6dae3643622b8eb89198d28fead77047dac50bdcf9491bdab05b7e03d02e18560f1021fa5360
+  data.tar.gz: 8a9fc59030029b4342019b205f9fe7da46ae6296729d641c49c199391cd5765ffea195dfca6cde46ff0df6518f496dcf9a1b66dc5dad0b808503230be8057107

data/TODO.pdf/151-schema-conformance.md

@@ -0,0 +1,48 @@
+# TODO PDF 151: Schema conformance for the Elements layer
+
+## Status: COMPLETE — implemented 2026-08-31
+
+## Problem
+
+Architecture review round four: 147 element classes held hundreds
+of wire attributes transcribed from the RNC, but only 11 classes
+had attribute-set specs — the project's own drift defense
+(CLAUDE.md convention 5) covered a tenth of the surface. Any
+hand-edit that added, dropped, or misspelled a `map_attribute`
+passed every test.
+
+## Solution
+
+- **`Idml::Schema::Rnc`** (`schema/rnc.rb`): the RNC parsing
+  extracted from the generator script into a lib adapter
+  (`element_attribute_map`, `element_definition`). Two consumers
+  over one seam — `scripts/rnc_to_lutaml.rb` (now presentation
+  only) and the conformance spec.
+- **Schema-conformance spec** (`elements_schema_conformance_spec.rb`):
+  for every Elements class — no wire attribute outside the RNC
+  universe (catches typos and inventions), and every mapped
+  destination is a declared attribute (mapping/declaration
+  consistency). Legacy non-schema classes (TableCell) carry an
+  explicit allow-list. Full equality is documented as
+  unenforceable (deliberate subsets; typedef-composed attributes).
+
+**Bug found by the probe and fixed**: `TextFramePreference`
+carried four invented attributes (`InsetTop/Left/Bottom/Right`)
+that appear in no schema, no spec, and no real file — while the
+schema-faithful inset carrier (`Properties > InsetSpacing`, spec
+examples 31/32) was unmodeled, so real documents' text frame
+insets were silently ignored. New `Elements::InsetSpacing`
+(single unit → all sides; list → [top, right, bottom, left]),
+wired into `layout_frame`; the invented attributes removed.
+
+## Files
+
+- `lib/idml/schema.rb`, `lib/idml/schema/rnc.rb` (new)
+- `scripts/rnc_to_lutaml.rb`
+- `lib/idml/elements/inset_spacing.rb` (new)
+- `lib/idml/elements/text_frame_preference.rb`,
+  `lib/idml/elements/properties.rb`, `lib/idml/elements.rb`
+- `lib/idml/render/renderers/text_frame_renderer.rb`,
+  `lib/idml.rb`
+- `spec/idml/elements_schema_conformance_spec.rb` (new)
+- `spec/idml/elements/inset_spacing_spec.rb` (new)

data/lib/idml/elements/inset_spacing.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module Idml
+  module Elements
+    # `<InsetSpacing>` inside TextFramePreference's Properties —
+    # the schema-faithful carrier of text frame insets (the
+    # spec's examples 31/32): a single `type="unit"` value applies
+    # to all sides; a `type="list"` of ListItems carries
+    # [top, right, bottom, left].
+    class InsetSpacing < Lutaml::Model::Serializable
+      attribute :type, :string
+      attribute :value, :string
+      attribute :list_item, TypedValue, collection: true
+
+      xml do
+        root "InsetSpacing"
+        map_attribute "type", to: :type
+        map_content to: :value
+        map_element "ListItem", to: :list_item
+      end
+
+      # [top, right, bottom, left] insets; nil components when the
+      # document doesn't declare them.
+      def sides
+        return Array.new(4, value&.to_f) if list_item.empty?
+
+        (0...4).map { |i| list_item[i]&.value&.to_f }
+      end
+    end
+  end
+end

data/lib/idml/elements/properties.rb

@@ -18,6 +18,7 @@ module Idml
       attribute :paragraph_border_color, Idml::Elements::TypedValue
       attribute :text_wrap_offset, Idml::Elements::TypedValue
       attribute :paragraph_border_gap_color, Idml::Elements::TypedValue
+      attribute :inset_spacing, Idml::Elements::InsetSpacing
 
       xml do
         root "Properties"
@@ -29,6 +30,7 @@ module Idml
         map_element "ParagraphBorderColor", to: :paragraph_border_color
         map_element "TextWrapOffset", to: :text_wrap_offset
         map_element "ParagraphBorderGapColor", to: :paragraph_border_gap_color
+        map_element "InsetSpacing", to: :inset_spacing
       end
 
       def first_geometry

data/lib/idml/elements/text_frame_preference.rb

@@ -5,12 +5,10 @@ module Idml
     # Typed model of `<TextFramePreference>`. Every
     # attribute from `TextFramePreference_Object` in
     # `reference-docs/schemas/package/Resources/Styles.rnc` is declared (33 attributes),
-    # generated by `scripts/rnc_to_lutaml.rb`.
+    # generated by `scripts/rnc_to_lutaml.rb`. Insets live in the
+    # Properties > InsetSpacing child (spec examples 31/32).
     class TextFramePreference < Lutaml::Model::Serializable
-      attribute :inset_top, :float
-      attribute :inset_left, :float
-      attribute :inset_bottom, :float
-      attribute :inset_right, :float
+      attribute :properties, Idml::Elements::Properties, collection: true
       attribute :footnotes_enable_overrides, :boolean
       attribute :footnotes_span_across_columns, :boolean
       attribute :footnotes_minimum_spacing, :float
@@ -47,10 +45,7 @@ module Idml
 
       xml do
         root "TextFramePreference"
-        map_attribute "InsetTop", to: :inset_top
-        map_attribute "InsetLeft", to: :inset_left
-        map_attribute "InsetBottom", to: :inset_bottom
-        map_attribute "InsetRight", to: :inset_right
+        map_element "Properties", to: :properties
         map_attribute "FootnotesEnableOverrides", to: :footnotes_enable_overrides
         map_attribute "FootnotesSpanAcrossColumns", to: :footnotes_span_across_columns
         map_attribute "FootnotesMinimumSpacing", to: :footnotes_minimum_spacing

data/lib/idml/elements.rb

@@ -90,6 +90,7 @@ module Idml
     autoload :MasterSpreadObject, "idml/elements/master_spread_object"
     autoload :MixedInk, "idml/elements/mixed_ink"
     autoload :MixedInkGroup, "idml/elements/mixed_ink_group"
+    autoload :InsetSpacing, "idml/elements/inset_spacing"
     autoload :MojikumiTable, "idml/elements/mojikumi_table"
     autoload :MojikumiTableProperties, "idml/elements/mojikumi_table"
     autoload :OverrideMojikumiAki, "idml/elements/mojikumi_table"

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

@@ -244,20 +244,40 @@ module Idml
         # back to 0 when the preference is absent or doesn't declare
         # them.
         def self.layout_frame(frame_item, box)
-          pref = frame_item.text_frame_preference&.first
+          top, right, bottom, left = frame_insets(
+            frame_item.text_frame_preference&.first,
+          )
           TextEngine::Frame.new(
             x: box[:x],
             y: box[:y],
             width: box[:width],
             height: box[:height],
-            inset_top: pref&.inset_top,
-            inset_bottom: pref&.inset_bottom,
-            inset_left: pref&.inset_left,
-            inset_right: pref&.inset_right,
+            inset_top: top,
+            inset_bottom: bottom,
+            inset_left: left,
+            inset_right: right,
           )
         end
         private_class_method :layout_frame
 
+        # Insets from Properties > InsetSpacing (spec examples
+        # 31/32): one unit value applies to all sides; a list
+        # carries [top, right, bottom, left]. Missing sides are 0.
+        def self.frame_insets(pref)
+          props = pref&.properties
+          spacing = props.first&.inset_spacing if props
+          return Array.new(4, 0.0) unless spacing
+
+          side_or_zero(spacing)
+        end
+
+        def self.side_or_zero(spacing)
+          [0, 1, 2, 3].map do |index|
+            spacing.sides[index] || 0.0
+          end
+        end
+        private_class_method :frame_insets
+
         # Walks the chain state's paragraphs/runs and emits one
         # `canvas.text` per line via the Shaper → LineBreaker →
         # Justifier → VerticalLayout pipeline. Cursor y descends

data/lib/idml/schema/rnc.rb

@@ -0,0 +1,88 @@
+# frozen_string_literal: true
+
+module Idml
+  module Schema
+    # Parses RelaxNG Compact element definitions into data:
+    # element name → wire attribute names. Handles the Adobe
+    # package schemas' shape (`NAME_Object = element Name { ... }`
+    # with balanced braces; attributes as `attribute X { type }`).
+    # Two consumers over this seam: the class generator script and
+    # the schema-conformance spec.
+    module Rnc
+      ELEMENT_DEF = /(\w+)\s*+=\s*+element\s*+([\w:]+)\s*+\{/
+      ATTRIBUTE_DEF = /attribute\s++(\w+)\s*+\{([^}]*)\}/
+
+      module_function
+
+      # { "Story" => [["Self", ...]], ... } for every element
+      # definition across the given RNC files. An element defined
+      # in several files keeps each definition as an alternative
+      # (array of attribute-name arrays) — a class conforms when
+      # its wire attributes equal ANY one alternative.
+      def element_attribute_map(paths)
+        definitions = Hash.new { |h, k| h[k] = [] }
+        each_element(paths) do |element_name, body|
+          definitions[element_name] << body_attributes(body)
+        end
+        definitions.to_h
+      end
+
+      # [xml_element_name, attrs_with_types] for one named
+      # definition (`Story_Object`) in one file; nil when absent.
+      # attrs_with_types: [["Self", "xsd:string"], ...].
+      def element_definition(path, definition_name)
+        src = File.read(path)
+        prefix = /#{Regexp.escape(definition_name)}\s*=\s*element\s+/
+        pattern = /#{prefix}([\w:]+)\s*\{/
+        match = src.match(pattern)
+        return nil unless match
+
+        body = balanced_body(src, match.end(0))
+        return nil unless body
+
+        attrs_with_types = body.scan(ATTRIBUTE_DEF)
+          .map { |name, type| [name, type.strip] }
+        [match[1], attrs_with_types]
+      end
+
+      def body_attributes(body)
+        body.scan(ATTRIBUTE_DEF).map(&:first).uniq
+      end
+
+      def each_element(paths, &block)
+        paths.each do |path|
+          scan_file(path, &block)
+        end
+      end
+
+      def scan_file(path)
+        src = File.read(path)
+        src.scan(ELEMENT_DEF) do
+          match = Regexp.last_match
+          body = balanced_body(src, match.end(0))
+          next unless body
+
+          element_name = match[2].sub(/^idPkg:/, "")
+          yield(element_name, body)
+        end
+      end
+
+      # The balanced-brace body starting just after `from` (which
+      # points past the opening brace); nil when unterminated.
+      def balanced_body(src, from)
+        depth = 1
+        i = from
+        while i < src.length && depth.positive?
+          case src[i]
+          when "{" then depth += 1
+          when "}" then depth -= 1
+          end
+          i += 1
+        end
+        return nil if depth.positive?
+
+        src[from...(i - 1)]
+      end
+    end
+  end
+end

data/lib/idml/schema.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Idml
+  # Namespace for adapters over the committed RelaxNG Compact
+  # schemas (`reference-docs/schemas/`). The RNC files are the
+  # authoritative interface of the Elements layer — this namespace
+  # turns them into data for the generator script and the
+  # conformance spec (two consumers, one seam).
+  module Schema
+    autoload :Rnc, "#{__dir__}/schema/rnc"
+  end
+end

data/lib/idml/version.rb

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

data/lib/idml.rb

@@ -18,6 +18,7 @@ module Idml
   autoload :Validation,         "#{__dir__}/idml/validation"
   autoload :Composition,        "#{__dir__}/idml/composition"
   autoload :Geometry,           "#{__dir__}/idml/geometry"
+  autoload :Schema,             "#{__dir__}/idml/schema"
   autoload :TextEngine,         "#{__dir__}/idml/text_engine"
   autoload :Render,             "#{__dir__}/idml/render"
   autoload :CLI,                "#{__dir__}/idml/cli"

data/scripts/rnc_to_lutaml.rb

@@ -10,21 +10,11 @@
 # Example:
 #   scripts/rnc_to_lutaml.rb reference-docs/schemas/package/Stories/Story.rnc Story_Object
 #
-# The script reads the named element definition (e.g.,
-# `Story_Object = element Story { ... }`), extracts every `attribute
-# Name { Type }?` line, and prints Ruby code suitable for pasting
-# into a Lutaml::Model::Serializable subclass.
-#
-# Generated output:
-#   attribute :self_attr, :string
-#   attribute :first_line_indent, :float
-#   # ... etc.
-#   xml do
-#     map_attribute "Self", to: :self_attr
-#     map_attribute "FirstLineIndent", to: :first_line_indent
-#   end
+# RNC parsing lives in Idml::Schema::Rnc (shared with the
+# schema-conformance spec); this script owns presentation only.
 
-require "strscan"
+$LOAD_PATH.unshift File.expand_path("../lib", __dir__)
+require "idml"
 
 RESERVED_RUBY_NAMES = %w[self class integer float string end do begin ensure
                          rescue retry next return break yield nil true false].freeze
@@ -56,59 +46,25 @@ def ruby_attr_name(xml_name)
   base
 end
 
-def extract_element(rnc_path, element_name)
-  src = File.read(rnc_path)
-  pattern = /#{Regexp.escape(element_name)}\s*=\s*element\s+([\w:]+)\s*\{/
-  match = src.match(pattern)
-  abort "#{element_name} not found in #{rnc_path}" unless match
-
-  xml_element_name = match[1]
-  start_pos = match.end(0)
-
-  # Walk the brace structure to find the matching close.
-  depth = 1
-  i = start_pos
-  while i < src.length && depth.positive?
-    case src[i]
-    when "{" then depth += 1
-    when "}" then depth -= 1
-    end
-    i += 1
-  end
-  body = src[start_pos...(i - 1)]
-
-  [xml_element_name, body]
-end
-
-def extract_attributes(body)
-  attrs = []
-  body.scan(/^\s*attribute\s+(\w+)\s*\{\s*([^}]+)\}/) do |name, type|
-    attrs << [name, type.strip]
-  end
-  attrs
-end
-
 rnc_path, element_name = ARGV
 abort "usage: #{$PROGRAM_NAME} <rnc-file> <ElementName>" unless rnc_path && element_name
 
-xml_root, body = extract_element(rnc_path, element_name)
-attrs = extract_attributes(body)
+xml_root, attrs = Idml::Schema::Rnc.element_definition(rnc_path, element_name)
+abort "#{element_name} not found in #{rnc_path}" unless xml_root
 
 puts "# xml root: <#{xml_root}>"
 puts "# source: #{rnc_path} (#{element_name})"
 puts "# #{attrs.length} attributes"
 puts
-puts "attribute :_placeholder_, :string # remove me"
-puts
-puts "xml do"
-puts "  root \"#{xml_root.sub(/^idPkg:/, '')}\""
-attrs.each do |name, _type| # rubocop:disable Style/HashEachMethods
-  puts %(  map_attribute "#{name}", to: :#{ruby_attr_name(name)}")
-end
-puts "end"
-puts
 puts "# attribute declarations:"
 attrs.each do |name, type|
   lutaml = lutaml_type(type.split(/\s/).first)
   puts "attribute :#{ruby_attr_name(name)}, :#{lutaml}"
 end
+puts
+puts "xml do"
+puts %(  root "#{xml_root.sub(/^idPkg:/, '')}")
+attrs.each do |name, _type| # rubocop:disable Style/HashEachMethods
+  puts %(  map_attribute "#{name}", to: :#{ruby_attr_name(name)})
+end
+puts "end"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: idml
 version: !ruby/object:Gem::Version
-  version: 0.10.12
+  version: 0.10.13
 platform: ruby
 authors:
 - Ribose
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2026-08-30 00:00:00.000000000 Z
+date: 2026-08-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bigdecimal
@@ -215,6 +215,7 @@ files:
 - TODO.pdf/149-architecture-round-two.md
 - TODO.pdf/15-wire-spread-children.md
 - TODO.pdf/150-architecture-round-three.md
+- TODO.pdf/151-schema-conformance.md
 - TODO.pdf/16-typed-model-pipeline.md
 - TODO.pdf/17-shape-rendering.md
 - TODO.pdf/18-text-rendering.md
@@ -352,6 +353,7 @@ files:
 - lib/idml/elements/ink.rb
 - lib/idml/elements/inner_glow_setting.rb
 - lib/idml/elements/inner_shadow_setting.rb
+- lib/idml/elements/inset_spacing.rb
 - lib/idml/elements/layer.rb
 - lib/idml/elements/link.rb
 - lib/idml/elements/master_spread_object.rb
@@ -527,6 +529,8 @@ files:
 - lib/idml/render/style_resolver.rb
 - lib/idml/render/text_wrap_resolver.rb
 - lib/idml/render/wrap_contour.rb
+- lib/idml/schema.rb
+- lib/idml/schema/rnc.rb
 - lib/idml/text_engine.rb
 - lib/idml/text_engine/cjk_layout.rb
 - lib/idml/text_engine/justifier.rb