metanorma-iso 1.5.12 → 1.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8fa41b9ff5a061ea7bf8428ec4cd1a692867c877462f4fd1b7bf1ae1b0dd2a9f
-  data.tar.gz: 7e99d7041d2a295b48057be5ea7505ce05be4b40739ce4ffa3ffc4b94149aabc
+  metadata.gz: 4ec4ec662c484d537eb81f3942a322462babc6f46faa2a4842cb3dd0d933a23a
+  data.tar.gz: 1967914fa124dbe03b21d008f615bb84f576665bf7562d85ef4740bf56d953c3
 SHA512:
-  metadata.gz: e7ee3745f439ae3aae5664e6440aed30d94f5e02b4691754fc39cc8ed58fa9bd8e8b80063d9d7889c4e36e8edc9e056f1bef761f471af4742bab8d8465d6a8d7
-  data.tar.gz: a8f78935bf25b08a0cf56872384d0dcabd71d7ea8e996bf87d54db1f7045811b6e064953773b93d0d4f560a38f4fff16b4efd96814f01ac1eefbd4ae4e214d04
+  metadata.gz: bbd9e8c580bc90dc62eb14bee46daecd43519b76028f80bb13d7076ad34ce5f1ccfe6cac8159d13ecf08aa82c7afb4a8560ea1d74bd442e2387f03afe1ce0491
+  data.tar.gz: 240233e6a5eca387b2def2da7660524f28bb11ddbe6d5ee61b9cf829f1baf9ee547ecb411626efa52b8b129434d31e2228a2f7c4c30bacbcf336893ada0f239c

data/.github/workflows/rake.yml

@@ -36,7 +36,10 @@ jobs:
         with:
           ruby-version: ${{ matrix.ruby }}
 
-      - uses: actions/cache@v1
+      - if: matrix.os == 'macos-latest'
+        run: brew install autoconf automake libtool
+
+      - uses: actions/cache@v2
         with:
           path: vendor/bundle
           key: bundle-${{ matrix.os }}-${{ matrix.ruby }}-${{ hashFiles('**/*.gemspec') }}
@@ -64,3 +67,17 @@ jobs:
         run: cinst -y plantuml
 
       - run: bundle exec rake
+
+  tests-passed:
+    needs: rake
+    runs-on: ubuntu-latest
+    continue-on-error: true
+    steps:
+      - name: Trigger tests passed event
+        uses: Sibz/github-status-action@v1
+        with:
+          authToken: ${{ secrets.METANORMA_CI_PAT_TOKEN || secrets.GITHUB_TOKEN }}
+          context: 'tests-passed-successfully'
+          description: 'Tests passed successfully'
+          state: 'success'
+          sha: ${{ github.event.pull_request.head.sha || github.sha }}

data/lib/asciidoctor/iso/base.rb

@@ -5,7 +5,6 @@ require "pathname"
 require "open-uri"
 require "isodoc"
 require "fileutils"
-require 'asciidoctor/iso/macros'
 
 module Asciidoctor
   module ISO
@@ -13,10 +12,6 @@ module Asciidoctor
       XML_ROOT_TAG = "iso-standard".freeze
       XML_NAMESPACE = "https://www.metanorma.org/ns/iso".freeze
 
-      Asciidoctor::Extensions.register do
-        inline_macro Asciidoctor::Iso::TermRefInlineMacro
-      end
-
       def html_converter(node)
         IsoDoc::Iso::HtmlConvert.new(html_extract_attributes(node))
       end
@@ -49,6 +44,11 @@ module Asciidoctor
         @amd = %w(amendment technical-corrigendum).include? doctype(node)
       end
 
+       def ol_attrs(node)
+        attr_code(keep_attrs(node).
+                  merge(id: ::Metanorma::Utils::anchor_or_uuid(node)))
+      end
+
       def outputs(node, ret)
           File.open(@filename + ".xml", "w:UTF-8") { |f| f.write(ret) }
           presentation_xml_converter(node).convert(@filename + ".xml")

data/lib/asciidoctor/iso/basicdoc.rng

@@ -596,6 +596,7 @@
       <ref name="bookmark"/>
       <ref name="image"/>
       <ref name="index"/>
+      <ref name="index-xref"/>
     </choice>
   </define>
   <define name="PureTextElement">
@@ -728,13 +729,61 @@
   </define>
   <define name="index">
     <element name="index">
-      <attribute name="primary"/>
       <optional>
