relaton 1.11.4 → 1.12.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bd53313a7d35f6ed1adf7669962afc84282d15d232247d3facec910aaba05270
-  data.tar.gz: 304a0e1c5a44731f0a4f9a30c063df920deb8694aca702044fd1ab03a10fe5e8
+  metadata.gz: 8299cf7ea6a28e344f438461d16233fe9acd733bc00441583ce9768c702b15fa
+  data.tar.gz: 28d87384bb3b763981ae98902b144236254b7cce20c3d608ef746be679b0661a
 SHA512:
-  metadata.gz: 4cfb3d708769580fccb31ef09a408265a4b828e70082c7f44a2fe485c2982437cf4f8b8369ada51e7e2d9d3e05c05eada5eaca8126506ea5b9224b7575727501
-  data.tar.gz: 2255f0695f06f0714e55b03d9a9ad7c2b7567d417ff184e598c462e299aeed145fb6fb143fc9e83aedf7223479addd9542a6ea3d16b17298f55621676100010f
+  metadata.gz: 5720aed26b5585b6673d92fd8c99fbae0883689c254344d5dbad5549a157388bd6422a2550942eb58a8d32f1c2d0aeafd6485de55274c0c02271ec5f87661405
+  data.tar.gz: 45fca34e30fe15699b9b3933f4060c877d54947ae31c5bc70ff05812b654c0876175eedda1d71ef16755a4db02a797c30199cd2128d081ae46b186a4939964f5

data/lib/relaton/db.rb

@@ -95,9 +95,18 @@ module Relaton
       result
     end
 
+    #
     # Fetch asynchronously
-    def fetch_async(code, year = nil, opts = {}, &block) # rubocop:disable Metrics/AbcSize,Metrics/MethodLength
-      stdclass = @registry.class_by_ref code
+    #
+    # @param [String] ref reference
+    # @param [String] year document yer
+    # @param [Hash] opts options
+    #
+    # @return [RelatonBib::BibliographicItem, RelatonBib::RequestError, nil] bibitem if document is found,
+    #   request error if server doesn't answer, nil if document not found
+    #
+    def fetch_async(ref, year = nil, opts = {}, &block) # rubocop:disable Metrics/AbcSize,Metrics/MethodLength
+      stdclass = @registry.class_by_ref ref
       if stdclass
         unless @queues[stdclass]
           processor = @registry.processors[stdclass]
@@ -106,11 +115,14 @@ module Relaton
             args[3].call fetch(*args[0..2])
           rescue RelatonBib::RequestError => e
             args[3].call e
+          rescue StandardError => e
+            Util.log "[relaton] ERROR: #{args[0]} -- #{e.message}", :error
+            args[3].call nil
           end
           @queues[stdclass] = { queue: Queue.new, workers_pool: wp }
           Thread.new { process_queue @queues[stdclass] }
         end
-        @queues[stdclass][:queue] << [code, year, opts, block]
+        @queues[stdclass][:queue] << [ref, year, opts, block]
       else yield nil
       end
     end
@@ -196,7 +208,7 @@ module Relaton
     end
 
     # @param file [String] file path
-    # @param content [String] content in XML or YAmL format
+    # @param content [String] content in XML or YAML format
     # @param edition [String, nil] edition to filter
     # @param year [Integer, nil] year to filter
     # @return [BibliographicItem, nil]
@@ -205,7 +217,7 @@ module Relaton
       item = if file.match?(/xml$/) then processor.from_xml(content)
              else processor.hash_to_bib(YAML.safe_load(content))
              end
