relaton 0.2.5 → 0.2.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0c1beef6d057ce75ecd9f18f02d3ce887bf9c8d259c0ac7d159f24d8584134c3
-  data.tar.gz: 62db2b47dae11069a14dc8eb83dcc62090aec6a4d586508d00cf81736d9492a1
+  metadata.gz: 0b1872ecb2665f86758a05dd822d450d6daf37cf7865f0faf17878a494e1e17c
+  data.tar.gz: 464054cbb8b6d3475ff016ce8748bc88105cced709187751421cba7124943d0e
 SHA512:
-  metadata.gz: 83a73440d1eb4f63c12e33d296075a7e46759db37bafe40bda57369d6786202e57eb17426f4975d1c1b005fa7dab76fa06996ecc538f608060f269625605a3b0
-  data.tar.gz: e1e8ab5afcb76904239547bbbdc4dca80a3e8dd0b2ca7040f721487970224c010b5e50b2357b9a8121a6147c05091d2babed9745c8b626cd282199b6849f21b0
+  metadata.gz: 62ed5b9d6a9002d748e9069651b7dda734d8e61b7f09aff340fabf563f4daef4c60b61131634dcad8f3d4faa174b64b873e3cb3e074279013807e8c89168eede
+  data.tar.gz: a389d31e90fd4a6b238a554998f9936e34324abfa41c21669212d3a20800cb538e37116a7b6d731a14a1920c46fdd366579aa2df736fbb65a52da30c0a644e56

data/Gemfile.lock

@@ -1,13 +1,13 @@
 PATH
   remote: .
   specs:
-    relaton (0.2.5)
+    relaton (0.2.6)
       algoliasearch
-      gbbib (~> 0.3.1)
-      iecbib (~> 0.1.1)
-      ietfbib (~> 0.4.1)
-      iso-bib-item (~> 0.3.0)
-      isobib (~> 0.3.1)
+      gbbib (~> 0.4.0)
+      iecbib (~> 0.2.0)
+      ietfbib (~> 0.4.2)
+      iso-bib-item (~> 0.4.1)
+      isobib (~> 0.4.0)
 
 GEM
   remote: https://rubygems.org/
@@ -28,10 +28,10 @@ GEM
     ffi (1.9.25)
     formatador (0.2.5)
     gb-agencies (0.0.3)
-    gbbib (0.3.1)
+    gbbib (0.4.0)
       cnccs (~> 0.1.1)
       gb-agencies (~> 0.0.1)
-      iso-bib-item (~> 0.3.0)
+      iso-bib-item (~> 0.4.1)
     guard (2.14.2)
       formatador (>= 0.2.4)
       listen (>= 2.7, < 4.0)
@@ -47,19 +47,19 @@ GEM
       guard-compat (~> 1.1)
       rspec (>= 2.99.0, < 4.0)
     httpclient (2.8.3)
-    iecbib (0.1.2)
+    iecbib (0.2.0)
       addressable
-      iso-bib-item (~> 0.3.0)
-    ietfbib (0.4.1)
-      iso-bib-item (~> 0.3.0)
-    iso-bib-item (0.3.1)
+      iso-bib-item (~> 0.4.0)
+    ietfbib (0.4.2)
+      iso-bib-item (~> 0.4.1)
+    iso-bib-item (0.4.1)
       isoics (~> 0.1.6)
       nokogiri (~> 1.8.4)
       ruby_deep_clone (~> 0.8.0)
-    isobib (0.3.1)
+    isobib (0.4.0)
       algoliasearch
-      iecbib (~> 0.1.1)
-      iso-bib-item (~> 0.3.0)
+      iecbib (~> 0.2.0)
+      iso-bib-item (~> 0.4.0)
     isoics (0.1.7)
     jaro_winkler (1.5.1)
     json (2.1.0)
@@ -71,7 +71,7 @@ GEM
     method_source (0.9.0)
     mini_portile2 (2.3.0)
     nenv (0.3.0)
-    nokogiri (1.8.4)
+    nokogiri (1.8.5)
       mini_portile2 (~> 2.3.0)
     notiffany (0.1.1)
       nenv (~> 0.1)
@@ -98,7 +98,7 @@ GEM
       rspec-mocks (~> 3.8.0)
     rspec-core (3.8.0)
       rspec-support (~> 3.8.0)
-    rspec-expectations (3.8.1)
+    rspec-expectations (3.8.2)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.8.0)
     rspec-mocks (3.8.0)
@@ -144,4 +144,4 @@ DEPENDENCIES
   timecop (~> 0.9)
 
 BUNDLED WITH
-   1.16.2
+   1.16.6

data/lib/relaton/db.rb

@@ -1,5 +1,6 @@
-require "pstore"
+# require "pstore"
 require_relative "registry"
+require_relative 'db_cache'
 
 module Relaton
   class RelatonError < StandardError; end
@@ -7,31 +8,31 @@ module Relaton
   class Db
     SUPPORTED_GEMS = %w[isobib ietfbib gbbib iecbib].freeze
 
