relaton 0.5.3 → 0.5.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8fe6f718dd250f8381790668f4df6ea64980dedb
-  data.tar.gz: bab1d04ee219e74fcd5b8df856196bd83bb14104
+  metadata.gz: aa7b97836f446229ce44afbf7a16e269627124e9
+  data.tar.gz: dcd68311f5e954a083a5aa62f5a65cbcf30164cb
 SHA512:
-  metadata.gz: c675d46a4ac6b10b424637d402811dae9acbb757275dcf67bf1b72666b8cb3b7a2d7703adbd7f8e9d058bbeec78f3abf1a016755e00250d5f58fb7e3bfe87a93
-  data.tar.gz: b9b051b9dcffc16f1580b76041c0f87e91d44ba662113b8639c13b74879e7908d5aa38fc9a773c931ffdc243ba9d2a702fec5121e68367a1bbf5a4c6c8409ac8
+  metadata.gz: e67ff8a550e90d17cbc9c8eff20c03158f3d1499b877910c4b690cba55efbd8c51fb0b149c54216764babb8532f38b0090d040326d528b3715fb9a9bea927ec4
+  data.tar.gz: 07cd319987710471a43ee309ca0843880c832f11ad011fe995e91e5d43b98cf4c0d0650c650f295487f84a4a797cf61e432711ed2cdad4ddcbf448c111716f0c

data/Gemfile.lock

@@ -1,23 +1,20 @@
 PATH
   remote: .
   specs:
-    relaton (0.5.3)
-      algoliasearch
+    relaton (0.5.4)
       relaton-gb (~> 0.6.0)
       relaton-iec (~> 0.4.0)
       relaton-ietf (~> 0.6.0)
       relaton-iso (~> 0.6.0)
       relaton-itu (~> 0.3.0)
       relaton-nist (~> 0.3.0)
