metanorma 2.2.1 → 2.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5d66c44fc8123332b449ee23540a8e0d009aa19b5a34f408bca97375f85223b0
-  data.tar.gz: 0227a49a94646c2bd0197fb5d49eabc237a6eb51350809a3f8436c601f41d41c
+  metadata.gz: ab41d7fdd92143add890202f0e64c0c88216c7936e603a0efd7a41df02b833c3
+  data.tar.gz: '09fc660fdf0eddeb88ee0094560113a2d05504767c0b6c220a63be6be7e80eea'
 SHA512:
-  metadata.gz: 503d2edd8d015e341949ab4de920abb7668bc1b13fb7d97697026fddad1ab11d9f94138257cffdd3b57ac32873d606cbe05689bcf8b9e8f7fb3baa19289a7d76
-  data.tar.gz: 41ba35a1a2ad8d740c9b7e3409f0297665c1746e3e461d2b26e2b203d66b09e26fc6bc9f1afebbe26134806a699ac8aa36350d28548629a08a2ae036aa3aa0e3
+  metadata.gz: 82c0f8b50777b5cf34262690a6e860d189c5eecf4b5365375ef24872e847d8c04d4624731155407d89b86d3d6839ce0295b3c3c44d76a350139555ff3c8d47fa
+  data.tar.gz: a7f8736e34eb0bc5ab76092ab9eeaae682f1058d52f634bc8d06f45cfa26982ef97813584430af5eb262317b6fdde7baf065c2c077645727f4a32dd569974479

data/README.adoc

@@ -2,7 +2,7 @@
 
 image:https://img.shields.io/gem/v/metanorma.svg["Gem Version", link="https://rubygems.org/gems/metanorma"]
 image:https://github.com/metanorma/metanorma/workflows/rake/badge.svg["Build Status", link="https://github.com/metanorma/metanorma/actions?workflow=rake"]
-image:https://codeclimate.com/github/metanorma/metanorma/badges/gpa.svg["Code Climate", link="https://codeclimate.com/github/metanorma/metanorma"]
+// image:https://codeclimate.com/github/metanorma/metanorma/badges/gpa.svg["Code Climate", link="https://codeclimate.com/github/metanorma/metanorma"]
 image:https://img.shields.io/github/issues-pr-raw/metanorma/metanorma.svg["Pull Requests", link="https://github.com/metanorma/metanorma/pulls"]
 image:https://img.shields.io/github/commits-since/metanorma/metanorma/latest.svg["Commits since latest",link="https://github.com/metanorma/metanorma/releases"]
 

data/lib/metanorma/collection/filelookup/filelookup.rb

@@ -26,7 +26,6 @@ module Metanorma
         @disambig = Util::DisambigFiles.new
         @manifest = parent.manifest
         read_files(@manifest.entry, parent.manifest)
-        #warn pp @files
       end
 
       def read_files(entries, parent)

data/lib/metanorma/collection/renderer/fileprocess.rb

@@ -11,7 +11,6 @@ module Metanorma
       # warn "metanorma compile -x html #{f.path}"
       def file_compile(file, filename, identifier)
         @files.get(identifier, :sectionsplit) and return
