coradoc-mirror 0.1.7 → 0.1.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 29f073186a23485753658ba4782ec7022461c2869351d6bb273eda9f30fda92e
-  data.tar.gz: aee881fe73fa219d89415deb8b6eb0e9a509cbd4b5b71b3f4ddfe6456ef114f8
+  metadata.gz: 0d0dddcebf58649933def45133c70a5ed3caf8f1441d1a789b9ea95d49fa8d24
+  data.tar.gz: 6275f1315af45cb267762a26862bdcb1d2bb65e29fd4657cd411a98200b6c0f9
 SHA512:
-  metadata.gz: beabd828aeb5e91a4a3c9e6049045123a2c4884ceef8a9887d4ec27874242a22e36661d2f807a67cbb7bc4a19b4616b8b578463d4ecfb763d98fcf56d5c5a591
-  data.tar.gz: 23e77c6e5dc7605ba5e4ff8a4cab88efc7433c30554cb5afcb71cff4345d4dc6906ca2efa03d58034e07f6a594e543c7291e9dd88e02f2f458fb5c6c197cdee9
+  metadata.gz: 13c8d02108886f582cf93f501a9e503361c450c224f0105e255583200323bd4d170d3303b2250510922ee4dad0aa92b45a987caf690528098f77d90b18e2672a
+  data.tar.gz: 3eef4445a831dfce49faaa0e777ad4cd28fb54d9d7b71db640e45585ea557267f87b831031839da32077bf6886ae53f9d085e65200ac6aa2cc939c393f93df1d

data/lib/coradoc/mirror/core_model_to_mirror.rb

@@ -164,9 +164,26 @@ module Coradoc
         value, concat = result
         return unless value
 
+        propagate_source_line(value, element)
         concat ? content.concat(Array(value)) : content << value
       end
 
+      # Copy parser-attached source_line from the CoreModel element onto
+      # every Mirror node the handler produced. Single touchpoint for the
+      # entire CoreModel → Mirror direction — handlers stay focused on
+      # per-type mapping and don't repeat this concern (DRY).
+      def propagate_source_line(value, element)
+        line = element.source_line
+        return unless line
+
+        Array(value).each do |node|
+          next unless node.is_a?(Node)
+          next if node.source_line
+
+          node.source_line = line
+        end
+      end
+
       def build_document_attrs(document)
         attrs = {}
         attrs[:title] = document.title if document.title

data/lib/coradoc/mirror/handlers/inline.rb

@@ -123,12 +123,56 @@ module Coradoc
           end
 
           def build_simple_mark(element, context, mark_class)
+            # When the mark carries parsed children (Bug 16B — nested
+            # inline marks like `**bold \`code\`**`), walk the children
+            # and apply this mark to each text leaf. Inner mark elements
+            # get the outer mark added to their marks list, producing
+            # ProseMirror's flat text-node-with-marks shape.
+            if element.children&.any?
+              return flatten_marked_children(element.children, [mark_class.new], context)
+            end
+
             text = extract_inline_text(element)
             return nil if text.empty?
 
             context.text_node(text, marks: [mark_class.new])
           end
 
+          # Walk a list of children, attaching the active set of marks
+          # to each text leaf. When a child is itself an InlineElement
+          # with its own mark (e.g. CodeElement inside BoldElement),
+          # the inner mark is added to the active set and recursion
+          # proceeds into its children. Produces the conjunction of
+          # marks for each text run that ProseMirror expects:
+          #   **a `b` c** → text("a ", [bold]), text("b", [bold, code]), text(" c", [bold])
+          def flatten_marked_children(children, active_marks, context)
+            result = []
+            children.each do |child|
+              case child
+              when CoreModel::TextContent
+                next if child.text.nil? || child.text.empty?
+
+                result << context.text_node(child.text, marks: active_marks.dup)
+              when CoreModel::InlineElement
+                inner_mark_class = SIMPLE_MARK_TYPES[child.class]
+                if inner_mark_class && child.children&.any?
+                  combined = active_marks + [inner_mark_class.new]
+                  result.concat(flatten_marked_children(child.children, combined, context))
+                elsif inner_mark_class
+                  text = extract_inline_text(child)
+                  next if text.empty?
+
+                  combined = active_marks + [inner_mark_class.new]
+                  result << context.text_node(text, marks: combined)
+                else
+                  nested = dispatch_inline(child, context)
+                  result << nested if nested
+                end
+              end
+            end
+            result
+          end
+
           def build_link_mark(element, context)
             text = extract_inline_text(element)
             text = element.target.to_s if text.empty? && element.target
