relaton-bipm 1.16.0 → 1.16.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b1db042c4a912ff57cf2fc14c3d7f43047e06f44ac3f30f45564ea9214201571
-  data.tar.gz: d089989213bb5b37722e493600852c687ad1e889983d75f874c691e970e71ad4
+  metadata.gz: ced155bf740bb8a1bb34fffc1c58bb864b753236abeb8a406aef9a2a509835c2
+  data.tar.gz: 7111b47d1617da91a47919336d2bc665de041e3ae109d06e0182ea9ad01ff140
 SHA512:
-  metadata.gz: 896bdd6d0bab83f90479990c232a34a35d5a6a76a0ea4514410741e2febf94622b103d0e6403aeebd4acec5a2a347d03232a56f7cb33298b94bd1e347e40a62b
-  data.tar.gz: 9175449ecb0da4a81389203aeccd1c541f2fd6f2f6028c087e9c40f263b143ffebc5c768df3bb299007e6150fccdfa51cd98b180d274363f902642df3a47a316
+  metadata.gz: d48462fd26483e16041580591fd0b3b5e0f58bdea4058dab03210606e1f49f6ddaddfe0b69a9e4c1e930496b56580315f2ad14644a1fb04abae4d991009c0004
+  data.tar.gz: 2e8ac7afb0fda2c8f8f1acf1beb00c3870ab8941250f124e718e3b6f251d67dfc69442251c4ec6965c4e5a895d90d7da8e5354976152a87691e11980e832da0a

data/README.adoc

@@ -187,76 +187,87 @@ Recommendation JCRB/43-1 (2021) / Recommandation JCRB/43-1 (2021)
 JCRB REC JCRB/43-1 (2021)
 ----
 
-==== Examples
+=== 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 `RelatonBipm.configure` block.
 
 [source,ruby]
 ----
 require 'relaton_bipm'
 => true
 
+RelatonBipm.configure do |config|
+  config.logger.level = Logger::DEBUG
+end
+----
+
+==== Examples
+
+[source,ruby]
+----
 # get BIPM brochure
 item = RelatonBipm::BipmBibliography.get "BIPM SI Brochure"
-[relaton-bipm] ("BIPM SI Brochure") fetching...
-[relaton-bipm] ("BIPM SI Brochure") found BIPM SI Brochure
+[relaton-bipm] (BIPM SI Brochure) fetching...
+[relaton-bipm] (BIPM SI Brochure) found `BIPM SI Brochure`
 => #<RelatonBipm::BipmBibliographicItem:0x007ffb83982fe8
 ...
 
 # get BIPM Metrologia page
 bib = RelatonBipm::BipmBibliography.get "BIPM Metrologia 29 6 001"
-[relaton-bipm] ("BIPM Metrologia 29 6 001") fetching...
-[relaton-bipm] ("BIPM Metrologia 29 6 001") found Metrologia 29 6 001
+[relaton-bipm] (BIPM Metrologia 29 6 001) fetching...
+[relaton-bipm] (BIPM Metrologia 29 6 001) found `Metrologia 29 6 001`
 => #<RelatonBipm::BipmBibliographicItem:0x007f8857f94d40
 ...
 
 # get CGPM meetings
 RelatonBipm::BipmBibliography.get "CGPM 1st Meeting (1889)"
-[relaton-bipm] ("CGPM 1st Meeting (1889)") fetching...
-[relaton-bipm] ("CGPM 1st Meeting (1889)") found CGPM 1th meeting (1889)
+[relaton-bipm] (CGPM 1st Meeting (1889)) fetching...
+[relaton-bipm] (CGPM 1st Meeting (1889)) found `CGPM 1th meeting (1889)`
 => #<RelatonBipm::BipmBibliographicItem:0x00007f7fd02aba28
 ...
 
 # get CGPM resolutions
 RelatonBipm::BipmBibliography.get "CGPM RES (1889, E)"
