relaton-nist 0.3.2 → 0.3.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 2eafbe4c1cb7719d3f782f77547db4b759bd8c41
-  data.tar.gz: 912039be62b33bdf6fab94966614e5de7adea3ac
+SHA256:
+  metadata.gz: 4a3bfb018267a6fe830f7383aeaf33ae641a32d648929a2aaf07672590290ee7
+  data.tar.gz: e66b1054ddf701faa547805f540a993ceffe96ed6c778965d58cfe158ea03bc9
 SHA512:
-  metadata.gz: e49aaf8910c7fc910da3f7581fd4f6dcc3fb9beb0dba9575ca266d4bc5edf2d9a0b013470308553c9a30f563aad84c5c7ae9d85ccbc4715bc8480e7bcb27ccc4
-  data.tar.gz: 84105c9c7612a47a9f3d6bebd873434147fa5a8e9ba0bedcc8ff0961939902eaf087fd3d08682eb2e45cbec10c262afabb4c5ec364d4f0e44262a061a6507048
+  metadata.gz: cee4a6e78a57d95f83f64578f3bedb0548f6ac9dd515706e7988bd392ee9a86310de478cecf6422cf3bce5e25283c066d6df9a45327511e231055dc68f04bef3
+  data.tar.gz: 59b0e362340ab0016fc083d1f37c527adc5121a1b33fad573dbf78a4d3998e04a6945a87b0d3b064af382048d0b38fd3becac5b09f2f76aefb499f675183249d

data/Gemfile.lock

@@ -1,15 +1,15 @@
 PATH
   remote: .
   specs:
-    relaton-nist (0.3.2)
+    relaton-nist (0.3.7)
       relaton-bib (~> 0.3.0)
       rubyzip
 
 GEM
   remote: https://rubygems.org/
   specs:
-    addressable (2.6.0)
-      public_suffix (>= 2.0.2, < 4.0)
+    addressable (2.7.0)
+      public_suffix (>= 2.0.2, < 5.0)
     byebug (11.0.1)
     coderay (1.1.2)
     crack (0.4.3)
@@ -33,11 +33,11 @@ GEM
     pry-byebug (3.7.0)
       byebug (~> 11.0)
       pry (~> 0.10)
-    public_suffix (3.1.1)
+    public_suffix (4.0.1)
     rake (10.5.0)
-    relaton-bib (0.3.4)
+    relaton-bib (0.3.11)
       addressable
-      nokogiri (~> 1.10)
+      nokogiri
     rspec (3.8.0)
       rspec-core (~> 3.8.0)
       rspec-expectations (~> 3.8.0)
@@ -53,7 +53,7 @@ GEM
     rspec-support (3.8.2)
     ruby-debug-ide (0.7.0)
       rake (>= 0.8.1)
-    rubyzip (1.2.3)
+    rubyzip (2.0.0)
     safe_yaml (1.0.5)
     simplecov (0.16.1)
       docile (~> 1.1)

data/README.adoc

@@ -113,7 +113,7 @@ fetching 8200...
 ...
 ----
 
-=== Create bibliographic item form YAML
+=== Create bibliographic item from YAML
 [source,ruby]
 ----
 hash = YAML.load_file 'spec/examples/nist_bib_item.yml'

data/lib/relaton_nist.rb

@@ -1,27 +1,11 @@
 require "relaton_nist/version"
 require "relaton_nist/nist_bibliography"
 
-if defined? Relaton
-  require_relative "relaton/processor"
-  Relaton::Registry.instance.register(Relaton::RelatonNist::Processor)
-end
+# if defined? Relaton
+#   require_relative "relaton/processor"
+#   Relaton::Registry.instance.register(Relaton::RelatonNist::Processor)
+# end
 
 module RelatonNist
   class Error < StandardError; end
-
-  class << self
-    # @param date [String]
-    # @return [Date, NilClass]
-    def parse_date(sdate)
-      if /(?<date>\w+\s\d{4})/ =~ sdate # February 2012
-        Date.strptime(date, "%B %Y")
-      elsif /(?<date>\w+\s\d{1,2},\s\d{4})/ =~ sdate # February 11, 2012
-        Date.strptime(date, "%B %d, %Y")
-      elsif /(?<date>\d{4}-\d{2}-\d{2})/ =~ sdate # 2012-02-11
-        Date.parse(date)
-      elsif /(?<date>\d{4}-\d{2})/ =~ sdate # 2012-02
-        Date.strptime date, "%Y-%m"
-      end
-    end
-  end
 end

data/lib/relaton_nist/comment_period.rb

@@ -26,5 +26,13 @@ module RelatonNist
         builder.extended extended.to_s if extended
       end
     end
