metanorma-nist 1.2.6 → 1.2.11

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 87d9c7be14355912b02f7f0dc22c25c4fc232911a18c6d5c41b95df158592314
-  data.tar.gz: dcc54050671bbb3265517009cee8bc5797c952473bd457cd72e0bc26ded1531c
+  metadata.gz: a863e95b5d96fb7716f7d124404590f3bc1ed01eb6def1a29270d20dba88946c
+  data.tar.gz: 0eab5f2b4444a27583679a1b36ecb77054d2d6983f0e2fc24ba50feb0bef76b3
 SHA512:
-  metadata.gz: c23571ad0654a2470b91f7d4704debdd577df11567d37facff8b22b17a76d38c4fe4ef7e61cfd69b01810c9bc8d5c99611d9f922fe63234c74906e88dd569484
-  data.tar.gz: 25a3e238f7c4ebc8003b4276e988388b0d6df536d5867058bc531c04e6f0bed37a54a466f73387caba8cf7d739b9a34eaa4b396da9e0fbdd999609532aa74a34
+  metadata.gz: 15fbad057288628de2ddb1807caae07799d66757312ea6ff4de5edb548b80476dea3286cc896f435b84169c5a457b9b9c98d130166ab04084b07f13c883d32dc
+  data.tar.gz: 90430efbb2d72e3eb967d19dd894923c7424a22c5a133b6bbd51484695f449594cefefef936814f6631eaa6d640ab87d66dd547cea74d2b787e663c411441fb7

data/.github/workflows/rake.yml

@@ -4,7 +4,8 @@ name: rake
 
 on:
   push:
-    branches: [ master ]
+    branches: [ master, main  ]
+    tags: [ v* ]
   pull_request:
 
 jobs:
@@ -31,14 +32,34 @@ jobs:
     steps:
       - uses: actions/checkout@master
 
-      - name: Use Ruby
-        uses: ruby/setup-ruby@v1
+      - uses: ruby/setup-ruby@v1
         with:
           ruby-version: ${{ matrix.ruby }}
-          bundler-cache: true
 
-      - name: Update gems
-        run: bundle install --jobs 4 --retry 3
+      - if: matrix.os == 'macos-latest'
+        run: brew install autoconf automake libtool
 
-      - name: Run specs
-        run: bundle exec rake
+      - uses: actions/cache@v2
+        with:
+          path: vendor/bundle
+          key: bundle-${{ matrix.os }}-${{ matrix.ruby }}-${{ hashFiles('**/*.gemspec') }}
+          restore-keys: bundle-${{ matrix.os }}-${{ matrix.ruby }}
+
+      - run: bundle config set path 'vendor/bundle'
+
+      - run: bundle install --jobs 4 --retry 3
+
+      - run: bundle exec rake
+
+  tests-passed:
+    needs: rake
+    runs-on: ubuntu-latest
+    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/.github/workflows/release.yml

@@ -0,0 +1,36 @@
+name: release
+
+on:
+  push:
+    tags:
+      - '*'
+
+jobs:
+  release:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v1
+
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: '2.6'
+
+      - uses: actions/cache@v1
+        with:
+          path: vendor/bundle
+          restore-keys: bundle-ubuntu-latest-2.6
+
+      - run: bundle exec rake
+
+      - name: publish
+        env:
+          GITHUB_PACKAGES_TOKEN: ${{ secrets.METANORMA_CI_PAT_TOKEN }}
+        run: |
+          cat << 'EOF' > ~/.gem/credentials
+          ---
+          :github: Bearer ${GITHUB_PACKAGES_TOKEN}
+          EOF
+          chmod 0600 ~/.gem/credentials
+          gem install gem-release
+          gem release --key github --host https://rubygems.pkg.github.com/metanorma
+

data/README.adoc

@@ -1,16 +1,15 @@
 = metanorma-nist: Metanorma processor for the NIST SP 800 document classes
 
 image:https://img.shields.io/gem/v/metanorma-nist.svg["Gem Version", link="https://rubygems.org/gems/metanorma-nist"]