-      item if (edition.nil? || item.edition == edition) && (year.nil? ||
+      item if (edition.nil? || item.edition.content == edition) && (year.nil? ||
         item.date.detect { |d| d.type == "published" && d.on(:year).to_s == year.to_s })
     end
 
@@ -293,8 +305,10 @@ module Relaton
       [prefix, code]
     end
 
+    #
     # @param entry [String] XML string
     # @param stdclass [Symbol]
+    #
     # @return [nil, RelatonBib::BibliographicItem,
     #   RelatonIsoBib::IsoBibliographicItem, RelatonItu::ItuBibliographicItem,
     #   RelatonIetf::IetfBibliographicItem, RelatonIec::IecBibliographicItem,
@@ -304,9 +318,7 @@ module Relaton
     #   RelatonBipm::BipmBibliographicItem, RelatonIho::IhoBibliographicItem,
     #   RelatonOmg::OmgBibliographicItem, RelatonW3c::W3cBibliographicItem]
     def bib_retval(entry, stdclass)
-      if entry.nil? || entry.match?(/^not_found/) then nil
-      else @registry.processors[stdclass].from_xml(entry)
-      end
+      @registry.processors[stdclass].from_xml(entry) if entry
     end
 
     # @param code [String]
@@ -334,8 +346,7 @@ module Relaton
       if db.nil?
         return if opts[:fetch_db]
 
-        bibentry = new_bib_entry(searchcode, year, opts, stdclass, db: db,
-                                                                   id: id)
+        bibentry = new_bib_entry(searchcode, year, opts, stdclass)
         return bib_retval(bibentry, stdclass)
       end
 
@@ -348,45 +359,58 @@ module Relaton
         @semaphore.synchronize do
           db.clone_entry id, altdb if altdb.valid_entry? id, year
         end
-        entry = new_bib_entry(searchcode, year, opts, stdclass, db: db, id: id) unless db[id]
+        new_bib_entry(searchcode, year, opts, stdclass, db: db, id: id)
         @semaphore.synchronize do
-          db[id] ||= entry
           altdb.clone_entry(id, db) if !altdb.valid_entry?(id, year)
         end
       else
         return bib_retval(db[id], stdclass) if opts[:fetch_db]
 
-        db[id] ||= new_bib_entry(searchcode, year, opts, stdclass, db: db,
-                                                                   id: id)
+        new_bib_entry(searchcode, year, opts, stdclass, db: db, id: id)
       end
       bib_retval(db[id], stdclass)
     end
 
+    #
+    # Create new bibliographic entry if it doesn't exist in database
+    #
     # @param code [String]
     # @param year [String]
     #
     # @param opts [Hash]
-    # @option opts [Boolean] :all_parts If all-parts reference is required
-    # @option opts [Boolean] :keep_year If undated reference should return
-    #   actual reference with year
+    # @option opts [Boolean, nil] :all_parts If true then all-parts reference is
+    #   requested
+    # @option opts [Boolean, nil] :keep_year If true then undated reference
+    #   should return actual reference with year
     # @option opts [Integer] :retries (1) Number of network retries
     #
     # @param stdclass [Symbol]
-    # @param db [Relaton::DbCache,`NilClass]
-    # @param id [String] docid
-    # @return [String]
-    def new_bib_entry(code, year, opts, stdclass, **args) # rubocop:disable Metrics/AbcSize,Metrics/CyclomaticComplexity,Metrics/PerceivedComplexity
+    # @param db [Relaton::DbCache,`nil]
+    # @param id [String, nil] docid
+    #
+    # @return [String] bibliographic entry
+    #   XML or "redirection ID" or "not_found YYYY-MM-DD" string
+    #
+    def new_bib_entry(code, year, opts, stdclass, **args) # rubocop:disable Metrics/AbcSize,Metrics/CyclomaticComplexity,Metrics/PerceivedComplexity,Metrics/MethodLength
+      entry = @semaphore.synchronize { args[:db] && args[:db][args[:id]] }
+      if entry
+        Util.log "[relaton] (#{code}) not found." if entry&.match?(/^not_found/)
+        return entry
+      end
+
       bib = net_retry(code, year, opts, stdclass, opts.fetch(:retries, 1))
       bib_id = bib&.docidentifier&.first&.id
 
       # when docid doesn't match bib's id then return a reference to bib's id
-      if args[:db] && args[:id] &&
-          bib_id && args[:id] !~ %r{#{Regexp.quote("(#{bib_id})")}}
-        bid = std_id(bib.docidentifier.first.id, nil, {}, stdclass).first
-        @semaphore.synchronize { args[:db][bid] ||= bib_entry bib }
-        "redirection #{bid}"
-      else bib_entry bib
-      end
+      entry = if args[:db] && args[:id] && bib_id && args[:id] !~ %r{#{Regexp.quote("(#{bib_id})")}}
+                bid = std_id(bib.docidentifier.first.id, nil, {}, stdclass).first
+                @semaphore.synchronize { args[:db][bid] ||= bib_entry bib }
+                "redirection #{bid}"
+              else bib_entry bib
+              end
+      return entry if args[:db].nil? || args[:id].nil?
+
+      @semaphore.synchronize { args[:db][args[:id]] ||= entry }
     end
 
     # @raise [RelatonBib::RequestError]
@@ -442,10 +466,16 @@ module Relaton
     end
 
     class << self
+      #
       # Initialse and return relaton instance, with local and global cache names
-      # local_cache: local cache name; none created if nil; "relaton" created
-      # if empty global_cache: boolean to create global_cache
-      # flush_caches: flush caches
+      #
+      # @param local_cache [String, nil] local cache name;
+      #   "relaton" created if empty or nil
+      # @param global_cache [Boolean, nil] create global_cache if true
+      # @param flush_caches [Boolean, nil] flush caches if true
+      #
+      # @return [Relaton::Db] relaton DB instance
+      #
       def init_bib_caches(**opts) # rubocop:disable Metrics/CyclomaticComplexity
         globalname = global_bibliocache_name if opts[:global_cache]
         localname = local_bibliocache_name(opts[:local_cache])

data/lib/relaton/db_cache.rb

@@ -45,7 +45,7 @@ module Relaton
       end
 
       prefix_dir = "#{@dir}/#{prefix(key)}"
-      FileUtils::mkdir_p prefix_dir unless Dir.exist? prefix_dir
+      FileUtils::mkdir_p prefix_dir
       set_version prefix_dir
       file_safe_write "#{filename(key)}.#{ext(value)}", value
     end
@@ -72,6 +72,12 @@ module Relaton
       end
     end
 
+    #
+    # Save entry from cache of `db` to this cache.
+    #
+    # @param [String] key key of the entry
+    # @param [Relaton::Db] db database
+    #
     def clone_entry(key, db)
       self[key] ||= db.get(key)
       if (code = redirect? get(key))

data/lib/relaton/version.rb

@@ -1,3 +1,3 @@
 module Relaton
-  VERSION = "1.11.4".freeze
+  VERSION = "1.12.1".freeze
 end

data/relaton.gemspec

@@ -29,27 +29,27 @@ Gem::Specification.new do |spec|
   # spec.test_files    = `git ls-files -- {spec}/*`.split("\n")
   spec.required_ruby_version = Gem::Requirement.new(">= 2.6.0")
 
-  spec.add_dependency "relaton-3gpp", "~> 1.11.0"
-  spec.add_dependency "relaton-bipm", "~> 1.11.0"
-  spec.add_dependency "relaton-bsi", "~> 1.11.0"
-  spec.add_dependency "relaton-calconnect", "~> 1.11.0"
-  spec.add_dependency "relaton-cen", "~> 1.11.0"
-  spec.add_dependency "relaton-cie", "~> 1.11.0"
-  spec.add_dependency "relaton-ecma", "~> 1.11.0"
-  spec.add_dependency "relaton-gb", "~> 1.11.0"
-  spec.add_dependency "relaton-iana", "~> 1.11.0"
-  spec.add_dependency "relaton-iec", "~> 1.11.0"
-  spec.add_dependency "relaton-ieee", "~> 1.11.0"
-  spec.add_dependency "relaton-ietf", "~> 1.11.0"
-  spec.add_dependency "relaton-iho", "~> 1.11.0"
-  spec.add_dependency "relaton-iso", "~> 1.11.0"
-  spec.add_dependency "relaton-itu", "~> 1.11.0"
-  spec.add_dependency "relaton-nist", "~> 1.11.0"
-  spec.add_dependency "relaton-oasis", "~> 1.11.0"
-  spec.add_dependency "relaton-ogc", "~> 1.11.0"
-  spec.add_dependency "relaton-omg", "~> 1.11.0"
-  spec.add_dependency "relaton-un", "~> 1.11.0"
-  spec.add_dependency "relaton-w3c", "~> 1.11.0"
+  spec.add_dependency "relaton-3gpp", "~> 1.12.0"
+  spec.add_dependency "relaton-bipm", "~> 1.12.0"
+  spec.add_dependency "relaton-bsi", "~> 1.12.0"
+  spec.add_dependency "relaton-calconnect", "~> 1.12.0"
+  spec.add_dependency "relaton-cen", "~> 1.12.0"
+  spec.add_dependency "relaton-cie", "~> 1.12.0"
+  spec.add_dependency "relaton-ecma", "~> 1.12.0"
+  spec.add_dependency "relaton-gb", "~> 1.12.0"
+  spec.add_dependency "relaton-iana", "~> 1.12.0"
+  spec.add_dependency "relaton-iec", "~> 1.12.0"
+  spec.add_dependency "relaton-ieee", "~> 1.12.0"
+  spec.add_dependency "relaton-ietf", "~> 1.12.0"
+  spec.add_dependency "relaton-iho", "~> 1.12.0"
+  spec.add_dependency "relaton-iso", "~> 1.12.0"
+  spec.add_dependency "relaton-itu", "~> 1.12.0"
+  spec.add_dependency "relaton-nist", "~> 1.12.0"
+  spec.add_dependency "relaton-oasis", "~> 1.12.0"
+  spec.add_dependency "relaton-ogc", "~> 1.12.0"
+  spec.add_dependency "relaton-omg", "~> 1.12.0"
+  spec.add_dependency "relaton-un", "~> 1.12.0"
+  spec.add_dependency "relaton-w3c", "~> 1.12.0"
 
   spec.add_development_dependency "byebug", "~> 11.0"
   spec.add_development_dependency "equivalent-xml", "~> 0.6"

data/spec/relaton/db_spec.rb

@@ -1,6 +1,40 @@
 RSpec.describe Relaton::Db do
   before(:each) { FileUtils.rm_rf %w[testcache testcache2] }
 
+  context "instance methods" do
+    subject { Relaton::Db.new nil, nil }
+
+    context "#search_edition_year" do
+      it "create bibitem from YAML content" do
+        h = { "docid" => [{ "id" => "ISO 123", type: "ISO", "primary" => true }] }
+        expect(YAML).to receive(:safe_load).with(:content).and_return h
+        item = subject.send :search_edition_year, "iso/item.yaml", :content, nil, nil
+        expect(item).to be_instance_of RelatonIsoBib::IsoBibliographicItem
+      end
+    end
+
+    context "#new_bib_entry" do
+      it "warn if cached entry is not_found" do
+        id = "ISO(ISO 123)"
+        db = double "db"
+        expect(db).to receive(:[]).with(id).and_return "not_found"
+        expect do
+          entry = subject.send :new_bib_entry, "ISO 123", nil, {}, :relaton_iso, db: db, id: id
+          expect(entry).to eq "not_found"
+        end.to output("[relaton] (ISO 123) not found.\n").to_stderr
+      end
+    end
+  end
+
+  context "class methods" do
+    it "::init_bib_caches" do
+      expect(FileUtils).to receive(:rm_rf).with(/\/\.relaton\/cache$/)
+      expect(FileUtils).to receive(:rm_rf).with(/testcache\/cache$/)
+      expect(Relaton::Db).to receive(:new).with(/\/\.relaton\/cache$/, /testcache\/cache$/)
+      Relaton::Db.init_bib_caches(global_cache: true, local_cache: "testcache", flush_caches: true)
+    end
+  end
+
   context "modifing database" do
     let(:db) { Relaton::Db.new "testcache", "testcache2" }
 
@@ -178,7 +212,7 @@ RSpec.describe Relaton::Db do
       refs = ["CGPM Resolution 1889-00", "CGPM Résolution 1889-00",
               "CGPM Réunion 9", "CGPM Meeting 9"]
       results = []
-      VCR.use_cassette "bipm_i18n_async_fetch" do
+      VCR.use_cassette "bipm_i18n_async_fetch", match_requests_on: %i[method uri body] do
         refs.each do |ref|
           db.fetch_async(ref) { |r| queue << [r, ref] }
         end
@@ -198,6 +232,22 @@ RSpec.describe Relaton::Db do
       expect(result).to be_nil
     end
 
+    it "handle HTTP request error" do
+      expect(db).to receive(:fetch).and_raise RelatonBib::RequestError
+      db.fetch_async("ISO REF") { |r| queue << r }
+      result = Timeout.timeout(5) { queue.pop }
+      expect(result).to be_instance_of RelatonBib::RequestError
+    end
+
+    it "handle other errors" do
+      expect(db).to receive(:fetch).and_raise Errno::EACCES
+      expect do
+        db.fetch_async("ISO REF") { |r| queue << r }
+        result = Timeout.timeout(5) { queue.pop }
+        expect(result).to be_nil
+      end.to output("[relaton] ERROR: ISO REF -- Permission denied\n").to_stderr
+    end
+
     it "use threads number from RELATON_FETCH_PARALLEL" do
       expect(ENV).to receive(:[]).with("RELATON_FETCH_PARALLEL").and_return(1)
       allow(ENV).to receive(:[]).and_call_original

data/spec/spec_helper.rb

@@ -13,6 +13,7 @@ VCR.configure do |c|
     clean_outdated_http_interactions: true,
     re_record_interval: 7 * 24 * 3600,
     record: :once,
+    allow_playback_repeats: true,
   }
   c.hook_into :webmock
 end

data/spec/vcr_cassetes/3gpp_tr_00_01u_umts_3_0_0.yml

@@ -41,29 +41,29 @@ http_interactions:
       X-Xss-Protection:
       - 1; mode=block
       X-Github-Request-Id:
-      - 7178:6974:A78BC:C192B:62AAF846
+      - 7D28:10C50:1BF854C:1DDFC0B:62BDDA6B
       Accept-Ranges:
       - bytes
       Date:
-      - Thu, 16 Jun 2022 09:30:46 GMT
+      - Thu, 30 Jun 2022 17:16:27 GMT
       Via:
       - 1.1 varnish
       X-Served-By:
-      - cache-vie6334-VIE
+      - cache-vie6348-VIE
       X-Cache:
       - MISS
       X-Cache-Hits:
       - '0'
       X-Timer:
-      - S1655371847.568153,VS0,VE230
+      - S1656609387.047148,VS0,VE235
       Vary:
       - Authorization,Accept-Encoding,Origin
       Access-Control-Allow-Origin:
       - "*"
       X-Fastly-Request-Id:
-      - da76509a3e570d0b83c3692633c0dfea81acef96
+      - 93a267346ed97c52087b05f16495084f70b848e8
       Expires:
-      - Thu, 16 Jun 2022 09:35:46 GMT
+      - Thu, 30 Jun 2022 17:21:27 GMT
       Source-Age:
       - '0'
     body:
@@ -143,5 +143,5 @@ http_interactions:
           freeze_stage3_meeting: SMG-28
           close_meeting: SP-28
           project_end: '1999-02-12'
-  recorded_at: Thu, 16 Jun 2022 09:30:46 GMT
+  recorded_at: Thu, 30 Jun 2022 17:16:27 GMT
 recorded_with: VCR 6.1.0