coradoc-mirror 0.1.5 → 0.1.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ec671d9e6bbd3654635451d5a9ae2284f7e778f313b56e4e8d87e237e853b15e
-  data.tar.gz: 51f63185d93bda861e6f545fdd4bceb0e07a9516db1d8d51011fda4e08236b35
+  metadata.gz: 29f073186a23485753658ba4782ec7022461c2869351d6bb273eda9f30fda92e
+  data.tar.gz: aee881fe73fa219d89415deb8b6eb0e9a509cbd4b5b71b3f4ddfe6456ef114f8
 SHA512:
-  metadata.gz: 40d4b935ed85cdfb2a0d4845807df32367541498c4921879d5875194f8c1572402ad7bd809055cdb285b9ea2b7457c1847c8039c861c88db9c5094ea42d6edfa
-  data.tar.gz: 91b105b79f7eef2230869c1cc386d0ec105b08346a36e66f4e18e95b6931a66382ae786910c9d6bc72c04e287dd9f856a38cc569dadfe3a9f2304f710186e0f7
+  metadata.gz: beabd828aeb5e91a4a3c9e6049045123a2c4884ceef8a9887d4ec27874242a22e36661d2f807a67cbb7bc4a19b4616b8b578463d4ecfb763d98fcf56d5c5a591
+  data.tar.gz: 23e77c6e5dc7605ba5e4ff8a4cab88efc7433c30554cb5afcb71cff4345d4dc6906ca2efa03d58034e07f6a594e543c7291e9dd88e02f2f458fb5c6c197cdee9

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

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Coradoc
+  module Mirror
+    module Handlers
+      module Abstract
+        def self.call(element, context:)
+          content = context.extract_content(element)
+          return nil if content.empty?
+
+          Node::Abstract.new(
+            attrs: Node::Abstract::Attrs.new(id: element.id, title: element.title),
+            content: content
+          )
+        end
+      end
+    end
+  end
+end

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

@@ -8,13 +8,16 @@ module Coradoc
       # Two emission shapes:
       #   - Ruby legacy (default): bare `image` node, title/caption in attrs.
       #   - JS @metanorma/mirror (`partition_structural: true`): when the
-      #     source image has a title, wrap it in a `figure` node with the
-      #     image plus a `caption` child, matching the JS schema.
+      #     source image is a **block** image with a title, wrap it in a
+      #     `figure` node with the image plus a `caption` child, matching
+      #     the JS schema. Inline images never wrap, even if they carry a
+      #     role or title, because they live inside paragraph flow.
       module Image
         def self.call(element, context:)
           image_node = build_image_node(element)
 
           return image_node unless context.partition_structural
