metanorma-nist 1.2.11 → 1.2.16

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a863e95b5d96fb7716f7d124404590f3bc1ed01eb6def1a29270d20dba88946c
-  data.tar.gz: 0eab5f2b4444a27583679a1b36ecb77054d2d6983f0e2fc24ba50feb0bef76b3
+  metadata.gz: 4580e1420646d3ff63309546c46de0031750698c6cf68930dd67a360f0201484
+  data.tar.gz: 859aeab56c957b83de78147e3c721a579ae6b65a2d10f69f62ebfa653f338a95
 SHA512:
-  metadata.gz: 15fbad057288628de2ddb1807caae07799d66757312ea6ff4de5edb548b80476dea3286cc896f435b84169c5a457b9b9c98d130166ab04084b07f13c883d32dc
-  data.tar.gz: 90430efbb2d72e3eb967d19dd894923c7424a22c5a133b6bbd51484695f449594cefefef936814f6631eaa6d640ab87d66dd547cea74d2b787e663c411441fb7
+  metadata.gz: bcb49ab1eab50871f69e6a5b824235a509dce74c48796555843daf636ad5177fa1b475b9f8a972494ac2656df209f737c91c9b549db01feb1b3429f4fadb46c4
+  data.tar.gz: 2120dbc9485b036496155fcc93275e4ae95f35f11b2f29f21c530fae9b7944e643b3aac4c329263796cae6bf52da01dc5565719fa751b5a8bcd9c8a8f497bed5

data/.github/workflows/rake.yml

@@ -4,7 +4,7 @@ name: rake
 
 on:
   push:
-    branches: [ master, main  ]
+    branches: [ master, main ]
     tags: [ v* ]
   pull_request:
 
@@ -16,50 +16,27 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        ruby: [ '2.6', '2.5', '2.4' ]
+        ruby: [ '2.7', '2.6', '2.5', '2.4' ]
         os: [ ubuntu-latest, windows-latest, macos-latest ]
         experimental: [ false ]
         include:
-          - ruby: '2.7'
+          - ruby: '3.0'
             os: 'ubuntu-latest'
             experimental: true
-          - ruby: '2.7'
+          - ruby: '3.0'
             os: 'windows-latest'
             experimental: true
-          - ruby: '2.7'
+          - ruby: '3.0'
             os: 'macos-latest'
             experimental: true
     steps:
-      - uses: actions/checkout@master
+      - uses: actions/checkout@v2
+        with:
+          submodules: true
 
       - uses: ruby/setup-ruby@v1
         with:
           ruby-version: ${{ matrix.ruby }}
-
-      - if: matrix.os == 'macos-latest'
-        run: brew install autoconf automake libtool
-
-      - 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
+          bundler-cache: true
 
       - 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/.gitignore

@@ -0,0 +1 @@
+.rubocop-https--*

data/.rubocop.yml

@@ -1,10 +1,14 @@
 # This project follows the Ribose OSS style guide.
 # https://github.com/riboseinc/oss-guides
 # All project-specific additions and overrides should be specified in this file.
-
 inherit_from:
   - https://raw.githubusercontent.com/riboseinc/oss-guides/master/ci/rubocop.yml
+
+# local repo-specific modifications
+
 AllCops:
-  TargetRubyVersion: 2.3
+  DisplayCopNames: false
+  StyleGuideCopsOnly: false
+  TargetRubyVersion: 2.4
 Rails:
   Enabled: true

data/README.adoc

@@ -660,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

@@ -729,9 +729,11 @@
   </define>
   <define name="index">
     <element name="index">
-      <attribute name="to">
-        <data type="IDREF"/>
-      </attribute>
+      <optional>
+        <attribute name="to">
+          <data type="IDREF"/>
+        </attribute>
+      </optional>
       <element name="primary">
         <oneOrMore>
           <ref name="PureTextElement"/>

data/lib/asciidoctor/nist/biblio.rng

@@ -124,7 +124,7 @@
           <value>application/tei+xml</value>
           <value>text/x-asciidoc</value>
           <value>text/markdown</value>
