relaton 1.7.6 → 1.7.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fdf3d2a7e0d55bf5b5edf65ef0e6f1f3d3ce5648388b6bae43127040df90d881
-  data.tar.gz: d3cc65b7002c57f6e72c86dccfab92956a992fcfef9ce836ec5b3b4806646e88
+  metadata.gz: 5814864d64a95c8d7cb4fbb094b2e789cf4f7b731ebc8a2e1f41a7cdbbce2115
+  data.tar.gz: 57319c212c34e9ff237b0f834eaad40f3d173dc3de784acd4a5ea804bc11ae01
 SHA512:
-  metadata.gz: ae4cba856c12417b10308310c14aec5e2d4452c0c24a4fe30b597d57b7c142e138e858fb97ad452bb29488e3d5d4b0a6bc1fde8dcc41bd4bb10c837315dc7257
-  data.tar.gz: e47b6c8e2feb25956d77df52352a474936168854263aeb354d526890b63428d420eeebdc7be6f6547689ec5a25e5a1b2045c72d82680ae7e234c5d1d42023579
+  metadata.gz: '097fcda0d2884380cbb6b64bdcbc43f38215036921177e897c5962274885456a49a323ea4c02a7a548bfb696cba261d1aac0e7ad7dfc51abe698d9d117b715b5'
+  data.tar.gz: 0052e5b6696c790e7deb6d17dd7b12a2918b452f93101cda548c96316317988a061a6aabe8c1277fdc69c45f9bfa2f3af2ab6f862adee48efa0504641d3035c1

data/docs/README.adoc

@@ -106,14 +106,18 @@ db = Relaton::Db.new("globalcache", "localcache")
 
 ==== Move DB
 
-`Relaton::Db#mv(new_globalcache_dir, new_localcahe_dir)` moves DB directories to new location.
+`Relaton::Db#mv(new_dir, type: :global)` moves DB directory to new location. Returns path to new directory if successful, or `nil` if target directiory exists.
 
-* `new_globalcahe_dir` - (String or nil) new globalcache location
-* `new_localcahe_dir` - (String or nil) new localcache location
+* `new_dir` - (String) new cache location
+* `type` - (Symbol) type of cache DB. Allowed values are: `:global`, `:local`. Default is `:global`.
 
 [source,ruby]
 ----
-db.mv("new_globalcache_dir", "new_localcahe_dir")
+db.mv("new_global_dir")
+=> "new_global_dir"
+
+db.mv("new_local_dir", type: :local)
+=> "new_local_dir"
 ----
 
 ==== Clear DB
@@ -330,7 +334,7 @@ ISO/IEC DIR 1
 ISO/IEC DIR 2 IEC
 ISO/IEC DIR 2 ISO
 ISO/IEC DIR IEC SUP
-ISO/IEC DIR 1 ISO SUP
+ISO/IEC DIR 1 JTC SUP
 ----
 
 === Get document type
@@ -368,7 +372,7 @@ x.to_xml bibdata: true
 db.load_entry("ISO(ISO 19011)")
 => "<bibdata type="standard">
       ...
-    <?bibdata>"
+    </bibdata>"
 ----
 
 === Entry manipulation

data/lib/relaton/config.rb

@@ -15,8 +15,10 @@ module Relaton
     attr_accessor :logs, :use_api
 
     def initialize
-      @logs = %i(warning error)
-      @use_api = false # @TODO change to true when we start using api.relaton.org
+      @logs = %i(info error)
+
+      # @TODO change to true when we start using api.relaton.org
+      @use_api = false
     end
   end
 

data/lib/relaton/db.rb

@@ -10,51 +10,64 @@ module Relaton
     # @param local_cache [String] directory of local DB
     def initialize(global_cache, local_cache)
       @registry = Relaton::Registry.instance