-image:https://github.com/metanorma/metanorma-nist/workflows/macos/badge.svg["Build Status (macOS)", link="https://github.com/metanorma/metanorma-nist/actions?workflow=macos"]
-image:https://github.com/metanorma/metanorma-nist/workflows/ubuntu/badge.svg["Build Status (ubuntu)", link="https://github.com/metanorma/metanorma-nist/actions?workflow=ubuntu"]
-image:https://github.com/metanorma/metanorma-nist/workflows/windows/badge.svg["Build Status (Windows)", link="https://github.com/metanorma/metanorma-nist/actions?workflow=windows"]
+image:https://github.com/metanorma/metanorma-nist/workflows/rake/badge.svg["Build Status", link="https://github.com/metanorma/metanorma-nist/actions?workflow=rake"]
 image:https://codeclimate.com/github/metanorma/metanorma-nist/badges/gpa.svg["Code Climate", link="https://codeclimate.com/github/metanorma/metanorma-nist"]
 image:https://img.shields.io/github/issues-pr-raw/metanorma/metanorma-nist.svg["Pull Requests", link="https://github.com/metanorma/metanorma-nist/pulls"]
 image:https://img.shields.io/github/commits-since/metanorma/metanorma-nist/latest.svg["Commits since latest",link="https://github.com/metanorma/metanorma-nist/releases"]
 
 == Functionality
 
-This gem processes Metanorma documents into the NIST document class.
+This gem processes https://www.metanorma.com[Metanorma documents] following
+a template for generating NIST standards.
 
 It provides the following functions:
 
@@ -300,7 +299,7 @@ Can be a number, or text (e.g. "initial", "final").
 `:series:`:: The publication series that the document belongs to. Legal values are:
 +
 --
-* nist-ams
+*  nist-ams
 *  building-science
 *  nist-fips
 *  nist-gcr
@@ -322,11 +321,28 @@ Can be a number, or text (e.g. "initial", "final").
 *  csrc-use-case
 *  csrc-building-block
 *  nist-cswp
+*  nist-csts
 --
 
 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).
+writing, styling has been provided for `nist-cswp` (Cybersecurity White Papers),
+`nist-csts` (Cybersecurity Technical Specifications, added in v1.2.10), and for `nist-sp` (SP-800).
+
+`:series-title:`:: (Added in v1.2.10) 
+`:series-mrprefix:`:: (Added in v1.2.10) 
+`:series-abbrev:`:: (Added in v1.2.10) The formal documents published by NIST belong to a registered
+list of series, each with a predefined title and abbreviation. Non-formal documents instead belong
+to ad hoc series defined for the purposes of Metanorma, such as `nist-csts`. That particular series
+acts as an umbrella for user-defined series of publications; so when it is used, the user needs to provide
+a title (e.g. "Automated Cryptographic Validation Protocol") and abbreviation (e.g. ACVP) for the user-defined
+series. The user also needs to provide the prefix by which the series will be identified in the machine-readable
+NIST identifier, when it is at variance with the abbreviation.
++
+--
+In this case, CSTS is retained as the primary series of the publication (and all CSTS documents
+are rendered the same way), and ACVP is modelled as a secondary series specific to CSTS. However,
+the series information rendered for the document involves the user-defined series, not CSTS itself.
+--
 
 `:comment-from:`:: The beginning of the period during which comments may be submitted to the NIST
 document draft. ISO-8601 date.

data/lib/asciidoctor/nist/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,15 +729,61 @@
   </define>
   <define name="index">
     <element name="index">
-      <attribute name="primary"/>
+      <attribute name="to">
+        <data type="IDREF"/>
+      </attribute>
+      <element name="primary">
+        <oneOrMore>
+          <ref name="PureTextElement"/>
+        </oneOrMore>
+      </element>
       <optional>
-        <attribute name="secondary"/>
+        <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>
   </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>
+        <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 -->
   <define name="bookmark">
     <element name="bookmark">

data/lib/asciidoctor/nist/boilerplate.rb

@@ -24,6 +24,7 @@ module Asciidoctor
         "csrc-use-case": "CSRC Use Case",
         "csrc-building-block": "CSRC Building Block",
         "nist-cswp": "NIST Cybersecurity White Paper",
