metanorma-core 0.2.1 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 314a93ed63df1389dfb3e950e63d7ebff4ccf3c1a0e1698d678ddb898ab9fc47
-  data.tar.gz: 4ef731b709d7f26820209291edea8d576992d457f0161dae1cc3d4c810433f5f
+  metadata.gz: 7e0fe54371f36297eba65fd7cea8649359c7ca0f50195f388d48c82266bc220f
+  data.tar.gz: a18e98b49080a74314677f7aae1b382ae64083e4b9ce21c773959cc9e94439b2
 SHA512:
-  metadata.gz: 03ed6bb9d50427ca61a7659458c8e154329566a968e3cf80f9bf4a9e46c859358bbab811ab1d76481f13797525f6651e80fb2d565eeb0408f41979ae10658c1b
-  data.tar.gz: 5e69aa811a9385a9938e0707a37334c51929e880633b707fe32590c599787ebe2bd8c5fc6d96e08d948da149079d7bbf52a119441ca27e3d504279286c76ca10
+  metadata.gz: 6d0a9c5cc7e45bbdfd7c4eafda1028e66c8a904c7d7550d95248d966034215a3a2a2baee6a7bcf54b9aedab8ae984e11e4751f70f4bd9fbff8319bdca56f18f7
+  data.tar.gz: 4b0244d3496a619dccc2dd2ae4dbfb449b84a86949bd51d052c486a148ba2f321643cfd1fb00c857061ded783fb532c6734fbfe34282e11f3bbb5bdc8d62dd2d

data/.rubocop.yml

@@ -1,8 +1,31 @@
+# Auto-generated by Cimas: Do not edit it manually!
+# See https://github.com/metanorma/cimas
 inherit_from:
   - https://raw.githubusercontent.com/riboseinc/oss-guides/main/ci/rubocop.yml
+  # .rubocop_todo.yml MUST be the last entry. inherit_from is last-wins:
+  # if listed before oss-guides, the shared config's stricter Metrics/
+  # (MethodLength, BlockLength, etc.) rules override the todo's per-file
+  # grandfathering, and the todo becomes inert on those cops. Empirically
+  # verified on suma 2026-07-06: with todo listed first, 34 Metrics/* offenses
+  # remained; moved last, cleared. Every gem in the metanorma-org fleet
+  # already ships a `.rubocop_todo.yml` on its live tree (audited 2026-07-06,
+  # 54/54 have it), so this reference is safe to emit unconditionally.
+  - .rubocop_todo.yml
+
+# Rubocop plugins enabled centrally so every metanorma-org gem picks them up
+# on cimas sync — best practice belongs at the shared-template layer, not
+# per-repo. Per ronaldtse feedback on metanorma/ci#332.
+plugins:
+  - rubocop-rspec
+  - rubocop-performance
+  - rubocop-rake
 
 # local repo-specific modifications
 # ...
 
 AllCops:
-  TargetRubyVersion: 3.4
+  # 3.3 matches the org-wide minimum being pushed via #274 (Raise minimum
+  # Ruby version to 3.3 due to EOL of 3.2 on 2026-03-31). Was 3.4 before
+  # this commit — 3.4 was above the org's stated minimum and would have
+  # applied Rubocop rules that fail-close on gems still targeting 3.3.
+  TargetRubyVersion: 3.3

data/Gemfile

@@ -7,5 +7,8 @@ git_source(:github) { |repo| "https://github.com/#{repo}" }
 gemspec
 
 gem "gem-release"
+# top-level, not the gemspec development group: the release job installs
+# without development/test, and bundle exec rake release needs rake
+gem "rake"
 
 eval_gemfile("Gemfile.devel") rescue nil

data/lib/metanorma/core/version.rb

@@ -1,5 +1,5 @@
 module Metanorma
   module Core
-    VERSION = "0.2.1".freeze
+    VERSION = "0.2.2".freeze
   end
 end

data/lib/metanorma/input/asciidoc.rb

@@ -115,7 +115,7 @@ module Metanorma
       # attribute is bare (no value).
       EMPTY_ADOC_OPTIONS_DEFAULT_FALSE =
         %w(hierarchical-assets break-up-urls-in-tables toc-figures
-           toc-tables toc-recommendations).freeze
+           toc-tables toc-recommendations toc-examples).freeze
 
       # Convert an Asciidoc-style attribute name (kebab-case, possibly
       # ending in +-override+ or +-pdf+) into the Ruby symbol used in

data/lib/metanorma/processor/processor.rb

@@ -43,6 +43,33 @@ module Metanorma
       }
     end
 
+    # Per-format "document model" publishing specs. Override in a flavor to
+    # register injected reader + transformer classes for a document-model
+    # output leg (Presentation/Semantic XML -> reader -> transformer -> XML),
+    # so the flavor declares two classes rather than re-implementing the
+    # read/transform/serialise chain in {#output}. The classes need not live
+    # in the +Metanorma::+ tree.
+    #
+    # Each value is a Hash with keys:
+    #   :reader                  - responds to +.from_xml(String)+ -> model
+    #                              (required)
+    #   :transformer             - responds to +.new(model, options)+; the
+    #                              instance responds to +#transform+ -> target,
+    #                              and the target responds to +#to_xml+
+    #                              (required)
+    #   :to_xml_options          - Hash splatted into +target.to_xml(**opts)+
+    #                              (default +{}+)
+    #   :strip_default_namespace - strip +xmlns="..."+ before +from_xml+
+    #                              (default +false+)
+    #   :post_process            - callable +(xml, transformer, options)+
+    #                              -> xml (default identity)
+    #
+    # @return [Hash{Symbol => Hash}] format symbol -> spec. Empty by default,
+    #   so flavors that do not use this leg are unaffected.
+    def document_transformers
+      {}
+    end
+
     # Convert an input file to Metanorma semantic XML by routing it
     # through the {Metanorma::Input::Asciidoc} processor with this
     # processor's Asciidoctor backend. Override for non-Asciidoc