-      @db = open_cache_biblio(global_cache, type: :global)
-      @local_db = open_cache_biblio(local_cache, type: :local)
-      @static_db = open_cache_biblio File.expand_path("../relaton/static_cache", __dir__)
+      gpath = global_cache && File.expand_path(global_cache)
+      @db = open_cache_biblio(gpath, type: :global)
+      lpath = local_cache && File.expand_path(local_cache)
+      @local_db = open_cache_biblio(lpath, type: :local)
+      @static_db = open_cache_biblio File.expand_path("../relaton/static_cache",
+                                                      __dir__)
       @queues = {}
     end
 
-    # Move global and/or local caches to anothe dirs
-    # @param new_global_dir [String, nil]
-    # @param new_local_dir [String, nil]
-    def mv(new_global_dir, new_local_dir)
-      @db.mv new_global_dir
-      @local_db.mv new_local_dir
+    # Move global or local caches to anothe dirs
+    # @param new_dir [String, nil]
+    # @param type: [Symbol]
+    # @return [String, nil]
+    def mv(new_dir, type: :global)
+      case type
+      when :global
+        @db&.mv new_dir
+      when :local
+        @local_db&.mv new_dir
+      end
     end
 
     # Clear global and local databases
     def clear
-      @db.clear
-      @local_db.clear
+      @db&.clear
+      @local_db&.clear
     end
 
     ##
     # The class of reference requested is determined by the prefix of the code:
-    # GB Standard for gbbib, IETF for ietfbib, ISO for isobib, IEC or IEV for iecbib,
+    # GB Standard for gbbib, IETF for ietfbib, ISO for isobib, IEC or IEV for
+    #   iecbib,
     #
     # @param code [String] the ISO standard Code to look up (e.g. "ISO 9000")
     # @param year [String] the year the standard was published (optional)
     #
     # @param opts [Hash] options
     # @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] :keep_year If undated reference should return
+    #   actual reference with year
     # @option opts [Integer] :retries (1) Number of network retries
     #
-    # @return [nil, RelatonBib::BibliographicItem, RelatonIsoBib::IsoBibliographicItem,
-    #   RelatonItu::ItuBibliographicItem, RelatonIetf::IetfBibliographicItem,
-    #   RelatonIec::IecBibliographicItem, RelatonIeee::IeeeBibliographicItem,
-    #   RelatonNist::NistBibliongraphicItem, RelatonGb::GbbibliographicItem,
-    #   RelatonOgc::OgcBibliographicItem, RelatonCalconnect::CcBibliographicItem]
+    # @return [nil, RelatonBib::BibliographicItem,
+    #   RelatonIsoBib::IsoBibliographicItem, RelatonItu::ItuBibliographicItem,
+    #   RelatonIetf::IetfBibliographicItem, RelatonIec::IecBibliographicItem,
+    #   RelatonIeee::IeeeBibliographicItem, RelatonNist::NistBibliongraphicItem,
+    #   RelatonGb::GbbibliographicItem, RelatonOgc::OgcBibliographicItem,
+    #   RelatonCalconnect::CcBibliographicItem, RelatinUn::UnBibliographicItem,
     #   RelatonBipm::BipmBibliographicItem, RelatonIho::IhoBibliographicItem,
-    #   RelatonOmg::OmgBibliographicItem RelatinUn::UnBibliographicItem,
-    #   RelatonW3c::W3cBibliographicItem
+    #   RelatonOmg::OmgBibliographicItem, RelatonW3c::W3cBibliographicItem]
     ##
     def fetch(code, year = nil, opts = {})
       stdclass = standard_class(code) || return
       processor = @registry.processors[stdclass]
-      ref = processor.respond_to?(:urn_to_code) ? processor.urn_to_code(code)&.first : code
+      ref = if processor.respond_to?(:urn_to_code)
+              processor.urn_to_code(code)&.first
+            else code
+            end
       ref ||= code
       result = combine_doc ref, year, opts, stdclass
       result ||= check_bibliocache(ref, year, opts, stdclass)
@@ -73,9 +86,15 @@ module Relaton
     # @param year [Integer, nil]
     # @return [Array]
     def fetch_all(text = nil, edition: nil, year: nil)
