metanorma-nist 1.0.6 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d4718e306a8584f427aa244ce10552c267eca1310510e99981582dc7d028ba3d
-  data.tar.gz: 4c976e465bfbd218bd3b02577ce2a2ee64b031cec48a5168a717d91f04cc6698
+  metadata.gz: '05109623d4ab89934b15717692765c6c29015007695efad9ea8258b81d1e956c'
+  data.tar.gz: f848bb3f40e50382a2bfeca5f2bd89a78d06d7808bbb3aa4e01d3ce88a8cb87e
 SHA512:
-  metadata.gz: ca687ca19884fd7aa3d63e174811448a8bc2380a60721bdb39d87c76d6a93951223bb27f70f4f54d422476f82255606fcc798cb0f3734a937472391a09e551f1
-  data.tar.gz: 5cd16e3ed0dd3bd4f9b6655f50e184c6499fd784599436b3d81a2e422e90d69505ece3bcdc1b9f08118588ff03d14e48e784686baa523048279ac8b0dd575c69
+  metadata.gz: 5b3e0c43ab7a515b8dcba5a6c988254d361934a87091dca35a9134b3d51833c463126695bc2ebee8a3c1430b309210fd08adc8efec6e1ddce727dd2a9c96ad28
+  data.tar.gz: edc0d9b4b5aa9b8fe2c98a7369cfec29a44a93a3b4808dfb95b8eb618aa6ff7ada7e0110190bb84cf35355fbcb4497c84827ddbd0eb540aeba2a3389525fd20d

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

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

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

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>
@@ -1001,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">

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

@@ -97,21 +97,12 @@ module Asciidoctor
         super
       end
 
-      def document(node)
-        init(node)
-        ret1 = makexml(node)
-        ret = ret1.to_xml(indent: 2)
-        unless node.attr("nodoc") || !node.attr("docfile")
-          filename = node.attr("docfile").gsub(/\.adoc/, ".xml").
-            gsub(%r{^.*/}, "")
-          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")
-        end
-        @log.write(@localdir + @filename + ".err") unless @novalid
-        @files_to_delete.each { |f| FileUtils.rm f }
-        ret
+      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")
       end
 
       def clause_parse(attrs, xml, node)
@@ -151,36 +142,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)
@@ -194,8 +161,8 @@ module Asciidoctor
         xml.annex **attr_code(attrs1) do |xml_section|
           xml_section.title { |t| t << "Bibliography" }
           @biblio = true
-          xml.references **attr_code(attrs) do |xml_section|
-            xml_section << node.content
+          xml.references **attr_code(attrs.merge(normative: true)) do |r|
+            r << node.content
           end
         end
         @biblio = false
@@ -227,11 +194,15 @@ module Asciidoctor
         super
       end
 
+      def presentation_xml_converter(node)
+        IsoDoc::NIST::PresentationXMLConvert.new(html_extract_attributes(node))
+      end
+
       def html_converter(node)
         IsoDoc::NIST::HtmlConvert.new(html_extract_attributes(node))
       end
 
-      def word_converter(node)
+      def doc_converter(node)
         IsoDoc::NIST::WordConvert.new(doc_extract_attributes(node))
       end
 

data/lib/asciidoctor/nist/front.rb

@@ -20,6 +20,7 @@ module Asciidoctor
       def metadata_version(node, xml)
         xml.edition node.attr("edition") if node.attr("edition")
         xml.edition "Revision #{node.attr("revision")}" if node.attr("revision")
+        xml.edition "Version #{node.attr("version")}" if node.attr("version")
         xml.version do |v|
           v.revision_date node.attr("revdate") if node.attr("revdate")
           v.draft node.attr("draft") if node.attr("draft")

data/lib/asciidoctor/nist/front_id.rb

@@ -1,17 +1,16 @@
+require "iso-639"
+
 module Asciidoctor
   module NIST
     class Converter < Standoc::Converter
       def metadata_id(node, xml)
         did = node.attr("docidentifier")
         dn = node.attr("docnumber")
-        dn = Iso690Render.MMMddyyyy(node.attr("issued-date")) if @series == "nist-cswp" and !dn
-        if did
-          xml.docidentifier did, **attr_code(type: "NIST")
-          xml.docidentifier unabbreviate(did), **attr_code(type: "nist-long")
-        else
-          metadata_id_compose(node, xml, dn)
-        end
-        xml.docnumber node.attr("docnumber")
+        @series == "nist-cswp" && !node.attr("docnumber") and
+          dn = Iso690Render.MMMddyyyy(node.attr("issued-date"))
+        metadata_id_compose(node, xml, dn, did)
+        xml.docnumber node.attr("docnumber") ||
+          did&.sub(/^[^0-9]*/, "")&.sub(/[ -].*$/, "")
       end
 
       def unabbreviate(did)
@@ -21,26 +20,42 @@ module Asciidoctor
       end
 
       def id_args(node, dn0)
