metanorma-iso 1.9.1 → 1.9.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8557db1b500f1f756f6f4c755f1adffd884529b0aa77bdce9dc47cdf38288948
-  data.tar.gz: 4d7f35c2b6ab91853e06d225d9ec679b2696e9392b2695d6002ff9c2fdb9fd90
+  metadata.gz: c3710d3b53ba9f99228d2305a92fc2ae20f8aee71f555a06b3273a029df82dc9
+  data.tar.gz: 14d71fa2b1cac17b6097d6601bc05a36096cce50ae6dd0ace99cbee759fe8d47
 SHA512:
-  metadata.gz: 0c40cff218ad2aacbeaf1ca44f315398115c9e9fc13e8fa2a845456328e94b743b0c08ede991ff12204ba4da67ce5cc541369082265c4580b0fd23addec64fa8
-  data.tar.gz: 06f917f6556624e961dfb33f59be02c88440b8a842909d280e1c41bbe3540e783931bd309f6f99af8d7f15caf4af42c1de55634270c471889a239f418ec267f4
+  metadata.gz: 9fd09732d19307285a7f4068b97be6c0bb5ca9a15028f10241c778e56eaf3d2d55093015d16f56c9cde30715d0c8842f345abd1bbeea0a208fd499c98fa303b2
+  data.tar.gz: b7abcda89ee9c7b390fbfef096b5403a1e507d9ed4e70071ccc3679c6cdc9c9c440c68b931634470407b85bc6acf562248713ff81d1ec25fc85d90d7bf8fd653

data/lib/asciidoctor/iso/cleanup.rb

@@ -137,10 +137,9 @@ module Asciidoctor
         xmldoc.xpath("//bibitem/note[@type = 'Unpublished-Status']").each do |n|
           id = n.parent["id"]
           e = xmldoc.at("//eref[@bibitemid = '#{id}']") or next
-          e.next = n.dup
-          e.next.name = "fn"
-          e.next.delete("format")
-          e.next.delete("type")
+          fn = n.children.to_xml
+          n&.elements&.first&.name == "p" or fn = "<p>#{fn}</p>"
+          e.next = "<fn>#{fn}</fn>"
         end
       end
 

data/lib/asciidoctor/iso/front_id.rb

@@ -193,12 +193,17 @@ module Asciidoctor
       end
 
       def get_stage(node)
-        node.attr("status") || node.attr("docstage") || "60"
+        a = node.attr("status")
+        a = node.attr("docstage") if a.nil? || a.empty?
+        a = "60" if a.nil? || a.empty?
+        a
       end
 
       def get_substage(node)
         stage = get_stage(node)
-        node.attr("docsubstage") || (stage == "60" ? "60" : "00")
+        ret = node.attr("docsubstage")
+        ret = (stage == "60" ? "60" : "00") if ret.nil? || ret.empty?
+        ret
       end
 
       def get_typeabbr(node, amd = false)

data/lib/asciidoctor/iso/isodoc.rng

@@ -32,6 +32,18 @@
         <ref name="DocumentType"/>
       </element>
     </define>
+    <define name="section-title">
+      <element name="title">
+        <zeroOrMore>
+          <ref name="TextElement"/>
+        </zeroOrMore>
+      </element>
+      <zeroOrMore>
+        <element name="variant-title">
+          <ref name="TypedTitleString"/>
+        </element>
+      </zeroOrMore>
+    </define>
     <define name="hyperlink">
       <element name="link">
         <attribute name="target">
@@ -158,15 +170,17 @@
             <data type="boolean"/>
           </attribute>
         </optional>
-        <attribute name="type">
-          <choice>
-            <value>roman</value>
-            <value>alphabet</value>
-            <value>arabic</value>
-            <value>roman_upper</value>
-            <value>alphabet_upper</value>
-          </choice>
-        </attribute>
+        <optional>
+          <attribute name="type">
+            <choice>
+              <value>roman</value>
+              <value>alphabet</value>
+              <value>arabic</value>
+              <value>roman_upper</value>
+              <value>alphabet_upper</value>
+            </choice>
+          </attribute>
+        </optional>
         <oneOrMore>
           <ref name="li"/>
         </oneOrMore>
@@ -976,6 +990,16 @@
           <data type="boolean"/>
         </attribute>
       </optional>
+      <optional>
+        <attribute name="linkmention">
+          <data type="boolean"/>
+        </attribute>
+      </optional>
+      <optional>
+        <attribute name="linkref">
+          <data type="boolean"/>
+        </attribute>
+      </optional>
       <optional>
         <element name="refterm">
           <zeroOrMore>
