coradoc-mirror 0.1.1

data/lib/coradoc/mirror.rb

@@ -0,0 +1,161 @@
+# frozen_string_literal: true
+
+require 'json'
+require 'yaml'
+
+module Coradoc
+  module Mirror
+    class Error < StandardError; end
+
+    autoload :VERSION, "#{__dir__}/mirror/version"
+    autoload :Node, "#{__dir__}/mirror/node"
+    autoload :Mark, "#{__dir__}/mirror/mark"
+    autoload :Transformer, "#{__dir__}/mirror/transformer"
+    autoload :CoreModelToMirror, "#{__dir__}/mirror/core_model_to_mirror"
+    autoload :MirrorToCoreModel, "#{__dir__}/mirror/mirror_to_core_model"
+    autoload :Partitioner, "#{__dir__}/mirror/partitioner"
+    # ReverseBuilder's REGISTRY is populated by the built-in builder
+    # subclasses (defined inside reverse_builder.rb) at load time. The
+    # file is the autoload target, so the registry is full by the time
+    # any caller references Coradoc::Mirror::ReverseBuilder.
+    autoload :ReverseBuilder, "#{__dir__}/mirror/reverse_builder"
+    # MarkReverseBuilder is the mark-level parallel to ReverseBuilder.
+    # Same OCP pattern: one Builder class per mark type, self-registering.
+    autoload :MarkReverseBuilder, "#{__dir__}/mirror/mark_reverse_builder"
+    autoload :HandlerRegistry, "#{__dir__}/mirror/handler_registry"
+    autoload :Handlers, "#{__dir__}/mirror/handlers"
+    # MirrorJsonFormat and MirrorYamlFormat are loaded via require in
+    # coradoc-mirror.rb (side-effect: register_format calls).
+
+    # Build the default handler registry with all built-in handlers.
+    #
+    # Third-party code can add handlers to extend the registry without
+    # modifying this method (OCP). Each handler maps a CoreModel class
+    # to a handler module/class that produces Mirror nodes.
+    #
+    # @return [HandlerRegistry]
+    def self.default_registry
+      registry = HandlerRegistry.new
+
+      # ── Structural ──
+      registry.register(CoreModel::DocumentElement, Handlers::Structural,
+                        method_name: :document)
+      registry.register(CoreModel::SectionElement, Handlers::Structural,
+                        method_name: :section)
+      registry.register(CoreModel::PreambleElement, Handlers::Structural,
+                        method_name: :preamble)
+      registry.register(CoreModel::HeaderElement, Handlers::Structural,
+                        method_name: :header)
+
+      # ── Paragraphs ──
+      registry.register(CoreModel::ParagraphBlock, Handlers::Paragraph)
+
+      # ── Code / Preformatted ──
+      registry.register(CoreModel::SourceBlock, Handlers::CodeBlock,
+                        method_name: :source)
+      registry.register(CoreModel::ListingBlock, Handlers::CodeBlock,
+                        method_name: :listing)
+      registry.register(CoreModel::LiteralBlock, Handlers::CodeBlock,
+                        method_name: :literal)
+      registry.register(CoreModel::PassBlock, Handlers::CodeBlock,
+                        method_name: :pass)
+
+      # ── Blocks ──
+      registry.register(CoreModel::QuoteBlock, Handlers::Blockquote)
+      registry.register(CoreModel::ExampleBlock, Handlers::Example)
+      registry.register(CoreModel::SidebarBlock, Handlers::Sidebar)
+      registry.register(CoreModel::OpenBlock, Handlers::OpenBlock)
+      registry.register(CoreModel::VerseBlock, Handlers::Verse)
+      registry.register(CoreModel::CommentBlock, Handlers::Comment)
+      registry.register(CoreModel::HorizontalRuleBlock, Handlers::HorizontalRule)
+      registry.register(CoreModel::ReviewerBlock, Handlers::Reviewer)
+
+      # ── Annotations / Admonitions ──
+      registry.register(CoreModel::AnnotationBlock, Handlers::Admonition)
+
+      # ── Lists ──
+      registry.register(CoreModel::ListBlock, Handlers::List)
+      registry.register(CoreModel::DefinitionList, Handlers::DefinitionList)
+
+      # ── Tables ──
+      registry.register(CoreModel::Table, Handlers::Table)
+
+      # ── Images ──
+      registry.register(CoreModel::Image, Handlers::Image)
+
+      # ── Inline ──
+      registry.register(CoreModel::InlineElement, Handlers::Inline)
+      registry.register(CoreModel::TextContent, Handlers::Inline,
+                        method_name: :text_content)
+
+      # ── Bibliography ──
+      registry.register(CoreModel::Bibliography, Handlers::Bibliography)
+
+      # ── Footnotes ──
+      registry.register(CoreModel::Footnote, Handlers::Footnote)
+      registry.register(CoreModel::FootnoteReference, Handlers::Footnote,
+                        method_name: :reference)
+
+      # ── TOC ──
+      registry.register(CoreModel::Toc, Handlers::Toc)
+
+      # ── Frontmatter ──
+      registry.register(CoreModel::FrontmatterBlock, Handlers::Frontmatter)
+
+      # ── Generic Block (catch-all for unrecognized block types) ──
+      registry.register(CoreModel::Block, Handlers::GenericBlock)
+
+      registry
+    end
+
+    # Convenience: transform a CoreModel document to Mirror JSON in one call.
+    #
+    # @param document [CoreModel::Base] CoreModel document
+    # @param registry [HandlerRegistry] handler registry (defaults to built-in)
+    # @param partition_structural [Boolean] wrap doc.content in
+    #   preface/sections/bibliography containers per the @metanorma/mirror JS
+    #   structural contract (default: false for backward compatibility).
+    # @return [Node::Document] mirror document root
+    def self.transform(document, registry: default_registry, partition_structural: false)
+      CoreModelToMirror.new(registry: registry).call(document, partition_structural: partition_structural)
+    end
+
+    # Convenience: transform and serialize to JSON string.
+    #
+    # @param document [CoreModel::Base] CoreModel document
+    # @param pretty [Boolean] pretty-print JSON (default: false)
+    # @param registry [HandlerRegistry] handler registry
+    # @return [String] JSON string
+    def self.to_json(document, pretty: false, registry: default_registry)
+      node = transform(document, registry: registry)
+      pretty ? JSON.pretty_generate(node.to_hash) : JSON.generate(node.to_hash)
+    end
+
+    # Convenience: transform and serialize to YAML string.
+    #
+    # @param document [CoreModel::Base] CoreModel document
+    # @param registry [HandlerRegistry] handler registry
+    # @return [String] YAML string
+    def self.to_yaml(document, registry: default_registry)
+      node = transform(document, registry: registry)
+      YAML.dump(node.to_hash)
+    end
+
+    # Top-level hash dispatcher: reads `type` and delegates to the
+    # matching Node subclass's lutaml-generated `from_hash`. This is a
+    # module-level factory — the actual deserialization is done by
+    # lutaml on the resolved subclass. Unknown types raise.
+    #
+    # @param hash [Hash, nil] wire-shape hash
+    # @return [Node, nil]
+    def self.from_hash(hash)
+      return nil if hash.nil?
+
+      type = hash.is_a?(Hash) ? hash['type'] : nil
+      klass_name = Node::TYPE_TO_CLASS[type]
+      raise Error, "Unknown mirror node type: #{type.inspect}" unless klass_name
+
+      Object.const_get(klass_name).from_hash(hash)
+    end
+  end
+end

