relaton-nist 1.7.1 → 1.7.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 86fbfc1190f5174be69a4e51bb6b791328c1d432143e8eb6d2aab6f644ae5100
-  data.tar.gz: 2aa468017a4bcf5ab9369e2f4fca85543fd641ac5ba2b35399e60e96769c996d
+  metadata.gz: c81efdc2d8f38426e3eba552cc116e51fac614c10901098bdc1e8eb71b09c1f1
+  data.tar.gz: d629498cf1943a4d0d735e55fa6d4d61727cfcfc7bd24ca1e0e4b1e102c04364
 SHA512:
-  metadata.gz: 9bb703e914559d9e8359ef6442f089d76fb3dc84fedb273e046893989b7e035825d7990235e1b9c95f14f1c916e0ffff24d9cc1e6b177ae027bcc403480ac2be
-  data.tar.gz: b1b0857eff72431fb9ae953af25dfedd49a1fa459b05fdd85c2285e642182ceb3a58d407bdcd8986153fad5f9f162e6115bd0c9d804d2956ed65de700d830158
+  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/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
@@ -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
 

data/lib/relaton_nist/nist_bibliography.rb

@@ -32,6 +32,7 @@ module RelatonNist
         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
@@ -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"
@@ -116,6 +117,9 @@ module RelatonNist
         { 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 } }
@@ -124,24 +128,94 @@ module RelatonNist
         workers.result.sort_by { |a| a[:i] }.map { |x| x[:hit] }
       end
 
-      def nistbib_search_filter(code, year, opts)
+      # @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..."
+        # 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)?
-          (?<serie1>(SP|FIPS|NISTIR|ITL\sBulletin|White\sPaper))\s
-          (?<code1>[0-9-]{3,}\w?)
-          (\/(?<upd1>Add))?
-        }x =~ code
-        warn "[relaton-nist] (\"#{code}\") fetching..."
-        result = search(code, year, opts)
-        result.select do |i|
-          %r{
-            ^((?:NIST)\s)?
-            ((?<serie2>(SP|FIPS|NISTIR|ITL\sBulletin|White\sPaper))\s)?
-            (?<code2>[0-9-]{3,}\w?)
-            (\s(?<upd2>Add)endum)?
-          }x =~ i.hit[:code]
-          [serie2, i.hit[:serie]].include?(serie1) && code1 == code2 && upd1 == upd2
-        end
+          ((?<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/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: relaton-nist
 version: !ruby/object:Gem::Version
-  version: 1.7.1
+  version: 1.7.2
 platform: ruby
 authors:
 - Ribose Inc.
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-12-08 00:00:00.000000000 Z
+date: 2020-12-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: debase