coradoc-markdown 1.0.3 → 1.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e84594b2f47a9d07086b781a843c5b1f7b2ddb34303bbe32114ea1c9e7ac1aec
-  data.tar.gz: 7fd311efb6eef499247c37bacb8357d3b6349eabc1347c6a875d21c6b315fa18
+  metadata.gz: 953ed53e8524e48cac6182bce3e847cc99deba64ba70e49add437b170186bc4c
+  data.tar.gz: 4b47acb69d7ab740fe2bb1f40e14ed0471cc4766ae7bb861efe066a94551eb33
 SHA512:
-  metadata.gz: ee32797ed75c3659d6e21fd9041d4f9a193497c50417f1f2ca986bd23459bf83b5a3cab47540f417d34014d806b1f20671e132ca4b0c0195b7b23870cb4aff37
-  data.tar.gz: 2cfc83d2fa5c1e732283d6efa0d37f05b5f9ea4c8970217f64cbb6771084c4aa2f6fa0aaaba4049aceb9ed9fb611d6395d210a5c8ce8c199a3bbf1768e4d4665
+  metadata.gz: 5e46c8a03f843c7061438135d27440476f4415c29a3c9d3f253cc523ae90a13ea044fa801c839f6ab7723ecc414c88a7773ac40effd10de38177dc376fafbd62
+  data.tar.gz: 7a3480158a1aef2af7236d751577fb5297f0844f148a54218b23b2583c74fee472b42c5a8c10b356b4b2c4e13999c3521fb6be4f808d27e037893509e458ec91

data/lib/coradoc/markdown/model/admonition.rb

@@ -24,11 +24,17 @@ module Coradoc
       attribute :content, :string
       attribute :title, :string
 
-      def initialize(admonition_type:, content:, title: nil, **rest)
+      # Mixed inline content (strings and inline model objects) carried
+      # from the CoreModel children so serializers can preserve cross
+      # references, code spans, etc. When empty, fall back to `content`.
+      attr_reader :children
+
+      def initialize(admonition_type:, content:, title: nil, children: [], **rest)
         super
         @admonition_type = admonition_type.to_s.downcase
         @content = content
         @title = title
+        @children = Array(children)
       end
     end
   end

data/lib/coradoc/markdown/model/example_block.rb

@@ -15,11 +15,13 @@ module Coradoc
     class ExampleBlock < Base
       attribute :content, :string
       attribute :caption, :string
+      attribute :children, Coradoc::Markdown::Base, collection: true, default: []
 
-      def initialize(content:, caption: nil, **rest)
+      def initialize(content:, caption: nil, children: [], **rest)
         super
         @content = content
         @caption = caption
+        @children = Array(children)
       end
     end
   end

data/lib/coradoc/markdown/serializer/serializers/example_block.rb

@@ -15,23 +15,31 @@ module Coradoc
           handles_type ::Coradoc::Markdown::ExampleBlock
 
           def call(element, ctx)
+            body = render_body(element, ctx)
             if ctx.config.admonition_style == :container
-              render_container(element)
+              render_container(element, body)
             else
-              render_html(element)
+              render_html(element, body)
             end
           end
 
           private
 
