metanorma-nist 1.0.5 → 1.0.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f758b64420197c62c491fb933d62fe0dde91fec5d9955d83e830a474160bfed0
-  data.tar.gz: 5b37fe1074ed0d62720af6e88dd08ffca4cb0c1f6eb1aeb256653e53c56c632e
+  metadata.gz: fdfccf7f80188c5fdb7b176e3f2e1ec2533218d878ffc2e8798a4ad3b9cd70f7
+  data.tar.gz: d98180fcdd728e854e47df4f8ca07503c77de570ac3c7f41ab21c6ae0b516e87
 SHA512:
-  metadata.gz: 3e4d2b04a0ded879553796a90c5a88ca0b7537020b5b59c0b94823c504e0c8594ac35d5fa299efd454014b8a25c1a891b10c5e0a11847224e83e7f693780b264
-  data.tar.gz: 62c4a654c0d35e6e39104be8627d260650e2392e1ce3b61871747ccced61c38cd38a83d05e37073d82c7de320eeeb9b52096fa4ec7bcfaa00f38bf1c57d77af1
+  metadata.gz: 25231b4da1777b011ef5ac9eb9aa2c9691227882ca37fa59cc034a4bbf5a22b077bb59b512e1673488d7a497b36c304d508e8e65b45fd0deb5b3aa069304a9bc
+  data.tar.gz: ba4697d24bb857a5468dd1dc02e4b0bf83cb8ea296c6fc08b205c855d8b9b4dd000a08bcba3f7871ce06ab5919dfeb758148f862464fbbc78ed6124b6d26aa7b

data/.github/workflows/macos.yml

@@ -6,15 +6,23 @@ on:
   push:
     branches: [ master ]
   pull_request:
+    paths-ignore:
+      - .github/workflows/ubuntu.yml
+      - .github/workflows/windows.yml
 
 jobs:
   test-macos:
     name: Test on Ruby ${{ matrix.ruby }} macOS
     runs-on: macos-latest
+    continue-on-error: ${{ matrix.experimental }}
     strategy:
       fail-fast: false
       matrix:
         ruby: [ '2.6', '2.5', '2.4' ]
+        experimental: [false]
+        include:
+          - ruby: '2.7'
+            experimental: true
     steps:
       - uses: actions/checkout@master
       - name: Use Ruby
@@ -26,13 +34,6 @@ jobs:
         run: |
           sudo gem install bundler --force
           bundle install --jobs 4 --retry 3
-      - name: Use Node
-        uses: actions/setup-node@v1
-        with:
-          node-version: '8'
-      - name: Install Puppeteer
-        run: |
-          npm install -g puppeteer
       - name: Run specs
         run: |
           bundle exec rake

data/.github/workflows/ubuntu.yml

@@ -5,16 +5,26 @@ name: ubuntu
 on:
   push:
     branches: [ master ]
+    tags:
+      - '*'
   pull_request:
+    paths-ignore:
+      - .github/workflows/macos.yml
+      - .github/workflows/windows.yml
 
 jobs:
   test-linux:
     name: Test on Ruby ${{ matrix.ruby }} Ubuntu
     runs-on: ubuntu-latest
+    continue-on-error: ${{ matrix.experimental }}
     strategy:
       fail-fast: false
       matrix:
         ruby: [ '2.6', '2.5', '2.4' ]
+        experimental: [false]
+        include:
+          - ruby: '2.7'
+            experimental: true
     steps:
       - uses: actions/checkout@master
       - name: Use Ruby
@@ -26,18 +36,11 @@ jobs:
         run: |
           gem install bundler
           bundle install --jobs 4 --retry 3
-      - name: Use Node
-        uses: actions/setup-node@v1
-        with:
-          node-version: '8'
-      - name: Install Puppeteer
-        run: |
-          npm install -g puppeteer
       - name: Run specs
         run: |
           bundle exec rake
       - name: Trigger dependent repositories
-        if: github.ref == 'refs/heads/master'
+        if: github.ref == 'refs/heads/master' && matrix.ruby == '2.6'
         env:
           GH_USERNAME: ${{ secrets.PAT_USERNAME }}
           GH_ACCESS_TOKEN: ${{ secrets.PAT_TOKEN }}
@@ -46,5 +49,5 @@ jobs:
           [[ -f ".github/workflows/dependent_repos.env" ]] && source .github/workflows/dependent_repos.env
           for repo in $DEPENDENT_REPOS
           do
