relaton 1.20.2 → 2.0.0.pre.alpha.1

data/lib/relaton/db.rb

@@ -28,13 +28,13 @@ 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
 
     ##
-    # The class of reference requested is determined by the prefix of the reference:
+    # The class of reference requested is determined by the prefix
+    # of the reference:
     # GB Standard for gbbib, IETF for ietfbib, ISO for isobib, IEC or IEV for
     #   iecbib,
     #
@@ -104,8 +104,10 @@ module Relaton
     # @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
+    # @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
@@ -115,13 +117,14 @@ module Relaton
           threads = ENV["RELATON_FETCH_PARALLEL"]&.to_i || processor.threads
           wp = WorkersPool.new(threads) do |args|
             args[3].call fetch(*args[0..2])
-          rescue RelatonBib::RequestError => e
+          rescue Relaton::RequestError => e
             args[3].call e
           rescue StandardError => e
             Util.error "`#{args[0]}` -- #{e.message}"
             args[3].call nil
           end
-          @queues[stdclass] = { queue: SizedQueue.new(threads * 2), workers_pool: wp }
+          @queues[stdclass] =
+            { queue: SizedQueue.new(threads * 2), workers_pool: wp }
           Thread.new { process_queue @queues[stdclass] }
         end
         @queues[stdclass][:queue] << [ref, year, opts, block]
@@ -194,7 +197,8 @@ module Relaton
     # @param (see #fetch_api)
     # @return (see #fetch_api)
     def fetch_doc(code, year, opts, processor)
-      if Relaton.configuration.use_api then fetch_api(code, year, opts, processor)
+      if Relaton.configuration.use_api then fetch_api(code, year, opts,
+                                                      processor)
       else processor.get(code, year, opts)
       end
     end
@@ -211,7 +215,8 @@ module Relaton
     # @param processor [Relaton::Processor]
     # @return [RelatonBib::BibliographicItem, nil]
     def fetch_api(code, year, opts, processor)
-      url = "#{Relaton.configuration.api_host}/api/v1/document?#{params(code, year, opts)}"
+      url = "#{Relaton.configuration.api_host}" \
+            "/api/v1/document?#{params(code, year, opts)}"
       rsp = Net::HTTP.get_response URI(url)
       processor.from_xml rsp.body if rsp.code == "200"
     rescue Errno::ECONNREFUSED
@@ -238,7 +243,7 @@ module Relaton
     # @param year [Integer, nil] year to filter
     # @return [BibliographicItem, nil]
     def search_xml(file, xml, text, edition, year)
-      return unless text.nil? || match_xml_text(xml, text)
+      return unless text.nil? || match_xml_text?(xml, text)
 
       search_edition_year(file, xml, edition, year)
     end
@@ -251,10 +256,12 @@ module Relaton
     def search_edition_year(file, content, edition, year) # rubocop:disable Metrics/AbcSize,Metrics/CyclomaticComplexity,Metrics/PerceivedComplexity
       processor = @registry.processor_by_ref(file.split("/")[-2])
       item = if file.match?(/xml$/) then processor.from_xml(content)
-             else processor.hash_to_bib(YAML.safe_load(content))
+             else processor.from_yaml(content)
              end
       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 })
+        item.date.detect do |d|
+          d.type == "published" && d.at.to_date.year.to_s == year.to_s
+        end)
     end
 
     #
@@ -265,8 +272,13 @@ module Relaton
     #
     # @return [Boolean]
     #
