relaton-ieee 1.16.0 → 1.16.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1b3158476d1e01a14fa8ca158d5216f0aa4f0f67a29ecb642a297dc60ff70e2d
-  data.tar.gz: 10a6247158f7f63edbfc26ba0598cb90fd9bee5413a533de18f1544a0d5c8210
+  metadata.gz: 0e079c3a74f3f1ee1a1c3571fad7415228bc2f97e302612adf3d308bd799f613
+  data.tar.gz: 56928364c2d39df1e75e2034348e0ae25dad573b6e99d4ebe7d6c2faf9419abd
 SHA512:
-  metadata.gz: dac9f194398e435db9884395e146beaf10932612b27cf29a7283779d761b7c120f8db2b35908bc70bf6b749004cf995745d34c92ea3e04854e3b54e246e1f2ff
-  data.tar.gz: 76fbc102622c419171bd15006722eaedfffa2ec70ee42f87f343960508309cfb439ad43dead51bc14dd3b6adeb9a0ace7e5a9085dfdb9e5e7ea197bcdea357d6
+  metadata.gz: 6298c1fb4d18e8cc8c03535978d5bfd1ab632fe6d772dde22357a5196da75a812bffbb53fea47b52017fa6e55fbcf41257c5140f8cebe2d8e2ec7d45a61f6697
+  data.tar.gz: 5137a02683f0bc8dd1032f216f574d2f9ecdc000a12faa807b0604467ef4c4c7e0339822cf7d603f1bbae3b8c7cde20eb5df070c77dc5b04030a50b055e01cc8

data/README.adoc

@@ -23,13 +23,24 @@ Or install it yourself as:
 
 == Usage
 
-=== Search for a standard using keywords
+=== Configuration
+
+Configuration is optional. The available option is `logger` which is a `Logger` instance. By default, the logger is `Logger.new($stderr)` with `Logger::WARN` level. To change the logger level, use `RelatonIeee.configure` block.
 
 [source,ruby]
 ----
 require 'relaton_ieee'
 => true
 
+RelatonIeee.configure do |config|
+  config.logger.level = Logger::DEBUG
+end
+----
+
+=== Search for a standard using keywords
+
+[source,ruby]
+----
 item = RelatonIeee::IeeeBibliography.search("IEEE 528-2019")
 => #<RelatonIeee::IeeeBibliographicItem:0x00007fe12ebc8cb8
 ...
@@ -73,8 +84,8 @@ item.to_xml bibdata: true
 [source,ruby]
 ----
 RelatonIeee::IeeeBibliography.get("IEEE 528-2019")
-[relaton-ieee] ("IEEE 528-2019") fetching...
-[relaton-ieee] ("IEEE 528-2019") found IEEE 528-2019
+[relaton-ieee] (IEEE 528-2019) fetching...
+[relaton-ieee] (IEEE 528-2019) found `IEEE 528-2019`
  => #<RelatonIeee::IeeeBibliographicItem:0x007fceb52a6e40
  ...
 ----

data/lib/relaton_ieee/balloting_group.rb

@@ -13,7 +13,7 @@ module RelatonIeee
     #
     def initialize(type:, content:)
       unless TYPES.include?(type)
-        warn "[relaton-ieee] WARNING: type of Balloting group must be one of #{TYPES.join(', ')}"
+        Util.warn "WARNING: type of Balloting group must be one of `#{TYPES.join('`, `')}`"
       end
 
       @type = type

data/lib/relaton_ieee/config.rb

@@ -0,0 +1,10 @@
+module RelatonIeee
+  module Config
+    include RelatonBib::Config
+  end
+  extend Config
+
+  class Configuration < RelatonBib::Configuration
+    PROGNAME = "relaton-ieee".freeze
+  end
+end

data/lib/relaton_ieee/document_status.rb

@@ -5,7 +5,7 @@ module RelatonIeee
 
       def initialize(value:, abbreviation: nil)
         unless STAGES.include?(value.downcase)
-          warn "[relaton-ieee] Stage value must be one of #{STAGES.join(', ')}"
+          Util.warn "Stage value must be one of: `#{STAGES.join('`, `')}`"
         end
         super
       end

data/lib/relaton_ieee/ieee_bibliographic_item.rb

@@ -25,12 +25,12 @@ module RelatonIeee
     #
     def initialize(**args) # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
       if args[:doctype] && !DOCTYPES.include?(args[:doctype])
