metanorma-nist 0.0.9 → 0.1.0

data/lib/asciidoctor/nist/nist.rng

@@ -9,19 +9,6 @@
     <start>
       <ref name="nist-standard"/>
     </start>
-    <define name="btitle">
-      <element name="title">
-        <ref name="TypedTitleString"/>
-      </element>
-    </define>
-    <define name="docidentifier">
-      <element name="docidentifier">
-        <optional>
-          <attribute name="type"/>
-        </optional>
-        <text/>
-      </element>
-    </define>
     <define name="figure">
       <element name="figure">
         <attribute name="id">
@@ -62,9 +49,18 @@
         </choice>
       </element>
     </define>
-    <define name="BibItemType" combine="choice">
+    <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>
     <!-- DocRelationType |= "obsoletedBy" | "supersedes" | "supersededBy" -->
     <define name="DocRelationType">
       <choice>
@@ -107,57 +103,6 @@
         <value>superseded</value>
       </choice>
     </define>
-    <!-- TitleType |= "document-class" -->
-    <define name="TitleType">
-      <choice>
-        <value>alternative</value>
-        <value>original</value>
-        <value>unofficial</value>
-        <value>subtitle</value>
-        <value>main</value>
-        <value>document-class</value>
-        <value>short-title</value>
-        <value>short-subtitle</value>
-      </choice>
-    </define>
-    <define name="editorialgroup">
-      <element name="editorialgroup">
-        <oneOrMore>
-          <ref name="committee"/>
-        </oneOrMore>
-      </element>
-    </define>
-    <define name="stage">
-      <element name="stage">
-        <choice>
-          <value>draft-internal</value>
-          <value>draft-wip</value>
-          <value>draft-prelim</value>
-          <value>draft-public</value>
-          <value>final</value>
-          <value>final-review</value>
-        </choice>
-      </element>
-    </define>
-    <define name="substage">
-      <element name="substage">
-        <choice>
-          <value>active</value>
-          <value>retired</value>
-          <value>withdrawn</value>
-        </choice>
-      </element>
-    </define>
-    <define name="iteration">
-      <element name="iteration">
-        <text/>
-      </element>
-    </define>
-    <define name="title-main">
-      <element name="title-main">
-        <ref name="FormattedString"/>
-      </element>
-    </define>
     <define name="preface">
       <element name="preface">
         <optional>
@@ -218,169 +163,23 @@
         </choice>
       </element>
     </define>
-    <define name="BibData">
+    <define name="BibDataExtensionType">
       <optional>
-        <attribute name="type">
-          <ref name="BibItemType"/>
-        </attribute>
+        <ref name="doctype"/>
       </optional>
       <oneOrMore>
-        <ref name="btitle"/>
+        <ref name="bkeyword"/>
       </oneOrMore>
       <optional>
-        <ref name="formattedref"/>
-      </optional>
-      <zeroOrMore>
-        <ref name="bsource"/>
-      </zeroOrMore>
-      <zeroOrMore>
-        <ref name="nistdocidentifier"/>
-      </zeroOrMore>
-      <optional>
-        <ref name="docnumber"/>
-      </optional>
-      <zeroOrMore>
-        <ref name="bdate"/>
-      </zeroOrMore>
-      <zeroOrMore>
-        <ref name="contributor"/>
-      </zeroOrMore>
-      <optional>
-        <ref name="edition"/>
-      </optional>
-      <optional>
-        <ref name="revision"/>
-      </optional>
-      <optional>
-        <ref name="version"/>
+        <ref name="commentperiod"/>
       </optional>
-      <zeroOrMore>
-        <ref name="biblionote"/>
-      </zeroOrMore>
-      <zeroOrMore>
-        <ref name="language"/>
-      </zeroOrMore>
-      <zeroOrMore>
-        <ref name="script"/>
-      </zeroOrMore>
-      <zeroOrMore>
-        <ref name="abstract"/>
-      </zeroOrMore>
-      <optional>
-        <ref name="status"/>
-      </optional>
-      <ref name="copyright"/>
-      <zeroOrMore>
-        <ref name="docrelation"/>
-      </zeroOrMore>
-      <optional>
-        <ref name="nistseries"/>
-      </optional>
-      <optional>
-        <ref name="nistsubseries"/>
-      </optional>
-      <optional>
-        <ref name="editorialgroup"/>
-      </optional>
-      <zeroOrMore>
-        <ref name="ics"/>
-      </zeroOrMore>
-      <optional>
-        <ref name="security"/>
-      </optional>
-      <oneOrMore>
-        <ref name="keyword"/>
-      </oneOrMore>
-      <ref name="commentperiod"/>
     </define>
   </include>
