metanorma-standoc 2.9.5 → 2.9.7

data/lib/metanorma/standoc/localbib.rb

@@ -23,7 +23,7 @@ module Metanorma
 
       def init_file_bibdb_config(defn, key)
         /=/.match?(defn) or defn = "file=#{defn}"
-        values = defn.split(",").map { |item| item.split /\s*=\s*/ }.to_h
+        values = defn.split(",").map { |item| item.split /(?<!\s)\s*=\s*/ }.to_h
         values["key"] = key
         values["format"] ||= "bibtex" # all we currently suppoort
         values

data/lib/metanorma/standoc/macros.rb

@@ -22,7 +22,7 @@ module Metanorma
       on_context :example, :sourcecode
 
       def init_indent(line)
-        /^(?<prefix>[ \t]*)(?<suffix>.*)$/ =~ line
+        /^(?<prefix>[ \t]*)(?![ \t])(?<suffix>.*)$/ =~ line
         prefix = prefix.gsub("\t", "\u00a0\u00a0\u00a0\u00a0")
           .tr(" ", "\u00a0")
         prefix + suffix

data/lib/metanorma/standoc/macros_inline.rb

@@ -160,28 +160,30 @@ module Metanorma
         str.sub(/^(["'])(.+)\1$/, "\\2")
       end
 
-      def format(attrs)
+      def format(attrs, number)
         # a="," => "a=,"
-        quoted_csv_split(attrs || "", ",").map do |x|
-          m = /^(.+?)=(.+)?$/.match(x) or next
+        out = quoted_csv_split(attrs || "", ",").map do |x|
+          m = /^(.+?)=(.+)?$/.match(HTMLEntities.new.decode(x)) or next
           "#{m[1]}='#{m[2]}'"
-        end.join(",")
+        end
+        /^\+/.match?(number.strip) and out << "number_sign='plus'"
+        out.join(",")
       end
 
       def number(text)
         n = BigDecimal(text)
         trailing_zeroes = 0
         m = /\.[1-9]*(0+)/.match(text) and trailing_zeroes += m[1].size
-        n.to_s("E").sub("e", "0" * trailing_zeroes + "e")
+        n.to_s("E").sub("e", "0" * trailing_zeroes + "e") # rubocop:disable Style/StringConcatenation
       end
 
       def process(parent, target, attrs)
         out = Asciidoctor::Inline.new(parent, :quoted, attrs["text"]).convert
-        fmt = format(out)
-        fmt.empty? and fmt = "notation='basic'"
-        fmt = %( data-metanorma-numberformat="#{fmt}")
+        fmt = format(out, target)
+        fmt.empty? and fmt = "default"
+        fmt = %( number-format="#{fmt}")
         <<~OUTPUT
-          <stem type="MathML"><math xmlns='#{MATHML_NS}'><mn#{fmt}>#{number(target)}</mn></math></stem>
+          <stem type="MathML"#{fmt}><math xmlns='#{MATHML_NS}'><mn>#{number(target)}</mn></math></stem>
         OUTPUT
       end
     end

data/lib/metanorma/standoc/macros_plantuml.rb

@@ -71,7 +71,7 @@ module Metanorma
 
       def self.prep_source(reader)
         src = reader.source
-        reader.lines.first.sub(/\s+$/, "").match /^@startuml($| )/ or
+        reader.lines.first.sub(/(?<!\s)\s+$/, "").match /^@startuml($| )/ or
           src = "@startuml\n#{src}\n@enduml\n"
         %r{@enduml\s*$}m.match?(src) or
           raise "@startuml without matching @enduml in PlantUML!"

data/lib/metanorma/standoc/ref.rb

@@ -5,7 +5,7 @@ module Metanorma
   module Standoc
     module Refs
       def iso_publisher(bib, code)
-        code.sub(/ .*$/, "").split("/").each do |abbrev|
+        code.sub(/(?<! ) .*$/, "").split("/").each do |abbrev|
           bib.contributor do |c|
             c.role type: "publisher"
             c.organization do |org|

data/lib/metanorma/standoc/ref_queue.rb

@@ -228,7 +228,7 @@ module Metanorma
             @iev_globalname = global_ievcache_name
           @iev_localname = local_ievcache_name(node.attr("local-cache") ||
                                                node.attr("local-cache-only"))
-          if node.attr("flush-caches")
+          if @flush_caches
             FileUtils.rm_f @iev_globalname unless @iev_globalname.nil?
             FileUtils.rm_f @iev_localname unless @iev_localname.nil?
           end

data/lib/metanorma/standoc/ref_utility.rb

@@ -20,7 +20,7 @@ module Metanorma
       def norm_year(year)
         /^&\#821[12];$/.match(year) and return "--"
         /^\d\d\d\d-\d\d\d\d$/.match(year) and return year
-        year&.sub(/(?<=[0-9])-.*$/, "")
+        year&.sub(/^([0-9]+)-.*$/, "\\1")
       end
 
       def conditional_date(bib, match, noyr)
@@ -46,7 +46,7 @@ module Metanorma
                         @bibdb&.docid_type(code) || [nil, code]
                       end
         code1.sub!(/^nofetch\((.+)\)$/, "\\1")
-        bib.docidentifier **attr_code(type: type) do |d|
+        bib.docidentifier **attr_code(type:) do |d|
           d << code1
         end
       end
@@ -59,7 +59,7 @@ module Metanorma
       end
 
       def mn_code(code)
-        code.sub(/^\(/, "[").sub(/\).*$/, "]")
+        code.sub(/^\(/, "[").sub(/^([^)]+)\).*$/, "\\1]")
           .sub(/^dropid\((.+)\)$/, "\\1")
           .sub(/^hidden\((.+)\)$/, "\\1")
           .sub(/^nofetch\((.+)\)$/, "\\1")
@@ -67,7 +67,8 @@ module Metanorma
       end
 
       def analyse_ref_localfile(ret)
-        m = /^local-file\((?:(?<source>[^,]+),\s*)?(?<id>.+)\)$/.match(ret[:id])
+        m = /^local-file\((?:(?<source>[^,)]+),\s*)?(?<id>[^)]+)\)$/
+          .match(ret[:id])
         m or return ret
         ret.merge(id: m[:id], localfile: m[:source] || "default")
       end