-        <attribute name="secondary"/>
+        <attribute name="to">
+          <data type="IDREF"/>
+        </attribute>
+      </optional>
+      <element name="primary">
+        <oneOrMore>
+          <ref name="PureTextElement"/>
+        </oneOrMore>
+      </element>
+      <optional>
+        <element name="secondary">
+          <oneOrMore>
+            <ref name="PureTextElement"/>
+          </oneOrMore>
+        </element>
+      </optional>
+      <optional>
+        <element name="tertiary">
+          <oneOrMore>
+            <ref name="PureTextElement"/>
+          </oneOrMore>
+        </element>
+      </optional>
+    </element>
+  </define>
+  <define name="index-xref">
+    <element name="index-xref">
+      <attribute name="also">
+        <data type="boolean"/>
+      </attribute>
+      <element name="primary">
+        <oneOrMore>
+          <ref name="PureTextElement"/>
+        </oneOrMore>
+      </element>
+      <optional>
+        <element name="secondary">
+          <oneOrMore>
+            <ref name="PureTextElement"/>
+          </oneOrMore>
+        </element>
       </optional>
       <optional>
-        <attribute name="tertiary"/>
+        <element name="tertiary">
+          <oneOrMore>
+            <ref name="PureTextElement"/>
+          </oneOrMore>
+        </element>
       </optional>
+      <element name="target">
+        <oneOrMore>
+          <ref name="PureTextElement"/>
+        </oneOrMore>
+      </element>
     </element>
   </define>
   <!-- bare ID element, used for referencing arbitrary spans of text -->

data/lib/asciidoctor/iso/cleanup.rb

@@ -4,7 +4,6 @@ require "htmlentities"
 require "json"
 require "pathname"
 require "open-uri"
-require "asciidoctor/iso/term_lookup_cleanup"
 
 module Asciidoctor
   module ISO
@@ -89,11 +88,6 @@ module Asciidoctor
         end
       end
 
-      def termdef_cleanup(xmldoc)
-        Asciidoctor::ISO::TermLookupCleanup.new(xmldoc, @log).call
-        super
-      end
-
       # TODO sort by authors
       # sort by: doc class (ISO, IEC, other standard (not DOI &c), other
       # then standard class (docid class other than DOI &c)

data/lib/asciidoctor/iso/front.rb

@@ -18,6 +18,11 @@ module Asciidoctor
           xml.updates_document_type a
       end
 
+      def metadata_doctype(node, xml)
+        xml.doctype doctype(node)
+        a = node.attr("horizontal") and xml.horizontal a
+      end
+
       def org_abbrev
         { "International Organization for Standardization" => "ISO",
           "International Electrotechnical Commission" => "IEC" }
@@ -80,27 +85,27 @@ module Asciidoctor
       def title_intro(node, t, lang, at)
         return unless node.attr("title-intro-#{lang}")
         t.title(**attr_code(at.merge(type: "title-intro"))) do |t1|
-          t1 << Asciidoctor::Standoc::Utils::asciidoc_sub(node.attr("title-intro-#{lang}"))
+          t1 << Metanorma::Utils::asciidoc_sub(node.attr("title-intro-#{lang}"))
         end
       end
 
       def title_main(node, t, lang, at)
         t.title **attr_code(at.merge(type: "title-main")) do |t1|
-          t1 << Asciidoctor::Standoc::Utils::asciidoc_sub(node.attr("title-main-#{lang}"))
+          t1 << Metanorma::Utils::asciidoc_sub(node.attr("title-main-#{lang}"))
         end
       end
 
       def title_part(node, t, lang, at)
         return unless node.attr("title-part-#{lang}")
         t.title(**attr_code(at.merge(type: "title-part"))) do |t1|
-          t1 << Asciidoctor::Standoc::Utils::asciidoc_sub(node.attr("title-part-#{lang}"))
+          t1 << Metanorma::Utils::asciidoc_sub(node.attr("title-part-#{lang}"))
         end
       end
 
       def title_amd(node, t, lang, at)
         return unless node.attr("title-amendment-#{lang}")
         t.title(**attr_code(at.merge(type: "title-amd"))) do |t1|
-          t1 << Asciidoctor::Standoc::Utils::asciidoc_sub(node.attr("title-amendment-#{lang}"))
+          t1 << Metanorma::Utils::asciidoc_sub(node.attr("title-amendment-#{lang}"))
         end
       end
 
@@ -113,7 +118,7 @@ module Asciidoctor
         title = "#{title} -- #{part}" if part
         title = "#{title} -- #{amd}" if amd && @amd
         t.title **attr_code(at.merge(type: "main")) do |t1|
-          t1 << Asciidoctor::Standoc::Utils::asciidoc_sub(title)
+          t1 << Metanorma::Utils::asciidoc_sub(title)
         end
       end
 

data/lib/asciidoctor/iso/isodoc.rng

@@ -55,6 +55,13 @@
             <param name="pattern">\i\c*|\c+#\c+</param>
           </data>
         </attribute>