-        #require "debug"; binding.b
         opts = {
           format: :asciidoc,
           extension_keys: @files.get(identifier, :format),

data/lib/metanorma/collection/renderer/renderer.rb

@@ -181,9 +181,12 @@ module Metanorma
       # collection manifest
       def coverpage
         @coverpage or return
+
+        @coverpage_path = Util::rel_path_resolve(@dirname, @coverpage)
         warn "\n\n\n\n\nCoverpage: #{DateTime.now.strftime('%H:%M:%S')}"
+
         File.open(File.join(@outdir, "index.html"), "w:UTF-8") do |f|
-          f.write @isodoc.populate_template(File.read(@coverpage))
+          f.write @isodoc.populate_template(File.read(@coverpage_path))
         end
       end
     end

data/lib/metanorma/collection/renderer/svg.rb

@@ -11,21 +11,31 @@ module Metanorma
       end
 
       def svgmap_resolve(docxml, docid, presxml)
+        ids, docxml, isodoc, tag = svgmap_resolve_prep(docxml, docid, presxml)
+        docxml.xpath(ns("//svgmap//#{tag}")).each do |e|
+          svgmap_resolve_eref(e, isodoc, docxml, ids, presxml)
+        end
+        svgmap_fmt_prefix_remove(docxml)
+        Vectory::SvgMapping.new(docxml, "").call
+        docxml.xpath(ns("//svgmap")).each { |s| isodoc.svgmap_extract(s) }
+      end
+
+      def svgmap_resolve_prep(docxml, docid, presxml)
         ids = @files.get(docid, :ids)
         docxml = svg_unnest(svg_datauri(docxml, docid))
         isodoc = IsoDoc::PresentationXMLConvert.new({})
         isodoc.bibitem_lookup(docxml)
         tag = presxml ? "fmt-eref" : "eref"
-        docxml.xpath(ns("//svgmap//#{tag}")).each do |e|
-          svgmap_resolve_eref(e, isodoc, docxml, ids, presxml)
-        end
-        docxml.xpath(ns("//svgmap/target")).each do |t| # undo Presentation XML: Vectory takes eref not fmt-eref
+        [ids, docxml, isodoc, tag]
+      end
+
+      # undo Presentation XML update: Vectory takes eref not fmt-eref
+      def svgmap_fmt_prefix_remove(docxml)
+        docxml.xpath(ns("//svgmap/target")).each do |t|
           n = t.at(ns(".//fmt-link | .//fmt-xref | .//fmt-eref")) or next
           n.name = n.name.sub(/^fmt-/, "")
           t.children = n
         end
-        Vectory::SvgMapping.new(docxml, "").call
-        docxml.xpath(ns("//svgmap")).each { |s| isodoc.svgmap_extract(s) }
       end
 
       def svg_unnest(docxml)

data/lib/metanorma/collection/sectionsplit/sectionsplit.rb

@@ -72,7 +72,7 @@ module Metanorma
       def block?(node)
         %w(p table formula admonition ol ul dl figure quote sourcecode example
            pre note pagebreak hr bookmark requirement recommendation permission
-           svgmap inputform toc passthrough review imagemap).include?(node.name)
+           svgmap inputform toc passthrough annotation imagemap).include?(node.name)
       end
 
       def conflate_floatingtitles(nodes)
@@ -151,7 +151,7 @@ module Metanorma
       def create_sectionfile(xml, out, file, chunks, parentnode)
         ins = out.at(ns("//metanorma-extension")) || out.at(ns("//bibdata"))
         sectionfile_insert(ins, chunks, parentnode)
-        sectionfile_fn_filter(sectionfile_review_filter(out))
+        sectionfile_fn_filter(sectionfile_annotation_filter(out))
         Metanorma::Collection::XrefProcess::xref_process(out, xml, @key,
                                                          @ident, @isodoc, true)
         outname = "#{file}.xml"
@@ -211,34 +211,35 @@ module Metanorma
         fnlabel.children = @isodoc_presxml.fn_body_label(fnbody)
       end
 
-      # map fmt-review-body/@id = fmt-review-{start/end}/@target
-      # to fmt-review-{stary/end}
-      def sectionfile_review_filter_prep(xml)
-        xml.xpath(ns("//fmt-review-start | //fmt-review-end"))
+      # map fmt-annotation-body/@id = fmt-annotation-{start/end}/@target
+      # to fmt-annotation-{start/end}
+      def sectionfile_annotation_filter_prep(xml)
+        xml.xpath(ns("//fmt-annotation-start | //fmt-annotation-end"))
           .each_with_object({}) do |f, m|
             m[f["target"]] ||= []
             m[f["target"]] << f
           end
       end
 
