coradoc 2.0.24 → 2.0.26

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bcce76c634ae51a857397a301fc2638950cb25e1a97048589ee5510f8a7aee40
-  data.tar.gz: 6cd3b391ae83e360ed282b40f778dad1c4290202b386b457b881e264ddca464e
+  metadata.gz: 6b56fd30c086580f71f5b576a209ba6ad20c5aa590fbd09d62477a7f85a4988f
+  data.tar.gz: 8be8c3211cf7dc7d1545c8d86966687c645e4929046d65c54a4a2d4f6c9f5cd2
 SHA512:
-  metadata.gz: f424dfb3267d2497dc46b9e764fab868083add0ef5cd82163aa89a35b884e75b81c7426a47d9c0b81abd15659dcc15b49f6f309b786848cba7c0aed42557cf3a
-  data.tar.gz: 07fe25f772cf02b7673f25f4bb41e9abb65e25631898af071407eb68961bba9c2a74c19c7d20d85544c722a4ad07404c4846d389278fb989d2a186caab36bdbb
+  metadata.gz: 9d6ec746cd4a049f0668aa367091817faf0c87ed9c35840f3b548124836701c0f1ac6c0ddc99fcdcb5420e6c15e3f972eec6c869c055d464dc518049af4d242c
+  data.tar.gz: 33abcf1caabfb83b74f803affc8a12d4f74bd9290e0607d91a7033121db317229831c43da321edcf30dc3c97a080ca6b304c1186101dc17038867413ad8e802f

data/lib/coradoc/core_model/attribute_reference_resolver.rb

@@ -0,0 +1,143 @@
+# frozen_string_literal: true
+
+module Coradoc
+  module CoreModel
+    # Walks a CoreModel tree and resolves InlineElement nodes whose
+    # format_type is 'attribute_reference' against a Metadata store.
+    #
+    # AsciiDoc `{foo}` references round-trip as InlineElement with
+    # format_type: 'attribute_reference' and target: 'foo'. After the
+    # document is parsed and its attributes are known, this visitor
+    # rewrites those nodes in place to TextContent carrying the value.
+    # Unresolved references are left untouched so they survive
+    # serialisation back to the source format.
+    #
+    # The visitor never mutates its input tree; it returns a new tree
+    # sharing unchanged subtrees. InlineElement#with_content already
+    # produces non-mutating copies for inline content; the same pattern
+    # is used here at the block level via `replace_children`.
+    class AttributeReferenceResolver
+      attr_reader :attributes
+
+      def self.call(root, attributes)
+        new(attributes).visit(root)
+      end
+
+      def initialize(attributes)
+        @attributes = attributes || Metadata.new
+      end
+
+      def visit(node)
+        return node.map { |child| visit(child) } if node.is_a?(Array)
+
+        return node unless node.is_a?(Base)
+
+        visit_typed(node)
+      end
+
+      private
+
+      def visit_typed(node)
+        case node
+        when DocumentElement, SectionElement
+          rebuild_children(node)
+        when Table
+          rebuild_collection(node, :rows)
+        when TableRow
+          rebuild_collection(node, :cells)
+        when Block, ParagraphBlock, ListItem, TableCell, Term,
+             QuoteBlock, ExampleBlock, SidebarBlock, OpenBlock,
+             AnnotationBlock, ReviewerBlock, VerseBlock, LiteralBlock,
+             PassBlock, StemBlock, ListingBlock, SourceBlock,
+             CommentBlock, FrontmatterBlock
+          rebuild_block(node)
+        when DefinitionList, DefinitionItem
+          rebuild_children(node)
+        when InlineElement, RawInlineElement
+          resolve_inline(node)
+        else
+          node
+        end
+      end
+
+      def rebuild_children(node)
+        return node unless node.respond_to?(:children)
+
+        original = node.children
+        return node if original.nil?
+
+        updated = original.is_a?(Array) ? original.map { |c| visit(c) } : visit(original)
+        return node if updated == original
+
+        node.dup.tap { |copy| copy.children = updated }
+      end
+
+      # For nodes whose child collection lives on a non-`children`
+      # attribute (Table#rows, TableRow#cells). Walks the collection,
+      # rebuilds the parent only when at least one child changed.
+      def rebuild_collection(node, attr_name)
+        original = node.public_send(attr_name)
+        return node if original.nil?
+
+        updated = original.is_a?(Array) ?
+                    original.map { |c| visit(c) } :
+                    visit(original)
+        return node if updated == original
+
+        node.dup.tap { |copy| copy.public_send("#{attr_name}=", updated) }
+      end
+
+      def rebuild_block(node)
+        return node unless node.respond_to?(:children)
+
+        original_children = node.children
+        return node if original_children.nil?
+
+        updated_children = original_children.is_a?(Array) ?
+                             original_children.map { |c| visit(c) } :
+                             visit(original_children)
+
+        if inline_resolvable?(node)
+          original_content = node.content
+          updated_content = resolve_content(original_content)
+        else
+          updated_content = node.content
+        end
+
+        return node if updated_children == original_children && updated_content == node.content
+
+        node.dup.tap do |copy|
+          copy.children = updated_children
+          copy.content = updated_content if inline_resolvable?(node)
+        end
+      end
+
+      def inline_resolvable?(node)
+        node.respond_to?(:content) && node.content.is_a?(String)
+      end
+
+      # Resolve attribute references inside a flat content string.
+      # Only replaces `{name}` when +name+ exists in +attributes+;
+      # unknown references are preserved verbatim for round-trip.
+      def resolve_content(content)
+        return content unless content.is_a?(String)
+
+        content.gsub(/\{([a-zA-Z0-9_-]+)\}/) do |match|
+          name = Regexp.last_match(1)
+          attributes.key?(name) ? attributes[name].to_s : match
+        end
+      end
+
+      def resolve_inline(node)
+        return node unless node.is_a?(InlineElement)
+        return node unless node.resolve_format_type == 'attribute_reference'
+
+        target = node.target
+        return node if target.nil? || target.empty?
+        return node unless attributes.key?(target)
+
+        TextContent.new(text: attributes[target].to_s)
+      end
+    end
+  end
+end

