relaton-iso 1.15.4 → 1.15.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 849d2ed5597da449397be8d44059b7c88d799bb118ff53cb13abcb67b90ec98c
-  data.tar.gz: 4084d1465fee0a3bc9062734d405eb97a1a28e18e866a473433026509a8907e1
+  metadata.gz: fadb60d3f225174438b872a27c8632fcb9dcb685b66ef67071b7ab16dd78f052
+  data.tar.gz: b53c685d0adf0856851f31d1808654f59f16d0ccd8db70b2ef818b22126e505e
 SHA512:
-  metadata.gz: 800e61c17385335e14b7fa56d9d29031db9a43ce6d908fd21dcd841db1422c2addec5a78e2a44aad4ceb170754167b79530c891d97ae54aff519900bfdcc0ebb
-  data.tar.gz: 00eb78136a9f91335f412d5af3d64fd83fce8d94b2fcce13e252dca09ac36eb2ec1e5fd3e025cda196be92f4d6fda49b17239f8bd4a6611ba7b177f0ecc302ab
+  metadata.gz: a10856c01099b1590b99ab0c2102aaf6dee654bd3fdf0b6a7f0717d3f85881bc58999219168e6ba707846cbd3fc785fbc9951003d7c21ad6c134af2a0fb0d4ea
+  data.tar.gz: a9a4b7a79acf34a0a42218f28979ec06a41c0b6305fcfbb77ebec0cf4881e2b806548ae5603112122420f1c4ed0d365d9be50a2c291fb4d5a00fe68534f2311b

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/Gemfile

@@ -6,7 +6,10 @@ git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
 gemspec
 
 gem "byebug"
+gem "equivalent-xml"
 gem "pry-byebug"
+gem "rake", "~> 13.0"
+gem "rspec", "~> 3.0"
 gem "rubocop"
 gem "rubocop-performance"
 gem "rubocop-rails"

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>
 
@@ -49,37 +60,11 @@ item = hit_collection[2].fetch
 ...
 
 item.docidentifier
