relaton-bsi 1.16.0 → 1.16.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 02a7a2396cd1217d1136a7a9b386faa0e68dc323c2b575432135eaceb82d5a49
-  data.tar.gz: 78d05d994d33be9bfaf38563fdbac05a394d49a9bd6e52a0e331935e1d821087
+  metadata.gz: beee0d1d60affb54c0d473077b8b792271bd773a89462aa9668794a47c8c37b4
+  data.tar.gz: 3f4a940e53481c52b6ff1d155a0ae1e9cccdc20a768753d59efb042beed7a80b
 SHA512:
-  metadata.gz: 1a8472d369486ba81fc493a275d8b14df1aff5a398441b31adbec582a9f9b989f14c9b325e0fb5e7004361481e7f3103d07d766d1945255a1b1de7a92d61c565
-  data.tar.gz: 83cdb931c8c3de6496e03ff95797e075683c20b9bb97ac6a230b9fdae82f2d7c1d5709a3572932e6f03e56955dacc905b904d4e01b2d29c66aa0494fe2c677a4
+  metadata.gz: d890a38ea4d5ba876d4e6e8497347e45bb3067aca5796f8c574a8d7de9e337836655158d9f3ce1ed1d1687c923750ee570b80994ea238be9e32df156bc6fd808
+  data.tar.gz: c12c4a02bd22a07cd63378de4a2a701df11e119e12717e8e28d74b7c6ce453712c123b8b55a10675f3b78e7bce23aebbc0187bb79ef5366e43aab0de46e7e3a5

data/README.adoc

@@ -27,13 +27,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 `RelatonBsi.configure` block.
 
 [source,ruby]
 ----
 require 'relaton_bsi'
 => true
 
+RelatonBsi.configure do |config|
+  config.logger.level = Logger::DEBUG
+end
+----
+
+=== Search for a standard using keywords
+
+[source,ruby]
+----
 hit_collection = RelatonBsi::BsiBibliography.search("BS EN ISO 8848")
 => <RelatonBsi::HitCollection:0x007fead49fe1f8 @ref=BS EN ISO 8848 @fetched=false>
 
@@ -89,14 +100,14 @@ item.to_xml bibdata: true
 [source,ruby]
 ----
 RelatonBsi::BsiBibliography.get "BS EN ISO 8848:2021"
-[relaton-bsi] ("BS EN ISO 8848:2021") fetching...
-[relaton-bsi] ("BS EN ISO 8848:2021") found BS EN ISO 8848:2021
+[relaton-bsi] (BS EN ISO 8848:2021) Fetching from shop.bsigroup.com ...
+[relaton-bsi] (BS EN ISO 8848:2021) Found: `BS EN ISO 8848:2021`
 => #<RelatonBsi::BsiBibliographicItem:0x007feb14814ca8
 ...
 
 RelatonBsi::BsiBibliography.get "BS EN ISO 8848", "2021"
-[relaton-bsi] ("BS EN ISO 8848") fetching...
-[relaton-bsi] ("BS EN ISO 8848") found BS EN ISO 8848:2021
+[relaton-bsi] (BS EN ISO 8848) Fetching from shop.bsigroup.com ...
+[relaton-bsi] (BS EN ISO 8848) Found: `BS EN ISO 8848:2021`
 => #<RelatonBsi::BsiBibliographicItem:0x007feaf59188a8
 ...
 ----

data/lib/relaton_bsi/bsi_bibliographic_item.rb

@@ -11,8 +11,8 @@ module RelatonBsi
 
     def initialize(**args) # rubocop:disable Metrics/AbcSize
       if args[:subdoctype] && !SUBDOCTYPES.include?(args[:subdoctype])
-        warn "[relaton-bsi] WARNING: invalid subdoctype: #{args[:subdoctype]}"
-        warn "[relaton-bsi] Allowed subdoctypes are: #{SUBDOCTYPES.join(', ')}"
+        Util.warn "WARNING: invalid subdoctype: `#{args[:subdoctype]}`"
+        Util.warn "Allowed subdoctypes are: `#{SUBDOCTYPES.join('`, `')}`"
       end
       super
     end