-      def sectionfile_review_filter(xml)
-        ids = sectionfile_review_filter_prep(xml)
-        xml.root.xpath(ns("./review-container/fmt-review-body")).each do |f|
+      def sectionfile_annotation_filter(xml)
+        ids = sectionfile_annotation_filter_prep(xml)
+        xml.root.xpath(ns("./annotation-container/fmt-annotation-body"))
+          .each do |f|
           ids.has_key?(f["id"]) or f.remove
         end
-        xml.root.xpath(ns("./review-container/fmt-review-body"))
+        xml.root.xpath(ns("./annotation-container/fmt-annotation-body"))
           .each_with_index do |fnbody, i|
-            sectionfile_review_filter_renumber(fnbody, i, ids)
+            sectionfile_annotation_filter_renumber(fnbody, i, ids)
           end
         xml
       end
 
-      def sectionfile_review_filter_renumber(fnbody, _idx, ids)
+      def sectionfile_annotation_filter_renumber(fnbody, _idx, ids)
         ids[fnbody["id"]].each do |f|
           case f.name
-          when "fmt-review-start"
+          when "fmt-annotation-start"
             f.children = @isodoc_presxml.comment_bookmark_start_label(f)
-          when "fmt-review-end"
+          when "fmt-annotation-end"
             f.children = @isodoc_presxml.comment_bookmark_end_label(f)
           end
         end

data/lib/metanorma/compile/compile.rb

@@ -184,7 +184,7 @@ module Metanorma
     end
 
     def process_input_adoc_overrides(attrs, options)
-      @registry.tastes.available_tastes.include?(options[:supplied_type]) or
+      Metanorma::TasteRegister.instance.available_tastes.include?(options[:supplied_type]) or
         return
       c = Metanorma::TasteRegister.get(options[:supplied_type])
       c.process_input_adoc_overrides(attrs, options)

data/lib/metanorma/compile/extract.rb

@@ -36,8 +36,8 @@ module Metanorma
         # @param xml [Nokogiri::XML::Document] the XML document
         # @return [String] the cleaned sourcecode
         def clean_sourcecode(xml)
-          xml.xpath(".//callout | .//annotation | .//xmlns:callout | "\
-                    ".//xmlns:annotation").each(&:remove)
+          xml.xpath(".//callout | .//callout-annotation | .//xmlns:callout | "\
+                    ".//xmlns:callout-annotation").each(&:remove)
           xml.xpath(".//br | .//xmlns:br").each { |x| x.replace("\n") }
           a = xml.at("./body | ./xmlns:body") and xml = a
           HTMLEntities.new.decode(xml.children.to_xml)

data/lib/metanorma/registry/registry.rb

@@ -7,45 +7,160 @@ class Error < StandardError
 end
 
 module Metanorma
+  # Central registry for managing Metanorma processors, flavors, and their aliases
+  #
+  # This singleton class provides a centralized registry for:
+  # - Metanorma processors (document format processors)
+  # - Flavor aliases (mapping legacy/alternative names to canonical flavors)
+  # - Taste configurations (via TasteRegister integration)
+  #
+  # The registry maintains backward compatibility with legacy flavor names while
+  # integrating with the modern TasteRegister system for dynamic taste management.
+  #
+  # @example Basic usage
+  #   registry = Metanorma::Registry.instance
+  #
+  #   # Register a processor
+  #   registry.register(MyProcessor)
+  #
+  #   # Look up flavor aliases
+  #   registry.alias(:csd)  # => :cc
+  #
+  #   # Register custom aliases
+  #   registry.register_alias(:my_flavor, :iso)
+  #
+  # @example Finding processors
+  #   processor = registry.find_processor(:iso)
+  #   formats = registry.output_formats
+  #   backends = registry.supported_backends
   class Registry
     include Singleton
 
     attr_reader :processors, :tastes
 