+
+    # @return [Hash]
+    def to_hash
+      hash = { "from" => from.to_s }
+      hash["to"] = to.to_s if to
+      hash["extended"] = extended.to_s if extended
+      hash
+    end
   end
 end

data/lib/relaton_nist/hit.rb

@@ -2,45 +2,16 @@
 
 module RelatonNist
   # Hit.
-  class Hit
+  class Hit < RelatonBib::Hit
     # @return [RelatonNist::HitCollection]
     attr_reader :hit_collection
 
-    # @return [Array<Hash>]
-    attr_reader :hit
-
-    # @param hit [Hash]
-    # @param hit_collection [RelatonNist:HitCollection]
-    def initialize(hit, hit_collection = nil)
-      @hit            = hit
-      @hit_collection = hit_collection
-    end
-
     # Parse page.
     # @return [RelatonNist::NistBliographicItem]
     def fetch
       @fetch ||= Scrapper.parse_page @hit
     end
 
-    # @return [String]
-    def to_s
-      inspect
-    end
-
-    # @return [String]
-    def inspect
-      "<#{self.class}:#{format('%#.14x', object_id << 1)} "\
-      "@text=\"#{@hit_collection&.text}\" "\
-      "@fetched=\"#{!@fetch.nil?}\" "\
-      "@fullIdentifier=\"#{@fetch&.shortref(nil)}\" "\
-      "@title=\"#{@hit[:code]}\">"
-    end
-
-    # @return [String]
-    def to_xml(**opts)
-      fetch.to_xml **opts
-    end
-
     # @return [Iteger]
     def sort_value
       @sort_value ||= begin

data/lib/relaton_nist/hit_collection.rb

@@ -8,18 +8,10 @@ require "open-uri"
 
 module RelatonNist
   # Page of hit collection.
-  class HitCollection < Array
+  class HitCollection < RelatonBib::HitCollection
     DOMAIN = "https://csrc.nist.gov"
-    DATAFILE = File.expand_path "data/pubs-export.zip", __dir__
-
-    # @return [TrueClass, FalseClass]
-    attr_reader :fetched
-
-    # @return [String]
-    attr_reader :text
-
-    # @return [String]
-    attr_reader :year
+    DATAFILEDIR = File.expand_path ".relaton/nist", Dir.home
+    DATAFILE = File.expand_path "pubs-export.zip", DATAFILEDIR
 
     # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
 
@@ -46,28 +38,6 @@ module RelatonNist
     end
     # rubocop:enable Metrics/AbcSize, Metrics/MethodLength
 
-    # @return [Iecbib::HitCollection]
-    def fetch
-      workers = RelatonBib::WorkersPool.new 4
-      workers.worker(&:fetch)
-      each do |hit|
-        workers << hit
-      end
-      workers.end
-      workers.result
-      @fetched = true
-      self
-    end
-
-    def to_s
-      inspect
-    end
-
-    # @return [String]
-    def inspect
-      "<#{self.class}:#{format('%#.14x', object_id << 1)} @fetched=#{@fetched}>"
-    end
-
     private
 
     # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
@@ -107,50 +77,79 @@ module RelatonNist
         )
       end
     end
+    # rubocop:enable Metrics/AbcSize, Metrics/MethodLength
 
     # Fetches data form json
     # @param docid [String]
+    # @param stage [String]
+    # @return [Array<RelatonNist::Hit>]
     def from_json(docid, **opts)
+      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"]
+        Hit.new({ code: h["docidentifier"], serie: serie.upcase, title: title,
+                  url: h["uri"], status: h["status"],
+                  release_date: release_date, json: h }, self)
+      end
+    end
+
+    # @param docid [String]
+    # @param stage [String]
+    # @return [Array<Hach>]
+    def select_data(docid, **opts)
+      d = Date.strptime year, "%Y" if year
       data.select do |doc|
-        if year
-          d = Date.strptime year, "%Y"
-          idate = RelatonNist.parse_date doc["issued-date"]
-          next unless idate.between? d, d.next_year.prev_day
-        end
+        next unless match_year?(doc, d)
+
         if /PD/ =~ opts[:stage]
           next unless %w[draft-public draft-prelim].include? doc["status"]
         else
           next unless doc["status"] == "final"
         end
         doc["docidentifier"] =~ Regexp.new(docid)
-      end.map do |h|
-        /(?<serie>(?<=-)\w+$)/ =~ h["series"]
-        title = [h["title-main"], h["title-sub"]].compact.join " - "
-        release_date = RelatonNist.parse_date h["published-date"]
-        Hit.new(
-          {
-            code: h["docidentifier"], serie: serie.upcase, title: title,
-            url: h["uri"], status: h["status"], release_date: release_date,
-            json: h
-          }, self
-        )
       end
     end
 
