metanorma-nist 0.0.8 → 0.0.9

data/lib/asciidoctor/nist/isodoc.rng

@@ -19,27 +19,16 @@
 -->
 <grammar xmlns="http://relaxng.org/ns/structure/1.0" datatypeLibrary="http://www.w3.org/2001/XMLSchema-datatypes">
   <include href="reqt.rng"/>
-  <include href="biblio.rng">
-    <define name="status">
-      <element name="status">
-        <choice>
-          <value>proposal</value>
-          <value>working_draft</value>
-          <value>committee_draft</value>
-          <value>draft_standard</value>
-          <value>final_draft</value>
-          <value>published</value>
-          <value>withdrawn</value>
-        </choice>
-      </element>
-    </define>
-  </include>
+  <include href="biblio.rng"/>
   <start>
     <ref name="standard-document"/>
   </start>
   <define name="standard-document">
     <element name="standard-document">
       <ref name="bibdata"/>
+      <optional>
+        <ref name="boilerplate"/>
+      </optional>
       <optional>
         <ref name="preface"/>
       </optional>
@@ -64,6 +53,42 @@
       </oneOrMore>
     </element>
   </define>
+  <define name="boilerplate">
+    <element name="boilerplate">
+      <optional>
+        <ref name="copyright-statement"/>
+      </optional>
+      <optional>
+        <ref name="license-statement"/>
+      </optional>
+      <optional>
+        <ref name="legal-statement"/>
+      </optional>
+      <optional>
+        <ref name="feedback-statement"/>
+      </optional>
+    </element>
+  </define>
+  <define name="copyright-statement">
+    <element name="copyright-statement">
+      <ref name="Content-Section"/>
+    </element>
+  </define>
+  <define name="license-statement">
+    <element name="license-statement">
+      <ref name="Content-Section"/>
+    </element>
+  </define>
+  <define name="legal-statement">
+    <element name="legal-statement">
+      <ref name="Content-Section"/>
+    </element>
+  </define>
+  <define name="feedback-statement">
+    <element name="feedback-statement">
+      <ref name="Content-Section"/>
+    </element>
+  </define>
   <define name="sections">
     <element name="sections">
       <oneOrMore>
@@ -533,6 +558,9 @@
       <attribute name="id">
         <data type="ID"/>
       </attribute>
+      <optional>
+        <attribute name="alt"/>
+      </optional>
       <optional>
         <ref name="tname"/>
       </optional>
@@ -868,6 +896,9 @@
       <attribute name="type">
         <ref name="ReferenceFormat"/>
       </attribute>
+      <optional>
+        <attribute name="alt"/>
+      </optional>
       <text/>
     </element>
   </define>

data/lib/asciidoctor/nist/isostandard.rng

@@ -268,22 +268,6 @@
         <ref name="FormattedString"/>
       </element>
     </define>
-    <define name="status">
-      <element name="status">
-        <choice>
-          <ref name="FormattedString"/>
-          <group>
-            <ref name="stage"/>
-            <optional>
-              <ref name="substage"/>
-            </optional>
-            <optional>
-              <ref name="iteration"/>
-            </optional>
-          </group>
-        </choice>
-      </element>
-    </define>
     <define name="btitle">
       <element name="title">
         <choice>
@@ -756,6 +740,9 @@
       <zeroOrMore>
         <ref name="termdocsource"/>
       </zeroOrMore>
+      <optional>
+        <ref name="boilerplate"/>
+      </optional>
       <ref name="preface"/>
       <oneOrMore>
         <ref name="sections"/>
@@ -817,40 +804,6 @@
       <ref name="Content-Section"/>
     </element>
   </define>
-  <define name="stage">
-    <element name="stage">
-      <choice>
-        <value>00</value>
-        <value>10</value>
-        <value>20</value>
-        <value>30</value>
-        <value>40</value>
-        <value>50</value>
-        <value>60</value>
-        <value>90</value>
-        <value>95</value>
-      </choice>
-    </element>
-  </define>
-  <define name="substage">
-    <element name="substage">
-      <choice>
-        <value>00</value>
-        <value>20</value>
-        <value>60</value>
-        <value>90</value>
-        <value>92</value>
-        <value>93</value>
-        <value>98</value>
-        <value>99</value>
-      </choice>
-    </element>
-  </define>
-  <define name="iteration">
-    <element name="iteration">
-      <data type="int"/>
-    </element>
-  </define>
   <define name="documentnumber">
     <element name="project-number">
       <optional>

