relaton-ieee 1.12.7 → 1.12.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 495622b50a4332e32e7d8b72c6258ffadeeeab45ee2fa848132f6c1284f638c2
-  data.tar.gz: 8b4c163ce241e5f3db57df8993f7a0aea2ea47729e1ff92b62b53bfa07347c97
+  metadata.gz: c1dc5898477bc082d2628a9420f042304ec97c7e763adaf3ad6029470a800743
+  data.tar.gz: 25ff4f71fe0c8aa9a3549f1f463008032195450291062f2735ea73b620ef9fa1
 SHA512:
-  metadata.gz: 4903079f76d6efbba076699e00ac7a2c7f5c7b0fa3d808995d34afb3d59781d08d1eb3eda804a0991b8fd89206fb537fc34b58f14eae586e3014c6265c4aed47
-  data.tar.gz: c57c445a08a38cb0568510544c8c89fca246bc5c3e2c6299e8d44cc1bdcf60862ddbb34dfc8f2351ccda527050c6725bd6adce300539e7e0dfcd075aec8c0f3b
+  metadata.gz: f805694634b0dcad0829b255d6f984eae49f6d86d3049279ee9d0357f9d2618f6f2c9a6139ca347b8810dfb75669233e7aa985202bd5b80474df2dc284c4135c
+  data.tar.gz: e08ea8f9f27bba582fd7e448dfb54624f62c8d0aa7fd9b16f7457170cc1297a75f5ef08a7622ea19f6704e69194629a1b38475aed8192de6bb808ca03be49ff2

data/lib/relaton_ieee/data_parser.rb

@@ -46,7 +46,7 @@ module RelatonIeee
         copyright: parse_copyright,
         language: ["en"],
         script: ["Latn"],
-        status: parse_status,
+        docstatus: parse_status,
         relation: parse_relation,
         link: parse_link,
         keyword: parse_keyword,

data/lib/relaton_ieee/ieee_bibliographic_item.rb

@@ -12,14 +12,17 @@ module RelatonIeee
     #
     # @param [Hash] args
     # @option args [Boolean, nil] :trialuse Trial use
-    # @option args [Array<RelatonIeee::EditorialGroup>] :editorialgroup Editorial group
+    # @option args [Array<RelatonIeee::EditorialGroup>] :editorialgroup
+    #   Editorial group
     #
-    def initialize(**args)
+    def initialize(**args) # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
       if args[:doctype] && !TYPES.include?(args[:doctype])
-        warn "[relaton-ieee] doctype should be one of #{TYPES.join(', ')}"
+        warn "[relaton-ieee] invalid doctype \"#{args[:doctype]}\". " \
+             "It should be one of: #{TYPES.join(', ')}."
       end
       if args[:docsubtype] && !SUBTYPES.include?(args[:docsubtype])
-        warn "[relaton-ieee] docsubtype should be one of #{SUBTYPES.join(', ')}"
+        warn "[relaton-ieee] invalid docsubtype \"#{args[:docsubtype]}\". " \
+             "It should be one of: #{SUBTYPES.join(', ')}."
       end
       eg = args.delete(:editorialgroup)
       @trialuse = args.delete(:trialuse)

data/lib/relaton_ieee/ieee_bibliography.rb

@@ -3,10 +3,14 @@ module RelatonIeee
     class << self
       GH_URL = "https://raw.githubusercontent.com/relaton/relaton-data-ieee/main/data/".freeze
 
+      #
+      # Search IEEE bibliography item by reference.
+      #
       # @param code [String]
+      #
       # @return [RelatonIeee::HitCollection]
+      #
       def search(code)
-        # HitCollection.new text
         ref = code.sub(/Std\s/i, "").gsub(/[\s,:\/]/, "_").squeeze("_").upcase
         url = "#{GH_URL}#{ref}.yaml"
         resp = Faraday.get url
@@ -17,77 +21,26 @@ module RelatonIeee
         raise RelatonBib::RequestError, "Could not access #{GH_URL}"
       end
 
+      #
+      # Get IEEE bibliography item by reference.
+      #
       # @param code [String] the IEEE standard Code to look up (e..g "528-2019")
       # @param year [String] the year the standard was published (optional)
       # @param opts [Hash] options
       #
       # @return [Hash, NilClass] returns { ret: RelatonBib::BibliographicItem }
       #   if document is found else returns NilClass
+      #
       def get(code, _year = nil, _opts = {}) # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
         warn "[relaton-ieee] (\"#{code}\") fetching..."
         item = search(code)
-        # year ||= code.match(/(?<=-)\d{4}/)&.to_s
-        # ret = bib_results_filter(result, code, year)
-        if item # ret[:ret]
-          # item = ret[:ret].fetch
+        if item
           warn "[relaton-ieee] (\"#{code}\") found #{item.docidentifier.first.id}"
           item
-        # else
-        #   fetch_ref_err(code, year, ret[:years])
+        else
+          warn "[relaton-ieee] (\"#{code}\") not found"
         end
       end
