relaton-bsi 1.18.1 → 1.19.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b4c523e402c6e17583164c104864771561c0fa5fa4031f7db2213d38ab4e2db4
-  data.tar.gz: e8361d2ec9755703179ddfb12719c81d18e2dd1818496c80c637ea9e2bfd1317
+  metadata.gz: 99af92172169b8df75ed0eaa5a5b3e458915b4748384c5b079ce545bb537d1e7
+  data.tar.gz: a5229c520d69cabbcf2edc9ae1ff19fa920ac463bb0a87f9d5474a61fb5e8110
 SHA512:
-  metadata.gz: 502077f0182a1bef51e2fddae6ba0489a8dea264d3e1e91615c87a52c8e60fe3b1cb16a4cf92b0e3a3f85d05c2eef059cf9a81d4d05596b08a87e550e806d6ae
-  data.tar.gz: 8e48df93646e97ba217a5bf84bf6b926de6ac6c3497180d017730d39472300cef13f228dbbc5aa06405744b734a013b164d391e9585651c54f940a04971e232d
+  metadata.gz: 1622681a2c14d77bb235eb01a57b14dfda1772ebbf18ea72d5224878a57ca330eec65c6ec4955a932e8e9b3de0857856b56868c1257cdae0cdff178188045503
+  data.tar.gz: f209f6be6baeff12865568275634f251023d2b0cba6deac3d6743ef8545e0911db6d4677003bac1ec52fb2df6426ed1a890eea00e1429b42db986b7161208d7f

data/README.adoc

@@ -27,24 +27,13 @@ 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 `RelatonBsi.configure` block.
+=== Search for a standard using keywords
 
 [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>
 
@@ -132,6 +121,10 @@ RelatonBsi::XMLParser.from_xml File.read("spec/fixtures/bibdata.xml", encoding:
 ...
 ----
 
+=== Logging
+
+RelatonBsi uses the relaton-logger gem for logging. By default, it logs to STDOUT. To change the log levels and add other loggers, read the https://github.com/relaton/relaton-logger#usage[relaton-logger] documentation.
+
 == Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/grammars/basicdoc.rng

@@ -244,6 +244,9 @@
         <data type="ID"/>
       </attribute>
       <attribute name="reviewer"/>
+      <optional>
+        <attribute name="type"/>
+      </optional>
       <optional>
         <attribute name="date">
           <data type="dateTime"/>

data/lib/relaton_bsi/bsi_bibliographic_item.rb

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

data/lib/relaton_bsi/bsi_bibliography.rb

@@ -58,7 +58,7 @@ module RelatonBsi
         # 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?
-          Util.warn "There was no match for `#{year}`, though there " \
+          Util.info "There was no match for `#{year}`, though there " \
                     "were matches found for `#{missed_years.join('`, `')}`."
         end
         # if /\d-\d/.match? code
@@ -82,9 +82,9 @@ module RelatonBsi
       #
       def search_filter(code)
         cp = code_parts code
-        Util.warn "(#{code}) Fetching from shop.bsigroup.com ..."
+        Util.info "Fetching from shop.bsigroup.com ...", key: code
         unless cp
-          Util.warn "(#{code}) Could not parse the reference"
+          Util.info "Could not parse the reference", key: code
           return []
         end
 
@@ -115,10 +115,10 @@ module RelatonBsi
         result = search_filter(code) || return
         ret = results_filter(result, year)
         if ret[:ret]
-          Util.warn "(#{code}) Found: `#{ret[:ret].docidentifier.first&.id}`"
+          Util.info "Found: `#{ret[:ret].docidentifier.first&.id}`", key: code
           ret[:ret]
         else
-          Util.warn "(#{code}) No found"
+          Util.info "No found", key: code
           fetch_ref_err(code, year, ret[:years])
         end
       end

data/lib/relaton_bsi/document_type.rb

@@ -14,7 +14,7 @@ module RelatonBsi
 
     def check_type(type)
       unless DOCTYPES.include? type
-        Util.warn "WARNING: invalid doctype: `#{type}`"
+        Util.warn "invalid doctype: `#{type}`"
       end
     end
   end

data/lib/relaton_bsi/util.rb

@@ -1,9 +1,6 @@
 module RelatonBsi
   module Util
     extend RelatonBib::Util
-
-    def self.logger
-      RelatonBsi.configuration.logger
-    end
+    PROGNAME = "relaton-bsi".freeze
   end
 end

data/lib/relaton_bsi/version.rb

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

data/lib/relaton_bsi/xml_parser.rb

@@ -21,6 +21,10 @@ module RelatonBsi
       def bib_item(item_hash)
         BsiBibliographicItem.new(**item_hash)
       end
+
+      def create_doctype(type)
+        DocumentType.new type: type.text, abbreviation: type[:abbreviation]
+      end
     end
   end
 end

data/lib/relaton_bsi.rb

@@ -2,16 +2,15 @@
 
 require "relaton_iso_bib"
 require_relative "relaton_bsi/version"
-require "relaton_bsi/config"
-require "relaton_bsi/util"
-require "relaton_bsi/document_type"
-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"
+require_relative "relaton_bsi/util"
+require_relative "relaton_bsi/document_type"
+require_relative "relaton_bsi/bsi_bibliography"
+require_relative "relaton_bsi/bsi_bibliographic_item"
+require_relative "relaton_bsi/scrapper"
+require_relative "relaton_bsi/hit_collection"
+require_relative "relaton_bsi/hit"
+require_relative "relaton_bsi/xml_parser"
+require_relative "relaton_bsi/hash_converter"
 
 module RelatonBsi
   # Returns hash of XML greammar

data/relaton_bsi.gemspec

@@ -33,5 +33,5 @@ Gem::Specification.new do |spec|
   spec.add_dependency "faraday-net_http_persistent", "~> 2.0"
   spec.add_dependency "graphql", "1.13.6"
   spec.add_dependency "graphql-client", "~> 0.16.0"
-  spec.add_dependency "relaton-iso-bib", "~> 1.18.0"
+  spec.add_dependency "relaton-iso-bib", "~> 1.19.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: relaton-bsi
 version: !ruby/object:Gem::Version
-  version: 1.18.1
+  version: 1.19.0
 platform: ruby
 authors:
 - Ribose Inc.
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2024-05-20 00:00:00.000000000 Z
+date: 2024-07-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: algolia
@@ -72,14 +72,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.18.0
+        version: 1.19.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.18.0
+        version: 1.19.0
 description: 'RelatonBsi: retrieve BSI Standards for bibliographic use using the BibliographicItem
   model'
 email:
@@ -108,7 +108,6 @@ 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/document_type.rb
 - lib/relaton_bsi/hash_converter.rb
 - lib/relaton_bsi/hit.rb

data/lib/relaton_bsi/config.rb

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