+          return image_node if element.inline
           return image_node unless caption_text?(element)
 
           Node::Figure.new(
@@ -27,16 +30,19 @@ module Coradoc
           private
 
           def build_image_node(element)
-            Node::Image.new(
-              attrs: Node::Image::Attrs.new(
-                src: element.src,
-                alt: element.alt,
-                title: element.title,
-                caption: element.caption,
-                width: element.width,
-                height: element.height,
-                inline: element.inline || nil
-              )
+            Node::Image.new(attrs: image_attrs(element))
+          end
+
+          def image_attrs(element)
+            Node::Image::Attrs.new(
+              src: element.src,
+              alt: element.alt,
+              title: element.title,
+              caption: element.caption,
+              width: element.width,
+              height: element.height,
+              role: element.role,
+              inline: element.inline
             )
           end
 

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

@@ -102,7 +102,9 @@ module Coradoc
               build_span_mark(element, context)
             when CoreModel::FootnoteElement
               build_footnote_node(element, context)
-            when CoreModel::HardLineBreakElement, CoreModel::LineBreakElement
+            when CoreModel::HardLineBreakElement
+              Node::HardBreak.new
+            when CoreModel::LineBreakElement
               Node::SoftBreak.new
             when CoreModel::TextElement
               build_text_only(element, context)

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

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Coradoc
+  module Mirror
+    module Handlers
+      module Partintro
+        def self.call(element, context:)
+          content = context.extract_content(element)
+          return nil if content.empty?
+
+          Node::Partintro.new(
+            attrs: Node::Partintro::Attrs.new(id: element.id, title: element.title),
+            content: content
+          )
+        end
+      end
+    end
+  end
+end

data/lib/coradoc/mirror/handlers.rb

@@ -17,6 +17,8 @@ module Coradoc
       autoload :Blockquote, "#{__dir__}/handlers/blockquote"
       autoload :Example, "#{__dir__}/handlers/example"
       autoload :Sidebar, "#{__dir__}/handlers/sidebar"
+      autoload :Abstract, "#{__dir__}/handlers/abstract"
+      autoload :Partintro, "#{__dir__}/handlers/partintro"
       autoload :OpenBlock, "#{__dir__}/handlers/open_block"
       autoload :Verse, "#{__dir__}/handlers/verse"
       autoload :Comment, "#{__dir__}/handlers/comment"

data/lib/coradoc/mirror/node.rb

@@ -303,6 +303,60 @@ module Coradoc
         end
       end
 
+      # Abstract block — `[abstract]\n====\n...\n====` in AsciiDoc. Carries
+      # the same shape as Sidebar/Example but a distinct wire type so the
+      # block-level construct does not collide with the section-level
+      # `abstract` (one of Section's PM_ALIASES). The block preserves its
+      # block identity through round-trip; renderers that want a section
+      # view should look at SectionElement-style sources instead.
+      class Abstract < Node
+        PM_TYPE = 'abstract_block'
+
+        class Attrs < Lutaml::Model::Serializable
+          attribute :title, :string
+          attribute :id, :string
+
+          key_value do
+            map 'title', to: :title
+            map 'id', to: :id
+          end
+        end
+
+        attribute :attrs, Attrs
+
+        key_value do
+          map 'type', to: :type, render_default: true
+          map 'attrs', to: :attrs
+          map 'content', to: :content, polymorphic: Node::POLYMORPHIC
+        end
+      end
+
+      # Partintro block — `[partintro]\n====\n...\n====` in AsciiDoc, used
+      # to introduce a "part" in multi-part documents. Distinct wire type
+      # for the same reason as Abstract (no collision with potential
+      # section-level uses of "partintro").
+      class Partintro < Node
+        PM_TYPE = 'partintro_block'
+
+        class Attrs < Lutaml::Model::Serializable
+          attribute :title, :string
+          attribute :id, :string
+
+          key_value do
+            map 'title', to: :title
+            map 'id', to: :id
+          end
+        end
+
+        attribute :attrs, Attrs
+
+        key_value do
+          map 'type', to: :type, render_default: true
+          map 'attrs', to: :attrs
+          map 'content', to: :content, polymorphic: Node::POLYMORPHIC
+        end
+      end
+
       class OpenBlock < Node
         PM_TYPE = 'open_block'
 
@@ -344,6 +398,15 @@ module Coradoc
         PM_TYPE = 'soft_break'
       end
 
+      # Hard line break — author-requested explicit break (`foo +\nbar` in
+      # AsciiDoc, `<br>` semantics in HTML). Distinct from SoftBreak so
+      # downstream renderers can map it to `<br>` rather than collapsing
+      # the break into a soft newline-or-space convention. ProseMirror's
+      # schema uses `hard_break` for the same purpose.
+      class HardBreak < Node
+        PM_TYPE = 'hard_break'
+      end
+
       # ── Admonition (NOTE, TIP, WARNING, CAUTION, IMPORTANT) ──
       #
       # The Ruby attribute name is `admonition_type` (kept distinct from
@@ -496,6 +559,7 @@ module Coradoc
           attribute :caption, :string
           attribute :width, :string
           attribute :height, :string
+          attribute :role, :string
           attribute :inline, :boolean
 
           key_value do
@@ -505,6 +569,7 @@ module Coradoc
             map 'caption', to: :caption
             map 'width', to: :width
             map 'height', to: :height
+            map 'role', to: :role
             map 'inline', to: :inline
           end
         end

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

@@ -0,0 +1,21 @@
+# 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,
+            id: node.attrs&.id,
+            children: build_content(node)
+          )
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,17 @@
+# 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
+      end
+    end
+  end
+end

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

@@ -0,0 +1,21 @@
+# 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,
+            id: node.attrs&.id,
+            children: build_content(node)
+          )
+        end
+      end
+    end
+  end
+end

