relaton 1.19.1 → 1.20.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5a133026bf858511b0385b639ec7cc96ab0f855c31a5446d1d118d009eda235d
-  data.tar.gz: b9b89a70476bf01a6c9ca710047ccf13f4531174dafa12e5b37908bdf668d44c
+  metadata.gz: 94a274b069b9e4fb89f9eef427cd1d8e8a15d44bb1e9f2fb216764dd68cc96a8
+  data.tar.gz: f52ab0985197190b47243f31ca57696df9a75d84be8db069796cbefbd477b4d8
 SHA512:
-  metadata.gz: d35962b592b2eb4ed65261bed9638d304bd91ffc09baf1cb40c7e245692381b28d6d4985fe321d326d09770afa738ea3cce1e15ab499501d4221228559051140
-  data.tar.gz: 46d9116df1ae0f23d7aea5763908bb4b5ac3ec3073d2bbd8b67578c94b85ab5ab89f327747f420ca2226409955ff78de41a4eeabd7992cb32383491386a45b99
+  metadata.gz: d245875f0f716ea358aaf03518f1888c6c82a36588e0f788cb761f1975e53e9025829dab57772597f233c80b8354494978de709c68c4c47b22048d4417d748fe
+  data.tar.gz: c0179c0e2dc4ff8c1d43a8dbdb34fe7b7d50302e24da7c4e651f09dbe1db6441a692b178c27b980264186c9a4019513dd4ae3c3c4c14c08ef278472141a9735d

data/docs/CHANGELOG.adoc

@@ -0,0 +1,16 @@
+= Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on https://keepachangelog.com/en/1.0.0/[Keep a Changelog], and this project adheres to https://semver.org/[Semantic Versioning].
+
+== [Unreleased]
+
+== [1.19.2] - 2024-06-29
+- Lazy load Relaton flavor gems dependencies.
+
+== [1.19.1] - 2024-06-24
+- Add `relaton-plateau` flavor gem.
+
+== [1.19.0] - 2024-06-29
+- Switch to using the `relaton-logger` gem for logging.

data/docs/VERSIONING_POLICY.adoc

@@ -0,0 +1,38 @@
+= Versioning Policy
+
+This document describes the versioning policy for the Relaton project. We follow the https://semver.org/[Semantic Versioning] scheme.
+
+== Versioning Scheme
+
+Version nubmers are in the form of `MAJOR.MINOR.PATCH`. The version number is incremented based on the following:
+
+- `MAJOR` version is incremented when incompatible changes are made to the API.
+- `MINOR` version is incremented when the Relaton data model is changed.
+- `PATCH` version is incremented when backward-compatible bug fixes are made.
+
+== Rules for incrementing version numbers
+
+1. **MAJOR** version is incremented when incompatible changes are made to the API. Icrement the MAJOR version when:
+   - Removing or renaming classes or methods.
+   - Changing the signature of a method.
+   - Changing the behavior of a method.
+
+2. **MINOR** version is incremented when the Relaton data model is changed. Increment the MINOR version when:
+   - Adding, remmoving or renaming attributes of data model classes.
+   - Adding new data model classes.
+
+3. **PATCH** version is incremented when backward-compatible bug fixes are made. Increment the PATCH version when:
+   - Fixing a bug that does not change the behavior of the API.
+   - Improving the performance of the API.
+
+== Additional Guidelines
+
+For convenience, we use the same major and minor vesions for all the Relaton flavor gems that uses the same version of the Relaton data model.
+
+== Exceptions
+
+In some cases, we may increment the `PATCH` version for backward-incompatible changes. In such cases, we will update dependent gems to use the new version or higher. For example `"~> 1.19.2"` doen't allow to use version less than `1.19.2`.
+
+== References
+
+- https://semver.org/[Semantic Versioning]

data/lib/relaton/db.rb

@@ -28,6 +28,7 @@ module Relaton
       @db&.clear
       @local_db&.clear
       @registry.processors.each_value do |p|