@@ -88,7 +89,7 @@ module Metanorma
       end
 
       def analyse_ref_repo_path(ret)
-        m = /^(?<type>repo|path|attachment):\((?<key>[^,]+),?(?<id>[^)]*)\)$/
+        m = /^(?<type>repo|path|attachment):\((?<key>[^,)]+),?(?<id>[^)]*)\)$/
           .match(ret[:id]) or return ret
         id = if m[:id].empty?
                if m[:type] == "attachment"
@@ -96,7 +97,7 @@ module Metanorma
                else m[:key].sub(%r{^[^/]+/}, "")
                end
              else m[:id] end
-        ret.merge(id: id, type: m[:type], key: m[:key], nofetch: true)
+        ret.merge(id:, type: m[:type], key: m[:key], nofetch: true)
       end
 
       def analyse_ref_numeric(ret)

data/lib/metanorma/standoc/reqt.rng

@@ -1,20 +1,27 @@
 <?xml version="1.0" encoding="UTF-8"?>
-<grammar xmlns="http://relaxng.org/ns/structure/1.0" datatypeLibrary="http://www.w3.org/2001/XMLSchema-datatypes">
+<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">
   <!--
     Presupposes isodoc.rnc, is included in it
     include "isodoc.rnc" { }
+    
+    This is the Metanorma default provisions model; it is overridden by other provisions models,
+    such as Modspec
   -->
   <define name="requirement">
+    <a:documentation>Specification of an attribute of a subject that is required.
+NOTE: A requirement can contain other requirements</a:documentation>
     <element name="requirement">
       <ref name="RequirementType"/>
     </element>
   </define>
   <define name="recommendation">