data/lib/coradoc/mirror/reverse_builder.rb

@@ -62,6 +62,8 @@ module Coradoc
       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'
@@ -91,6 +93,7 @@ module Coradoc
       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

data/lib/coradoc/mirror/version.rb

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

data/lib/coradoc/mirror.rb

@@ -75,6 +75,8 @@ module Coradoc
       registry.register(CoreModel::QuoteBlock, Handlers::Blockquote)
       registry.register(CoreModel::ExampleBlock, Handlers::Example)
       registry.register(CoreModel::SidebarBlock, Handlers::Sidebar)
+      registry.register(CoreModel::AbstractBlock, Handlers::Abstract)
+      registry.register(CoreModel::PartintroBlock, Handlers::Partintro)
       registry.register(CoreModel::OpenBlock, Handlers::OpenBlock)
       registry.register(CoreModel::VerseBlock, Handlers::Verse)
       registry.register(CoreModel::CommentBlock, Handlers::Comment)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: coradoc-mirror
 version: !ruby/object:Gem::Version
-  version: 0.1.5
+  version: 0.1.7
 platform: ruby
 authors:
 - Ribose Inc.
@@ -81,6 +81,7 @@ files:
 - lib/coradoc/mirror/frontmatter_tree_to_hash.rb
 - lib/coradoc/mirror/handler_registry.rb
 - lib/coradoc/mirror/handlers.rb
+- lib/coradoc/mirror/handlers/abstract.rb
 - lib/coradoc/mirror/handlers/admonition.rb
 - lib/coradoc/mirror/handlers/bibliography.rb
 - lib/coradoc/mirror/handlers/blockquote.rb
@@ -98,6 +99,7 @@ files:
 - lib/coradoc/mirror/handlers/list.rb
 - lib/coradoc/mirror/handlers/open_block.rb
 - lib/coradoc/mirror/handlers/paragraph.rb
+- lib/coradoc/mirror/handlers/partintro.rb
 - lib/coradoc/mirror/handlers/reviewer.rb
 - lib/coradoc/mirror/handlers/sidebar.rb
 - lib/coradoc/mirror/handlers/structural.rb
@@ -112,6 +114,7 @@ files:
 - lib/coradoc/mirror/node.rb
 - lib/coradoc/mirror/partitioner.rb
 - lib/coradoc/mirror/reverse_builder.rb
+- lib/coradoc/mirror/reverse_builder/abstract.rb
 - lib/coradoc/mirror/reverse_builder/admonition.rb
 - lib/coradoc/mirror/reverse_builder/base.rb
 - lib/coradoc/mirror/reverse_builder/biblio_entry.rb
@@ -129,6 +132,7 @@ files:
 - lib/coradoc/mirror/reverse_builder/footnotes.rb
 - lib/coradoc/mirror/reverse_builder/frontmatter.rb
 - lib/coradoc/mirror/reverse_builder/generic_block.rb
+- lib/coradoc/mirror/reverse_builder/hard_break.rb
 - lib/coradoc/mirror/reverse_builder/header.rb
 - lib/coradoc/mirror/reverse_builder/horizontal_rule.rb
 - lib/coradoc/mirror/reverse_builder/image.rb
@@ -139,6 +143,7 @@ files:
 - lib/coradoc/mirror/reverse_builder/open_block.rb
 - lib/coradoc/mirror/reverse_builder/ordered_list.rb
 - lib/coradoc/mirror/reverse_builder/paragraph.rb
+- lib/coradoc/mirror/reverse_builder/partintro.rb
 - lib/coradoc/mirror/reverse_builder/pass_block.rb
 - lib/coradoc/mirror/reverse_builder/preamble.rb
 - lib/coradoc/mirror/reverse_builder/raw_inline.rb