+        require p.short.to_s
         p.remove_index_file if p.respond_to? :remove_index_file
       end
     end
@@ -59,7 +60,7 @@ module Relaton
     def fetch(text, year = nil, opts = {})
       reference = text.strip
       stdclass = @registry.class_by_ref(reference) || return
-      processor = @registry.processors[stdclass]
+      processor = @registry[stdclass]
       ref = if processor.respond_to?(:urn_to_code)
               processor.urn_to_code(reference)&.first
             else reference
@@ -105,7 +106,7 @@ module Relaton
       stdclass = @registry.class_by_ref ref
       if stdclass
         unless @queues[stdclass]
-          processor = @registry.processors[stdclass]
+          processor = @registry[stdclass]
           threads = ENV["RELATON_FETCH_PARALLEL"]&.to_i || processor.threads
           wp = WorkersPool.new(threads) do |args|
             args[3].call fetch(*args[0..2])
@@ -157,7 +158,7 @@ module Relaton
     def docid_type(code)
       stdclass = @registry.class_by_ref(code) or return [nil, code]
       _, code = strip_id_wrapper(code, stdclass)
-      [@registry.processors[stdclass].idtype, code]
+      [@registry[stdclass].idtype, code]
     end
 
     # @param key [String]
@@ -293,7 +294,7 @@ module Relaton
       else return
       end
 
-      doc = @registry.processors[stdclass].hash_to_bib docid: { id: code }
+      doc = @registry[stdclass].hash_to_bib docid: { id: code }
       ref = refs[0]
       updates = check_bibliocache(refs[0], year, opts, stdclass)
       if updates
@@ -336,7 +337,7 @@ module Relaton
     # @param stdClass [Symbol]
     # @return [Array]
     def strip_id_wrapper(code, stdclass)