data/lib/asciidoctor/nist/nist.rng

@@ -62,17 +62,6 @@
         </choice>
       </element>
     </define>
-    <define name="status">
-      <element name="status">
-        <ref name="stage"/>
-        <optional>
-          <ref name="substage"/>
-        </optional>
-        <optional>
-          <ref name="iteration"/>
-        </optional>
-      </element>
-    </define>
     <define name="BibItemType" combine="choice">
       <value>standard</value>
     </define>
@@ -171,7 +160,6 @@
     </define>
     <define name="preface">
       <element name="preface">
-        <ref name="authority"/>
         <optional>
           <ref name="preface_abstract"/>
         </optional>
@@ -420,32 +408,6 @@
       <ref name="Basic-Section"/>
     </element>
   </define>
-  <define name="authority">
-    <element name="authority">
-      <optional>
-        <element name="title">
-          <text/>
-        </element>
-      </optional>
-      <element name="authority1">
-        <ref name="Basic-Section"/>
-      </element>
-      <element name="authority2">
-        <ref name="Basic-Section"/>
-      </element>
-      <element name="authority3">
-        <ref name="Basic-Section"/>
-      </element>
-      <optional>
-        <element name="authority4">
-          <ref name="Basic-Section"/>
-        </element>
-      </optional>
-      <element name="authority5">
-        <ref name="Basic-Section"/>
-      </element>
-    </element>
-  </define>
   <define name="revision">
     <element name="revision">
       <text/>
@@ -457,6 +419,9 @@
       <zeroOrMore>
         <ref name="termdocsource"/>
       </zeroOrMore>
+      <optional>
+        <ref name="boilerplate"/>
+      </optional>
       <ref name="preface"/>
       <oneOrMore>
         <ref name="sections"/>

data/lib/asciidoctor/nist/nist_intro.xml

@@ -1,33 +1,36 @@
-<authority>
-<title>Authority</title>
+<boilerplate>
+  <legal-statement>
 
-<authority1>
+<clause id="authority1">
+<title>Authority</title>
 <p>This publication has been developed by NIST in accordance with its statutory responsibilities under the Federal Information Security Modernization Act (FISMA) of 2014, 44 U.S.C. &#xa7; 3551 <em>et seq.</em>, Public Law (P.L.) 113-283. NIST is responsible for developing information security standards and guidelines, including minimum requirements for federal information systems, but such standards and guidelines shall not apply to national security systems without the express approval of appropriate federal officials exercising policy authority over such systems. This guideline is consistent with the requirements of the Office of Management and Budget (OMB) Circular A-130.</p>
 
 <p>Nothing in this publication should be taken to contradict the standards and guidelines made mandatory and binding on federal agencies by the Secretary of Commerce under statutory authority. Nor should these guidelines be interpreted as altering or superseding the existing authorities of the Secretary of Commerce, Director of the OMB, or any other federal official. This publication may be used by nongovernmental organizations on a voluntary basis and is not subject to copyright in the United States. Attribution would, however, be appreciated by NIST.</p>
-</authority1>
+</clause>
 
-<authority2>
-<p align="center">National Institute of Standards and Technology {{ docidentifier_long | remove: "NIST " }} <br/>
-Natl. Inst. Stand. Technol. {{ docidentifier | remove: "NIST " | replace: " Volume ", " Vol. " }}, ({{ revdate_monthyear }}) <br/>
+<clause id="authority2">
+<p align="center">National Institute of Standards and Technology {{ docidentifier_long_undated | remove: "NIST " }} <br/>
+  Natl. Inst. Stand. Technol. {{ docidentifier_undated | remove: "NIST " | replace: " Volume ", " Vol. " }}, ({{ most_recent_date_monthyear }}{% if updateddate_mmddyyyy %}, including updates as of {{updateddate_mmddyyyy}}{% endif %}) <br/>
 CODEN: NSPUE2</p>
 
 {% if doi %}
 <p align="center">This publication is available free of charge from: <br/>
   <link target="{{doi}}"/></p>
 {% endif %}