+        <optional>
+          <attribute name="to">
+            <data type="string">
+              <param name="pattern">\i\c*|\c+#\c+</param>
+            </data>
+          </attribute>
+        </optional>
         <optional>
           <attribute name="type">
             <ref name="ReferenceFormat"/>
@@ -246,6 +253,12 @@
             <data type="boolean"/>
           </attribute>
         </optional>
+        <optional>
+          <attribute name="width"/>
+        </optional>
+        <optional>
+          <ref name="colgroup"/>
+        </optional>
         <optional>
           <ref name="tname"/>
         </optional>
@@ -764,6 +777,21 @@
     </define>
   </include>
   <!-- end overrides -->
+  <define name="colgroup">
+    <element name="colgroup">
+      <oneOrMore>
+        <ref name="col"/>
+      </oneOrMore>
+    </element>
+  </define>
+  <define name="col">
+    <element name="col">
+      <attribute name="width"/>
+    </element>
+  </define>
+  <define name="BibItemType" combine="choice">
+    <value>internal</value>
+  </define>
   <define name="TextElement" combine="choice">
     <ref name="concept"/>
   </define>
@@ -814,6 +842,9 @@
           <data type="boolean"/>
         </attribute>
       </optional>
+      <optional>
+        <attribute name="number"/>
+      </optional>
       <optional>
         <attribute name="obligation">
           <choice>
@@ -869,9 +900,11 @@
       <element name="code">
         <text/>
       </element>
-      <element name="text">
-        <text/>
-      </element>
+      <optional>
+        <element name="text">
+          <text/>
+        </element>
+      </optional>
     </element>
   </define>
   <define name="standard-document">
@@ -1041,6 +1074,9 @@
         </choice>
       </attribute>
     </optional>
+    <optional>
+      <attribute name="number"/>
+    </optional>
     <optional>
       <attribute name="type"/>
     </optional>
@@ -1094,6 +1130,9 @@
     <optional>
       <attribute name="type"/>
     </optional>
+    <optional>
+      <attribute name="number"/>
+    </optional>
     <optional>
       <ref name="section-title"/>
     </optional>
@@ -1196,6 +1235,9 @@
       <optional>
         <attribute name="type"/>
       </optional>
+      <optional>
+        <attribute name="number"/>
+      </optional>
       <optional>
         <attribute name="obligation">
           <choice>
@@ -1524,6 +1566,7 @@
           <value>add</value>
           <value>modify</value>
           <value>delete</value>
+          <value>replace</value>
         </choice>
       </attribute>
       <optional>
@@ -1554,6 +1597,11 @@
       </optional>
       <optional>
         <element name="newcontent">
+          <optional>
+            <attribute name="id">
+              <data type="ID"/>
+            </attribute>
+          </optional>
           <zeroOrMore>
             <ref name="BasicBlock"/>
           </zeroOrMore>

data/lib/asciidoctor/iso/isostandard-amd.rng

@@ -14,9 +14,6 @@
     </define>
     <define name="clause">
       <element name="clause">
-        <optional>
-          <attribute name="type"/>
-        </optional>
         <optional>
           <attribute name="change">
             <choice>
@@ -34,6 +31,13 @@
     </define>
     <define name="iso-standard">
       <element name="iso-standard">
+        <attribute name="version"/>
+        <attribute name="type">
+          <choice>
+            <value>semantic</value>
+            <value>presentation</value>
+          </choice>
+        </attribute>
         <ref name="bibdata"/>
         <optional>
           <ref name="boilerplate"/>
@@ -68,7 +72,7 @@
         </optional>
         <optional>
           <attribute name="origyr">
-            <data type="int"/>
+            <ref name="ISO8601Date"/>
           </attribute>
         </optional>
         <text/>

data/lib/asciidoctor/iso/isostandard.rng

@@ -38,6 +38,9 @@
     </define>
     <define name="BibDataExtensionType">
       <ref name="doctype"/>
+      <optional>
+        <ref name="horizontal"/>
+      </optional>
       <ref name="editorialgroup"/>
       <zeroOrMore>
         <ref name="ics"/>
@@ -137,22 +140,28 @@
           </choice>
         </attribute>
       </optional>
+      <optional>
+        <attribute name="type"/>
+      </optional>
       <optional>
         <ref name="section-title"/>
       </optional>
-      <choice>
-        <group>
-          <oneOrMore>
-            <ref name="BasicBlock"/>
-          </oneOrMore>
-          <zeroOrMore>
-            <ref name="note"/>
-          </zeroOrMore>
-        </group>
+      <group>
+        <choice>
+          <group>
+            <oneOrMore>
+              <ref name="BasicBlock"/>
+            </oneOrMore>
+            <zeroOrMore>
+              <ref name="note"/>
+            </zeroOrMore>
+          </group>
+          <ref name="amend"/>
+        </choice>
         <oneOrMore>
           <ref name="clause-subsection"/>
         </oneOrMore>