-            sh trigger-gh-actions.sh $ORGANISATION $repo $GH_USERNAME $GH_ACCESS_TOKEN $GITHUB_REPOSITORY
+            sh trigger-gh-actions.sh $ORGANISATION $repo $GH_USERNAME $GH_ACCESS_TOKEN $GITHUB_REPOSITORY "{ \"ref\": \"${GITHUB_REF}\" }"
           done

data/.github/workflows/windows.yml

@@ -6,15 +6,23 @@ on:
   push:
     branches: [ master ]
   pull_request:
+    paths-ignore:
+      - .github/workflows/macos.yml
+      - .github/workflows/ubuntu.yml
 
 jobs:
   test-windows:
     name: Test on Ruby ${{ matrix.ruby }} Windows
     runs-on: windows-latest
+    continue-on-error: ${{ matrix.experimental }}
     strategy:
       fail-fast: false
       matrix:
         ruby: [ '2.6', '2.5', '2.4' ]
+        experimental: [false]
+        include:
+          - ruby: '2.7'
+            experimental: true
     steps:
       - uses: actions/checkout@master
       - name: Use Ruby
@@ -27,15 +35,7 @@ jobs:
         run: |
           gem install bundler
           bundle config --local path vendor/bundle
-          bundle update
           bundle install --jobs 4 --retry 3
-      - name: Use Node
-        uses: actions/setup-node@v1
-        with:
-          node-version: '8'
-      - name: Install Puppeteer
-        run: |
-          npm install -g puppeteer
       - name: Run specs
         run: |
           bundle exec rake

data/README.adoc

@@ -223,6 +223,10 @@ Used to indicate the date of errata releases.
 The date at which a draft is circulated. Displayed on the cover page of drafts.
 MANDATORY FOR DRAFTS.
 
+`:language:`::
+Two-letter code (ISO 639-1) of the language the document is written in. Defaults to `en`.
+If multiple languages are used in the document, comma-delimited; e.g. `en,fr`.
+
 === NIST-specific attributes
 
 The following document attributes are specific to this document class:
