relaton-nist 1.3.0 → 1.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dac2975c8efc8f3fb1fe8720fb852daba9bd66fb0e7bfc5fd87e24b69ed08ff1
-  data.tar.gz: 84503272191f86d904c947bbe6143c4363bc5fe03d0bb4f40b56162ef45f6c7d
+  metadata.gz: e04045cea97147ffffc8bab0c35810ce34a788483994aab230d877ce8b890633
+  data.tar.gz: '09da55208d81abc48309f63ae2ca85ae4fdc743e368efcca0b6cfe3b2f5fbd5d'
 SHA512:
-  metadata.gz: b82763b595daf55b2d09643804f5caf2351e11f8de4f1e61b0c8f98273770da35aaa4161209ad21a137e04dbfc35fa6cc8ff14f9f15ad2e7c450e2e8bcb7e9a2
-  data.tar.gz: 23f6829e141eb6b2f3f90f23de5b6f8b731b8659060ca7459599727ff5652368f8f8970a1234b0c551ffd40321b1a99e4a9e212b84669c803e4483f0eba079ad
+  metadata.gz: ae6e413d24ac3a426007a4e344c2475ee11049a0472dbac103967acc99408404a82dd3f961618f3a41c0c6285124656e8ddac0951afefe937e8155c862fad2bd
+  data.tar.gz: 4cf76e604f0abd5c812d412afb7034f4977ca75b38593297fe864ad0c8d597621ebdf9a15f5add133a77954fe6c4eb5aada43d189b9f6a5f25accbb319533381

data/.github/workflows/macos.yml

@@ -26,6 +26,8 @@ jobs:
       - name: Update gems
         run: |
           sudo gem install bundler --force
+          ruby -v | grep 2.5 && bundle config set build.debase --with-cflags="-Wno-error=implicit-function-declaration"
+          ruby -v | grep 2.5 && bundle config set build.ruby-debug-ide --with-cflags="-Wno-error=implicit-function-declaration"
           bundle install --jobs 4 --retry 3
       - name: Run specs
         run: |

data/README.adoc

@@ -39,11 +39,10 @@ Or install it yourself as:
 require 'relaton_nist'
 
 hit_collection = RelatonNist::NistBibliography.search("8200")
-=> [<RelatonNist::Hit:0x007f82b9b2b298 @text="8200" @fetched="false" @fullIdentifier="" @title="8200">,
- <RelatonNist::Hit:0x007f82b9b2a1e0 @text="8200" @fetched="false" @fullIdentifier="" @title="8200">]
+=> <RelatonNist::HitCollection:0x007fc069d19da0 @ref=8200 @fetched=false>
 
  item = hit_collection[1].fetch
- => #<RelatonNist::NistBibliographicItem:0x007f82b986e668
+=> #<RelatonNist::NistBibliographicItem:0x007fc049aa6778
  ...
 ----
 
@@ -71,9 +70,6 @@ item.to_xml bibdata: true
     ...
     <ext>
       <doctype>stadard</doctype>
-      <keyword>cybersecurity</keyword>
-      <keyword>cybersecurity objectives</keyword>
-      ...
       <commentperiod>
         <from>2018-02-01</from>
         <to>2018-04-18</to>
@@ -86,8 +82,9 @@ item.to_xml bibdata: true
 [source,ruby]
 ----
 RelatonNist::NistBibliography.get("8200", "2018", {})
-fetching 8200...
-=> #<RelatonNist::NistBibliographicItem:0x007f82bb3370a8
+[relaton-nist] ("8200") fetching...
+[relaton-nist] ("8200") found NISTIR 8200
+=> #<RelatonNist::NistBibliographicItem:0x007fc06aa2b480
 ...
 ----
 
@@ -110,9 +107,10 @@ NIST FIPS {docnumber}
 ----
 [source,ruby]
 ----
-RelatonNist::NistBibliography.get("8200", "2018", {})
-fetching 8200...
-=> #<RelatonNist::NistBibliographicItem:0x007f82bb3370a8
+RelatonNist::NistBibliography.get("SP 800-205 (February 2019) (PD)")
+[relaton-nist] ("SP 800-205") fetching...
+[relaton-nist] ("SP 800-205") found SP 800-205 (Draft)
+=> #<RelatonNist::NistBibliographicItem:0x007fc059934768
 ...
 ----
 

