metanorma-iso 1.8.4 → 1.9.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 40c9fc0bf08ed5cca2885426c54c0b1970511fbdd14a7e982197bb57f95fc55b
-  data.tar.gz: 4695506d2644d2b01090cd4bfa7cd123672dd99de111a6c09f50fea1c84ed3c3
+  metadata.gz: 4ad1b23ba99cb087c9e257a7bb0bd4d0245bfdc2a2d00c881cc700db7e5c8c42
+  data.tar.gz: bc6b4e4d61c32fe3b01cb64a8d0cefc33410814dfa740e140e74a1b2ad4f686f
 SHA512:
-  metadata.gz: 5b8317d64f94cee315afeb98045ff026c0b5df38ea7c141c4fa1d839d758dce919382ff5ae72c76893d296b74d69bae965a50096b7fdfb159b0085c122783a19
-  data.tar.gz: 2f6a2bdb6e5b33adbe3970838f4d4c2ca0f97fe8b40cbe66b828e5fec18fc5cd7932cc42a2880c0765d5b6621a26502d3ae0fa38533488e0cfebb2a1e96917ea
+  metadata.gz: 84dc22c62dc17b3d93b1ec601de1b6662762be8963b830ebe305171d1955e3c0cab44e459ad65600752d8de2d97d6caa003e88daed3e6175527fd8feb4f5ea6a
+  data.tar.gz: 7ee4889948da20e6db0a534396dd4946cf890b87c67e1cec8a7c2a0eaa4cf85d0d72443fe2535e8b93223c2a66dcadaf42402a8ad786f90bcded7cc9d2a7a1dc

data/.github/workflows/rake.yml

@@ -16,7 +16,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        ruby: [ '3.0', '2.7', '2.6', '2.5', '2.4' ]
+        ruby: [ '3.0', '2.7', '2.6', '2.5' ]
         os: [ ubuntu-latest, windows-latest, macos-latest ]
         experimental: [ false ]
     steps:

data/.rubocop.yml

@@ -7,4 +7,4 @@ inherit_from:
 # ...
 
 AllCops:
-  TargetRubyVersion: 2.4
+  TargetRubyVersion: 2.5

data/lib/asciidoctor/iso/cleanup.rb

@@ -3,7 +3,6 @@ require "nokogiri"
 require "htmlentities"
 require "json"
 require "pathname"
-require "open-uri"
 
 module Asciidoctor
   module ISO

data/lib/asciidoctor/iso/isodoc.rng

@@ -204,6 +204,18 @@
         </zeroOrMore>
       </element>
     </define>
+    <define name="dt">
+      <element name="dt">
+        <optional>
+          <attribute name="id">
+            <data type="ID"/>
+          </attribute>
+        </optional>
+        <zeroOrMore>
+          <ref name="TextElement"/>
+        </zeroOrMore>
+      </element>
+    </define>
     <define name="example">
       <element name="example">
         <attribute name="id">
@@ -899,7 +911,7 @@
   </include>
   <!-- end overrides -->
   <define name="docsubtype">
-    <element name="docsubtype">
+    <element name="subdoctype">
       <ref name="DocumentSubtype"/>
     </element>
   </define>
@@ -955,7 +967,34 @@
   <define name="concept">
     <element name="concept">
       <optional>
-        <attribute name="term"/>
+        <attribute name="ital">
+          <data type="boolean"/>
+        </attribute>
+      </optional>
+      <optional>
+        <attribute name="ref">
+          <data type="boolean"/>
+        </attribute>
+      </optional>
+      <optional>
+        <element name="refterm">
+          <zeroOrMore>
+            <choice>
+              <ref name="PureTextElement"/>
+              <ref name="stem"/>
+            </choice>
+          </zeroOrMore>
+        </element>
+      </optional>
+      <optional>
+        <element name="renderterm">
+          <zeroOrMore>
+            <choice>
+              <ref name="PureTextElement"/>
+              <ref name="stem"/>
+            </choice>
+          </zeroOrMore>
+        </element>
       </optional>
       <choice>
         <ref name="eref"/>
@@ -981,6 +1020,9 @@
       </attribute>
       <attribute name="name"/>
       <attribute name="action"/>
+      <optional>
+        <attribute name="class"/>
+      </optional>
       <zeroOrMore>
         <choice>
           <ref name="TextElement"/>
@@ -1473,26 +1515,26 @@
     <optional>
       <ref name="section-title"/>
     </optional>
-    <group>
+    <choice>
       <choice>
         <group>
-          <zeroOrMore>
+          <oneOrMore>
             <ref name="BasicBlock"/>
-          </zeroOrMore>
+          </oneOrMore>
           <zeroOrMore>
             <ref name="note"/>
           </zeroOrMore>
         </group>
         <ref name="amend"/>
       </choice>
