metanorma-nist 1.1.0 → 1.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '05109623d4ab89934b15717692765c6c29015007695efad9ea8258b81d1e956c'
-  data.tar.gz: f848bb3f40e50382a2bfeca5f2bd89a78d06d7808bbb3aa4e01d3ce88a8cb87e
+  metadata.gz: 1495072b5486784814d43bda0e9352fbc4945952571260b0226025aa69025ccd
+  data.tar.gz: e90d93ae0853e166cd1b36f954e8ab13b56b3ec87d3a78e347eefa063e05267f
 SHA512:
-  metadata.gz: 5b3e0c43ab7a515b8dcba5a6c988254d361934a87091dca35a9134b3d51833c463126695bc2ebee8a3c1430b309210fd08adc8efec6e1ddce727dd2a9c96ad28
-  data.tar.gz: edc0d9b4b5aa9b8fe2c98a7369cfec29a44a93a3b4808dfb95b8eb618aa6ff7ada7e0110190bb84cf35355fbcb4497c84827ddbd0eb540aeba2a3389525fd20d
+  metadata.gz: 99c3f28c3399dff97c470d7f88207abd2631c023177068b1b6e5076d31500ded0e748a51c0d29bc5bbb73eec2771676b7860af368994125a00737e7474aba744
+  data.tar.gz: 99d118cfd090a5a479f3e496874207ddd6530ac93b83f015fcfa1411b6723373ccc6dd6cb80a633e279a237f655f20af957f9c8250031447f6be72f9972baeb7

data/.github/workflows/macos.yml

@@ -29,7 +29,6 @@ jobs:
         uses: actions/setup-ruby@v1
         with:
           ruby-version: ${{ matrix.ruby }}
-          architecture: 'x64'
       - name: Update gems
         run: |
           sudo gem install bundler --force

data/.github/workflows/ubuntu.yml

@@ -31,7 +31,6 @@ jobs:
         uses: actions/setup-ruby@v1
         with:
           ruby-version: ${{ matrix.ruby }}
-          architecture: 'x64'
       - name: Update gems
         run: |
           gem install bundler
@@ -39,15 +38,19 @@ jobs:
       - name: Run specs
         run: |
           bundle exec rake
-      - name: Trigger dependent repositories
-        if: github.ref == 'refs/heads/master' && matrix.ruby == '2.6'
+      - name: Trigger repositories
+        if: matrix.ruby == '2.6'
         env:
-          GH_USERNAME: ${{ secrets.PAT_USERNAME }}
-          GH_ACCESS_TOKEN: ${{ secrets.PAT_TOKEN }}
+          GH_USERNAME: metanorma-ci
+          GH_ACCESS_TOKEN: ${{ secrets.METANORMA_CI_PAT_TOKEN }}
         run: |
           curl -LO --retry 3 https://raw.githubusercontent.com/metanorma/metanorma-build-scripts/master/trigger-gh-actions.sh
           [[ -f ".github/workflows/dependent_repos.env" ]] && source .github/workflows/dependent_repos.env
-          for repo in $DEPENDENT_REPOS
+          CLIENT_PAYLOAD=$(cat <<EOF
+          "{ "ref": "${GITHUB_REF}", "repo": "${GITHUB_REPOSITORY}" }"
+          EOF
+          )
+          for repo in $REPOS
           do
-            sh trigger-gh-actions.sh $ORGANISATION $repo $GH_USERNAME $GH_ACCESS_TOKEN $GITHUB_REPOSITORY "{ \"ref\": \"${GITHUB_REF}\" }"
+            sh trigger-gh-actions.sh $ORGANISATION $repo $GH_USERNAME $GH_ACCESS_TOKEN $GITHUB_REPOSITORY "$CLIENT_PAYLOAD"
           done

data/.github/workflows/windows.yml

@@ -29,7 +29,6 @@ jobs:
         uses: actions/setup-ruby@v1
         with:
           ruby-version: ${{ matrix.ruby }}
-          architecture: 'x64'
       - name: Update gems
         shell: pwsh
         run: |

data/Rakefile

@@ -1,6 +1,8 @@
 require "bundler/gem_tasks"
 require "rspec/core/rake_task"
+require 'isodoc/gem_tasks'
 
+IsoDoc::GemTasks.install
 RSpec::Core::RakeTask.new(:spec)
 
 task default: :spec

