metanorma-ietf 3.7.5 → 3.7.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ecb30164aa292c1dc02c1e133986d9d84fe829a1750bfcb814175694cd8ff4c2
-  data.tar.gz: 7a0c9a1fdcdae18d3809e4bc8c885813e856478f08e60374d6ba84f31ed72431
+  metadata.gz: 6e8481e986bb9e8f6f6544aa626251e7d4af18be4650a654c6fa6e1f9f4c093e
+  data.tar.gz: 26b7391ce2715daf4ce3f7c10387ce9620b5485229b646ca8c1817bf0206797f
 SHA512:
-  metadata.gz: 592138149c1102b1dfe8b97e72cc1681965332320147c0f5758e39a3d5680556e698facb9a793e075c0c82c247c4e23c06f584149450080724da795b094d3f20
-  data.tar.gz: 05c0e6d1f81776ebf6c68391dff1446243abd9ea9361debd44009137c30463fe6b29f4b3b261901bde395652a7dbb7acfa9dd93c65a7c44524dffce1255c1ebc
+  metadata.gz: 7edb00b1b05b750cdba48d04dc71f7725f9b6086db0b8c76c6f8b793e72a8c914a6949bf5613da391d9149b175dde49762f639498a75e0c01b20294abcc091d2
+  data.tar.gz: ca1b556936be2cb95a8ab1bad6af2b2d1db870869cb76752bd1f14f5f1a7fd95b7fbca17adb596d011ee48245c6135474b8df05b4f5530261a0b6e6db7d37371

data/.rubocop.yml

@@ -1,10 +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/master/ci/rubocop.yml
+  - 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: 2.5
+  # 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/lib/isodoc/ietf/cleanup.rb

@@ -79,7 +79,8 @@ module IsoDoc
         xmldoc.xpath("//refcontent").each do |a|
           val = a.text.strip
           if val.empty? then a.remove
-          else a.children = val
+          else a.content = val # not children=: a literal "<" in the text
+            # would be reparsed as markup and fabricate an element (#267)
           end
         end
       end
@@ -98,18 +99,26 @@ module IsoDoc
         end.join
       end
 
+      # Flatten titles to the plain text RFC XML v3 allows, without a
+      # string -> XML round-trip: replacing an empty eref with its raw
+      # target string, then reparsing the title text as markup, fabricated
+      # an element out of a URL adjacent to a literal "<" in a formattedref
+      # ("<http:>", a QName violation fatal to xml2rfc, #267). Text nodes
+      # and content= keep the same flattening semantics with escaping.
       def front_cleanup(xmldoc)
-        xmldoc.xpath("//title").each do |s|
-          s.xpath(".//eref[normalize-space(.)='']").each do |e|
-            e.replace(e["target"])
-          end
-          s.children = s.text
-        end
+        xmldoc.xpath("//title").each { |s| title_flatten(s, xmldoc) }
         xmldoc.xpath("//reference/front[not(author)]").each do |f|
           insert = f.at("./seriesInfo[last()]") || f.at("./title")
           insert.next = "<author surname='Unknown'/>"
         end
       end
+
+      def title_flatten(title, xmldoc)
+        title.xpath(".//eref[normalize-space(.)='']").each do |e|
+          e.replace(xmldoc.create_text_node(e["target"]))
+        end
+        title.content = title.text
+      end
     end
   end
 end

data/lib/isodoc/ietf/cleanup_blocks.rb

@@ -117,14 +117,23 @@ module IsoDoc
 
       def crossref_remove_markup_elem(node)
         case node.name
-        when "eref"
-          node.replace(node.children.empty? ? node["target"] : node.children)
+        when "eref" then crossref_flatten_eref(node)
         when "xref"
           node.children.empty? ? sourcecode_xref(node) : node.replace(node.children)
           # when "relref" then n.replace(n.children.empty? ? n["target"] : n.children)
         end
       end
 
+      # empty eref: insert the target as a text node, not a raw string
+      # that Nokogiri would reparse as markup (#267)
+      def crossref_flatten_eref(node)
+        if node.children.empty?
+          node.replace(node.document.create_text_node(node["target"]))
+        else
+          node.replace(node.children)
+        end
+      end
+
       def sourcecode_remove_markup_elem(node)
         case node.name
         when "br" then node.replace("\n")

