metanorma-standoc 3.4.7 → 3.4.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b1dfc55e13dc35cba30f131721a669b4d8f4373d9afea12d2a1fd19c178ab9b1
-  data.tar.gz: b1c07c99802d3018f9205e3b68574d2e6557380d81b51f6d33fec5026da355d4
+  metadata.gz: a76abb834a587adae31dae92f93936ca82968bc7b77a9d907633b51a0de29319
+  data.tar.gz: a03fe3c22052427818cc8161c376786c27b3ee570dec4f4fa243713b54ef30a6
 SHA512:
-  metadata.gz: 501724517b1124aab3b9be9dc9eece4c4da9671e8ca13b6c4a86f52e45487772ed50b51418cc334280f183241c0d244acc4b7f63040a6b8ecf0ac5e48676e458
-  data.tar.gz: 3b6a32f1e821f68243cc01f3833f6f8fa26f14ac5f6b686e10cf872c6f4cdd968324579540dea0ee481d06ecaa04695390a601888d72977ea1375dabb1b4b789
+  metadata.gz: 17ac7b991acf83f47f01e79c8c0eb71f1531db814c77ec60b5fa69b0828707a25702f83a92492b49a2217f23525287d22fb6e064b3a48a3b3ecbbc8646a964d4
+  data.tar.gz: df7537f969e7559c90569125da0c3847da7cc723c998f96e1393229607d22271191b909c36262a8ee89a0c63fea20b5a4e005fa925e430c6b2e6b08d6699c1a6

data/.rubocop.yml

@@ -2,9 +2,30 @@
 # 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

@@ -6,5 +6,10 @@ git_source(:github) { |repo| "https://github.com/#{repo}" }
 
 gemspec
 
-eval_gemfile("Gemfile.devel") rescue nil
+# Stopgap: lutaml 0.11.x removed lib/lutaml/xmi.rb, which metanorma-plugin-lutaml
+# 0.7.x still `require`s. Hold lutaml at 0.10.x until plugin-lutaml follows the
+# file to its new home. Remove once resolved:
+# https://github.com/metanorma/metanorma-plugin-lutaml/issues/292
+gem "lutaml", "< 0.11"
 
+eval_gemfile("Gemfile.devel") rescue nil

data/lib/isodoc/html/htmlstyle.css

@@ -150,6 +150,11 @@ a.FootnoteRef, span.FootnoteRef {
   vertical-align: super;
 }
 
+a.TableFootnoteRef, a.FootnoteRef, a.footnote-number,
+sup a, a:has(> sup) {
+  vertical-align: baseline;
+}
+
 .addition {
   color: blue;
 }

data/lib/metanorma/cleanup/bibdata.rb

@@ -198,15 +198,23 @@ module Metanorma
         XML
       end
 
-      def published_base?(stage, _xmldoc)
+      def published_base?(stage, xmldoc)
         if @stage_published
           @stage_published == "true"
-        else published?(stage, _xmldoc)
+        else !draft_stage?(stage, xmldoc)
         end
       end
 
+      # Is the stage a draft (unpublished) stage? Overridable seam for
+      # flavours whose stage repertoires are not the binary
+      # published/unpublished; the :docstage-published: document
+      # attribute (@stage_published, above) trumps it either way.
+      def draft_stage?(stage, xmldoc)
+        !published?(stage, xmldoc)
+      end
+
       def published?(stage, _xmldoc)
-        stage.casecmp("published").zero?
+        stage.to_s.casecmp("published").zero?
       end
 
       # allows us to deal with doc relation localities,

data/lib/metanorma/cleanup/cleanup.rb

@@ -61,7 +61,7 @@ module Metanorma
           boilerplateauthority embed_hdr embed_id erefstyle originstyle
           xrefstyle blockunnumbered keepasciimath numberfmt_formula
           numberfmt_prof sort_biblio reqt_models default_requirement_model
-          document_scheme
+          document_scheme publisher_sort_config
         ]
       end
 