-    # @param global_cache [String] filename of global DB
-    # @param local_cache [String] filename of local DB
+    # @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
       @db = open_cache_biblio(global_cache)
       @local_db = open_cache_biblio(local_cache, global: false)
       @db_name = global_cache
       @local_db_name = local_cache
-      @registry = Relaton::Registry.instance
     end
 
     def register_gems
-      puts "[relaton] detecting backends:"
+      puts "[relaton] Info: detecting backends:"
       SUPPORTED_GEMS.each do |b|
-        puts b
+        # puts b
         begin
           require b
         rescue LoadError
-          puts "[relaton] backend #{b} not present"
+          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, 
+    # 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
@@ -63,10 +64,10 @@ module Relaton
     # @return [Hash]
     def load_entry(key)
       unless @local_db.nil?
-        entry = @local_db.transaction { @local_db[key] }
+        entry = @local_db[key]
         return entry if entry
       end
-      @db.transaction { @db[key] }
+      @db[key]
     end
 
     # @param key [String]
@@ -74,29 +75,29 @@ module Relaton
     # @option value [Date] "fetched"
     # @option value [IsoBibItem::IsoBibliographicItem] "bib"
     def save_entry(key, value)
-      @db.nil? or @db.transaction { @db[key] = value }
-      @local_db.nil? or @local_db.transaction { @local_db[key] = value }
+      @db.nil? || (@db[key] = value)
+      @local_db.nil? || (@local_db[key] = value)
     end
 
     # list all entries as a serialization
+    # @return [String]
     def to_xml
       db = @local_db || @db || return
-      db.transaction do
-        Nokogiri::XML::Builder.new(encoding: "UTF-8") do |xml|
-          xml.documents do
-            db.roots.reject { |key| key == :version }.
-              each { |key| db[key]&.fetch("bib")&.to_xml(xml, {}) }
-          end
-        end.to_xml
-      end
+      Nokogiri::XML::Builder.new(encoding: "UTF-8") do |xml|
+        xml.documents do
+          xml.parent.add_child db.all.join(" ")
+        end
+      end.to_xml
     end
 
     private
 
+    # @param code [String] code of standard
+    # @return [Symbol] standard class name
     def standard_class(code)
       @registry.processors.each do |name, processor|
         return name if /^#{processor.prefix}/.match(code) ||
-          processor.defaultprefix.match(code)
+            processor.defaultprefix.match(code)
       end
       allowed = @registry.processors.reduce([]) do |m, (_k, v)|
         m << v.prefix
@@ -106,6 +107,12 @@ module Relaton
     end
 
     # TODO: i18n
+    # Fofmat ID
+    # @param code [String]
+    # @param year [String]
+    # @param opts [Hash]
+    # @param stdClass [Symbol]
+    # @return [Array]
     def std_id(code, year, opts, stdclass)
       prefix, code = strip_id_wrapper(code, stdclass)
       ret = code
@@ -114,14 +121,18 @@ module Relaton
       ["#{prefix}(#{ret})", code]
     end
 
+    # Find prefix and clean code
+    # @param code [String]
+    # @param stdClass [Symbol]
+    # @return [Array]
     def strip_id_wrapper(code, stdclass)
       prefix = @registry.processors[stdclass].prefix
       code = code.sub(/^#{prefix}\((.+)\)$/, "\\1")
       [prefix, code]
     end
 
-    def bib_retval(entry)
-      entry["bib"] == "not_found" ? nil : entry["bib"]
+    def bib_retval(entry, stdclass)
+      entry =~ /^not_found/ ? nil : @registry.processors[stdclass].from_xml(entry)
     end
 
     # @param code [String]
@@ -132,21 +143,17 @@ module Relaton
       id, searchcode = std_id(code, year, opts, stdclass)
       db = @local_db || @db
       altdb = @local_db && @db ? @db : nil
-      return bib_retval(new_bib_entry(searchcode, year, opts, stdclass)) if db.nil?
-      db.transaction do
-        db.delete(id) unless valid_bib_entry?(db[id], year)
-        if altdb
-          altdb.transaction do
-            db[id] ||= altdb[id]
-            db[id] ||= new_bib_entry(searchcode, year, opts, stdclass)
-            altdb[id] = db[id] if !valid_bib_entry?(altdb[id], year)
-            bib_retval(db[id])
-          end
-        else
-          db[id] ||= new_bib_entry(searchcode, year, opts, stdclass)
-          bib_retval(db[id])
-        end
+      return bib_retval(new_bib_entry(searchcode, year, opts, stdclass), stdclass) if db.nil?
+
+      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)
+      else
+        db[id] ||= new_bib_entry(searchcode, year, opts, stdclass)
       end
+      bib_retval(db[id], stdclass)
     end
 
     # hash uses => , because the hash is imported from JSON
@@ -157,51 +164,56 @@ module Relaton
     # @return [Hash]
     def new_bib_entry(code, year, opts, stdclass)
       bib = @registry.processors[stdclass].get(code, year, opts)
