metanorma-nist 0.2.3 → 0.2.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d9b324dd09a8d49e7d0f962d8f526c39770127b56a4dc9b2eedd3e34f5003eec
-  data.tar.gz: c41f9cf011e6042a7658a173340d0ec8b83375c3d924a6485c2e382f57e49efb
+  metadata.gz: 1ade7003156424dd8933b9db67420ee3d8d16c5abafb109750a8c48abd7ec87e
+  data.tar.gz: 958c85c11773fd4eb70d0b6604026067e8e48962cda5ed2bdeea73d35916d42e
 SHA512:
-  metadata.gz: 8f87e8f12899a69732ed0830a76166ad2d1147717d5430949631f5c246cd14557ab5add686da89cea525abd7370b7ad0b32b3b955cc834f118c6b44c90dfe5ad
-  data.tar.gz: 750b3102e74993362d5225d23bbf874c30ddf4941810ca4e0faf4dc67577975e721195c1a889b83ab849bc25e32fd4a5a75e7ba634f61e34115cab51ac6b3a49
+  metadata.gz: 46c6f1a1a443e805b5362cd1e16d47d74a05e5586410c08ae989bfd363c5187df4c8062dd317be1cacfee085c2d0fb432c9b2def06496a287e26d242e01e5a85
+  data.tar.gz: 6a960942edd97e79272ab858ae2f3483bb49e8bc64fecfe55e0b627f686aa5495b712cf83f9d6a5ef0f8ac9effedec06f683bbb4bad35c1acd1ea60c5f99c2d4

data/.github/workflows/macos.yml

@@ -0,0 +1,34 @@
+# Auto-generated !!! Do not edit it manually
+# use ci-master https://github.com/metanorma/metanorma-build-scripts
+name: macos
+
+on: [push]
+
+jobs:
+  test-macos:
+    name: Test on Ruby ${{ matrix.ruby }} macOS
+    runs-on: macos-latest
+    strategy:
+      matrix:
+        ruby: [ '2.6', '2.5', '2.4' ]
+    steps:
+      - uses: actions/checkout@master
+      - name: Use Ruby
+        uses: actions/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+          architecture: 'x64'
+      - name: Update gems
+        run: |
+          sudo gem install bundler -v "~> 2" --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

@@ -0,0 +1,34 @@
+# Auto-generated !!! Do not edit it manually
+# use ci-master https://github.com/metanorma/metanorma-build-scripts
+name: ubuntu
+
+on: [push]
+
+jobs:
+  test-linux:
+    name: Test on Ruby ${{ matrix.ruby }} Ubuntu
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby: [ '2.6', '2.5', '2.4' ]
+    steps:
+      - uses: actions/checkout@master
+      - name: Use Ruby
+        uses: actions/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+          architecture: 'x64'
+      - name: Update gems
+        run: |
+          gem install bundler -v "~> 2"
+          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/windows.yml

@@ -0,0 +1,37 @@
+# Auto-generated !!! Do not edit it manually
+# use ci-master https://github.com/metanorma/metanorma-build-scripts
+name: windows
+
+on: [push]
+
+jobs:
+  test-windows:
+    name: Test on Ruby ${{ matrix.ruby }} Windows
+    runs-on: windows-latest
+    strategy:
+      matrix:
+        ruby: [ '2.6', '2.5', '2.4' ]
+    steps:
+      - uses: actions/checkout@master
+      - name: Use Ruby
+        uses: actions/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+          architecture: 'x64'
+      - name: Update gems
+        shell: pwsh
+        run: |
+          gem install bundler -v "~> 2"
+          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

@@ -148,8 +148,12 @@ docnumber-edition (if edition is present)
 `:docidentifier:`:: The document identifier for the document. Normally this should not be supplied,
 as the document identifier is composed from the document series, document number, document volume,
 and edition/revision (e.g. _NIST SP 800 Revision 1_).