data/lib/metanorma/cleanup/ref.rb

@@ -34,6 +34,77 @@ module Metanorma
         bib
       end
 
+      BIBLIO_PUBLISHER_ORG =
+        "./contributor[role/@type = 'publisher']/organization".freeze
+
+      # Configurable publisher sort ranking, shared by every flavour's
+      # bibliography sort. `table` is the flavour's default ordering, an array
+      # of { abbrev:, name:, rank: }. A per-document / metanorma-taste override
+      # (:sort-biblio-<abbrev>: <rank>: <name> attributes, captured into
+      # @publisher_sort_config) REPLACES the flavour default when present.
+      #
+      # A matched publisher gets its configured rank; an unmatched standards
+      # reference sorts immediately after the ranked publishers, and a
+      # non-standard reference last. With no override and the flavour's own
+      # default table, this reproduces the flavour's historical hardcoded ranks.
+      def publisher_sort_rank(bib, table)
+        table = publisher_sort_table(table)
+        if (entry = publisher_sort_match(bib, table))
+          return entry[:rank]
+        end
+
+        maxrank = table.map { |e| e[:rank] }.max || 0
+        biblio_standards_ref?(bib) ? maxrank + 1 : maxrank + 2
+      end
+
+      # Secondary sort token: the co-publisher(s) other than the matched
+      # primary. Deterministic when several co-publishers exist (returns the
+      # smallest token), which reproduces e.g. JIS's "JIS+IEC before
+      # JIS+ISO, JIS+IEC+ISO alongside JIS+IEC" ordering.
+      def publisher_sort_second(bib, table)
+        entry = publisher_sort_match(bib, publisher_sort_table(table))
+        entry or return ""
+        bib.xpath(BIBLIO_PUBLISHER_ORG)
+          .reject { |o| publisher_org_match?(o, entry) }
+          .map { |o| (o.at("./abbreviation") || o.at("./name"))&.text&.strip }
+          .compact.reject(&:empty?).min || ""
+      end
+
+      def publisher_sort_table(default_table)
+        cfg = @publisher_sort_config
+        cfg && !cfg.empty? ? cfg : default_table
+      end
+
+      # lowest-ranked table entry whose publisher appears on the bibitem
+      def publisher_sort_match(bib, table)
+        orgs = bib.xpath(BIBLIO_PUBLISHER_ORG)
+        table.sort_by { |e| e[:rank] }.find do |e|
+          orgs.any? { |o| publisher_org_match?(o, e) }
+        end
+      end
+
+      # A table entry matches a publisher organization on its abbreviation
+      # (case-insensitive, since AsciiDoc lowercases attribute-derived abbrevs)
+      # or on any of its names (`name` may be a single string or an array; the
+      # latter lets a flavour list, e.g., a Japanese and an English publisher
+      # name for the same rank).
+      def publisher_org_match?(org, entry)
+        abbr = org.at("./abbreviation")&.text&.strip
+        name = org.at("./name")&.text&.strip
+        names = Array(entry[:name]).map { |n| n.to_s.strip }.reject(&:empty?)
+        (!entry[:abbrev].to_s.empty? && abbr&.casecmp?(entry[:abbrev])) ||
+          (!name.to_s.empty? && names.include?(name))
+      end
+
+      # Whether a bibitem is a standards reference (sorts after the ranked
+      # publishers, before non-standard references). Base definition: it has a
+      # typed, non-DOI/ISSN/ISBN docidentifier. Flavours may widen this (ISO
+      # also treats an untyped docidentifier as a standards reference).
+      def biblio_standards_ref?(bib)
+        !!bib.at("./docidentifier[@type][not(#{@conv.skip_docid} or " \
+                 "@type = 'metanorma')]")
+      end
+
       # default presuppose that all citations in biblio numbered
       # consecutively, but that standards codes are preserved as is:
       # only numeric references are renumbered

data/lib/metanorma/cleanup/term_lookup.rb