-          <value>application/x-isodoc+xml</value>
+          <value>application/x-metanorma+xml</value>
           <text/>
         </choice>
       </attribute>
@@ -452,6 +452,7 @@
       <attribute name="type">
         <choice>
           <value>isni</value>
+          <value>orcid</value>
           <value>uri</value>
         </choice>
       </attribute>
@@ -461,10 +462,7 @@
   <define name="org-identifier">
     <element name="identifier">
       <attribute name="type">
-        <choice>
-          <value>orcid</value>
-          <value>uri</value>
-        </choice>
+        <data type="string" datatypeLibrary=""/>
       </attribute>
       <text/>
     </element>
@@ -1106,7 +1104,7 @@
       <value>complementOf</value>
       <value>obsoletes</value>
       <value>obsoletedBy</value>
-      <value>cited</value>
+      <value>cites</value>
       <value>isCitedIn</value>
     </choice>
   </define>

data/lib/asciidoctor/nist/boilerplate.rb

@@ -96,8 +96,8 @@ 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
 

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

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)
@@ -105,6 +105,8 @@ module Asciidoctor
         @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)

data/lib/asciidoctor/nist/isodoc.rng

@@ -102,7 +102,7 @@
           </attribute>
         </optional>
         <oneOrMore>
-          <ref name="li"/>
+          <ref name="ul_li"/>
         </oneOrMore>
         <zeroOrMore>
           <ref name="note"/>
@@ -789,6 +789,9 @@
       <attribute name="width"/>
     </element>
   </define>
+  <define name="BibItemType" combine="choice">
+    <value>internal</value>
+  </define>
   <define name="TextElement" combine="choice">
     <ref name="concept"/>
   </define>
@@ -809,6 +812,8 @@
       <ref name="requirement"/>
       <ref name="recommendation"/>
       <ref name="permission"/>
+      <ref name="imagemap"/>
+      <ref name="svgmap"/>
     </choice>
   </define>
   <define name="bibliography">
@@ -914,6 +919,9 @@
         </choice>
       </attribute>
       <ref name="bibdata"/>
+      <optional>
+        <ref name="misccontainer"/>
+      </optional>
       <optional>
         <ref name="boilerplate"/>
       </optional>
@@ -924,11 +932,21 @@
       <zeroOrMore>
         <ref name="annex"/>
       </zeroOrMore>
+      <optional>
+        <ref name="bibliography"/>
+      </optional>
       <zeroOrMore>
-        <ref name="references"/>
+        <ref name="indexsect"/>
       </zeroOrMore>
     </element>
   </define>
+  <define name="misccontainer">
+    <element name="misc-container">
+      <oneOrMore>
+        <ref name="AnyElement"/>
+      </oneOrMore>
+    </element>
+  </define>
   <define name="preface">
     <element name="preface">
       <oneOrMore>
@@ -952,6 +970,11 @@
       <ref name="Content-Section"/>
     </element>
   </define>
+  <define name="indexsect">
+    <element name="indexsect">
+      <ref name="Content-Section"/>
+    </element>
+  </define>
   <define name="boilerplate">
     <element name="boilerplate">
       <optional>
@@ -1632,4 +1655,87 @@
       <text/>
     </element>
   </define>