-      <zeroOrMore>
+      <oneOrMore>
         <choice>
           <ref name="clause-subsection"/>
           <ref name="terms"/>
           <ref name="definitions"/>
         </choice>
-      </zeroOrMore>
-    </group>
+      </oneOrMore>
+    </choice>
   </define>
   <define name="Annex-Section">
     <optional>

data/lib/asciidoctor/iso/isostandard.rng

@@ -101,7 +101,11 @@
           <ref name="definitions"/>
         </optional>
         <oneOrMore>
-          <ref name="clause"/>
+          <choice>
+            <ref name="clause"/>
+            <ref name="term-clause"/>
+            <ref name="terms"/>
+          </choice>
         </oneOrMore>
       </element>
     </define>
@@ -136,7 +140,7 @@
       <optional>
         <ref name="section-title"/>
       </optional>
-      <group>
+      <choice>
         <choice>
           <group>
             <oneOrMore>
@@ -151,7 +155,7 @@
         <oneOrMore>
           <ref name="clause-subsection"/>
         </oneOrMore>
-      </group>
+      </choice>
     </define>
     <define name="term">
       <element name="term">

data/lib/asciidoctor/iso/section.rb

@@ -33,6 +33,9 @@ module Asciidoctor
       def sectiontype(node, level = true)
         return nil if @amd
 
+        ret = sectiontype_streamline(sectiontype1(node))
+        return ret if ret == "terms and definitions" && @vocab
+
         super
       end
     end

data/lib/asciidoctor/iso/validate.rb

@@ -32,7 +32,7 @@ module Asciidoctor
         root.xpath("//xref").each do |t|
           preceding = t.at("./preceding-sibling::text()[last()]")
           next unless !preceding.nil? &&
-            /\b(see| refer to)\s*$/mi.match(preceding)
+            /\b(see| refer to)\s*\Z/mi.match(preceding)
 
           (target = root.at("//*[@id = '#{t['target']}']")) || next
           if target&.at("./ancestor-or-self::*[@obligation = 'normative']")
@@ -46,7 +46,7 @@ module Asciidoctor
       def see_erefs_validate(root)
         root.xpath("//eref").each do |t|
           prec = t.at("./preceding-sibling::text()[last()]")