-</authority2>
+</clause>
 
-<authority3>
+<clause id="authority3">
 <p>Any mention of commercial products or reference to commercial organizations is for information only; it does not imply recommendation or endorsement by the United States Government, nor does it imply that the products mentioned are necessarily the best available for the purpose.</p>
 
 <p>There may be references in this publication to other publications currently under development by NIST in accordance with its assigned statutory responsibilities. The information in this publication, including concepts and methodologies, may be used by Federal agencies even before the completion of such companion publications. Thus, until each publication is completed, current requirements, guidelines, and procedures, where they exist, remain operative. For planning and transition purposes, Federal agencies may wish to closely follow the development of these new publications by NIST.</p>
 
 <p>Organizations are encouraged to review all draft publications during public comment periods and provide feedback to NIST. Many NIST cybersecurity publications, other than the ones noted above, are available at <link target="https://csrc.nist.gov/publications"/>
-</authority3>
+</clause>
+</legal-statement>
 
+<feedback-statement>
   {% if unpublished %}
-<authority4>
+<clause id="authority4">
 {% if comment_extended %}
 <p align="center">[{{ comment_extended}}: Comment period extended]</p>
 {% endif %}
@@ -39,10 +42,10 @@ CODEN: NSPUE2</p>
 <p align="center"><strong>Public comment period: from <em>{{ comment_from }}</em></strong></p>
 {% endif %}
 {% endif %}
-</authority4>
+</clause>
 {% endif %}
 
-<authority5>
+<clause id="authority5">
   <p align="center"><strong>Comments on this publication may be submitted to:</strong></p>
 
 <p align="center">National Institute of Standards and Technology <br/>
@@ -53,5 +56,6 @@ CODEN: NSPUE2</p>
   {% endif %}</p>
 
 <p align="center">All comments are subject to release under the Freedom of Information Act (FOIA).</p>
-</authority5>
-</authority>
+</clause>
+</feedback-statement>
+</boilerplate>

data/lib/isodoc/nist/base_convert.rb

@@ -23,15 +23,13 @@ module IsoDoc
         end
       end
 
-      FRONT_CLAUSE = "//*[parent::preface][not(local-name() = 'abstract')]".freeze
+      FRONT_CLAUSE = "//*[parent::preface][not(local-name() = 'abstract' or local-name() = 'foreword')]".freeze
 
-       # All "[preface]" sections should have class "IntroTitle" to prevent
+      # All "[preface]" sections should have class "IntroTitle" to prevent
       # page breaks
       # But for the Exec Summary
       def preface(isoxml, out)
         isoxml.xpath(ns(FRONT_CLAUSE)).each do |c|
-          foreword(isoxml, out) and next if c.name == "foreword"
-          authority_parse(c, out) and next if c.name == "authority"
           next if skip_render(c, isoxml)
           title = c&.at(ns("./title"))
           patent = ["Call for Patent Claims", "Patent Disclosure Notice"].include? title&.text
@@ -113,20 +111,17 @@ module IsoDoc
         when "requirement" then requirement_parse(node, out)
         when "permission" then permission_parse(node, out)
         when "errata" then errata_parse(node, out)
-        when "authority" then authority_parse(node, out)
-        when "authority1" then authority1_parse(node, out, "authority1")
-        when "authority2" then authority1_parse(node, out, "authority2")
-        when "authority3" then authority1_parse(node, out, "authority3")
-        when "authority4" then authority1_parse(node, out, "authority4")
-        when "authority5" then authority1_parse(node, out, "authority5")
+        when "legal-statement" then children_parse(node, out)
+        when "feedback-statement" then children_parse(node, out)
         else
           super
         end
       end
 
-      def authority_parse(node, out)
+      def boilerplate(node, out)
+        boilerplate = node.at(ns("//boilerplate")) or return
         out.div **{class: "authority"} do |s|
