relaton-iso 1.15.5 → 1.16.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d8f96ec7677b17a7e89ca54cc7230eda13391749c404fcc8d95bca32ddb61d98
-  data.tar.gz: c74831929f8d4d276e1aae6c06990559e51bcc4ba1ea3c627fef33d141463612
+  metadata.gz: b3ca89f9616730766487b295af824ea9b797aa863f0bbc248e21e8f26862e02c
+  data.tar.gz: 070dedc5d81dfeea1085da56872e960a021691193c0ad1b7b47c4a3c8704a2ed
 SHA512:
-  metadata.gz: 80862ee504de862925e70c188ae40ed13001748f87f9af41aaad00e1e3e2b473779da64e0402ac920ac84af6318e19fe8ec6d73c7d6ff5b752b20f3fd0d2721c
-  data.tar.gz: e896e1986545b722df2393b075ce947d2ab00ca365249498b4a0e738ebcb9669475e72961e2ab90495181ce8ccd5af8df380d697b9433b335e013ab554ddf23a
+  metadata.gz: a62229e67a1547c934babfb52d77d1a2c51f0982840bca9a889499479cbdc0b2e7bcbc0291bfa0812afaf25eb5d13f6c760b073a5b6742b588275a922fcbe210
+  data.tar.gz: 46ef00eeef8fa1b4f55281ae7566fbee4f5ac743c8d90bb0053fd12255121ff5e994e47b16e441c019137e8962a3d4ce298f954b29dd08b219537ba3d8d70edd

data/.github/workflows/release.yml

@@ -7,7 +7,8 @@ on:
     inputs:
       next_version:
         description: |
-          Next release version. Possible values: x.y.z, major, minor, patch or pre|rc|etc
+          Next release version. Possible values: x.y.z, major, minor, patch (or pre|rc|etc).
+          Also, you can pass 'skip' to skip 'git tag' and do 'gem push' for the current version
         required: true
         default: 'skip'
   repository_dispatch:

data/README.adoc

@@ -31,13 +31,24 @@ Or install it yourself as:
 
 == Usage
 
-=== Search for standards 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 `RelatonIso.configure` block.
 
 [source,ruby]
 ----
 require 'relaton_iso'
 => true
 
+RelatonIso.configure do |config|
+  config.logger.level = Logger::DEBUG
+end
+----
+
+=== Search for standards using keywords
+
+[source,ruby]
+----
 hit_collection = RelatonIso::IsoBibliography.search("ISO 19115")
 => <RelatonIso::HitCollection:0x007fa5bc847038 @ref=19115 @fetched=false>
 

data/lib/relaton_iso/config.rb

@@ -1,26 +1,10 @@
 module RelatonIso
   module Config
-    def configure
-      yield configuration if block_given?
-    end
-
-    def configuration
-      @configuration ||= Configuration.new
-    end
-
-    extend self
+    include RelatonBib::Config
   end
+  extend Config
 
-  class Configuration
-    attr_accessor :logger
-
-    def initialize
-      @logger = ::Logger.new $stderr
-      @logger.level = ::Logger::WARN
-      @logger.progname = "relaton-iso"
-      @logger.formatter = proc do |_severity, _datetime, progname, msg|
-        "[#{progname}] #{msg}\n"
-      end
-    end
+  class Configuration < RelatonBib::Configuration
+    PROGNAME = "relaton-iso".freeze
   end
 end

data/lib/relaton_iso/hit.rb

@@ -43,8 +43,8 @@ module RelatonIso
     def pubid
       @pubid ||= Pubid::Iso::Identifier.parse_from_title(hit[:title])
     rescue Pubid::Iso::Errors::WrongTypeError, Pubid::Iso::Errors::ParseError => e
-      Logger.warn "unable to find an identifier in \"#{hit[:title]}\"."
-      Logger.warn e.message
+      Util.warn "unable to find an identifier in `#{hit[:title]}`."
+      Util.warn e.message
     end
   end
 end

data/lib/relaton_iso/hit_collection.rb

@@ -13,7 +13,11 @@ module RelatonIso
     def initialize(text)
       super
       @from_gh = text.match?(/^ISO[\s\/](?:TC\s184\/SC\s?4|IEC\sDIR\s(?:\d|IEC|JTC))/)
+    end
+
+    def fetch
       @array = from_gh ? fetch_github : fetch_iso
+      self
     end
 
     # @param lang [String, NilClass]
@@ -30,7 +34,7 @@ module RelatonIso
           formattedref: RelatonBib::FormattedRef.new(content: hi.pubid.to_s),
         )
         all_parts_item.relation << RelatonBib::DocumentRelation.new(
-          type: "instance", bibitem: isobib,
+          type: "instanceOf", bibitem: isobib,
         )
       end
       all_parts_item