data/grammars/isodoc.rng

@@ -43,7 +43,9 @@
     <define name="xref">
       <element name="xref">
         <attribute name="target">
-          <data type="IDREF"/>
+          <data type="string">
+            <param name="pattern">\i\c*|\c+#\c+</param>
+          </data>
         </attribute>
         <optional>
           <attribute name="type">
@@ -61,6 +63,11 @@
             </choice>
           </attribute>
         </optional>
+        <optional>
+          <attribute name="droploc">
+            <data type="boolean"/>
+          </attribute>
+        </optional>
         <text/>
       </element>
     </define>
@@ -578,6 +585,8 @@
             <ref name="ol"/>
             <ref name="dl"/>
             <ref name="formula"/>
+            <ref name="quote"/>
+            <ref name="sourcecode"/>
           </choice>
         </oneOrMore>
       </element>
@@ -661,6 +670,16 @@
             </choice>
           </attribute>
         </optional>
+        <optional>
+          <attribute name="valign">
+            <choice>
+              <value>top</value>
+              <value>middle</value>
+              <value>bottom</value>
+              <value>baseline</value>
+            </choice>
+          </attribute>
+        </optional>
         <choice>
           <zeroOrMore>
             <choice>
@@ -697,6 +716,16 @@
             </choice>
           </attribute>
         </optional>
+        <optional>
+          <attribute name="valign">
+            <choice>
+              <value>top</value>
+              <value>middle</value>
+              <value>bottom</value>
+              <value>baseline</value>
+            </choice>
+          </attribute>
+        </optional>
         <choice>
           <zeroOrMore>
             <choice>
@@ -834,6 +863,13 @@
   </define>
   <define name="standard-document">
     <element name="standard-document">
+      <attribute name="version"/>
+      <attribute name="type">
+        <choice>
+          <value>semantic</value>
+          <value>presentation</value>
+        </choice>
+      </attribute>
       <ref name="bibdata"/>
       <optional>
         <ref name="boilerplate"/>
@@ -855,7 +891,7 @@
       <oneOrMore>
         <choice>
           <ref name="content"/>
-          <ref name="preface_abstract"/>
+          <ref name="abstract"/>
           <ref name="foreword"/>
           <ref name="introduction"/>
           <ref name="acknowledgements"/>
@@ -922,6 +958,9 @@
       <optional>
         <attribute name="script"/>
       </optional>
+      <optional>
+        <attribute name="type"/>
+      </optional>
       <optional>
         <attribute name="obligation">
           <choice>
@@ -961,9 +1000,6 @@
   </define>
   <define name="content-subsection">
     <element name="clause">
-      <optional>
-        <attribute name="type"/>
-      </optional>
       <ref name="Content-Section"/>
     </element>
   </define>
@@ -992,6 +1028,9 @@
         </choice>
       </attribute>
     </optional>
+    <optional>
+      <attribute name="type"/>
+    </optional>
     <optional>
       <ref name="section-title"/>
     </optional>
@@ -1011,9 +1050,6 @@
   </define>
   <define name="clause">
     <element name="clause">
-      <optional>
-        <attribute name="type"/>
-      </optional>
       <ref name="Clause-Section"/>
     </element>
   </define>
@@ -1042,18 +1078,24 @@
         </choice>
       </attribute>
     </optional>
+    <optional>
+      <attribute name="type"/>
+    </optional>
     <optional>
       <ref name="section-title"/>
     </optional>
     <group>
-      <group>
-        <zeroOrMore>
-          <ref name="BasicBlock"/>
-        </zeroOrMore>
-        <zeroOrMore>
-          <ref name="note"/>
-        </zeroOrMore>
-      </group>
+      <choice>
+        <group>
+          <zeroOrMore>
+            <ref name="BasicBlock"/>
+          </zeroOrMore>
+          <zeroOrMore>
+            <ref name="note"/>
+          </zeroOrMore>
+        </group>
+        <ref name="amend"/>
+      </choice>
       <zeroOrMore>
         <choice>
           <ref name="clause-subsection"/>