-          node.children.each do |n|
+          boilerplate.children.each do |n|
             if n.name == "title"
               s.h1 do |h|
                 n.children.each { |nn| parse(nn, h) }
@@ -136,19 +131,12 @@ module IsoDoc
             end
           end
         end
+        page_break(out)
       end
 
-      def authority1_parse(node, out, classname)
-        out.div **{class: classname} do |s|
-          node.children.each do |n|
-            if n.name == "title"
-              s.h2 do |h|
-                n.children.each { |nn| parse(nn, h) }
-              end
-            else
-              parse(n, s)
-            end
-          end
+      def children_parse(node, out)
+        node.children.each do |n|
+          parse(n, out)
         end
       end
 
@@ -201,24 +189,11 @@ module IsoDoc
           t.tbody do |b|
             node.xpath(ns("./row")).each do |row|
               b.tr do |tr|
-                tr.td do |td|
-                  row&.at(ns("./date"))&.children.each do |n|
-                    parse(n, td)
-                  end
-                end
-                tr.td do |td|
-                  row&.at(ns("./type"))&.children.each do |n|
-                    parse(n, td)
-                  end
-                end
-                tr.td do |td|
-                  row&.at(ns("./change"))&.children.each do |n|
-                    parse(n, td)
-                  end
-                end
-                tr.td do |td|
-                  row&.at(ns("./pages"))&.children.each do |n|
-                    parse(n, td)
+                %w{date type change pages}.each do |hdr|
+                  tr.td do |td|
+                    row&.at(ns("./#{hdr}"))&.children.each do |n|
+                      parse(n, td)
+                    end
                   end
                 end
               end
@@ -252,10 +227,12 @@ module IsoDoc
         "//bibliography/clause".freeze
 
       def initial_anchor_names(d)
-        d.xpath("//xmlns:preface/child::*").each do |c|
+        d.xpath("//xmlns:boilerplate/child::* | //xmlns:preface/child::*").each do |c|
           preface_names(c)
         end
-        sequential_asset_names(d.xpath("//xmlns:preface/child::*"))
+        @in_execsummary = true
+        hierarchical_asset_names(d.xpath("//xmlns:executivesummary"), "ES")
+        @in_execsummary = false
         clause_names(d, 0)
         middle_section_asset_names(d)
         termnote_anchor_names(d)
@@ -276,71 +253,11 @@ module IsoDoc
       end
 
       def middle_section_asset_names(d)
-        middle_sections = 
-          "//xmlns:preface/child::* | //xmlns:sections/child::*"
+        middle_sections = "//xmlns:preface/child::*[not(self::xmlns:executivesummary)] | "\
+          "//xmlns:sections/child::*"
         sequential_asset_names(d.xpath(middle_sections))
       end
 
-      def sequential_asset_names(clause)
-        super
-        sequential_permission_names(clause)
-        sequential_requirement_names(clause)
-        sequential_recommendation_names(clause)
-      end
-
-      def sequential_permission_names(clause)
-        clause.xpath(ns(".//permission")).each_with_index do |t, i|
-          next if t["id"].nil? || t["id"].empty?
-          @anchors[t["id"]] = anchor_struct(i + 1, t, "Permission", "permission")
-        end
-      end
-
-      def sequential_requirement_names(clause)
-        clause.xpath(ns(".//requirement")).each_with_index do |t, i|
-          next if t["id"].nil? || t["id"].empty?
-          @anchors[t["id"]] = anchor_struct(i + 1, t, "Requirement", "requirement")
-        end
-      end
-
-      def sequential_recommendation_names(clause)
-        clause.xpath(ns(".//recommendation")).each_with_index do |t, i|
-          next if t["id"].nil? || t["id"].empty?
-          @anchors[t["id"]] = anchor_struct(i + 1, t, "Recommendation", "recommendation")
-        end
-      end
-
-
-      def hierarchical_asset_names(clause, num)
-        super
-        hierarchical_permission_names(clause, num)
-        hierarchical_requirement_names(clause, num)
-        hierarchical_recommendation_names(clause, num)
-      end
-
-      def hierarchical_permission_names(clause, num)
-        clause.xpath(ns(".//permission")).each_with_index do |t, i|
-          next if t["id"].nil? || t["id"].empty?
-          @anchors[t["id"]] = anchor_struct("#{num}.#{i + 1}",
-                                            t, "Permission", "permission")
-        end
-      end
-
-      def hierarchical_requirement_names(clause, num)
-        clause.xpath(ns(".//requirement")).each_with_index do |t, i|
-          next if t["id"].nil? || t["id"].empty?
-          @anchors[t["id"]] = anchor_struct("#{num}.#{i + 1}",
-                                            t, "Requirement", "requirement")
-        end
-      end
-
-      def hierarchical_recommendation_names(clause, num)
-        clause.xpath(ns(".//recommendation")).each_with_index do |t, i|
-          next if t["id"].nil? || t["id"].empty?
-          @anchors[t["id"]] = anchor_struct("#{num}.#{i + 1}",
-                                            t, "Recommendation", "recommendation")
-        end
-      end
-
       def clause_names(docxml, sect_num)
         q = "//xmlns:sections/child::*"
         docxml.xpath(q).each_with_index do |c, i|