data/lib/asciidoctor/nist/boilerplate.rb

@@ -94,8 +94,8 @@ module Asciidoctor
 
       def boilerplate_isodoc(xmldoc)
         conv = super
-        conv.labels = conv.labels.merge({nist_division: @nistdivision,
-                       nist_division_address: @nistdivisionaddress})
+        conv.i18n.set(:nist_division, @nistdivision)
+        conv.i18n.set(:nist_division_address, @nistdivisionaddress)
         conv
       end
 

data/lib/asciidoctor/nist/cleanup.rb

@@ -3,9 +3,15 @@ module Asciidoctor
     class Converter < Standoc::Converter
       def cleanup(xmldoc)
         sourcecode_cleanup(xmldoc)
+        annex_rename(xmldoc)
         super
       end
 
+      def annex_rename(xmldoc)
+        return unless xmldoc.xpath("//references").size == 1
+        replace_title(xmldoc, "//annex[references]", @i18n&.normref, true)
+      end
+
       def sourcecode_cleanup(xmldoc)
         xmldoc.xpath("//sourcecode").each do |x|
           x.traverse do |n|
@@ -37,7 +43,7 @@ module Asciidoctor
         move_execsummary_into_preface(x, preface)
       end
 
-       def move_clauses_into_preface1(x, preface)
+      def move_clauses_into_preface1(x, preface)
         x.xpath("//clause[@preface]").each do |c|
           c.delete("preface")
           title = c&.at("./title")&.text.downcase
@@ -45,9 +51,9 @@ module Asciidoctor
           c.name = "executivesummary" if title == "executive summary"
           preface.add_child c.remove
         end
-       end
+      end
 
-       def move_execsummary_into_preface(x, preface)
+      def move_execsummary_into_preface(x, preface)
         x.xpath("//clause[@executivesummary]").each do |c|
           c.delete("executivesummary")
           title = c&.at("./title")&.text.downcase
@@ -150,7 +156,7 @@ module Asciidoctor
         elsif metaid = bib&.at("./docidentifier[@type = 'NIST']")&.text
           key = metaid.sub(/-(\d+)/) {|m| sprintf "-%09d", ($1.to_i) }
         elsif metaid = bib&.at("./docidentifier[not(@type = 'DOI' or "\
-                           "@type = 'metanorma' or @type = 'ISSN' or @type = 'ISBN')]")&.text
+                               "@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"]
@@ -171,6 +177,30 @@ module Asciidoctor
         end
         acc
       end
+
+      def section_names_refs_cleanup(x)
+        replace_title(x, "//bibliography//references[@normative = 'true']",
+                      @i18n&.normref, true)
+        replace_title(x, "//bibliography//references[@normative = 'false']",
+                      @i18n&.bibliography, true)
+      end
+
+      def section_names_terms_cleanup(x)
+        replace_title(x, "//definitions[@type = 'symbols']", @i18n&.symbols)
+        replace_title(x, "//definitions[@type = 'abbreviated_terms']", @i18n&.abbrev)
+        replace_title(x, "//definitions[not(@type)]", @i18n&.symbolsabbrev)
+        replace_title(x, "//sections//terms#{SYMnoABBR} | //sections//clause[.//terms]#{SYMnoABBR}",
+                      @i18n&.termsdefsymbols, true)
+        replace_title(x, "//sections//terms#{ABBRnoSYM} | //sections//clause[.//terms]#{ABBRnoSYM}",
+                      @i18n&.termsdefabbrev, true)
+        replace_title(x, "//sections//terms#{SYMABBR} | //sections//clause[.//terms]#{SYMABBR}",
+                      @i18n&.termsdefsymbolsabbrev, true)
+        replace_title(x, "//sections//terms#{NO_SYMABBR} | //sections//clause[.//terms]#{NO_SYMABBR}",
+                      @i18n&.termsdefsymbolsabbrev, true)
+        replace_title(
+          x, "//sections//terms[not(.//definitions)] | //sections//clause[.//terms][not(.//definitions)]",
+          @i18n&.termsdef, true)
+      end
     end
   end
 end

data/lib/asciidoctor/nist/converter.rb

@@ -100,9 +100,12 @@ module Asciidoctor
       def outputs(node, ret)
         File.open(@filename + ".xml", "w:UTF-8") { |f| f.write(ret) }
           presentation_xml_converter(node).convert(@filename + ".xml")