data/lib/coradoc/core_model/image.rb

@@ -44,9 +44,12 @@ module Coradoc
 
       # @!attribute link
       #   @return [String, nil] URL to link to when image is clicked
-      #   @note Not yet wired by any transformer; reserved for future use
       attribute :link, :string
 
+      # @!attribute role
+      #   @return [String, nil] CSS role/class for the image (AsciiDoc role attr)
+      attribute :role, :string
+
       # @!attribute inline
       #   @return [Boolean] whether this is an inline image
       attribute :inline, :boolean, default: -> { false }
@@ -59,7 +62,7 @@ module Coradoc
       private
 
       def comparable_attributes
-        super + %i[src alt caption width height link inline]
+        super + %i[src alt caption width height link role inline]
       end
     end
   end

data/lib/coradoc/core_model.rb

@@ -81,6 +81,7 @@ module Coradoc
     autoload :CommentLine, "#{__dir__}/core_model/comment_line"
     autoload :HorizontalRuleBlock, "#{__dir__}/core_model/horizontal_rule_block"
     autoload :IdGenerator, "#{__dir__}/core_model/id_generator"
+    autoload :AttributeReferenceResolver, "#{__dir__}/core_model/attribute_reference_resolver"
     autoload :Include, "#{__dir__}/core_model/include"
     autoload :IncludeOptions, "#{__dir__}/core_model/include_options"
     autoload :IncludeLevelOffset, "#{__dir__}/core_model/include_level_offset"

data/lib/coradoc/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Coradoc
-  VERSION = '2.0.24'
+  VERSION = '2.0.26'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: coradoc
 version: !ruby/object:Gem::Version
-  version: 2.0.24
+  version: 2.0.26
 platform: ruby
 authors:
 - Ribose Inc.
@@ -56,6 +56,7 @@ files:
 - lib/coradoc/coradoc.rb
 - lib/coradoc/core_model.rb
 - lib/coradoc/core_model/annotation_block.rb
+- lib/coradoc/core_model/attribute_reference_resolver.rb
 - lib/coradoc/core_model/base.rb
 - lib/coradoc/core_model/bibliography.rb
 - lib/coradoc/core_model/bibliography_entry.rb