-    # Fetches json data
+    # @param doc [Hash]
+    # @param date [Date] first day of year
+    # @return [TrueClass, FalseClass]
+    def match_year?(doc, date)
+      return true unless year
+
+      idate = RelatonBib.parse_date doc["issued-date"]
+      idate.between? date, date.next_year.prev_day
+    end
+
+    # Fetches json data form server
     # @return [Hash]
     def data
       ctime = File.ctime DATAFILE if File.exist? DATAFILE
       if !ctime || ctime.to_date < Date.today
-        resp = OpenURI.open_uri("https://csrc.nist.gov/CSRC/media/feeds/metanorma/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
-          FileUtils.mv zip.path, DATAFILE
-        end
+        fetch_data(ctime)
+      end
+      unzip
+    end
+
+    # Fetch data form server and save it to file
+    #
+    # @prarm ctime [Time, NilClass]
+    def fetch_data(ctime)
+      resp = OpenURI.open_uri("https://csrc.nist.gov/CSRC/media/feeds/metanorma/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
+        FileUtils.mkdir_p DATAFILEDIR unless Dir.exist? DATAFILEDIR
+        FileUtils.mv zip.path, DATAFILE
       end
-      return if @data
+    end
+
+    # upack zip file
+    #
+    # @return [Hash]
+    def unzip
+      return @data if @data
 
       Zip::File.open(DATAFILE) do |zf|
         zf.each do |f|
@@ -160,6 +159,5 @@ module RelatonNist
       end
       @data
     end
-    # rubocop:enable Metrics/AbcSize, Metrics/MethodLength
   end
 end

data/lib/relaton_nist/keyword.rb

@@ -1,5 +1,7 @@
 module RelatonNist
   class Keyword
+    include RelatonBib
+
     # @return [Nokogiri::XML::DocumentFragment]
     attr_reader :element
 
@@ -12,5 +14,10 @@ module RelatonNist
     def to_xml(builder)
       builder.keyword element.to_xml
     end
+
+    # @return [String]
+    def to_hash
+      element.text
+    end
   end
 end

data/lib/relaton_nist/nist_bibliographic_item.rb

@@ -6,7 +6,7 @@ module RelatonNist
     # @return [Array<RelatonNist::Keyword>]
     attr_reader :keyword
 
-    # @return [RelatonNist::CommentPeriod]
+    # @return [RelatonNist::CommentPeriod, NilClass]
     attr_reader :commentperiod
 
     # @param id [String, NilClass]
@@ -31,7 +31,7 @@ module RelatonNist
     # @param fetched [Date, NilClass] default nil
     # @param doctype [String]
     # @param keyword [Array<RelatonNist::Keyword>]
-    # @param commentperiod [RelatonNist::CommentPeriod]
+    # @param commentperiod [RelatonNist::CommentPeriod, NilClass]
     #
     # @param date [Array<Hash>]
     # @option date [String] :type
@@ -74,5 +74,13 @@ module RelatonNist
         end
       end
     end
+
+    # @return [Hash]
+    def to_hash
+      hash = super
+      hash["keyword"] = single_element_array(keyword) if keyword&.any?
+      hash["commentperiod"] = commentperiod.to_hash if commentperiod
+      hash
+    end
   end
 end

data/lib/relaton_nist/nist_bibliography.rb

@@ -51,11 +51,7 @@ module RelatonNist
         end
 
         code += "-1" if opts[:all_parts]
-        ret = nistbib_get1(code, year, opts)
-        # return nil if ret.nil?
-        # ret.to_most_recent_reference unless year || opts[:keep_year]
-        # ret.to_all_parts if opts[:all_parts]
-        ret
+        nistbib_get1(code, year, opts)
       end
 
       private

data/lib/relaton_nist/processor.rb

@@ -0,0 +1,33 @@
+require "relaton/processor"
+
+module RelatonNist
+  class Processor < Relaton::Processor
+    def initialize
+      @short = :relaton_nist
+      @prefix = "NIST"
+      @defaultprefix = %r{^(NIST|NISTGCR|ITL Bulletin|JPCRD|NISTIR|CSRC)[ /]}
+      @idtype = "NIST"
+    end
+
+    # @param code [String]
+    # @param date [String, NilClass] year
+    # @param opts [Hash]
+    # @return [RelatonNist::GbBibliographicItem]
+    def get(code, date = nil, opts = {})
+      ::RelatonNist::NistBibliography.get(code, date, opts)
+    end
+
+    # @param xml [String]
+    # @return [RelatonNist::GbBibliographicItem]
+    def from_xml(xml)
+      ::RelatonNist::XMLParser.from_xml xml
+    end
+
+    # @param hash [Hash]
+    # @return [RelatonNist::GbBibliographicItem]
+    def hash_to_bib(hash)
+      item_hash = ::RelatonNist::HashConverter.hash_to_bib(hash)
+      ::RelatonNist::NistBibliographicItem.new item_hash
+    end
+  end
+end

data/lib/relaton_nist/scrapper.rb

@@ -21,7 +21,7 @@ module RelatonNist
         unless /^(SP|NISTIR|FIPS) / =~ item_data[:docid][0].id
           doctype = id_cleanup(item_data[:docid][0].id)
           item_data[:docid][0] = RelatonBib::DocumentIdentifier.new(
-            id: titles[0][:content], type: "NIST",
+            id: titles[0][:content].upcase, type: "NIST",
           )
         end
         item_data[:fetched] = Date.today.to_s
@@ -44,11 +44,9 @@ module RelatonNist
           edition: fetch_edition(json),
           language: [json["language"]],
           script: [json["script"]],
-          # abstract: fetch_abstract(doc),
           docstatus: fetch_status(json, hit_data[:status]),
           copyright: fetch_copyright(json["published-date"]),
           relation: fetch_relations_json(json),
-          # series: fetch_series(json),
           keyword: fetch_keywords(json),
           commentperiod: fetch_commentperiod_json(json),
         }
@@ -179,14 +177,14 @@ module RelatonNist
         dates = [{ type: "published", on: release_date.to_s }]
 
         if doc.is_a? Hash
-          issued = RelatonNist.parse_date doc["issued-date"]
-          updated = RelatonNist.parse_date doc["updated-date"]
+          issued = RelatonBib.parse_date doc["issued-date"]
+          updated = RelatonBib.parse_date doc["updated-date"]
           dates << { type: "updated", on: updated.to_s } if updated
-          obsoleted = RelatonNist.parse_date doc["obsoleted-date"]
+          obsoleted = RelatonBib.parse_date doc["obsoleted-date"]
           dates << { type: "obsoleted", on: obsoleted.to_s } if obsoleted
         else
           d = doc.at("//span[@id='pub-release-date']").text.strip
-          issued = RelatonNist.parse_date d
+          issued = RelatonBib.parse_date d
         end
         dates << { type: "issued", on: issued.to_s }
         dates

data/lib/relaton_nist/version.rb

@@ -1,3 +1,3 @@
 module RelatonNist
-  VERSION = "0.3.2".freeze
+  VERSION = "0.3.7".freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: relaton-nist
 version: !ruby/object:Gem::Version
-  version: 0.3.2
+  version: 0.3.7
 platform: ruby
 authors:
 - Ribose Inc.
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-08-13 00:00:00.000000000 Z
+date: 2019-10-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -211,10 +211,8 @@ files:
 - appveyor.yml
 - bin/console
 - bin/setup
-- lib/relaton/processor.rb
 - lib/relaton_nist.rb
 - lib/relaton_nist/comment_period.rb
-- lib/relaton_nist/data/pubs-export.zip
 - lib/relaton_nist/document_status.rb
 - lib/relaton_nist/hash_converter.rb
 - lib/relaton_nist/hit.rb
@@ -222,6 +220,7 @@ files:
 - lib/relaton_nist/keyword.rb
 - lib/relaton_nist/nist_bibliographic_item.rb
 - lib/relaton_nist/nist_bibliography.rb
+- lib/relaton_nist/processor.rb
 - lib/relaton_nist/scrapper.rb
 - lib/relaton_nist/version.rb
 - lib/relaton_nist/xml_parser.rb
@@ -245,8 +244,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.12
+rubygems_version: 3.0.6
 signing_key: 
 specification_version: 4
 summary: 'RelatonNist: retrive NIST standards.'

data/lib/relaton/processor.rb

@@ -1,23 +0,0 @@
-require "relaton/processor"
-
-module Relaton
-  module RelatonNist
-    class Processor < Relaton::Processor
-
-      def initialize
-        @short = :relaton_nist
-        @prefix = "NIST"
-        @defaultprefix = %r{^(NIST|NISTGCR|ITL Bulletin|JPCRD|NISTIR|CSRC)[ /]}
-        @idtype = "NIST"
-      end
-
-      def get(code, date = nil, opts = {})
-        ::RelatonNist::NistBibliography.get(code, date, opts)
-      end
-
-      def from_xml(xml)
-        ::RelatonNist::XMLParser.from_xml xml
-      end
-    end
-  end
-end