+  <define name="imagemap">
+    <element name="imagemap">
+      <ref name="figure"/>
+      <zeroOrMore>
+        <element name="area">
+          <attribute name="type">
+            <choice>
+              <value>rect</value>
+              <value>circle</value>
+              <value>ellipse</value>
+              <value>poly</value>
+            </choice>
+          </attribute>
+          <choice>
+            <ref name="xref"/>
+            <ref name="hyperlink"/>
+            <ref name="eref"/>
+          </choice>
+          <oneOrMore>
+            <element name="coords">
+              <attribute name="x">
+                <data type="float"/>
+              </attribute>
+              <attribute name="y">
+                <data type="float"/>
+              </attribute>
+            </element>
+          </oneOrMore>
+          <optional>
+            <element name="radius">
+              <attribute name="x">
+                <data type="float"/>
+              </attribute>
+              <optional>
+                <attribute name="y">
+                  <data type="float"/>
+                </attribute>
+              </optional>
+            </element>
+          </optional>
+        </element>
+      </zeroOrMore>
+    </element>
+  </define>
+  <define name="svgmap">
+    <element name="svgmap">
+      <ref name="figure"/>
+      <zeroOrMore>
+        <element name="target">
+          <attribute name="href">
+            <data type="anyURI"/>
+          </attribute>
+          <choice>
+            <ref name="xref"/>
+            <ref name="hyperlink"/>
+            <ref name="eref"/>
+          </choice>
+        </element>
+      </zeroOrMore>
+    </element>
+  </define>
+  <define name="ul_li">
+    <element name="li">
+      <optional>
+        <attribute name="id">
+          <data type="ID"/>
+        </attribute>
+      </optional>
+      <optional>
+        <attribute name="uncheckedcheckbox">
+          <data type="boolean"/>
+        </attribute>
+      </optional>
+      <optional>
+        <attribute name="checkedcheckbox">
+          <data type="boolean"/>
+        </attribute>
+      </optional>
+      <oneOrMore>
+        <ref name="BasicBlock"/>
+      </oneOrMore>
+    </element>
+  </define>
 </grammar>

data/lib/asciidoctor/nist/nist.rng

@@ -194,6 +194,9 @@
       <zeroOrMore>
         <ref name="termdocsource"/>
       </zeroOrMore>
+      <optional>
+        <ref name="misccontainer"/>
+      </optional>
       <optional>
         <ref name="boilerplate"/>
       </optional>
@@ -207,6 +210,9 @@
       <optional>
         <ref name="bibliography"/>
       </optional>
+      <zeroOrMore>
+        <ref name="indexsect"/>
+      </zeroOrMore>
     </element>
   </define>
 </grammar>

data/lib/asciidoctor/nist/nist_intro.xml

@@ -6,21 +6,21 @@
     <p>
     {%- if substage == "retired" or substage == "withdrawn" -%}
     {%- if unpublished -%}
-    {%- if substage == "retired" %}{{draft-retired-boilerplate}}{% else %}{{draft-withdrawn-boilerplate}}{% endif -%}  
+    {%- if substage == "retired" %}{{labels["draft-retired-boilerplate"]}}{% else %}{{labels["draft-withdrawn-boilerplate"]}}{% endif -%}  
     {%- else -%}
-    {%- if withdrawal_pending %}{{ withdrawal-pending-boilerplate}}{% else %}{{ publication-withdrawn-boilerplate }}{% endif -%}
+    {%- if withdrawal_pending %}{{ labels["withdrawal-pending-boilerplate"]}}{% else %}{{ labels["publication-withdrawn-boilerplate"] }}{% endif -%}
     {%- endif -%}
     {%- else -%}
     {%- if status == "Internal Draft" -%}
-    {{- draft-internal-boilerplate -}}
+    {{- labels["draft-internal-boilerplate"] -}}
     {%- elsif status == "Work-in-Progress Draft" -%}
-    {{- draft-wip-boilerplate -}}
+    {{- labels["draft-wip-boilerplate"] -}}
     {%- elsif status == "Preliminary Draft" -%}
-    {{- draft-prelim-boilerplate -}}
+    {{- labels["draft-prelim-boilerplate"] -}}
     {%- elsif status == "Public Draft" -%}
-    {{- draft-public-boilerplate -}}
+    {{- labels["draft-public-boilerplate"] -}}
     {%- elsif status == "Approval Draft" -%}
-    {{- draft-public-boilerplate -}}
+    {{- labels["draft-public-boilerplate"] -}}
     {%- endif -%}
     {%- endif -%}
   </p>
@@ -78,8 +78,8 @@ CODEN: NSPUE2</p>
   <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/>
+  Attn: {{ labels["nist_division"] }} <br/>
+  {{ labels["nist_division_address"] }} <br/>
   {% if email %}
   Email: <link target="mailto:{{ email }}"/>
   {% endif %}</p>