relaton-oasis 1.16.0 → 1.16.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3908ef54f79de05bfa9ee81c64f27b03e923f13fdd68df2c3a78b14bdc137bcf
-  data.tar.gz: 8e120eac3b886e8536532747a89b64f3c7fd9e64d098435e3e2135bde6f17acb
+  metadata.gz: 186697624e16817571af23ec1665efd8a562bbba0c9b980ab3068b1d7dfb24e6
+  data.tar.gz: 327389bf02d3f0ba84ce42ae08f9473215305c9ca72017ca80cc0bc39c64ed20
 SHA512:
-  metadata.gz: 2f97cd29537cce17fa2f3ce144a7074727a277131a1ea5739480efe6adc3c7dfd6b7b2fc913c029e9ade56694f243311b7b30f7c5df878d34a46af6d80437fb3
-  data.tar.gz: 7e9373716c8c693c1532c7a0b413dd0d114597baba2c4a95be9d76b3796d76b16a38e2c44255f45b53642428ddbf7cb55c2562a6688c0cf63ca87ceb3f82ade8
+  metadata.gz: 44148f1ebdc5e14d6ab59323192415e37f6d812df9147d0fb3fb9b73aab0a35cd65e59077c17ef3ffca684840e909df07975ebfe596bef5885e729a4814b5107
+  data.tar.gz: f9cf5995c54f4d0a086f523ed018857a38459c60667df2065fc6c5cd8e74e2d85a0c0b4c7c404d05161197c59734540dfe456aac91c48f0b5be52ef105efa569

data/README.adoc

@@ -30,18 +30,29 @@ Or install it yourself as:
 
 == Usage
 
-=== Get standard using reference.
+=== Configuration
 
-All the OASIS documents are parsed from https://www.oasis-open.org/standards/ and stored in a GitHub repository https://github.com/relaton/relaton-data-oasis. You can find all possible references on the index page https://relaton.github.io/relaton-data-oasis/.
+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 `RelatonOasis.configure` block.
 
 [source,ruby]
 ----
 require 'relaton_oasis'
 => true
 
+RelatonOasis.configure do |config|
+  config.logger.level = Logger::DEBUG
+end
+----
+
+=== Get standard using reference.
+
+All the OASIS documents are parsed from https://www.oasis-open.org/standards/ and stored in a GitHub repository https://github.com/relaton/relaton-data-oasis. You can find all possible references on the index page https://relaton.github.io/relaton-data-oasis/.
+
+[source,ruby]
+----
 item = RelatonOasis::OasisBibliography.get "OASIS amqp-core"
