relaton 1.12.0 → 1.12.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: eb0eb1b1516d3d9891e873ecad6e439da21cb0cf0ef1b13d9f0a53568b04ad6d
-  data.tar.gz: af692237538c88b588db7537366d0fbc476e92e60f48163f892f0cb254c1fa2d
+  metadata.gz: 8299cf7ea6a28e344f438461d16233fe9acd733bc00441583ce9768c702b15fa
+  data.tar.gz: 28d87384bb3b763981ae98902b144236254b7cce20c3d608ef746be679b0661a
 SHA512:
-  metadata.gz: 771e6695638f73ee4c6bb4c00d376889ecd5b7120cd9f31e055ab06f3060b24b55e3276f90d74909806b5977f54593cabc201a17729922e2589e5ac1c0fe6ea4
-  data.tar.gz: 2e9611d5f1b99206a2c99f42720638321781563109e9b0e01345c9576dd6bbd9836c185b55233ea6d7c7ddeaf7c86d90a00605a52ba12d6f9527b7c9a6df5cc0
+  metadata.gz: 5720aed26b5585b6673d92fd8c99fbae0883689c254344d5dbad5549a157388bd6422a2550942eb58a8d32f1c2d0aeafd6485de55274c0c02271ec5f87661405
+  data.tar.gz: 45fca34e30fe15699b9b3933f4060c877d54947ae31c5bc70ff05812b654c0876175eedda1d71ef16755a4db02a797c30199cd2128d081ae46b186a4939964f5

data/lib/relaton/db.rb

@@ -208,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]
@@ -305,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,
@@ -316,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]
@@ -346,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
 
@@ -360,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]
 
-        entry = new_bib_entry(searchcode, year, opts, stdclass, db: db, id: id) unless db[id]
-        @semaphore.synchronize { db[id] ||= entry }
+        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]
@@ -454,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.12.0".freeze
+  VERSION = "1.12.1".freeze
 end

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" }
 

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:
-      - 8632:A505:57A7C:6013A:62B49FA8
+      - 7D28:10C50:1BF854C:1DDFC0B:62BDDA6B
       Accept-Ranges:
       - bytes
       Date:
-      - Thu, 23 Jun 2022 17:15:20 GMT
+      - Thu, 30 Jun 2022 17:16:27 GMT
       Via:
       - 1.1 varnish
       X-Served-By:
-      - cache-vie6363-VIE
+      - cache-vie6348-VIE
       X-Cache:
       - MISS
       X-Cache-Hits:
       - '0'
       X-Timer:
-      - S1656004520.417992,VS0,VE231
+      - S1656609387.047148,VS0,VE235
       Vary:
       - Authorization,Accept-Encoding,Origin
       Access-Control-Allow-Origin:
       - "*"
       X-Fastly-Request-Id:
-      - e165b70d2170479617e6f38ce302ae4e577caea3
+      - 93a267346ed97c52087b05f16495084f70b848e8
       Expires:
-      - Thu, 23 Jun 2022 17:20:20 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, 23 Jun 2022 17:15:20 GMT
+  recorded_at: Thu, 30 Jun 2022 17:16:27 GMT
 recorded_with: VCR 6.1.0