-          html_converter(node).convert(@filename + ".presentation.xml", nil, false, "#{@filename}.html")
-          doc_converter(node).convert(@filename + ".presentation.xml", nil, false, "#{@filename}.doc")
-          pdf_converter(node)&.convert(@filename + ".presentation.xml", nil, false, "#{@filename}.pdf")
+          html_converter(node).convert(@filename + ".presentation.xml", 
+                                       nil, false, "#{@filename}.html")
+          doc_converter(node).convert(@filename + ".presentation.xml", 
+                                      nil, false, "#{@filename}.doc")
+          pdf_converter(node)&.convert(@filename + ".presentation.xml", 
+                                       nil, false, "#{@filename}.pdf")
       end
 
       def clause_parse(attrs, xml, node)
@@ -159,7 +162,7 @@ module Asciidoctor
       def bibliography_annex_parse(attrs, xml, node)
         attrs1 = attrs.merge(id: "_" + UUIDTools::UUID.random_create)
         xml.annex **attr_code(attrs1) do |xml_section|
-          xml_section.title { |t| t << "Bibliography" }
+          xml_section.title { |t| t << node.title }
           @biblio = true
           xml.references **attr_code(attrs.merge(normative: true)) do |r|
             r << node.content

data/lib/asciidoctor/nist/front.rb

@@ -5,9 +5,6 @@ require_relative "./front_id.rb"
 
 module Asciidoctor
   module NIST
-    # A {Converter} implementation that generates RSD output, and a document
-    # schema encapsulation of the document for validation
-
     class Converter < Standoc::Converter
       def doctype(node)
         node.attr("doctype") || "sp-800"
@@ -27,31 +24,35 @@ module Asciidoctor
         end
       end
 
+      def asciidoc_sub(text)
+        Asciidoctor::Standoc::Utils::asciidoc_sub(text)
+      end
+
       def title_subtitle(node, t, at)
         return unless node.attr("title-sub")
         t.title(**attr_code(at.merge(type: "subtitle"))) do |t1|
-          t1 << Asciidoctor::Standoc::Utils::asciidoc_sub(node.attr("title-sub"))
+          t1 << asciidoc_sub(node.attr("title-sub"))
         end
         node.attr("title-sub-short") and
           t.title(**attr_code(at.merge(type: "short-subtitle"))) do |t1|
-          t1 << Asciidoctor::Standoc::Utils::asciidoc_sub(node.attr("title-sub-short"))
+          t1 << asciidoc_sub(node.attr("title-sub-short"))
         end
       end
 
       def title_document_class(node, t, at)
         return unless node.attr("title-document-class")
         t.title(**attr_code(at.merge(type: "document-class"))) do |t1|
-          t1 << Asciidoctor::Standoc::Utils::asciidoc_sub(node.attr("title-document-class"))
+          t1 << asciidoc_sub(node.attr("title-document-class"))
         end
       end
 
       def title_main(node, t, at)
         t.title(**attr_code(at.merge(type: "main"))) do |t1|
-          t1 << (Asciidoctor::Standoc::Utils::asciidoc_sub(node.attr("title-main")) || node.title)
+          t1 << (asciidoc_sub(node.attr("title-main")) || node.title)
         end
         node.attr("title-main-short") and
           t.title(**attr_code(at.merge(type: "short-title"))) do |t1|
-          t1 << Asciidoctor::Standoc::Utils::asciidoc_sub(node.attr("title-main-short"))
+          t1 << asciidoc_sub(node.attr("title-main-short"))
         end
       end
 
@@ -68,12 +69,21 @@ module Asciidoctor
         personal_author(node, xml)
       end
 
+      def default_publisher
+        "National Institute of Standards and Technology"
+      end
+
       def metadata_publisher(node, xml)
-        xml.contributor do |c|
-          c.role **{ type: "publisher" }
-          c.organization do |a|
-            a.name "NIST"
-            d = node.attr("nist-division") and a.subdivision d
+        publishers = node.attr("publisher") || default_publisher
+        csv_split(publishers)&.each do |p|
+          xml.contributor do |c|
+            c.role **{ type: "publisher" }
+            c.organization do |a|
+              a.name p
+              if p == default_publisher
+                d = node.attr("nist-division") and a.subdivision d
+              end
+            end
           end
         end
       end