+    <a:documentation>Specification of an attribute of a subject that is recommended</a:documentation>
     <element name="recommendation">
       <ref name="RequirementType"/>
     </element>
   </define>
   <define name="permission">
+    <a:documentation>Specification of an attribute of a subject that is permitted</a:documentation>
     <element name="permission">
       <ref name="RequirementType"/>
     </element>
@@ -22,80 +29,101 @@
   <define name="RequirementType">
     <optional>
       <attribute name="obligation">
-        <ref name="ObligationType"/>
-      </attribute>
-    </optional>
-    <optional>
-      <attribute name="unnumbered">
-        <data type="boolean"/>
-      </attribute>
-    </optional>
-    <optional>
-      <attribute name="number"/>
-    </optional>
-    <optional>
-      <attribute name="subsequence"/>
-    </optional>
-    <optional>
-      <attribute name="keep-with-next">
-        <data type="boolean"/>
-      </attribute>
-    </optional>
-    <optional>
-      <attribute name="keep-lines-together">
-        <data type="boolean"/>
+        <a:documentation>An attribute that may be used to override the obligation represented in
+the tag name of the top level containers</a:documentation>
+        <ref name="ReqtObligationType"/>
       </attribute>
     </optional>
     <attribute name="id">
       <data type="ID"/>
     </attribute>
+    <ref name="NumberingAttributes"/>
+    <ref name="BlockAttributes"/>
     <optional>
-      <attribute name="filename"/>
-    </optional>
-    <optional>
-      <attribute name="model"/>
+      <attribute name="filename">
+        <a:documentation>File name of the requirement model when exported</a:documentation>
+      </attribute>
     </optional>
     <optional>
-      <attribute name="type"/>
+      <attribute name="model">
+        <a:documentation>Model of requirements realised by this requirement, e.g. "ogc" for Modspec</a:documentation>
+      </attribute>
     </optional>
     <optional>
-      <attribute name="tag"/>
+      <attribute name="type">
+        <a:documentation>Type of requirement; does not override labelling, unlike `class`</a:documentation>
+      </attribute>
     </optional>
     <optional>
-      <attribute name="multilingual-rendering">
-        <ref name="MultilingualRenderingType"/>
+      <attribute name="class">
+        <a:documentation>Class of provision, used to sequence and label that class separately.
+By default, provisions are sequenced and labelled as requirements, recommendations, or
+permissions, by obligation; the class overrides that</a:documentation>
       </attribute>
     </optional>
     <optional>
-      <ref name="reqtitle"/>
+      <ref name="reqtitle">
+        <a:documentation>Human-readable title of the requirement</a:documentation>
+      </ref>
     </optional>
     <optional>
-      <ref name="label"/>
+      <ref name="reqtlabel">
+        <a:documentation>Formal identifier with which the requirement is referenced</a:documentation>
+      </ref>
     </optional>
     <zeroOrMore>
-      <ref name="subject"/>
+      <ref name="subject">
+        <a:documentation>The party subject to the obligation stated in the requirement</a:documentation>
+      </ref>
     </zeroOrMore>
     <zeroOrMore>
-      <ref name="reqinherit"/>
+      <ref name="reqinherit">
+        <a:documentation>Reference to the identifier of another requirement, of which this requirement
+is a subclass, and from which it inherits attributes</a:documentation>
+      </ref>
     </zeroOrMore>
     <zeroOrMore>
-      <ref name="classification"/>
+      <ref name="classification">
+        <a:documentation>Key/Value pairs of metadata used to describe the requirement.
+A key can be associated with multiple values</a:documentation>
+      </ref>
     </zeroOrMore>
     <zeroOrMore>
       <choice>