data/lib/isodoc/ietf/inline.rb

@@ -142,18 +142,22 @@ module IsoDoc
         end
       end
 
+      # Empty localities are omitted, not emitted as section=""
+      # relative="" junk attributes (#269): attr_code drops nil, not ""
       def eref_relative(node)
-        node["relative"] ||
-          node.at(ns(".//locality[@type = 'anchor']/referenceFrom"))&.text || ""
+        ret = node["relative"] ||
+          node.at(ns(".//locality[@type = 'anchor']/referenceFrom"))&.text
+        ret.nil? || ret.empty? ? nil : ret
       end
 
       def eref_section(node)
         ret = @isodoc.eref_localities(
           node.xpath(ns("./locality | ./localityStack")), nil, node
-        ) or return ""
-        ret.gsub(%r{</?span[^>]*>}, "").sub(/^,/, "")
+        ) or return nil
+        ret = ret.gsub(%r{</?span[^>]*>}, "").sub(/^,/, "")
           .sub(/^\s*(Sections?|Clauses?)/, "").strip.sub(/,$/, "")
           .gsub(/\s+/, " ")
+        ret.empty? ? nil : ret
       end
 
       def semx_origin_parse(node, out)

data/lib/isodoc/ietf/metadata.rb

@@ -47,9 +47,15 @@ module IsoDoc
         set(:wg, workgroups)
       end
 
+      # Standoc emits <doctype>rfc</doctype>, which the base class
+      # capitalises to "Rfc"; the front/section renderers compare against
+      # the exact "RFC", so the document's own RFC seriesInfo (and with it
+      # the "Request for Comments" masthead line) was dropped (#268).
+      # Normalise casing here so every consumer sees "RFC".
       def doctype(isoxml, _out)
         super
-        set(:doctype, "RFC") if get[:doctype].nil?
+        d = get[:doctype]
+        d.nil? || d.casecmp?("rfc") and set(:doctype, "RFC")
       end
 
       def initialize(lang, script, locale, i18n, fonts_options = {})

data/lib/isodoc/ietf/rfc_convert.rb

@@ -1,18 +1,18 @@
-require_relative "./terms"
-require_relative "./blocks"
-require_relative "./lists"
-require_relative "./metadata"
-require_relative "./front"
-require_relative "./table"
-require_relative "./inline"
-require_relative "./reqt"
-require_relative "./cleanup"
-require_relative "./footnotes"
-require_relative "./references"
-require_relative "./section"
-require_relative "./validation"
-require_relative "./xref"
-require_relative "./init"
+require_relative "terms"
+require_relative "blocks"
+require_relative "lists"
+require_relative "metadata"
+require_relative "front"
+require_relative "table"
+require_relative "inline"
+require_relative "reqt"
+require_relative "cleanup"
+require_relative "footnotes"
+require_relative "references"
+require_relative "section"
+require_relative "validation"
+require_relative "xref"
+require_relative "init"
 
 module IsoDoc
   module Ietf
@@ -32,10 +32,11 @@ module IsoDoc
 
       def document_preprocess(docxml)
         @isodoc.reqt_models = Metanorma::Requirements
-          .new({ default: "default", lang: @lang, script: @script,
-                 locale: @locale, labels: @i18n.get })
+          .new({ conv: @isodoc, default: "default", lang: @lang,
+                 script: @script, locale: @locale, labels: @i18n.get })
         populate_id(docxml)
         info docxml, nil
+        @xrefs.reqt_models = @isodoc.reqt_models
         @xrefs.parse docxml
         @isodoc.xrefs = @xrefs
         @isodoc.bibrender = @isodoc.bibrenderer
@@ -88,7 +89,7 @@ module IsoDoc
           "fmt-provision"
           node.elements.each { |n| parse(n, out) }
         else
-          text = node.to_xml.gsub(/</, "&lt;").gsub(/>/, "&gt;")
+          text = node.to_xml.gsub("<", "&lt;").gsub(">", "&gt;")
           out.t { |p| p << text }
         end
       end
