relaton-nist 1.5.1 → 1.7.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e04045cea97147ffffc8bab0c35810ce34a788483994aab230d877ce8b890633
-  data.tar.gz: '09da55208d81abc48309f63ae2ca85ae4fdc743e368efcca0b6cfe3b2f5fbd5d'
+  metadata.gz: c81efdc2d8f38426e3eba552cc116e51fac614c10901098bdc1e8eb71b09c1f1
+  data.tar.gz: d629498cf1943a4d0d735e55fa6d4d61727cfcfc7bd24ca1e0e4b1e102c04364
 SHA512:
-  metadata.gz: ae6e413d24ac3a426007a4e344c2475ee11049a0472dbac103967acc99408404a82dd3f961618f3a41c0c6285124656e8ddac0951afefe937e8155c862fad2bd
-  data.tar.gz: 4cf76e604f0abd5c812d412afb7034f4977ca75b38593297fe864ad0c8d597621ebdf9a15f5add133a77954fe6c4eb5aada43d189b9f6a5f25accbb319533381
+  metadata.gz: 1089faa79d7cc68a375fa77f6abd1ddbc9d10a636ef00cdd56fd99112d2b3356fa95703630685a4d668badca853fb5696b7503b4b680e8117a9b1a064a785003
+  data.tar.gz: 105c563803b84854488ed7e02c9bfe74a3853a78f55c90f5f67ba5c36fa3f3d83df9f889a925fef89da1114fc1efff0cb0d6fbddc2e49193d8d72ae7595c4ffa

data/README.adoc

@@ -91,11 +91,14 @@ RelatonNist::NistBibliography.get("8200", "2018", {})
 === Get short citation
 Short citation is a convetion about a citation's format. The format for NIST publications is:
 ----
-NIST {abbrev(series)} {docnumber} {(edition), optional} {(stage), optioal}
+NIST {abbrev(series)} {docnumber} {(edition), optional} {(stage), optional}
 # or
-{abbrev(series)} {docnumber} {(edition), optional} {(stage), optioal}
+{abbrev(series)} {docnumber} {(edition), optional} {(stage), optional}
 ----
-- `(stage)` is empty if the state is "final" (published)
+- `(stage)` is empty if the state is "final" (published). In case state is "draft" it shoud be:
+  * PD for public draft
+  * IPD for initial iteration public draft or 2PD, 3PD and so one for following iterations
+  * FPD for final public draft
 - `(edition)` is the date of publication or update
 - `docnumber` is the full NIST number, including revision, e.g., 800-52
 
@@ -114,6 +117,36 @@ RelatonNist::NistBibliography.get("SP 800-205 (February 2019) (PD)")
 ...
 ----
 
+=== Get specific part, volume, version, revision, and addendum
+
+Referehces can contain optional parameters `{ptN}{vN}{verN}{rN}{/Add}`:
+- Part is specified as `ptN` (SP 800-57pt1)
+- Volume is specified as `vN` (SP 800-60v1)
+- Version is specified as `verN` (SP 800-45ver2)
+- Revision is specified as `rN` (SP 800-40r3)
+- Addendum is specified as `/Add` (SP 800-38A/Add)
+
+[source,ruby]
+----
+item = RelatonNist::NistBibliography.get 'SP 800-67r3'
+[relaton-nist] ("SP 800-67r3") fetching...
+[relaton-nist] ("SP 800-67r3") found SP 800-67 Rev. 3
+=> #<RelatonNist::NistBibliographicItem:0x007fd87bbe9460
+...
+
+item.docidentifier.first.id
+=> "SP 800-67 Rev. 3"
+
+RelatonNist::NistBibliography.get 'SP 800-38A/Add'
+[relaton-nist] ("SP 800-38A/Add") fetching...
+[relaton-nist] ("SP 800-38A/Add") found SP 800-38A-Add
+=> #<RelatonNist::NistBibliographicItem:0x007fd88c21d880
+...
+
+item.docidentifier.first.id
+=> "SP 800-38A-Add"
+----
+
 === Create bibliographic item from YAML
 [source,ruby]
 ----

data/grammars/isodoc.rng

@@ -24,6 +24,14 @@
     <start>
       <ref name="standard-document"/>
     </start>
+    <define name="doctype">
+      <element name="doctype">
+        <optional>
+          <attribute name="abbreviation"/>
+        </optional>
+        <ref name="DocumentType"/>
+      </element>
+    </define>
     <define name="hyperlink">
       <element name="link">
         <attribute name="target">
@@ -141,6 +149,11 @@
             <data type="boolean"/>
           </attribute>
         </optional>
