metanorma 2.2.0 → 2.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: af06733dd8691111633e6309c85ebfa069baa2edf16cbd7e8458a17ad34d4b2a
-  data.tar.gz: e924bb9b298cc37c2cebef6f8d9251ae3979e9cd9b537539057a5ade07e11c88
+  metadata.gz: 6c21a32c429827b3a3f308801ec2e8617f2e30f2baf8c8e5e6c80f2c105b0ce2
+  data.tar.gz: b59f55514b1413623471c7c408a7688a87513f03aca899afeb433372577f37e1
 SHA512:
-  metadata.gz: 29499feb91dd56f4fe6f281f885263c897fb555a9905ce3a32b56d175199b520e9066041ff96489d5221302c259a08bf0d3c07bde19a232b3893d79a0bde747b
-  data.tar.gz: 717f1409b88dfc565393c71cddb0fda604e062d38e80b45c470dc06957ac5e7cf2f5adfd7ef7083666aeb4f7f7b6356fcbc95014bb2e9091c9c927232d7c225f
+  metadata.gz: 06e63a51abf0ff822b2f6bed6cf51a1c0a55f08375aff1aec64d41016fd5c3f4d61ed21661911dee7bb9c4477a406b1a5bd125f95c2d00a9096415249cba24c5
+  data.tar.gz: 78352215966b37d04fbb5cb0203bd65d725b63eade9652ecf2142ef4d9b594fe69229232de6e5796c44c782cef3763af4e5d31c2eee2a0f67e8ab3c66bc470da

data/lib/metanorma/collection/config/converters.rb

@@ -6,16 +6,37 @@ module Metanorma
       module Converters
         def bibdata_from_yaml(model, value)
           value and !value.empty? or return
+          force_primary_docidentifier_yaml(value)
           model.bibdata = Relaton::Cli::YAMLConvertor.convert_single_file(value)
         end
 
+        def force_primary_docidentifier_yaml(value)
+          case value["docid"]
+          when Array
+            value["docid"].empty? ||
+              value["docid"].none? do |x|
+                x["primary"] == "true"
+              end or
+              value["docid"].first["primary"] = "true"
+          when Hash
+            value["docid"]["primary"] ||= "true"
+          end
+        end
+
         def bibdata_to_yaml(model, doc)
           doc["bibdata"] = model.bibdata&.to_hash
         end
 
         def bibdata_from_xml(model, node)
-          node and
-            model.bibdata = Relaton::Cli.parse_xml(node.adapter_node)
+          node or return
+          force_primary_docidentifier_xml(node.adapter_node)
+          model.bibdata = Relaton::Cli.parse_xml(node.adapter_node)
+        end
+
+        def force_primary_docidentifier_xml(node)
+          node.at("//docidentifier[@primary = 'true']") and return node
+          d = node.at("//docidentifier") or return node
+          d["primary"] = "true"
         end
 
         def bibdata_to_xml(model, parent, doc)

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

@@ -11,14 +11,12 @@ module Metanorma
       end
 
       def svgmap_resolve(docxml, docid, presxml)
-        #require "debug"; binding.b
         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|
-        #require "debug"; binding.b
           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

data/lib/metanorma/collection/util/util.rb

@@ -39,8 +39,6 @@ module Metanorma
         def add_suffix_to_attrs(doc, suffix, tag_name, attr_name, isodoc)
           (suffix.nil? || suffix.empty?) and return
           doc.xpath(isodoc.ns("//#{tag_name}[@#{attr_name}]")).each do |elem|
-            #warn "#{tag_name} : #{elem.name}" if attr_name == "bibitemid"
-            #require 'debug'; binding.b if attr_name == "bibitemid" && #!%w(eref fmt-eref link fmt-link).include?(elem.name)
             a = elem.attributes[attr_name].value
             /_#{suffix}$/.match?(a) or
               elem.attributes[attr_name].value = "#{a}_#{suffix}"
@@ -91,6 +89,8 @@ module Metanorma
           isodoc.i18n_init(lang, script, nil) # read in internationalisation
           # TODO locale?
           isodoc.metadata_init(lang, script, nil, isodoc.i18n)
+          isodoc.xref_init(lang, script, nil, isodoc.i18n, {})
+          isodoc.xrefs.klass.meta = isodoc.meta
           isodoc.info(xml, nil)
           isodoc
         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.0".freeze
+  VERSION = "2.2.2".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"
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: metanorma
 version: !ruby/object:Gem::Version
-  version: 2.2.0
+  version: 2.2.2
 platform: ruby
 authors:
 - Ribose Inc.
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-06-09 00:00:00.000000000 Z
+date: 2025-07-05 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