@@ -127,8 +128,7 @@ module IsoDoc
         @isodoc.i18n_init("en", "Latn", nil, nil)
       end
 
-      def bibdata(docxml)
-      end
+      def bibdata(docxml); end
 
       include ::IsoDoc::Ietf::Init
     end

data/lib/isodoc/ietf/table.rb

@@ -18,9 +18,13 @@ module IsoDoc
       end
 
       def table_parse_tail(node, out)
-        (key = node.at(ns("./key"))) && parse(key, out)
-        node.xpath(ns("./source")).each { |n| parse(n, out) }
-        node.xpath(ns("./note")).each { |n| parse(n, out) }
+        table_parse_tail_elems.each do |k|
+          node.xpath(ns(k)).each { |n| parse(n, out) }
+        end
+      end
+
+      def table_parse_tail_elems
+        ["./key", "./source", "./note"]
       end
 
       def table_title_parse(node, out)

data/lib/metanorma/ietf/basicdoc.rng

@@ -187,6 +187,15 @@ Applicable to modify and delete</a:documentation>
         <a:documentation>Optional caption of this block</a:documentation>
       </attribute>
     </optional>
+    <optional>
+      <attribute name="position">
+        <a:documentation>For an "add" change, whether the change is added before or after the location</a:documentation>
+        <choice>
+          <value>before</value>
+          <value>after</value>
+        </choice>
+      </attribute>
+    </optional>
     <optional>
       <element name="location">
         <a:documentation>The location(s) in the original document which have undergone the change described in this block</a:documentation>
@@ -1893,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/ietf/biblio.rng

@@ -1142,11 +1142,11 @@ NOTE: This should preferably be encoded as  a URI or short identifier, rather th
         <a:documentation>Information about how long the current description of the bibliographic item is valid for</a:documentation>
       </ref>
     </optional>
-    <optional>
+    <zeroOrMore>
       <ref name="depiction">
         <a:documentation>Depiction of the bibliographic item, typically an image</a:documentation>
       </ref>
-    </optional>
+    </zeroOrMore>
   </define>
   <define name="ReducedBibliographicItem">
     <a:documentation>Reduced description of a bibliographic resource, without mandatory title and docidentifier, used for document relations
@@ -2015,15 +2015,11 @@ provided that it is not the entire bibliographic item that is so related</a:docu
     <a:documentation>A version of the bibliographic item (within an edition). Can be used for drafts</a:documentation>
     <element name="version">
       <optional>
-        <ref name="revision-date">
-          <a:documentation>The date at which the current version of the bibliographic item was produced</a:documentation>
-        </ref>
-      </optional>
-      <optional>
-        <ref name="draft">
-          <a:documentation>The identifier for the current draft of the bibliographic item</a:documentation>
-        </ref>
+        <attribute name="type">
+          <a:documentation>Versioning scheme, in case of multiple versioning schemes</a:documentation>
+        </attribute>
       </optional>
+      <text/>
     </element>
   </define>
   <define name="vedition">
@@ -2063,13 +2059,13 @@ provided that it is not the entire bibliographic item that is so related</a:docu
           <ref name="LocalizedString"/>
         </element>
       </optional>
-      <oneOrMore>
+      <zeroOrMore>
         <element name="taxon">
           <a:documentation>The keywords as a hierarchical taxonomy. For example, the sequence of `taxon` elements
 `pump`, `centrifugal pump`, `line shaft pump` represents a taxonomic classification</a:documentation>
           <ref name="LocalizedString"/>
         </element>
-      </oneOrMore>
+      </zeroOrMore>
       <zeroOrMore>
         <ref name="vocabid">
           <a:documentation>Identifiers for the keyword as a controlled vocabulary</a:documentation>

data/lib/metanorma/ietf/isodoc.rng

@@ -1,6 +1,6 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <grammar xmlns:a="http://relaxng.org/ns/compatibility/annotations/1.0" xmlns="http://relaxng.org/ns/structure/1.0" datatypeLibrary="http://www.w3.org/2001/XMLSchema-datatypes">
-<!-- VERSION v2.1.5 -->
+<!-- VERSION v2.1.6 -->
 
   <!--
     ALERT: cannot have root comments, because of https://github.com/metanorma/metanorma/issues/437