-          def render_html(element)
+          def render_body(element, ctx)
+            return element.content.to_s if element.children.nil? || element.children.empty?
+
+            element.children.map { |c| ctx.serialize(c) }.join("\n\n")
+          end
+
+          def render_html(element, body)
             caption_html = element.caption ? %(<h4>Example: #{element.caption}</h4>\n) : ''
-            %(<div class="example">\n#{caption_html}<p>#{element.content.to_s}</p>\n</div>)
+            inner = element.children&.any? ? body : "<p>#{body}</p>"
+            %(<div class="example">\n#{caption_html}#{inner}\n</div>)
           end
 
-          def render_container(element)
+          def render_container(element, body)
             title = element.caption ? " Example: #{element.caption}" : ''
-            ":::details#{title}\n#{element.content.to_s}\n:::"
+            ":::details#{title}\n#{body}\n:::"
           end
         end
       end

data/lib/coradoc/markdown/serializer/strategies/admonition/base.rb

@@ -21,6 +21,17 @@ module Coradoc
               def mode_name
                 name.split('::').last.gsub(/([a-z\d])([A-Z])/, '\1_\2').downcase.to_sym
               end
+
+              # Render the admonition body, preferring typed children
+              # (so cross-refs, code spans, etc. survive) and falling
+              # back to the plain-text content attribute when there are
+              # no children or the ctx can't serialize them.
+              def render_body(admonition, ctx)
+                children = admonition.children
+                return admonition.content.to_s if children.nil? || children.empty?
+
+                ctx.serialize_inline_join(children)
+              end
             end
           end
         end

data/lib/coradoc/markdown/serializer/strategies/admonition/container.rb

@@ -20,10 +20,10 @@ module Coradoc
           #   :::
           class Container < Base
             class << self
-              def render(admonition, _ctx)
+              def render(admonition, ctx)
                 type = admonition.admonition_type.to_s
                 title_suffix = admonition.title ? "[#{admonition.title}]" : ''
-                ":::#{type}#{title_suffix}\n#{admonition.content.to_s}\n:::"
+                ":::#{type}#{title_suffix}\n#{render_body(admonition, ctx)}\n:::"
               end
             end
           end

data/lib/coradoc/markdown/serializer/strategies/admonition/gfm_alert.rb

@@ -12,9 +12,9 @@ module Coradoc
           # Source: https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax#alerts
           class GfmAlert < Base
             class << self
-              def render(admonition, _ctx)
+              def render(admonition, ctx)
                 type = admonition.admonition_type.to_s.capitalize
-                body = admonition.content.to_s
+                body = render_body(admonition, ctx)
                 body = body.lines.map { |line| "> #{line}".rstrip }.join("\n")
                 title_suffix = admonition.title ? " \"#{admonition.title}\"" : ''
                 "> [!#{type}]#{title_suffix}\n#{body}"

data/lib/coradoc/markdown/serializer/strategies/admonition/github.rb

@@ -12,12 +12,10 @@ module Coradoc
           # recognize the bold-prefix pattern.
           class Github < Base
             class << self
-              def render(admonition, _ctx)
+              def render(admonition, ctx)
                 type = admonition.admonition_type.to_s.upcase
-                body = admonition.content.to_s
-                if admonition.title
-                  body = "**#{admonition.title}**\n\n#{body}" unless admonition.title.to_s.strip.empty?
-                end
+                body = render_body(admonition, ctx)
+                body = "**#{admonition.title}**\n\n#{body}" if admonition.title && !admonition.title.to_s.strip.empty?
                 "> **#{type}:** #{body}"
               end
             end

data/lib/coradoc/markdown/serializer/strategies/admonition/html.rb

@@ -11,10 +11,10 @@ module Coradoc
           # `<div class="title">` for the title.
           class Html < Base
             class << self
-              def render(admonition, _ctx)
+              def render(admonition, ctx)
                 type = admonition.admonition_type.to_s
                 title_html = admonition.title ? %(<div class="title">#{admonition.title}</div>\n) : ''
-                %(<div class="#{type}">\n#{title_html}#{admonition.content.to_s}\n</div>)
+                %(<div class="#{type}">\n#{title_html}#{render_body(admonition, ctx)}\n</div>)
               end
             end
           end

data/lib/coradoc/markdown/transform/from_core_model.rb

@@ -165,6 +165,12 @@ module Coradoc
             end
           end
 
+          def transform_inline_array(renderable)
+            return [] unless renderable.is_a?(Array)
+
+            renderable.map { |c| transform_inline_content(c) }
+          end
+
           def transform_delimited_block(block)
             semantic = resolve_markdown_semantic(block)
 
@@ -226,9 +232,11 @@ module Coradoc
           end
 
           def transform_example_block(block)
+            children = Array(block.children).map { |c| transform(c) }.flat_map { |c| flatten_result(c) }
             Coradoc::Markdown::ExampleBlock.new(
               content: block.flat_text,
-              caption: block.title.to_s
+              caption: block.title.to_s,
+              children: children
             )
           end
 
@@ -255,10 +263,12 @@ module Coradoc
           end
 
           def transform_admonition_block(block, default_type: 'note')
+            children = transform_inline_array(block.renderable_content)
             Coradoc::Markdown::Admonition.new(
               admonition_type: block.respond_to?(:annotation_type) ? (block.annotation_type || default_type) : default_type,
               content: block.flat_text,
-              title: block.respond_to?(:annotation_label) ? block.annotation_label : nil
+              title: block.respond_to?(:annotation_label) ? block.annotation_label : nil,
+              children: children
             )
           end
 

data/lib/coradoc/markdown/version.rb

@@ -2,6 +2,6 @@
 
 module Coradoc
   module Markdown
-    VERSION = '1.0.3'
+    VERSION = '1.0.5'
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: coradoc-markdown
 version: !ruby/object:Gem::Version
-  version: 1.0.3
+  version: 1.0.5
 platform: ruby
 authors:
 - Ribose Inc.