+        <optional>
+          <attribute name="key">
+            <data type="boolean"/>
+          </attribute>
+        </optional>
         <oneOrMore>
           <ref name="dt"/>
           <ref name="dd"/>
@@ -1164,49 +1177,7 @@
   </define>
   <define name="annex">
     <element name="annex">
-      <optional>
-        <attribute name="id">
-          <data type="ID"/>
-        </attribute>
-      </optional>
-      <optional>
-        <attribute name="language"/>
-      </optional>
-      <optional>
-        <attribute name="script"/>
-      </optional>
-      <optional>
-        <attribute name="inline-header">
-          <data type="boolean"/>
-        </attribute>
-      </optional>
-      <attribute name="obligation">
-        <choice>
-          <value>normative</value>
-          <value>informative</value>
-        </choice>
-      </attribute>
-      <optional>
-        <ref name="section-title"/>
-      </optional>
-      <group>
-        <group>
-          <zeroOrMore>
-            <ref name="BasicBlock"/>
-          </zeroOrMore>
-          <zeroOrMore>
-            <ref name="note"/>
-          </zeroOrMore>
-        </group>
-        <zeroOrMore>
-          <choice>
-            <ref name="annex-subsection"/>
-            <ref name="terms"/>
-            <ref name="definitions"/>
-            <ref name="references"/>
-          </choice>
-        </zeroOrMore>
-      </group>
+      <ref name="Annex-Section"/>
     </element>
   </define>
   <define name="terms">

data/grammars/nist.rng

@@ -43,6 +43,7 @@
           <choice>
             <ref name="clause"/>
             <ref name="errata_clause"/>
+            <ref name="acknowledgements"/>
           </choice>
         </zeroOrMore>
         <optional>

data/lib/relaton_nist/hit_collection.rb

@@ -21,8 +21,9 @@ module RelatonNist
     def initialize(ref_nbr, year = nil, opts = {}) # rubocop:disable Metrics/AbcSize
       super ref_nbr, year
 
-      /(?<docid>(SP|FIPS)\s[0-9-]+\w?)/ =~ text
+      /(?<docid>(SP|FIPS)\s[0-9-]+)/ =~ text
       @array = docid ? from_json(docid, **opts) : from_csrc(**opts)
+      @array = from_csrc(**opts) unless @array.any?
 
       @array.sort! do |a, b|
         if a.sort_value != b.sort_value
@@ -83,7 +84,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)
@@ -94,8 +95,9 @@ module RelatonNist
     # @param stage [String]
     # @return [Array<Hach>]
     def select_data(docid, **opts) # rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/MethodLength,Metrics/PerceivedComplexity
+      # ref = docid.sub(/(?<=\d{3}-\d{2})r(\d+)/, ' Rev. \1')
       d = Date.strptime year, "%Y" if year
-      didrx = Regexp.new(docid)
+      # didrx = Regexp.new(docid)
       data.select do |doc|
         next unless match_year?(doc, d)
 
@@ -104,7 +106,7 @@ module RelatonNist
         else
           next unless doc["status"] == "final"
         end
-        doc["docidentifier"] =~ didrx
+        doc["docidentifier"].include? docid
       end
     end
 
@@ -114,7 +116,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
 

data/lib/relaton_nist/nist_bibliography.rb

@@ -29,15 +29,16 @@ module RelatonNist
       #
       # @return [String] Relaton XML serialisation of reference
       def get(code, year = nil, opts = {})