@@ -1180,6 +1222,9 @@
       <optional>
         <attribute name="script"/>
       </optional>
+      <optional>
+        <attribute name="type"/>
+      </optional>
       <optional>
         <attribute name="obligation">
           <choice>
@@ -1447,11 +1492,6 @@
       </optional>
     </element>
   </define>
-  <define name="preface_abstract">
-    <element name="abstract">
-      <ref name="Basic-Section"/>
-    </element>
-  </define>
   <define name="term-clause">
     <element name="clause">
       <optional>
@@ -1501,4 +1541,79 @@
       <ref name="CitationType"/>
     </element>
   </define>
+  <define name="amend">
+    <element name="amend">
+      <optional>
+        <attribute name="id">
+          <data type="ID"/>
+        </attribute>
+      </optional>
+      <attribute name="change">
+        <choice>
+          <value>add</value>
+          <value>modify</value>
+          <value>delete</value>
+        </choice>
+      </attribute>
+      <optional>
+        <attribute name="path"/>
+      </optional>
+      <optional>
+        <attribute name="path_end"/>
+      </optional>
+      <optional>
+        <attribute name="title"/>
+      </optional>
+      <optional>
+        <element name="location">
+          <zeroOrMore>
+            <ref name="locality"/>
+          </zeroOrMore>
+        </element>
+      </optional>
+      <zeroOrMore>
+        <ref name="autonumber"/>
+      </zeroOrMore>
+      <optional>
+        <element name="description">
+          <zeroOrMore>
+            <ref name="BasicBlock"/>
+          </zeroOrMore>
+        </element>
+      </optional>
+      <optional>
+        <element name="newcontent">
+          <zeroOrMore>
+            <ref name="BasicBlock"/>
+          </zeroOrMore>
+        </element>
+      </optional>
+      <optional>
+        <element name="description">
+          <zeroOrMore>
+            <ref name="BasicBlock"/>
+          </zeroOrMore>
+        </element>
+      </optional>
+    </element>
+  </define>
+  <define name="autonumber">
+    <element name="autonumber">
+      <attribute name="type">
+        <choice>
+          <value>requirement</value>
+          <value>recommendation</value>
+          <value>permission</value>
+          <value>table</value>
+          <value>figure</value>
+          <value>admonition</value>
+          <value>formula</value>
+          <value>sourcecode</value>
+          <value>example</value>
+          <value>note</value>
+        </choice>
+      </attribute>
+      <text/>
+    </element>
+  </define>
 </grammar>

data/grammars/nist.rng

@@ -9,6 +9,24 @@
     <start>
       <ref name="nist-standard"/>
     </start>
+    <define name="ol">
+      <element name="ol">
+        <attribute name="id">
+          <data type="ID"/>
+        </attribute>
+        <optional>
+          <attribute name="class">
+            <value>steps</value>
+          </attribute>
+        </optional>
+        <oneOrMore>
+          <ref name="li"/>
+        </oneOrMore>
+        <zeroOrMore>
+          <ref name="note"/>
+        </zeroOrMore>
+      </element>
+    </define>
     <define name="DocumentType">
       <value>standard</value>
     </define>
@@ -16,7 +34,7 @@
     <define name="preface">
       <element name="preface">
         <optional>
-          <ref name="preface_abstract"/>
+          <ref name="abstract"/>
         </optional>
         <optional>
           <ref name="foreword"/>
@@ -164,6 +182,13 @@
   </define>
   <define name="nist-standard">
     <element name="nist-standard">
+      <attribute name="version"/>
+      <attribute name="type">
+        <choice>
+          <value>semantic</value>
+          <value>presentation</value>
+        </choice>
+      </attribute>
       <ref name="bibdata"/>
       <zeroOrMore>
         <ref name="termdocsource"/>

data/lib/relaton_nist/hit_collection.rb

@@ -10,6 +10,7 @@ module RelatonNist
   # Page of hit collection.
   class HitCollection < RelatonBib::HitCollection
     DOMAIN = "https://csrc.nist.gov"
+    PUBS_EXPORT = URI.join(DOMAIN, "/CSRC/media/feeds/metanorma/pubs-export")
     DATAFILEDIR = File.expand_path ".relaton/nist", Dir.home
     DATAFILE = File.expand_path "pubs-export.zip", DATAFILEDIR
 