-=> [#<RelatonIso::DocumentIdentifier:0x00007fa8b7db1f20
-  @id=
-   #<Pubid::Iso::Identifier:0x00007fa8b7db2a60
-    @base=#<Pubid::Iso::Identifier:0x00007fa8b7db2c68 @edition="1", @number="19115"@4, @part="1", @publisher="ISO", @year=2014>,
-    @number="2"@21,
-    @publisher="ISO",
-    @stage=#<Pubid::Iso::Stage:0x00007fa8b7db20d8 @abbr=nil, @harmonized_code=#<Pubid::Iso::HarmonizedStageCode:0x00007fa8b7db2088 @stages=["60.60"]>>,
-    @typed_stage=#<Pubid::Iso::TypedStage:0x00007fa8b7db2920 @type=#<Pubid::Iso::Type:0x00007fa8b7db26c8 @type=:amd>, @typed_stage=nil>,
-    @year=2020>,
-  @language=nil,
-  @primary=true,
-  @scope=nil,
-  @script=nil,
-  @type="ISO">,
- #<RelatonIso::DocumentIdentifier:0x00007fa8b7db1e80
-  @id=
-   #<Pubid::Iso::Identifier:0x00007fa8b7db2a60
-    @base=#<Pubid::Iso::Identifier:0x00007fa8b7db2c68 @edition="1", @number="19115"@4, @part="1", @publisher="ISO", @year=2014>,
-    @number="2"@21,
-    @publisher="ISO",
-    @stage=#<Pubid::Iso::Stage:0x00007fa8b7db20d8 @abbr=nil, @harmonized_code=#<Pubid::Iso::HarmonizedStageCode:0x00007fa8b7db2088 @stages=["60.60"]>>,
-    @typed_stage=#<Pubid::Iso::TypedStage:0x00007fa8b7db2920 @type=#<Pubid::Iso::Type:0x00007fa8b7db26c8 @type=:amd>, @typed_stage=nil>,
-    @year=2020>,
-  @language=nil,
-  @primary=nil,
-  @scope=nil,
-  @script=nil,
-  @type="URN">]
+=> [#<RelatonIso::DocumentIdentifier:0x0000000112a23a88
+...
 
 item.docidentifier.detect { |di| di.type == "URN" }.id
-=> "urn:iso:std:iso:19115:-1:ed-1:amd:2020:v2"
+=> "urn:iso:std:iso:19115:-1:ed-1:stage-60.60:amd:2020:v2"
 ----
 
 === Fetch document by reference and year
@@ -93,9 +78,9 @@ item = RelatonIso::IsoBibliography.get "ISO 19115:2003"
 ...
 
 item = RelatonIso::IsoBibliography.get "ISO 19115", "2003"
-[relaton-iso] ("ISO 19115") fetching from ISO...
-[relaton-iso] ("ISO 19115:2003") Found exact match.
-=> #<RelatonIsoBib::IsoBibliographicItem:0x00007f8c828d3180
+[relaton-iso] ("ISO 19115:2003") Fetching from ISO...
+[relaton-iso] ("ISO 19115:2003") Found ("ISO 19115:2003").
+=> #<RelatonIsoBib::IsoBibliographicItem:0x0000000112c9ca80
 ...
 
 item.docidentifier[0].id
@@ -113,7 +98,7 @@ item = RelatonIso::IsoBibliography.get "ISO 19115"
 ...
 
 item.docidentifier[0].id
-=> "ISO 19115:2003"
+=> "ISO 19115"
 ----
 
 === Fetch a part document
@@ -136,13 +121,13 @@ item.docidentifier[0].id
 ----
 item = RelatonIso::IsoBibliography.get "ISO 19115 (all parts)"
 [relaton-iso] ("ISO 19115") Fetching from ISO...
-[relaton-iso] ("ISO 19115") Found exact match.
+[relaton-iso] ("ISO 19115") Found ("ISO 19115").
 => #<RelatonIsoBib::IsoBibliographicItem:0x00007f8ca216e118
 ...
 
 item = RelatonIso::IsoBibliography.get "ISO 19115", nil, all_parts: true
 [relaton-iso] ("ISO 19115") Fetching from ISO...
-[relaton-iso] ("ISO 19115") Found exact match.
+[relaton-iso] ("ISO 19115") Found ("ISO 19115").
 => #<RelatonIsoBib::IsoBibliographicItem:0x00007f8c830f3d38
 ...
 
@@ -151,12 +136,12 @@ item.docidentifier[0].id
 
 item = RelatonIso::IsoBibliography.get "ISO 19115-1 (all parts)"
 [relaton-iso] ("ISO 19115") Fetching from ISO...
-[relaton-iso] ("ISO 19115") Found exact match.
+[relaton-iso] ("ISO 19115") Found ("ISO 19115").
 => #<RelatonIsoBib::IsoBibliographicItem:0x00007f8c8290e5a0
 
 item = RelatonIso::IsoBibliography.get "ISO 19115-1", nil, all_parts: true
 [relaton-iso] ("ISO 19115") Fetching from ISO...
-[relaton-iso] ("ISO 19115") Found exact match.
+[relaton-iso] ("ISO 19115") Found ("ISO 19115").
 => #<RelatonIsoBib::IsoBibliographicItem:0x00007f8c925355b8
 ...
 
@@ -217,35 +202,31 @@ item.to_xml note: [{ text: "Note", type: "note" }]
 [source,ruby]
 ----
 item.title lang: 'en'
-=> #<RelatonBib::TypedTitleStringCollection:0x00007fa8b7f47c90
+=> #<RelatonBib::TypedTitleStringCollection:0x0000000112783fd0
  @array=
-  [#<RelatonBib::TypedTitleString:0x00007fa8b7be8a40
-    @title=#<RelatonBib::FormattedString:0x00007fa8b7be87c0 @content="Geographic information", @format="text/plain", @language=["en"], @script=["Latn"]>,
+  [#<RelatonBib::TypedTitleString:0x00000001138e2380
+    @title=#<RelatonBib::FormattedString:0x0000000112d496b8 @content="Geographic information", @format="text/plain", @language=["en"], @script=["Latn"]>,
     @type="title-intro">,
-   #<RelatonBib::TypedTitleString:0x00007fa8b7be84a0
-    @title=#<RelatonBib::FormattedString:0x00007fa8b7be83d8 @content="Metadata", @format="text/plain", @language=["en"], @script=["Latn"]>,
+   #<RelatonBib::TypedTitleString:0x00000001138e1f70
+    @title=#<RelatonBib::FormattedString:0x0000000112d495c8 @content="Metadata", @format="text/plain", @language=["en"], @script=["Latn"]>,
     @type="title-main">,
-   #<RelatonBib::TypedTitleString:0x00007fa8b7be8130
+   #<RelatonBib::TypedTitleString:0x00000001138e1d68
     @title=
-     #<RelatonBib::FormattedString:0x00007fa8b7be8018
-      @content="Geographic information – Metadata",
-      @format="text/plain",
-      @language=["en"],
-      @script=["Latn"]>,
+     #<RelatonBib::FormattedString:0x0000000112d49488 @content="Geographic information – Metadata", @format="text/plain", @language=["en"], @script=["Latn"]>,
     @type="main">]>
 
 item.title lang: 'fr'
-=> #<RelatonBib::TypedTitleStringCollection:0x00007fa8b7bcb4b8
+=> #<RelatonBib::TypedTitleStringCollection:0x0000000113067458
  @array=
-  [#<RelatonBib::TypedTitleString:0x00007fa8b7be3ea0
-    @title=#<RelatonBib::FormattedString:0x00007fa8b7be3dd8 @content="Information géographique", @format="text/plain", @language=["fr"], @script=["Latn"]>,
+  [#<RelatonBib::TypedTitleString:0x00000001138e1c28
+    @title=#<RelatonBib::FormattedString:0x0000000112d49438 @content="Information géographique", @format="text/plain", @language=["fr"], @script=["Latn"]>,
     @type="title-intro">,
-   #<RelatonBib::TypedTitleString:0x00007fa8b7be3ba8
-    @title=#<RelatonBib::FormattedString:0x00007fa8b7be3b58 @content="Métadonnées", @format="text/plain", @language=["fr"], @script=["Latn"]>,
+   #<RelatonBib::TypedTitleString:0x00000001138e1b10
+    @title=#<RelatonBib::FormattedString:0x0000000112d49398 @content="Métadonnées", @format="text/plain", @language=["fr"], @script=["Latn"]>,
     @type="title-main">,
-   #<RelatonBib::TypedTitleString:0x00007fa8b7be38d8
+   #<RelatonBib::TypedTitleString:0x00000001138e1908
     @title=
-     #<RelatonBib::FormattedString:0x00007fa8b7be3860
+     #<RelatonBib::FormattedString:0x0000000112d491b8
       @content="Information géographique – Métadonnées",
       @format="text/plain",
       @language=["fr"],
@@ -254,10 +235,9 @@ item.title lang: 'fr'
 
 item = RelatonIso::IsoBibliography.get "ISO 19115:2003"
 [relaton-iso] ("ISO 19115:2003") Fetching from ISO...
-[relaton-iso] ("ISO 19115:2003") Found exact match.
+[relaton-iso] ("ISO 19115:2003") Found ("ISO 19115:2003").
 => #<RelatonIsoBib::IsoBibliographicItem:0x00007fa8870b69e0
 
-item.abstract lang: 'en'
 item.abstract lang: 'en'
 => #<RelatonBib::FormattedString:0x00007fa8870b4f78
  @content=
@@ -274,13 +254,13 @@ Each ISO document has `src` type link and optional `obp`, `rss`, and `pub` link
 [source,ruby]
 ----
 item.link
-=> [#<RelatonBib::TypedUri:0x00007fa8870ac5a8
-  @content=#<Addressable::URI:0xcc6514 URI:https://www.iso.org/standard/26020.html>,
+=> [#<RelatonBib::TypedUri:0x0000000112d66c40
+  @content=#<Addressable::URI:0x93d71c URI:https://www.iso.org/standard/26020.html>,
   @language=nil,
   @script=nil,
   @type="src">,
- #<RelatonBib::TypedUri:0x00007fa8870a7490
-  @content=#<Addressable::URI:0xcc6528 URI:https://www.iso.org/contents/data/standard/02/60/26020.detail.rss>,
+ #<RelatonBib::TypedUri:0x0000000112d66920
+  @content=#<Addressable::URI:0x93d730 URI:https://www.iso.org/contents/data/standard/02/60/26020.detail.rss>,
   @language=nil,
   @script=nil,
   @type="rss">]

data/lib/relaton_iso/config.rb

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

data/lib/relaton_iso/hit.rb

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

data/lib/relaton_iso/hit_collection.rb

@@ -6,17 +6,23 @@ require "relaton_iso/hit"
 module RelatonIso
   # Page of hit collection.
   class HitCollection < RelatonBib::HitCollection
-    # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
+    # @return [Boolean] whether the search was performed on GitHub
+    attr_reader :from_gh
 
     # @param text [String] reference to search
     def initialize(text)
       super
-      @array = text.match?(/^ISO[\s\/](?:TC\s184\/SC\s?4|IEC\sDIR\s(?:\d|IEC|JTC))/) ? fetch_github : fetch_iso
+      @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]
     # @return [RelatonIsoBib::IsoBibliographicItem, nil]
-    def to_all_parts(lang = nil) # rubocop:disable Metrics/CyclomaticComplexity
+    def to_all_parts(lang = nil) # rubocop:disable Metrics/AbcSize,Metrics/MethodLength
       # parts = @array.reject { |h| h.hit["docPart"]&.empty? }
       hit = @array.min_by { |h| h.pubid.part.to_i }
       return @array.first&.fetch lang unless hit
@@ -33,7 +39,6 @@ module RelatonIso
       end
       all_parts_item
     end
-    # rubocop:enable Metrics/AbcSize, Metrics/MethodLength
 
     private
 
@@ -63,23 +68,11 @@ module RelatonIso
     # @return [Array<RelatonIso::Hit>]
     #
     def fetch_iso # rubocop:disable Metrics/AbcSize,Metrics/MethodLength
-      # %r{\s(?<num>\d+)(?:-(?<part>[\d-]+))?} =~ text
-      # http = Net::HTTP.new "www.iso.org", 443
-      # http.use_ssl = true
-      # search = ["status=ENT_ACTIVE,ENT_PROGRESS,ENT_INACTIVE,ENT_DELETED"]
-      # search << "docNumber=#{num}"
-      # search << "docPartNo=#{part}" if part
-      # q = search.join "&"
-      # resp = http.get("/cms/render/live/en/sites/isoorg.advancedSearch.do?#{q}",
-      #                 "Accept" => "application/json, text/plain, */*")
       config = Algolia::Search::Config.new(application_id: "JCL49WV5AR", api_key: "dd1b9e1ab383f4d4817d29cd5e96d3f0")
-      client = Algolia::Search::Client.new config, logger: ::Logger.new($stderr)
+      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"
-      # return [] if resp.body.empty?
 
-      # json = JSON.parse resp.body
-      # json["standards"]
       resp[:hits].map { |h| Hit.new h, self }.sort! do |a, b|
         if a.sort_weight == b.sort_weight && b.hit[:year] = a.hit[:year]
           a.hit[:title] <=> b.hit[:title]
@@ -90,19 +83,5 @@ module RelatonIso
         end
       end
     end
-
-    # @param hit [Hash]
-    # @return [Date]
-    # def parse_date(hit)
-    #   if hit["publicationDate"]
-    #     Date.strptime(hit["publicationDate"], "%Y-%m")
-    #   elsif %r{:(?<year>\d{4})} =~ hit["docRef"]
-    #     Date.strptime(year, "%Y")
-    #   elsif hit["newProjectDate"]
-    #     Date.parse hit["newProjectDate"]
-    #   else
-    #     Date.new 0
-    #   end
-    # end
   end
 end

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,
@@ -29,7 +29,7 @@ module RelatonIso
       #
       # @return [RelatonIsoBib::IsoBibliographicItem] Relaton XML serialisation of reference
       def get(ref, year = nil, opts = {}) # rubocop:disable Metrics/CyclomaticComplexity,Metrics/MethodLength,Metrics/PerceivedComplexity,Metrics/AbcSize
-        code = ref.gsub(/\u2013/, "-")
+        code = ref.gsub("\u2013", "-")
 
         # parse "all parts" request
         code.sub! " (all parts)", ""
@@ -37,43 +37,24 @@ module RelatonIso
 
         query_pubid = Pubid::Iso::Identifier.parse(code)
         query_pubid.year = year if year
+        query_pubid.part = nil if opts[:all_parts]
+        Util.warn "(#{query_pubid}) Fetching from ISO..."
 
-        resp = isobib_search_filter(query_pubid, opts)
-
-        # Try with ISO/IEC prefix if ISO not found
-        if resp[:hits].empty? && query_pubid.copublisher.nil? &&
-            query_pubid.publisher == "ISO"
-          resp_isoiec = retry_isoiec_prefix(query_pubid, opts)
-          resp = resp_isoiec unless resp_isoiec.nil?
-        end
+        hits, missed_year_ids = isobib_search_filter(query_pubid, opts)
+        tip_ids = look_up_with_any_types_stages(hits, ref, opts)
 
-        # return only first one if not all_parts
-        ret = if !opts[:all_parts] || resp[:hits].size == 1
-                resp[:hits].any? && resp[:hits].first.fetch(opts[:lang])
+        ret = if !opts[:all_parts] || hits.size == 1
+                hits.any? && hits.first.fetch(opts[:lang])
               else
-                resp[:hits].to_all_parts(opts[:lang])
+                hits.to_all_parts(opts[:lang])
               end
 
-        return fetch_ref_err(query_pubid) unless ret
+        return fetch_ref_err(query_pubid, missed_year_ids, tip_ids) unless ret
 
-        # puts "xxxxx #{ret.docidentifier.first.id.inspect}"
         response_docid = ret.docidentifier.first.id.sub(" (all parts)", "")
         response_pubid = Pubid::Iso::Identifier.parse(response_docid)
-        # puts "xxxxx query_pubid(#{query_pubid}) response_pubid(#{response_pubid})"
-
-        if query_pubid.to_s == response_pubid.to_s
-          warn "[relaton-iso] (\"#{query_pubid}\") Found exact match."
-        elsif matches_base?(query_pubid, response_pubid)
-          warn "[relaton-iso] (\"#{query_pubid}\") " \
-               "Found (\"#{response_pubid}\")."
-        elsif matches_base?(query_pubid, response_pubid, any_types_stages: true)
-          warn "[relaton-iso] (\"#{query_pubid}\") TIP: " \
-               "Found with different type/stage, " \
-               "please amend to (\"#{response_pubid}\")."
-        else
-          # when there are all parts
-          warn "[relaton-iso] (\"#{query_pubid}\") Found (\"#{response_pubid}\")."
-        end
+
+        Util.warn "(#{query_pubid}) Found `#{response_pubid}`."
 
         get_all = (
           (query_pubid.year && opts[:keep_year].nil?) ||
@@ -83,9 +64,9 @@ module RelatonIso
         return ret if get_all
 
         ret.to_most_recent_reference
-
       rescue Pubid::Core::Errors::ParseError
-        warn "[relaton-iso] (\"#{code}\") is not recognized as a standards identifier."
+        Util.warn "(#{code}) is not recognized as a standards identifier."
+        nil
       end
 
       # @param query_pubid [Pubid::Iso::Identifier]
@@ -109,147 +90,113 @@ module RelatonIso
       # @return [<Type>] <description>
       #
       def matches_base?(query_pubid, pubid, any_types_stages: false) # rubocop:disable Metrics/AbcSize,Metrics/CyclomaticComplexity,Metrics?PerceivedComplexity
-        return unless pubid.respond_to?(:publisher)
+        return false unless pubid.respond_to?(:publisher)
 
         query_pubid.publisher == pubid.publisher &&
           query_pubid.number == pubid.number &&
           query_pubid.copublisher == pubid.copublisher &&
-          ((any_types_stages && query_pubid.stage.nil?) || query_pubid.stage == pubid.stage) &&
-          ((any_types_stages && query_pubid.type.nil?) || query_pubid.type == pubid.type)
+          (any_types_stages || query_pubid.stage == pubid.stage) &&
+          (any_types_stages || query_pubid.is_a?(pubid.class))
       end
 
       # @param hit_collection [RelatonIso::HitCollection]
       # @param year [String]
-      # @return [RelatonIso::HitCollection]
-      def filter_hits_by_year(hit_collection, year) # rubocop:disable Metrics/MethodLength,Metrics/AbcSize,Metrics/CyclomaticComplexity,Metrics/PerceivedComplexity
-        missed_years = []
-        return { hits: hit_collection, missed_years: missed_years } if year.nil?
+      # @return [Array<RelatonIso::HitCollection, Array<String>>] hits and missed year IDs
+      def filter_hits_by_year(hit_collection, year)
+        missed_year_ids = Set.new
+        return [hit_collection, missed_year_ids] if year.nil?
 
         # filter by year
         hits = hit_collection.select do |hit|
-          if (hit.pubid.base.nil? && hit.pubid.year.to_s == year.to_s) ||
-              (!hit.pubid.base.nil? && hit.pubid.base.year.to_s == year.to_s) ||
-              (!hit.pubid.base.nil? && hit.pubid.year.to_s == year.to_s)
-            true
-          elsif hit.pubid.year.nil? && hit.hit[:year].to_s == year
-            hit.pubid.year = year
-            true
-          else
-            missed_year = (hit.pubid.year || hit.hit[:year]).to_s
-            if missed_year && !missed_year.empty? && !missed_years.include?(missed_year)
-              missed_years << missed_year
-            end
-            false
-          end
+          hit.pubid.year ||= hit.hit[:year]
+          next true if check_year(year, hit)
+
+          missed_year_ids << hit.pubid.to_s if hit.pubid.year
+          false
         end
 
-        { hits: hits, missed_years: missed_years }
+        [hits, missed_year_ids]
       end
 
       private
 
-      # @param query_pubid [Pubid::Iso::Identifier] PubID with no results
-      def fetch_ref_err(query_pubid) # rubocop:disable Metrics/MethodLength
-        warn "[relaton-iso] (\"#{query_pubid}\") " \
-             "Not found. " \
-             "The identifier must be exactly as shown on the ISO website."
+      def check_year(year, hit) # rubocop:disable Metrics/AbcSize
+        (hit.pubid.base.nil? && hit.pubid.year.to_s == year.to_s) ||
+          (!hit.pubid.base.nil? && hit.pubid.base.year.to_s == year.to_s) ||
+          (!hit.pubid.base.nil? && hit.pubid.year.to_s == year.to_s)
+      end
 
-        if query_pubid.part
-          warn "[relaton-iso] (\"#{query_pubid}\") TIP: " \
-               "If it cannot be found, the document may no longer be published in parts."
-        else
-          warn "[relaton-iso] (\"#{query_pubid}\") TIP: " \
-               "If you wish to cite all document parts for the reference, " \
-               "use (\"#{query_pubid.to_s(format: :ref_undated)} (all parts)\")."
+      # @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
+        Util.warn "(#{pubid}) Not found."
+
+        if missed_year_ids.any?
+          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
 
-        unless %w(TS TR PAS Guide).include?(query_pubid.type)
-          warn "[relaton-iso] (\"#{query_pubid}\") TIP: " \
-               "If the document is not an International Standard, use its " \
-               "deliverable type abbreviation (TS, TR, PAS, Guide)."
+        if tip_ids.any?
+          ids = tip_ids.map { |i| "`#{i}`" }.join(", ")
+          Util.warn "(#{pubid}) TIP: Matches exist for #{ids}."
         end
 
-        nil
-      end
+        if pubid.part
+          Util.warn "(#{pubid}) TIP: If it cannot be found, " \
+                    "the document may no longer be published in parts."
+        else
+          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
 
-      # @param pubid [Pubid::Iso::Identifier]
-      # @param missed_years [Array<String>]
-      def warn_missing_years(pubid, missed_years)
-        warn "[relaton-iso] (\"#{pubid}\") TIP: " \
-             "No match for edition year #{pubid.year}, " \
-             "but matches exist for #{missed_years.uniq.join(', ')}."
+        nil
       end
 
-      # Search for hits using ISO/IEC prefix.
-      #
-      # @param old_pubid [Pubid::Iso::Identifier] reference with ISO prefix
-      # @param opts [Hash]
-      # @return [Array<RelatonIso::Hit>]
-      def retry_isoiec_prefix(old_pubid, opts) # rubocop:disable Metrics/MethodLength
-        return nil unless old_pubid.copublisher.nil? && old_pubid.publisher == "ISO"
-
-        pubid = old_pubid.dup
-        pubid.copublisher = "IEC"
-        warn "[relaton-iso] (\"#{old_pubid}\") Not found, trying with ISO/IEC prefix (\"#{pubid}\")..."
-        resp_isoiec = isobib_search_filter(pubid, opts)
-
-        if resp_isoiec[:hits].empty?
-          warn "[relaton-iso] (\"#{pubid}\") Not found. "
-          return nil
-        end
-
-        warn "[relaton-iso] (\"#{pubid}\") TIP: Found with ISO/IEC prefix, " \
-             "please amend to (\"#{pubid}\")."
+      def look_up_with_any_types_stages(hits, ref, opts) # rubocop:disable Metrics/MethodLength
+        found_ids = []
+        return found_ids if hits.from_gh || hits.any? || !ref.match?(/^ISO[\/\s][A-Z]/)
 
-        resp_isoiec
+        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
 
+      #
       # Search for hits. If no found then trying missed stages.
       #
       # @param query_pubid [Pubid::Iso::Identifier] reference without correction
       # @param opts [Hash]
-      # @return [Array<RelatonIso::Hit>]
-      def isobib_search_filter(query_pubid, opts) # rubocop:disable Metrics/MethodLength,Metrics/AbcSize,Metrics/CyclomaticComplexity,Metrics/PerceivedComplexity
-        missed_years = []
-        query_pubid.part = nil if opts[:all_parts]
-        warn "[relaton-iso] (\"#{query_pubid}\") Fetching from ISO..."
-
-        # fetch hits collection
+      # @param any_types_stages [Boolean] match with any stages
+      #
+      # @return [Array<RelatonIso::HitCollection, Array<String>>] hits and missed years
+      #
+      def isobib_search_filter(query_pubid, opts, any_types_stages: false) # rubocop:disable Metrics/MethodLength,Metrics/AbcSize,Metrics/CyclomaticComplexity,Metrics/PerceivedComplexity
         query_pubid_without_year = query_pubid.dup
         # remove year for query
         query_pubid_without_year.year = nil
         hit_collection = search(query_pubid_without_year.to_s)
 
         # filter only matching hits
-        res = filter_hits hit_collection, query_pubid, all_parts: opts[:all_parts]
-        return res unless res[:hits].empty?
-
-        missed_years += res[:missed_years]
-
-        # lookup for documents with stages when no match without stage
-        res = filter_hits hit_collection, query_pubid,
-                          all_parts: opts[:all_parts], any_types_stages: true
-        return res unless res[:hits].empty?
-
-        missed_years += res[:missed_years]
-
-        if missed_years.any?
-          warn_missing_years(query_pubid, missed_years)
-        end
-
-        res
+        filter_hits hit_collection, query_pubid, opts[:all_parts], any_types_stages
       end
 
-      # @param hits [RelatonIso::HitCollection]
+      #
+      # Filter hits by query_pubid.
+      #
+      # @param hit_collection [RelatonIso::HitCollection]
       # @param query_pubid [Pubid::Iso::Identifier]
       # @param all_parts [Boolean]
-      # @param any_stages [Boolean]
-      # @return [RelatonIso::HitCollection]
-      def filter_hits(hit_collection, query_pubid, all_parts: false, any_types_stages: false) # rubocop:disable Metrics/AbcSize,Metrics/CyclomaticComplexity,Metrics/PerceivedComplexity
+      # @param any_stypes_tages [Boolean]
+      #
+      # @return [Array<RelatonIso::HitCollection, Array<String>>] hits and missed year IDs
+      #
+      def filter_hits(hit_collection, query_pubid, all_parts, any_stypes_tages) # rubocop:disable Metrics/AbcSize,Metrics/CyclomaticComplexity,Metrics/PerceivedComplexity
         # filter out
         result = hit_collection.select do |i|
           hit_pubid = i.pubid
-          matches_base?(query_pubid, hit_pubid, any_types_stages: any_types_stages) &&
+          matches_base?(query_pubid, hit_pubid, any_types_stages: any_stypes_tages) &&
             matches_parts?(query_pubid, hit_pubid, all_parts: all_parts) &&
             query_pubid.corrigendums == hit_pubid.corrigendums &&
             query_pubid.amendments == hit_pubid.amendments

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.4"
+  VERSION = "1.15.6"
 end

data/lib/relaton_iso.rb

@@ -1,6 +1,13 @@
 # frozen_string_literal: true
 
+require "nokogiri"
+require "net/http"
+require "logger"
+require "pubid-iso"
+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 "pubid-iso"
 require "relaton_iso/document_identifier"

data/relaton_iso.gemspec

@@ -10,10 +10,10 @@ Gem::Specification.new do |spec|
   spec.authors       = ["Ribose Inc."]
   spec.email         = ["open.source@ribose.com"]
 
-  spec.summary       = "RelatonIso: retrieve ISO Standards for bibliographic use "\
-                       "using the IsoBibliographicItem model"
-  spec.description   = "RelatonIso: retrieve ISO Standards for bibliographic use "\
-                       "using the IsoBibliographicItem model"
+  spec.summary       = "RelatonIso: retrieve ISO Standards for bibliographic " \
+                       "use using the IsoBibliographicItem model"
+  spec.description   = "RelatonIso: retrieve ISO Standards for bibliographic " \
+                       "use using the IsoBibliographicItem model"
 
   spec.homepage      = "https://github.com/relaton/relaton-iso"
   spec.license       = "BSD-2-Clause"
@@ -26,11 +26,8 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
   spec.required_ruby_version = Gem::Requirement.new(">= 2.7.0")
 
-  spec.add_development_dependency "equivalent-xml", "~> 0.6"
-  spec.add_development_dependency "rake", "~> 13.0"
-  spec.add_development_dependency "rspec", "~> 3.0"
-
   spec.add_dependency "algolia", "~> 2.3.0"
-  spec.add_dependency "pubid-iso", "~> 0.5.0"
+  spec.add_dependency "pubid-iso", "~> 0.6.0"
+  spec.add_dependency "relaton-bib", "~> 1.14.13"
   spec.add_dependency "relaton-iso-bib", "~> 1.14.0"
 end

metadata

@@ -1,85 +1,57 @@
 --- !ruby/object:Gem::Specification
 name: relaton-iso
 version: !ruby/object:Gem::Version
-  version: 1.15.4
+  version: 1.15.6
 platform: ruby
 authors:
 - Ribose Inc.
-autorequire:
+autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-05-18 00:00:00.000000000 Z
+date: 2023-08-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: equivalent-xml
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.6'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.6'
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '13.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '13.0'
-- !ruby/object:Gem::Dependency
-  name: rspec
+  name: algolia
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
-  type: :development
+        version: 2.3.0
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: 2.3.0
 - !ruby/object:Gem::Dependency
-  name: algolia
+  name: pubid-iso
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.3.0
+        version: 0.6.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.3.0
+        version: 0.6.0
 - !ruby/object:Gem::Dependency
-  name: pubid-iso
+  name: relaton-bib
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.5.0
+        version: 1.14.13
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.5.0
+        version: 1.14.13
 - !ruby/object:Gem::Dependency
   name: relaton-iso-bib
   requirement: !ruby/object:Gem::Requirement
@@ -135,19 +107,21 @@ files:
 - bin/setup
 - bin/thor
 - lib/relaton_iso.rb
+- lib/relaton_iso/config.rb
 - lib/relaton_iso/document_identifier.rb
 - lib/relaton_iso/hit.rb
 - lib/relaton_iso/hit_collection.rb
 - lib/relaton_iso/iso_bibliography.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
 licenses:
 - BSD-2-Clause
 metadata: {}
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -162,8 +136,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.9
-signing_key:
+rubygems_version: 3.3.26
+signing_key: 
 specification_version: 4
 summary: 'RelatonIso: retrieve ISO Standards for bibliographic use using the IsoBibliographicItem
   model'