-      result = @static_db.all { |file, yml| search_yml file, yml, text, edition, year }.compact
+      result = @static_db.all do |file, yml|
+        search_yml file, yml, text, edition, year
+      end.compact
       db = @db || @local_db
-      result += db.all { |file, xml| search_xml file, xml, text, edition, year }.compact if db
+      if db
+        result += db.all do |file, xml|
+          search_xml file, xml, text, edition, year
+        end.compact
+      end
       result
     end
 
@@ -100,17 +119,18 @@ module Relaton
     #
     # @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] :keep_year If undated reference should return
+    #   actual reference with year
     # @option opts [Integer] :retries (1) Number of network retries
     #
-    # @return [nil, RelatonBib::BibliographicItem, RelatonIsoBib::IsoBibliographicItem,
-    #   RelatonItu::ItuBibliographicItem, RelatonIetf::IetfBibliographicItem,
-    #   RelatonIec::IecBibliographicItem, RelatonIeee::IeeeBibliographicItem,
-    #   RelatonNist::NistBibliongraphicItem, RelatonGb::GbbibliographicItem,
-    #   RelatonOgc::OgcBibliographicItem, RelatonCalconnect::CcBibliographicItem]
+    # @return [nil, RelatonBib::BibliographicItem,
+    #   RelatonIsoBib::IsoBibliographicItem, RelatonItu::ItuBibliographicItem,
+    #   RelatonIetf::IetfBibliographicItem, RelatonIec::IecBibliographicItem,
+    #   RelatonIeee::IeeeBibliographicItem, RelatonNist::NistBibliongraphicItem,
+    #   RelatonGb::GbbibliographicItem, RelatonOgc::OgcBibliographicItem,
+    #   RelatonCalconnect::CcBibliographicItem, RelatinUn::UnBibliographicItem,
     #   RelatonBipm::BipmBibliographicItem, RelatonIho::IhoBibliographicItem,
-    #   RelatonOmg::OmgBibliographicItem RelatinUn::UnBibliographicItem,
-    #   RelatonW3c::W3cBibliographicItem
+    #   RelatonOmg::OmgBibliographicItem, RelatonW3c::W3cBibliographicItem]
     def fetch_std(code, year = nil, stdclass = nil, opts = {})
       std = nil
       @registry.processors.each do |name, processor|
@@ -193,9 +213,11 @@ module Relaton
     # @return [BibliographicItem, nil]
     def search_edition_year(file, content, edition, year) # rubocop:disable Metrics/AbcSize,Metrics/CyclomaticComplexity,Metrics/PerceivedComplexity
       processor = @registry.processors[standard_class(file.split("/")[-2])]
-      item = file.match?(/xml$/) ? processor.from_xml(content) : processor.hash_to_bib(YAML.safe_load(content))
-      item if (edition.nil? || item.edition == edition) &&
-        (year.nil? || item.date.detect { |d| d.type == "published" && d.on(:year) == year })
+      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.date.detect { |d| d.type == "published" && d.on(:year).to_s == year.to_s })
     end
 
     # @param xml [String] content in XML format
@@ -211,17 +233,18 @@ module Relaton
     #
     # @param opts [Hash] options
     # @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] :keep_year If undated reference should return
+    #   actual reference with year
     # @option opts [Integer] :retries (1) Number of network retries
     #
-    # @return [nil, RelatonBib::BibliographicItem, RelatonIsoBib::IsoBibliographicItem,
-    #   RelatonItu::ItuBibliographicItem, RelatonIetf::IetfBibliographicItem,
-    #   RelatonIec::IecBibliographicItem, RelatonIeee::IeeeBibliographicItem,
-    #   RelatonNist::NistBibliongraphicItem, RelatonGb::GbbibliographicItem,
-    #   RelatonOgc::OgcBibliographicItem, RelatonCalconnect::CcBibliographicItem]
+    # @return [nil, RelatonBib::BibliographicItem,
+    #   RelatonIsoBib::IsoBibliographicItem, RelatonItu::ItuBibliographicItem,
+    #   RelatonIetf::IetfBibliographicItem, RelatonIec::IecBibliographicItem,
+    #   RelatonIeee::IeeeBibliographicItem, RelatonNist::NistBibliongraphicItem,
+    #   RelatonGb::GbbibliographicItem, RelatonOgc::OgcBibliographicItem,
+    #   RelatonCalconnect::CcBibliographicItem, RelatinUn::UnBibliographicItem,
     #   RelatonBipm::BipmBibliographicItem, RelatonIho::IhoBibliographicItem,