-[relaton-bipm] ("CGPM RES (1889, E)") fetching...
-[relaton-bipm] ("CGPM RES (1889, E)") found CGPM RES (1889)
+[relaton-bipm] (CGPM RES (1889, E)) fetching...
+[relaton-bipm] (CGPM RES (1889, E)) found `CGPM RES (1889)`
 => #<RelatonBipm::BipmBibliographicItem:0x00007f80421f93d8
 ...
 
 RelatonBipm::BipmBibliography.get "CGPM Resolution (1889)"
-[relaton-bipm] ("CGPM Resolution (1889)") fetching...
-[relaton-bipm] ("CGPM Resolution (1889)") found CGPM RES (1889)
+[relaton-bipm] (CGPM Resolution (1889)) fetching...
+[relaton-bipm] (CGPM Resolution (1889)) found `CGPM RES (1889)`
 => #<RelatonBipm::BipmBibliographicItem:0x00007f8017f60c18
 ...
 
 RelatonBipm::BipmBibliography.get "CGPM Résolution (1889)"
-[relaton-bipm] ("CGPM Résolution (1889)") fetching...
-[relaton-bipm] ("CGPM Résolution (1889)") found CGPM RES (1889)
+[relaton-bipm] (CGPM Résolution (1889)) fetching...
+[relaton-bipm] (CGPM Résolution (1889)) found `CGPM RES (1889)`
 => #<RelatonBipm::BipmBibliographicItem:0x00007f8017f492e8
 ...
 
 # get CIPM decision by year and decision number
 RelatonBipm::BipmBibliography.get "BIPM Decision CIPM/101-1 (2012)"
-[relaton-bipm] ("BIPM Decision CIPM/101-1 (2012)") fetching...
-[relaton-bipm] ("BIPM Decision CIPM/101-1 (2012)") found CIPM DECN 101-1 (2012)
+[relaton-bipm] (BIPM Decision CIPM/101-1 (2012)) fetching...
+[relaton-bipm] (BIPM Decision CIPM/101-1 (2012)) found `CIPM DECN 101-1 (2012)`
 => #<RelatonBipm::BipmBibliographicItem:0x00007f8017f2bd88
 ...
 
 RelatonBipm::BipmBibliography.get "BIPM DECN CIPM/101-1 (2012, E)"
-[relaton-bipm] ("BIPM DECN CIPM/101-1 (2012, E)") fetching...
-[relaton-bipm] ("BIPM DECN CIPM/101-1 (2012, E)") found CIPM DECN 101-1 (2012)
+[relaton-bipm] (BIPM DECN CIPM/101-1 (2012, E)) fetching...
+[relaton-bipm] (BIPM DECN CIPM/101-1 (2012, E)) found `CIPM DECN 101-1 (2012)`
 => #<RelatonBipm::BipmBibliographicItem:0x00007f8017f39438
 ...
 
 # get CIPM recommendation
 RelatonBipm::BipmBibliography.get "CIPM Recommendation 1 (2005)"
-[relaton-bipm] ("CIPM Recommendation 1 (2005)") fetching...
-[relaton-bipm] ("CIPM Recommendation 1 (2005)") found CIPM REC 1 (2005)
+[relaton-bipm] (CIPM Recommendation 1 (2005)) fetching...
+[relaton-bipm] (CIPM Recommendation 1 (2005)) found `CIPM REC 1 (2005)`
 => #<RelatonBipm::BipmBibliographicItem:0x00007f8017f31da0
 ...
 
 RelatonBipm::BipmBibliography.get "CIPM REC 1 (2005, FR)"
-[relaton-bipm] ("CIPM REC 1 (2005, FR)") fetching...
-[relaton-bipm] ("CIPM REC 1 (2005, FR)") found CIPM REC 1 (2005)
+[relaton-bipm] (CIPM REC 1 (2005, FR)) fetching...
+[relaton-bipm] (CIPM REC 1 (2005, FR)) found `CIPM REC 1 (2005)`
 => #<RelatonBipm::BipmBibliographicItem:0x00007f80422100d8
 ...
 ----