-      bib = "not_found" if bib.nil?
-      { "fetched" => Date.today, "bib" => bib }
+      bib = "not_found #{Date.today}" if bib.nil? || bib.empty?
+      bib
     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 valid_bib_entry?(bib, year)
+    #   bib&.is_a?(Hash) && bib&.has_key?("bib") && bib&.has_key?("fetched") &&
+    #     (year || Date.today - bib["fetched"] < 60)
+    # end
 
-    # @param filename [String] DB filename
+    # @param dir [String] DB directory
     # @param global [TrueClass, FalseClass]
     # @return [PStore]
-    def open_cache_biblio(filename, global: true)
-      return nil if filename.nil?
-      db = PStore.new filename
-      if File.exist? filename
+    def open_cache_biblio(dir, global: true)
+      return nil if dir.nil?
+      db = DbCache.new dir
+      if File.exist? dir
         if global
-          unless check_cache_version(db)
-            File.delete filename
+          unless db.check_version?
+            FileUtils.rm_rf dir + '/.'
             warn "Global cache version is obsolete and cleared."
           end
-          set_cache_version db
-        elsif check_cache_version(db) then db
+          db.set_version
+        elsif db.check_version? then db
         else
           warn "Local cache version is obsolete."
           nil
         end
-      else
-        set_cache_version db
+      else db.set_version
       end
     end
 
-    def check_cache_version(cache_db)
-      cache_db.transaction { cache_db[:version] == VERSION }
-    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
 
-    def set_cache_version(cache_db)
-      unless File.exist? cache_db.path
-        cache_db.transaction { cache_db[:version] = VERSION }
-      end
-      cache_db
-    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]

data/lib/relaton/db_cache.rb

@@ -0,0 +1,111 @@
+module Relaton
+  class DbCache
+    # @return [String]
+    attr_reader :dir
+
+    # @param dir [String] DB directory
+    def initialize(dir)
+      @dir = dir
+      Dir.mkdir @dir unless Dir.exist? @dir
+      fiele_version = "#{@dir}/version"
+      File.write fiele_version, VERSION unless File.exist? fiele_version
+    end
+
+    # Save item
+    # @param key [String]
+    # @param value [String] Bibitem xml serialization
+    def []=(key, value)
+      return if value.nil?
+      prefix_dir = "#{@dir}/#{prefix(key)}"
+      Dir.mkdir prefix_dir unless Dir.exist? prefix_dir
+      File.write filename(key), value
+    end
+
+    # Read item
+    # @param key [String]
+    # @return [String]
+    def [](key)
+      file = filename key
+      return unless File.exist? file
+
+      File.read(file)
+    end
+
+    # Return fetched date
+    # @param key [String]
+    # @return [String]
+    def fetched(key)
+      value = self[key]
+      return unless value
+      if value =~ /^not_found/
+        value.match(/\d{4}-\d{2}-\d{2}/).to_s
+      else
+        doc = Nokogiri::XML value
+        doc.at('/bibitem/fetched').text
+      end
+    end
+
+    # Returns all items
+    # @return [Array<Hash>]
+    def all
+      Dir.glob("testcache/**/*.xml").sort.map do |f|
+        File.read(f)
+      end
+    end
+
+    # Delete item
+    # @param key [String]
+    def delete(key)
+      file = filename key
+      File.delete file if File.exist? file
+    end
+
+    # Check if version of the DB match to the gem version.
+    # @return [TrueClass, FalseClass]
+    def check_version?
+      v = File.read @dir + "/version"
+      v == VERSION
+    end
+
+    # Set version of the DB to the gem version.
+    # @return [Relaton::DbCache]
+    def set_version
+      File.write @dir + "/version", VERSION
+      self
+    end
+
+    # if cached reference is undated, expire it after 60 days
+    # @param key [String]
+    # @param year [String]
+    def valid_entry?(key, year)
+      datestr = fetched key
+      return false unless datestr
+      date = Date.parse datestr
+      year || Date.today - date < 60
+    end
+
+    private
+
+    # Return item's file name
+    # @param key [String]
+    # @return [String]
+    def filename(key)
+      prefcode = key.downcase.match /^(?<prefix>[^\(]+)\((?<code>[^\)]+)/
+      if prefcode
+        "#{@dir}/#{prefcode[:prefix]}/#{prefcode[:code].gsub(/[-:\s\/]/, '_')}.xml"
+      else
+        "#{@dir}/#{key.gsub(/[-:\s]/, '_')}.xml"
+      end
+    end
+
+    # Return item's subdir
+    # @param key [String]
+    # @return [String]
+    def prefix(key)
+      # @registry.processors.detect do |_n, p|
+      #   /^#{p.prefix}/.match(key) || processor.defaultprefix.match(key)
+      # end[1].prefix.downcase
+      key.downcase.match(/^[^\(]+(?=\()/).to_s
+    end
+  end
+end