metanorma-standoc 3.4.6 → 3.4.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e4f541051cf5c4f2d8d09fa2abd0557875da3503bf5475ca4cf6f346d91afe5d
-  data.tar.gz: 9d14d6673be1b03aa241d2dfa2c57cf5c8c5fb2e345959b49aea7a713af0b3a4
+  metadata.gz: 8cbc11c6b0e55ec1404d12dd309d0f711c1d4918d079375716d0b0406f6bce2f
+  data.tar.gz: 016b74cca05a97b06809a7e9af8d48b97b07c39e3d98fe0bd575da362f1bed57
 SHA512:
-  metadata.gz: a2789df5307bf398f4ee3f0c87d1ff4295f4964e036d0dfea922362ff6c390a0fb714b623ca58445d9f7cf1ba73edc5b4936555ffe2a1c211af6cbf773ee98b9
-  data.tar.gz: db9d8f35807bd2dcb2ba96ff93cc6ae2b3434d0d8585a0536f6a4c78c98232c1c7daaad9ed423d21f2f110e80fc300bc54f8e109897a9ad36ad904ce2619de13
+  metadata.gz: 7510bd34addc7e4e2f6d123aa19c89dffe555f1a2f06ff572824136b2269e073721bc7ac8df2f4a94ed09180bd724dbcdb2d5f6d29dc076c71650fe6d5f3c597
+  data.tar.gz: d575b92f788e95d9754b9d0d2cf6af1f670d82d2f3710d82b165a6e453f8d8ec884fc407926bbf1f86594c61f2992ee3728e9fc3455e0eeb459a2dd4b1f5bcb1

data/.rubocop.yml

@@ -3,8 +3,20 @@
 inherit_from:
   - https://raw.githubusercontent.com/riboseinc/oss-guides/main/ci/rubocop.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/lib/metanorma/cleanup/block.rb

@@ -166,13 +166,22 @@ module Metanorma
         align_callouts_to_annotations(xmldoc)
       end
 
+      # State threaded through {{{ ... }}} sourcecode-markup processing.
+      # open: inside a span; inline: that span opened in the current text node
+      # (so its content is convertible, not merely delimiter-stripped);
+      # buf: the open span's content so far; out: the rebuilt node content.
+      SourcecodeMarkup = Struct.new(:open, :inline, :buf, :out, :node)
+
+      # {{{ ... }}} injects Asciidoc markup into otherwise-verbatim sourcecode.
+      # A span's delimiters can be split across separate text nodes by an
+      # element that subs="macros" injected between them (e.g. an inline
+      # image), so we walk the sourcecode's text nodes in order and carry the
+      # open state across them, rather than processing each node in isolation.
       def sourcecode_cleanup(xmldoc)
         xmldoc.xpath("//sourcecode").each do |x|
-          x.traverse do |n|
-            n.text? or next
-            /#{Regexp.escape(@sourcecode_markup_start)}/.match?(n.text) or next
-            n.replace(sourcecode_markup(n))
-          end
+          open = x.xpath(".//text()")
+            .inject(false) { |acc, node| sourcecode_markup(node, acc) }
+          open and @log.add("STANDOC_65", x, params: [@sourcecode_markup_start])
         end
       end
 
@@ -183,32 +192,78 @@ module Metanorma
         )
       end
 
-      def sourcecode_markup(node)
-        source_markup_prep(node).each_slice(4).map.with_object([]) do |a, acc|
-          acc << safe_noko(a[0], node.document)
-          a.size == 4 or next
-          acc << @conv.isolated_asciidoctor_convert(
-            "{blank} #{a[2]}", doctype: :inline,
-                               backend: @conv.backend&.to_sym || :standoc
-          ).strip
-        end.join
+      # @return [Boolean] whether a {{{ span is still open after this node
+      def sourcecode_markup(node, open)
+        open || sourcecode_markup?(node.text) or return open
+        state = SourcecodeMarkup.new(open, false, [], [], node)
+        sourcecode_markup_split(node.text)
+          .each { |tok| sourcecode_markup_token(tok, state) }
+        sourcecode_markup_flush(state)
+        state.open
       end
 
