relaton-nist 1.3.1 → 1.6.pre1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a7a5a66a0bf3122bb2ecc3146f30ee12ca9a746ed7c96747fef6949925392769
-  data.tar.gz: e56387b519fe1efd6c1874c2a42d4e4555080c73f982049bc8b2366c82540422
+  metadata.gz: 83911e87d23d384599e9d311ced2568d538e38adb7782a01396ae5db599b9c9e
+  data.tar.gz: dd9b9df50f61fe10efa8ba323598c261f13224065301b4914e1a9ff2a2ec2393
 SHA512:
-  metadata.gz: da82fcc539ca6c7ade8214e01966f81018e57dd89496669fbee744cb133d2b0db6d2da369cee4ca05ac4161189c1f114897dd332368c9a634b72a5641e5cce52
-  data.tar.gz: 882fdf875645a91716aab1b275eb18d257d245d71f5bdea7615d78495b3cfa9696a4f0a5b96bf11e0770de52eec1849b21d02118c104dd86d4397df871fd2365
+  metadata.gz: 533c2c283684bf285c6221baecc36eee7068ef1d2c478f5e474b028b4fa5f599ff7efdb2117000c2fae452686c5577db32c7492051c74ae1cce321efa9b25f48
+  data.tar.gz: caee23be7c38f9ed33fa1adc48fc4610b0716eca1aadee6f0d66be8d08f33b8f02fb86cb8b199bd6979e8e7bb6ac5fc6c549a2c8dd86deaf598ee6d347f68ccb

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
 
@@ -45,7 +46,8 @@ 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/.match? opts[:stage]
@@ -81,7 +83,7 @@ module RelatonNist
       select_data(docid, **opts).map do |h|
         /(?<serie>(?<=-)\w+$)/ =~ h["series"]
         title = [h["title-main"], h["title-sub"]].compact.join " - "
-        release_date = RelatonBib.parse_date h["published-date"]
+        release_date = RelatonBib.parse_date h["published-date"], false
         Hit.new({ code: h["docidentifier"], serie: serie.upcase, title: title,
                   url: h["uri"], status: h["status"],
                   release_date: release_date, json: h }, self)
@@ -112,7 +114,7 @@ module RelatonNist
     def match_year?(doc, date)
       return true unless year
 
-      idate = RelatonBib.parse_date doc["issued-date"]
+      idate = RelatonBib.parse_date doc["issued-date"], false
       idate.between? date, date.next_year.prev_day
     end
 
@@ -130,15 +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
 

data/lib/relaton_nist/nist_bibliographic_item.rb

@@ -63,13 +63,16 @@ module RelatonNist
       super
     end
 
-    # @param builder [Nokogiri::XML::Builder]
-    def to_xml(builder = nil, **opts)
-      super builder, date_format: :short, **opts do |b|
+    # @param opts [Hash]
+    # @option opts [Nokogiri::XML::Builder] :builder XML builder
+    # @option opts [Boolean] :bibdata
+    # @option opts [String] :lang language
+    # @return [String] XML
+    def to_xml(**opts)
+      super date_format: :short, **opts do |b|
         if opts[:bibdata]
           b.ext do
             b.doctype doctype if doctype
-            # keyword.each { |kw| b.keyword { kw.to_xml b } }
             commentperiod&.to_xml b
           end
         end