metanorma-nist 1.2.8 → 1.2.13

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 76b612ddae877500cbbc398c12a44867549fa1c987772eb781fc7aa33ac63e2b
-  data.tar.gz: d6def5426449912f9890f09834da5ed430c1fc04958b8c2850d59c5730b7cae7
+  metadata.gz: 6f05d4a7aa6eab8094080eabca5f37047291220bcadd29327fe79dbbdda23e1a
+  data.tar.gz: c22cb715ade934a51e95072988976c83758d414fbe4e38e1ba47686dd3c37991
 SHA512:
-  metadata.gz: 5ce949e7353a14d240b75037b5a68736490a3fd2efe227af16d34ec0b7b1ecb82c689117bc743cc99f33f68a22824d40ed8126516d929de75e14767de2e78bd4
-  data.tar.gz: e077d67bfb18798c77dbd0573e0988771b0a6d273149950c7ba5f11a12f50c17a728c5d978eaee82f716696fcdbe9fd50b29015485f918913cda27059ec71fd9
+  metadata.gz: 12e27e427e31e5eba00a66a1d2b949147577859c557b061c83a7e75ed9ce28ca8cdcfc9b5a39ae7487646b61fa778238c0afd9d770b64ba3990c7f47cb0032b8
+  data.tar.gz: 481e55314eab8e92e83817f9c653103cb44811e670b430b4d6bb5366cfa040394b075afcb8b656471742d54e11e26565975f9de254cdd3003f0592c75f910350

data/.github/workflows/rake.yml

@@ -36,6 +36,9 @@ jobs:
         with:
           ruby-version: ${{ matrix.ruby }}
 
+      - if: matrix.os == 'macos-latest'
+        run: brew install autoconf automake libtool
+
       - uses: actions/cache@v2
         with:
           path: vendor/bundle

data/.rubocop.yml

@@ -4,7 +4,3 @@
 
 inherit_from:
   - https://raw.githubusercontent.com/riboseinc/oss-guides/master/ci/rubocop.yml
-AllCops:
-  TargetRubyVersion: 2.3
-Rails:
-  Enabled: true

data/README.adoc

@@ -299,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
@@ -321,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.
@@ -643,6 +660,9 @@ which will be converted to the tag `nistvariable` in Metanorma XML:
 ----
 ---
 
+In the rest of Metanorma, `{{{ ... }}}` is used to introduce AsciiDoc markup into sourcecode.
+In the NIST flavour, this is done through `{{{{ ... }}}}`
+
 === Errata
 
 Errata are marked up as an Asciidoctor table with role attribute `[.errata]`.

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,13 +729,61 @@
   </define>
   <define name="index">
     <element name="index">
-      <attribute name="primary"/>
       <optional>
-        <attribute name="secondary"/>
+        <attribute name="to">
+          <data type="IDREF"/>
+        </attribute>
+      </optional>
+      <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>
+  </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>
-        <attribute name="tertiary"/>
+        <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 -->

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
@@ -94,13 +96,13 @@ module Asciidoctor
 
       def boilerplate_isodoc(xmldoc)
         conv = super
-        conv.i18n.set(:nist_division, @nistdivision)
-        conv.i18n.set(:nist_division_address, @nistdivisionaddress)
+        conv.i18n.set("nist_division", @nistdivision)
+        conv.i18n.set("nist_division_address", @nistdivisionaddress)
         conv
       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

@@ -16,10 +16,11 @@ module Asciidoctor
         xmldoc.xpath("//sourcecode").each do |x|
           x.traverse do |n|
             next unless n.text?