@@ -48,6 +48,7 @@ module Metanorma
       def concept_cleanup
         xmldoc.xpath("//concept").each do |n|
           refterm = n.at("./refterm") or next
+          refterm.xpath(".//index").each(&:remove)
           lookup = norm_ref_id_text(refterm.text.strip)
           p = @lookup[:sec2prim][lookup] and refterm.children = @c.encode(p)
         end

data/lib/metanorma/converter/blocks.rb

@@ -116,6 +116,7 @@ module Metanorma
           .merge(align: node.attr("align"),
                  variant_title: node.role == "variant-title" ? true : nil,
                  key: node.option?("key") ? "true" : nil,
+                 class: node.attr("class"),
                  type: node.attr("type"))))
       end
 
@@ -134,7 +135,7 @@ module Metanorma
 
       def quote_attrs(node)
         attr_code(id_attr(node).merge(keep_attrs(node))
-          .merge(align: node.attr("align")))
+          .merge(align: node.attr("align"), class: node.attr("class")))
       end
 
       def quote_attribution(node, out)
@@ -164,6 +165,7 @@ module Metanorma
                          linenums: linenums ? "true" : nil,
                          unnumbered: node.option?("unnumbered") ? "true" : nil,
                          number: node.attr("number"),
+                         class: node.attr("class"),
                          filename: node.attr("filename"))))
       end
 

data/lib/metanorma/converter/blocks_examples.rb

@@ -41,7 +41,8 @@ module Metanorma
       def pseudocode_example(node)
         node.blocks.each { |b| b.remove_sub(:replacements) }
         noko do |xml|
-          xml.figure **example_attrs(node).merge(class: "pseudocode") do |ex|
+          klass = (["pseudocode"] + (node.attr("class")&.split || [])).uniq
+          xml.figure **example_attrs(node).merge(class: klass.join(" ")) do |ex|
             block_title(node, ex)
             wrap_in_para(node, ex)
           end
@@ -50,7 +51,8 @@ module Metanorma
 
       def example_attrs(node)
         attr_code(id_unnum_attrs(node).merge(keep_attrs(node))
-          .merge(collapsible: node.option?("collapsible") ? "true" : nil))
+          .merge(collapsible: node.option?("collapsible") ? "true" : nil,
+                 class: node.attr("class")))
       end
 
       def example_proper(node)

data/lib/metanorma/converter/blocks_notes.rb

@@ -12,7 +12,7 @@ module Metanorma
 
       def note_attrs(node)
         attr_code(termnote_attrs(node).merge(admonition_core_attrs(node)
-          .merge(type: node.attr("type"))))
+          .merge(type: node.attr("type"), class: node.attr("class"))))
       end
 
       def sidebar(node)
@@ -86,7 +86,7 @@ module Metanorma
       def admonition_attrs(node)
         attr_code(keep_attrs(node).merge(id_attr(node)
           .merge(admonition_core_attrs(node)
-          .merge(type: admonition_name(node)))))
+          .merge(type: admonition_name(node), class: node.attr("class")))))
       end
 
       def admonition_core_attrs(node)

data/lib/metanorma/converter/converter.rb

@@ -40,11 +40,16 @@ module Metanorma
         preprocessor Metanorma::Standoc::EmbedIncludeProcessor
         preprocessor Metanorma::Standoc::LinkProtectPreprocessor
         preprocessor Metanorma::Standoc::PassProtectPreprocessor
-        preprocessor Metanorma::Standoc::MonospaceProtectPreprocessor
         preprocessor Metanorma::Plugin::Lutaml::Json2TextPreprocessor
         preprocessor Metanorma::Plugin::Lutaml::Yaml2TextPreprocessor
         preprocessor Metanorma::Plugin::Lutaml::Data2TextPreprocessor
         preprocessor Metanorma::Plugin::Lutaml::LutamlXmiUmlPreprocessor
