metanorma-nist 1.0.3 → 1.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2fe0b9d18da4d89a09e1c33a6299d1b7f222b00768421ac8a35d6cabae0fa2dd
-  data.tar.gz: 2dd93732ce0b519a0b6b11c75f52295cfa3f0dde1d21eb2916dc0c6c35d66cda
+  metadata.gz: 9be11fbdb11ce260e1671031d3c1d3f463d0cfbc049b32dd36d362eeae5163bd
+  data.tar.gz: 346ed9adb971cb651e22b84f335ed6c1a75ec9f3ac4793300972375afe86d634
 SHA512:
-  metadata.gz: d5e2dd3571dc44341fa1d4858221e0b1bb8d2107fd0f77a9bd30f28e73784a5a16b6387259d0302fff066798f034bbde36cebc336f4fafcb8918d737f809d97c
-  data.tar.gz: de51bd7ceed4f8869c0d9bcdb3c5ad8b860090ffb1ed450ab0e3dc996df6f9ffa655b644ef90b1c2d5c1ecf13bb5a4fe4eb898ec29b64208d4c1e89ab51862c3
+  metadata.gz: 5a4b107d57c4a7ba95ad1f57c7fa25626819836cd312ed2693fc1da97b67e636613549ff4631ffc76ae7e5f8c51b8578eaa764f7ba38fba496261606d397c6fa
+  data.tar.gz: 3a022940e4cbad44ac9f1f400697f03815a87c131a1c7d9d651c2ef6ece75ba768dc9dc8e2fc2c1ea008918c99904a2972678bcab4f799b5c108aebeab0f2aa2

data/.github/workflows/macos.yml

@@ -1,12 +1,11 @@
-# Auto-generated !!! Do not edit it manually
-# use ci-master https://github.com/metanorma/metanorma-build-scripts
+# Auto-generated by Cimas: Do not edit it manually!
+# See https://github.com/metanorma/cimas
 name: macos
 
 on:
   push:
     branches: [ master ]
   pull_request:
-    branches: [ '**' ]
 
 jobs:
   test-macos:

data/.github/workflows/ubuntu.yml

@@ -1,12 +1,11 @@
-# Auto-generated !!! Do not edit it manually
-# use ci-master https://github.com/metanorma/metanorma-build-scripts
+# Auto-generated by Cimas: Do not edit it manually!
+# See https://github.com/metanorma/cimas
 name: ubuntu
 
 on:
   push:
     branches: [ master ]
   pull_request:
-    branches: [ '**' ]
 
 jobs:
   test-linux:
@@ -25,7 +24,7 @@ jobs:
           architecture: 'x64'
       - name: Update gems
         run: |
-          gem install bundler 
+          gem install bundler
           bundle install --jobs 4 --retry 3
       - name: Use Node
         uses: actions/setup-node@v1
@@ -37,3 +36,15 @@ jobs:
       - name: Run specs
         run: |
           bundle exec rake