@@ -1012,6 +1036,7 @@
       <ref name="svgmap"/>
       <ref name="inputform"/>
       <ref name="toc"/>
+      <ref name="passthrough"/>
     </choice>
   </define>
   <define name="toc">
@@ -1019,6 +1044,14 @@
       <ref name="ul"/>
     </element>
   </define>
+  <define name="passthrough">
+    <element name="passthrough">
+      <optional>
+        <attribute name="formats"/>
+      </optional>
+      <text/>
+    </element>
+  </define>
   <define name="inputform">
     <element name="form">
       <attribute name="id">
@@ -1686,7 +1719,9 @@
       <zeroOrMore>
         <ref name="termgrammar"/>
       </zeroOrMore>
-      <ref name="definition"/>
+      <oneOrMore>
+        <ref name="termdefinition"/>
+      </oneOrMore>
       <zeroOrMore>
         <ref name="termnote"/>
       </zeroOrMore>
@@ -1749,7 +1784,7 @@
       </oneOrMore>
     </element>
   </define>
-  <define name="definition">
+  <define name="termdefinition">
     <element name="definition">
       <oneOrMore>
         <choice>
@@ -1758,6 +1793,9 @@
           <ref name="formula"/>
         </choice>
       </oneOrMore>
+      <zeroOrMore>
+        <ref name="termsource"/>
+      </zeroOrMore>
     </element>
   </define>
   <define name="termnote">

data/lib/asciidoctor/iso/isostandard.rng

@@ -174,7 +174,7 @@
         <optional>
           <ref name="termdomain"/>
         </optional>
-        <ref name="definition"/>
+        <ref name="termdefinition"/>
         <zeroOrMore>
           <ref name="termnote"/>
         </zeroOrMore>
@@ -184,6 +184,9 @@
         <zeroOrMore>
           <ref name="termsource"/>
         </zeroOrMore>
+        <zeroOrMore>
+          <ref name="term"/>
+        </zeroOrMore>
       </element>
     </define>
     <define name="annex">

data/lib/asciidoctor/iso/reqt.rng

@@ -64,9 +64,9 @@
     <optional>
       <ref name="label"/>
     </optional>
-    <optional>
+    <zeroOrMore>
       <ref name="subject"/>
-    </optional>
+    </zeroOrMore>
     <zeroOrMore>
       <ref name="reqinherit"/>
     </zeroOrMore>
@@ -80,6 +80,7 @@
         <ref name="verification"/>
         <ref name="import"/>
         <ref name="description"/>
+        <ref name="component"/>
       </choice>
     </zeroOrMore>
     <optional>
@@ -105,12 +106,16 @@
   </define>
   <define name="subject">
     <element name="subject">
-      <text/>
+      <oneOrMore>
+        <ref name="TextElement"/>
+      </oneOrMore>
     </element>
   </define>
   <define name="reqinherit">
     <element name="inherit">
-      <text/>
+      <oneOrMore>
+        <ref name="TextElement"/>
+      </oneOrMore>
     </element>
   </define>
   <define name="measurementtarget">
@@ -138,6 +143,12 @@
       <ref name="RequirementSubpart"/>
     </element>
   </define>
+  <define name="component">
+    <element name="component">
+      <attribute name="class"/>
+      <ref name="RequirementSubpart"/>
+    </element>
+  </define>
   <define name="reqt_references">
     <element name="references">
       <oneOrMore>

data/lib/asciidoctor/iso/section.rb

@@ -15,7 +15,7 @@ module Asciidoctor
       end
 
       def appendix_parse(attrs, xml, node)
-        attrs["inline-header".to_sym] = node.option? "inline-header"
+        attrs[:"inline-header"] = node.option? "inline-header"
         set_obligation(attrs, node)
         xml.appendix **attr_code(attrs) do |xml_section|
           xml_section.title { |name| name << node.title }
@@ -38,6 +38,12 @@ module Asciidoctor
 
         super
       end
+
+      def term_def_subclause_parse(attrs, xml, node)
+        node.role == "term" and
+          return term_def_subclause_parse1(attrs, xml, node)
+        super
+      end
     end
   end
 end

data/lib/asciidoctor/iso/validate_section.rb

@@ -32,10 +32,10 @@ module Asciidoctor
       end
 
       ONE_SYMBOLS_WARNING = "Only one Symbols and Abbreviated "\
