relaton-ecma 1.16.0 → 1.16.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7b85e57cdcdbe42357ffaa34abce500363874a0a7e22968478ccc469634e3760
-  data.tar.gz: b623c0c898cc6ac095a06b1cadfc84910fecf395a6a0638ba82f5cf7a8ea4798
+  metadata.gz: 6b71aace87d7e254f0f12d8c79c95567e67f03ab86b3e71784d66feb876419eb
+  data.tar.gz: bf33ddaa1c8b4350cd9b7a43f96657173c4f8ae8997c044f84eb3ad81c44e370
 SHA512:
-  metadata.gz: d0d75ff9175f0971a1cd429565dc82abe4429cc596b7c38e9a107f3bb832c3139c5d749523d6ed44667f86a974d4e3259c17bcedf78a911d7970cd8d03c8727d
-  data.tar.gz: 92ebfe927d53e728b16972a00c6ba6fdeab2b35a314d3b9d3539f2cc6296e477694b028299553a26169d14d2adfcb7928c968e76a37f797fa4796ffbbf53b9bc
+  metadata.gz: ca703ec7cf5cc4276be529224ee261174618a0c8d7f273b02cae997dce13918598d523b610ca3b01305000a990d95872597631ced2c3c8bd8e998c939488cd2c
+  data.tar.gz: 6c2732b6d3ed06e9c5a93e9b2b44018221f9e5124405481169f15a15dd21c5eadc459e3dd3961c2344ff0ce55f72649a0ceae46bff48426e4788f17e5b14f8fe

data/README.adoc

@@ -29,6 +29,20 @@ Or install it yourself as:
 
 == Usage
 
+=== 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 `RelatonEcma.configure` block.
+
+[source,ruby]
+----
+require 'relaton_ecma'
+=> true
+
+RelatonEcma.configure do |config|
+  config.logger.level = Logger::DEBUG
+end
+----
+
 === Fetch documents
 
 Documents can be fetched by reference. The structure of the reference depends on the type of the document. There are three types of documents:
@@ -45,27 +59,24 @@ ECMA mementos have the following reference structure: `ECMA MEM/{YEAR}`. Where:
 
 [source,ruby]
 ----
-require 'relaton_ecma'
-=> true
-
 # fetch ECMA standard
 item = RelatonEcma::EcmaBibliography.get 'ECMA-6'
-[relaton-ecma] ("ECMA-6") fetching...
-[relaton-ecma] ("ECMA-6") found ECMA-6
+[relaton-ecma] (ECMA-6) Fetching from Relaton repository ...
+[relaton-ecma] (ECMA-6) Found: `ECMA-6`
 #<RelatonEcma::BibliographicItem:0x00007fc645b11c10
 ...
 
 # fetch ECMA standard with edition and volume
 RelatonEcma::EcmaBibliography.get "ECMA-269 ed3 vol2"
-[relaton-ecma] ("ECMA-269 ed3 vol2") fetching...
-[relaton-ecma] ("ECMA-269 ed3 vol2") found ECMA-269
+[relaton-ecma] (ECMA-269 ed3 vol2) Fetching from Relaton repository ...
+[relaton-ecma] (ECMA-269 ed3 vol2) Found: `ECMA-269`
 => #<RelatonEcma::BibliographicItem:0x0000000106ac8210
 ...
 
 # fetch the last edition of ECMA standard
 bib = RelatonEcma::EcmaBibliography.get "ECMA-269"
-[relaton-ecma] ("ECMA-269") fetching...
-[relaton-ecma] ("ECMA-269") found ECMA-269
+[relaton-ecma] (ECMA-269) Fetching from Relaton repository ...
+[relaton-ecma] (ECMA-269) Found: `ECMA-269`
 => #<RelatonEcma::BibliographicItem:0x000000010a408480
 ...
 
@@ -74,8 +85,8 @@ bib.edition.content
 
 # fetch the first volume of ECMA standard
 bib = RelatonEcma::EcmaBibliography.get "ECMA-269 ed3"