-    #   RelatonOmg::OmgBibliographicItem RelatinUn::UnBibliographicItem,
-    #   RelatonW3c::W3cBibliographicItem
+    #   RelatonOmg::OmgBibliographicItem, RelatonW3c::W3cBibliographicItem]
     def combine_doc(code, year, opts, stdclass) # rubocop:disable Metrics/AbcSize,Metrics/MethodLength
       if (refs = code.split " + ").size > 1
         reltype = "derivedFrom"
@@ -235,11 +258,16 @@ module Relaton
       doc = @registry.processors[stdclass].hash_to_bib docid: { id: code }
       ref = refs[0]
       updates = check_bibliocache(ref, year, opts, stdclass)
-      doc.relation << RelatonBib::DocumentRelation.new(bibitem: updates, type: "updates") if updates
+      if updates
+        doc.relation << RelatonBib::DocumentRelation.new(bibitem: updates,
+                                                         type: "updates")
+      end
       refs[1..-1].each_with_object(doc) do |c, d|
         bib = check_bibliocache("#{ref}/#{c}", year, opts, stdclass)
         if bib
-          d.relation << RelatonBib::DocumentRelation.new(type: reltype, description: reldesc, bibitem: bib)
+          d.relation << RelatonBib::DocumentRelation.new(
+            type: reltype, description: reldesc, bibitem: bib
+          )
         end
       end
     end
@@ -254,8 +282,8 @@ module Relaton
       allowed = @registry.processors.reduce([]) do |m, (_k, v)|
         m << v.prefix
       end
-      warn <<~WARN
-        #{code} does not have a recognised prefix: #{allowed.join(', ')}.
+      Util.log <<~WARN, :info
+        [relaton] #{code} does not have a recognised prefix: #{allowed.join(', ')}.
         See https://github.com/relaton/relaton/ for instructions on prefixing and wrapping document identifiers to disambiguate them.
       WARN
     end
@@ -267,7 +295,8 @@ module Relaton
     #
     # @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] :keep_year If undated reference should return
+    #   actual reference with year
     # @option opts [Integer] :retries (1) Number of network retries
     #
     # @param stdClass [Symbol]
@@ -292,16 +321,18 @@ module Relaton
 
     # @param entry [String] XML string
     # @param stdclass [Symbol]
-    # @return [nil, RelatonBib::BibliographicItem, RelatonIsoBib::IsoBibliographicItem,
-    #   RelatonItu::ItuBibliographicItem, RelatonIetf::IetfBibliographicItem,
-    #   RelatonIec::IecBibliographicItem, RelatonIeee::IeeeBibliographicItem,
-    #   RelatonNist::NistBibliongraphicItem, RelatonGb::GbbibliographicItem,
-    #   RelatonOgc::OgcBibliographicItem, RelatonCalconnect::CcBibliographicItem]
+    # @return [nil, RelatonBib::BibliographicItem,
+    #   RelatonIsoBib::IsoBibliographicItem, RelatonItu::ItuBibliographicItem,
+    #   RelatonIetf::IetfBibliographicItem, RelatonIec::IecBibliographicItem,
+    #   RelatonIeee::IeeeBibliographicItem, RelatonNist::NistBibliongraphicItem,
+    #   RelatonGb::GbbibliographicItem, RelatonOgc::OgcBibliographicItem,
+    #   RelatonCalconnect::CcBibliographicItem, RelatinUn::UnBibliographicItem,
     #   RelatonBipm::BipmBibliographicItem, RelatonIho::IhoBibliographicItem,
