relaton-iso 1.13.3 → 1.13.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 36560c5f9f49d1ff9855a051c71b562bfddd82fc1c862cf08b35b1129ec69720
-  data.tar.gz: 4900a496e3b112b40dda6ab2acc4fe40db02084b01f42545de104a9c12dff922
+  metadata.gz: 545043eab945ec715dbf08c77dbd3c07379b87d0c06c317431223a97cb0b7816
+  data.tar.gz: 8f7594c2399682c780e47eb4e770deb19d48a17ffd5c21efc1938a463768eb25
 SHA512:
-  metadata.gz: 2bcea09926b89d5c6d3017376b75ee79916d9e5ace197592dc6d42cd77d715d4ad67896165c5a17a0b31e7d8ab45c9219f6713aea03f6c08d9dc622792bff074
-  data.tar.gz: 883976ba644b4ffae07292c4ad754fda13d195a3b34a6c03ffdc1382f44184bd0b0fd50ad270ae97ad69cf7d4d5c47e4f3d18098ed5bb6fcaa292deeb5c00e17
+  metadata.gz: 15b2628861c98f99a4879ec5d4c94f52d6551cdd20b322127d9ec4f42e2370e6f85350b95a257ecaaa49843bd29975a74e33fadff12bcbacc594d5ab3dd00d75
+  data.tar.gz: d5491c7ac248b6e3ba7bee7dbd2c32527103a3ede84dc14bfc67d29597c35e735ea47b5beed488f104ae3e9a46e28201aad0bc2667a85203a95d9bb9c9486c6e

data/.github/workflows/rake.yml

@@ -5,7 +5,6 @@ name: rake
 on:
   push:
     branches: [ master, main ]
-    tags: [ v* ]
   pull_request:
 
 jobs:

data/lib/relaton_iso/iso_bibliography.rb

@@ -40,6 +40,13 @@ module RelatonIso
 
         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
+
         # 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])
@@ -47,17 +54,37 @@ module RelatonIso
                 resp[:hits].to_all_parts(opts[:lang])
               end
 
-        if ret
-          warn "[relaton-iso] (\"#{query_pubid}\") found #{ret.docidentifier.first.id}"
-        else
-          return fetch_ref_err(query_pubid)
-        end
+        return fetch_ref_err(query_pubid) unless ret
 
-        if (query_pubid.year && opts[:keep_year].nil?) || opts[:keep_year] || opts[:all_parts]
-          ret
-        else
-          ret.to_most_recent_reference
+        # 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
+
+        get_all = (
+          (query_pubid.year && opts[:keep_year].nil?) ||
+          opts[:keep_year] ||
+          opts[:all_parts]
+        )
+        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."
       end
@@ -67,12 +94,10 @@ module RelatonIso
       # @param all_parts [Boolean] match with any parts when true
       # @return [Boolean]
       def matches_parts?(query_pubid, pubid, all_parts: false)
-        if all_parts
-          # match only with documents with part number
-          !pubid.part.nil?
-        else
-          query_pubid.part == pubid.part
-        end
+        # match only with documents with part number
+        return !pubid.part.nil? if all_parts
+
+        query_pubid.part == pubid.part
       end
 
       def matches_base?(query_pubid, pubid, any_types_stages: false) # rubocop:disable Metrics/AbcSize,Metrics/CyclomaticComplexity,Metrics?PerceivedComplexity
@@ -111,22 +136,68 @@ module RelatonIso
 
       private
 
+      # @param query_pubid [Pubid::Iso::Identifier] PubID with no results
       def fetch_ref_err(query_pubid) # rubocop:disable Metrics/MethodLength
-        warn "[relaton-iso] WARNING: no match found online for #{query_pubid}. " \
-             "The code must be exactly like it is on the standards website."
-        if /\d-\d/.match? query_pubid.to_s
-          warn "[relaton-iso] The provided document part may not exist, " \
-               "or the document may no longer be published in parts."
+        warn "[relaton-iso] (\"#{query_pubid}\") " \
+             "Not found. " \
+             "The identifier must be exactly as shown on the ISO website."
+
+        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] If you wanted to cite all document parts for " \
-               "the reference, use \"#{query_pubid} (all parts)\"."
-          warn "[relaton-iso] If the document is not a standard, use its " \
-               "document type abbreviation (TS, TR, PAS, Guide)."
+          warn "[relaton-iso] (\"#{query_pubid}\") TIP: " \
+               "If you wish to cite all document parts for the reference, " \
+               "use (\"#{query_pubid.to_s(with_date: false)} (all parts)\")."
         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)."
+        end
+
         nil
       end
 
-      # Search for hits. If no found then trying missed stages and ISO/IEC.
+      # @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(', ')}."
+      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)
+        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}\")."
+
+        resp_isoiec
+      end
+
+      # Search for hits. If no found then trying missed stages.
       #
       # @param query_pubid [Pubid::Iso::Identifier] reference without correction
       # @param opts [Hash]
@@ -134,32 +205,29 @@ module RelatonIso
       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..."
+        warn "[relaton-iso] (\"#{query_pubid}\") Fetching from ISO..."
+
         # fetch hits collection
-        hit_collection = search(query_pubid.to_s(with_date: false))
+        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(with_date: false))
+
         # 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]
-        # TODO: do this at pubid-iso
-        if query_pubid.publisher == "ISO" && query_pubid.copublisher.nil? # try ISO/IEC if ISO not found
-          warn "[relaton-iso] Attempting ISO/IEC retrieval"
-          query_pubid.copublisher = "IEC"
-          res = filter_hits hit_collection, query_pubid, all_parts: opts[:all_parts]
-          missed_years += res[:missed_years]
-        end
 
-        if res[:hits].empty? && missed_years.any?
-          warn "[relaton-iso] (There was no match for #{query_pubid.year}, though there "\
-               "were matches found for #{missed_years.uniq.join(', ')}.)"
+        if missed_years.any?
+          warn_missing_years(query_pubid, missed_years)
         end
+
         res
       end
 
@@ -180,6 +248,7 @@ module RelatonIso
 
         filter_hits_by_year(result, query_pubid.year)
       end
+
     end
   end
 end

data/lib/relaton_iso/version.rb

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

data/relaton_iso.gemspec

@@ -39,6 +39,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "webmock"
 
   spec.add_dependency "algolia"
-  spec.add_dependency "pubid-iso", "0.1.10"
+  spec.add_dependency "pubid-core", "1.2.1"
+  spec.add_dependency "pubid-iso", "~> 0.2.0"
   spec.add_dependency "relaton-iso-bib", "~> 1.13.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: relaton-iso
 version: !ruby/object:Gem::Version
-  version: 1.13.3
+  version: 1.13.5
 platform: ruby
 authors:
 - Ribose Inc.
-autorequire:
+autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-09-17 00:00:00.000000000 Z
+date: 2022-10-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: byebug
@@ -179,19 +179,33 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: pubid-iso
+  name: pubid-core
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.1.10
+        version: 1.2.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.1.10
+        version: 1.2.1
+- !ruby/object:Gem::Dependency
+  name: pubid-iso
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.0
 - !ruby/object:Gem::Dependency
   name: relaton-iso-bib
   requirement: !ruby/object:Gem::Requirement
@@ -259,7 +273,7 @@ homepage: https://github.com/relaton/relaton-iso
 licenses:
 - BSD-2-Clause
 metadata: {}
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -274,8 +288,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.3
-signing_key:
+rubygems_version: 3.1.6
+signing_key: 
 specification_version: 4
 summary: 'RelatonIso: retrieve ISO Standards for bibliographic use using the IsoBibliographicItem
   model'