@@ -208,7 +252,11 @@ module Coradoc
           def extract_inline_text(element)
             return element.content.to_s if element.content && !element.content.to_s.empty?
 
-            return element.nested_elements.map { |nested| extract_inline_text(nested) }.join if element.is_a?(CoreModel::InlineElement) && element.nested_elements
+            if element.is_a?(CoreModel::InlineElement) && element.nested_elements
+              return element.nested_elements.map do |nested|
+                extract_inline_text(nested)
+              end.join
+            end
 
             if (element.is_a?(CoreModel::InlineElement) || element.is_a?(CoreModel::Block)) && element.children && !element.children.empty?
               return element.children.map do |child|

data/lib/coradoc/mirror/mirror_to_core_model.rb

@@ -19,7 +19,27 @@ module Coradoc
         builder_class = ReverseBuilder.lookup(node.type)
         raise Error, "Unknown mirror node type: #{node.type}" unless builder_class
 
-        builder_class.new(self).build(node)
+        result = builder_class.new(self).build(node)
+        propagate_source_line(result, node)
+        result
+      end
+
+      # Copy parser-attached source_line from the Mirror node onto every
+      # CoreModel node the builder produced. Single touchpoint for the
+      # entire Mirror → CoreModel direction — builders stay focused on
+      # per-type mapping and don't repeat this concern (DRY).
+      def propagate_source_line(result, node)
+        return unless node.is_a?(Node)
+
+        line = node.source_line
+        return unless line
+
+        Array(result).each do |built|
+          next unless built.is_a?(CoreModel::Base)
+          next if built.source_line
+
+          built.source_line = line
+        end
       end
 
       # ── Shared helpers (single source of truth — used by every

data/lib/coradoc/mirror/node.rb

@@ -29,6 +29,13 @@ module Coradoc
       attribute :type, :string, default: -> { self.class::PM_TYPE }
       attribute :content, Node, collection: true
       attribute :marks, Mark, collection: true
+      # Parser metadata, single source of truth on the wire side too.
+      # Carried in memory so CoreModel → Mirror → CoreModel round-trips
+      # preserve the source location. Intentionally absent from every
+      # subclass `key_value` block: source_line is not part of the
+      # ProseMirror JSON contract — editor consumers don't need it, and
+      # serializing it would leak parser internals onto the wire.
+      attribute :source_line, :integer
 
       key_value do
         map 'type', to: :type, render_default: true

data/lib/coradoc/mirror/reverse_builder/abstract.rb

@@ -1,13 +1,9 @@
 # frozen_string_literal: true
 
-require_relative 'base'
-
 module Coradoc
   module Mirror
     module ReverseBuilder
       class Abstract < Base