-      </choice>
+      </group>
     </define>
     <define name="term">
       <element name="term">
@@ -379,6 +388,9 @@
             <data type="anyURI"/>
           </attribute>
         </optional>
+        <optional>
+          <ref name="colgroup"/>
+        </optional>
         <optional>
           <ref name="tname"/>
         </optional>
@@ -429,6 +441,11 @@
       <ref name="bibliography"/>
     </element>
   </define>
+  <define name="horizontal">
+    <element name="horizontal">
+      <data type="boolean"/>
+    </element>
+  </define>
   <define name="documentnumber">
     <element name="project-number">
       <optional>

data/lib/asciidoctor/iso/validate.rb

@@ -146,6 +146,83 @@ module Asciidoctor
                    "#{iteration} is not a recognised iteration")
       end
 
+      # DRG directives 3.7; but anticipated by standoc
+      def subfigure_validate(xmldoc)
+        xmldoc.xpath("//figure//figure").each do |f|
+          { footnote: "fn", note: "note", key: "dl" }.each do |k, v|
+            f.xpath(".//#{v}").each do |n|
+              @log.add("Style", n, "#{k} is not permitted in a subfigure")
+            end
+          end
+        end
+      end
+
+      def image_name_prefix(xmldoc)
+        std = xmldoc&.at("//bibdata/ext/structuredidentifier/project-number") or return
+        num = xmldoc&.at("//bibdata/docnumber")&.text or return
+        ed = xmldoc&.at("//bibdata/edition")&.text || "1"
+        prefix = num
+        part = std["part"] and prefix += "-#{std['part']}"
+        prefix += "_ed#{ed}"
+        amd = std["amendment"] and prefix += "amd#{amd}"
+        prefix
+      end
+
+      def image_name_suffix(xmldoc)
+        case xmldoc&.at("//bibdata/language")&.text
+        when "fr" then "_f"
+        when "de" then "_d"
+        when "ru" then "_r"
+        when "es" then "_s"
+        when "ar" then "_a"
+        when "en" then "_e"
+        else
+          "_e"
+        end
+      end
+
+      def disjunct_error(i, cond1, cond2, msg1, msg2)
+        cond1 && !cond2 and @log.add("Style", i, "image name #{i['src']} #{msg1}")
+        !cond1 && cond2 and @log.add("Style", i, "image name #{i['src']} #{msg2}")
+      end
+
+      def image_name_validate1(i, prefix)
+        m = %r[(SL)?#{prefix}fig(?<tab>Tab)?(?<annex>[A-Z])?(Text)?(?<num>\d+)
+            (?<subfig>[a-z])?(?<key>_key\d+)?(?<lang>_[a-z])?$]x.match(File.basename(i["src"], ".*"))
+        if m.nil?
+          @log.add("Style", i, "image name #{i['src']} does not match DRG requirements")
+          return
+        end
+        warn i['src']
+        disjunct_error(i, i.at("./ancestor::table"), !m[:tab].nil?,
+                       "is under a table but is not so labelled", "is labelled as under a table but is not")
+        disjunct_error(i, i.at("./ancestor::annex"), !m[:annex].nil?,
+                       "is under an annex but is not so labelled", "is labelled as under an annex but is not")
+        disjunct_error(i, i.xpath("./ancestor::figure").size > 1, !m[:subfig].nil?,
+                       "does not have a subfigure letter but is a subfigure",
+                       "has a subfigure letter but is not a subfigure")
+        lang = image_name_suffix(i.document.root)
+        (m[:lang] || "_e") == lang or @log.add("Style", i, "image name #{i['src']} expected to have suffix #{lang}")
+      end
+
+      # DRG directives 3.2
+      def image_name_validate(xmldoc)
+        prefix = image_name_prefix(xmldoc) or return
+        xmldoc.xpath("//image").each do |i|
+          if /^ISO_\d+_/.match(File.basename(i["src"]))
+          elsif /^(SL)?#{prefix}fig/.match(File.basename(i["src"]))
+            image_name_validate1(i, prefix)
+          else
+            @log.add("Style", i, "image name #{i['src']} does not match DRG requirements: expect #{prefix}fig")
+          end
+        end
+      end
+
+      def figure_validate(xmldoc)
+        image_name_validate(xmldoc)
+        subfigure_validate(xmldoc)
+      end
+
       def bibdata_validate(doc)
         doctype_validate(doc)
         script_validate(doc)
@@ -166,6 +243,7 @@ module Asciidoctor
         locality_erefs_validate(doc.root)
         bibdata_validate(doc.root)
         bibitem_validate(doc.root)
+        figure_validate(doc.root)
       end
 
       def bibitem_validate(xmldoc)