+      - name: Trigger dependent repositories
+        if: github.ref == 'refs/heads/master'
+        env:
+          GH_USERNAME: ${{ secrets.PAT_USERNAME }}
+          GH_ACCESS_TOKEN: ${{ secrets.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
+          do
+            sh trigger-gh-actions.sh $ORGANISATION $repo $GH_USERNAME $GH_ACCESS_TOKEN $GITHUB_REPOSITORY
+          done

data/.github/workflows/windows.yml

@@ -1,12 +1,11 @@
-# Auto-generated !!! Do not edit it manually
-# use ci-master https://github.com/metanorma/metanorma-build-scripts
+# Auto-generated by Cimas: Do not edit it manually!
+# See https://github.com/metanorma/cimas
 name: windows
 
 on:
   push:
     branches: [ master ]
   pull_request:
-    branches: [ '**' ]
 
 jobs:
   test-windows:
@@ -26,7 +25,7 @@ jobs:
       - name: Update gems
         shell: pwsh
         run: |
-          gem install bundler 
+          gem install bundler
           bundle config --local path vendor/bundle
           bundle update
           bundle install --jobs 4 --retry 3

data/README.adoc

@@ -1,8 +1,9 @@
 = 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://travis-ci.com/metanorma/metanorma-nist.svg["Build Status", link="https://travis-ci.com/metanorma/metanorma-nist"]
-image:https://ci.appveyor.com/api/projects/status/vflfr333319tofbi?svg=true["Appveyor Build Status", link="https://ci.appveyor.com/project/metanorma/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://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"]
@@ -640,6 +641,27 @@ Glossaries are given as definition lists with role attribute `[.glossary]`:
 stem:[A= {x_1, x_2, ..., x_k}]:: The alphabet, i.e., the set of all possible symbols that a (digitized) noise source produces.
 ----
 
+=== References
+
+Bibliographies in NIST are contained within annexes:
+
+[source,asciidoctor]
+----
+[appendix]
+== References
+
+LAWS, POLICIES, DIRECTIVES, REGULATIONS, MEMORANDA, STANDARDS, AND GUIDELINES
+
+[bibliography]
+=== Legislation and Executive Orders
+* [[[ref1,1]]] E-Government Act [includes FISMA] (P.L. 107-347), December 2002.
+----
+
+Provided there is only one bibliography in the document, it is automatically titled _References_.
+
+If an annex contains a single bibliography, then the annex and the bibliography are treated as equivalent:
+the bibliography does not have a distinct title.
+
 === Document status
 
 The following table illustrates how transitions between stages of NIST documents are indicated
@@ -755,10 +777,4 @@ line breaks:
 
 == Examples
 
-////
-* link:spec/examples/rfc6350.adoc[] is an Metanorma AsciiDoc version of https://tools.ietf.org/html/rfc6350[RFC 6350].
-* link:spec/examples/rfc6350.html[] is an HTML file generated from the Asciidoctor.
-* link:spec/examples/rfc6350.doc[] is a Word document generated from the Asciidoctor.
-
-////
-
+See https://gitlab.com/metanorma/mn-samples-nist (private repository)

data/lib/asciidoctor/nist/biblio.rng

@@ -703,21 +703,11 @@
   </define>
   <define name="TypedTitleString">
     <optional>
-      <attribute name="type">
-        <ref name="TitleType"/>
-      </attribute>
+      <attribute name="type"/>
     </optional>
     <ref name="FormattedString"/>
   </define>
-  <define name="TitleType">
-    <choice>
-      <value>alternative</value>
-      <value>original</value>
-      <value>unofficial</value>
-      <value>subtitle</value>
-      <value>main</value>
-    </choice>
-  </define>
+  <!-- TitleType = ( "alternative" | "original" | "unofficial" | "subtitle" | "main" ) -->
   <define name="TypedUri">
     <optional>
       <attribute name="type"/>

data/lib/asciidoctor/nist/converter.rb

@@ -109,7 +109,7 @@ module Asciidoctor
           word_converter(node).convert filename unless node.attr("nodoc")
           pdf_converter(node).convert filename unless node.attr("nodoc")
         end
-        @log.write(@filename + ".err") unless @novalid
+        @log.write(@localdir + @filename + ".err") unless @novalid
         @files_to_delete.each { |f| FileUtils.rm f }
         ret
       end

data/lib/asciidoctor/nist/isodoc.rng

@@ -101,9 +101,7 @@
         <ref name="structuredidentifier"/>
       </zeroOrMore>
     </define>
-    <define name="TitleType">
-      <text/>
-    </define>
+    <!-- TitleType = text -->
     <define name="sections">
       <element name="sections">
         <oneOrMore>

data/lib/asciidoctor/nist/nist.rng

@@ -12,15 +12,7 @@
     <define name="DocumentType">
       <value>standard</value>
     </define>
-    <define name="TitleType">
-      <choice>
-        <value>alternative</value>
-        <value>original</value>
-        <value>unofficial</value>
-        <value>subtitle</value>
-        <value>main</value>
-      </choice>
-    </define>
+    <!-- TitleType = ( "alternative" | "original" | "unofficial" | "subtitle" | "main" ) -->
     <define name="preface">
       <element name="preface">
         <optional>

data/lib/isodoc/nist/base_convert.rb

@@ -208,7 +208,7 @@ module IsoDoc
       def bibliography_parse(node, out)
         title = node&.at(ns("./title"))&.text || ""
         out.div do |div|
-          unless node.parent.name == "annex"
+          unless suppress_biblio_title(node)
             anchor(node['id'], :label, false) and
           clause_parse_title(node, div, node.at(ns("./title")), out) or
             div.h2 title, **{ class: "Section3" }
@@ -217,6 +217,16 @@ module IsoDoc
         end
       end
 
+      def suppress_biblio_title(node)
+        return false unless node.parent.name == "annex"
+        return false if node.parent.xpath("./references | ./clause | "\
+                                          "./terms | ./definitions").size > 1
+        title1 = node&.at(ns("./title"))&.text
+        return true unless title1
+        title2 = node&.parent&.at(ns("./title"))&.text
+        title1&.casecmp(title2) == 0
+      end
+
       def foreword(isoxml, out)
         f = isoxml.at(ns("//foreword")) || return
         out.div **attr_code(id: f["id"]) do |s|

data/lib/isodoc/nist/metadata.rb

@@ -37,10 +37,10 @@ module IsoDoc
       def author(ixml, _out)
         tc = ixml.at(ns("//bibdata/ext/editorialgroup/committee"))
         set(:tc, tc.text.upcase) if tc
-        personal_authors(ixml)
         subdiv = ixml.at(ns("//bibdata/contributor[role/@type = 'publisher']/"\
                             "organization/subdivision")) and
                            set(:nist_subdiv, subdiv.text)
+        super
       end
 
       def version(ixml, _out)
@@ -86,7 +86,8 @@ module IsoDoc
       end
 
       def withdrawal_pending(ixml)
-        d = ixml&.at(ns("//bibdata/date[@type = 'obsoleted']"))&.text or return
+        d = ixml&.at(ns("//bibdata/date[@type = 'obsoleted']"))&.text&.strip or return
+        d += "-01" if /^\d\d\d\d-\d\d$/.match(d)
         date = Date.parse(d) or return
         set(:withdrawal_pending, true) if date > Date.today
       end
@@ -109,18 +110,15 @@ module IsoDoc
                           "title"))&.text and set(:subseries, subs)
       end
 