+        # MonospaceProtect must run AFTER the content-injecting preprocessors
+        # (json2text/yaml2text/data2text, XMI) so that monospace in their
+        # injected content is protected from Asciidoctor character
+        # substitution too, consistently with hand-authored adoc.
+        # metanorma/iso-10303#208
+        preprocessor Metanorma::Standoc::MonospaceProtectPreprocessor
         preprocessor Metanorma::Plugin::Glossarist::DatasetPreprocessor
         preprocessor Metanorma::Standoc::NamedEscapePreprocessor
         inline_macro Metanorma::Standoc::PreferredTermInlineMacro
@@ -106,7 +111,8 @@ module Metanorma
       $xreftext = {}
 
       attr_reader :bibdb, :lang, :script, :locale, :relaton_log, :libdir, :backend,
-                  :novalid, :local_log, :output_dir, :filename, :files_to_delete
+                  :novalid, :local_log, :output_dir, :filename, :files_to_delete,
+                  :docstage_valid
 
       def initialize(backend, opts)
         doc = opts&.dig(:document)

data/lib/metanorma/converter/init.rb

@@ -27,6 +27,7 @@ module Metanorma
         @document_scheme = document_scheme(node)
         @default_doctype = "standard"
         @stage_published = node.attr("docstage-published")
+        @docstage_valid = node.attr("docstage-valid")&.split(/,\s*/)
         @metadata_attrs = metadata_attrs(node)
       end
 
@@ -116,6 +117,11 @@ module Metanorma
       end
 
       def init_toc(node)
+        init_toc_levels(node)
+        init_toc_types(node)
+      end
+
+      def init_toc_levels(node)
         @htmltoclevels = node.attr("toclevels-html") ||
           node.attr("htmltoclevels") ||
           node.attr("toclevels") || toc_default[:html_levels]
@@ -125,10 +131,13 @@ module Metanorma
         @pdftoclevels = node.attr("toclevels-pdf") ||
           node.attr("toclevels") || toc_default[:pdf_levels]
         @toclevels = node.attr("toclevels") || toc_default[:html_levels]
-        @tocfigures = node.attr("toc-figures")
-        @toctables = node.attr("toc-tables")
-        @tocrecommendations = node.attr("toc-recommendations")
-        @tocexamples = node.attr("toc-examples")
+      end
+
+      def init_toc_types(node)
+        @tocfigures = node.attr("toc-figures") != "false"
+        @toctables = node.attr("toc-tables") != "false"
+        @tocrecommendations = node.attr("toc-recommendations") != "false"
+        @tocexamples = node.attr("toc-examples") != "false"
       end
 
       def toc_default
@@ -175,6 +184,7 @@ module Metanorma
         @no_isobib = node.attr("no-isobib")
         @flush_caches = node.attr("flush-caches")
         @sort_biblio = node.attr("sort-biblio") != "false"
+        @publisher_sort_config = init_publisher_sort_config(node)
         init_bib_db(node)
         init_bib_caches(node)
         init_iev_caches(node)
@@ -182,6 +192,21 @@ module Metanorma
         @biblio_cutoff = biblio_cutoff(node)
       end
 
+      # Per-publisher bibliography sort ranks, from
+      # :sort-biblio-<abbrev>: <rank>: <name> document attributes (set directly
+      # in a document or injected by a metanorma-taste config). AsciiDoc
+      # lowercases attribute names, so <abbrev> is matched case-insensitively
+      # downstream. Returns [] when none are set (flavours keep their default
+      # publisher ordering).
+      def init_publisher_sort_config(node)
+        node.attributes.each_with_object([]) do |(k, v), acc|
+          m = /\Asort-biblio-(?<abbrev>.+)\z/.match(k.to_s) or next
+          rank_s, name = v.to_s.split(":", 2)
+          rank = Integer(rank_s.to_s.strip, exception: false) or next
+          acc << { abbrev: m[:abbrev].strip, name: name&.strip, rank: rank }
+        end
+      end
+
       def init_bib_db(node)
         @bibdb = nil
         @local_bibdb =