data/lib/coradoc-mirror.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+require 'coradoc'
+require_relative 'coradoc/mirror'
+
+# Side-effect: registers output processors with Coradoc::Output pipeline.
+# Side-effect: registers format modules with Coradoc registry.
+# These must use require (not autoload) because they have load-time side effects.
+require_relative 'coradoc/mirror/output'
+require_relative 'coradoc/mirror/mirror_json_format'
+require_relative 'coradoc/mirror/mirror_yaml_format'
+
+# Ensure Coradoc error classes are loaded (autoloaded via Coradoc::Error).
+Coradoc::Error

metadata

@@ -0,0 +1,140 @@
+--- !ruby/object:Gem::Specification
+name: coradoc-mirror
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Ribose Inc.
+bindir: exe
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: coradoc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec-its
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Transforms Coradoc CoreModel documents into ProseMirror-compatible JSON/YAML
+  suitable for rich frontend rendering with Vue.js, React, or any ProseMirror-based
+  editor.
+email:
+- open.source@ribose.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/coradoc-mirror.rb
+- lib/coradoc/mirror.rb
+- lib/coradoc/mirror/core_model_to_mirror.rb
+- lib/coradoc/mirror/handler_registry.rb
+- lib/coradoc/mirror/handlers.rb
+- lib/coradoc/mirror/handlers/admonition.rb
+- lib/coradoc/mirror/handlers/bibliography.rb
+- lib/coradoc/mirror/handlers/blockquote.rb
+- lib/coradoc/mirror/handlers/code_block.rb
+- lib/coradoc/mirror/handlers/comment.rb
+- lib/coradoc/mirror/handlers/definition_list.rb
+- lib/coradoc/mirror/handlers/example.rb
+- lib/coradoc/mirror/handlers/footnote.rb
+- lib/coradoc/mirror/handlers/frontmatter.rb
+- lib/coradoc/mirror/handlers/generic_block.rb
+- lib/coradoc/mirror/handlers/horizontal_rule.rb
+- lib/coradoc/mirror/handlers/image.rb
+- lib/coradoc/mirror/handlers/inline.rb
+- lib/coradoc/mirror/handlers/list.rb
+- lib/coradoc/mirror/handlers/open_block.rb
+- lib/coradoc/mirror/handlers/paragraph.rb
+- lib/coradoc/mirror/handlers/reviewer.rb
+- lib/coradoc/mirror/handlers/sidebar.rb
+- lib/coradoc/mirror/handlers/structural.rb
+- lib/coradoc/mirror/handlers/table.rb
+- lib/coradoc/mirror/handlers/toc.rb
+- lib/coradoc/mirror/handlers/verse.rb
+- lib/coradoc/mirror/mark.rb
+- lib/coradoc/mirror/mark_reverse_builder.rb
+- lib/coradoc/mirror/mirror_json_format.rb
+- lib/coradoc/mirror/mirror_to_core_model.rb
+- lib/coradoc/mirror/mirror_yaml_format.rb
+- lib/coradoc/mirror/node.rb
+- lib/coradoc/mirror/output.rb
+- lib/coradoc/mirror/partitioner.rb
+- lib/coradoc/mirror/reverse_builder.rb
+- lib/coradoc/mirror/transformer.rb
+- lib/coradoc/mirror/version.rb
+homepage: https://github.com/metanorma/coradoc
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/metanorma/coradoc
+  source_code_uri: https://github.com/metanorma/coradoc
+  changelog_uri: https://github.com/metanorma/coradoc/releases
+  rubygems_mfa_required: 'true'
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.9
+specification_version: 4
+summary: ProseMirror-compatible JSON document model for Coradoc
+test_files: []