-        return fetch_ref_err(code, year, []) if code =~ /\sEP$/
+        return fetch_ref_err(code, year, []) if code.match? /\sEP$/
 
         /^(?<code2>[^\(]+)(\((?<date2>\w+\s(\d{2},\s)?\d{4})\))?\s?\(?((?<=\()(?<stage>[^\)]+))?/ =~ code
+        stage ||= /(?<=\.)PD-\w+(?=\.)/.match(code)&.to_s
         if code2
           code = code2.strip
           if date2
-            if /\w+\s\d{4}/ =~ date2
+            if /\w+\s\d{4}/.match? date2
               opts[:issued_date] = Date.strptime date2, "%B %Y"
-            elsif /\w+\s\d{2},\s\d{4}/ =~ date2
+            elsif /\w+\s\d{2},\s\d{4}/.match? date2
               opts[:updated_date] = Date.strptime date2, "%B %d, %Y"
             end
           end
@@ -81,10 +82,10 @@ module RelatonNist
       # @option opts [Time] :issued_date
       # @option opts [String] :stage
       #
-      # @retur [Hash]
+      # @return [Hash]
       def nistbib_results_filter(result, year, opts)
         missed_years = []
-        iter = opts[:stage]&.slice(-3, 1)
+        iter = /\w+(?=PD)|(?<=PD-)\w+/.match(opts[:stage])&.to_s
         iteration = case iter
                     when "I" then "1"
                     when "F" then "final"
@@ -93,25 +94,32 @@ module RelatonNist
         result.each_slice(3) do |s| # ISO website only allows 3 connections
           fetch_pages(s, 3).each_with_index do |r, _i|
             if opts[:issued_date]
-              ids = r.date.select { |d| d.type == "issued" && d.on == opts[:issued_date] }
+              ids = r.date.select do |d|
+                d.type == "issued" && d.on(:date) == opts[:issued_date]
+              end
               next if ids.empty?
             elsif opts[:updated_date]
-              pds = r.date.select { |d| d.type == "published" && d.on == opts[:updated_date] }
+              pds = r.date.select do |d|
+                d.type == "published" && d.on(:date) == opts[:updated_date]
+              end
               next if pds.empty?
             end
             next if iter && r.status.iteration != iteration
             return { ret: r } if !year
 
             r.date.select { |d| d.type == "published" }.each do |d|
-              return { ret: r } if year.to_i == d.on.year
+              return { ret: r } if year.to_i == d.on(:year)
 
-              missed_years << d.on.year
+              missed_years << d.on(:year)
             end
           end
         end
         { years: missed_years }
       end
 
+      # @param hits [RelatonNist::HitCollection]
+      # @param threads [Integer]
+      # @return [Array<RelatonNist::NistBibliographicItem>]
       def fetch_pages(hits, threads)
         workers = RelatonBib::WorkersPool.new threads
         workers.worker { |w| { i: w[:i], hit: w[:hit].fetch } }
@@ -120,15 +128,94 @@ module RelatonNist
         workers.result.sort_by { |a| a[:i] }.map { |x| x[:hit] }
       end
 
-      def nistbib_search_filter(code, year, opts)
-        idregex = %r{[0-9-]{3,}\w?}
-        docid = code.match(idregex).to_s
-        serie = code.match(%r{(FISP|SP|NISTIR)(?=\s)})
+      # @param code [String]
+      # @param year [String, nil]
+      # @param opts [Hash]
+      # @return [RelatonNist::HitCollection]
+      def nistbib_search_filter(code, year, opts) # rubocop:disable Metrics/MethodLength
         warn "[relaton-nist] (\"#{code}\") fetching..."
-        result = search(code, year, opts)
-        result.select do |i|
-          i.hit[:code]&.match(idregex).to_s == docid && (!serie || i.hit[:serie] == serie.to_s)
-        end
+        # match = %r{
+        #   ^((?:NIST)\s)?
+        #   (?<serie>(SP|FIPS|NISTIR|ITL\sBulletin|White\sPaper))\s
+        #   (?<code>[0-9-]{3,}[A-Z]?)
+        #   (?<prt1>pt\d+)?
+        #   (?<vol1>v\d+)?
+        #   (?<ver1>ver[\d\.]+)?
+        #   (?<rev1>r\d+)?
+        #   (\s(?<prt2>Part\s\d+))?
+        #   (\s(?<vol2>Vol\.\s\d+))?
+        #   (\s(?<ver2>(Ver\.|Version)\s[\d\.]+))?
+        #   (\s(?<rev2>Rev\.\s\d+))?
+        #   (\/(?<upd>Add))?
+        # }x.match(code)
+        # match ||= %r{
+        #   ^NIST\.
+        #   (?<serie>(SP|FIPS|IR|ITL\sBulletin|White\sPaper))\.
+        #   ((PD-\d+|PUB)\.)?
+        #   (?<code>[0-9-]{3,}[A-Z]?)
+        #   (\.(?<prt1>pt-\d+))?
+        #   (\.(?<vol1>v-\d+))?
+        #   (\.(?<ver1>ver-[\d\.]+))?
+        #   (\.(?<rev1>r-\d+))?
+        # }x.match(code)
+        matches = {
+          serie: match(/(SP|FIPS|(NIST)?IR|ITL\sBulletin|White\sPaper)(?=\.|\s)/, code),
+          code: match(/(?<=\.|\s)[0-9-]{3,}[A-Z]?/, code),
+          prt1: match(/(?<=(\.))?pt(?(1)-)[A-Z\d]+/, code),
+          vol1: match(/(?<=(\.))?v(?(1)-)\d+/, code),
+          ver1: match(/(?<=(\.))?ver(?(1)[-\d]|[\.\d])+/, code)&.gsub(/-/, "."),
+          rev1: match(/(?<=[^a-z])(?<=(\.))?r(?(1)-)\d+/, code),
+          add1: match(/(?<=(\.))?add(?(1)-)\d+/, code),
+          prt2: match(/(?<=\s)Part\s[A-Z\d]+/, code),
+          vol2: match(/(?<=\s)Vol\.\s\d+/, code),
+          ver2: match(/(?<=\s)Ver\.\s\d+/, code),
+          rev2: match(/(?<=\s)Rev\.\s\d+/, code),
+          add2: match(/(?<=\/)Add/, code),
+        }
+        ref = matches[:code] ? "#{matches[:serie]} #{matches[:code]}" : code
+        result = search(ref, year, opts)
+        result.select { |i| search_filter i, matches, code }
+      end
+
+      def match(regex, code)
+        regex.match(code)&.to_s
+      end
+
+      # @param item [RelatonNist::Hit]
+      # @param matches [Hash]
+      # @param text [String]
+      # @return [Boolean]
+      def search_filter(item, matches, text) # rubocop:disable Metrics/AbcSize,Metrics/CyclomaticComplexity,Metrics/MethodLength,Metrics/PerceivedComplexity
+        %r{
+          ^((?:NIST)\s)?
+          ((?<serie>(SP|FIPS|NISTIR|ITL\sBulletin|White\sPaper))\s)?
+          (?<code>[0-9-]{3,}[A-Z]?)
+          (?<prt1>pt\d+)?
+          (?<vol1>v\d+)?
+          (?<ver1>ver[\d\.]+)?
+          (?<rev1>r\d+)?
+          (\s(?<prt2>Part\s\d+))?
+          (\s(?<vol2>Vol\.\s\d+))?
+          (\s(?<ver2>(Ver\.|Version)\s[\d\.]+))?
+          (\s(?<rev2>Rev\.\s\d+))?
+          (\s(?<add>Add)endum)?
+        }x =~ item.hit[:code]
+        matches[:code] && [serie, item.hit[:serie]].include?(matches[:serie]) && matches[:code] == code &&
+          long_to_short(matches[:prt1], matches[:prt2]) == long_to_short(prt1, prt2) &&
+          long_to_short(matches[:vol1], matches[:vol2]) == long_to_short(vol1, vol2) &&
+          long_to_short(matches[:ver1], matches[:ver2]) == long_to_short(ver1, ver2) &&
+          long_to_short(matches[:rev1], matches[:rev2]) == long_to_short(rev1, rev2) &&
+          long_to_short(matches[:add1], matches[:add2]) == add || item.hit[:title].include?(text.sub(/^NIST\s/, ""))
+      end
+
+      # @param short [String]
+      # @param long [String]
+      # @return [String, nil]
+      def long_to_short(short, long)
+        return short.sub(/-/, "") if short
+        return unless long
+
+        long.sub(/Part\s/, "pt").sub(/Vol\.\s/, "v").sub(/Rev\.\s/, "r").sub(/(Ver\.|Version)\s/, "ver")
       end
 
       def fetch_ref_err(code, year, missed_years)

data/lib/relaton_nist/scrapper.rb

@@ -110,9 +110,10 @@ module RelatonNist
                        "//div[contains(@class, 'publications-detail')]/h3"
                      )&.text&.strip&.sub(/(?<=\w)\([^\)]+\)$/) do |m|
                        " " + m.upcase