@@ -164,6 +164,9 @@ Sources are currently only rendered in metanorma-plateau</a:documentation>
           </choice>
         </attribute>
       </optional>
+      <optional>
+        <ref name="DisplayDirective"/>
+      </optional>
     </define>
     <define name="DlAttributes">
       <ref name="BlockAttributes"/>
@@ -210,6 +213,12 @@ Sources are currently only rendered in metanorma-plateau</a:documentation>
     <define name="ExampleAttributes">
       <ref name="NumberingAttributes"/>
       <ref name="BlockAttributes"/>
+      <optional>
+        <attribute name="collapsible">
+          <a:documentation>Render the example as collapsible (HTML5 details/summary)</a:documentation>
+          <data type="boolean"/>
+        </attribute>
+      </optional>
     </define>
     <define name="ExampleBody">
       <optional>
@@ -814,6 +823,9 @@ titlecase, or lowercase</a:documentation>
   </define>
   <define name="UlAttributes" combine="interleave">
     <ref name="BlockAttributes"/>
+    <optional>
+      <ref name="DisplayDirective"/>
+    </optional>
   </define>
   <define name="TableAttributes" combine="interleave">
     <optional>
@@ -840,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"/>
@@ -1271,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>
@@ -1968,7 +1984,7 @@ used in document amendments</a:documentation>
           <a:documentation>Zero or more examples of how the term is to be used</a:documentation>
         </ref>
       </zeroOrMore>
-      <ref name="TermSource">
+      <ref name="TermSources">
         <a:documentation>Bibliographic references for the managed term</a:documentation>
       </ref>
     </element>
@@ -2077,7 +2093,7 @@ used in document amendments</a:documentation>
         <a:documentation>Information about how the designation is to be used</a:documentation>
       </ref>
     </optional>
-    <ref name="TermSource">
+    <ref name="TermSources">
       <a:documentation>Bibliographic references for this designation of the managed term</a:documentation>
     </ref>
   </define>
@@ -2348,7 +2364,7 @@ used in document amendments</a:documentation>
           <ref name="formula"/>
         </choice>
       </oneOrMore>
-      <ref name="TermSource">
+      <ref name="TermSources">
         <a:documentation>Bibliographic references for this designation of the managed term</a:documentation>
       </ref>
     </element>
@@ -2365,7 +2381,7 @@ used in document amendments</a:documentation>
           <ref name="formula"/>
         </choice>
       </oneOrMore>
-      <ref name="TermSource">
+      <ref name="TermSources">
         <a:documentation>Bibliographic references for this designation of the managed term</a:documentation>
       </ref>
     </element>
@@ -2756,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>
@@ -2788,6 +2808,37 @@ 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>
+      <attribute name="display">
+        <a:documentation>Display style for block.
+If the block is `ol` or `ul` and dispay is `table`, 
+the list is to be rendered as a table, with a column for each nested level, and a row for each terminal sublist</a:documentation>
+      </attribute>
+    </optional>
+    <optional>
+      <attribute name="display-directives">
+        <a:documentation>display-directives is a key-value set of attributes, guiding how the rendering of the block should happen. 
+The key-value set is comma-delimited, and encoded as `key1='value1',key2='value'`, 
+as with stem//mn/@data-metanorma-numberformat
+*  If the block is `ol` or `ul` and dispay is `table`,  display-directives can have the value `colgroup='col1,col2,...coln'`, 
+where each col value is a percentage width of the column in the output table (with no % suffix). 
+e.g. `colgroup='50,33.3,16.7'`  </a:documentation>
+      </attribute>
+    </optional>
+  </define>
   <define name="ReferencesAttributes">
     <optional>
       <attribute name="obligation">
@@ -2800,7 +2851,7 @@ Normative References contents contain normative references, but as a clause in t
       <data type="boolean"/>
     </attribute>
   </define>
-  <define name="TermSource">
+  <define name="TermSources">
     <zeroOrMore>
       <ref name="termsource"/>
     </zeroOrMore>