data/lib/relaton_bipm/bipm_bibliographic_item.rb

@@ -27,13 +27,13 @@ module RelatonBipm
     # @param structuredidentifier [RelatonBipm::StructuredIdentifier]
     def initialize(**args) # rubocop:disable Metrics/AbcSize,Metrics/MethodLength
       if args[:docstatus] && !STATUSES.include?(args[:docstatus].stage.value)
-        warn "[relaton-bipm] Warning: invalid docstatus: #{args[:docstatus].stage.value}. " \
-             "It should be one of: #{STATUSES}"
+        Util.warn "WARNING: invalid docstatus: `#{args[:docstatus].stage.value}`. " \
+                  "It should be one of: `#{STATUSES.join('`, `')}`"
       end
 
       if args[:si_aspect] && !SI_ASPECTS.include?(args[:si_aspect])
-        warn "[relaton-bipm] Warning: invalid si_aspect: #{args[:si_aspect]}. " \
-             "It should be one of: #{SI_ASPECTS}"
+        Util.warn "WARNING: invalid si_aspect: `#{args[:si_aspect]}``. " \
+                  "It should be one of: `#{SI_ASPECTS.join('`, `')}`"
       end
 
       @comment_period = args.delete :comment_period

data/lib/relaton_bipm/bipm_bibliography.rb

@@ -9,47 +9,49 @@ module RelatonBipm
       # @param text [String]
       # @return [RelatonBipm::BipmBibliographicItem]
       def search(text, _year = nil, _opts = {}) # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
-        warn "[relaton-bipm] (\"#{text}\") fetching..."
+        Util.warn "(#{text}) fetching from Relaton repository ..."
         ref = text.sub(/^BIPM\s/, "")
-        item = get_bipm(ref, magent)
+        item = get_bipm ref
         unless item
-          warn "[relaton-bipm] (\"#{text}\") not found."
+          Util.warn "(#{text}) not found."
           return
         end
 
-        warn("[relaton-bipm] (\"#{text}\") found #{item.docidentifier[0].id}")
+        Util.warn("(#{text}) found `#{item.docidentifier[0].id}`")
         item
       rescue Mechanize::ResponseCodeError => e
         raise RelatonBib::RequestError, e.message unless e.response_code == "404"
       end
 
       # @return [Mechanize]
-      def magent # rubocop:disable Metrics/MethodLength
-        a = Mechanize.new
-        a.request_headers = {
-          "Accept" => "text/html,application/xhtml+xml,application/xml;q=0.9," \
-                      "image/avif,image/webp,image/apng," \
-                      "*/*;q=0.8,application/signed-exchange;v=b3;q=0.9",
-          "Accept-Encoding" => "gzip, deflate, br",
-          "Accept-Language" => "en-US,en;q=0.9,ru-RU;q=0.8,ru;q=0.7",
-          "Cache-Control" => "max-age=0",
-          "Upgrade-Insecure-Requests" => "1",
-        }
-        a.user_agent_alias = Mechanize::AGENT_ALIASES.map(&:first).shuffle.first
-        # a.user_agent_alias = "Mac Safari"
-        a
-      end
+      # def magent # rubocop:disable Metrics/MethodLength
+      #   a = Mechanize.new
+      #   a.request_headers = {
+      #     "Accept" => "text/html,application/xhtml+xml,application/xml;q=0.9," \
+      #                 "image/avif,image/webp,image/apng," \
+      #                 "*/*;q=0.8,application/signed-exchange;v=b3;q=0.9",
+      #     "Accept-Encoding" => "gzip, deflate, br",
+      #     "Accept-Language" => "en-US,en;q=0.9,ru-RU;q=0.8,ru;q=0.7",
+      #     "Cache-Control" => "max-age=0",
+      #     "Upgrade-Insecure-Requests" => "1",
+      #   }
+      #   a.user_agent_alias = Mechanize::AGENT_ALIASES.map(&:first).shuffle.first
+      #   # a.user_agent_alias = "Mac Safari"
+      #   a
+      # end
 