-        registers 'abstract_block'
-
         def build(node)
           CoreModel::AbstractBlock.new(
             title: node.attrs&.title,

data/lib/coradoc/mirror/reverse_builder/admonition.rb

@@ -1,13 +1,9 @@
 # frozen_string_literal: true
 
-require_relative 'base'
-
 module Coradoc
   module Mirror
     module ReverseBuilder
       class Admonition < Base
-        registers 'admonition'
-
         def build(node)
           CoreModel::AnnotationBlock.new(
             annotation_type: node.attrs&.admonition_type,

data/lib/coradoc/mirror/reverse_builder/biblio_entry.rb

@@ -1,13 +1,9 @@
 # frozen_string_literal: true
 
-require_relative 'base'
-
 module Coradoc
   module Mirror
     module ReverseBuilder
       class BiblioEntry < Base
-        registers 'biblio_entry'
-
         def build(node)
           attrs = node.attrs
           CoreModel::BibliographyEntry.new(

data/lib/coradoc/mirror/reverse_builder/bibliography.rb

@@ -1,13 +1,9 @@
 # frozen_string_literal: true
 
-require_relative 'base'
-
 module Coradoc
   module Mirror
     module ReverseBuilder
       class Bibliography < Base
-        registers 'bibliography'
-
         def build(node)
           entries = build_content(node).select { |c| c.is_a?(CoreModel::BibliographyEntry) }
           CoreModel::Bibliography.new(title: node.attrs&.title, entries: entries)

data/lib/coradoc/mirror/reverse_builder/blockquote.rb

@@ -1,13 +1,9 @@
 # frozen_string_literal: true
 
-require_relative 'base'
-
 module Coradoc
   module Mirror
     module ReverseBuilder
       class Blockquote < Base
-        registers 'quote'
-
         def build(node)
           CoreModel::QuoteBlock.new(
             attribution: node.attrs&.attribution,

data/lib/coradoc/mirror/reverse_builder/bullet_list.rb

@@ -1,13 +1,9 @@
 # frozen_string_literal: true
 
-require_relative 'base'
-
 module Coradoc
   module Mirror
     module ReverseBuilder
       class BulletList < Base
-        registers 'bullet_list'
-
         def build(node)
           items = build_content(node).select { |c| c.is_a?(CoreModel::ListItem) }
           CoreModel::ListBlock.new(marker_type: 'unordered', items: items)

data/lib/coradoc/mirror/reverse_builder/caption.rb

@@ -1,15 +1,11 @@
 # frozen_string_literal: true
 
-require_relative 'base'
-
 module Coradoc
   module Mirror
     module ReverseBuilder
       # Caption only appears as a Figure child. If encountered standalone,
       # extract its text as an inline element so it isn't lost.
       class Caption < Base
-        registers 'caption'
-
         def build(node)
           CoreModel::InlineElement.new(content: extract_text(node))
         end

data/lib/coradoc/mirror/reverse_builder/code_block.rb

@@ -1,13 +1,9 @@
 # frozen_string_literal: true
 
-require_relative 'base'
-
 module Coradoc
   module Mirror
     module ReverseBuilder
       class CodeBlock < Base
-        registers 'sourcecode'
-
         def build(node)
           attrs = node.attrs
           CoreModel::SourceBlock.new(

data/lib/coradoc/mirror/reverse_builder/definition_list.rb

@@ -1,13 +1,9 @@
 # frozen_string_literal: true
 
-require_relative 'base'
-
 module Coradoc
   module Mirror
     module ReverseBuilder
       class DefinitionList < Base
-        registers 'dl'
-
         def build(node)
           terms = []
           descriptions = []

data/lib/coradoc/mirror/reverse_builder/document.rb

@@ -1,13 +1,9 @@
 # frozen_string_literal: true
 
-require_relative 'base'
-
 module Coradoc
   module Mirror
     module ReverseBuilder
       class Document < Base
-        registers 'doc'
-
         def build(node)
           attrs = node.attrs
           CoreModel::DocumentElement.new(

data/lib/coradoc/mirror/reverse_builder/example.rb

@@ -1,13 +1,9 @@
 # frozen_string_literal: true
 
-require_relative 'base'
-
 module Coradoc
   module Mirror
     module ReverseBuilder
       class Example < Base
-        registers 'example'
-
         def build(node)
           CoreModel::ExampleBlock.new(
             title: node.attrs&.title,

data/lib/coradoc/mirror/reverse_builder/figure.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require_relative 'base'
-
 module Coradoc
   module Mirror
     module ReverseBuilder
@@ -9,8 +7,6 @@ module Coradoc
       # caption. Reverse: collapse back to a single CoreModel::Image,
       # promoting the caption child to `caption:` if present.
       class Figure < Base
-        registers 'figure'
-
         def build(node)
           image_child = node.content&.find { |c| c.is_a?(Node) && c.type == 'image' }
           return nil unless image_child

data/lib/coradoc/mirror/reverse_builder/footnote_entry.rb

@@ -1,13 +1,9 @@
 # frozen_string_literal: true
 
-require_relative 'base'
-
 module Coradoc
   module Mirror
     module ReverseBuilder
       class FootnoteEntry < Base
-        registers 'footnote_entry'
-
         def build(node)
           attrs = node.attrs
           CoreModel::Footnote.new(id: attrs&.id, content: extract_text(node))

data/lib/coradoc/mirror/reverse_builder/footnote_marker.rb

@@ -1,15 +1,11 @@
 # frozen_string_literal: true
 
-require_relative 'base'
-
 module Coradoc
   module Mirror
     module ReverseBuilder
       # Inline footnote marker (JS `footnote_marker`). The CoreModel
       # FootnoteReference holds the same id/ref/number triple.
       class FootnoteMarker < Base
-        registers 'footnote_marker'
-
         def build(node)
           attrs = node.attrs
           CoreModel::FootnoteReference.new(

data/lib/coradoc/mirror/reverse_builder/footnotes.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require_relative 'base'
-
 module Coradoc
   module Mirror
     module ReverseBuilder
@@ -9,8 +7,6 @@ module Coradoc
       # no CoreModel equivalent (each entry is built separately). Returns
       # nil so build_content filters it out.
       class Footnotes < Base
-        registers 'footnotes'
-
         def build(_node)
           nil
         end

data/lib/coradoc/mirror/reverse_builder/frontmatter.rb

@@ -1,13 +1,9 @@
 # frozen_string_literal: true
 
-require_relative 'base'
-
 module Coradoc
   module Mirror
     module ReverseBuilder
       class Frontmatter < Base
-        registers 'frontmatter'
-
         def build(node)
           attrs = node.attrs
           CoreModel::FrontmatterBlock.new(

data/lib/coradoc/mirror/reverse_builder/generic_block.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require_relative 'base'
-
 module Coradoc
   module Mirror
     module ReverseBuilder
@@ -9,8 +7,6 @@ module Coradoc
       # direction (`Node::GenericBlock`). Preserves the semantic_type so
       # downstream consumers can dispatch on it.
       class GenericBlock < Base
-        registers 'generic_block'
-
         def build(node)
           attrs = node.attrs
           CoreModel::Block.new(

data/lib/coradoc/mirror/reverse_builder/hard_break.rb

@@ -1,13 +1,9 @@
 # frozen_string_literal: true
 
-require_relative 'base'
-
 module Coradoc
   module Mirror
     module ReverseBuilder
       class HardBreak < Base
-        registers 'hard_break'
-
         def build(_node)
           CoreModel::HardLineBreakElement.new(content: '')
         end

data/lib/coradoc/mirror/reverse_builder/header.rb

@@ -1,13 +1,9 @@
 # frozen_string_literal: true
 
-require_relative 'base'
-
 module Coradoc
   module Mirror
     module ReverseBuilder
       class Header < Base
-        registers 'floating_title', 'heading'
-
         def build(node)
           attrs = node.attrs
           CoreModel::HeaderElement.new(

data/lib/coradoc/mirror/reverse_builder/horizontal_rule.rb

@@ -1,13 +1,9 @@
 # frozen_string_literal: true
 
-require_relative 'base'
-
 module Coradoc
   module Mirror
     module ReverseBuilder
       class HorizontalRule < Base
-        registers 'horizontal_rule', 'thematic_break'
-
         def build(_node)
           CoreModel::HorizontalRuleBlock.new
         end

data/lib/coradoc/mirror/reverse_builder/image.rb

@@ -1,13 +1,9 @@
 # frozen_string_literal: true
 
-require_relative 'base'
-
 module Coradoc
   module Mirror
     module ReverseBuilder
       class Image < Base
-        registers 'image'
-
         def build(node)
           attrs = node.attrs
           CoreModel::Image.new(

data/lib/coradoc/mirror/reverse_builder/include.rb

@@ -1,15 +1,11 @@
 # frozen_string_literal: true
 
-require_relative 'base'
-
 module Coradoc
   module Mirror
     module ReverseBuilder
       # Include directive: round-trips back to a CoreModel::Include link
       # node. The text graph is preserved through mirror_json → core.
       class Include < Base
-        registers 'include'
-
         def build(node)
           attrs = node.attrs
           CoreModel::Include.new(

data/lib/coradoc/mirror/reverse_builder/inline_text.rb

@@ -1,13 +1,9 @@
 # frozen_string_literal: true
 
-require_relative 'base'
-
 module Coradoc
   module Mirror
     module ReverseBuilder
       class InlineText < Base
-        registers 'dt', 'dd'
-
         def build(node)
           children = build_inline_children(node)
           text = children.map { |c| c.is_a?(CoreModel::TextContent) ? c.text : '' }.join

data/lib/coradoc/mirror/reverse_builder/list_item.rb

@@ -1,13 +1,9 @@
 # frozen_string_literal: true
 
-require_relative 'base'
-
 module Coradoc
   module Mirror
     module ReverseBuilder
       class ListItem < Base
-        registers 'list_item'
-
         LIST_TYPES = %w[bullet_list ordered_list].freeze
         private_constant :LIST_TYPES
 

data/lib/coradoc/mirror/reverse_builder/literal_block.rb

@@ -1,13 +1,9 @@
 # frozen_string_literal: true
 
-require_relative 'base'
-
 module Coradoc
   module Mirror
     module ReverseBuilder
       class LiteralBlock < Base
-        registers 'literal'
-
         def build(node)
           attrs = node.attrs
           CoreModel::LiteralBlock.new(

data/lib/coradoc/mirror/reverse_builder/open_block.rb

@@ -1,13 +1,9 @@
 # frozen_string_literal: true
 
-require_relative 'base'
-
 module Coradoc
   module Mirror
     module ReverseBuilder
       class OpenBlock < Base
-        registers 'open_block'
-
         def build(node)
           CoreModel::OpenBlock.new(children: build_content(node))
         end

data/lib/coradoc/mirror/reverse_builder/ordered_list.rb

@@ -1,13 +1,9 @@
 # frozen_string_literal: true
 
-require_relative 'base'
-
 module Coradoc
   module Mirror
     module ReverseBuilder
       class OrderedList < Base
-        registers 'ordered_list'
-
         def build(node)
           items = build_content(node).select { |c| c.is_a?(CoreModel::ListItem) }
           CoreModel::ListBlock.new(marker_type: 'ordered', items: items)

data/lib/coradoc/mirror/reverse_builder/paragraph.rb

@@ -1,13 +1,9 @@
 # frozen_string_literal: true
 
-require_relative 'base'
-
 module Coradoc
   module Mirror
     module ReverseBuilder
       class Paragraph < Base
-        registers 'paragraph'
-
         def build(node)
           CoreModel::ParagraphBlock.new(children: build_inline_children(node))
         end

data/lib/coradoc/mirror/reverse_builder/partintro.rb

@@ -1,13 +1,9 @@
 # frozen_string_literal: true
 
-require_relative 'base'
-
 module Coradoc
   module Mirror
     module ReverseBuilder
       class Partintro < Base
-        registers 'partintro_block'
-
         def build(node)
           CoreModel::PartintroBlock.new(
             title: node.attrs&.title,

data/lib/coradoc/mirror/reverse_builder/pass_block.rb

@@ -1,13 +1,9 @@
 # frozen_string_literal: true
 
-require_relative 'base'
-
 module Coradoc
   module Mirror
     module ReverseBuilder
       class PassBlock < Base
-        registers 'pass'
-
         def build(node)
           attrs = node.attrs
           CoreModel::PassBlock.new(

data/lib/coradoc/mirror/reverse_builder/preamble.rb

@@ -1,13 +1,9 @@
 # frozen_string_literal: true
 
-require_relative 'base'
-
 module Coradoc
   module Mirror
     module ReverseBuilder
       class Preamble < Base
-        registers 'preface'
-
         def build(node)
           CoreModel::PreambleElement.new(children: build_content(node))
         end

data/lib/coradoc/mirror/reverse_builder/raw_inline.rb

@@ -1,13 +1,9 @@
 # frozen_string_literal: true
 
-require_relative 'base'
-
 module Coradoc
   module Mirror
     module ReverseBuilder
       class RawInline < Base
-        registers 'raw_inline'
-
         def build(node)
           CoreModel::RawInlineElement.new(content: node.text.to_s)
         end

data/lib/coradoc/mirror/reverse_builder/section.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require_relative 'base'
-
 module Coradoc
   module Mirror
     module ReverseBuilder
@@ -9,10 +7,6 @@ module Coradoc
       # information lives in the original AsciiDoc and is preserved only
       # on the forward side; the reverse side collapses them.
       class Section < Base
-        registers 'section', 'clause', 'annex', 'content_section',
-                  'abstract', 'foreword', 'introduction',
-                  'acknowledgements', 'terms', 'definitions', 'references'
-
         def build(node)
           attrs = node.attrs
           CoreModel::SectionElement.new(

data/lib/coradoc/mirror/reverse_builder/sections.rb

@@ -1,15 +1,11 @@
 # frozen_string_literal: true
 
-require_relative 'base'
-
 module Coradoc
   module Mirror
     module ReverseBuilder
       # `sections` is a structural container only — unwrap directly into
       # an array. MirrorToCoreModel#build_content flattens arrays.
       class Sections < Base
-        registers 'sections'
-
         def build(node)
           build_content(node)
         end

data/lib/coradoc/mirror/reverse_builder/sidebar.rb

@@ -1,13 +1,9 @@
 # frozen_string_literal: true
 
-require_relative 'base'
-
 module Coradoc
   module Mirror
     module ReverseBuilder
       class Sidebar < Base
-        registers 'sidebar'
-
         def build(node)
           CoreModel::SidebarBlock.new(
             title: node.attrs&.title,

data/lib/coradoc/mirror/reverse_builder/soft_break.rb

@@ -1,13 +1,9 @@
 # frozen_string_literal: true
 
-require_relative 'base'
-
 module Coradoc
   module Mirror
     module ReverseBuilder
       class SoftBreak < Base
-        registers 'soft_break'
-
         def build(_node)
           CoreModel::LineBreakElement.new
         end

data/lib/coradoc/mirror/reverse_builder/stem_block.rb

@@ -1,13 +1,9 @@
 # frozen_string_literal: true
 
-require_relative 'base'
-
 module Coradoc
   module Mirror
     module ReverseBuilder
       class StemBlock < Base
-        registers 'stem'
-
         def build(node)
           attrs = node.attrs
           CoreModel::StemBlock.new(

data/lib/coradoc/mirror/reverse_builder/table.rb

@@ -1,13 +1,9 @@
 # frozen_string_literal: true
 
-require_relative 'base'
-
 module Coradoc
   module Mirror
     module ReverseBuilder
       class Table < Base
-        registers 'table'
-
         def build(node)
           rows = []
           node.content&.each do |child|

data/lib/coradoc/mirror/reverse_builder/table_body.rb

@@ -1,13 +1,9 @@
 # frozen_string_literal: true
 
-require_relative 'base'
-
 module Coradoc
   module Mirror
     module ReverseBuilder
       class TableBody < Base
-        registers 'table_body'
-
         def build(node)
           build_content(node).first || CoreModel::TableRow.new
         end

data/lib/coradoc/mirror/reverse_builder/table_cell.rb

@@ -1,13 +1,9 @@
 # frozen_string_literal: true
 
-require_relative 'base'
-
 module Coradoc
   module Mirror
     module ReverseBuilder
       class TableCell < Base
-        registers 'table_cell'
-
         def build(node)
           attrs = node.attrs
           CoreModel::TableCell.new(

data/lib/coradoc/mirror/reverse_builder/table_head.rb

@@ -1,13 +1,9 @@
 # frozen_string_literal: true
 
-require_relative 'base'
-
 module Coradoc
   module Mirror
     module ReverseBuilder
       class TableHead < Base
-        registers 'table_head'
-
         def build(node)
           build_content(node).first || CoreModel::TableRow.new
         end

data/lib/coradoc/mirror/reverse_builder/table_row.rb

@@ -1,13 +1,9 @@
 # frozen_string_literal: true
 
-require_relative 'base'
-
 module Coradoc
   module Mirror
     module ReverseBuilder
       class TableRow < Base
-        registers 'table_row'
-
         def build(node)
           cells = build_content(node).select { |c| c.is_a?(CoreModel::TableCell) }
           CoreModel::TableRow.new(cells: cells)

data/lib/coradoc/mirror/reverse_builder/text.rb

@@ -1,13 +1,9 @@
 # frozen_string_literal: true
 
-require_relative 'base'
-
 module Coradoc
   module Mirror
     module ReverseBuilder
       class Text < Base
-        registers 'text'
-
         def build(node)
           text = node.text || ''
           marks = node.marks || []

data/lib/coradoc/mirror/reverse_builder/toc.rb

@@ -1,13 +1,9 @@
 # frozen_string_literal: true
 
-require_relative 'base'
-
 module Coradoc
   module Mirror
     module ReverseBuilder
       class Toc < Base
-        registers 'toc'
-
         def build(_node)
           CoreModel::Toc.new
         end

data/lib/coradoc/mirror/reverse_builder/toc_entry.rb

@@ -1,13 +1,9 @@
 # frozen_string_literal: true
 
-require_relative 'base'
-
 module Coradoc
   module Mirror
     module ReverseBuilder
       class TocEntry < Base
-        registers 'toc_entry'
-
         def build(node)
           attrs = node.attrs
           CoreModel::TocEntry.new(id: attrs&.id, title: attrs&.title)

data/lib/coradoc/mirror/reverse_builder/verse.rb

@@ -1,13 +1,9 @@
 # frozen_string_literal: true
 
-require_relative 'base'
-
 module Coradoc
   module Mirror
     module ReverseBuilder
       class Verse < Base
-        registers 'verse'
-
         def build(node)
           CoreModel::VerseBlock.new(
             content: extract_text(node),

data/lib/coradoc/mirror/reverse_builder.rb

@@ -2,34 +2,117 @@
 
 module Coradoc
   module Mirror
-    # OCP-compliant registry for Mirror node -> CoreModel transformation.
+    # OCP-compliant registry for Mirror node → CoreModel transformation.
     #
-    # Adding support for a new Mirror node type is purely additive:
+    # Single source of truth: the TYPE_TO_FILE table below maps every
+    # Mirror wire type string (and its aliases) to the file that
+    # implements its builder. Two things derive from this one table:
     #
-    #   # reverse_builder/<name>.rb
-    #   require_relative 'base'
-    #   module Coradoc::Mirror::ReverseBuilder
-    #     class Figure < Base
-    #       registers 'figure'
-    #       def build(node) = CoreModel::Image.new(...)
-    #     end
-    #   end
+    #   1. autoload declarations — one per unique file, so builders
+    #      load lazily on first lookup (no 47-file eager load at boot).
+    #   2. lookup() — type → file → const_get, which triggers autoload.
     #
-    # Then add a single `require_relative` for the new file below. No edits
-    # to MirrorToCoreModel or any other existing class — the registry is
-    # the single source of truth for "which type string maps to which
-    # builder" (MECE).
+    # Adding a new built-in builder is purely additive:
     #
-    # This file is the autoload target for the ReverseBuilder constant
-    # (see coradoc/mirror.rb). Each Builder subclass lives in its own
-    # file under reverse_builder/; eager-requiring them here populates
-    # the REGISTRY at load time so every caller sees a full registry.
-    # Mirror-level mark dispatch lives in MarkReverseBuilder
-    # (mark_reverse_builder.rb).
+    #   1. Add `'<wire_type>' => '<file_basename>'` to TYPE_TO_FILE.
+    #   2. Create `reverse_builder/<file_basename>.rb` defining
+    #      `class <CamelizedName> < Base; def build(node); ...; end; end`.
+    #
+    # No edits to this file beyond the table — autoload and lookup
+    # adapt automatically. Mirror-level mark dispatch lives in
+    # MarkReverseBuilder (mark_reverse_builder.rb).
+    #
+    # Third-party / runtime builders can still register via
+    # `ReverseBuilder.register(type, klass)`; they take precedence over
+    # built-in autoload entries.
     module ReverseBuilder
-      # Not frozen: subclasses call `register` from their class body at
-      # load time, and `registers` may fire late via autoload. Freezing
-      # here breaks the first mirror-to-core round-trip after load.
+      autoload :Base, "#{__dir__}/reverse_builder/base"
+
+      # Wire type string → file basename under reverse_builder/.
+      # Aliases (e.g. 'clause' and 'annex' both route to section) are
+      # expressed by mapping multiple type strings to the same file.
+      TYPE_TO_FILE = {
+        'doc' => 'document',
+        'section' => 'section',
+        'clause' => 'section',
+        'annex' => 'section',
+        'content_section' => 'section',
+        'abstract' => 'section',
+        'foreword' => 'section',
+        'introduction' => 'section',
+        'acknowledgements' => 'section',
+        'terms' => 'section',
+        'definitions' => 'section',
+        'references' => 'section',
+        'sections' => 'sections',
+        'preface' => 'preamble',
+        'floating_title' => 'header',
+        'heading' => 'header',
+        'paragraph' => 'paragraph',
+        'sourcecode' => 'code_block',
+        'literal' => 'literal_block',
+        'pass' => 'pass_block',
+        'stem' => 'stem_block',
+        'quote' => 'blockquote',
+        'example' => 'example',
+        'sidebar' => 'sidebar',
+        'abstract_block' => 'abstract',
+        'partintro_block' => 'partintro',
+        'open_block' => 'open_block',
+        'verse' => 'verse',
+        'horizontal_rule' => 'horizontal_rule',
+        'thematic_break' => 'horizontal_rule',
+        'soft_break' => 'soft_break',
+        'hard_break' => 'hard_break',
+        'admonition' => 'admonition',
+        'bullet_list' => 'bullet_list',
+        'ordered_list' => 'ordered_list',
+        'list_item' => 'list_item',
+        'dl' => 'definition_list',
+        'dt' => 'inline_text',
+        'dd' => 'inline_text',
+        'image' => 'image',
+        'figure' => 'figure',
+        'caption' => 'caption',
+        'include' => 'include',
+        'table' => 'table',
+        'table_head' => 'table_head',
+        'table_body' => 'table_body',
+        'table_row' => 'table_row',
+        'table_cell' => 'table_cell',
+        'bibliography' => 'bibliography',
+        'biblio_entry' => 'biblio_entry',
+        'footnotes' => 'footnotes',
+        'footnote_entry' => 'footnote_entry',
+        'footnote_marker' => 'footnote_marker',
+        'toc' => 'toc',
+        'toc_entry' => 'toc_entry',
+        'text' => 'text',
+        'raw_inline' => 'raw_inline',
+        'frontmatter' => 'frontmatter',
+        'generic_block' => 'generic_block'
+      }.freeze
+
+      # File basename → Ruby constant name. Derived from the file name
+      # using the project-wide snake_case → CamelCase convention
+      # (every existing builder follows it). Declared once here so
+      # adding a builder that follows convention requires no extra
+      # wiring.
+      FILE_TO_CLASS = TYPE_TO_FILE.each_value.each_with_object({}) do |file, acc|
+        next if acc.key?(file)
+
+        acc[file] = file.split('_').map(&:capitalize).join
+      end.freeze
+
+      # Lazy-load each builder. Lookup triggers autoload via const_get.
+      FILE_TO_CLASS.each do |file, const_name|
+        autoload const_name.to_sym, "#{__dir__}/reverse_builder/#{file}"
+      end
+
+      # Runtime registrations from third-party / external builders.
+      # Takes precedence over built-in autoload entries so external
+      # code can override built-in behaviour (e.g. a custom Paragraph).
+      # Not frozen: register() writes here at runtime.
       REGISTRY = {}
 
       module_function
@@ -38,63 +121,27 @@ module Coradoc
         REGISTRY[type] = builder_class
       end
 
+      # DSL for subclasses to self-register at load time. Kept for
+      # backward compatibility with the existing OCP test pattern that
+      # creates synthetic builders via `Class.new(Base) { registers(...) }`.
+      # Built-in builders no longer call this — their dispatch is
+      # derived from TYPE_TO_FILE.
+      def registers(*types)
+        types.each { |t| register(t, self) }
+      end
+
       def lookup(type)
-        REGISTRY[type]
+        return REGISTRY[type] if REGISTRY.key?(type)
+
+        file = TYPE_TO_FILE[type]
+        return nil unless file
+
+        const_get(FILE_TO_CLASS[file])
       end
 
       def registered_types
-        REGISTRY.keys
+        (REGISTRY.keys + TYPE_TO_FILE.keys).uniq
       end
-
-      # Base must load first — every subclass inherits from it. Then
-      # eager-load each Builder so its `registers` call runs.
-      require_relative 'reverse_builder/base'
-      require_relative 'reverse_builder/document'
-      require_relative 'reverse_builder/section'
-      require_relative 'reverse_builder/header'
-      require_relative 'reverse_builder/preamble'
-      require_relative 'reverse_builder/sections'
-      require_relative 'reverse_builder/paragraph'
-      require_relative 'reverse_builder/code_block'
-      require_relative 'reverse_builder/literal_block'
-      require_relative 'reverse_builder/pass_block'
-      require_relative 'reverse_builder/stem_block'
-      require_relative 'reverse_builder/blockquote'
-      require_relative 'reverse_builder/example'
-      require_relative 'reverse_builder/sidebar'
-      require_relative 'reverse_builder/abstract'
-      require_relative 'reverse_builder/partintro'
-      require_relative 'reverse_builder/open_block'
-      require_relative 'reverse_builder/verse'
-      require_relative 'reverse_builder/horizontal_rule'
-      require_relative 'reverse_builder/frontmatter'
-      require_relative 'reverse_builder/admonition'
-      require_relative 'reverse_builder/bullet_list'
-      require_relative 'reverse_builder/ordered_list'
-      require_relative 'reverse_builder/list_item'
-      require_relative 'reverse_builder/definition_list'
-      require_relative 'reverse_builder/inline_text'
-      require_relative 'reverse_builder/image'
-      require_relative 'reverse_builder/figure'
-      require_relative 'reverse_builder/caption'
-      require_relative 'reverse_builder/include'
-      require_relative 'reverse_builder/table'
-      require_relative 'reverse_builder/table_head'
-      require_relative 'reverse_builder/table_body'
-      require_relative 'reverse_builder/table_row'
-      require_relative 'reverse_builder/table_cell'
-      require_relative 'reverse_builder/bibliography'
-      require_relative 'reverse_builder/biblio_entry'
-      require_relative 'reverse_builder/footnotes'
-      require_relative 'reverse_builder/footnote_entry'
-      require_relative 'reverse_builder/footnote_marker'
-      require_relative 'reverse_builder/toc'
-      require_relative 'reverse_builder/toc_entry'
-      require_relative 'reverse_builder/text'
-      require_relative 'reverse_builder/raw_inline'
-      require_relative 'reverse_builder/soft_break'
-      require_relative 'reverse_builder/hard_break'
-      require_relative 'reverse_builder/generic_block'
     end
   end
 end

data/lib/coradoc/mirror/version.rb

@@ -2,6 +2,6 @@
 
 module Coradoc
   module Mirror
-    VERSION = '0.1.7'
+    VERSION = '0.1.9'
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: coradoc-mirror
 version: !ruby/object:Gem::Version
-  version: 0.1.7
+  version: 0.1.9
 platform: ruby
 authors:
 - Ribose Inc.