-  <define name="committee">
-    <element name="committee">
-      <attribute name="type">
-        <choice>
-          <value>technical</value>
-          <value>provisional</value>
-        </choice>
-      </attribute>
-      <text/>
-    </element>
-  </define>
-  <define name="title-sub">
-    <element name="title-sub">
-      <ref name="FormattedString"/>
-    </element>
-  </define>
-  <define name="nistdocidentifier">
-    <element name="docidentifier">
-      <attribute name="type">
-        <choice>
-          <value>nist</value>
-          <value>nist-long</value>
-          <value>nist-mr</value>
-        </choice>
-      </attribute>
-      <text/>
-    </element>
-  </define>
-  <define name="security">
-    <element name="security">
+  <define name="bkeyword">
+    <element name="keyword">
       <text/>
     </element>
   </define>
-  <define name="nistseries">
-    <element name="series">
-      <attribute name="type">
-        <value>main</value>
-      </attribute>
-      <ref name="nistseriestitle"/>
-      <optional>
-        <ref name="abbreviation"/>
-      </optional>
-    </element>
-  </define>
-  <define name="nistsubseries">
-    <element name="series">
-      <attribute name="type">
-        <value>secondary</value>
-      </attribute>
-      <ref name="nistsubseriestitle"/>
-    </element>
-  </define>
-  <define name="nistseriestitle">
-    <element name="title">
-      <choice>
-        <value>NIST Advanced Manufacturing Series</value>
-        <value>NIST Building Science Series</value>
-        <value>NIST Federal Information Processing Standards</value>
-        <value>NIST Grant/Contract Reports</value>
-        <value>NIST Handbook</value>
-        <value>ITL Bulletin</value>
-        <value>Journal of Physical and Chemical Reference Data</value>
-        <value>NIST Journal of Research</value>
-        <value>NIST Letter Circular</value>
-        <value>NIST Monograph</value>
-        <value>NIST National Construction Safety Team Act Reports</value>
-        <value>NIST National Standard Reference Data Series</value>
-        <value>NIST Interagency/Internal Report</value>
-        <value>NIST Product Standards</value>
-        <value>NIST Special Publication</value>
-        <value>NIST Technical Note</value>
-        <value>NIST Other</value>
-        <value>CSRC White Paper</value>
-        <value>CSRC Book</value>
-        <value>CSRC Use Case</value>
-        <value>CSRC Building Block</value>
-      </choice>
-    </element>
-  </define>
-  <define name="nistsubseriestitle">
-    <element name="title">
-      <choice>
-        <value>computer-security</value>
-        <value>information-security</value>
-      </choice>
-    </element>
-  </define>
   <define name="commentperiod">
     <element name="commentperiod">
       <element name="from">
@@ -408,11 +207,6 @@
       <ref name="Basic-Section"/>
     </element>
   </define>
-  <define name="revision">
-    <element name="revision">
-      <text/>
-    </element>
-  </define>
   <define name="nist-standard">
     <element name="nist-standard">
       <ref name="bibdata"/>

data/lib/asciidoctor/nist/reqt.rng

@@ -25,6 +25,11 @@
         <ref name="ObligationType"/>
       </attribute>
     </optional>
+    <optional>
+      <attribute name="unnumbered">
+        <data type="boolean"/>
+      </attribute>
+    </optional>
     <attribute name="id">
       <data type="ID"/>
     </attribute>

data/lib/asciidoctor/nist/validate.rb

@@ -1,24 +1,70 @@
 module Asciidoctor
   module NIST
     class Converter < Standoc::Converter
-       def title_validate(root)
+      def title_validate(root)
         nil
       end
 
-       def validate(doc)
+      def content_validate(doc)
+        super
+        bibdata_validate(doc.root)
+      end
+
+      def bibdata_validate(doc)
+        doctype_validate(doc)
+        stage_validate(doc)
+        substage_validate(doc)
+        iteration_validate(doc)
+        series_validate(doc)
+      end
+
+      def doctype_validate(xmldoc)
+        doctype = xmldoc&.at("//bibdata/ext/doctype")&.text
+        %w(standard).include? doctype or
+          warn "Document Attributes: #{doctype} is not a recognised document type"
+      end
+
+      def stage_validate(xmldoc)
+        stage = xmldoc&.at("//bibdata/status/stage")&.text
+        %w(draft-internal draft-wip draft-prelim draft-public draft-approval
+        final final-review).include? stage or
+        warn "Document Attributes: #{stage} is not a recognised stage"
+      end
+
+      def substage_validate(xmldoc)
+        substage = xmldoc&.at("//bibdata/status/substage")&.text or return
+        %w(active retired withdrawn).include? substage or
+          warn "Document Attributes: #{substage} is not a recognised substage"
+      end
+
+      def iteration_validate(xmldoc)
+        iteration = xmldoc&.at("//bibdata/status/iteration")&.text or return
+        %w(final).include? iteration.downcase or /^\d+$/.match(iteration) or
+          warn "Document Attributes: #{iteration} is not a recognised iteration"
+      end
+
+      def series_validate(xmldoc)
+        series = xmldoc&.at("//bibdata/series/title")&.text or return
+        found = false
+        SERIES.each { |_, v| found = true if v == series }
+        found or
+          warn "Document Attributes: #{series} is not a recognised series"
+      end
+
+      def validate(doc)
         content_validate(doc)
         schema_validate(formattedstr_strip(doc.dup),
                         File.join(File.dirname(__FILE__), "nist.rng"))
       end
 