-      def monthyr(isodate)
-        return nil if isodate.nil?
-        DateTime.parse(isodate).localize(:en).to_additional_s("yMMMM")
-      end
-
       def mmddyyyy(isodate)
         return nil if isodate.nil?
+        isodate += "-01" if /^\d\d\d\d-\d\d$/.match(isodate)
         Date.parse(isodate).strftime("%m-%d-%Y")
       end
 
       def MMMddyyyy(isodate)
         return nil if isodate.nil?
+        isodate += "-01" if /^\d\d\d\d-\d\d$/.match(isodate)
         Date.parse(isodate).strftime("%B %d, %Y")
       end
 

data/lib/isodoc/nist/render.rb

@@ -93,7 +93,7 @@ module Iso690Render
   def self.standardidentifier(doc)
     ret = []
     doc.xpath("./docidentifier").each do |id|
-      next if %w(nist-mr nist-long).include? id["type"]
+      next if %w(nist-mr nist-long metanorma rfc-anchor).include? id["type"]
       ret << standardidentifier1(id)
     end
     ret.join(". ")
@@ -207,7 +207,6 @@ module Iso690Render
     else
       ret += embedded ? wrap(creatornames(doc), "", "") : wrap(creatornames(doc), "", "")
     end
-
     if dr
       mdy = MMMddyyyy(date(doc)) and ret += wrap(mdy, " (", ")")
     else

data/lib/isodoc/nist/render_dates.rb

@@ -54,6 +54,7 @@ module Iso690Render
 
   def self.MMMddyyyy(isodate)
     return nil if isodate.nil?
+    return isodate if isodate == "--"
     arr = isodate.split("-")
     date = if arr.size == 1 and (/^\d+$/.match isodate)
              Date.new(*arr.map(&:to_i)).strftime("%Y")

data/lib/isodoc/nist/xrefs.rb

@@ -77,7 +77,8 @@ module IsoDoc
           annex_names1(c, "#{num}.#{i + 1}", 2)
         end
         clause.xpath(ns("./terms | ./term | ./references")).each_with_index do |c, i|
-          annex_names1(c, "#{num}", 1)
+          suppress_biblio_title(c) ?
+            annex_names1(c, "#{num}", 1) : annex_names1(c, "#{num}.#{i + 1}", 2)
         end
         hierarchical_asset_names(clause, num)
       end

data/lib/metanorma/nist/version.rb

@@ -1,5 +1,5 @@
 module Metanorma
   module NIST
-    VERSION = "1.0.3"
+    VERSION = "1.0.4"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: metanorma-nist
 version: !ruby/object:Gem::Version
-  version: 1.0.3
+  version: 1.0.4
 platform: ruby
 authors:
 - Ribose Inc.
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-03-20 00:00:00.000000000 Z
+date: 2020-04-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: htmlentities