+
 If the `:docidentifier:` value is provided, it will override this composed value.
 
+CSWP publications do not have a distinct `:docidentifier:` or `:docnumber:`: they are identified
+by their `:issued-date:`.
+
 `:status:`:: Document status/stage. The permitted types are:
 +
 --
@@ -259,13 +263,13 @@ e.g. "Computer Security" for SP 800.
 publishes the document under.)
 
 `:call-for-patent-claims:`:: Include the Call for Patent Claims in document drafts,
-and the Patent Disclosure Notice in finalised documents.
+and the Patent Disclosure Notice in finalised documents. (Not applicable to CSWP.)
 
 `:commitment-to-licence:`:: Indicate in the Patent Disclosure Notice that
-notice and commitment to license have been received.
+notice and commitment to license have been received. (Not applicable to CSWP.)
 
 `:patent-contact:`:: Contact for the Call for Patent Claims or Patent Disclosure Notice.
-If not supplied, `:doc-email:` is used.
+If not supplied, `:doc-email:` is used. (Not applicable to CSWP.)
 
 `:iteration:`:: The iteration of a stage, in case there have been multiple drafts.
 Can be a number, or text (e.g. "initial", "final").
@@ -294,8 +298,13 @@ Can be a number, or text (e.g. "initial", "final").
 *  csrc-book
 *  csrc-use-case
 *  csrc-building-block
+*  nist-cswp
 --
 
+Documents belonging to different series are expected to be rendered differently. As of this
+writing, styling has been provided for `nist-cswp` (Cybersecurity White Papers) and for 
+`nist-sp` (SP-800).
+
 `:comment-from:`:: The beginning of the period during which comments may be submitted to the NIST
 document draft. ISO-8601 date.
 
@@ -311,7 +320,8 @@ forward. If present, bibliographies are treated in the legacy manner: they are t
 and are given an appendix number according to where in the document they occur.
 
 `:boilerplate-authority:`:: Nominate a Metanorma XML file encoding the authority statement of the document,
-to overwrite the default authority statement included in the gem (link:lib/asciidoctor/nist/nist_intro.xml[]),
+to overwrite the default authority statement included in the gem 
+(link:lib/asciidoctor/nist/nist_intro.xml[], link:lib/asciidoctor/nist/nist_intro_cswp.xml[]),
 in case the document is historical, and needs to be generated with a previous authority statement.
 
 `:obsoletes:`::
@@ -422,15 +432,15 @@ The authority statement in NIST consists of five sections. They are semantically
 XML under the `boilerplate` tag, as subclauses:
 
 `boilerplate/legal-statement/clause[@id = 'authority1']`:: The initial section of the authority section ("This publication has been developed
-by NIST...").
-`boilerplate/legal-statement/clause[@id = 'authority2']`:: The identifier, revision date, and URL of the document.
+by NIST..."). (Not applicable to CSWP.)
+`boilerplate/legal-statement/clause[@id = 'authority2']`:: The identifier, revision date, and URL of the document. (Not applicanble to CSWP.)
 `boilerplate/legal-statement/clasue[@id = 'authority3']`:: The boxed disclaimer statement ("Any mention of commercial products or reference to commercial organizations...")
 `boilerplate/feedback-statement/clause[@id = 'authority4']`:: The public comment period, for drafts
 `boilerplate/feedback-statement/clause[@id = 'authority5']`:: The contact details for comments
 
 The authority statement has been marked up in Metanorma XML rather than Asciidoctor because of its complexity.
 If you wish to supply a different authority statement, you will need to provide a piece of Metanorma XML corresponding
-to the existing default statement (available from link:lib/asciidoctor/nist/nist_intro.xml[]), and containing
+to the existing default statement (available from link:lib/asciidoctor/nist/nist_intro.xml[] and link:lib/asciidoctor/nist/nist_intro_cswp.xml[]), and containing
 text corresponding to the sections given above. You can give the location of your own authority statement file
 relative to the current document through the document attribute `:boilerplate-authority:`.
 

data/lib/asciidoctor/nist/basicdoc.rng

@@ -443,6 +443,9 @@
       <optional>
         <attribute name="subsequence"/>
       </optional>
+      <optional>
+        <ref name="tname"/>
+      </optional>
       <oneOrMore>
         <choice>
           <ref name="formula"/>

data/lib/asciidoctor/nist/boilerplate.rb

@@ -23,6 +23,7 @@ module Asciidoctor
         "csrc-book": "CSRC Book",
         "csrc-use-case": "CSRC Use Case",
         "csrc-building-block": "CSRC Building Block",
+        "nist-cswp": "NIST Cybersecurity White Paper",
       }.freeze
 
       SERIES_ABBR = {
@@ -47,6 +48,7 @@ module Asciidoctor
         "csrc-book": "CSRC Book",
         "csrc-use-case": "CSRC Use Case",
         "csrc-building-block": "CSRC Building Block",
+        "nist-cswp": "NIST CSWP",
       }.freeze
 
       CALL_FOR_PATENT_CLAIMS = <<~END.freeze