data/lib/relaton_bsi/bsi_bibliography.rb

@@ -1,14 +1,5 @@
 # frozen_string_literal: true
 
-# require "mechanize"
-require "relaton_iso_bib"
-require "relaton_bsi/bsi_bibliographic_item"
-require "relaton_bsi/scrapper"
-require "relaton_bsi/hit_collection"
-require "relaton_bsi/hit"
-require "relaton_bsi/xml_parser"
-require "relaton_bsi/hash_converter"
-
 module RelatonBsi
   # Class methods for search ISO standards.
   class BsiBibliography
@@ -64,11 +55,11 @@ module RelatonBsi
       def fetch_ref_err(code, year, missed_years) # rubocop:disable Metrics/MethodLength
         y = code_parts(code)[:year]
         id = year && !y ? "#{code}:#{year}" : code
-        warn "[relaton-bsi] WARNING: no match found online for #{id}. "\
-             "The code must be exactly like it is on the standards website."
+        Util.warn "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-bsi] (There was no match for #{year}, though there "\
-               "were matches found for #{missed_years.join(', ')}.)"
+          Util.warn "There was no match for `#{year}`, though there " \
+                    "were matches found for `#{missed_years.join('`, `')}`."
         end
         # if /\d-\d/.match? code
         #   warn "[relaton-bsi] The provided document part may not exist, or "\
@@ -91,8 +82,11 @@ module RelatonBsi
       #
       def search_filter(code)
         cp = code_parts code
-        warn "[relaton-bsi] (\"#{code}\") fetching..."
-        return [] unless cp
+        Util.warn "(#{code}) Fetching from shop.bsigroup.com ..."
+        unless cp
+          Util.warn "(#{code}) Could not parse the reference"
+          return []
+        end
 
         search(code).filter_hits!(cp)
       end
@@ -121,9 +115,10 @@ module RelatonBsi
         result = search_filter(code) || return
         ret = results_filter(result, year)
         if ret[:ret]
-          warn "[relaton-bsi] (\"#{code}\") found #{ret[:ret].docidentifier.first&.id}"
+          Util.warn "(#{code}) Found: `#{ret[:ret].docidentifier.first&.id}`"
           ret[:ret]
         else
+          Util.warn "(#{code}) No found"
           fetch_ref_err(code, year, ret[:years])
         end
       end

data/lib/relaton_bsi/config.rb

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

data/lib/relaton_bsi/util.rb

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

data/lib/relaton_bsi/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module RelatonBsi
-  VERSION = "1.16.0"
+  VERSION = "1.16.2"
 end

data/lib/relaton_bsi.rb

@@ -1,15 +1,24 @@
 # frozen_string_literal: true
 
+require "relaton_iso_bib"
 require_relative "relaton_bsi/version"
+require "relaton_bsi/config"
+require "relaton_bsi/util"
 require "relaton_bsi/bsi_bibliography"
+require "relaton_bsi/bsi_bibliographic_item"
+require "relaton_bsi/scrapper"
+require "relaton_bsi/hit_collection"
+require "relaton_bsi/hit"
+require "relaton_bsi/xml_parser"
+require "relaton_bsi/hash_converter"
 
 module RelatonBsi
   # Returns hash of XML greammar
   # @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 RelatonBsi::VERSION + RelatonIsoBib::VERSION + RelatonBib::VERSION # grammars
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: relaton-bsi
 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-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: algolia
@@ -94,12 +94,14 @@ files:
 - lib/relaton_bsi.rb
 - lib/relaton_bsi/bsi_bibliographic_item.rb
 - lib/relaton_bsi/bsi_bibliography.rb
+- lib/relaton_bsi/config.rb
 - lib/relaton_bsi/hash_converter.rb
 - lib/relaton_bsi/hit.rb
 - lib/relaton_bsi/hit_collection.rb
 - lib/relaton_bsi/processor.rb
 - lib/relaton_bsi/schema.json
 - lib/relaton_bsi/scrapper.rb
+- lib/relaton_bsi/util.rb
 - lib/relaton_bsi/version.rb
 - lib/relaton_bsi/xml_parser.rb
 - relaton_bsi.gemspec