@@ -197,6 +222,15 @@ module Metanorma
       end
 
       def biblio_cutoff(node)
+        # An explicit :bibliography-cutoff-date: overrides the date derived from
+        # the document's own dates, and a sentinel (none/false/no/off) disables
+        # the cutoff entirely. metanorma/metanorma-standoc#941.
+        if (override = node.attr("bibliography-cutoff-date"))
+          override = override.strip
+          return nil if %w(none false no off).include?(override.downcase)
+
+          return complete_and_compare_dates([override])
+        end
         dates = %w(revdate published-date accessed-date created-date
                    implemented-date confirmed-date updated-date issued-date
                    circulated-date unchanged-date copyright-year)

data/lib/metanorma/converter/lists.rb

@@ -24,6 +24,7 @@ module Metanorma
       def ul_attrs(node)
         attr_code(id_attr(node).merge(keep_attrs(node)
           .merge(display: node.attr("display"),
+                 class: node.attr("class"),
                  "display-directives": node.attr("display-directives"))))
       end
 
@@ -63,6 +64,7 @@ module Metanorma
           .merge(type: olist_style(node.style),
                  start: node.attr("start"),
                  display: node.attr("display"),
+                 class: node.attr("class"),
                  "display-directives": node.attr("display-directives"),
                  "explicit-type": olist_style(node.attributes[1]))))
       end
@@ -101,6 +103,7 @@ module Metanorma
           .merge(
             metadata: node.option?("metadata") ? "true" : nil,
             key: node.option?("key") ? "true" : nil,
+            class: node.attr("class"),
           )))
       end
 

data/lib/metanorma/converter/macros.rb

@@ -67,16 +67,23 @@ module Metanorma
         end.join
       end
 
-      # debugging output of results of all preprocessing,
-      # including include files concatenation and Lutaml/Liquid processing
+      # debugging output of results of all preprocessing, including include
+      # files concatenation and Lutaml/Liquid processing.
+      #
+      # Skipped for docfile-less (string/stdin) input: the target would
+      # degenerate to a single CWD-relative "./metanorma.asciidoc.log.txt" that
+      # the thousands of collection sub-compiles all truncate-rewrite (so it
+      # carries no useful diagnostics anyway). And a diagnostic write must never
+      # abort the build, so a write failure degrades to a warning rather than
+      # propagating out of the preprocessor. metanorma/metanorma-standoc#1209
       def log(doc, text)
-        source = doc.attr("docfile") || "metanorma"
+        source = doc.attr("docfile") or return
         dirname  = File.dirname(source)
         basename = File.basename(source, ".*")
         fname = File.join(dirname, "#{basename}.asciidoc.log.txt")
-        File.open(fname, "w:UTF-8") do |f|
-          f.write(text.join("\n"))
-        end
+        File.open(fname, "w:UTF-8") { |f| f.write(text.join("\n")) }
+      rescue SystemCallError => e
+        warn "metanorma: could not write preprocessing log #{fname}: #{e.message}"
       end
     end
 

data/lib/metanorma/converter/table.rb

@@ -9,7 +9,11 @@ module Metanorma
                  plain: node.option?("plain") ? "true" : nil,
                  style: node.attr("css-style"),
                  summary: node.attr("summary"),
-                 width: node.attr("width"))
+                 width: node.attr("width"),
+                 # Custom CSS class(es) passed through to HTML output, via the
+                 # `[class="..."]` named attribute (NOT role, which is reserved
+                 # for block dispatch). metanorma/metanorma-pdfa#33
+                 class: node.attr("class"))
       end
 
       def table(node)

data/lib/metanorma/standoc/version.rb

@@ -19,6 +19,6 @@ module Metanorma
   end
 
   module Standoc
-    VERSION = "3.4.7".freeze
+    VERSION = "3.4.9".freeze
   end
 end

data/lib/metanorma/validate/basicdoc.rng

@@ -1902,15 +1902,40 @@ or as the string "auto"</a:documentation>
     <a:documentation>Mathematically formatted text</a:documentation>
     <element name="stem">
       <ref name="StemAttributes"/>