-        "Terms section in the standard".freeze
+                            "Terms section in the standard".freeze
 
       NON_DL_SYMBOLS_WARNING = "Symbols and Abbreviated Terms can "\
-        "only contain a definition list".freeze
+                               "only contain a definition list".freeze
 
       def symbols_validate(root)
         f = root.xpath("//definitions")
@@ -87,7 +87,7 @@ module Asciidoctor
           },
           {
             msg: "Normative References must be followed by "\
-            "Terms and Definitions",
+                 "Terms and Definitions",
             val: ["./self::terms | .//terms"],
           },
         ].freeze
@@ -127,17 +127,20 @@ module Asciidoctor
         end
         elem&.at("./self::clause") ||
           @log.add("Style", elem, "Document must contain clause after "\
-                   "Terms and Definitions")
+                                  "Terms and Definitions")
         elem&.at("./self::clause[@type = 'scope']") &&
-          @log.add("Style", elem, "Scope must occur before Terms and Definitions")
+          @log.add("Style", elem,
+                   "Scope must occur before Terms and Definitions")
         elem = names.shift
         while elem&.name == "clause"
           elem&.at("./self::clause[@type = 'scope']")
-          @log.add("Style", elem, "Scope must occur before Terms and Definitions")
+          @log.add("Style", elem,
+                   "Scope must occur before Terms and Definitions")
           elem = names.shift
         end
         %w(annex references).include? elem&.name or
-          @log.add("Style", elem, "Only annexes and references can follow clauses")
+          @log.add("Style", elem,
+                   "Only annexes and references can follow clauses")
         [names, elem]
       end
 
@@ -146,7 +149,8 @@ module Asciidoctor
           elem = names.shift
         end
         %w(annex references).include? elem&.name or
-          @log.add("Style", elem, "Only annexes and references can follow terms and clauses")
+          @log.add("Style", elem,
+                   "Only annexes and references can follow terms and clauses")
         [names, elem]
       end
 
@@ -155,25 +159,19 @@ module Asciidoctor
           elem = names.shift
           if elem.nil?
             @log.add("Style", nil, "Document must include (references) "\
-                     "Normative References")
+                                   "Normative References")
           end
         end
         elem&.at("./self::references[@normative = 'true']") ||
           @log.add("Style", nil, "Document must include (references) "\
-                   "Normative References")
+                                 "Normative References")
         elem = names&.shift
         elem&.at("./self::references[@normative = 'false']") ||
-          @log.add("Style", elem, "Final section must be (references) Bibliography")
+          @log.add("Style", elem,
+                   "Final section must be (references) Bibliography")
         names.empty? ||
-          @log.add("Style", elem, "There are sections after the final Bibliography")
-      end
-
-      def style_warning(node, msg, text = nil)
-        return if @novalid
-
-        w = msg
-        w += ": #{text}" if text
-        @log.add("Style", node, w)
+          @log.add("Style", elem,
+                   "There are sections after the final Bibliography")
       end
 
       NORM_ISO_WARN = "non-ISO/IEC reference not expected as normative".freeze

data/lib/asciidoctor/iso/validate_style.rb

@@ -70,18 +70,18 @@ module Asciidoctor
         style(node, extract_text(node))
       end
 
-      def style_regex(re, warning, n, text)
-        (m = re.match(text)) && style_warning(n, warning, m[:num])
+      def style_regex(regex, warning, n, text)
+        (m = regex.match(text)) && style_warning(n, warning, m[:num])
       end
 
       # style check with a regex on a token
       # and a negative match on its preceding token
-      def style_two_regex_not_prev(n, text, re, re_prev, warning)
+      def style_two_regex_not_prev(n, text, regex, re_prev, warning)
         return if text.nil?
 
         arr = Tokenizer::WhitespaceTokenizer.new.tokenize(text)
         arr.each_index do |i|
-          m = re.match arr[i]
+          m = regex.match arr[i]
           m_prev = i.zero? ? nil : re_prev.match(arr[i - 1])
           if !m.nil? && m_prev.nil?
             style_warning(n, warning, m[:num])
@@ -132,22 +132,22 @@ module Asciidoctor
 
       # leaving out as problematic: N J K C S T H h d B o E
       SI_UNIT = "(m|cm|mm|km|μm|nm|g|kg|mgmol|cd|rad|sr|Hz|Hz|MHz|Pa|hPa|kJ|"\