@@ -65,7 +69,7 @@ module RelatonIso
     #
     def fetch_iso # rubocop:disable Metrics/AbcSize,Metrics/MethodLength
       config = Algolia::Search::Config.new(application_id: "JCL49WV5AR", api_key: "dd1b9e1ab383f4d4817d29cd5e96d3f0")
-      client = Algolia::Search::Client.new config, logger: Config.configuration.logger
+      client = Algolia::Search::Client.new config, logger: RelatonIso.configuration.logger
       index = client.init_index "all_en"
       resp = index.search text, hitsPerPage: 100, filters: "category:standard"
 

data/lib/relaton_iso/iso_bibliography.rb

@@ -12,7 +12,7 @@ module RelatonIso
       # @param text [String]
       # @return [RelatonIso::HitCollection]
       def search(text)
-        HitCollection.new text.gsub("\u2013", "-")
+        HitCollection.new(text.gsub("\u2013", "-")).fetch
       rescue SocketError, Timeout::Error, Errno::EINVAL, Errno::ECONNRESET,
              EOFError, Net::HTTPBadResponse, Net::HTTPHeaderSyntaxError,
              Net::ProtocolError, OpenSSL::SSL::SSLError, Errno::ETIMEDOUT,
@@ -38,10 +38,10 @@ module RelatonIso
         query_pubid = Pubid::Iso::Identifier.parse(code)
         query_pubid.year = year if year
         query_pubid.part = nil if opts[:all_parts]
-        Logger.warn "(\"#{query_pubid}\") Fetching from ISO..."
+        Util.warn "(#{query_pubid}) Fetching from ISO..."
 
         hits, missed_year_ids = isobib_search_filter(query_pubid, opts)
-        tip_ids = look_up_with_any_types_stages(hits, query_pubid, opts)
+        tip_ids = look_up_with_any_types_stages(hits, ref, opts)
 
         ret = if !opts[:all_parts] || hits.size == 1
                 hits.any? && hits.first.fetch(opts[:lang])
@@ -54,7 +54,7 @@ module RelatonIso
         response_docid = ret.docidentifier.first.id.sub(" (all parts)", "")
         response_pubid = Pubid::Iso::Identifier.parse(response_docid)
 