-      <oneOrMore>
-        <choice>
+      <optional>
+        <text>
           <a:documentation>The content of the mathematically formatted text</a:documentation>
-          <text/>
-          <ref name="AnyElement"/>
-        </choice>
-      </oneOrMore>
+        </text>
+      </optional>
+      <optional>
+        <ref name="mathml"/>
+      </optional>
+      <optional>
+        <ref name="asciimath"/>
+      </optional>
+      <optional>
+        <ref name="latexmath"/>
+      </optional>
     </element>
   </define>
+  <define name="latexmath">
+    <a:documentation>Encoding of LatexMath</a:documentation>
+    <element name="latexmath">
+      <text/>
+    </element>
+  </define>
+  <define name="asciimath">
+    <a:documentation>Encoding of AsciiMath</a:documentation>
+    <element name="asciimath">
+      <text/>
+    </element>
+  </define>
+  <define name="mathml">
+    <a:documentation>Encoding of MathML: the official W3C MathML 4 grammar (namespace
+http://www.w3.org/1998/Math/MathML), via the metanorma wrapper in
+grammars/mathml/. See grammars/mathml/README.adoc and basicdoc-models#35.</a:documentation>
+    <externalRef href="metanorma-mathml.rng"/>
+  </define>
   <define name="StemAttributes">
     <attribute name="type">
       <a:documentation>The notation used to mathematically format the text</a:documentation>

data/lib/metanorma/validate/isodoc.rng

@@ -852,7 +852,7 @@ titlecase, or lowercase</a:documentation>
         <a:documentation>Width of the figure block in rendering</a:documentation>
       </attribute>
     </optional>
-    <ref name="BlockAttributes"/>
+    <ref name="BlockAttributesCore"/>
   </define>
   <define name="SourceAttributes" combine="interleave">
     <ref name="BlockAttributes"/>
@@ -1283,7 +1283,11 @@ That concept may be defined as a term within the current document, or it may be
           <a:documentation>Class of input form</a:documentation>
         </attribute>
       </optional>
-      <ref name="BlockAttributes"/>
+      <ref name="BlockAttributesCore">
+        <a:documentation>form declares its own class above, so it uses BlockAttributesCore to
+avoid duplicating the custom-class slot in BlockAttributes. Treated like
+figure. See metanorma/metanorma-standoc#1197</a:documentation>
+      </ref>
       <zeroOrMore>
         <!-- Input form contents -->
         <choice>
@@ -2768,7 +2772,11 @@ links within an SVG file, so that the SVG file can hyperlink to anchors within t
       </oneOrMore>
     </element>
   </define>
-  <define name="BlockAttributes">
+  <define name="BlockAttributesCore">
+    <a:documentation>Block attributes excluding the custom CSS class. Blocks that already carry
+their own `class` attribute (e.g. figure, via basicdoc FigureAttributes)
+include this directly, to avoid a duplicate-attribute collision with the
+`class` added in BlockAttributes. See metanorma/metanorma-standoc#1197</a:documentation>
     <optional>
       <attribute name="keep-with-next">
         <a:documentation>Keep this block on the same page as the following block in paged media</a:documentation>
@@ -2800,6 +2808,17 @@ to span across both columns</a:documentation>
       </attribute>
     </optional>
   </define>
+  <define name="BlockAttributes">
+    <a:documentation>Universal block attributes, including a custom CSS class (space-separated,
+appended additively to the block's built-in HTML class, HTML output only).
+See metanorma/metanorma-standoc#1197</a:documentation>
+    <ref name="BlockAttributesCore"/>
+    <optional>
+      <attribute name="class">
+        <a:documentation>Custom CSS class(es) for the block in HTML output</a:documentation>
+      </attribute>
+    </optional>
+  </define>
   <define name="DisplayDirective">
     <a:documentation>Directive on how to render a block in Presentation XML </a:documentation>
     <optional>