+        "nist-csts": "NIST Cybersecurity Technical Specification",
       }.freeze
 
       SERIES_ABBR = {
@@ -49,6 +50,7 @@ module Asciidoctor
         "csrc-use-case": "CSRC Use Case",
         "csrc-building-block": "CSRC Building Block",
         "nist-cswp": "NIST CSWP",
+        "nist-csts": "NIST CSTS",
       }.freeze
 
       CALL_FOR_PATENT_CLAIMS = <<~END.freeze
@@ -100,7 +102,7 @@ module Asciidoctor
       end
 
       def boilerplate_file(xmldoc)
-        File.join(@libdir, @series == "nist-cswp" ? "nist_intro_cswp.xml" : "nist_intro.xml")
+        File.join(@libdir, @cswp ? "nist_intro_cswp.xml" : "nist_intro.xml")
       end
     end
   end

data/lib/asciidoctor/nist/cleanup.rb

@@ -44,6 +44,7 @@ module Asciidoctor
       end
 
       def move_clauses_into_preface1(x, preface)
+        x.xpath("//acknowledgements[@preface]").each { |c| c.delete("preface") }
         x.xpath("//clause[@preface]").each do |c|
           c.delete("preface")
           title = c&.at("./title")&.text.downcase
@@ -71,7 +72,7 @@ module Asciidoctor
       end
 
       def callforpatentclaims(x, preface)
-        return if @series == "nist-cswp"
+        return if @cswp
         if @callforpatentclaims
           docemail = x&.at("//uri[@type = 'email']")&.text || "???"
           docnumber = x&.at("//docnumber")&.text || "???"

data/lib/asciidoctor/nist/converter.rb

@@ -103,6 +103,7 @@ module Asciidoctor
         @nistdivisionaddress = node.attr("nist-division-address") ||
           "100 Bureau Drive (Mail Stop 8930) Gaithersburg, MD 20899-8930"
         @series = node.attr("series")
+        @cswp = %w(nist-cswp nist-csts).include?(@series)
         super
       end
 
@@ -151,6 +152,8 @@ module Asciidoctor
           "terms and definitions"
         when "introduction"
           "donotrecognise_introduction"
+        when "normative references"
+          "bibliography"
         else
           super
         end

data/lib/asciidoctor/nist/front.rb

@@ -29,8 +29,7 @@ module Asciidoctor
         t.title(**attr_code(at.merge(type: "subtitle"))) do |t1|
           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|
+        node.attr("title-sub-short") and t.title(**attr_code(at.merge(type: "short-subtitle"))) do |t1|
           t1 << asciidoc_sub(node.attr("title-sub-short"))
         end
       end
@@ -46,8 +45,7 @@ module Asciidoctor
         t.title(**attr_code(at.merge(type: "main"))) do |t1|
           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|
+        node.attr("title-main-short") and t.title(**attr_code(at.merge(type: "short-title"))) do |t1|
           t1 << asciidoc_sub(node.attr("title-main-short"))
         end
       end
@@ -85,21 +83,16 @@ module Asciidoctor
       end
 
       def metadata_committee(node, xml)
-        return unless node.attr("technical-committee") ||
-          node.attr("subcommittee") ||
+        return unless node.attr("technical-committee") || node.attr("subcommittee") ||
           node.attr("workgroup") || node.attr("workinggroup")
         xml.editorialgroup do |a|
-          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")))
-          (node.attr("workgroup") || node.attr("workinggroup")) and
-            a.workgroup(node.attr("workgroup") || node.attr("workinggroup"),
-                        **attr_code(type: node.attr("workgroup-type"),
-                                    number: node.attr("workgroup-number")))
+          c = node.attr("technical-committee") and a.committee(c)
+          c = node.attr("subcommittee") and
+            a.subcommittee(c, **attr_code(type: node.attr("subcommittee-type"),
+                                          number: node.attr("subcommittee-number")))
+          c = (node.attr("workgroup") || node.attr("workinggroup")) and
+            a.workgroup(c,
+                        **attr_code(type: node.attr("workgroup-type"), number: node.attr("workgroup-number")))
         end
       end
 
@@ -114,16 +107,26 @@ module Asciidoctor
 
       def metadata_source(node, xml)
         super