-    # TODO: make aliases configurable
+    # Default legacy aliases for backward compatibility
+    # Maps old flavor names to their canonical equivalents
+    DEFAULT_ALIASES = { csd: :cc, m3d: :m3aawg, mpfd: :mpfa, csand: :csa }.freeze
+
+    # Initialize the registry with processors, tastes, and aliases
+    #
+    # Sets up the registry by:
+    # 1. Initializing empty processors hash
+    # 2. Connecting to the TasteRegister instance
+    # 3. Initializing custom aliases with defaults
     def initialize
       @processors = {}
       @tastes = Metanorma::TasteRegister.instance
-      tastealiases = @tastes.available_tastes.each_with_object({}) do |x, m|
-        m[x] = @tastes.taste_info(x)[:base_flavor]
-      end
-      @aliases = { csd: :cc, m3d: :m3aawg, mpfd: :mpfa, csand: :csa }
-        .merge tastealiases
+      @custom_aliases = DEFAULT_ALIASES.dup
     end
 
+    # Look up the canonical flavor name for a given alias
+    #
+    # Checks aliases in priority order:
+    # 1. Custom registered aliases (highest priority)
+    # 2. Taste-based aliases from TasteRegister
+    # 3. Returns nil if no alias found
+    #
+    # @param flavour [Symbol, String, nil] The flavor alias to look up
+    # @return [Symbol, nil] The canonical flavor name, or nil if no alias exists
+    #
+    # @example
+    #   registry.alias(:csd)  # => :cc (from DEFAULT_ALIASES)
+    #   registry.alias(:icc)  # => :iso (from taste configuration)
+    #   registry.alias(:unknown)  # => nil
+    #   registry.alias(nil)  # => nil
     def alias(flavour)
-      @aliases[flavour]
+      return nil if flavour.nil?
+
+      flavour_sym = flavour.to_sym
+
+      # Check custom aliases first (includes defaults)
+      return @custom_aliases[flavour_sym] if @custom_aliases.key?(flavour_sym)
+
+      # Then check taste aliases
+      taste_aliases = @tastes.aliases
+      taste_aliases[flavour_sym]
+    end
+
+    # Register a custom alias mapping
+    #
+    # Allows runtime registration of flavor aliases. Custom aliases take precedence
+    # over taste-based aliases, allowing overrides of taste configurations.
+    #
+    # @param alias_name [Symbol, String] The alias name to register
+    # @param target_flavor [Symbol, String] The canonical flavor it should map to
+    #
+    # @example
+    #   registry.register_alias(:my_custom, :iso)
+    #   registry.alias(:my_custom)  # => :iso
+    #
+    #   # Override a taste alias
+    #   registry.register_alias(:icc, :custom_iso)
+    def register_alias(alias_name, target_flavor)
+      @custom_aliases[alias_name.to_sym] = target_flavor.to_sym
     end
 
+    # Register a Metanorma processor
+    #
+    # Registers a processor class and automatically creates aliases for all its
+    # short names. The last short name is considered the canonical name.
+    #
+    # @param processor [Class] A processor class that inherits from Metanorma::Processor
+    # @raise [Error] If the processor doesn't inherit from Metanorma::Processor
+    # @return [Array<Symbol>] Array of short names for the processor
+    #
+    # @example
+    #   registry.register(Metanorma::ISO::Processor)
+    #   # Registers processor and creates aliases for all its short names
     def register(processor)
-      processor < ::Metanorma::Processor or raise Error
-      p = processor.new
-      # p.short[-1] is the canonical name
-      short = Array(p.short)
-      @processors[short[-1]] = p
-      short.each { |s| @aliases[s] = short[-1] }
-      Array(p.short)
-      Util.log("[metanorma] processor \"#{Array(p.short)[0]}\" registered", :info)
+      unless processor < ::Metanorma::Processor
+        raise Error, "Processor must inherit from Metanorma::Processor"
+      end
+
+      # The last short name is the canonical name
+      processor_instance = processor.new
+      short_names = Array(processor_instance.short)
+      canonical_name = short_names.last
+
+      # Register processor with canonical name
+      @processors[canonical_name] = processor_instance
+
+      # Create aliases for all short names pointing to canonical name
+      short_names.each { |name| @custom_aliases[name] = canonical_name }
+
+      Util.log("[metanorma] processor \"#{short_names.first}\" registered", :info)
+      short_names
     end
 