-
-      private
-
-      # Sort through the results from RelatonIeee, fetching them three at a time,
-      # and return the first result that matches the code,
-      # matches the year (if provided), and which # has a title (amendments do not).
-      # Only expects the first page of results to be populated.
-      # Does not match corrigenda etc (e.g. ISO 3166-1:2006/Cor 1:2007)
-      # If no match, returns any years which caused mismatch, for error reporting
-      #
-      # @param result [RelatonIeee::HitCollection]
-      # @param opts [Hash] options
-      #
-      # @return [Hash]
-      # def bib_results_filter(result, ref, year) # rubocop:disable Metrics/AbcSize
-      #   rp1 = ref_parts ref
-      #   missed_years = []
-      #   result.each do |hit|
-      #     rp2 = ref_parts hit.hit[:ref]
-      #     next if rp1[:code] != rp2[:code] || rp1[:corr] != rp2[:corr]
-
-      #     return { ret: hit } if !year
-
-      #     return { ret: hit } if year.to_i == hit.hit[:year]
-
-      #     missed_years << hit.hit[:year]
-      #   end
-      #   { years: missed_years.uniq }
-      # end
-
-      # def ref_parts(ref)
-      #   %r{
-      #     ^(?:IEEE\s(?:Std\s)?)?
-      #     (?<code>[^-/]+)
-      #     (?:-(?<year>\d{4}))?
-      #     (?:/(?<corr>\w+\s\d+-\d{4}))?
-      #   }x.match ref
-      # end
-
-      # @param code [Strig]
-      # @param year [String]
-      # @param missed_years [Array<Strig>]
-      # def fetch_ref_err(code, year, missed_years)
-      #   id = year ? "#{code} year #{year}" : code
-      #   warn "[relaton-ieee] WARNING: no match found online for #{id}. "\
-      #     "The code must be exactly like it is on the standards website."
-      #   unless missed_years.empty?
-      #     warn "[relaton-ieee] (There was no match for #{year}, though there were matches "\
-      #       "found for #{missed_years.join(', ')}.)"
-      #   end
-      #   nil
-      # end
     end
   end
 end

data/lib/relaton_ieee/processor.rb

@@ -41,7 +41,7 @@ module RelatonIeee
     # @param hash [Hash]
     # @return [RelatonIeee::IeeeBibliographicItem]
     def hash_to_bib(hash)
-      ::RelatonIeee::IeeeBibliographicItem.new hash
+      ::RelatonIeee::IeeeBibliographicItem.new(**hash)
     end
 
     # Returns hash of XML grammar

data/lib/relaton_ieee/version.rb

@@ -1,3 +1,3 @@
 module RelatonIeee
-  VERSION = "1.12.7".freeze
+  VERSION = "1.12.8".freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: relaton-ieee
 version: !ruby/object:Gem::Version
-  version: 1.12.7
+  version: 1.12.8
 platform: ruby
 authors:
 - Ribose Inc.
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-07-28 00:00:00.000000000 Z
+date: 2022-08-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: equivalent-xml
@@ -154,7 +154,6 @@ files:
 - lib/relaton_ieee/editorial_group.rb
 - lib/relaton_ieee/hash_converter.rb
 - lib/relaton_ieee/hit.rb
-- lib/relaton_ieee/hit_collection.rb
 - lib/relaton_ieee/ieee_bibliographic_item.rb
 - lib/relaton_ieee/ieee_bibliography.rb
 - lib/relaton_ieee/processor.rb

data/lib/relaton_ieee/hit_collection.rb

@@ -1,42 +0,0 @@
-require "faraday"
-require "relaton_ieee/hit"
-require "fileutils"
-
-module RelatonIeee
-  class HitCollection < RelatonBib::HitCollection
-    # DOMAIN = "https://standards.ieee.org".freeze
-    GH_URL = "https://raw.githubusercontent.com/relaton/relaton-data-ieee/main/data/".freeze
-
-    # @param reference [Strig]
-    # @param opts [Hash]
-    def initialize(reference) # rubocop:disable Metrics/MethodLength, Metrics/AbcSize
-      super
-      ref = reference.gsub(/[\s,:\/]/, "_").squeeze("_").upcase
-      url = "#{GH_URL}#{ref}.yaml"
-      resp = Faraday.get url
-      hit = YAML.load resp.body
-      # code1 = reference.sub(/^IEEE\s(Std\s)?/, "")
-      # url = "#{DOMAIN}/wp-admin/admin-ajax.php"
-      # query = reference.gsub("/", " ")
-      # resp = Faraday.post url, { action: "ieee_cloudsearch", q: query }
-      # json = JSON.parse resp.body
-      # unless json["results"]
-      #   @array = []
-      #   return
-      # end
-
-      # @array = json["results"]["hits"]["hit"].reduce([]) do |s, hit|
-      #   flds = hit["fields"]
-      #   /^(?:\w+\s)?(?<code2>[A-Z\d.]+)(?:-(?<year>\d{4}))?/ =~ flds["meta_designation_l"]
-      #   next s unless code2 && code1 =~ %r{^#{code2}}
-
-      #   hit_data = {
-      #     ref: flds["meta_designation_l"],
-      #     year: year.to_i,
-      #     url: flds["doc_id_l"],
-      #   }
-      #   s << Hit.new(hit_data, self)
-      # end.sort_by { |h| h.hit[:year].to_s + h.hit[:url] }.reverse
-    end
-  end
-end