-        node.attr("doc-email") && xml.uri(node.attr("doc-email"), type: "email")
-        node.attr("doi") && xml.uri(node.attr("doi"), type: "doi")
+        node.attr("doc-email") and xml.uri(node.attr("doc-email"), type: "email")
+        node.attr("doi") and xml.uri(node.attr("doi"), type: "doi")
       end
 
       def metadata_series(node, xml)
         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
-            s.abbreviation SERIES_ABBR.dig(series.to_sym)
+          SERIES_ABBR.dig(series.to_sym) and s.abbreviation SERIES_ABBR.dig(series.to_sym)
+        end
+        metadata_subseries(node, xml)
+      end
+
+      def metadata_subseries(node, xml)
+        title = node.attr("series-title")
+        abbrev = node.attr("series-abbrev")
+        return unless (title || abbrev)
+        xml.series **{ type: "secondary" } do |s|
+          title and s.title title
+          abbrev and s.abbreviation abbrev
         end
       end
 
@@ -143,13 +146,11 @@ 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,29 +167,24 @@ module Asciidoctor
             metadata_superseding_dates(b, node)
             b.status do |s|
               s.stage node.attr("superseding-status")
-              iter = node.attr("superseding-iteration") and
-                s.iteration iter
+              iter = node.attr("superseding-iteration") and s.iteration iter
             end
           end
         end
       end
 
       def metadata_superseding_ids(b, xml)
-        did = xml&.parent&.at("./ancestor::bibdata/docidentifier"\
-                              "[@type = 'NIST']")&.text
-        didl = xml&.parent&.at("./ancestor::bibdata/docidentifier"\
-                               "[@type = 'nist-long']")&.text
+        did = xml&.parent&.at("./ancestor::bibdata/docidentifier[@type = 'NIST']")&.text
+        didl = xml&.parent&.at("./ancestor::bibdata/docidentifier[@type = 'nist-long']")&.text
         b.docidentifier did, **{ type: "NIST" }
         b.docidentifier didl, **{ type: "nist-long" }
       end
 
       def metadata_superseding_dates(b, node)
-        cdate = node.attr("superseding-circulated-date") and
-          b.date **{ type: "circulated" } do |d|
+        cdate = node.attr("superseding-circulated-date") and b.date **{ type: "circulated" } do |d|
           d.on cdate
         end
-        cdate = node.attr("superseding-issued-date") and
-          b.date **{ type: "issued" } do |d|
+        cdate = node.attr("superseding-issued-date") and b.date **{ type: "issued" } do |d|
           d.on cdate
         end
       end
@@ -198,24 +194,21 @@ module Asciidoctor
           b.title **{ type: "main" } do |t|
             t << asciidoc_sub(node.attr("superseding-title"))
           end
-          node.attr("superseding-subtitle") and
-            b.title **{ type: "subtitle" } do |t|
+          node.attr("superseding-subtitle") and b.title **{ type: "subtitle" } do |t|
             t << asciidoc_sub(node.attr("superseding-subtitle"))
           end
         else
           b.title **{ type: "main" } do |t|
             t << (asciidoc_sub(node.attr("title-main")) || node.title)
           end
-          node.attr("title-sub") and
-            b.title **{ type: "subtitle" } do |t|
+          node.attr("title-sub") and b.title **{ type: "subtitle" } do |t|
             t << asciidoc_sub(node.attr("title-sub"))
           end
         end
       end
 
       def metadata_superseding_authors(b, node)
-        node.attr("superseding-authors") and
-          node.attr("superseding-authors").split(/,\s*/).each do |a|
+        node.attr("superseding-authors") and node.attr("superseding-authors").split(/,\s*/).each do |a|
           b.contributor do |c|
             c.role nil, **{ type: "author" }
             c.person do |p|
@@ -228,10 +221,8 @@ module Asciidoctor
       end
 
       def metadata_note(node, xml)
-        note = node.attr("bib-additional-note") and
-          xml.note note, **{ type: "additional-note" }
-        note = node.attr("bib-withdrawal-note") and
-          xml.note note, **{ type: "withdrawal-note" }
+        note = node.attr("bib-additional-note") and xml.note note, **{ type: "additional-note" }
+        note = node.attr("bib-withdrawal-note") and xml.note note, **{ type: "withdrawal-note" }
         note = node.attr("bib-withdrawal-announcement-link") and
           xml.note note, **{ type: "withdrawal-announcement-link" }
       end