relaton-iho 1.16.0 → 1.16.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7f42703d14350d77f2b7f27e05bcd39eb2368b93e41663958334510b4f39de72
-  data.tar.gz: 4858a670fa0dbb5c1d12fd2401ebbce7ef44c9dd57d5f3a30498abb700f2b82d
+  metadata.gz: 86d710da9b97b769ffffa9b42765e8b953b42d78f9a1528ae84e0426562812af
+  data.tar.gz: 2776acafcc19b1e959ecc5c5f183ce74b4fa033ae40a40bfbe83379eebcd2a6f
 SHA512:
-  metadata.gz: adf0bec1036948bb9501671ca7116aad714d9accdeeb4ab973c7aec4d64bdf74ffb0a7dc9952d007a19d7ddb6a133d2f146190e4c6c06cd823e5bf8cc80ce7a2
-  data.tar.gz: e08a8892bdc5f10e359fcba761c8f0bd1757bfe91abb7e906fa866c7697a03f97c1cbc0d8bb90da92a228d89208efebb20bf23228439d58a89be9f6e99131245
+  metadata.gz: fae3afa87bd593e6245bdaedaed955ea3e4e5ae49f898549ce244e9742591aad80bf33a3436f334a9e1aea4d6898456741d5fada7a3d31d927be428311988f10
+  data.tar.gz: d91cd33057f9ad518a029820609396067d7152d3e75c5a81d10326d32e1107052477274f262225c3335b5e9d5cc31bbbc964e412d1ffa156754d8168ad6a82c3

data/README.adoc

@@ -37,26 +37,37 @@ $ gem install relaton-iho
 
 == Usage
 
-=== Search for a standard using keywords
+=== Configuration
 
-Reference can be specified with or without an edition. References without an edition will return the latest edition of the standard. References with an edition will return the standard with the specified edition.
+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 `RelatonIho.configure` block.
 
 [source,ruby]
 ----
 require 'relaton_iho'
 => true
 
+RelatonIho.configure do |config|
+  config.logger.level = Logger::DEBUG
+end
+----
+
+=== Search for a standard using keywords
+
+Reference can be specified with or without an edition. References without an edition will return the latest edition of the standard. References with an edition will return the standard with the specified edition.
+
+[source,ruby]
+----
 # Search for a standard using a reference without an edition
 item = RelatonIho::IhoBibliography.search("IHO B-11")
-[relaton-iho] ("IHO B-11") fetching...
-[relaton-iho] ("IHO B-11") found B-11
+[relaton-iho] (IHO B-11) Fetching from Relaton repository ...
+[relaton-iho] (IHO B-11) Found: `B-11`
 => #<RelatonIho::IhoBibliographicItem:0x007fe74fc80800
 ...
 
 # Search for a standard using a reference with an edition
 item = RelatonIho::IhoBibliography.search("IHO B-11 1.0.0")
-[relaton-iho] ("IHO B-11 1.0.0") fetching...
-[relaton-iho] ("IHO B-11 1.0.0") found B-11
+[relaton-iho] (IHO B-11 1.0.0) Fetchint from Rlaont repository ...
+[relaton-iho] (IHO B-11 1.0.0) Found: `B-11`
 => #<RelatonIho::IhoBibliographicItem:0x00007fe79d0ed698
 ...
 ----
@@ -95,8 +106,8 @@ item.to_xml bibdata: true
 [source,ruby]
 ----
 RelatonIho::IhoBibliography.get "IHO B-11"
-[relaton-iho] ("IHO B-11") fetching...
-[relaton-iho] ("IHO B-11") found B-11
+[relaton-iho] (IHO B-11) Fetching from Relaton repository ...
+[relaton-iho] (IHO B-11) Found: `B-11`
 => #<RelatonIho::IhoBibliographicItem:0x007fe78dbb7c78
 ...
 ----

data/lib/relaton_iho/config.rb

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

data/lib/relaton_iho/iho_bibliography.rb

@@ -14,21 +14,26 @@ module RelatonIho
       # @return [RelatonIho::IhoBibliographicItem, nil] the IHO standard or nil if not found
       #
       def search(text, _year = nil, _opts = {}) # rubocop:disable Metrics/MethodLength, Metrics/AbcSize
-        warn "[relaton-iho] (\"#{text}\") fetching..."
+        Util.warn "(#{text}) Fetching from Relaton repository ..."
         ref = text.sub(/^IHO\s/, "").sub(/^([[:alpha:]]+)(\d+)/, '\1-\2')
         index = Relaton::Index.find_or_create :iho, url: "#{ENDPOINT}index.zip"
         row = index.search(ref).max_by { |r| r[:id] }
-        return unless row
+        unless row
+          Util.warn "(#{text}) Not found."
+          return
+        end
 
         uri = URI("#{ENDPOINT}#{row[:file]}")
         resp = Net::HTTP.get_response uri
-        return unless resp.code == "200"
+        unless resp.code == "200"
+          raise RelatonBib::RequestError, "Could not access #{uri}: HTTP #{resp.code}"
+        end
 
         yaml = RelatonBib.parse_yaml resp.body, [Date]
         hash = HashConverter.hash_to_bib yaml
         hash[:fetched] = Date.today.to_s
         item = IhoBibliographicItem.new(**hash)
-        warn "[relaton-iho] (\"#{text}\") found #{item.docidentifier.first.id}"
+        Util.warn "(#{text}) Found: `#{item.docidentifier.first.id}`"
         item
       rescue SocketError, Errno::EINVAL, Errno::ECONNRESET, EOFError,
              Net::HTTPBadResponse, Net::HTTPHeaderSyntaxError,

data/lib/relaton_iho/util.rb

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

data/lib/relaton_iho/version.rb

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

data/lib/relaton_iho.rb

@@ -3,6 +3,8 @@ require "yaml"
 require "relaton_bib"
 require "relaton/index"
 require "relaton_iho/version"
+require "relaton_iho/config"
+require "relaton_iho/util"
 require "relaton_iho/iho_bibliography"
 require "relaton_iho/hash_converter"
 require "relaton_iho/xml_parser"
@@ -17,9 +19,9 @@ module RelatonIho
   # 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 RelatonIho::VERSION + RelatonBib::VERSION # grammars
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: relaton-iho
 version: !ruby/object:Gem::Version
-  version: 1.16.0
+  version: 1.16.2
 platform: ruby
 authors:
 - Ribose Inc.
 autorequire: 
 bindir: bin
 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
@@ -62,6 +62,7 @@ files:
 - grammars/relaton-iho.rng
 - lib/relaton_iho.rb
 - lib/relaton_iho/comment_periond.rb
+- lib/relaton_iho/config.rb
 - lib/relaton_iho/editorial_group.rb
 - lib/relaton_iho/eg.yml
 - lib/relaton_iho/hash_converter.rb
@@ -69,6 +70,7 @@ files:
 - lib/relaton_iho/iho_bibliography.rb
 - lib/relaton_iho/iho_group.rb
 - lib/relaton_iho/processor.rb
+- lib/relaton_iho/util.rb
 - lib/relaton_iho/version.rb
 - lib/relaton_iho/xml_parser.rb
 - relaton_iho.gemspec