-        warn "[relaton-ieee] invalid doctype \"#{args[:doctype]}\". " \
-             "It should be one of: #{DOCTYPES.join(', ')}."
+        Util.warn "Invalid doctype: `#{args[:doctype]}`. " \
+                  "It should be one of: `#{DOCTYPES.join('`, `')}`."
       end
       if args[:docsubtype] && !SUBTYPES.include?(args[:docsubtype])
-        warn "[relaton-ieee] invalid docsubtype \"#{args[:docsubtype]}\". " \
-             "It should be one of: #{SUBTYPES.join(', ')}."
+        Util.warn "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

@@ -38,13 +38,14 @@ module RelatonIeee
       #   if document is found else returns NilClass
       #
       def get(code, _year = nil, _opts = {}) # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
-        warn "[relaton-ieee] (\"#{code}\") fetching..."
+        Util.warn "(#{code}) Fetching from Relaton repository ..."
         item = search(code)
         if item
-          warn "[relaton-ieee] (\"#{code}\") found #{item.docidentifier.first.id}"
+          Util.warn "(#{code}) Found: `#{item.docidentifier.first.id}`"
           item
         else
-          warn "[relaton-ieee] (\"#{code}\") not found"
+          Util.warn "(#{code}) Not found."
+          nil
         end
       end
     end

data/lib/relaton_ieee/rawbib_id_parser.rb

@@ -456,7 +456,7 @@ module RelatonIeee
         PubId.new(publisher: $1, number: $2)
 
       else
-        warn %{Use stdnumber "#{stdnumber}" for nortitle "#{normtitle}"}
+        Util.warn %{Use stdnumber "#{stdnumber}" for nortitle "#{normtitle}"}
         PubId.new(publisher: "IEEE", number: stdnumber)
       end
     rescue ArgumentError => e

data/lib/relaton_ieee/util.rb

@@ -0,0 +1,9 @@
+module RelatonIeee
+  module Util
+    extend RelatonBib::Util
+
+    def self.logger
+      RelatonIeee.configuration.logger
+    end
+  end
+end

data/lib/relaton_ieee/version.rb

@@ -1,3 +1,3 @@
 module RelatonIeee
-  VERSION = "1.16.0".freeze
+  VERSION = "1.16.2".freeze
 end

data/lib/relaton_ieee.rb

@@ -4,6 +4,8 @@ require "yaml"
 require "relaton/index"
 require "relaton_bib"
 require "relaton_ieee/version"
+require "relaton_ieee/config"
+require "relaton_ieee/util"
 require "relaton_ieee/document_status"
 require "relaton_ieee/ieee_bibliography"
 require "relaton_ieee/ieee_bibliographic_item"
@@ -20,9 +22,9 @@ module RelatonIeee
   # Returns hash of XML reammar
   # @return [String]
   def self.grammar_hash
-    gem_path = File.expand_path "..", __dir__
-    grammars_path = File.join gem_path, "grammars", "*"
-    grammars = Dir[grammars_path].sort.map { |gp| File.read gp }.join
-    Digest::MD5.hexdigest grammars
+    # gem_path = File.expand_path "..", __dir__
+    # grammars_path = File.join gem_path, "grammars", "*"
+    # grammars = Dir[grammars_path].sort.map { |gp| File.read gp }.join
+    Digest::MD5.hexdigest RelatonIeee::VERSION + RelatonBib::VERSION # grammars
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: relaton-ieee
 version: !ruby/object:Gem::Version
-  version: 1.16.0
+  version: 1.16.2
 platform: ruby
 authors:
 - Ribose Inc.
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-09-03 00:00:00.000000000 Z
+date: 2023-10-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -108,6 +108,7 @@ files:
 - lib/relaton_ieee.rb
 - lib/relaton_ieee/balloting_group.rb
 - lib/relaton_ieee/bibxml_parser.rb
+- lib/relaton_ieee/config.rb
 - lib/relaton_ieee/data_fetcher.rb
 - lib/relaton_ieee/data_parser.rb
 - lib/relaton_ieee/document_status.rb
@@ -118,6 +119,7 @@ files:
 - lib/relaton_ieee/processor.rb
 - lib/relaton_ieee/pub_id.rb
 - lib/relaton_ieee/rawbib_id_parser.rb
+- lib/relaton_ieee/util.rb
 - lib/relaton_ieee/version.rb
 - lib/relaton_ieee/xml_parser.rb
 - relaton_ieee.gemspec