-      prefix = @registry.processors[stdclass].prefix
+      prefix = @registry[stdclass].prefix
       code = code.sub(/\u2013/, "-").sub(/^#{prefix}\((.+)\)$/, "\\1")
       [prefix, code]
     end
@@ -355,7 +356,7 @@ module Relaton
     #   RelatonOmg::OmgBibliographicItem, RelatonW3c::W3cBibliographicItem]
     def bib_retval(entry, stdclass)
       if entry && !entry.match?(/^not_found/)
-        @registry.processors[stdclass].from_xml(entry)
+        @registry[stdclass].from_xml(entry)
       end
     end
 
@@ -443,7 +444,7 @@ module Relaton
     end
 
     def fetch_entry(code, year, opts, stdclass, **args)
-      processor = @registry.processors[stdclass]
+      processor = @registry[stdclass]
       bib = net_retry(code, year, opts, processor, opts.fetch(:retries, 1))
 
       entry = check_entry(bib, stdclass, **args)

data/lib/relaton/registry.rb

@@ -26,7 +26,6 @@ module Relaton
       # Util.info("Info: detecting backends:")
 
       SUPPORTED_GEMS.each do |b|
-        require b
         require "#{b}/processor"
         register Kernel.const_get "#{camel_case(b)}::Processor"
       rescue LoadError => e
@@ -61,7 +60,7 @@ module Relaton
     # @return [Relaton::Processor, nil]
     #
     def find_processor_by_dataset(dataset)
-      processors.values.detect { |p| p.datasets&.include? dataset }
+      require_gem(processors.values.detect { |p| p.datasets&.include? dataset })
     end
 
     #
@@ -73,7 +72,18 @@ module Relaton
     #   RelatonGb::Processor, RelatonOgc::Processor,
     #   RelatonCalconnect::Processor]
     def by_type(type)
-      processors.values.detect { |v| v.prefix == type&.upcase }
+      require_gem(processors.values.detect { |v| v.prefix == type&.upcase })
+    end
+
+    def [](stdclass)
+      require_gem processors[stdclass]
+    end
+
+    def require_gem(processor)
+      return unless processor
+
+      require processor.short.to_s
+      processor
     end
 
     #
@@ -84,7 +94,7 @@ module Relaton
     # @return [Relaton::Processor] processor
     #
     def processor_by_ref(ref)
-      @processors[class_by_ref(ref)]
+      require_gem processors[class_by_ref(ref)]
     end
 
     #
@@ -95,7 +105,7 @@ module Relaton
     # @return [Symbol, nil] standard class name
     #
     def class_by_ref(ref)
-      ref = ref.match(/^\w+\((.*)\)$/) ? Regexp.last_match(1) : ref
+      ref = ref =~ /^\w+\((.*)\)$/ ? Regexp.last_match(1) : ref
       @processors.each do |class_name, processor|
         return class_name if /^(urn:)?#{processor.prefix}\b/i.match?(ref) ||
           processor.defaultprefix.match(ref)

data/lib/relaton/version.rb

@@ -1,3 +1,3 @@
 module Relaton
-  VERSION = "1.19.1".freeze
+  VERSION = "1.20.0".freeze
 end

data/relaton.gemspec

@@ -29,32 +29,32 @@ Gem::Specification.new do |spec|
   # spec.test_files    = `git ls-files -- {spec}/*`.split("\n")
   spec.required_ruby_version = Gem::Requirement.new(">= 3.0.0")
 
-  spec.add_dependency "relaton-3gpp", "~> 1.19.0"
-  spec.add_dependency "relaton-bipm", "~> 1.19.0"
-  spec.add_dependency "relaton-bsi", "~> 1.19.1"
-  spec.add_dependency "relaton-calconnect", "~> 1.19.0"
-  spec.add_dependency "relaton-ccsds", "~> 1.19.0"
-  spec.add_dependency "relaton-cen", "~> 1.19.0"
-  spec.add_dependency "relaton-cie", "~> 1.19.0"
-  spec.add_dependency "relaton-doi", "~> 1.19.0"
-  spec.add_dependency "relaton-ecma", "~> 1.19.0"
-  spec.add_dependency "relaton-etsi", "~> 1.19.0"
-  spec.add_dependency "relaton-gb", "~> 1.19.0"
-  spec.add_dependency "relaton-iana", "~> 1.19.0"
-  spec.add_dependency "relaton-iec", "~> 1.19.0"
-  spec.add_dependency "relaton-ieee", "~> 1.19.0"
-  spec.add_dependency "relaton-ietf", "~> 1.19.0"
-  spec.add_dependency "relaton-iho", "~> 1.19.0"
-  spec.add_dependency "relaton-isbn", "~> 1.19.0"
-  spec.add_dependency "relaton-iso", "~> 1.19.0"
-  spec.add_dependency "relaton-itu", "~> 1.19.0"
-  spec.add_dependency "relaton-jis", "~> 1.19.0"
-  spec.add_dependency "relaton-nist", "~> 1.19.0"
-  spec.add_dependency "relaton-oasis", "~> 1.19.0"
-  spec.add_dependency "relaton-ogc", "~> 1.19.0"
-  spec.add_dependency "relaton-omg", "~> 1.19.0"
-  spec.add_dependency "relaton-plateau", "~> 1.19.0"
-  spec.add_dependency "relaton-un", "~> 1.19.0"
-  spec.add_dependency "relaton-w3c", "~> 1.19.0"
-  spec.add_dependency "relaton-xsf", "~> 1.19.0"
+  spec.add_dependency "relaton-3gpp", "~> 1.20.0"
+  spec.add_dependency "relaton-bipm", "~> 1.20.0"
+  spec.add_dependency "relaton-bsi", "~> 1.20.0"
+  spec.add_dependency "relaton-calconnect", "~> 1.20.0"
+  spec.add_dependency "relaton-ccsds", "~> 1.20.2"
+  spec.add_dependency "relaton-cen", "~> 1.20.0"
+  spec.add_dependency "relaton-cie", "~> 1.20.0"
+  spec.add_dependency "relaton-doi", "~> 1.20.0"
+  spec.add_dependency "relaton-ecma", "~> 1.20.0"
+  spec.add_dependency "relaton-etsi", "~> 1.20.0"
+  spec.add_dependency "relaton-gb", "~> 1.20.0"
+  spec.add_dependency "relaton-iana", "~> 1.20.0"
+  spec.add_dependency "relaton-iec", "~> 1.20.0"
+  spec.add_dependency "relaton-ieee", "~> 1.20.0"
+  spec.add_dependency "relaton-ietf", "~> 1.20.0"
+  spec.add_dependency "relaton-iho", "~> 1.20.0"
+  spec.add_dependency "relaton-isbn", "~> 1.20.0"
+  spec.add_dependency "relaton-iso", "~> 1.20.0"
+  spec.add_dependency "relaton-itu", "~> 1.20.0"
+  spec.add_dependency "relaton-jis", "~> 1.20.0"
+  spec.add_dependency "relaton-nist", "~> 1.20.0"
+  spec.add_dependency "relaton-oasis", "~> 1.20.0"
+  spec.add_dependency "relaton-ogc", "~> 1.20.0"
+  spec.add_dependency "relaton-omg", "~> 1.20.0"
+  spec.add_dependency "relaton-plateau", "~> 1.20.0"
+  spec.add_dependency "relaton-un", "~> 1.20.0"
+  spec.add_dependency "relaton-w3c", "~> 1.20.0"
+  spec.add_dependency "relaton-xsf", "~> 1.20.0"
 end

data/spec/relaton/processor_spec.rb

@@ -17,7 +17,7 @@ RSpec.describe Relaton::Processor do
     end
 
     it "fetch_data method should be implemented" do
-      expect { subject.fetch_data "cource", {} }.to raise_error StandardError
+      expect { subject.fetch_data "source", {} }.to raise_error StandardError
     end
 
     it "from_xml method should be implemented" do
@@ -43,7 +43,7 @@ RSpec.describe Relaton::Processor do
 
       it "get method should call get method of #{flavor}" do
         expect(bibliography).to receive(:get).with("code", nil, {}).and_return :item
-        expect(processor.get "code", nil, {}).to eq :item
+        expect(processor.get("code", nil, {})).to eq :item
       end
 
       it "grammar_hash method should call grammar_hash method of #{flavor}" do
@@ -58,7 +58,7 @@ RSpec.describe Relaton::Processor do
 
       it "fetch_data method should call fetch_data method of #{flavor}" do
         expect(fetcher_class).to receive(:fetch).with(output: "dir", format: "bibxml").and_return :item
-        expect(processor.fetch_data source, output: "dir", format: "bibxml").to eq :item
+        expect(processor.fetch_data(source, output: "dir", format: "bibxml")).to eq :item
       end
     end
 
@@ -68,7 +68,7 @@ RSpec.describe Relaton::Processor do
 
       it "from_xml method should call from_xml method of #{flavor}" do
         expect(parser_class).to receive(:from_xml).with("xml").and_return :item
-        expect(processor.from_xml "xml").to eq :item
+        expect(processor.from_xml("xml")).to eq :item
       end
     end
 

data/spec/relaton_spec.rb

@@ -490,7 +490,7 @@ RSpec.describe Relaton::Db do
     it "should clear cache if version is changed" do
       expect(File.read("testcache/iso/version", encoding: "UTF-8")).not_to eq "new_version"
       expect(File.read("testcache2/iso/version", encoding: "UTF-8")).not_to eq "new_version"
-      processor = double
+      processor = double "processor", short: :relaton_iso
       expect(processor).to receive(:grammar_hash).and_return("new_version").exactly(2).times
       expect(Relaton::Registry.instance).to receive(:by_type).and_return(processor).exactly(2).times
       Relaton::Db.new "testcache", "testcache2"