-    #   RelatonOmg::OmgBibliographicItem RelatinUn::UnBibliographicItem,
-    #   RelatonW3c::W3cBibliographicItem
+    #   RelatonOmg::OmgBibliographicItem, RelatonW3c::W3cBibliographicItem]
     def bib_retval(entry, stdclass)
-      entry.nil? || entry.match?(/^not_found/) ? nil : @registry.processors[stdclass].from_xml(entry)
+      if entry.nil? || entry.match?(/^not_found/) then nil
+      else @registry.processors[stdclass].from_xml(entry)
+      end
     end
 
     # @param code [String]
@@ -309,29 +340,33 @@ module Relaton
     #
     # @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] :keep_year If undated reference should return
+    #   actual reference with year
     # @option opts [Integer] :retries (1) Number of network retries
     #
     # @param stdclass [Symbol]
-    # @return [nil, RelatonBib::BibliographicItem, RelatonIsoBib::IsoBibliographicItem,
-    #   RelatonItu::ItuBibliographicItem, RelatonIetf::IetfBibliographicItem,
-    #   RelatonIec::IecBibliographicItem, RelatonIeee::IeeeBibliographicItem,
-    #   RelatonNist::NistBibliongraphicItem, RelatonGb::GbbibliographicItem,
-    #   RelatonOgc::OgcBibliographicItem, RelatonCalconnect::CcBibliographicItem]
+    # @return [nil, RelatonBib::BibliographicItem,
+    #   RelatonIsoBib::IsoBibliographicItem, RelatonItu::ItuBibliographicItem,
+    #   RelatonIetf::IetfBibliographicItem, RelatonIec::IecBibliographicItem,
+    #   RelatonIeee::IeeeBibliographicItem, RelatonNist::NistBibliongraphicItem,
+    #   RelatonGb::GbbibliographicItem, RelatonOgc::OgcBibliographicItem,
+    #   RelatonCalconnect::CcBibliographicItem, RelatinUn::UnBibliographicItem,
     #   RelatonBipm::BipmBibliographicItem, RelatonIho::IhoBibliographicItem,
-    #   RelatonOmg::OmgBibliographicItem RelatinUn::UnBibliographicItem,
-    #   RelatonW3c::W3cBibliographicItem
+    #   RelatonOmg::OmgBibliographicItem, RelatonW3c::W3cBibliographicItem]
     def check_bibliocache(code, year, opts, stdclass) # rubocop:disable Metrics/AbcSize,Metrics/CyclomaticComplexity,Metrics/MethodLength,Metrics/PerceivedComplexity
       id, searchcode = std_id(code, year, opts, stdclass)
       yaml = @static_db[id]
-      return @registry.processors[stdclass].hash_to_bib YAML.safe_load(yaml) if yaml
+      if yaml
+        return @registry.processors[stdclass].hash_to_bib YAML.safe_load(yaml)
+      end
 
       db = @local_db || @db
       altdb = @local_db && @db ? @db : nil
       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, db: db,
+                                                                   id: id)
         return bib_retval(bibentry, stdclass)
       end
 
@@ -340,12 +375,14 @@ module Relaton
         return bib_retval(altdb[id], stdclass) if opts[:fetch_db]
 
         db.clone_entry id, altdb if altdb.valid_entry? id, year
-        db[id] ||= new_bib_entry(searchcode, year, opts, stdclass, db: db, id: id)
+        db[id] ||= new_bib_entry(searchcode, year, opts, stdclass, db: db,
+                                                                   id: id)
         altdb.clone_entry(id, db) if !altdb.valid_entry?(id, year)
       else
         return bib_retval(db[id], stdclass) if opts[:fetch_db]
 
-        db[id] ||= new_bib_entry(searchcode, year, opts, stdclass, db: db, id: id)
+        db[id] ||= new_bib_entry(searchcode, year, opts, stdclass, db: db,
+                                                                   id: id)
       end
       bib_retval(db[id], stdclass)
     end