-    def match_xml_text(xml, text)
-      %r{((?<attr>=((?<apstr>')|"))|>).*?#{text}.*?(?(<attr>)(?(<apstr>)'|")|<)}mi.match?(xml)
+    def match_xml_text?(xml, text)
+      esc = Regexp.escape(text)
+      pat = "((?<attr>=((?<apstr>')|\"" \
+            "))|>).*?#{esc}" \
+            ".*?(?(<attr>)(?(<apstr>)'|\")|<)"
+      Regexp.new(pat, Regexp::MULTILINE | Regexp::IGNORECASE)
+        .match?(xml)
     end
 
     # @param code [String]
@@ -279,14 +291,8 @@ module Relaton
     #   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, RelatinUn::UnBibliographicItem,
-    #   RelatonBipm::BipmBibliographicItem, RelatonIho::IhoBibliographicItem,
-    #   RelatonOmg::OmgBibliographicItem, RelatonW3c::W3cBibliographicItem]
+    # @return [nil, Relaton::Bib::ItemData
+    #
     def combine_doc(code, year, opts, stdclass) # rubocop:disable Metrics/AbcSize,Metrics/MethodLength,Metrics/CyclomaticComplexity,Metrics/PerceivedComplexity
       return if stdclass == :relaton_bipm
 
@@ -295,21 +301,22 @@ module Relaton
         reldesc = nil
       elsif (refs = code.split ", ").size > 1
         reltype = "complements"
-        reldesc = RelatonBib::FormattedString.new content: "amendment"
+        reldesc = Bib::LocalizedMarkedUpString.new content: "amendment"
       else return
       end
 
-      doc = @registry[stdclass].hash_to_bib docid: { id: code }
+      yaml = { docidentifier: [{ content: code }] }.to_yaml
+      doc = @registry[stdclass].from_yaml(yaml)
       ref = refs[0]
       updates = check_bibliocache(refs[0], year, opts, stdclass)
       if updates
-        doc.relation << RelatonBib::DocumentRelation.new(bibitem: updates, type: "updates")
+        doc.relation << Bib::Relation.new(bibitem: updates, type: "updates")
       end
       divider = stdclass == :relaton_itu ? " " : "/"
       refs[1..].each_with_object(doc) do |c, d|
         bib = check_bibliocache(ref + divider + c, year, opts, stdclass)
         if bib
-          d.relation << RelatonBib::DocumentRelation.new(
+          d.relation << Bib::Relation.new(
             type: reltype, description: reldesc, bibitem: bib,
           )
         end
@@ -334,12 +341,10 @@ module Relaton
       ret = code
       ret += (stdclass == :relaton_gb ? "-" : ":") + year if year
       ret += " (all parts)" if opts[:all_parts]
-      if opts[:publication_date_after]
-        ret += " after-#{opts[:publication_date_after]}"
-      end
-      if opts[:publication_date_before]
-        ret += " before-#{opts[:publication_date_before]}"
-      end
+      after = opts[:publication_date_after]
+      ret += " after-#{after}" if after
+      before = opts[:publication_date_before]
+      ret += " before-#{before}" if before
       ["#{prefix}(#{ret.strip})", code]
     end
 
@@ -349,7 +354,11 @@ module Relaton
     # @return [Array]
     def strip_id_wrapper(code, stdclass)
       prefix = @registry[stdclass].prefix
-      code = code.sub(/\u2013/, "-").sub(/^#{prefix}\((.+)\)$/, "\\1")
+      code =
+        if code.is_a?(String)
+          code.sub("\u2013", "-").sub(/^#{prefix}\((.+)\)$/, "\\1")
+        else code.to_s
+        end
       [prefix, code]
     end
 
@@ -461,7 +470,9 @@ module Relaton
     #
     def new_bib_entry(code, year, opts, stdclass, **args)
       entry = @semaphore.synchronize { args[:db] && args[:db][args[:id]] }
-      return fetch_entry(code, year, opts, stdclass, **args) if !entry || opts[:no_cache]
+      if !entry || opts[:no_cache]
+        return fetch_entry(code, year, opts, stdclass, **args)
+      end
 
       if entry&.match?(/^not_found/)
         Util.info "not found in cache, if you wish to " \
@@ -484,7 +495,8 @@ module Relaton
 
     #
     # If the reference isn't equal to the document identifier
-    # then store the document in the cache and create for the reference a redirection to the document
+    # then store the document in the cache and create
+    # for the reference a redirection to the document
     #
     # @param [<Type>] bib <description>
     # @param [<Type>] stdclass <description>
@@ -493,11 +505,13 @@ module Relaton
     # @return [<Type>] <description>
     #
     def check_entry(bib, stdclass, **args) # rubocop:disable Metrics/AbcSize,Metrics/CyclomaticComplexity,Metrics/PerceivedComplexity
-      bib_id = bib&.docidentifier&.first&.id
+      bib_id = bib && bib.docidentifier.first&.content
 
       # when ref isn't equal to bib's id then return a redirection 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
+      quoted = Regexp.quote("(#{bib_id})")
+      if args[:db] && args[:id] && bib_id &&
+          args[:id] !~ /#{quoted}/
+        bid = std_id(bib.docidentifier.first.content, nil, {}, stdclass).first
         @semaphore.synchronize { args[:db][bid] ||= bib_entry bib }
         "redirection #{bid}"
       else bib_entry bib
@@ -521,7 +535,7 @@ module Relaton
     #
     def net_retry(code, year, opts, processor, retries)
       fetch_doc code, year, opts, processor
-    rescue RelatonBib::RequestError => e
+    rescue Relaton::RequestError => e
       raise e unless retries > 1
 
       net_retry(code, year, opts, processor, retries - 1)
@@ -537,7 +551,11 @@ module Relaton
     #   RelatonOmg::OmgBibliographicItem, RelatonW3c::W3cBibliographicItem]
     # @return [String] XML or "not_found mm-dd-yyyy"
     def bib_entry(bib)
-      bib.respond_to?(:to_xml) ? bib.to_xml(bibdata: true) : "not_found #{Date.today}"
+      if bib.respond_to?(:to_xml)
+        bib.to_xml(bibdata: true)
+      else
+        "not_found #{Date.today}"
+      end
     end
 
     # Check if an XML entry's published date falls within the requested range.

data/lib/relaton/db_cache.rb

@@ -101,7 +101,7 @@ module Relaton
     # Returns all items
     # @return [Array<String>]
     def all(&block)
-      Dir.glob("#{@dir}/**/*.{xml,yml,yaml}").sort.map do |f|
+      Dir.glob("#{@dir}/**/*.{xml,yml,yaml}").map do |f|
         content = File.read(f, encoding: "utf-8")
         block ? yield(f, content) : content
       end
@@ -168,7 +168,8 @@ module Relaton
     def filename(key)
       prefcode = key.downcase.match(/^(?<prefix>[^(]+)\((?<code>[^)]+)/)
       fn = if prefcode
-             "#{prefcode[:prefix]}/#{prefcode[:code].gsub(/[:\s\/()]/, '_').squeeze('_')}"
+             "#{prefcode[:prefix]}/#{prefcode[:code].gsub(/[:\s\/()]/,
+                                                          '_').squeeze('_')}"
            else
              key.gsub(/[-:\s]/, "_")
            end

data/lib/relaton/registry.rb

@@ -1,16 +1,18 @@
 require "singleton"
 
-class Error < StandardError
-end
+# class Error < StandardError
+# end
 
 module Relaton
   class Registry
     SUPPORTED_GEMS = %w[
-      relaton_gb relaton_iec relaton_ietf relaton_iso relaton_itu relaton_nist
-      relaton_ogc relaton_calconnect relaton_omg relaton_un relaton_w3c
-      relaton_ieee relaton_iho relaton_bipm relaton_ecma relaton_cie relaton_bsi
-      relaton_cen relaton_iana relaton_3gpp relaton_oasis relaton_doi relaton_jis
-      relaton_xsf relaton_ccsds relaton_etsi relaton_isbn relaton/plateau
+      relaton/gb relaton/iec relaton/ietf relaton/iso
+      relaton/itu relaton/nist relaton/ogc relaton/calconnect
+      relaton/omg relaton/un relaton/w3c relaton/ieee
+      relaton/iho relaton/bipm relaton/ecma relaton/cie
+      relaton/bsi relaton/cen relaton/iana relaton/3gpp
+      relaton/oasis relaton/doi relaton/jis relaton/xsf
+      relaton/ccsds relaton/etsi relaton/isbn relaton/plateau
     ].freeze
 
     include Singleton
@@ -27,14 +29,15 @@ module Relaton
 
       SUPPORTED_GEMS.each do |b|
         require "#{b}/processor"
-        register Kernel.const_get "#{camel_case(b)}::Processor"
+        register Kernel.const_get "#{gem_to_module_path(b)}::Processor"
       rescue LoadError => e
-        Util.error "backend #{b} not present\n#{e.message}\n#{e.backtrace.join "\n"}"
+        Util.error "backend #{b} not present\n" \
+                   "#{e.message}\n#{e.backtrace.join "\n"}"
       end
     end
 
     def register(processor)
-      raise Error unless processor < ::Relaton::Processor
+      raise Error unless processor < Core::Processor
 
       p = processor.new
       return if processors[p.short]
@@ -57,33 +60,23 @@ module Relaton
     #
     # @param [String] dataset
     #
-    # @return [Relaton::Processor, nil]
+    # @return [Relaton::Core::Processor, nil]
     #
     def find_processor_by_dataset(dataset)
-      require_gem(processors.values.detect { |p| p.datasets&.include? dataset })
+      processors.values.detect { |p| p.datasets&.include? dataset }
     end
 
     #
     # Find processor by type
     #
     # @param type [String]
-    # @return [RelatonIso::Processor, RelatonIec::Processor,
-    #   RelatonNist::Processor, RelatonIetf::Processot, RelatonItu::Processor,
-    #   RelatonGb::Processor, RelatonOgc::Processor,
-    #   RelatonCalconnect::Processor]
+    # @return [Relaton::Core::Processor]
     def by_type(type)
-      require_gem(processors.values.detect { |v| v.prefix == type&.upcase })
+      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
+      processors[stdclass]
     end
 
     #
@@ -91,10 +84,10 @@ module Relaton
     #
     # @param [String] ref reference or prefix
     #
-    # @return [Relaton::Processor] processor
+    # @return [Relaton::Core::Processor] processor
     #
     def processor_by_ref(ref)
-      require_gem processors[class_by_ref(ref)]
+      processors[class_by_ref(ref)]
     end
 
     #
@@ -105,7 +98,7 @@ module Relaton
     # @return [Symbol, nil] standard class name
     #
     def class_by_ref(ref)
-      ref = ref =~ /^\w+\((.*)\)$/ ? Regexp.last_match(1) : ref
+      ref = Regexp.last_match(1) if ref =~ /^\w+\((.*)\)$/
       @processors.each do |class_name, processor|
         return class_name if /^(urn:)?#{processor.prefix}\b/i.match?(ref) ||
           processor.defaultprefix.match(ref)
@@ -116,9 +109,9 @@ module Relaton
 
     private
 
-    def camel_case(gem_name)
+    def gem_to_module_path(gem_name)
       gem_name.split("/").map do |part|
-        part.split("_").map(&:capitalize).join
+        part.capitalize.sub("3gpp", "ThreeGpp")
       end.join("::")
     end
   end

data/lib/relaton/util.rb

@@ -1,6 +1,7 @@
 module Relaton
   module Util
-    extend RelatonBib::Util
+    extend Relaton::Bib::Util
+
     PROGNAME = "relaton".freeze
   end
 end

data/lib/relaton/version.rb

@@ -1,3 +1,3 @@
 module Relaton
-  VERSION = "1.20.2".freeze
+  VERSION = "2.0.0-alpha.1".freeze
 end

data/lib/relaton/workers_pool.rb

@@ -3,7 +3,7 @@
 module Relaton
   # Workers poll.
   class WorkersPool
-    def initialize(workers = 2, &_block)
+    def initialize(workers = 2, &)
       # num_workers = workers < 2 ? 2 : workers
       @queue = SizedQueue.new(workers * 2)
       @threads = Array.new workers do

data/lib/relaton.rb

@@ -1,11 +1,10 @@
-require "relaton_bib"
+require "relaton/bib"
 require "relaton/util"
 require "relaton/config"
 require "yaml"
 
-require "relaton/workers_pool"
-require "relaton/db"
-require "relaton/db_cache"
-require "relaton/version"
-require "relaton/registry"
-require "relaton/processor"
+require_relative "relaton/workers_pool"
+require_relative "relaton/db"
+require_relative "relaton/db_cache"
+require_relative "relaton/version"
+require_relative "relaton/registry"

data/relaton.gemspec

@@ -10,7 +10,7 @@ Gem::Specification.new do |spec|
   spec.authors       = ["Ribose Inc."]
   spec.email         = ["open.source@ribose.com"]
 
-  spec.summary       = "The Relaton core for importing, managing and caching "\
+  spec.summary       = "The Relaton core for importing, managing and caching " \
                        "bibliographic references to technical standards."
   spec.description   = <<~DESCRIPTION
       The Relaton core for importing, managing and caching bibliographic
@@ -27,35 +27,35 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
   spec.files         = `git ls-files`.split("\n")
   # spec.test_files    = `git ls-files -- {spec}/*`.split("\n")
-  spec.required_ruby_version = Gem::Requirement.new(">= 3.1.0")
+  spec.required_ruby_version = Gem::Requirement.new(">= 3.2.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.3"
-  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"
-  spec.add_development_dependency "rubocop-rails"
+  spec.add_dependency "relaton-3gpp", "~> 2.0.0-alpha.3"
+  spec.add_dependency "relaton-bipm", "~> 2.0.0-alpha.2"
+  spec.add_dependency "relaton-bsi", "~> 2.0.0-alpha.1"
+  spec.add_dependency "relaton-calconnect", "~> 2.0.0-alpha.2"
+  spec.add_dependency "relaton-ccsds", "~> 2.0.0-alpha.2"
+  spec.add_dependency "relaton-cen", "~> 2.0.0-alpha.1"
+  spec.add_dependency "relaton-cie", "~> 2.0.0-alpha.2"
+  spec.add_dependency "relaton-doi", "~> 2.0.0-alpha.1"
+  spec.add_dependency "relaton-ecma", "~> 2.0.0-alpha.2"
+  spec.add_dependency "relaton-etsi", "~> 2.0.0-alpha.2"
+  spec.add_dependency "relaton-gb", "~> 2.0.0-alpha.1"
+  spec.add_dependency "relaton-iana", "~> 2.0.0-alpha.2"
+  spec.add_dependency "relaton-iec", "~> 2.0.0-alpha.2"
+  spec.add_dependency "relaton-ieee", "~> 2.0.0-alpha.1"
+  spec.add_dependency "relaton-ietf", "~> 2.0.0-alpha.2"
+  spec.add_dependency "relaton-iho", "~> 2.0.0-alpha.2"
+  spec.add_dependency "relaton-isbn", "~> 2.0.0-alpha.1"
+  spec.add_dependency "relaton-iso", "~> 2.0.0-alpha.2"
+  spec.add_dependency "relaton-itu", "~> 2.0.0-alpha.2"
+  spec.add_dependency "relaton-jis", "~> 2.0.0-alpha.1"
+  spec.add_dependency "relaton-nist", "~> 2.0.0-alpha.2"
+  spec.add_dependency "relaton-oasis", "~> 2.0.0-alpha.2"
+  spec.add_dependency "relaton-ogc", "~> 2.0.0-alpha.2"
+  spec.add_dependency "relaton-omg", "~> 2.0.0-alpha.1"
+  spec.add_dependency "relaton-plateau", "~> 2.0.0-alpha.1"
+  spec.add_dependency "relaton-un", "~> 2.0.0-alpha.1"
+  spec.add_dependency "relaton-w3c", "~> 2.0.0-alpha.2"
+  spec.add_dependency "relaton-xsf", "~> 2.0.0-alpha.1"
+  spec.metadata["rubygems_mfa_required"] = "true"
 end

data/spec/relaton/db_cache_spec.rb

@@ -18,7 +18,7 @@ RSpec.describe Relaton::DbCache do
     dir = "testcache/iso"
     FileUtils.mkdir_p dir
     file_name = File.join dir, "iso_123.xml"
-    file = File.open file_name, File::RDWR | File::CREAT, encoding: "UTF-8"
+    file = File.open(file_name, File::RDWR | File::CREAT, encoding: "UTF-8") # rubocop:disable Style/FileOpen
     file.flock File::LOCK_EX
     command = <<~RBY
       require "relaton"