metanorma-iso 1.8.3 → 1.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cb8038b020aca28d9a8ac7faa9fd0c11157fb9bc380d291edcb05fb91f675683
-  data.tar.gz: af9152228cacb007d0e19bce254d89e4d524596c615aa8031b9348519996e6c9
+  metadata.gz: 2fc50a5631e4815038d720b3f8b01551c824df300760d7d5c01e0fa57adf37a0
+  data.tar.gz: 7f2b4cad47277b4b1b0ab49d12f873e9a008b511fbd5db2a3925b96c9f504875
 SHA512:
-  metadata.gz: 6de552f032b9f1a767a3dd9b8aecc4a3d73ef66bdb2bfcffa5b045a3e2c3557ddcd9b85af78134db5cdb21618f6d209abba095f5a24b0a9b04c6bbbc8e024bbb
-  data.tar.gz: f560fd265b804ab36ba2e304fc85c0d0353f99dbefe7af5bea3841306c70f78ca72b7827a4f0148483244bebd6c5ef976cb2a93e58843f92446b125001a7762e
+  metadata.gz: cfb9d4ca6d29cdd964118d3d7810cd71acfbe4b6d9c5c1edb3b14bfbadddbc004e73755e5495ebf91fa51670a373dc02d6b37ea4e1bac8df5d097bb3214adb44
+  data.tar.gz: 28b0407e858ff7ea5b8a7911b9c7bf2b82c7a9d45e9035029bd510a78a7e16016175fdfa03dbf04599d4254e2eabce2178f36b671141e833587f02d3298b008a

data/.github/workflows/rake.yml

@@ -4,7 +4,7 @@ name: rake
 
 on:
   push:
-    branches: [ master, main  ]
+    branches: [ master, main ]
     tags: [ v* ]
   pull_request:
 
@@ -16,19 +16,9 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        ruby: [ '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 ]
-        include:
-          - ruby: '3.0'
-            os: 'ubuntu-latest'
-            experimental: true
-          - ruby: '3.0'
-            os: 'windows-latest'
-            experimental: true
-          - ruby: '3.0'
-            os: 'macos-latest'
-            experimental: true
     steps:
       - uses: actions/checkout@master
 
@@ -49,5 +39,5 @@ jobs:
         with:
           token: ${{ secrets.METANORMA_CI_PAT_TOKEN || secrets.GITHUB_TOKEN }}
           repository: ${{ github.repository }}
-          event-type: notify
+          event-type: tests-passed
           client-payload: '{"ref": "${{ github.ref }}", "sha": "${{ github.sha }}"}'

data/.hound.yml

@@ -1,3 +1,5 @@
+# Auto-generated by Cimas: Do not edit it manually!
+# See https://github.com/metanorma/cimas
 ruby:
-  Enabled: true
+  enabled: true
   config_file: .rubocop.yml

data/.rubocop.yml

@@ -1,12 +1,10 @@
-# This project follows the Ribose OSS style guide.
-# https://github.com/riboseinc/oss-guides
-# All project-specific additions and overrides should be specified in this file.
+# 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
 
 # local repo-specific modifications
+# ...
 
 AllCops:
-  DisplayCopNames: false
-  StyleGuideCopsOnly: false
-  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

@@ -45,6 +45,11 @@
         <optional>
           <attribute name="alt"/>
         </optional>
+        <optional>
+          <attribute name="updatetype">
+            <data type="boolean"/>
+          </attribute>
+        </optional>
         <text/>
       </element>
     </define>
@@ -199,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">
@@ -543,6 +560,9 @@
     </define>
     <define name="BibDataExtensionType">
       <ref name="doctype"/>
+      <optional>
+        <ref name="docsubtype"/>
+      </optional>
       <optional>
         <ref name="editorialgroup"/>
       </optional>
@@ -890,6 +910,14 @@
     </define>
   </include>
   <!-- end overrides -->
+  <define name="docsubtype">
+    <element name="subdoctype">
+      <ref name="DocumentSubtype"/>
+    </element>
+  </define>
+  <define name="DocumentSubtype">
+    <text/>
+  </define>
   <define name="colgroup">
     <element name="colgroup">
       <oneOrMore>
@@ -939,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"/>
@@ -965,6 +1020,9 @@
       </attribute>
       <attribute name="name"/>
       <attribute name="action"/>
+      <optional>
+        <attribute name="class"/>
+      </optional>
       <zeroOrMore>
         <choice>
           <ref name="TextElement"/>
@@ -1457,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-amd.rng

@@ -83,6 +83,9 @@
     </define>
     <define name="BibDataExtensionType">
       <ref name="doctype"/>
+      <optional>
+        <ref name="docsubtype"/>
+      </optional>
       <ref name="editorialgroup"/>
       <zeroOrMore>
         <ref name="ics"/>

data/lib/asciidoctor/iso/isostandard.rng

@@ -38,6 +38,9 @@
     </define>
     <define name="BibDataExtensionType">
       <ref name="doctype"/>
+      <optional>
+        <ref name="docsubtype"/>
+      </optional>
       <optional>
         <ref name="horizontal"/>
       </optional>
@@ -98,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>
@@ -133,7 +140,7 @@
       <optional>
         <ref name="section-title"/>
       </optional>
-      <group>
+      <choice>
         <choice>
           <group>
             <oneOrMore>
@@ -148,7 +155,7 @@
         <oneOrMore>
           <ref name="clause-subsection"/>
         </oneOrMore>
-      </group>
+      </choice>
     </define>
     <define name="term">
       <element name="term">
@@ -259,6 +266,14 @@
         <value>directive</value>
       </choice>
     </define>
+    <define name="DocumentSubtype">
+      <choice>
+        <value>specification</value>
+        <value>method-of-test</value>
+        <value>vocabulary</value>
+        <value>code-of-practice</value>
+      </choice>
+    </define>
     <define name="structuredidentifier">
       <element name="structuredidentifier">
         <optional>

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)