+      #
       # @param reference [String]
-      # @param agent [Mechanize]
+      #
       # @return [RelatonBipm::BipmBibliographicItem]
-      def get_bipm(reference, agent) # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
+      #
+      def get_bipm(reference) # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
         ref_id = Id.new reference
         rows = index.search { |r| ref_id == r[:id] }
         return unless rows.any?
 
         url = "#{GH_ENDPOINT}#{rows.first[:file]}"
-        resp = agent.get url
+        resp = Mechanize.new.get url
         return unless resp.code == "200"
 
         yaml = RelatonBib.parse_yaml resp.body, [Date]

data/lib/relaton_bipm/committee.rb

@@ -11,8 +11,8 @@ module RelatonBipm
     def initialize(acronym:, content: nil)
       acronyms = YAML.load_file File.join(__dir__, "acronyms.yaml")
       unless acronyms[acronym]
-        warn "[relaton-bipm] WARNING: invalid acronym: #{acronym}. Allowed " \
-             "values: #{acronyms.map { |k, _v| k }.join ', '}"
+        Util.warn "WARNING: invalid acronym: `#{acronym}`. Allowed " \
+                  "values: `#{acronyms.map { |k, _v| k }.join '`, `'}`"
       end
 
       @acronym = acronym

data/lib/relaton_bipm/config.rb

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

data/lib/relaton_bipm/id_parser.rb

@@ -76,7 +76,7 @@ module RelatonBipm
     def initialize(id)
       @id = Parser.new.parse(id)
     rescue Parslet::ParseFailed => e
-      warn "[relaton-bipm] Incorrect reference: #{id}"
+      Util.warn "WARNING: Incorrect reference: `#{id}`"
       # warn "[relaton-bipm] #{e.parse_failure_cause.ascii_tree}"
       raise RelatonBib::RequestError, e
     end

data/lib/relaton_bipm/util.rb

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

data/lib/relaton_bipm/version.rb

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

data/lib/relaton_bipm.rb

@@ -3,6 +3,8 @@ require "fileutils"
 require "parslet"
 require "relaton_bib"
 require "relaton/index"
+require "relaton_bipm/config"
+require "relaton_bipm/util"
 require "relaton_bipm/id_parser"
 require "relaton_bipm/version"
 require "relaton_bipm/editorial_group"
@@ -28,10 +30,10 @@ module RelatonBipm
   # Returns hash of XML reammar
   # @return [String]
   def 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 RelatonBipm::VERSION + RelatonBib::VERSION # grammars
   end
 
   extend self

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: relaton-bipm
 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-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -127,6 +127,7 @@ files:
 - lib/relaton_bipm/bipm_si_brochure_parser.rb
 - lib/relaton_bipm/comment_periond.rb
 - lib/relaton_bipm/committee.rb
+- lib/relaton_bipm/config.rb
 - lib/relaton_bipm/data_fetcher.rb
 - lib/relaton_bipm/data_outcomes_parser.rb
 - lib/relaton_bipm/document_relation.rb
@@ -137,6 +138,7 @@ files:
 - lib/relaton_bipm/rawdata_bipm_metrologia/article_parser.rb
 - lib/relaton_bipm/rawdata_bipm_metrologia/fetcher.rb
 - lib/relaton_bipm/structured_identifier.rb
+- lib/relaton_bipm/util.rb
 - lib/relaton_bipm/version.rb
 - lib/relaton_bipm/workgroup.rb
 - lib/relaton_bipm/xml_parser.rb