-            n.replace(Nokogiri::XML::NodeSet.new(n.document,
-                                                 nistvariable_insert(n)))
+            next unless /\{\{\{/.match(n.text)
+            n.replace(Nokogiri::XML::NodeSet.new(n.document, nistvariable_insert(n)))
           end
         end
+        super
       end
 
       # skip annex/terms/terms, which is empty node
@@ -72,7 +73,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

@@ -62,7 +62,7 @@ module Asciidoctor
       end
 
       def olist(node)
-        id = Asciidoctor::Standoc::Utils::anchor_or_uuid(node)
+        id = Metanorma::Utils::anchor_or_uuid(node)
         noko do |xml|
           xml.ol **attr_code(id: id, class: node.attr("class")) do |xml_ol|
             node.items.each { |item| li(xml_ol, item) }
@@ -72,7 +72,7 @@ module Asciidoctor
 
       def glossary(node)
         noko do |xml|
-          xml.dl **{id: Asciidoctor::Standoc::Utils::anchor_or_uuid(node),
+          xml.dl **{id: Metanorma::Utils::anchor_or_uuid(node),
                     type: "glossary"} do |xml_dl|
             node.items.each do |terms, dd|
               dt(terms, xml_dl)
@@ -103,7 +103,10 @@ 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
+        @sourcecode_markup_start = node.attr("sourcecode-markup-start") || "{{{{"
+        @sourcecode_markup_end = node.attr("sourcecode-markup-end") || "}}}}"
       end
 
       def outputs(node, ret)

data/lib/asciidoctor/nist/front.rb

@@ -21,7 +21,7 @@ module Asciidoctor
       end
 
       def asciidoc_sub(text)
-        Asciidoctor::Standoc::Utils::asciidoc_sub(text)
+        Metanorma::Utils::asciidoc_sub(text)
       end
 
       def title_subtitle(node, t, at)
@@ -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

data/lib/asciidoctor/nist/front_id.rb

@@ -24,6 +24,9 @@ module Asciidoctor
         {
           id: dn0,
           series: node.attr("series"),
+          subseries: node.attr("series-title") || node.attr("series-abbrev"),
+          subseries_abbr: node.attr("series-abbrev"),
+          subseries_mr: node.attr("series-mrprefix") || node.attr("series-abbrev"),
           edition: node.attr("edition"),
           version: node.attr("version"),
           revision: node.attr("revision"),
@@ -52,8 +55,7 @@ module Asciidoctor
         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(args, true), **attr_code(type: "nist-long")
           xml.docidentifier add_id_parts_mr(args), **attr_code(type: "nist-mr")
         end
       end
@@ -67,10 +69,20 @@ module Asciidoctor
         IsoDoc::NIST::Metadata.new(nil, nil, @i18n).status_abbr(stage, iter)
       end
 
+      def id_series_name(args, type)
+        if args[:series] == "nist-csts"
+          return ret = case type
+                       when :long then args[:subseries] 
+                       when :short then args[:subseries_abbr]
+                       when :mr then args[:subseries_mr]
+                       end
+        end
+        type == :long ?
+          SERIES.dig(args[:series].to_sym) : SERIES_ABBR.dig(args[:series].to_sym)
+      end
+
       def add_id_parts(args, long)
-        args[:series] and series_name = long ?
-          SERIES.dig(args[:series].to_sym) :
-          SERIES_ABBR.dig(args[:series].to_sym)
+        args[:series] and series_name = id_series_name(args, (long ? :long : :short))
         dn = (series_name || "NIST #{args[:series]}")  + " " + args[:id]
         dn += " Volume #{args[:vol]}" if args[:vol]
         dn += "," if args[:vol] && args[:revision]
@@ -107,8 +119,7 @@ module Asciidoctor
 
       def add_id_parts_mr(args)
         ret = ["NIST"]
-        args[:series] and
-          ret << SERIES_ABBR&.dig(args[:series].to_sym)&.sub(/^NIST /, "")
+        args[:series] and ret << id_series_name(args, :mr)&.sub(/^NIST /, "")
         stage = status_abbr(args[:stage], nil) || ""
         stage += "[-#{args[:iter]}]" if args[:iter]
         ret << stage unless stage.empty?