+        return nil unless dn0
         {
           id: dn0,
           series: node.attr("series"),
+          edition: node.attr("edition"),
+          version: node.attr("version"),
           revision: node.attr("revision"),
+          update: node.attr("update"),
+          year: (node.attr("copyright-year") || node.attr("updated-date") ||
+                 node.attr("revdate") || node.attr("circulated-date") || 
+                 Date.today.year.to_s).sub(/^(....).*$/, "\\1"),
           vol: node.attr("volume"),
+          part: node.attr("part") || node.attr("part-number"),
+          section: node.attr("section") || node.attr("section-number"),
+          supplement: node.attr("supplement") || node.attr("supplement-number"),
+          index: node.attr("index") || node.attr("index-number"),
           stage: node.attr("status") || node.attr("docstage"),
           iter: node.attr("iteration"),
+          language: node.attr("language") || "en",
           date: /^draft/.match(node.attr("status") || node.attr("docstage")) ?
           (node.attr("circulated-date") || node.attr("revdate")) :
           node.attr("updated-date")
         }
       end
 
-      def metadata_id_compose(node, xml, dn0)
-        return unless dn0
-        args = id_args(node, dn0)
-        xml.docidentifier add_id_parts(args, false), **attr_code(type: "NIST")
-        xml.docidentifier add_id_parts(args, true),
-          **attr_code(type: "nist-long")
-        xml.docidentifier add_id_parts_mr(args), **attr_code(type: "nist-mr")
+      def metadata_id_compose(node, xml, dn0, did)
+        if did
+          xml.docidentifier did, **attr_code(type: "NIST")
+          xml.docidentifier unabbreviate(did), **attr_code(type: "nist-long")
+        else
+          args = id_args(node, dn0) || return
+          xml.docidentifier add_id_parts(args, false), **attr_code(type: "NIST")
+          xml.docidentifier add_id_parts(args, true),
+            **attr_code(type: "nist-long")
+          xml.docidentifier add_id_parts_mr(args), **attr_code(type: "nist-mr")
+        end
       end
 
       def MMMddyyyy(isodate)
@@ -48,26 +63,61 @@ module Asciidoctor
         Date.parse(isodate).strftime("%B %d, %Y")
       end
 
+      def status_abbr(stage, iter)
+        IsoDoc::NIST::Metadata.new(nil, nil, {}).status_abbr(stage, iter)
+      end
+
       def add_id_parts(args, long)
-        vol_delim = " Volume "
-        ed_delim = " Revision "
         args[:series] and series_name = long ?
           SERIES.dig(args[:series].to_sym) :
           SERIES_ABBR.dig(args[:series].to_sym)
         dn = (series_name || "NIST #{args[:series]}")  + " " + args[:id]
-        dn += "#{vol_delim}#{args[:vol]}" if args[:vol]
+        dn += " Volume #{args[:vol]}" if args[:vol]
         dn += "," if args[:vol] && args[:revision]
-        dn += "#{ed_delim}#{args[:revision]}" if args[:revision]
-        stage = IsoDoc::NIST::Metadata.new(nil, nil, {}).status_abbr(args[:stage], args[:iter])
-        dn += " (#{stage})" if stage
+        dn += " Revision #{args[:revision]}" if args[:revision]
+        dn += "/Upd #{args[:update]}:#{args[:year]}" if args[:update]
+        stage = status_abbr(args[:stage], args[:iter]) and dn += " (#{stage})"
         dn += " (#{MMMddyyyy(args[:date])})" if args[:date]
         dn
       end
 
+      def id_parts_mr(args)
+        part = []
+        part << "v-#{args[:vol]}" if args[:vol]
+        part << "pt-#{args[:part]}" if args[:part]
+        part << "sec-#{args[:section]}" if args[:section]
+        part << "sup-#{args[:supplement]}" if args[:supplement]
+        part << "indx-#{args[:index]}" if args[:index]
+        part
+      end
+
+      def id_editions_mr(args)
+        part = []
+        part << "e-#{args[:edition]}" if args[:edition]
+        part << "r-#{args[:revision]}" if args[:revision]
+        part << "ver-#{args[:version]}" if args[:version]
+        part
+      end
+
+      def id_lang_mr(args)
+        ret = args[:language].split(/,\s*/).map do |l|
+          ISO_639.find(l).alpha3
+        end.join(",")
+      end
+
       def add_id_parts_mr(args)
+        ret = ["NIST"]
         args[:series] and
-          name = SERIES_ABBR&.dig(args[:series].to_sym)&.sub(/^NIST /, "")
-        "NIST.#{name}.#{args[:id]}.#{args[:vol]}.#{args[:revision]}.#{args[:date]}"
+          ret << SERIES_ABBR&.dig(args[:series].to_sym)&.sub(/^NIST /, "")
+        stage = status_abbr(args[:stage], nil) || ""
+        stage += "[-#{args[:iter]}]" if args[:iter]
+        ret << stage unless stage.empty?
+        ret << args[:id]
+        ret += id_parts_mr(args)
+        ret += id_editions_mr(args)
+        ret << id_lang_mr(args)
+        args[:update] and ret << "upd-#{args[:update]}:#{args[:year]}"
+        ret.join(".")
       end
     end
   end