-        "V|kV|W|MW|kW|F|μF|Ω|Wb|°C|lm|lx|Bq|Gy|Sv|kat|l|t|eV|u|Np|Bd|"\
-        "bit|kB|MB|Hart|nat|Sh|var)".freeze
+                "V|kV|W|MW|kW|F|μF|Ω|Wb|°C|lm|lx|Bq|Gy|Sv|kat|l|t|eV|u|Np|Bd|"\
+                "bit|kB|MB|Hart|nat|Sh|var)".freeze
 
       # ISO/IEC DIR 2, 9.3
       def style_units(node, text)
         style_regex(/\b(?<num>[0-9][0-9,]*\s+[\u00b0\u2032\u2033])/,
                     "space between number and degrees/minutes/seconds",
                     node, text)
-        style_regex(/\b(?<num>[0-9][0-9,]*#{SI_UNIT})\b/,
+        style_regex(/\b(?<num>[0-9][0-9,]*#{SI_UNIT})\b/o,
                     "no space between number and SI unit", node, text)
         style_non_std_units(node, text)
       end
 
       NONSTD_UNITS = {
-        "sec": "s", "mins": "min", "hrs": "h", "hr": "h", "cc": "cm^3",
-        "lit": "l", "amp": "A", "amps": "A", "rpm": "r/min"
+        sec: "s", mins: "min", hrs: "h", hr: "h", cc: "cm^3",
+        lit: "l", amp: "A", amps: "A", rpm: "r/min"
       }.freeze
 
       # ISO/IEC DIR 2, 9.3
@@ -157,6 +157,14 @@ module Asciidoctor
                       "non-standard unit (should be #{v})", node, text)
         end
       end
+
+      def style_warning(node, msg, text = nil)
+        return if @novalid
+
+        w = msg
+        w += ": #{text}" if text
+        @log.add("Style", node, w)
+      end
     end
   end
 end

data/lib/isodoc/iso/index.rb

@@ -7,12 +7,13 @@ module IsoDoc
 
       def index(docxml)
         unless docxml.at(ns("//index"))
-          docxml.xpath(ns("//indexsect")).each { |i| i.remove }
+          docxml.xpath(ns("//indexsect")).each(&:remove)
           return
         end
         i = docxml.at(ns("//indexsect")) ||
           docxml.root.add_child("<indexsect #{add_id}><title>#{@i18n.index}</title></indexsect>").first
-        index = sort_indexterms(docxml.xpath(ns("//index")), docxml.xpath(ns("//index-xref[@also = 'false']")),
+        index = sort_indexterms(docxml.xpath(ns("//index")),
+                                docxml.xpath(ns("//index-xref[@also = 'false']")),
                                 docxml.xpath(ns("//index-xref[@also = 'true']")))
         index1(docxml, i, index)
       end
@@ -20,10 +21,12 @@ module IsoDoc
       def index1(docxml, i, index)
         c = i.add_child("<ul></ul>").first
         index.keys.sort.each do |k|
-          #c = i.add_child "<clause #{add_id}><title>#{k}</title><ul></ul></clause>"
-          words = index[k].keys.each_with_object({}) { |w, v| v[sortable(w).downcase] = w }
+          # c = i.add_child "<clause #{add_id}><title>#{k}</title><ul></ul></clause>"
+          words = index[k].keys.each_with_object({}) do |w, v|
+            v[sortable(w).downcase] = w
+          end
           words.keys.localize(@lang.to_sym).sort.to_a.each do |w|
-            #c.first.at(ns("./ul")).add_child index_entries(words, index[k], w)
+            # c.first.at(ns("./ul")).add_child index_entries(words, index[k], w)
             c.add_child index_entries(words, index[k], w)
           end
         end
@@ -31,8 +34,8 @@ module IsoDoc
         @xrefs.bookmark_anchor_names(docxml)
       end
 
-      def sortable(s)
-        HTMLEntities.new.decode(Nokogiri::XML.fragment(s).text)
+      def sortable(str)
+        HTMLEntities.new.decode(Nokogiri::XML.fragment(str).text)
       end
 
       def index_entries_opt
@@ -40,8 +43,12 @@ module IsoDoc
       end
 
       def index_entries(words, index, primary)
-        ret = index_entries_head(words[primary], index.dig(words[primary], nil, nil), index_entries_opt)
-        words2 = index[words[primary]]&.keys&.reject { |k| k.nil?}&.each_with_object({}) { |w, v| v[w.downcase] = w }
+        ret = index_entries_head(words[primary],
+                                 index.dig(words[primary], nil, nil),
+                                 index_entries_opt)
+        words2 = index[words[primary]]&.keys&.reject do |k|
+                   k.nil?
+                 end&.each_with_object({}) { |w, v| v[w.downcase] = w }
         unless words2.empty?
           ret += "<ul>"
           words2.keys.localize(@lang.to_sym).sort.to_a.each do |w|
@@ -53,12 +60,18 @@ module IsoDoc
       end
 
       def index_entries2(words, index, secondary)
-        ret = index_entries_head(words[secondary], index.dig(words[secondary], nil), index_entries_opt)
-        words3 = index[words[secondary]]&.keys&.reject { |k| k.nil?}&.each_with_object({}) { |w, v| v[w.downcase] = w }
+        ret = index_entries_head(words[secondary],
+                                 index.dig(words[secondary], nil),
+                                 index_entries_opt)
+        words3 = index[words[secondary]]&.keys&.reject do |k|
+                   k.nil?
+                 end&.each_with_object({}) { |w, v| v[w.downcase] = w }
         unless words3.empty?
           ret += "<ul>"
           words3.keys.localize(@lang.to_sym).sort.to_a.each do |w|
-            ret += (index_entries_head(words3[w], index[words[secondary]][words3[w]], index_entries_opt) + "</li>")
+            ret += (index_entries_head(words3[w],
+                                       index[words[secondary]][words3[w]],
+                                       index_entries_opt) + "</li>")
           end
           ret += "</ul>"
         end
@@ -68,10 +81,18 @@ module IsoDoc
       def index_entries_head(head, entries, opt)
         ret = "<li>#{head}"
         xref = entries&.dig(:xref)&.join(", ")
-        see_sort = entries&.dig(:see)&.each_with_object({}) { |w, v| v[sortable(w).downcase] = w }
-        see = see_sort&.keys&.localize(@lang.to_sym)&.sort&.to_a&.map { |k| see_sort[k] }&.join(", ")
-        also_sort = entries&.dig(:also)&.each_with_object({}) { |w, v| v[sortable(w).downcase] = w }
-        also = also_sort&.keys&.localize(@lang.to_sym)&.sort&.to_a&.map { |k| also_sort[k] }&.join(", ")
+        see_sort = entries&.dig(:see)&.each_with_object({}) do |w, v|
+          v[sortable(w).downcase] = w
+        end
+        see = see_sort&.keys&.localize(@lang.to_sym)&.sort&.to_a&.map do |k|
+                see_sort[k]
+              end&.join(", ")
+        also_sort = entries&.dig(:also)&.each_with_object({}) do |w, v|
+          v[sortable(w).downcase] = w
+        end
+        also = also_sort&.keys&.localize(@lang.to_sym)&.sort&.to_a&.map do |k|
+                 also_sort[k]
+               end&.join(", ")
         ret += "#{opt[:xref_lbl]} #{xref}" if xref
         ret += "#{opt[:see_lbl]} #{see}" if see
         ret += "#{opt[:also_lbl]} #{also}" if also
@@ -96,8 +117,8 @@ module IsoDoc
         end
       end
 
-      def extract_indexsee(v, terms, label)
-        terms.each_with_object(v) do |t, v|
+      def extract_indexsee(val, terms, label)
+        terms.each_with_object(val) do |t, v|
           term = t&.at(ns("./primary"))&.children&.to_xml
           term2 = t&.at(ns("./secondary"))&.children&.to_xml
           term3 = t&.at(ns("./tertiary"))&.children&.to_xml
@@ -110,8 +131,11 @@ module IsoDoc
         end
       end
 
-      def xml_encode_attr(s)
-        HTMLEntities.new.encode(s, :basic, :hexadecimal).gsub(/\&#x([^;]+);/) { |x| "&#x#{$1.upcase};" }
+      def xml_encode_attr(str)
+        HTMLEntities.new.encode(str, :basic, :hexadecimal)
+          .gsub(/&#x([^;]+);/) do |_x|
+          "&#x#{$1.upcase};"
+        end
       end
 
       # attributes are decoded into UTF-8, elements in extract_indexsee are still in entities
@@ -130,10 +154,10 @@ module IsoDoc
         end
       end
 
-      def index2bookmark(t)
-        t.name = "bookmark"
-        t.children.each { |x| x.remove }
-        t["id"] = "_#{UUIDTools::UUID.random_create}"
+      def index2bookmark(node)
+        node.name = "bookmark"
+        node.children.each(&:remove)
+        node["id"] = "_#{UUIDTools::UUID.random_create}"
       end
     end
   end