+      relaton-ogc (~> 0.1.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    addressable (2.6.0)
-      public_suffix (>= 2.0.2, < 4.0)
-    algoliasearch (1.26.1)
-      httpclient (~> 2.8, >= 2.8.3)
-      json (>= 1.5.1)
+    addressable (2.7.0)
+      public_suffix (>= 2.0.2, < 5.0)
     ast (2.4.0)
     byebug (10.0.2)
     cnccs (0.1.3)
@@ -31,6 +28,8 @@ GEM
     docile (1.3.2)
     equivalent-xml (0.6.0)
       nokogiri (>= 1.4.3)
+    faraday (0.15.4)
+      multipart-post (>= 1.2, < 3)
     ffi (1.11.1)
     formatador (0.2.5)
     gb-agencies (0.0.5)
@@ -49,7 +48,6 @@ GEM
       guard-compat (~> 1.1)
       rspec (>= 2.99.0, < 4.0)
     hashdiff (0.4.0)
-    httpclient (2.8.3)
     isoics (0.1.7)
     json (2.2.0)
     listen (3.1.5)
@@ -59,6 +57,7 @@ GEM
     lumberjack (1.0.13)
     method_source (0.9.2)
     mini_portile2 (2.4.0)
+    multipart-post (2.1.1)
     nenv (0.3.0)
     nokogiri (1.10.4)
       mini_portile2 (~> 2.4.0)
@@ -75,36 +74,39 @@ GEM
     pry-byebug (3.6.0)
       byebug (~> 10.0)
       pry (~> 0.10)
-    public_suffix (3.1.1)
+    public_suffix (4.0.1)
     rainbow (3.0.0)
     rake (12.3.2)
     rb-fsevent (0.10.3)
     rb-inotify (0.10.0)
       ffi (~> 1.0)
-    relaton-bib (0.3.5)
+    relaton-bib (0.3.6)
       addressable
-      nokogiri (~> 1.10)
-    relaton-gb (0.6.1)
+      nokogiri
+    relaton-gb (0.6.3)
       cnccs (~> 0.1.1)
       gb-agencies (~> 0.0.1)
       relaton-iso-bib (~> 0.3.0)
-    relaton-iec (0.4.2)
+    relaton-iec (0.4.4)
       addressable
       relaton-iso-bib (~> 0.3.0)
-    relaton-ietf (0.6.2)
+    relaton-ietf (0.6.4)
       relaton-bib (~> 0.3.0)
-    relaton-iso (0.6.3)
+    relaton-iso (0.6.5)
       relaton-iec (~> 0.4.0)
       relaton-iso-bib (~> 0.3.0)
-    relaton-iso-bib (0.3.3)
+    relaton-iso-bib (0.3.5)
       isoics (~> 0.1.6)
       relaton-bib (~> 0.3.0)
       ruby_deep_clone (~> 0.8.0)
-    relaton-itu (0.3.1)
+    relaton-itu (0.3.3)
       relaton-iso-bib (~> 0.3.0)
-    relaton-nist (0.3.3)
+    relaton-nist (0.3.4)
       relaton-bib (~> 0.3.0)
       rubyzip
+    relaton-ogc (0.1.0)
+      faraday
+      relaton-iso-bib (~> 0.3.0)
     rspec (3.8.0)
       rspec-core (~> 3.8.0)
       rspec-expectations (~> 3.8.0)
@@ -130,7 +132,7 @@ GEM
     ruby-progressbar (1.10.1)
     ruby_deep_clone (0.8.0)
     ruby_dep (1.5.0)
-    rubyzip (1.2.3)
+    rubyzip (1.2.4)
     safe_yaml (1.0.5)
     shellany (0.0.1)
     simplecov (0.16.1)

data/docs/README.adoc

@@ -1,9 +1,9 @@
 = Relaton
 
 image:https://img.shields.io/gem/v/relaton.svg["Gem Version", link="https://rubygems.org/gems/relaton"]
-image:https://img.shields.io/travis/metanorma/relaton/master.svg["Build Status", link="https://travis-ci.org/metanorma/relaton"]
+image:https://img.shields.io/travis/relaton/relaton/master.svg["Build Status", link="https://travis-ci.org/relaton/relaton"]
 image:https://ci.appveyor.com/api/projects/status/rm8mundlocspsue0?svg=true["Appveyor Build Status", link="https://ci.appveyor.com/project/ribose/relaton"]
-image:https://codeclimate.com/github/metanorma/relaton/badges/gpa.svg["Code Climate", link="https://codeclimate.com/github/metanorma/relaton"]
+image:https://codeclimate.com/github/relaton/relaton/badges/gpa.svg["Code Climate", link="https://codeclimate.com/github/relaton/relaton"]
 
 Gem for importing and caching bibliographic references to technical standards. 
 
@@ -13,17 +13,17 @@ The Relaton gem obtains authoritative bibliographic entries for technical standa
 
 The gem also caches entries it has retrieved, so that subsequent iterations do not need to go back online to retrieve the same entries. The gem uses two caches: a global cache (for all bibliographic entries retrieved by the user), and a local cache (intended to store references specific to the current document being processed.)
 
-Entries are retrieved and stored in the https://github.com/metanorma/relaton-models[Relaton bibliographic model], which is an expression of ISO 690. The subset of the model used and serialised for Relaton is defined in the https://github.com/metanorma/iso-bib-item[iso-bib-item] gem.
+Entries are retrieved and stored in the https://github.com/relaton/relaton-models[Relaton bibliographic model], which is an expression of ISO 690. The subset of the model used and serialised for Relaton is defined in the https://github.com/relaton/relaton-bib[relaton-bib] and https://github.com/relaton/relaton-iso-bib[relaton-iso-bib] gems.
 
-Entries are serialised to and from an internal data model, and multiple formats are intended to be supported. Currently only https://github.com/metanorma/relaton-models/blob/master/grammars/biblio.rnc[Relaton XML] is supported.
+Entries are serialised to and from an internal data model, and multiple formats are intended to be supported. Currently only https://github.com/relaton/relaton-models/blob/master/grammars/biblio.rnc[Relaton XML] is supported.
 
 Relaton imports bibliographic entries from:
 
-* ISO through the iso.org website, via the https://github.com/metanorma/relaton-iso[relaton-iso] gem
-* IEC through the iec.ch website, via the https://github.com/metanorma/relaton-iec[relaton-iec] gem
-* GB (Chinese national standards) through the GB websites, via the https://github.com/metanorma/relaton-gb[relaton-gb] gem 
-* IETF standards (Internet Drafts, RFC) through the http://xml2rfc.tools.ietf.org website, via the https://github.com/metanorma/relaton-ietf[relaton-ietf] gem 
-* NIST standards through the nist.gov website, via the https://github.com/metanorma/relaton-nist[relaotn-nist] gem
+* ISO through the iso.org website, via the https://github.com/relaton/relaton-iso[relaton-iso] gem
+* IEC through the iec.ch website, via the https://github.com/relaton/relaton-iec[relaton-iec] gem
+* GB (Chinese national standards) through the GB websites, via the https://github.com/relaton/relaton-gb[relaton-gb] gem 
+* IETF standards (Internet Drafts, RFC) through the http://xml2rfc.tools.ietf.org website, via the https://github.com/relaton/relaton-ietf[relaton-ietf] gem 
+* NIST standards through the nist.gov website, via the https://github.com/relaton/relaton-nist[relaotn-nist] gem
 
 The identifiers for which bibliographic entries are to be retrieved need to indicate which standards body they belong to. To do so, this gem adopts the convention of bracketing identifiers, and preceding them with a code that indicates the standards body:
 

data/lib/relaton/db.rb

@@ -6,44 +6,34 @@ module Relaton
   class RelatonError < StandardError; end
 
   class Db
-    SUPPORTED_GEMS = %w[
-      relaton_iso relaton_ietf relaton_gb relaton_iec relaton_nist relaton_itu
-    ].freeze
-
     # @param global_cache [String] directory of global DB
     # @param local_cache [String] directory of local DB
     def initialize(global_cache, local_cache)
-      register_gems
       @registry = Relaton::Registry.instance
+      # @registry.register_gems
       @db = open_cache_biblio(global_cache)
       @local_db = open_cache_biblio(local_cache, global: false)
       @db_name = global_cache
       @local_db_name = local_cache
     end
 
-    def register_gems
-      puts "[relaton] Info: detecting backends:"
-      SUPPORTED_GEMS.each do |b|
-        # puts b
-        begin
-          require b
-        rescue LoadError
-          puts "[relaton] Error: backend #{b} not present"
-        end
-      end
-    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,
     # @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; restricted to :all_parts if all-parts reference is required
-    # @return [String] Relaton XML serialisation of reference
+    # @return [NilClass, RelatonIsoBib::IsoBibliographicItem,
+    #   RelatonItu::ItuBibliographicItem, RelatonIetf::IetfBibliographicItem,
+    #   RelatonNist::NistBibliongraphicItem, RelatonGb::GbbibliographicItem]
     def fetch(code, year = nil, opts = {})
       stdclass = standard_class(code) or return nil
       check_bibliocache(code, year, opts, stdclass)
     end
 
+    # @param code [String]
+    # @param year [String, NilClass]
+    # @param stdclass [Symbol, NilClass]
+    # @param opts [Hash]
     def fetch_std(code, year = nil, stdclass = nil, opts = {})
       std = nil
       @registry.processors.each do |name, processor|
@@ -55,14 +45,9 @@ module Relaton
       check_bibliocache(code, year, opts, std)
     end
 
-    # def fetched(key)
-    #   return @local_db.fetched key if @local_db
-    #   return @db.fetched key if @db
-
-    #   ""
-    # end
-
     # The document identifier class corresponding to the given code
+    # @param code [String]
+    # @return [Array]
     def docid_type(code)
       stdclass = standard_class(code) or return [nil, code]
       _prefix, code = strip_id_wrapper(code, stdclass)
@@ -126,7 +111,7 @@ module Relaton
       ret = code
       ret += ":#{year}" if year
       ret += " (all parts)" if opts[:all_parts]
-      ["#{prefix}(#{ret})", code]
+      ["#{prefix}(#{ret.strip})", code]
     end
 
     # Find prefix and clean code
@@ -139,6 +124,11 @@ module Relaton
       [prefix, code]
     end
 
+    # @param entry [String] XML string
+    # @param stdclass [Symbol]
+    # @return [NilClass, RelatonIsoBib::IsoBibliographicItem,
+    #   RelatonItu::ItuBibliographicItem, RelatonIetf::IetfBibliographicItem,
+    #   RelatonNist::NistBibliongraphicItem, RelatonGb::GbbibliographicItem]
     def bib_retval(entry, stdclass)
       entry =~ /^not_found/ ? nil : @registry.processors[stdclass].from_xml(entry)
     end
@@ -147,6 +137,9 @@ module Relaton
     # @param year [String]
     # @param opts [Hash]
     # @param stdclass [Symbol]
+    # @return [NilClass, RelatonIsoBib::IsoBibliographicItem,
+    #   RelatonItu::ItuBibliographicItem, RelatonIetf::IetfBibliographicItem,
+    #   RelatonNist::NistBibliongraphicItem, RelatonGb::GbbibliographicItem]
     def check_bibliocache(code, year, opts, stdclass)
       id, searchcode = std_id(code, year, opts, stdclass)
       db = @local_db || @db
@@ -155,35 +148,40 @@ module Relaton
 
       db.delete(id) unless db.valid_entry?(id, year)
       if altdb
-        db[id] ||= altdb[id]
-        db[id] ||= new_bib_entry(searchcode, year, opts, stdclass)
-        altdb[id] = db[id] if !altdb.valid_entry?(id, year)
+        # db[id] ||= altdb[id]
+        db.clone_entry id, altdb
+        db[id] ||= new_bib_entry(searchcode, year, opts, stdclass, db, id)
+        altdb.clone_entry(id, db) if !altdb.valid_entry?(id, year)
       else
-        db[id] ||= new_bib_entry(searchcode, year, opts, stdclass)
+        db[id] ||= new_bib_entry(searchcode, year, opts, stdclass, db, id)
       end
       bib_retval(db[id], stdclass)
     end
 
-    # hash uses => , because the hash is imported from JSON
     # @param code [String]
     # @param year [String]
     # @param opts [Hash]
     # @param stdclass [Symbol]
-    # @return [Hash]
-    def new_bib_entry(code, year, opts, stdclass)
+    # @return [String]
+    def new_bib_entry(code, year, opts, stdclass, db = nil, id = nil)
       bib = @registry.processors[stdclass].get(code, year, opts)
-      bib = bib.to_xml(bibdata: true) if bib.respond_to? :to_xml
-      bib = "not_found #{Date.today}" if bib.nil? || bib.empty?
-      bib
+      bib_id = bib&.docidentifier&.first&.id&.sub(%r{(?<=\d)-(?=\d{4})}, ":")
+      if db && id && bib_id && id !~ %r{\(#{bib_id}\)}
+        bid = std_id(bib.docidentifier.first.id, nil, {}, stdclass).first
+        db[bid] ||= bib_entry bib
+        "redirection #{bid}"
+      else
+        bib_entry bib
+      end
     end
 
-    # if cached reference is undated, expire it after 60 days
-    # @param bib [Hash]
-    # @param year [String]
-    # def valid_bib_entry?(bib, year)
-    #   bib&.is_a?(Hash) && bib&.has_key?("bib") && bib&.has_key?("fetched") &&
-    #     (year || Date.today - bib["fetched"] < 60)
-    # end
+    def bib_entry(bib)
+      if bib.respond_to? :to_xml
+        bib.to_xml(bibdata: true)
+      else
+        "not_found #{Date.today}"
+      end
+    end
 
     # @param dir [String] DB directory
     # @param global [TrueClass, FalseClass]
@@ -204,39 +202,5 @@ module Relaton
         nil
       end
     end
-
-    # Check if version of the DB match to the gem version.
-    # @param cache_db [String] DB directory
-    # @return [TrueClass, FalseClass]
-    # def check_cache_version(cache_db)
-    #   cache_db.transaction { cache_db[:version] == VERSION }
-    # end
-
-    # Set version of the DB to the gem version.
-    # @param cache_db [String] DB directory
-    # @return [Pstore]
-    # def set_cache_version(cache_db)
-    #   unless File.exist? cache_db.path
-    #     cache_db.transaction { cache_db[:version] = VERSION }
-    #   end
-    #   cache_db
-    # end
-
-    # @param enstry [String] entry in XML format
-    # @return [IsoBibItem::IsoBibliographicItem]
-    # def from_xml(entry)
-    #   IsoBibItem.from_xml entry # will be unmarshaller
-    # end
-
-    # @param [Hash{String=>Hash{String=>String}}] biblio
-    # def save_cache_biblio(biblio, filename)
-    #   return if biblio.nil? || filename.nil?
-    #   File.open(filename, "w") do |b|
-    #     b << biblio.reduce({}) do |s, (k, v)|
-    #       bib = v["bib"].respond_to?(:to_xml) ? v["bib"].to_xml : v["bib"]
-    #       s.merge(k => { "fetched" => v["fetched"], "bib" => bib })
-    #     end.to_json
-    #   end
-    # end
   end
 end

data/lib/relaton/db_cache.rb

@@ -31,10 +31,19 @@ module Relaton
     # @param key [String]
     # @return [String]
     def [](key)
-      file = filename key
-      return unless File.exist? file
+      value = get(key)
+      if (code = redirect? value)
+        self[code]
+      else
+        value
+      end
+    end
 
-      File.read(file, encoding: "utf-8")
+    def clone_entry(key, db)
+      self[key] ||= db.get(key)
+      if (code = redirect? get(key))
+        clone_entry code, db
+      end
     end
 
     # Return fetched date
@@ -92,8 +101,30 @@ module Relaton
       year || Date.today - date < 60
     end
 
+    protected
+
+    # Reads file by a key
+    #
+    # @param key [String]
+    # @return [String, NilClass]
+    def get(key)
+      file = filename key
+      return unless File.exist? file
+
+      File.read(file, encoding: "utf-8")
+    end
+
     private
 
+    # Check if a file content is redirection
+    #
+    # @prarm value [String] file content
+    # @return [String, NilClass] redirection code or nil
+    def redirect?(value)
+      %r{redirection\s(?<code>.*)} =~ value
+      code
+    end
+
     # Return item's file name
     # @param key [String]
     # @return [String]

data/lib/relaton/processor.rb

@@ -1,6 +1,5 @@
 module Relaton
   class Processor
-
     attr_reader :short
     attr_reader :prefix
     attr_reader :defaultprefix
@@ -10,13 +9,16 @@ module Relaton
       raise "This is an abstract class!"
     end
 
-    def get(code, date, opts)
+    def get(_code, _date, _opts)
       raise "This is an abstract class!"
     end
 
-    def from_xml(xml)
+    def from_xml(_xml)
+      raise "This is an abstract class!"
+    end
+
+    def hash_to_bib(_hash)
       raise "This is an abstract class!"
     end
   end
 end
-

data/lib/relaton/registry.rb

@@ -5,27 +5,65 @@ end
 
 module Relaton
   class Registry
+    SUPPORTED_GEMS = %w[
+      relaton_gb relaton_iec relaton_ietf relaton_iso relaton_itu relaton_nist
+      relaton_ogc
+    ].freeze
+
     include Singleton
 
     attr_reader :processors
 
     def initialize
       @processors = {}
+      register_gems
+    end
+
+    def register_gems
+      puts "[relaton] Info: detecting backends:"
+      SUPPORTED_GEMS.each do |b|
+        begin
+          require b
+          require "#{b}/processor"
+          register Kernel.const_get "#{camel_case(b)}::Processor"
+        rescue LoadError
+          puts "[relaton] Error: backend #{b} not present"
+        end
+      end
     end
 
     def register(processor)
-      raise Error unless processor < :: Relaton::Processor
+      raise Error unless processor < ::Relaton::Processor
+
       p = processor.new
+      return if processors[p.short]
+
       puts "[relaton] processor \"#{p.short}\" registered"
-      @processors[p.short] = p
+      processors[p.short] = p
     end
 
     def find_processor(short)
-      @processors[short.to_sym]
+      processors[short.to_sym]
     end
 
+    # @return [Array]
     def supported_processors
-      @processors.keys
+      processors.keys
+    end
+
+    #
+    # Find processor by type
+    #
+    # @param type [String]
+    # @return [Relaton::RelatonIso::Processor]
+    def by_type(type)
+      processors.values.detect { |v| v.idtype == type }
+    end
+
+    private
+
+    def camel_case(gem_name)
+      gem_name.split("_").map(&:capitalize).join
     end
   end
 end