@@ -100,7 +102,7 @@ module Asciidoctor
         conv.labels = {nist_division: @nistdivision,
                        nist_division_address: @nistdivisionaddress}
         file = @boilerplateauthority ? "#{@localdir}/#{@boilerplateauthority}" :
-          File.join(File.dirname(__FILE__),"nist_intro.xml")
+          File.join(File.dirname(__FILE__), @series == "nist-cswp" ? "nist_intro_cswp.xml" : "nist_intro.xml")
           conv.populate_template((File.read(file, encoding: "UTF-8")), nil)
       end
     end

data/lib/asciidoctor/nist/cleanup.rb

@@ -75,6 +75,7 @@ module Asciidoctor
       end
 
       def callforpatentclaims(x, preface)
+        return if @series == "nist-cswp"
         if @callforpatentclaims
           docemail = x&.at("//uri[@type = 'email']")&.text || "???"
           docnumber = x&.at("//docnumber")&.text || "???"

data/lib/asciidoctor/nist/converter.rb

@@ -128,6 +128,7 @@ module Asciidoctor
           "Computer Security Division, Information Technology Laboratory"
         @nistdivisionaddress = node.attr("nist-division-address") ||
           "100 Bureau Drive (Mail Stop 8930) Gaithersburg, MD 20899-8930"
+        @series = node.attr("series")
         super
       end
 

data/lib/asciidoctor/nist/front.rb

@@ -4,11 +4,13 @@ require "fileutils"
 
 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"
+      end
 
       def datetypes
         super + %w(abandoned superseded)
@@ -63,6 +65,7 @@ module Asciidoctor
       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")
@@ -124,7 +127,7 @@ module Asciidoctor
 
       def add_id_parts_mr(args)
         args[:series] and
-          name = SERIES_ABBR.dig(args[:series].to_sym).sub(/^NIST /, "")
+          name = SERIES_ABBR&.dig(args[:series].to_sym)&.sub(/^NIST /, "")
         "NIST.#{name}.#{args[:vol]}.#{args[:revision]}.#{args[:date]}"
       end
 
@@ -189,8 +192,7 @@ module Asciidoctor
       end
 
       def metadata_series(node, xml)
-        series = node.attr("series")
-        series || return
+        series = node.attr("series") || "nist-sp"
         series and xml.series **{ type: "main" } do |s|
           s.title (SERIES.dig(series.to_sym) || series)
           SERIES_ABBR.dig(series.to_sym) and

data/lib/asciidoctor/nist/isodoc.rng

@@ -44,6 +44,27 @@
         </oneOrMore>
       </element>
     </define>