-[relaton-oasis] (OASIS amqp-core fetching...
-[relaton-oasis] (OASIS amqp-core) found OASIS amqp-core
+[relaton-oasis] (OASIS) amqp-core Fetching from Relaton repository ...
+[relaton-oasis] (OASIS amqp-core) Found: `OASIS amqp-core`
 => #<RelatonOasis::OasisBibliographicItem:0x00007fceea1aecb0
 ...
 ----
@@ -86,8 +97,8 @@ Some OASIS documents have `src` type link.
 [source,ruby]
 ----
 item = RelatonOasis::OasisBibliography.get "OASIS amqp-core-types-v1.0-Pt1"
-[relaton-oasis] (OASIS amqp-core-types-v1.0-Pt1 fetching...
-[relaton-oasis] (OASIS amqp-core-types-v1.0-Pt1) found OASIS amqp-core-types-v1.0-Pt1
+[relaton-oasis] (OASIS amqp-core-types-v1.0-Pt1) Fetching from Relaton repository ...
+[relaton-oasis] (OASIS amqp-core-types-v1.0-Pt1) Found: `OASIS amqp-core-types-v1.0-Pt1`
 => #<RelatonOasis::OasisBibliographicItem:0x00007fceda0c5e08
 ...
 

data/lib/relaton_oasis/config.rb

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

data/lib/relaton_oasis/index.rb

@@ -69,7 +69,12 @@ module RelatonOasis
     # Read from file or create empty index.
     #
     def read
-      @index = File.exist?(@file) ? YAML.load_file(@file, symbolize_names: true) : []
+      @index = if File.exist?(@file)
+                 YAML.load_file(@file,
+                                symbolize_names: true)
+               else
+                 []
+               end
     end
   end
 end

data/lib/relaton_oasis/oasis_bibliographic_item.rb

@@ -16,8 +16,9 @@ module RelatonOasis
       @technology_area = args.delete(:technology_area) || []
       uta = @technology_area.reject { |a| AREAS.include? a }
       if uta.any?
-        warn "[relaton-oasis] WARNING Unknown technology area: #{uta.join(', ')}"
-        warn "[relaton-oasis] (Valid values are: #{AREAS.join(', ')})"
+        area = uta.size > 1 ? "areas" : "area"
+        Util.warn "WARNING Unknown technology #{area}: `#{uta.join('`, `')}`"
+        Util.warn "Valid values are: `#{AREAS.join('`, `')}`"
       end
       super
     end

data/lib/relaton_oasis/oasis_bibliography.rb

@@ -9,9 +9,11 @@ module RelatonOasis
     class << self
       # @param text [String]
       # @return [RelatonOasis::HitCollection]
-      def search(text, _year = nil)
+      def search(text, _year = nil) # rubocop:disable Metrics/AbcSize,Metrics/MethodLength
         /^(?:OASIS\s)?(?<code>.+)/ =~ text
-        index = Relaton::Index.find_or_create :oasis, url: "#{ENDPOINT}index-v1.zip", file: INDEX_FILE
+        index = Relaton::Index.find_or_create(
+          :oasis, url: "#{ENDPOINT}index-v1.zip", file: INDEX_FILE
+        )
         row = index.search(code).min_by { |i| i[:id] }
         return unless row
 
@@ -34,15 +36,15 @@ module RelatonOasis
       #   reference is required
       # @return [RelatonOasis::OasisBibliographicItem, nil]
       def get(code, year = nil, _opts = {}) # rubocop:disable Metrics/CyclomaticComplexity,Metrics/MethodLength,Metrics/PerceivedComplexity
-        warn "[relaton-oasis] (#{code}) fetching..."
+        Util.warn "(#{code}) Fetching from Relaton repository ..."
         bibitem = search code, year
         if bibitem
           docid = bibitem.docidentifier.detect(&:primary).id
-          warn "[relaton-oasis] (#{code}) found #{docid}"
-          bibitem
+          Util.warn "(#{code}) Found: `#{docid}`"
         else
-          warn "[relaton-oasis] (#{code}) not found"
+          Util.warn "(#{code}) Not found."
         end
+        bibitem
       end
     end
   end

data/lib/relaton_oasis/util.rb

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

data/lib/relaton_oasis/version.rb

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

data/lib/relaton_oasis.rb

@@ -4,6 +4,8 @@ require "mechanize"
 require "relaton/index"
 require "relaton_bib"
 require_relative "relaton_oasis/version"
+require_relative "relaton_oasis/config"
+require_relative "relaton_oasis/util"
 require_relative "relaton_oasis/oasis_bibliographic_item"
 require_relative "relaton_oasis/xml_parser"
 require_relative "relaton_oasis/hash_converter"
@@ -21,9 +23,9 @@ module RelatonOasis
   # 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 RelatonOasis::VERSION + RelatonBib::VERSION # grammars
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: relaton-oasis
 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-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mechanize
@@ -92,6 +92,7 @@ files:
 - grammars/relaton-oasis-compile.rng
 - grammars/relaton-oasis.rng
 - lib/relaton_oasis.rb
+- lib/relaton_oasis/config.rb
 - lib/relaton_oasis/data_fetcher.rb
 - lib/relaton_oasis/data_parser.rb
 - lib/relaton_oasis/data_parser_utils.rb
@@ -101,6 +102,7 @@ files:
 - lib/relaton_oasis/oasis_bibliographic_item.rb
 - lib/relaton_oasis/oasis_bibliography.rb
 - lib/relaton_oasis/processor.rb
+- lib/relaton_oasis/util.rb
 - lib/relaton_oasis/version.rb
 - lib/relaton_oasis/xml_parser.rb
 - relaton_oasis.gemspec