-          next unless !prec.nil? && /\b(see|refer to)\s*$/mi.match(prec)
+          next unless !prec.nil? && /\b(see|refer to)\s*\Z/mi.match(prec)
 
           unless target = root.at("//*[@id = '#{t['bibitemid']}']")
             @log.add("Bibliography", t,
@@ -80,23 +80,11 @@ module Asciidoctor
         xmldoc.xpath("//term").each do |t|
           para = t.at("./definition") || return
           term = t.at("./preferred").text
-          termdef_warn(para.text, /^(the|a)\b/i, t, term,
+          termdef_warn(para.text, /\A(the|a)\b/i, t, term,
                        "term definition starts with article")
-          termdef_warn(para.text, /\.$/i, t, term,
+          termdef_warn(para.text, /\.\Z/i, t, term,
                        "term definition ends with period")
         end
-        cited_term_style(xmldoc)
-      end
-
-      # ISO/IEC DIR 2, 16.5.10
-      def cited_term_style(xmldoc)
-        xmldoc.xpath("//term//xref").each do |x|
-          next unless xmldoc.at("//term[@id = '#{x['target']}']")
-
-          x&.previous&.text == " (" and x&.previous&.previous&.name == "em" or
-            style_warning(x, "term citation not preceded with italicised term",
-                          x.parent.text)
-        end
       end
 
       def doctype_validate(xmldoc)
@@ -150,7 +138,6 @@ module Asciidoctor
         isosubgroup_validate(doc.root)
         onlychild_clause_validate(doc.root)
         termdef_style(doc.root)
-        iev_validate(doc.root)
         see_xrefs_validate(doc.root)
         see_erefs_validate(doc.root)
         locality_erefs_validate(doc.root)

data/lib/asciidoctor/iso/validate_section.rb

@@ -42,7 +42,7 @@ module Asciidoctor
         f.empty? && return
         (f.size == 1) || @log.add("Style", f.first, ONE_SYMBOLS_WARNING)
         f.first.elements.each do |e|
-          unless e.name == "dl"
+          unless %w(title dl).include? e.name
             @log.add("Style", f.first, NON_DL_SYMBOLS_WARNING)
             return
           end
@@ -99,57 +99,73 @@ module Asciidoctor
         "//clause[descendant::references][not(parent::clause)]".freeze
 
       def sections_sequence_validate(root)
-        vocab = root&.at("//bibdata/ext/subdoctype")&.text == "vocabulary"
+        names, n = sections_sequence_validate_start(root)
+        if root&.at("//bibdata/ext/subdoctype")&.text == "vocabulary"
+          names, n = sections_sequence_validate_body_vocab(names, n)
+        else
+          names, n = sections_sequence_validate_body(names, n)
+        end
+        sections_sequence_validate_end(names, n)
+      end
+
+      def sections_sequence_validate_start(root)
         names = root.xpath(SECTIONS_XPATH)
         names = seqcheck(names, SEQ[0][:msg], SEQ[0][:val])
         n = names[0]
         names = seqcheck(names, SEQ[1][:msg], SEQ[1][:val])
-        if n&.at("./self::introduction")
+        n&.at("./self::introduction") and
           names = seqcheck(names, SEQ[2][:msg], SEQ[2][:val])
-        end
         names = seqcheck(names, SEQ[3][:msg], SEQ[3][:val])
         n = names.shift
-        if n&.at("./self::definitions")
-          n = names.shift
-        end
-        if n.nil? || n.name != "clause"
-          @log.add("Style", n, "Document must contain at least one clause")
+        n = names.shift if n&.at("./self::definitions")
+        [names, n]
+      end
+
+      def sections_sequence_validate_body(names, elem)
+        if elem.nil? || elem.name != "clause"
+          @log.add("Style", elem, "Document must contain at least one clause")
         end
-        n&.at("./self::clause") ||
-          @log.add("Style", n, "Document must contain clause after "\
+        elem&.at("./self::clause") ||
+          @log.add("Style", elem, "Document must contain clause after "\
                    "Terms and Definitions")
-        n&.at("./self::clause[@type = 'scope']") &&
-          @log.add("Style", n, "Scope must occur before Terms and Definitions")
-        n = names.shift
-        while n&.name == "clause" || (vocab && n&.name == "terms")
-          n&.at("./self::clause[@type = 'scope']")
-          @log.add("Style", n, "Scope must occur before Terms and Definitions")
-          n = names.shift
+        elem&.at("./self::clause[@type = 'scope']") &&
+          @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")
+          elem = names.shift
         end
-        if vocab
-          unless %w(annex references terms).include? n&.name
-            @log.add("Style", n, "Only terms, annexes and references can follow clauses")
-          end
-        else
-          unless %w(annex references).include? n&.name
-            @log.add("Style", n, "Only annexes and references can follow clauses")
-          end
+        %w(annex references).include? elem&.name or
+          @log.add("Style", elem, "Only annexes and references can follow clauses")
+        [names, elem]
+      end
+
+      def sections_sequence_validate_body_vocab(names, elem)
+        while elem && %w(clause terms).include?(elem.name)
+          elem = names.shift
         end
-        while n&.name == "annex"
-          n = names.shift
-          if n.nil?
+        %w(annex references).include? elem&.name or
+          @log.add("Style", elem, "Only annexes and references can follow terms and clauses")
+        [names, elem]
+      end
+
+      def sections_sequence_validate_end(names, elem)
+        while elem&.name == "annex"
+          elem = names.shift
+          if elem.nil?
             @log.add("Style", nil, "Document must include (references) "\
                      "Normative References")
           end
         end
-        n&.at("./self::references[@normative = 'true']") ||
+        elem&.at("./self::references[@normative = 'true']") ||
           @log.add("Style", nil, "Document must include (references) "\
                    "Normative References")
-        n = names&.shift
-        n&.at("./self::references[@normative = 'false']") ||
-          @log.add("Style", n, "Final section must be (references) Bibliography")
+        elem = names&.shift
+        elem&.at("./self::references[@normative = 'false']") ||
+          @log.add("Style", elem, "Final section must be (references) Bibliography")
         names.empty? ||
-          @log.add("Style", n, "There are sections after the final Bibliography")
+          @log.add("Style", elem, "There are sections after the final Bibliography")
       end
 
       def style_warning(node, msg, text = nil)

data/lib/asciidoctor/iso/validate_style.rb

@@ -102,8 +102,8 @@ module Asciidoctor
       # ISO/IEC DIR 2, Table B.1
       def style_number(node, text)
         style_two_regex_not_prev(
-          node, text, /^(?<num>-?[0-9]{4,}[,0-9]*)$/,
-          %r{\b(ISO|IEC|IEEE/|(in|January|February|March|April|May|June|August|September|October|November|December)\b)$},
+          node, text, /^(?<num>-?[0-9]{4,}[,0-9]*)\Z/,
+          %r{\b(ISO|IEC|IEEE/|(in|January|February|March|April|May|June|August|September|October|November|December)\b)\Z},
           "number not broken up in threes"
         )
         style_regex(/\b(?<num>[0-9]+\.[0-9]+)/i,
@@ -123,7 +123,7 @@ module Asciidoctor
       # ISO/IEC DIR 2, 8.4
       # ISO/IEC DIR 2, 9.3
       def style_abbrev(node, text)
-        style_regex(/(^|\s)(?!e\.g\.|i\.e\.)
+        style_regex(/(\A|\s)(?!e\.g\.|i\.e\.)
                     (?<num>[a-z]{1,2}\.([a-z]{1,2}|\.))\b/ix,
                     "no dots in abbreviations", node, text)
         style_regex(/\b(?<num>ppm)\b/i,

data/lib/isodoc/iso/base_convert.rb

@@ -13,8 +13,8 @@ module IsoDoc
         super
       end
 
-      def implicit_reference(b)
-        return true if b&.at(ns("./docidentifier"))&.text == "IEV"
+      def implicit_reference(bib)
+        return true if bib&.at(ns("./docidentifier"))&.text == "IEV"
 
         super
       end
@@ -32,7 +32,7 @@ module IsoDoc
         return if name.nil?
 
         div.span **{ class: "example_label" } do |p|
-          name.children.each { |n| parse(n, div) }
+          name.children.each { |n| parse(n, p) }
         end
       end
 
@@ -89,7 +89,7 @@ module IsoDoc
         return unless insert = node.at(ns("./definition"))
 
         insert = insertall_after_here(node, insert, "termexample")
-        insert = insertall_after_here(node, insert, "termnote")
+        insertall_after_here(node, insert, "termnote")
       end
 
       def termdef_parse(node, out)
@@ -110,26 +110,29 @@ module IsoDoc
         end
       end
 
-      def formula_where(dl, out)
-        return if dl.nil?
-        return super unless (dl&.xpath(ns("./dt"))&.size == 1 && 
-                             dl&.at(ns("./dd"))&.elements&.size == 1 &&
-                             dl&.at(ns("./dd/p")))
+      def formula_where(dlist, out)
+        return if dlist.nil?
+        return super unless dlist&.xpath(ns("./dt"))&.size == 1 &&
+          dlist&.at(ns("./dd"))&.elements&.size == 1 &&
+          dlist&.at(ns("./dd/p"))
 
         out.span **{ class: "zzMoveToFollowing" } do |s|
           s << "#{@i18n.where} "
-          dl.at(ns("./dt")).children.each { |n| parse(n, s) }
+          dlist.at(ns("./dt")).children.each { |n| parse(n, s) }
           s << " "
         end
-        parse(dl.at(ns("./dd/p")), out)
+        parse(dlist.at(ns("./dd/p")), out)
       end
 
       def admonition_parse(node, out)
         type = node["type"]
         name = admonition_name(node, type)
         out.div **{ id: node["id"], class: admonition_class(node) } do |div|
-          node.first_element_child.name == "p" ?
-            admonition_p_parse(node, div, name) : admonition_parse1(node, div, name)
+          if node.first_element_child.name == "p"
+            admonition_p_parse(node, div, name)
+          else
+            admonition_parse1(node, div, name)
+          end
         end
       end
 
@@ -153,17 +156,39 @@ module IsoDoc
         div << " &mdash; "
       end
 
-      def figure_name_parse(node, div, name)
+      def figure_name_parse(_node, div, name)
         div.p **{ class: "FigureTitle", style: "text-align:center;" } do |p|
-          name&.children&.each { |n| parse(n, div) }
+          name&.children&.each { |n| parse(n, p) }
         end
       end
 
       def middle(isoxml, out)
-        super
+        middle_title(isoxml, out)
+        middle_admonitions(isoxml, out)
+        i = scope isoxml, out, 0
+        i = norm_ref isoxml, out, i
+        # i = terms_defs isoxml, out, i
+        # symbols_abbrevs isoxml, out, i
+        clause_etc isoxml, out, i
+        annex isoxml, out
+        bibliography isoxml, out
         indexsect isoxml, out
       end
 
+      def clause_etc(isoxml, out, num)
+        isoxml.xpath(ns("//sections/clause[not(@type = 'scope')] | "\
+                        "//sections/terms | //sections/definitions")).each do |f|
+          out.div **attr_code(id: f["id"],
+                              class: f.name == "definitions" ? "Symbols" : nil) do |div|
+            num = num + 1
+            clause_name(num, f&.at(ns("./title")), div, nil)
+            f.elements.each do |e|
+              parse(e, div) unless %w{title source}.include? e.name
+            end
+          end
+        end
+      end
+
       def indexsect(isoxml, out)
         isoxml.xpath(ns("//indexsect")).each do |i|
           clause_parse(i, out)