-[relaton-ecma] ("ECMA-269 ed3") fetching...
-[relaton-ecma] ("ECMA-269 ed3") found ECMA-269
+[relaton-ecma] (ECMA-269 ed3) Fetching from Relaton repository ...
+[relaton-ecma] (ECMA-269 ed3) Found: `ECMA-269`
 => #<RelatonEcma::BibliographicItem:0x000000010a3ed0e0
 ...
 
@@ -84,22 +95,22 @@ bib.extent.first.reference_from
 
 # fetch ECMA technical report
 RelatonEcma::EcmaBibliography.get 'ECMA TR/18'
-[relaton-ecma] ("ECMA TR/18") fetching...
-[relaton-ecma] ("ECMA TR/18") found ECMA TR/18
+[relaton-ecma] (ECMA TR/18) Fetching from Relaton repository ...
+[relaton-ecma] (ECMA TR/18) Found: `ECMA TR/18`
 => #<RelatonEcma::BibliographicItem:0x00007fc645c00cc0
 ...
 
 # fetch ECMA memento
 RelatonEcma::EcmaBibliography.get "ECMA MEM/2021"
-[relaton-ecma] ("ECMA MEM/2021") fetching...
-[relaton-ecma] ("ECMA MEM/2021") found ECMA MEM/2021
+[relaton-ecma] (ECMA MEM/2021) Fetching from Relaton repository ...
+[relaton-ecma] (ECMA MEM/2021) Found: `ECMA MEM/2021`
 => #<RelatonEcma::BibliographicItem:0x00007fc665b2f060
 ...
 
 # Return nil if a document doesn't exist.
 RelatonEcma::EcmaBibliography.get '1111'
-[relaton-ecma] ("1111") fetching...
-[relaton-ecma] WARNING no match found online for 1111. The code must be exactly like it is on the standards website.
+[relaton-ecma] (1111) Fetching from Relaton repository ...
+[relaton-ecma] (1111) Not found.
 => nil
 ----
 

data/lib/relaton_ecma/config.rb

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

data/lib/relaton_ecma/ecma_bibliography.rb

@@ -40,14 +40,13 @@ module RelatonEcma
       # @param opts [Hash] not used
       # @return [RelatonEcma::BibliographicItem] Relaton of reference
       def get(code, _year = nil, _opts = {})
-        warn "[relaton-ecma] (\"#{code}\") fetching..."
+        Util.warn "(#{code}) Fetching from Relaton repository ..."
         result = fetch_doc(code)
         if result
-          warn "[relaton-ecma] (\"#{code}\") found #{result.docidentifier.first.id}"
+          Util.warn "(#{code}) Found: `#{result.docidentifier.first.id}`"
           # item
         else
-          warn "[relaton-ecma] WARNING no match found online for #{code}. " \
-               "The code must be exactly like it is on the standards website."
+          Util.warn "(#{code}) Not found."
         end
         result
       end

data/lib/relaton_ecma/util.rb

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

data/lib/relaton_ecma/version.rb

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

data/lib/relaton_ecma.rb

@@ -4,6 +4,8 @@ require "yaml"
 require "relaton/index"
 require "relaton_bib"
 require "relaton_ecma/version"
+require "relaton_ecma/config"
+require "relaton_ecma/util"
 require "relaton_ecma/bibliographic_item"
 require "relaton_ecma/xml_parser"
 require "relaton_ecma/hash_converter"
@@ -15,9 +17,9 @@ module RelatonEcma
   # 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 RelatonEcma::VERSION + RelatonBib::VERSION # grammars
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: relaton-ecma
 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-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mechanize
@@ -79,11 +79,13 @@ files:
 - grammars/relaton-ecma.rng
 - lib/relaton_ecma.rb
 - lib/relaton_ecma/bibliographic_item.rb
+- lib/relaton_ecma/config.rb
 - lib/relaton_ecma/data_fetcher.rb
 - lib/relaton_ecma/data_parser.rb
 - lib/relaton_ecma/ecma_bibliography.rb
 - lib/relaton_ecma/hash_converter.rb
 - lib/relaton_ecma/processor.rb
+- lib/relaton_ecma/util.rb
 - lib/relaton_ecma/version.rb
 - lib/relaton_ecma/xml_parser.rb
 - relaton_ecma.gemspec