-        <ref name="measurementtarget"/>
-        <ref name="specification"/>
-        <ref name="verification"/>
-        <ref name="import"/>
-        <ref name="description"/>
-        <ref name="component"/>
+        <ref name="measurementtarget">
+          <a:documentation>Quantitative statement of metrics that the requirement realises</a:documentation>
+        </ref>
+        <ref name="specification">
+          <a:documentation>Formal specification of the requirement. Expected to be machine-readable</a:documentation>
+        </ref>
+        <ref name="verification">
+          <a:documentation>Processes or code used to verify that the requirement is being complied
+with. Can be a test (including test code), or a compliance statement</a:documentation>
+        </ref>
+        <ref name="import">
+          <a:documentation>A reference to source code or a statement of prerequisites which is defined elsewhere</a:documentation>
+        </ref>
+        <ref name="description">
+          <a:documentation>Descriptive statement of the content of the requirement. Is expected to
+be human-readable, and to contain formatting markup following Metanorma
+conventions. Is expected to be discursive, and be resumed after
+interruption by other sub-containers</a:documentation>
+        </ref>
+        <ref name="component">
+          <a:documentation>Provisions nested within this provision, which cannot be referenced autonomously and have
+subclasses specific to the parent provision. Not expressed with provision metadata</a:documentation>
+        </ref>
       </choice>
     </zeroOrMore>
     <optional>
-      <ref name="reqt_references"/>
+      <ref name="reqt_references">
+        <a:documentation>A list of references for the requirement, following the Relaton model</a:documentation>
+      </ref>
     </optional>
     <zeroOrMore>
       <choice>
+        <a:documentation>Provisions nested within this provision, which are self-standing and do not have
+subclasses specific to the parent provision</a:documentation>
         <ref name="requirement"/>
         <ref name="recommendation"/>
         <ref name="permission"/>
@@ -104,10 +132,10 @@
   </define>
   <define name="reqtitle">
     <element name="title">
-      <ref name="FormattedString"/>
+      <ref name="LocalizedMarkedUpString"/>
     </element>
   </define>
-  <define name="label">
+  <define name="reqtlabel">
     <element name="identifier">
       <oneOrMore>
         <ref name="TextElement"/>
@@ -155,7 +183,9 @@
   </define>
   <define name="component">
     <element name="component">
-      <attribute name="class"/>
+      <attribute name="class">
+        <a:documentation>Class of component</a:documentation>
+      </attribute>
       <ref name="RequirementSubpart"/>
     </element>
   </define>
@@ -167,44 +197,36 @@
     </element>
   </define>
   <define name="RequirementSubpart">
-    <optional>
-      <attribute name="type"/>
-    </optional>
-    <optional>
-      <attribute name="exclude">
-        <data type="boolean"/>
+    <a:documentation>A subcontainer can be either machine-readable or human-readable, or a
+mixture of the two.
+A machine-readable component can be included as source code with
+nomination of the language</a:documentation>
+    <optional>
+      <attribute name="type">
+        <a:documentation>Type of sub-container.
+For example a `verification[@type = "unit-test"]` contains a unit test of a single
+feature, and is to be treated differently from
+`verification[@type = "comprehensive"]`, which represents a comprehensive test suite</a:documentation>
       </attribute>
     </optional>
     <optional>
-      <attribute name="keep-with-next">
-        <data type="boolean"/>
-      </attribute>
-    </optional>
-    <optional>
-      <attribute name="keep-lines-together">
+      <attribute name="exclude">
+        <a:documentation>Indicates that the current sub-container is only intended to be
+machine-readable, and is not to be rendered as document output</a:documentation>
         <data type="boolean"/>
       </attribute>
     </optional>
-    <optional>
-      <attribute name="tag"/>
-    </optional>
-    <optional>
-      <attribute name="multilingual-rendering">
-        <ref name="MultilingualRenderingType"/>
-      </attribute>
-    </optional>
+    <ref name="BlockAttributes"/>
     <oneOrMore>
       <choice>
+        <a:documentation>Content of subpart: blocks, rather than provisions</a:documentation>
         <ref name="BasicBlock"/>
         <ref name="component"/>
       </choice>
     </oneOrMore>
   </define>
-  <define name="ObligationType">
-    <choice>
-      <value>requirement</value>
-      <value>recommendation</value>
-      <value>permission</value>
-    </choice>
+  <define name="ReqtObligationType">
+    <a:documentation>Values are "requirement", "recommendation", "permission"; multiple values can be comma-delimited</a:documentation>
+    <text/>
   </define>
 </grammar>