@@ -87,19 +114,75 @@ module Metanorma
       options[:output_formats] ||= output_formats
     end
 
-    # Default output-writer: dump the rendered output string to a
-    # UTF-8 file. Override for binary formats (Word, PDF) that need
-    # different post-processing.
+    # Default output-writer. If +format+ is registered in
+    # {#document_transformers}, render it through the document-model leg
+    # ({#render_via_document_model}); otherwise dump the rendered output
+    # string to a UTF-8 file. Flavors override this for binary formats
+    # (Word, PDF) that need different post-processing, calling +super+ for
+    # the document-model and passthrough cases.
     #
-    # @param isodoc_node [String] rendered output content.
-    # @param _inname [String] source filename (unused at this base level).
+    # @param isodoc_node [String, nil] rendered output content, or the
+    #   semantic XML string on the document-model semantic leg.
+    # @param inname [String] source filename.
     # @param outname [String] destination path.
-    # @param _format [Symbol] output format (unused at this base level).
-    # @param _options [Hash] processor options (unused at this base level).
-    # @return [Integer] bytes written (Ruby's +File#write+ return).
-    def output(isodoc_node, _inname, outname, _format, _options = {})
-      File.open(outname, "w:UTF-8") { |f| f.write(isodoc_node) }
+    # @param format [Symbol] output format.
+    # @param options [Hash] processor options.
+    # @return [Object] bytes written (passthrough) or the serialised XML
+    #   string (document-model leg).
+    def output(isodoc_node, inname, outname, format, options = {})
+      options_preprocess(options)
+      if document_transformers.key?(format)
+        render_via_document_model(isodoc_node, inname, outname, format,
+                                  options)
+      else
+        File.open(outname, "w:UTF-8") { |f| f.write(isodoc_node) }
+      end
+    end
+
+    # Render a document-model output leg: read the input XML into a model via
+    # the registered reader, transform it, serialise, optionally post-process,
+    # and write. The input XML comes from +isodoc_node+ (semantic leg) or,
+    # when that is nil, from reading +inname+ (presentation leg) — so both
+    # {#use_presentation_xml} settings are supported transparently. The driver
+    # is duck-typed: it never names a concrete reader/transformer/target-model
+    # gem, keeping those out of metanorma-core's dependencies.
+    #
+    # @param isodoc_node [String, nil] semantic XML string, or nil on the
+    #   presentation leg.
+    # @param inname [String] input filename (read on the presentation leg).
+    # @param outname [String, nil] destination path; written when non-nil.
+    # @param format [Symbol] output-format symbol; must be a key of
+    #   {#document_transformers}.
+    # @param options [Hash] processor options, passed to the transformer and
+    #   post-processor.
+    # @return [String] the serialised (and post-processed) output XML.
+    def render_via_document_model(isodoc_node, inname, outname, format, options)
+      spec = document_transformers.fetch(format)
+      xml = document_model_input_xml(isodoc_node, inname)
+      xml = xml.gsub(/\sxmlns="[^"]*"/, "") if spec[:strip_default_namespace]
+      transformer = spec.fetch(:transformer)
+        .new(spec.fetch(:reader).from_xml(xml), options)
+      out = transformer.transform.to_xml(**(spec[:to_xml_options] || {}))
+      if (post = spec[:post_process])
+        out = post.call(out, transformer, options)
+      end
+      File.open(outname, "w:UTF-8") { |f| f.write(out) } if outname
+      out
+    end
+
+    # Resolve the input XML string from whichever leg fired: the semantic
+    # leg passes the XML as +isodoc_node+; the presentation leg passes nil
+    # and the presentation-XML file path as +inname+.
+    #
+    # @param isodoc_node [String, nil] semantic XML string, or nil.
+    # @param inname [String] presentation-XML file path (used when node nil).
+    # @return [String] the input XML.
+    def document_model_input_xml(isodoc_node, inname)
+      return isodoc_node if isodoc_node
+
+      File.read(inname, encoding: "UTF-8")
     end
+    private :document_model_input_xml
 
     # Read processor-relevant options from the input file's header
     # via {Metanorma::Input::Asciidoc#extract_options}, merging in

data/metanorma-core.gemspec

@@ -23,10 +23,10 @@ Gem::Specification.new do |spec|
     f.match(%r{^(test|spec|features|bin|.github)/}) \
     || f.match(%r{Rakefile|bin/rspec})
   end
-  spec.required_ruby_version = Gem::Requirement.new(">= 3.1.0")
+  spec.required_ruby_version = Gem::Requirement.new(">= 3.3.0")
 
   spec.add_dependency "asciidoctor"
-  spec.add_dependency "metanorma-taste", "~> 1.0.0"
+  spec.add_dependency "metanorma-taste", "~> 1.1.0"
   spec.add_dependency "metanorma-utils"
   spec.add_dependency "nokogiri"
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: metanorma-core
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.2.2
 platform: ruby
 authors:
 - Ribose Inc.
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2026-05-25 00:00:00.000000000 Z
+date: 2026-07-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: asciidoctor
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.0.0
+        version: 1.1.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.0.0
+        version: 1.1.0
 - !ruby/object:Gem::Dependency
   name: metanorma-utils
   requirement: !ruby/object:Gem::Requirement
@@ -192,7 +192,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 3.1.0
+      version: 3.3.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="