@@ -392,9 +309,12 @@ module IsoDoc
       def annex_names(clause, num)
         @anchors[clause["id"]] = { label: annex_name_lbl(clause, num), type: "clause",
                                    xref: "#{@annex_lbl} #{num}", level: 1 }
-        clause.xpath(ns("./clause | ./terms | ./term | ./references")).each_with_index do |c, i|
+        clause.xpath(ns("./clause")).each_with_index do |c, i|
           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)
+        end
         hierarchical_asset_names(clause, num)
       end
 
@@ -429,6 +349,66 @@ module IsoDoc
           biblio_list(node, div, true)
         end
       end
+
+      NIST_PUBLISHER_XPATH = 
+        "./contributor[xmlns:role/@type = 'publisher']/"\
+        "organization[abbreviation = 'NIST' or xmlns:name = 'NIST']".freeze
+
+      # we are taking the ref number/code out as prefix to reference
+      def noniso_bibitem(list, b, ordinal, bibliography)
+        list.p **attr_code(iso_bibitem_entry_attrs(b, bibliography)) do |r|
+          if !b.at(ns("./formattedref"))
+            nist_reference_format(b, r)
+          else
+            reference_format(b, r)
+          end
+        end
+      end
+
+      def reference_format(b, r)
+        if ftitle = b.at(ns("./formattedref"))
+          ftitle&.children&.each { |n| parse(n, r) }
+        else
+          title = b.at(ns("./title[@language = '#{@language}']")) || b.at(ns("./title"))
+          r.i do |i|
+            title&.children&.each { |n| parse(n, i) }
+          end
+        end
+        r << "[#{iso_bibitem_ref_code(b)}] "
+      end
+
+      def omit_docid_prefix(prefix)
+        return true if prefix.nil? || prefix.empty?
+        return ["ISO", "IEC", "nist"].include? prefix
+      end
+
+      def nist_reference_format(b, r)
+        bibitem = b.dup.to_xml
+        r.parent.add_child ::Iso690Render.render(bibitem, true)
+      end
+
+      def pseudocode_parse(node, out)
+        @in_figure = true
+        name = node.at(ns("./name"))
+        out.div **attr_code(id: node["id"], class: "pseudocode") do |div|
+          node.children.each do |n|
+            parse(n, div) unless n.name == "name"
+          end
+          figure_name_parse(node, div, name)
+        end
+        @in_figure = false
+      end
+
+      def foreword(isoxml, out)
+        f = isoxml.at(ns("//foreword")) || return
+        out.div **attr_code(id: f["id"]) do |s|
+          title = f.at(ns("./title"))
+          s.h1(**{ class: "ForewordTitle" }) do |h1|
+            title and title.children.each { |e| parse(e, h1) }
+          end
+          f.elements.each { |e| parse(e, s) unless e.name == "title" }
+        end
+      end
     end
   end
 end