@@ -355,7 +392,8 @@ module Relaton
     #
     # @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] :keep_year If undated reference should return
+    #   actual reference with year
     # @option opts [Integer] :retries (1) Number of network retries
     #
     # @param stdclass [Symbol]
@@ -367,7 +405,8 @@ module Relaton
       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})")}}
+      if args[:db] && args[:id] &&
+          bib_id && args[:id] !~ %r{#{Regexp.quote("(#{bib_id})")}}
         bid = std_id(bib.docidentifier.first.id, nil, {}, stdclass).first
         args[:db][bid] ||= bib_entry bib
         "redirection #{bid}"
@@ -384,9 +423,14 @@ module Relaton
       net_retry(code, year, opts, stdclass, retries - 1)
     end
 
-    # @param bib [RelatonGb::GbBibliongraphicItem, RelatonIsoBib::IsoBibliographicItem,
-    #   RelatonIetf::IetfBibliographicItem, RelatonItu::ItuBibliographicItem,
-    #   RelatonNist::NistBibliongraphicItem, RelatonOgc::OgcBibliographicItem]
+    # @param bib [RelatonBib::BibliographicItem,
+    #   RelatonIsoBib::IsoBibliographicItem, RelatonItu::ItuBibliographicItem,
+    #   RelatonIetf::IetfBibliographicItem, RelatonIec::IecBibliographicItem,
+    #   RelatonIeee::IeeeBibliographicItem, RelatonNist::NistBibliongraphicItem,
+    #   RelatonGb::GbbibliographicItem, RelatonOgc::OgcBibliographicItem,
+    #   RelatonCalconnect::CcBibliographicItem, RelatinUn::UnBibliographicItem,
+    #   RelatonBipm::BipmBibliographicItem, RelatonIho::IhoBibliographicItem,
+    #   RelatonOmg::OmgBibliographicItem, RelatonW3c::W3cBibliographicItem]
     # @return [String] XML or "not_found mm-dd-yyyy"
     def bib_entry(bib)
       if bib.respond_to? :to_xml
@@ -399,7 +443,7 @@ module Relaton
     # @param dir [String, nil] DB directory
     # @param type [Symbol]
     # @return [Relaton::DbCache, NilClass]
-    def open_cache_biblio(dir, type: :static)
+    def open_cache_biblio(dir, type: :static) # rubocop:disable Metrics/MethodLength
       return nil if dir.nil?
 
       db = DbCache.new dir, type == :static ? "yml" : "xml"
@@ -408,9 +452,12 @@ module Relaton
       Dir["#{dir}/*/"].each do |fdir|
         next if db.check_version?(fdir)
 
-        FileUtils.rm_rf(Dir.glob(fdir + "/*"), secure: true)
-        db.set_version fdir
-        warn "[relaton] cache #{fdir}: version is obsolete and cache is cleared."
+        FileUtils.rm_rf(fdir, secure: true)
+        Util.log(
+          "[relaton] WARNING: cache #{fdir}: version is obsolete and cache is "\
+            "cleared.",
+          :warning
+        )
       end
       db
     end

data/lib/relaton/db_cache.rb

@@ -17,9 +17,15 @@ module Relaton
 
     # Move caches to anothe dir
     # @param new_dir [String, nil]
+    # @return [String, nil]
     def mv(new_dir)
       return unless new_dir && @ext == "xml"
 
+      if File.exist? new_dir
+        warn "[relaton] WARNING: target directory exists \"#{new_dir}\""
+        return
+      end
+
       FileUtils.mv dir, new_dir
       @dir = new_dir
     end

data/lib/relaton/util.rb

@@ -4,7 +4,7 @@ module Relaton
       log_types = Relaton.configuration.logs.map(&:to_s) || []
 
       if log_types.include?(type.to_s)
-        puts(message)
+        warn(message)
       end
     end
   end