-       def introduction_validate(doc)
+      def introduction_validate(doc)
         intro = doc.at("//sections/clause/title")
         intro&.text == "Introduction" or
           warn "First section of document body should be Introduction, "\
           "not #{intro&.text}"
       end
 
-       REF_SECTIONS_TO_VALIDATE = "//references[not(parent::clause)]/title | "\
+      REF_SECTIONS_TO_VALIDATE = "//references[not(parent::clause)]/title | "\
         "//clause[descendant::references][not(parent::clause)]/title".freeze
 
       def section_validate(doc)

data/lib/isodoc/nist/base_convert.rb

@@ -35,7 +35,7 @@ module IsoDoc
           patent = ["Call for Patent Claims", "Patent Disclosure Notice"].include? title&.text
           out.div **attr_code(id: c["id"]) do |s|
             page_break(s) if patent
-            clause_name(get_anchors[c['id']][:label], title&.content, s,
+            clause_name(anchor(c['id'], :label), title&.content, s,
                         class: (c.name == "executivesummary") ? "NormalTitle" :
                         "IntroTitle")
             c.elements.reject { |c1| c1.name == "title" }.each do |c1|
@@ -70,9 +70,10 @@ module IsoDoc
 
       def requirement_cleanup(docxml)
         docxml.xpath("//div[@class = 'recommend' or @class = 'require' "\
-                     "or @class = 'permission'][title]").each do |d|
-          title = d.at("./title")
+                     "or @class = 'permission']").each do |d|
+          title = d.at("./p[@class = 'AdmonitionTitle']") or next
           title.name = "b"
+          title.delete("class")
           n = title.next_element
           n&.children&.first&.add_previous_sibling(" ")
           n&.children&.first&.add_previous_sibling(title.remove)
@@ -146,39 +147,15 @@ module IsoDoc
         end
       end
 
-      def recommendation_parse(node, out)
-        name = node["type"]
-        out.div **{ class: "recommend" } do |t|
-          t.title { |b| b << "Recommendation #{get_anchors[node['id']][:label]}:" }
-          node.children.each do |n|
-            parse(n, t)
-          end
-        end
-      end
-
-      def requirement_parse(node, out)
-        name = node["type"]
-        out.div **{ class: "require" } do |t|
-          t.title { |b| b << "Requirement #{get_anchors[node['id']][:label]}:" }
-          node.children.each do |n|
-            parse(n, t)
-          end
-        end
-      end
-
-      def permission_parse(node, out)
-        name = node["type"]
-        out.div **{ class: "permission" } do |t|
-          t.title { |b| b << "Permission #{get_anchors[node['id']][:label]}:" }
-          node.children.each do |n|
-            parse(n, t)
-          end
-        end
-      end
-
       def errata_parse(node, out)
         out.a **{ name: "errata_XYZZY" }
         out.table **make_table_attr(node) do |t|
+          errata_head(t)
+          errata_body(t, node)
+        end
+      end
+
+      def errata_head(t)
           t.thead do |h|
             h.tr do |tr|
               %w(Date Type Change Pages).each do |hdr|
@@ -186,6 +163,9 @@ module IsoDoc
               end
             end
           end
+      end
+
+      def errata_body(t, node)
           t.tbody do |b|
             node.xpath(ns("./row")).each do |row|
               b.tr do |tr|
@@ -199,7 +179,6 @@ module IsoDoc
               end
             end
           end
-        end
       end
 
       MIDDLE_CLAUSE = "//clause[parent::sections] | "\
@@ -291,7 +270,7 @@ module IsoDoc
 
       def annex_name(annex, name, div)
         div.h1 **{ class: "Annex" } do |t|
-          t << "#{get_anchors[annex['id']][:label]} &mdash; "
+          t << "#{anchor(annex['id'], :label)} &mdash; "
           t.b do |b|
             if @bibliographycount == 1 && annex.at(ns("./references"))
               b << "References"
@@ -379,7 +358,7 @@ module IsoDoc
 
       def omit_docid_prefix(prefix)
         return true if prefix.nil? || prefix.empty?
-        return ["ISO", "IEC", "nist"].include? prefix
+        return ["ISO", "IEC", "NIST"].include? prefix
       end
 
       def nist_reference_format(b, r)