@@ -17,10 +18,10 @@ module RelatonNist
     # @param year [String]
     # @param opts [Hash]
     # @option opts [String] :stage
-    def initialize(ref_nbr, year = nil, opts = {})
+    def initialize(ref_nbr, year = nil, opts = {}) # rubocop:disable Metrics/AbcSize
       super ref_nbr, year
 
-      /(?<docid>(SP|FIPS)\s[0-9-]+)/ =~ text
+      /(?<docid>(SP|FIPS)\s[0-9-]+\w?)/ =~ text
       @array = docid ? from_json(docid, **opts) : from_csrc(**opts)
 
       @array.sort! do |a, b|
@@ -45,28 +46,29 @@ module RelatonNist
         from = d.strftime "%m/%d/%Y"
         to   = d.next_year.prev_day.strftime "%m/%d/%Y"
       end
-      url  = "#{DOMAIN}/publications/search?keywords-lg=#{text}"
+      url = "#{DOMAIN}/publications/search?keywords-lg=#{text}"\
+        "&sortBy-lg=relevence"
       url += "&dateFrom-lg=#{from}" if from
       url += "&dateTo-lg=#{to}" if to
-      url += if /PD/ =~ opts[:stage]
+      url += if /PD/.match? opts[:stage]
                "&status-lg=Draft,Retired Draft,Withdrawn"
              else
                "&status-lg=Final,Withdrawn"
              end
 
-      doc  = Nokogiri::HTML OpenURI.open_uri(::Addressable::URI.parse(url).normalize)
+      doc = Nokogiri::HTML OpenURI.open_uri(::Addressable::URI.parse(url).normalize)
       doc.css("table.publications-table > tbody > tr").map do |h|
         link  = h.at("td/div/strong/a")
         serie = h.at("td[1]").text.strip
         code  = h.at("td[2]").text.strip
         title = link.text
-        doc_url   = DOMAIN + link[:href]
+        doc_url = DOMAIN + link[:href]
         status = h.at("td[4]").text.strip.downcase
         release_date = Date.strptime h.at("td[5]").text.strip, "%m/%d/%Y"
         Hit.new(
           {
-            code: code, serie: serie, title: title, url: doc_url, status: status,
-            release_date: release_date
+            code: code, serie: serie, title: title, url: doc_url,
+            status: status, release_date: release_date
           }, self
         )
       end
@@ -91,17 +93,18 @@ module RelatonNist
     # @param docid [String]
     # @param stage [String]
     # @return [Array<Hach>]
-    def select_data(docid, **opts)
+    def select_data(docid, **opts) # rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/MethodLength,Metrics/PerceivedComplexity
       d = Date.strptime year, "%Y" if year
+      didrx = Regexp.new(docid)
       data.select do |doc|
         next unless match_year?(doc, d)
 
-        if /PD/ =~ opts[:stage]
+        if /PD/.match? opts[:stage]
           next unless %w[draft-public draft-prelim].include? doc["status"]
         else
           next unless doc["status"] == "final"
         end
-        doc["docidentifier"] =~ Regexp.new(docid)
+        doc["docidentifier"] =~ didrx
       end
     end
 
@@ -129,13 +132,12 @@ module RelatonNist
     #
     # @prarm ctime [Time, NilClass]
     def fetch_data(ctime)
-      resp = OpenURI.open_uri("https://csrc.nist.gov/CSRC/media/feeds/metanorma/pubs-export.meta")
+      resp = OpenURI.open_uri("#{PUBS_EXPORT}.meta")
       if !ctime || ctime < resp.last_modified
         @data = nil
-        zip = OpenURI.open_uri "https://csrc.nist.gov/CSRC/media/feeds/metanorma/pubs-export.zip"
-        zip.close
+        uri_open = URI.method(:open) || Kernel.method(:open)
         FileUtils.mkdir_p DATAFILEDIR unless Dir.exist? DATAFILEDIR
-        FileUtils.mv zip.path, DATAFILE
+        IO.copy_stream(uri_open.call("#{PUBS_EXPORT}.zip"), DATAFILE)
       end
     end