-      def source_markup_prep(node)
-        ret = node.text.split(/(#{Regexp.escape(@sourcecode_markup_start)}|
-                          #{Regexp.escape(@sourcecode_markup_end)})/x)
-        source_markup_validate(node, ret)
-        ret
+      def sourcecode_markup_flush(state)
+        state.open and
+          state.out << safe_noko(state.buf.join, state.node.document)
+        state.node.replace(state.out.join)
       end
 
-      def source_markup_validate(node, ret)
-        ret.each_slice(4) do |a|
-          a.size == 4 or next
-          a[1] == @sourcecode_markup_start && a[3] == @sourcecode_markup_end or
-            @log.add("STANDOC_61", node, params: [a.join])
+      def sourcecode_markup?(text)
+        text.include?(@sourcecode_markup_start) ||
+          text.include?(@sourcecode_markup_end)
+      end
+
+      def sourcecode_markup_split(text)
+        text.split(/(#{Regexp.escape(@sourcecode_markup_start)}|
+                     #{Regexp.escape(@sourcecode_markup_end)})/x)
+      end
+
+      def sourcecode_markup_token(tok, state)
+        case tok
+        when @sourcecode_markup_start then sourcecode_markup_open(state)
+        when @sourcecode_markup_end then sourcecode_markup_close(state)
+        else sourcecode_markup_content(tok, state)
         end
       end
 
+      # a nested {{{ is improper nesting: STANDOC_61 is fatal
+      def sourcecode_markup_open(state)
+        state.open and
+          return @log.add("STANDOC_61", state.node, params: [state.node.text])
+        state.open = state.inline = true
+      end
+
+      def sourcecode_markup_close(state)
+        state.open or return sourcecode_markup_stray(state)
+        state.out << sourcecode_markup_closed(state)
+        state.open = state.inline = false
+        state.buf = []
+      end
+
+      # a stray }}} with no opener is left as literal text
+      def sourcecode_markup_stray(state)
+        state.out << safe_noko(@sourcecode_markup_end, state.node.document)
+      end
+
+      # a span closed within one node is converted; one split across nodes
+      # (already holding a processed element) is delimiter-stripped only
+      def sourcecode_markup_closed(state)
+        state.inline and return sourcecode_markup_convert(state.buf.join)
+        safe_noko(state.buf.join, state.node.document)
+      end
+
+      def sourcecode_markup_content(tok, state)
+        state.open and return state.buf << tok
+        state.out << safe_noko(tok, state.node.document)
+      end
+
+      def sourcecode_markup_convert(span)
+        @conv.isolated_asciidoctor_convert(
+          "{blank} #{span}", doctype: :inline,
+                             backend: @conv.backend&.to_sym || :standoc
+        ).strip
+      end
+
       def form_cleanup(xmldoc)
         xmldoc.xpath("//select").each do |s|
           while s.next_element&.name == "option"

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
@@ -49,7 +50,9 @@ module Metanorma
       end
 
       def example_attrs(node)
-        attr_code(id_unnum_attrs(node).merge(keep_attrs(node)))
+        attr_code(id_unnum_attrs(node).merge(keep_attrs(node))
+          .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

data/lib/metanorma/converter/front_title.rb

@@ -54,7 +54,9 @@ module Metanorma
         part, subpart = node.attr("partnumber")&.split("-")
         { part:, subpart:, amendment: node.attr("amendment-number"),
           corrigendum: node.attr("corrigendum-number"),
-          addendum: node.attr("addendum-number") }
+          addendum: node.attr("addendum-number"),
+          supplement: node.attr("supplement-number"),
+          extract: node.attr("extract-number") }
       end
 
       def title_num_prefix(key, value, xml, lang)

data/lib/metanorma/converter/init.rb

@@ -128,6 +128,7 @@ module Metanorma
         @tocfigures = node.attr("toc-figures")
         @toctables = node.attr("toc-tables")
         @tocrecommendations = node.attr("toc-recommendations")
+        @tocexamples = node.attr("toc-examples")
       end
 
       def toc_default
@@ -196,6 +197,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

data/lib/metanorma/converter/log.rb

@@ -198,6 +198,9 @@ module Metanorma
         STANDOC_64: { category: "AsciiDoc Input",
                       error: "Empty index term: %s.",
                       severity: 0 },
+        STANDOC_65: { category: "AsciiDoc Input",
+                      error: "Unbalanced sourcecode markup: unclosed %s",
+                      severity: 0 },
         RELATON_1: { category: "Relaton",
                      error: "(Error from Relaton) %s",
                      severity: 0 },

data/lib/metanorma/converter/ref_queue.rb

@@ -221,6 +221,8 @@ module Metanorma
         global = !@no_isobib_cache && !node.attr("local-cache-only")
         local = node.attr("local-cache") || node.attr("local-cache-only")
         local = nil if @no_isobib_cache
+        flush_bib_caches_force(node) if node.attr("flush-caches") &&
+          @no_isobib_cache
         @bibdb = Relaton::Db.init_bib_caches(
           local_cache: local,
           flush_caches: node.attr("flush-caches"),
@@ -228,6 +230,23 @@ module Metanorma
         )
       end
 
+      # `:flush-caches:` must clear stale cache state regardless of whether
+      # `:no-isobib-cache:` disables caching for *this* compile. When both
+      # are set, the `Relaton::Db.init_bib_caches` path no-ops on the flush
+      # (because it has no cache paths to flush), leaving any previously
+      # cached entries on disk for the next compile that DOES have caching
+      # enabled to pick up. Force-flush the conventional cache locations
+      # here so the flag does what its name says.
+      # Source issue: https://github.com/relaton/relaton-iso/issues/181
+      def flush_bib_caches_force(node)
+        FileUtils.rm_rf "#{Dir.home}/.relaton/cache"
+        lcache_name = node.attr("local-cache") || node.attr("local-cache-only")
+        if lcache_name
+          base = lcache_name.to_s.empty? ? "relaton" : lcache_name
+          FileUtils.rm_rf "#{base}/cache"
+        end
+      end
+
       # Treat empty strings as falsy (they're set by Asciidoctor for some attributes)
       def init_iev_caches(node)
         no_cache = @no_isobib_cache && !@no_isobib_cache.empty?

data/lib/metanorma/converter/render.rb

@@ -41,6 +41,7 @@ module Metanorma
           tocfigures: @tocfigures,
           toctables: @toctables,
           tocrecommendations: @tocrecommendations,
+          tocexamples: @tocexamples,
           fonts: flex_attr_name(node, "fonts"),
           fontlicenseagreement: flex_attr_name(node, "font-license-agreement"),
           localizenumber: flex_attr_name(node, "localize-number"),
@@ -92,6 +93,7 @@ module Metanorma
           tocfigures: @tocfigures,
           toctables: @toctables,
           tocrecommendations: @tocrecommendations,
+          tocexamples: @tocexamples,
           fonts: flex_attr_name(node, "fonts"),
           fontlicenseagreement: flex_attr_name(node, "font-license-agreement"),
         }

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.6".freeze
+    VERSION = "3.4.8".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 3.0 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

@@ -213,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>
@@ -846,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"/>
@@ -1277,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>
@@ -2762,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>
@@ -2794,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>