data/lib/metanorma/standoc/section.rb

@@ -14,8 +14,8 @@ module Metanorma
         node.attr("heading")&.downcase ||
           node.title
             .gsub(%r{<index>.*?</index>}m, "")
-            .gsub(%r{<fn[^>]*>.*?</fn>}m, "")
-            .gsub(/<[^>]+>/, "")
+            .gsub(%r{<fn[^<>]*>.*?</fn>}m, "")
+            .gsub(/<[^<>]+>/, "")
             .strip.downcase.sub(/\.$/, "")
       end
 

data/lib/metanorma/standoc/term_lookup_cleanup.rb

@@ -4,7 +4,7 @@ module Metanorma
   module Standoc
     # Intelligent term lookup xml modifier
     class TermLookupCleanup
-      AUTO_GEN_ID_REGEXP = /\A_/.freeze
+      AUTO_GEN_ID_REGEXP = /\A_/
 
       attr_reader :xmldoc, :lookup, :log
 
@@ -130,7 +130,7 @@ module Metanorma
       end
 
       def remove_missing_ref_msg1(_node, target, ret)
-        target2 = "_#{target.downcase.gsub('-', '_')}"
+        target2 = "_#{target.downcase.tr('-', '_')}"
         if @terms_tags[target] || @terms_tags[target2]
           ret.strip!
           ret += ". Did you mean to point to a subterm?"

data/lib/metanorma/standoc/utils.rb

@@ -37,7 +37,8 @@ module Metanorma
                                    %("\\1#{eql}\\3"))
         Metanorma::Utils::csv_split(text, delim)
           .map do |x|
-            c.encode(x.sub(/^(["'])(.+)\1$/, "\\2"), :basic, :hexadecimal)
+            c.encode(x.sub(/^(["'])(.+)\1$/, "\\2"),
+                     :basic, :hexadecimal)
           end
       end
 
@@ -100,8 +101,9 @@ module Metanorma
       # wrapped in <sections>
       def adoc2xml(text, flavour)
         Nokogiri::XML(text).root and return text
+        f = @flush_caches ? ":flush-caches:\n" : ""
         c = Asciidoctor.convert("= X\nA\n:semantic-metadata-headless: true\n" \
-                                ":novalid:\n\n#{text}\n",
+                                ":no-isobib:\n#{f}:novalid:\n\n#{text}\n",
                                 backend: flavour, header_footer: true)
         Nokogiri::XML(c).at("//xmlns:sections")
       end

data/lib/metanorma/standoc/version.rb

@@ -19,6 +19,6 @@ module Metanorma
   end
 
   module Standoc
-    VERSION = "2.9.5".freeze
+    VERSION = "2.9.7".freeze
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: metanorma-standoc
 version: !ruby/object:Gem::Version
-  version: 2.9.5
+  version: 2.9.7
 platform: ruby
 authors:
 - Ribose Inc.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-08-19 00:00:00.000000000 Z
+date: 2024-09-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable
@@ -528,6 +528,7 @@ files:
 - lib/metanorma/standoc/cleanup_image.rb
 - lib/metanorma/standoc/cleanup_inline.rb
 - lib/metanorma/standoc/cleanup_maths.rb
+- lib/metanorma/standoc/cleanup_mathvariant.rb
 - lib/metanorma/standoc/cleanup_ref.rb
 - lib/metanorma/standoc/cleanup_reqt.rb
 - lib/metanorma/standoc/cleanup_section.rb
@@ -535,6 +536,7 @@ files:
 - lib/metanorma/standoc/cleanup_symbols.rb
 - lib/metanorma/standoc/cleanup_table.rb
 - lib/metanorma/standoc/cleanup_terms.rb
+- lib/metanorma/standoc/cleanup_terms_boilerplate.rb
 - lib/metanorma/standoc/cleanup_terms_designations.rb
 - lib/metanorma/standoc/cleanup_text.rb
 - lib/metanorma/standoc/cleanup_toc.rb