@@ -239,11 +243,29 @@ Added to authority statement as document contact. Use line breaks (in Asciidocto
 `:revision:`:: The document revision; e.g. `1` (Revision 1). Will be stored in Metanorma XML
 under the `<edition>` tag, with the prefix `Revision `.
 
+`:version:`:: The document version, when titled as version. Will be stored in Metanorma XML
+under the `<edition>` tag, with the prefix `Version `.
+
 `:volume:`::
 The number of the volume of a standard. Is ignored if a precomposed
 document identifier (`:docidentifier:`) is supplied.
 Is prefixed with "Volume" or "Vol." in display.
 
+`:part:`::
+The part number of a standard. Is only used to generate machine readable NIST identifier (nist-mr).
+
+`:section:`::
+The section number of a standard. Is only used to generate machine readable NIST identifier (nist-mr).
+
+`:supplement:`::
+The supplement number of a standard. Is only used to generate machine readable NIST identifier (nist-mr).
+
+`:index:`::
+The index number of a standard. Is only used to generate machine readable NIST identifier (nist-mr).
+
+`:update:`::
+The update number of a standard. Is only used to generate machine readable NIST identifier (nist-mr).
+
 `:title-main:`:: The title of the document.
 `:title-sub:`:: The subtitle of the document.
 

data/lib/asciidoctor/nist/biblio.rng

@@ -88,7 +88,7 @@
       <text/>
     </element>
   </define>
-  <define name="LocalizedString">
+  <define name="LocalizedString1">
     <optional>
       <!-- multiple languages and scripts possible: comma delimit them if so -->
       <attribute name="language"/>
@@ -98,6 +98,16 @@
     </optional>
     <text/>
   </define>
+  <define name="LocalizedString">
+    <choice>
+      <ref name="LocalizedString1"/>
+      <oneOrMore>
+        <element name="variant">
+          <ref name="LocalizedString1"/>
+        </element>
+      </oneOrMore>
+    </choice>
+  </define>
   <!--
     Unlike UML, change type to format: type is overloaded
     Would be need if plain were default value and could omit the attribute
@@ -121,7 +131,7 @@
     </optional>
     <ref name="LocalizedStringOrXsAny"/>
   </define>
-  <define name="LocalizedStringOrXsAny">
+  <define name="LocalizedStringOrXsAny1">
     <optional>
       <!-- multiple languages and scripts possible: comma delimit them if so -->
       <attribute name="language"/>
@@ -136,6 +146,16 @@
       </choice>
     </oneOrMore>
   </define>
+  <define name="LocalizedStringOrXsAny">
+    <choice>
+      <ref name="LocalizedStringOrXsAny1"/>
+      <oneOrMore>
+        <element name="variant">
+          <ref name="LocalizedStringOrXsAny1"/>
+        </element>
+      </oneOrMore>
+    </choice>
+  </define>
   <define name="contributor">
     <element name="contributor">
       <zeroOrMore>
@@ -512,7 +532,7 @@
   </define>
   <define name="LocalityType">
     <data type="string">
-      <param name="pattern">section|clause|part|paragraph|chapter|page|whole|table|annex|figure|note|list|example|volume|issue|time|locality:[a-zA-Z0-9_]+</param>
+      <param name="pattern">section|clause|part|paragraph|chapter|page|whole|table|annex|figure|note|list|example|volume|issue|time|anchor|locality:[a-zA-Z0-9_]+</param>
     </data>
   </define>
   <define name="referenceFrom">
@@ -641,9 +661,9 @@
     <optional>
       <ref name="status"/>
     </optional>
-    <optional>
+    <zeroOrMore>
       <ref name="copyright"/>
-    </optional>
+    </zeroOrMore>
     <zeroOrMore>
       <ref name="docrelation"/>
     </zeroOrMore>
@@ -767,6 +787,8 @@
       <value>unchanged</value>
       <value>circulated</value>
       <value>adapted</value>
+      <value>vote-started</value>
+      <value>vote-ended</value>
     </choice>
   </define>
   <define name="bdate">
@@ -999,7 +1021,17 @@
       <optional>
         <ref name="to"/>
       </optional>
-      <ref name="owner"/>
+      <oneOrMore>
+        <ref name="owner"/>
+      </oneOrMore>
+      <optional>
+        <ref name="copyright_scope"/>
+      </optional>
+    </element>
+  </define>
+  <define name="copyright_scope">
+    <element name="scope">
+      <text/>
     </element>
   </define>
   <define name="from">
@@ -1019,38 +1051,63 @@
   </define>
   <define name="DocRelationType">
     <choice>
-      <value>obsoletes</value>
-      <value>obsoletedBy</value>
-      <value>supersedes</value>
-      <value>supersededBy</value>
-      <value>updates</value>
-      <value>updatedBy</value>
-      <value>complements</value>
-      <value>derivedFrom</value>
-      <value>translatedFrom</value>
-      <value>hasTranslation</value>
-      <value>adoptedFrom</value>
-      <value>equivalent</value>
-      <value>identical</value>
-      <value>nonequivalent</value>
-      <value>includedIn</value>
       <value>includes</value>
-      <value>instance</value>
-      <value>instanceOf</value>
-      <value>partOf</value>
+      <value>includedIn</value>
       <value>hasPart</value>
-      <value>hasDraft</value>
-      <value>draftOf</value>
+      <value>partOf</value>
       <value>merges</value>
+      <value>mergedInto</value>
       <value>splits</value>
-      <value>amends</value>
-      <value>amendedBy</value>
-      <value>corrects</value>
-      <value>correctedBy</value>
-      <value>revises</value>
-      <value>revisedBy</value>
+      <value>splitInto</value>
+      <value>instance</value>
+      <value>hasInstance</value>
+      <value>exemplarOf</value>
+      <value>hasExemplar</value>
+      <value>manifestationOf</value>
+      <value>hasManifestation</value>
+      <value>reproductionOf</value>
+      <value>hasReproduction</value>
+      <value>reprintOf</value>
+      <value>hasReprint</value>
+      <value>expressionOf</value>
+      <value>hasExpression</value>
+      <value>translatedFrom</value>
+      <value>hasTranslation</value>
+      <value>arrangementOf</value>
+      <value>hasArrangement</value>
+      <value>abridgementOf</value>
+      <value>hasAbridgement</value>
+      <value>annotationOf</value>
+      <value>hasAnnotation</value>
+      <value>draftOf</value>
+      <value>hasDraft</value>
+      <value>editionOf</value>
+      <value>hasEdition</value>
+      <value>updates</value>
+      <value>updatedBy</value>
+      <value>derivedFrom</value>
+      <value>derives</value>
       <value>describes</value>
       <value>describedBy</value>
+      <value>catalogues</value>
+      <value>cataloguedBy</value>
+      <value>hasSuccessor</value>
+      <value>successorOf</value>
+      <value>adaptedFrom</value>
+      <value>hasAdaptation</value>
+      <value>adoptedFrom</value>
+      <value>adoptedAs</value>
+      <value>reviewOf</value>
+      <value>hasReview</value>
+      <value>commentaryOf</value>
+      <value>hasCommentary</value>
+      <value>related</value>
+      <value>complements</value>
+      <value>complementOf</value>
+      <value>obsoletes</value>
+      <value>obsoletedBy</value>
+      <value>cited</value>
+      <value>isCitedIn</value>
     </choice>
   </define>
   <define name="docrelation">

data/lib/asciidoctor/nist/cleanup.rb

@@ -100,12 +100,12 @@ module Asciidoctor
         super
         ret = get_all_nist_refs(docxml)
         tallies = ret.inject(Hash.new(0)) do |memo, (k, v)|
-          memo[v[:trunc]] += 1
+          memo[v[:trunc]] += 1 unless v[:trunc].nil?
           memo
         end
         ret.each do |k, v|
           tallies[v[:trunc]] == 1 and @anchors[k][:xref] = v[:trunc]
-          @anchors[k][:xref].sub!(/^NIST /, "")
+          @anchors&.dig(k, :xref)&.sub!(/^NIST /, "")
         end
       end
 
@@ -149,10 +149,11 @@ module Asciidoctor
           key = /^\[\d+\]$/.match(metaid) ? ( @citation_order[metaid] % "09%d" ) : metaid
         elsif metaid = bib&.at("./docidentifier[@type = 'NIST']")&.text
           key = metaid.sub(/-(\d+)/) {|m| sprintf "-%09d", ($1.to_i) }
-        else
-          metaid = bib&.at("./docidentifier[not(@type = 'DOI' or "\
+        elsif metaid = bib&.at("./docidentifier[not(@type = 'DOI' or "\
                            "@type = 'metanorma' or @type = 'ISSN' or @type = 'ISBN')]")&.text
           key = metaid.sub(/-(\d+)/) {|m| sprintf "-%09d", ($1.to_i) }
+        else # no usable docid
+          key = "000000000" + bib["id"]
         end
         title = bib&.at("./title[@type = 'main']")&.text ||
           bib&.at("./title")&.text || bib&.at("./formattedref")&.text

data/lib/asciidoctor/nist/converter.rb

@@ -107,7 +107,7 @@ module Asciidoctor
           File.open(filename, "w:UTF-8") { |f| f.write(ret) }
           html_converter(node).convert filename unless node.attr("nodoc")
           word_converter(node).convert filename unless node.attr("nodoc")
-          pdf_converter(node).convert filename unless node.attr("nodoc")
+          pdf_converter(node)&.convert filename unless node.attr("nodoc")
         end
         @log.write(@localdir + @filename + ".err") unless @novalid
         @files_to_delete.each { |f| FileUtils.rm f }
@@ -151,36 +151,12 @@ module Asciidoctor
         end
       end
 
-      def section(node)
-        a = section_attributes(node)
-        noko do |xml|
-          case sectiontype(node)
-            #when "normative references" then norm_ref_parse(a, xml, node)
-          when "terms and definitions"
-            if node.attr("style") == "appendix" && node.level == 1
-              @term_def = true
-              terms_annex_parse(a, xml, node)
-              @term_def = false
-            else
-              clause_parse(a, xml, node)
-            end
-          when "acknowledgements"
-            acknowledgements_parse(a, xml, node)
-          else
-            if @term_def 
-              term_def_subclause_parse(a, xml, node)
-            elsif @biblio then bibliography_parse(a, xml, node)
-            elsif node.attr("style") == "bibliography"
-              bibliography_parse(a, xml, node)
-            elsif node.attr("style") == "abstract"
-              abstract_parse(a, xml, node)
-            elsif node.attr("style") == "appendix" && node.level == 1
-              annex_parse(a, xml, node)
-            else
-              clause_parse(a, xml, node)
-            end
-          end
-        end.join("\n")
+      def term_def_parse(attrs, xml, node, toplevel)
+        if node.attr("style") == "appendix" && node.level == 1
+          terms_annex_parse(attrs, xml, node)
+        else
+          clause_parse(attrs, xml, node)
+        end
       end
 
       def bibliography_parse(a, xml, node)
@@ -236,6 +212,7 @@ module Asciidoctor
       end
 
       def pdf_converter(node)
+        return nil if node.attr("no-pdf")
         IsoDoc::NIST::PdfConvert.new(html_extract_attributes(node))
       end
     end