@@ -86,9 +96,10 @@ module Asciidoctor
           node.attr("technical-committee") and
             a.committee(node.attr("technical-committee"))
           node.attr("subcommittee") and
-            a.subcommittee(node.attr("subcommittee"),
-                           **attr_code(type: node.attr("subcommittee-type"),
-                                       number: node.attr("subcommittee-number")))
+            a.subcommittee(
+              node.attr("subcommittee"),
+              **attr_code(type: node.attr("subcommittee-type"),
+                          number: node.attr("subcommittee-number")))
           (node.attr("workgroup") || node.attr("workinggroup")) and
             a.workgroup(node.attr("workgroup") || node.attr("workinggroup"),
                         **attr_code(type: node.attr("workgroup-type"),
@@ -105,19 +116,6 @@ module Asciidoctor
         end
       end
 
-      def metadata_copyright(node, xml)
-        from = node.attr("copyright-year") || node.attr("copyrightyear") ||
-          Date.today.year
-        xml.copyright do |c|
-          c.from from
-          c.owner do |owner|
-            owner.organization do |o|
-              o.name "NIST"
-            end
-          end
-        end
-      end
-
       def metadata_source(node, xml)
         super
         node.attr("doc-email") && xml.uri(node.attr("doc-email"), type: "email")
@@ -149,14 +147,13 @@ module Asciidoctor
       end
 
       def relaton_relation_descriptions
-        super.merge({
-          "supersedes" => "obsoletes",
-          "superseded-by" => "obsoleted-by",
-        })
+        super.merge({ "supersedes" => "obsoletes",
+                      "superseded-by" => "obsoleted-by", })
       end
 
       def metadata_getrelation(node, xml, type, desc = nil)
-        if type == "obsoleted-by" and desc.nil? and node.attr("superseding-status")
+        if type == "obsoleted-by" and desc.nil? and 
+            node.attr("superseding-status")
           metadata_superseding_doc(node, xml)
         end
         super
@@ -166,10 +163,8 @@ module Asciidoctor
         xml.relation **{ type: "obsoletedBy" } do |r|
           r.bibitem **{ type: "standard" } do |b|
             metadata_superseding_titles(b, node)
-            doi = node.attr("superseding-doi") and
-              b.uri doi, **{ type: "doi" }
-            url = node.attr("superseding-url") and
-              b.uri url, **{ type: "uri" }
+            doi = node.attr("superseding-doi") and b.uri doi, **{ type: "doi" }
+            url = node.attr("superseding-url") and b.uri url, **{ type: "uri" }
             metadata_superseding_ids(b, xml)
             metadata_superseding_authors(b, node)
             metadata_superseding_dates(b, node)
@@ -205,19 +200,19 @@ module Asciidoctor
       def metadata_superseding_titles(b, node)
         if node.attr("superseding-title")
           b.title **{ type: "main" } do |t|
-            t << Asciidoctor::Standoc::Utils::asciidoc_sub(node.attr("superseding-title"))
+            t << asciidoc_sub(node.attr("superseding-title"))
           end
           node.attr("superseding-subtitle") and
             b.title **{ type: "subtitle" } do |t|
-            t << Asciidoctor::Standoc::Utils::asciidoc_sub(node.attr("superseding-subtitle"))
+            t << asciidoc_sub(node.attr("superseding-subtitle"))
           end
         else
           b.title **{ type: "main" } do |t|
-            t << (Asciidoctor::Standoc::Utils::asciidoc_sub(node.attr("title-main")) || node.title)
+            t << (asciidoc_sub(node.attr("title-main")) || node.title)
           end
           node.attr("title-sub") and
             b.title **{ type: "subtitle" } do |t|
-            t << Asciidoctor::Standoc::Utils::asciidoc_sub(node.attr("title-sub"))
+            t << asciidoc_sub(node.attr("title-sub"))
           end
         end
       end

data/lib/asciidoctor/nist/front_id.rb

@@ -64,7 +64,7 @@ module Asciidoctor
       end
 
       def status_abbr(stage, iter)
-        IsoDoc::NIST::Metadata.new(nil, nil, {}).status_abbr(stage, iter)
+        IsoDoc::NIST::Metadata.new(nil, nil, @i18n).status_abbr(stage, iter)
       end
 
       def add_id_parts(args, long)

data/lib/asciidoctor/nist/isodoc.rng

@@ -922,6 +922,9 @@
       <optional>
         <attribute name="script"/>
       </optional>
+      <optional>
+        <attribute name="type"/>
+      </optional>
       <optional>
         <attribute name="obligation">
           <choice>
@@ -961,9 +964,6 @@
   </define>
   <define name="content-subsection">
     <element name="clause">
-      <optional>
-        <attribute name="type"/>
-      </optional>
       <ref name="Content-Section"/>
     </element>
   </define>
@@ -992,6 +992,9 @@
         </choice>
       </attribute>
     </optional>
+    <optional>
+      <attribute name="type"/>
+    </optional>
     <optional>
       <ref name="section-title"/>
     </optional>
@@ -1011,9 +1014,6 @@
   </define>
   <define name="clause">
     <element name="clause">
-      <optional>
-        <attribute name="type"/>
-      </optional>
       <ref name="Clause-Section"/>
     </element>
   </define>
@@ -1042,6 +1042,9 @@
         </choice>
       </attribute>
     </optional>
+    <optional>
+      <attribute name="type"/>
+    </optional>
     <optional>
       <ref name="section-title"/>
     </optional>
@@ -1180,6 +1183,9 @@
       <optional>
         <attribute name="script"/>
       </optional>
+      <optional>
+        <attribute name="type"/>
+      </optional>
       <optional>
         <attribute name="obligation">
           <choice>

data/lib/asciidoctor/nist/validate.rb

@@ -21,26 +21,30 @@ module Asciidoctor
       def doctype_validate(xmldoc)
         doctype = xmldoc&.at("//bibdata/ext/doctype")&.text
         %w(standard).include? doctype or
-          @log.add("Document Attributes", nil, "#{doctype} is not a recognised document type")
+          @log.add("Document Attributes", nil, 
+                   "#{doctype} is not a recognised document type")
       end
 
       def stage_validate(xmldoc)
         stage = xmldoc&.at("//bibdata/status/stage")&.text
         %w(draft-internal draft-wip draft-prelim draft-public draft-approval
         final final-review).include? stage or
-        @log.add("Document Attributes", nil, "#{stage} is not a recognised stage")
+        @log.add("Document Attributes", nil, 
+                 "#{stage} is not a recognised stage")
       end
 
       def substage_validate(xmldoc)
         substage = xmldoc&.at("//bibdata/status/substage")&.text or return
         %w(active retired withdrawn).include? substage or
-          @log.add("Document Attributes", nil, "#{substage} is not a recognised substage")
+          @log.add("Document Attributes", nil, 
+                   "#{substage} is not a recognised substage")
       end
 
       def iteration_validate(xmldoc)
         iteration = xmldoc&.at("//bibdata/status/iteration")&.text or return
         %w(final).include? iteration.downcase or /^\d+$/.match(iteration) or
-          @log.add("Document Attributes", nil, "#{iteration} is not a recognised iteration")
+          @log.add("Document Attributes", nil, 
+                   "#{iteration} is not a recognised iteration")
       end
 
       def series_validate(xmldoc)
@@ -48,7 +52,8 @@ module Asciidoctor
         found = false
         SERIES.each { |_, v| found = true if v == series }
         found or
-          @log.add("Document Attributes", nil, "#{series} is not a recognised series")
+          @log.add("Document Attributes", nil, 
+                   "#{series} is not a recognised series")
       end
 
       def validate(doc)
@@ -60,8 +65,9 @@ module Asciidoctor
       def introduction_validate(doc)
         intro = doc.at("//sections/clause/title")
         intro&.text == "Introduction" or
-          @log.add("Style", intro, "First section of document body should be Introduction, "\
-          "not #{intro&.text}")
+          @log.add("Style", intro, 
+                   "First section of document body should be Introduction, "\
+                   "not #{intro&.text}")
       end
 
       REF_SECTIONS_TO_VALIDATE = "//references[not(parent::clause)]/title | "\
@@ -80,8 +86,9 @@ module Asciidoctor
         return if names == ["References"]
         return if names == ["Bibliography"]
         return if names == ["References", "Bibliography"]
-        @log.add("Style", nil, "Reference clauses #{names.join(', ')} do not follow expected "\
-          "pattern in NIST")
+        @log.add("Style", nil, 
+                 "Reference clauses #{names.join(', ')} do not follow "\
+                 "expected pattern in NIST")
       end
     end
   end