-        Logger.warn "(\"#{query_pubid}\") Found (\"#{response_pubid}\")."
+        Util.warn "(#{query_pubid}) Found `#{response_pubid}`."
 
         get_all = (
           (query_pubid.year && opts[:keep_year].nil?) ||
@@ -65,7 +65,7 @@ module RelatonIso
 
         ret.to_most_recent_reference
       rescue Pubid::Core::Errors::ParseError
-        Logger.warn "(\"#{code}\") is not recognized as a standards identifier."
+        Util.warn "(#{code}) is not recognized as a standards identifier."
         nil
       end
 
@@ -128,35 +128,37 @@ module RelatonIso
 
       # @param pubid [Pubid::Iso::Identifier] PubID with no results
       def fetch_ref_err(pubid, missed_year_ids, tip_ids) # rubocop:disable Metrics/MethodLength,Metrics/AbcSize
-        Logger.warn "(\"#{pubid}\") Not found."
+        Util.warn "(#{pubid}) Not found."
 
         if missed_year_ids.any?
-          ids = missed_year_ids.map { |i| "\"#{i}\"" }.join(", ")
-          Logger.warn "(\"#{pubid}\") TIP: No match for edition year " \
-                      "#{pubid.year}, but matches exist for #{ids}."
+          ids = missed_year_ids.map { |i| "`#{i}`" }.join(", ")
+          Util.warn "(#{pubid}) TIP: No match for edition year " \
+                    "#{pubid.year}, but matches exist for #{ids}."
         end
 
         if tip_ids.any?
-          ids = tip_ids.map { |i| "\"#{i}\"" }.join(", ")
-          Logger.warn "(\"#{pubid}\") TIP: Matches exist for #{ids}."
+          ids = tip_ids.map { |i| "`#{i}`" }.join(", ")
+          Util.warn "(#{pubid}) TIP: Matches exist for #{ids}."
         end
 
         if pubid.part
-          Logger.warn "(\"#{pubid}\") TIP: If it cannot be found, " \
-                      "the document may no longer be published in parts."
+          Util.warn "(#{pubid}) TIP: If it cannot be found, " \
+                    "the document may no longer be published in parts."
         else
-          Logger.warn "(\"#{pubid}\") TIP: If you wish to cite " \
-                      "all document parts for the reference, use " \
-                      "(\"#{pubid.to_s(format: :ref_undated)} (all parts)\")."
+          Util.warn "(#{pubid}) TIP: If you wish to cite " \
+                    "all document parts for the reference, use " \
+                    "`#{pubid.to_s(format: :ref_undated)} (all parts)`."
         end
 
         nil
       end
 
-      def look_up_with_any_types_stages(hits, pubid, opts) # rubocop:disable Metrics/MethodLength
+      def look_up_with_any_types_stages(hits, ref, opts) # rubocop:disable Metrics/MethodLength
         found_ids = []
-        return found_ids unless !hits.from_gh && hits.empty? && pubid.copublisher.nil?
+        return found_ids if hits.from_gh || hits.any? || !ref.match?(/^ISO[\/\s][A-Z]/)
 
+        ref_no_type_stage = ref.sub(/^ISO[\/\s][A-Z]+/, "ISO")
+        pubid = Pubid::Iso::Identifier.parse(ref_no_type_stage)
         resp, = isobib_search_filter(pubid, opts, any_types_stages: true)
         resp.map &:pubid
       end

data/lib/relaton_iso/scrapper.rb

@@ -1,10 +1,5 @@
 # frozen_string_literal: true
 
-require "relaton_iso_bib"
-require "relaton_iso/hit"
-require "nokogiri"
-require "net/http"
-
 module RelatonIso
   # Scrapper.
   module Scrapper # rubocop:disable Metrics/ModuleLength

data/lib/relaton_iso/util.rb

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

data/lib/relaton_iso/version.rb

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

data/lib/relaton_iso.rb

@@ -1,9 +1,13 @@
 # frozen_string_literal: true
 
+require "nokogiri"
+require "net/http"
 require "logger"
 require "pubid-iso"
-require "relaton_iso/config"
-require "relaton_iso/logger"
+require "relaton_iso_bib"
 require "relaton_iso/version"
+require "relaton_iso/config"
+require "relaton_iso/util"
+require "relaton_iso/hit"
 require "relaton_iso/iso_bibliography"
 require "relaton_iso/document_identifier"

data/relaton_iso.gemspec

@@ -27,8 +27,6 @@ Gem::Specification.new do |spec|
   spec.required_ruby_version = Gem::Requirement.new(">= 2.7.0")
 
   spec.add_dependency "algolia", "~> 2.3.0"
-  spec.add_dependency "pubid-core", "1.8.5"
-  spec.add_dependency "pubid-iso", "~> 0.5.0"
-  spec.add_dependency "relaton-bib", "~> 1.14.12"
-  spec.add_dependency "relaton-iso-bib", "~> 1.14.0"
+  spec.add_dependency "pubid-iso", "~> 0.6.0"
+  spec.add_dependency "relaton-iso-bib", "~> 1.16.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: relaton-iso
 version: !ruby/object:Gem::Version
-  version: 1.15.5
+  version: 1.16.0
 platform: ruby
 authors:
 - Ribose Inc.
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-08-03 00:00:00.000000000 Z
+date: 2023-09-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: algolia
@@ -24,62 +24,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 2.3.0
-- !ruby/object:Gem::Dependency
-  name: pubid-core
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: 1.8.5
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: 1.8.5
 - !ruby/object:Gem::Dependency
   name: pubid-iso
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.5.0
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.5.0
-- !ruby/object:Gem::Dependency
-  name: relaton-bib
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 1.14.12
+        version: 0.6.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.14.12
+        version: 0.6.0
 - !ruby/object:Gem::Dependency
   name: relaton-iso-bib
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.14.0
+        version: 1.16.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.14.0
+        version: 1.16.0
 description: 'RelatonIso: retrieve ISO Standards for bibliographic use using the IsoBibliographicItem
   model'
 email:
@@ -126,9 +98,9 @@ files:
 - lib/relaton_iso/hit.rb
 - lib/relaton_iso/hit_collection.rb
 - lib/relaton_iso/iso_bibliography.rb
-- lib/relaton_iso/logger.rb
 - lib/relaton_iso/processor.rb
 - lib/relaton_iso/scrapper.rb
+- lib/relaton_iso/util.rb
 - lib/relaton_iso/version.rb
 - relaton_iso.gemspec
 homepage: https://github.com/relaton/relaton-iso

data/lib/relaton_iso/logger.rb

@@ -1,13 +0,0 @@
-module RelatonIso
-  module Logger
-    extend self
-
-    def method_missing(method, *args, &block)
-      Config.configuration.logger.send(method, *args, &block)
-    end
-
-    def respond_to_missing?(method_name, include_private = false)
-      Config.configuration.logger.respond_to?(method_name) || super
-    end
-  end
-end