+    # Find a registered processor by its short name
+    #
+    # @param short [Symbol, String] The short name of the processor to find
+    # @return [Metanorma::Processor, nil] The processor instance, or nil if not found
+    #
+    # @example
+    #   processor = registry.find_processor(:iso)
+    #   processor = registry.find_processor("iso")
     def find_processor(short)
       @processors[short.to_sym]
     end
 
+    # Get list of all supported backend names
+    #
+    # @return [Array<Symbol>] Array of registered processor backend names
+    #
+    # @example
+    #   registry.supported_backends  # => [:iso, :iec, :itu, ...]
     def supported_backends
       @processors.keys
     end
 
+    # Get output formats supported by each registered processor
+    #
+    # @return [Hash<Symbol, Hash>] Hash mapping processor names to their output formats
+    #
+    # @example
+    #   registry.output_formats
+    #   # => { iso: { html: "html", pdf: "pdf", ... }, iec: { ... }, ... }
     def output_formats
       @processors.inject({}) do |acc, (k, v)|
         acc[k] = v.output_formats
@@ -53,6 +168,13 @@ module Metanorma
       end
     end
 
+    # Get XML root tags for processors with Asciidoctor backends
+    #
+    # @return [Hash<Symbol, String>] Hash mapping processor names to their XML root tags
+    #
+    # @example
+    #   registry.root_tags
+    #   # => { iso: "iso-standard", iec: "iec-standard", ... }
     def root_tags
       @processors.inject({}) do |acc, (k, v)|
         if v.asciidoctor_backend

data/lib/metanorma/version.rb

@@ -1,3 +1,3 @@
 module Metanorma
-  VERSION = "2.2.1".freeze
+  VERSION = "2.2.3".freeze
 end

data/metanorma.gemspec

@@ -29,7 +29,7 @@ Gem::Specification.new do |spec|
   spec.add_runtime_dependency "fontist", ">= 1.14.3"
   spec.add_runtime_dependency "htmlentities"
   spec.add_runtime_dependency "isodoc", ">= 3.0.0"
-  spec.add_runtime_dependency "metanorma-taste"
+  spec.add_runtime_dependency "metanorma-taste", "~> 0.1.0"
   spec.add_runtime_dependency "mn2pdf", "~> 2"
   spec.add_runtime_dependency "nokogiri"
 
@@ -38,7 +38,7 @@ Gem::Specification.new do |spec|
   # spec.add_dependency "metanorma-standoc"
 
   spec.add_development_dependency "debug"
-  spec.add_development_dependency "equivalent-xml", "~> 0.6"
+  spec.add_development_dependency "equivalent-xml"
   spec.add_development_dependency "metanorma-iso"
   spec.add_development_dependency "mnconvert"
   spec.add_development_dependency "pry"
@@ -49,5 +49,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rubocop-performance"
   spec.add_development_dependency "sassc-embedded", "~> 1"
   spec.add_development_dependency "simplecov", "~> 0.15"
-  spec.add_development_dependency "xml-c14n"
+  spec.add_development_dependency "canon"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: metanorma
 version: !ruby/object:Gem::Version
-  version: 2.2.1
+  version: 2.2.3
 platform: ruby
 authors:
 - Ribose Inc.
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-06-23 00:00:00.000000000 Z
+date: 2025-08-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: asciidoctor
@@ -84,16 +84,16 @@ dependencies:
   name: metanorma-taste
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.1.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.1.0
 - !ruby/object:Gem::Dependency
   name: mn2pdf
   requirement: !ruby/object:Gem::Requirement
@@ -140,16 +140,16 @@ dependencies:
   name: equivalent-xml
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.6'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.6'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: metanorma-iso
   requirement: !ruby/object:Gem::Requirement
@@ -291,7 +291,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0.15'
 - !ruby/object:Gem::Dependency
-  name: xml-c14n
+  name: canon
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="