+    <define name="references">
+      <element name="references">
+        <optional>
+          <attribute name="id">
+            <data type="ID"/>
+          </attribute>
+        </optional>
+        <optional>
+          <ref name="section-title"/>
+        </optional>
+        <zeroOrMore>
+          <ref name="BasicBlock"/>
+        </zeroOrMore>
+        <zeroOrMore>
+          <ref name="bibitem"/>
+          <zeroOrMore>
+            <ref name="note"/>
+          </zeroOrMore>
+        </zeroOrMore>
+      </element>
+    </define>
   </include>
   <define name="standard-document">
     <element name="standard-document">

data/lib/asciidoctor/nist/nist_intro_cswp.xml

@@ -0,0 +1,45 @@
+<boilerplate>
+  <legal-statement>
+
+<clause id="authority3">
+<title>Disclaimer</title>
+<p>Any mention of commercial products or reference to commercial organizations is for information only; it does not imply recommendation or endorsement by NIST, nor does it imply that the products mentioned are necessarily the best available for the purpose.</p>
+</clause>
+
+<clause id="authority3a">
+  <title>Additional Information</title>
+  <p>For additional information on NIST's Cybersecurity programs, projects and publications, visit the <link target="https://csrc.nist.gov">Computer Security Resource Center</link>. Information on other efforts at <link target="https://www.nist.gov">NIST</link> and in the <link target="https://www.nist.gov/itl">Information Technology Laboratory</link> (ITL) is also available.</p>
+</clause>
+</legal-statement>
+
+<feedback-statement>
+  {% if unpublished %}
+<clause id="authority4">
+{% if comment_extended %}
+<p align="center">[{{ comment_extended}}: Comment period extended]</p>
+{% endif %}
+
+{% if comment_from and comment_to %}
+<p align="center"><strong>Public comment period: <em>{{ comment_from }}</em> through <em>{{comment_to}}</em></strong></p>
+{% else %}
+{% if comment_from %}
+<p align="center"><strong>Public comment period: from <em>{{ comment_from }}</em></strong></p>
+{% endif %}
+{% endif %}
+</clause>
+{% endif %}
+
+<clause id="authority5">
+  <p align="center"><strong>Comments on this publication may be submitted to:</strong></p>
+
+<p align="center">National Institute of Standards and Technology <br/>
+  Attn: {{ nist_division }} <br/>
+  {{ nist_division_address }} <br/>
+  {% if email %}
+  Email: <link target="mailto:{{ email }}"/>
+  {% endif %}</p>
+
+<p align="center">All comments are subject to release under the Freedom of Information Act (FOIA).</p>
+</clause>
+</feedback-statement>
+</boilerplate>

data/lib/isodoc/nist/base_convert.rb

@@ -189,8 +189,13 @@ module IsoDoc
         super
       end
 
+      def wrap_brackets(txt)
+        return txt if /^\[.*\]$/.match txt
+        "[#{txt}]"
+      end
+
       def get_linkend(node)
-        link = anchor_linkend(node, docid_l10n(node["target"] || "[#{node['citeas']}]"))
+        link = anchor_linkend(node, docid_l10n(node["target"] || wrap_brackets(node['citeas'])))
         link += eref_localities(node.xpath(ns("./locality")), link)
         contents = node.children.select { |c| c.name != "locality" }
         return link if contents.nil? || contents.empty?
@@ -222,10 +227,13 @@ module IsoDoc
       def bibliography_parse(node, out)
         title = node&.at(ns("./title"))&.text || ""
         out.div do |div|
-          node.parent.name == "annex" or
+          unless node.parent.name == "annex"
+            anchor(node['id'], :label, false) and
+          clause_parse_title(node, div, node.at(ns("./title")), out) or
             div.h2 title, **{ class: "Section3" }
+          end
           node.elements.reject do |e|
-            ["reference", "title", "bibitem"].include? e.name
+            %w(reference title bibitem note).include? e.name
           end.each { |e| parse(e, div) }
           biblio_list(node, div, true)
         end