-                     end&.squeeze(" ")&.gsub /&#13;|\n|\r/, ""
+                     end&.squeeze(" ")&.gsub(/&#13;|\n|\r/, "")
                    end
         item_ref ||= "?"
+        item_ref.sub! /\sAddendum$/, "-Add"
         [RelatonBib::DocumentIdentifier.new(id: item_ref, type: "NIST")]
       end
 

data/lib/relaton_nist/version.rb

@@ -1,3 +1,3 @@
 module RelatonNist
-  VERSION = "1.5.1".freeze
+  VERSION = "1.7.2".freeze
 end

data/relaton_nist.gemspec

@@ -34,6 +34,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "vcr"
   spec.add_development_dependency "webmock"
 
-  spec.add_dependency "relaton-bib", "~> 1.5.0"
+  spec.add_dependency "relaton-bib", "~> 1.7.0"
   spec.add_dependency "rubyzip"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: relaton-nist
 version: !ruby/object:Gem::Version
-  version: 1.5.1
+  version: 1.7.2
 platform: ruby
 authors:
 - Ribose Inc.
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-11-06 00:00:00.000000000 Z
+date: 2020-12-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: debase
@@ -156,14 +156,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.5.0
+        version: 1.7.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.5.0
+        version: 1.7.0
 - !ruby/object:Gem::Dependency
   name: rubyzip
   requirement: !ruby/object:Gem::Requirement