relaton-ietf 1.16.0 → 1.16.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d6e85cde14717a5171d911a03dd3f069ab295314a9750a4795ee4a40694ad525
-  data.tar.gz: d5e62680f2a47c54131c8f9a14bcf03eacd00c86377d99f8a4f126e295afc03c
+  metadata.gz: f991e579da3f0e467e20d1af8eb3215fc4f7c03f8dca773359da7262b4557a71
+  data.tar.gz: a8993337405ef4de678ce8b40670b93478dda1cf43c4e44bb33f1a0b13a960a0
 SHA512:
-  metadata.gz: af082b142044e88a11d1580c8f1dc2cc8a21a3cabd26a166622513125bcee6f5acd9212233dfabcf21a4a5bb0194ad27274a06577ce76f2e1afc2623d94d6a74
-  data.tar.gz: 608c4bcfb0cee144a867b8cdfc04ceda41554b73a744d43cb1d10e48d4ddca691ba756a62be457dbea0aea77e22d1e162ebc9d3db22349742b6f683584771b12
+  metadata.gz: 98d758c3fbaaf0c76e8c4c144e1a7fc5d3e55ccf4f922dd242f11882c7e6d2c759f027dc9f06b344ad6d3486c84d35f237ca878e3e6c9befcfaace406c1b698c
+  data.tar.gz: d5d739811a64be1aa4417a2958ffc9a91ca159c9a94c2655a50e6a0d6ea2d9c73684cc639edcc23939672aeae9d238f6c430216f79787ab29aae589ef6a1888a

data/README.adoc

@@ -33,31 +33,42 @@ Or install it yourself as:
 
 == Usage
 
-=== Fetching documents
+=== 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 `RelatonIetf.configure` block.
 
 [source,ruby]
 ----
 require 'relaton_ietf'
 => true
 
+RelatonIetf.configure do |config|
+  config.logger.level = Logger::DEBUG
+end
+----
+
+=== Fetching documents
+
+[source,ruby]
+----
 # Fetch RFC document
 item = RelatonIetf::IetfBibliography.get 'IETF RFC 8341'
-[relaton-ietf] ("IETF RFC 8341") fetching...
-[relaton-ietf] ("IETF RFC 8341") found RFC 8341
+[relaton-ietf] (IETF RFC 8341) Fetching from Relaton repository ...
+[relaton-ietf] (IETF RFC 8341) Found: `RFC 8341`
 => #<RelatonIetf::IetfBibliographicItem:0x007fd1875e7f58
 ...
 
 # Fetch Internet-Draft document
 RelatonIetf::IetfBibliography.get 'IETF I-D.draft-abarth-cake-01'
-[relaton-ietf] ("IETF I-D.draft-abarth-cake-01") fetching...
-[relaton-ietf] ("IETF I-D.draft-abarth-cake-01") found draft-abarth-cake-01
+[relaton-ietf] (IETF I-D.draft-abarth-cake-01) Fetching from Relaton repository ...
+[relaton-ietf] (IETF I-D.draft-abarth-cake-01) Found: `draft-abarth-cake-01`
 => #<RelatonIetf::IetfBibliographicItem:0x00007fdd129bbeb8
 ...
 
 # Return nil if a document doesn't exist.
 RelatonIetf::IetfBibliography.get 'IETF 1111'
-[relaton-ietf] ("IETF 1111") fetching...
-[relaton-ietf] ("IETF 1111") not found
+[relaton-ietf] (IETF 1111) Fetching from Relaton repository ...
+[relaton-ietf] (IETF 1111) Not found.
 => nil
 ----
 

data/lib/relaton_ietf/config.rb

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

data/lib/relaton_ietf/ietf_bibliographic_item.rb

@@ -13,7 +13,7 @@ module RelatonIetf
     # @param stream [String, nil]
     def initialize(**args)
       if args[:doctype] && !DOCTYPES.include?(args[:doctype])
-        warn "[relaton-ietf] WARNING: invalid doctype #{args[:doctype]}"
+        Util.warn "WARNING: Invalid doctype: `#{args[:doctype]}`"
       end
       @stream = args.delete(:stream)
       super

data/lib/relaton_ietf/ietf_bibliography.rb

@@ -18,13 +18,13 @@ module RelatonIetf
       #   reference is required
       # @return [RelatonIetf::IetfBibliographicItem] Relaton of reference
       def get(code, _year = nil, _opts = {})
-        warn "[relaton-ietf] (\"#{code}\") fetching..."
+        Util.warn "(#{code}) Fetching from Relaton repository ..."
         result = search code
         if result
           docid = result.docidentifier.detect(&:primary) || result.docidentifier.first
-          warn "[relaton-ietf] (\"#{code}\") found #{docid.id}"
+          Util.warn "(#{code}) Found: `#{docid.id}`"
         else
-          warn "[relaton-ietf] (\"#{code}\") not found"
+          Util.warn "(#{code}) Not found."
         end
         result
       end

data/lib/relaton_ietf/util.rb

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

data/lib/relaton_ietf/version.rb

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

data/lib/relaton_ietf.rb

@@ -4,6 +4,8 @@ require "net/http"
 require "relaton/index"
 require "relaton_bib"
 require "relaton_ietf/version"
+require "relaton_ietf/config"
+require "relaton_ietf/util"
 require "relaton_ietf/bibxml_parser"
 require "relaton_ietf/ietf_bibliography"
 require "relaton_ietf/xml_parser"
@@ -16,9 +18,9 @@ module RelatonIetf
   # 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 RelatonIetf::VERSION + RelatonBib::VERSION # grammars
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: relaton-ietf
 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: relaton-bib
@@ -71,6 +71,7 @@ files:
 - lib/relaton_ietf.rb
 - lib/relaton_ietf/bibxml_parser.rb
 - lib/relaton_ietf/committee.rb
+- lib/relaton_ietf/config.rb
 - lib/relaton_ietf/data_fetcher.rb
 - lib/relaton_ietf/hash_converter.rb
 - lib/relaton_ietf/ietf_bibliographic_item.rb
@@ -80,6 +81,7 @@ files:
 - lib/relaton_ietf/rfc_entry.rb
 - lib/relaton_ietf/rfc_index_entry.rb
 - lib/relaton_ietf/scrapper.rb
+- lib/relaton_ietf/util.rb
 - lib/relaton_ietf/version.rb
 - lib/relaton_ietf/xml_parser.rb
 - relaton_ietf.gemspec