relaton-nist 1.7.0 → 1.8.0

data/grammars/nist.rng

@@ -194,6 +194,9 @@
       <zeroOrMore>
         <ref name="termdocsource"/>
       </zeroOrMore>
+      <optional>
+        <ref name="misccontainer"/>
+      </optional>
       <optional>
         <ref name="boilerplate"/>
       </optional>
@@ -207,6 +210,9 @@
       <optional>
         <ref name="bibliography"/>
       </optional>
+      <zeroOrMore>
+        <ref name="indexsect"/>
+      </zeroOrMore>
     </element>
   </define>
 </grammar>

data/grammars/reqt.rng

@@ -30,15 +30,34 @@
         <data type="boolean"/>
       </attribute>
     </optional>
+    <optional>
+      <attribute name="number"/>
+    </optional>
     <optional>
       <attribute name="subsequence"/>
     </optional>
+    <optional>
+      <attribute name="keep-with-next">
+        <data type="boolean"/>
+      </attribute>
+    </optional>
+    <optional>
+      <attribute name="keep-lines-together">
+        <data type="boolean"/>
+      </attribute>
+    </optional>
     <attribute name="id">
       <data type="ID"/>
     </attribute>
     <optional>
       <attribute name="filename"/>
     </optional>
+    <optional>
+      <attribute name="model"/>
+    </optional>
+    <optional>
+      <attribute name="type"/>
+    </optional>
     <optional>
       <ref name="reqtitle"/>
     </optional>
@@ -48,9 +67,9 @@
     <optional>
       <ref name="subject"/>
     </optional>
-    <optional>
+    <zeroOrMore>
       <ref name="reqinherit"/>
-    </optional>
+    </zeroOrMore>
     <zeroOrMore>
       <ref name="classification"/>
     </zeroOrMore>
@@ -135,6 +154,16 @@
         <data type="boolean"/>
       </attribute>
     </optional>
+    <optional>
+      <attribute name="keep-with-next">
+        <data type="boolean"/>
+      </attribute>
+    </optional>
+    <optional>
+      <attribute name="keep-lines-together">
+        <data type="boolean"/>
+      </attribute>
+    </optional>
     <oneOrMore>
       <ref name="BasicBlock"/>
     </oneOrMore>

data/lib/relaton_nist/hash_converter.rb

@@ -18,13 +18,13 @@ module RelatonNist
       # @param item_hash [Hash]
       # @return [RelatonNist::NistBibliographicItem]
       def bib_item(item_hash)
-        NistBibliographicItem.new item_hash
+        NistBibliographicItem.new **item_hash
       end
 
       def commentperiod_hash_to_bib(ret)
         return unless ret[:commentperiod]
 
-        ret[:commentperiod] = CommentPeriod.new ret[:commentperiod]
+        ret[:commentperiod] = CommentPeriod.new **ret[:commentperiod]
       end
 
       # @param ret [Hash]
@@ -32,7 +32,7 @@ module RelatonNist
         super
         return unless ret[:relation]
 
-        ret[:relation] = ret[:relation].map { |r| DocumentRelation.new r }
+        ret[:relation] = ret[:relation].map { |r| DocumentRelation.new **r }
 
         # ret[:relation] = array(ret[:relation])
         # ret[:relation]&.each do |r|

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_bibliographic_item.rb

@@ -63,6 +63,13 @@ module RelatonNist
       super
     end
 
+    # @param hash [Hash]
+    # @return [RelatonNist::GbBibliographicItem]
+    def self.from_hash(hash)
+      item_hash = RelatonNist::HashConverter.hash_to_bib(hash)
+      new **item_hash
+    end
+
     # @param opts [Hash]
     # @option opts [Nokogiri::XML::Builder] :builder XML builder
     # @option opts [Boolean] :bibdata

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"
@@ -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,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/processor.rb

@@ -26,8 +26,7 @@ module RelatonNist
     # @param hash [Hash]
     # @return [RelatonNist::GbBibliographicItem]
     def hash_to_bib(hash)
-      item_hash = ::RelatonNist::HashConverter.hash_to_bib(hash)
-      ::RelatonNist::NistBibliographicItem.new item_hash
+      ::RelatonNist::NistBibliographicItem.from_hash hash
     end
 
     # Returns hash of XML grammar

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.7.0".freeze
+  VERSION = "1.8.0".freeze
 end

data/lib/relaton_nist/xml_parser.rb

@@ -17,7 +17,7 @@ module RelatonNist
       # @param item_hash [Hash]
       # @return [RelatonNist::NistBibliographicItem]
       def bib_item(item_hash)
-        NistBibliographicItem.new item_hash
+        NistBibliographicItem.new **item_hash
       end
 
       def fetch_status(item)

data/relaton_nist.gemspec

@@ -23,17 +23,17 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
   spec.required_ruby_version = Gem::Requirement.new(">= 2.4.0")
 
-  spec.add_development_dependency "debase"
+  # spec.add_development_dependency "debase"
   spec.add_development_dependency "equivalent-xml", "~> 0.6"
   spec.add_development_dependency "pry-byebug"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "rspec", "~> 3.0"
-  spec.add_development_dependency "ruby-debug-ide"
+  # spec.add_development_dependency "ruby-debug-ide"
   spec.add_development_dependency "ruby-jing"
   spec.add_development_dependency "simplecov"
   spec.add_development_dependency "vcr"
   spec.add_development_dependency "webmock"
 
-  spec.add_dependency "relaton-bib", "~> 1.7.0"
+  spec.add_dependency "relaton-bib", "~> 1.8.0"
   spec.add_dependency "rubyzip"
 end

metadata

@@ -1,29 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: relaton-nist
 version: !ruby/object:Gem::Version
-  version: 1.7.0
+  version: 1.8.0
 platform: ruby
 authors:
 - Ribose Inc.
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-11-27 00:00:00.000000000 Z
+date: 2021-05-17 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: debase
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 - !ruby/object:Gem::Dependency
   name: equivalent-xml
   requirement: !ruby/object:Gem::Requirement
@@ -80,20 +66,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
-- !ruby/object:Gem::Dependency
-  name: ruby-debug-ide
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 - !ruby/object:Gem::Dependency
   name: ruby-jing
   requirement: !ruby/object:Gem::Requirement
@@ -156,14 +128,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.7.0
+        version: 1.8.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.7.0
+        version: 1.8.0
 - !ruby/object:Gem::Dependency
   name: rubyzip
   requirement: !ruby/object:Gem::Requirement
@@ -185,9 +157,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".github/workflows/macos.yml"
-- ".github/workflows/ubuntu.yml"
-- ".github/workflows/windows.yml"
+- ".github/workflows/rake.yml"
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
@@ -236,7 +206,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.6
+rubygems_version: 3.2.3
 signing_key:
 specification_version: 4
 summary: 'RelatonNist: retrive NIST standards.'