relaton 0.0.2 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1c97ee373e8454f0e9bc2050074e3a291dd19af6eb7e4caf82b4fdf7f1a81f85
-  data.tar.gz: c295361c298708f5cc21155d15b5f7c96e7526f46e1986d0c7d5dea8ef466ddb
+  metadata.gz: bec19dd26e20ad03b8e537bbfcaab9f5cf75dc005ab71d83a094c99b80f08aaa
+  data.tar.gz: 161b82000e567929a9a3faa39669acbfd4528dd6c1ff6dab6610314248b85553
 SHA512:
-  metadata.gz: 2dc0a45b6022acc12df6026babdf0a3e1aadc1af73a08238afce32a4b4053f7db36290cfcc1edd14aa1ef5401fb3b9f16e71e25c931944afd549a5b5cc19f414
-  data.tar.gz: e9b37a99f8269b7bcf48be11c5ac2cd6955c00fa32d2b21416fbd60f377473c93b47e26d3af96a62e45e9d3fecf4ff873953fe91ecfdeffd584f94ca7a6413a1
+  metadata.gz: c56f8d929682c8bde40d0b559cb3f5879107dd9bae7032551dbe6a6923555cc5c8107411f73db57d7150b35f8fa8cd9cb807a67b4a170ef855921fbf07ba8e21
+  data.tar.gz: 51c4e74ee9e8610b1bd49d972bbcda8e210355f949be4f264af8beb632fe7eb5fc27ed2dcbbd15201e38c5a91f107e6957e9c6fbfc380ba5728fe3469bd7ac35

data/.gitignore

@@ -0,0 +1,6 @@
+coverage/
+.byebug_history
+.rspec_status
+
+testcache
+testcache2

data/.travis.yml

@@ -1,6 +1,14 @@
+dist: trusty
 sudo: false
 language: ruby
 rvm:
-  - 2.4.3
+  - 2.5
+  - 2.4
+  - ruby-head
 before_install:
   - gem install bundler -v 1.16.1
+  - unset _JAVA_OPTIONS
+matrix:
+  allow_failures:
+    - rvm: ruby-head
+

data/Gemfile.lock

@@ -1,12 +1,11 @@
 PATH
   remote: .
   specs:
-    relaton (0.0.1)
-      asciidoctor (~> 1.5.7)
+    relaton (0.0.2)
+      algoliasearch
       gbbib (~> 0.1.0)
       iev (~> 0.1.0)
-      iso-bib-item (~> 0.1.6)
-      isobib (~> 0.1.8)
+      isobib (~> 0.2.0)
       rfcbib (~> 0.1.0)
 
 GEM
@@ -15,81 +14,17 @@ GEM
     algoliasearch (1.23.2)
       httpclient (~> 2.8, >= 2.8.3)
       json (>= 1.5.1)
-    asciidoctor (1.5.7.1)
-    asciidoctor-csand (0.3.1)
-      asciidoctor (~> 1.5.7)
-      asciidoctor-iso (>= 0.9.0)
-      asciimath
-      htmlentities (~> 4.3.4)
-      image_size
-      isodoc (>= 0.8.0)
-      mime-types
-      nokogiri
-      ruby-jing
-      ruby-xslt
-      thread_safe
-      uuidtools
-    asciidoctor-csd (0.4.1)
-      asciidoctor-iso (>= 0.9.0)
-      isodoc (>= 0.8.0)
-    asciidoctor-gb (0.3.1)
-      asciidoctor-iso (>= 0.9.0)
-      gbbib
-      isodoc (>= 0.8.0)
-      twitter_cldr
-    asciidoctor-iso (0.9.3)
-      asciidoctor (~> 1.5.7)
-      iso-bib-item (~> 0.1.6)
-      isobib (~> 0.1.8)
-      isodoc (>= 0.8)
-      ruby-jing
-    asciidoctor-m3d (0.3.2)
-      asciidoctor (~> 1.5.7)
-      asciidoctor-iso (>= 0.9.0)
-      asciimath
-      htmlentities (~> 4.3.4)
-      image_size
-      isodoc (>= 0.8.0)
-      mime-types
-      nokogiri
-      ruby-jing
-      ruby-xslt
-      thread_safe
-      uuidtools
-    asciidoctor-rfc (0.9.0)
-      asciidoctor (~> 1.5.7)
-      htmlentities (~> 4.3.4)
-      nokogiri
-      ruby-jing
-      thread_safe
-    asciidoctor-rsd (0.3.1)
-      asciidoctor (~> 1.5.7)
-      asciidoctor-iso (>= 0.8.0)
-      asciimath
-      htmlentities (~> 4.3.4)
-      image_size
-      isodoc (>= 0.7.0)
-      mime-types
-      nokogiri
-      ruby-jing
-      ruby-xslt
-      thread_safe
-      uuidtools
-    asciimath (1.0.4)
     ast (2.4.0)
     byebug (9.1.0)
-    camertron-eprun (1.1.1)
-    cldr-plurals-runtime-rb (1.0.1)
     cnccs (0.1.1)
     coderay (1.1.2)
     diff-lcs (1.3)
     docile (1.3.1)
-    duplicate (1.1.1)
     equivalent-xml (0.6.0)
       nokogiri (>= 1.4.3)
     ffi (1.9.25)
     formatador (0.2.5)
-    gbbib (0.1.3)
+    gbbib (0.1.4)
       cnccs
       iso-bib-item
     guard (2.14.2)
@@ -106,62 +41,25 @@ GEM
       guard (~> 2.1)
       guard-compat (~> 1.1)
       rspec (>= 2.99.0, < 4.0)
-    html2doc (0.8.0)
-      asciimath
-      htmlentities (~> 4.3.4)
-      image_size
-      mime-types
-      nokogiri
-      ruby-xslt
-      thread_safe
-      uuidtools
-    htmlentities (4.3.4)
     httpclient (2.8.3)
     iev (0.1.0)
       nokogiri
-    image_size (2.0.0)
-    iso-bib-item (0.1.10)
-      duplicate (~> 1.1.1)
+    iso-bib-item (0.2.0)
       isoics (~> 0.1.6)
-      nokogiri
-    isobib (0.1.9)
+      nokogiri (~> 1.8.4)
+      ruby_deep_clone (~> 0.8.0)
+    isobib (0.2.0)
       algoliasearch
-      iso-bib-item (~> 0.1.10)
-    isodoc (0.8.1)
-      asciimath
-      html2doc (>= 0.7.1)
-      htmlentities (~> 4.3.4)
-      image_size
-      liquid
-      mime-types
-      nokogiri
-      roman-numerals
-      ruby-xslt
-      sass
-      thread_safe
-      uuidtools
+      iso-bib-item (~> 0.2.0)
     isoics (0.1.6)
     jaro_winkler (1.5.1)
     json (2.1.0)
-    liquid (4.0.0)
     listen (3.1.5)
       rb-fsevent (~> 0.9, >= 0.9.4)
       rb-inotify (~> 0.9, >= 0.9.7)
       ruby_dep (~> 1.2)
     lumberjack (1.0.13)
-    metanorma (0.2.5)
-      asciidoctor-csand (>= 0.3.0)
-      asciidoctor-csd (>= 0.4.0)
-      asciidoctor-gb (>= 0.3.0)
-      asciidoctor-iso (>= 0.9.1)
-      asciidoctor-m3d (>= 0.3.1)
-      asciidoctor-rfc (>= 0.9.0)
-      asciidoctor-rsd (>= 0.3.0)
-      isodoc (>= 0.8.0)
     method_source (0.9.0)
-    mime-types (3.1)
-      mime-types-data (~> 3.2015)
-    mime-types-data (3.2016.0521)
     mini_portile2 (2.3.0)
     nenv (0.3.0)
     nokogiri (1.8.4)
@@ -169,22 +67,23 @@ GEM
     notiffany (0.1.1)
       nenv (~> 0.1)
       shellany (~> 0.0)
-    optout (0.0.2)
     parallel (1.12.1)
-    parser (2.5.1.0)
+    parser (2.5.1.2)
       ast (~> 2.4.0)
     powerpack (0.1.2)
     pry (0.11.3)
       coderay (~> 1.1.0)
       method_source (~> 0.9.0)
+    pry-byebug (3.5.1)
+      byebug (~> 9.1)
+      pry (~> 0.10)
     rainbow (3.0.0)
     rake (12.3.1)
     rb-fsevent (0.10.3)
     rb-inotify (0.9.10)
       ffi (>= 0.5.0, < 2)
     rfcbib (0.1.1)
-      iso-bib-item (~> 0.1.10)
-    roman-numerals (0.3.0)
+      iso-bib-item (~> 0.2.0)
     rspec (3.7.0)
       rspec-core (~> 3.7.0)
       rspec-expectations (~> 3.7.0)
@@ -198,24 +97,17 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.7.0)
     rspec-support (3.7.1)
-    rubocop (0.57.2)
+    rubocop (0.58.1)
       jaro_winkler (~> 1.5.1)
       parallel (~> 1.10)
-      parser (>= 2.5)
+      parser (>= 2.5, != 2.5.1.1)
       powerpack (~> 0.1)
       rainbow (>= 2.2.2, < 4.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (~> 1.0, >= 1.0.1)
-    ruby-jing (0.0.1)
-      optout (>= 0.0.2)
     ruby-progressbar (1.9.0)
-    ruby-xslt (0.9.10)
+    ruby_deep_clone (0.8.0)
     ruby_dep (1.5.0)
-    sass (3.5.6)
-      sass-listen (~> 4.0.0)
-    sass-listen (4.0.0)
-      rb-fsevent (~> 0.9, >= 0.9.4)
-      rb-inotify (~> 0.9, >= 0.9.7)
     shellany (0.0.1)
     simplecov (0.16.1)
       docile (~> 1.1)
@@ -223,16 +115,8 @@ GEM
       simplecov-html (~> 0.10.0)
     simplecov-html (0.10.2)
     thor (0.20.0)
-    thread_safe (0.3.6)
     timecop (0.9.1)
-    twitter_cldr (4.4.3)
-      camertron-eprun
-      cldr-plurals-runtime-rb (~> 1.0)
-      tzinfo
-    tzinfo (1.2.5)
-      thread_safe (~> 0.1)
     unicode-display_width (1.4.0)
-    uuidtools (2.1.5)
 
 PLATFORMS
   ruby
@@ -243,7 +127,7 @@ DEPENDENCIES
   equivalent-xml (~> 0.6)
   guard (~> 2.14)
   guard-rspec (~> 4.7)
-  metanorma (~> 0.2.5)
+  pry-byebug
   rake (~> 12.0)
   relaton!
   rspec (~> 3.6)

data/README.adoc

@@ -1,8 +1,13 @@
 = relaton
 
+image:https://img.shields.io/gem/v/relaton.svg["Gem Version", link="https://rubygems.org/gems/relaton"]
+image:https://img.shields.io/travis/riboseinc/relaton/master.svg["Build Status", link="https://travis-ci.org/riboseinc/relaton"]
+image:https://codeclimate.com/github/riboseinc/relaton/badges/gpa.svg["Code Climate", link="https://codeclimate.com/github/riboseinc/relaton"]
+
 gem for importing and caching bibliographic references to technical standards
 
-```ruby
+[source,ruby]
+----
 x = Relaton.fetch("ISO19011")
 => Relaton::Error "No such fetcher"
 
@@ -12,6 +17,4 @@ x = Relaton.fetch("ISO19011")
 
 x.to_xml
 => <bib-item ...>
-```
-
-
+----

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/lib/relaton/db.rb

@@ -1,3 +1,4 @@
+require "pstore"
 require_relative "registry"
 
 module Relaton
@@ -6,11 +7,13 @@ module Relaton
   class Db
     SUPPORTED_GEMS = %w[ isobib rfcbib gbbib ].freeze
 
+    # @param global_cache [String] filename of global DB
+    # @param local_cache [String] filename of local DB
     def initialize(global_cache, local_cache)
-      @bibdb = open_cache_biblio(global_cache)
-      @local_bibdb = open_cache_biblio(local_cache)
-      @bibdb_name = global_cache
-      @local_bibdb_name = local_cache
+      @db = open_cache_biblio(global_cache)
+      @local_db = open_cache_biblio(local_cache)
+      @db_name = global_cache
+      @local_db_name = local_cache
       register_gems
       @registry = Relaton::Registry.instance
     end
@@ -38,11 +41,39 @@ module Relaton
       check_bibliocache(code, year, opts, stdclass)
     end
 
-    def save
-      save_cache_biblio(@bibdb, @bibdb_name)
-      save_cache_biblio(@local_bibdb, @local_bibdb_name)
+    # @param key [String]
+    # @return [Hash]
+    def load_entry(key)
+      entry = @local_db.transaction { @local_db[key] }
+      return entry if entry
+      @db.transaction { @db[key] }
     end
 
+    # @param key [String]
+    # @param value [Hash]
+    # @option value [Date] "fetched"
+    # @option value [IsoBibItem::IsoBibliographicItem] "bib"
+    def save_entry(key, value)
+      @db.transaction { @db[key] = value }
+      @local_db.transaction { @local_db[key] = value }
+    end
+
+    # list all entris as a serialization
+    def to_xml
+      @db.transaction do
+        Nokogiri::XML::Builder.new(encoding: "UTF-8") do |xml|
+          xml.documents do
+            @db.roots.each { |key| @db[key]["bib"].to_xml(xml, {}) }
+          end
+        end.to_xml
+      end
+    end
+
+    # def save
+    #   save_cache_biblio(@db, @db_name)
+    #   save_cache_biblio(@local_db, @local_db_name)
+    # end
+
     private
 
     def standard_class(code)
@@ -52,10 +83,12 @@ module Relaton
       %r{^(ISO|IEC)[ /]|IEV($| )}.match? code and return :isobib
 =end
       @registry.processors.each do |name, processor|
-        processor.prefix.match? code and return name
+        processor.prefix.match?(code) and return name
+      end
+      allowed = @registry.processors.reduce([]) do |m, (_k, v)|
+        m << v.prefix.inspect
       end
-      warn "#{code} does not have a recognised prefix: "\
-        "#{@registry.processors.inject([]) { |m, (k, v)| m << v.prefix.inspect }.join(', ')}"
+      warn "#{code} does not have a recognised prefix: #{allowed.join(', ')}"
       nil
     end
 
@@ -67,55 +100,69 @@ module Relaton
       ret
     end
 
+    # @param code [String]
+    # @param year [String]
+    # @param opts [Hash]
+    # @param stdclass [Symbol]
     def check_bibliocache(code, year, opts, stdclass)
       id = std_id(code, year, opts, stdclass)
-      return nil if @bibdb.nil? # signals we will not be using isobib
-      @bibdb[id] = nil unless is_valid_bibcache_entry?(@bibdb[id], year)
-      @bibdb[id] ||= new_bibcache_entry(code, year, opts, stdclass)
-      @local_bibdb[id] = @bibdb[id] if !@local_bibdb.nil? &&
-        !is_valid_bibcache_entry?(@local_bibdb[id], year)
-      return nil if @bibdb[id].nil?
-      return @local_bibdb[id]["bib"] unless @local_bibdb.nil?
-      @bibdb[id]["bib"]
+      return nil if @db.nil? # signals we will not be using isobib
+      @db.transaction do
+        @db.delete(id) unless valid_bib_entry?(@db[id], year)
+        @db[id] ||= new_bib_entry(code, year, opts, stdclass)
+        @local_db.transaction do
+          @local_db[id] = @db[id] if !valid_bib_entry?(@local_db[id], year)
+          @local_db[id]["bib"] == "not_found" ? nil : @local_db[id]["bib"]
+        end
+      end
     end
 
-    # hash uses => , because the hash is imported from JSON
-    def new_bibcache_entry(code, year, opts, stdclass)
+    # hash uses => , because the hash is imported from JSONo
+    # @param code [String]
+    # @param year [String]
+    # @param opts [Hash]
+    # @param stdclass [Symbol]
+    # @return [Hash]
+    def new_bib_entry(code, year, opts, stdclass)
       bib = @registry.processors[stdclass].get(code, year, opts)
-      return nil if bib.nil?
+      bib = "not_found" if bib.nil?
       { "fetched" => Date.today, "bib" => bib }
     end
 
     # if cached reference is undated, expire it after 60 days
-    def is_valid_bibcache_entry?(x, year)
-      x && x.is_a?(Hash) && x&.has_key?("bib") && x&.has_key?("fetched") &&
-        (year || Date.today - Date.iso8601(x["fetched"]) < 60)
+    # @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
 
+    # @param filename [String] DB filename
+    # @return [Hash]
     def open_cache_biblio(filename)
-      biblio = {}
-      return {} unless !filename.nil? && Pathname.new(filename).file?
-      File.open(filename, "r") { |f| biblio = JSON.parse(f.read) }
-      biblio.each do |k, v|
-        biblio[k]&.fetch("bib") and
-          biblio[k]["bib"] = from_xml(biblio[k]["bib"])
-      end
-      biblio
+      PStore.new filename
+      # biblio = {}
+      # return {} unless !filename.nil? && Pathname.new(filename).file?
+      # File.open(filename, "r") { |f| biblio = JSON.parse(f.read) }
+      # biblio.each { |_k, v| v["bib"] && (v["bib"] = from_xml(v["bib"])) }
+      # biblio
     end
 
-    def from_xml(entry)
-      entry # will be unmarshaller
-    end
+    # @param enstry [String] entry in XML format
+    # @return [IsoBibItem::IsoBibliographicItem]
+    # def from_xml(entry)
+    #   IsoBibItem.from_xml entry # will be unmarshaller
+    # end
 
-    def save_cache_biblio(biblio, filename)
-      return if biblio.nil? || filename.nil?
-      biblio.each do |k, v|
-        biblio[k]&.fetch("bib")&.respond_to? :to_xml and
-          biblio[k]["bib"] = biblio[k]["bib"].to_xml
-      end
-      File.open(filename, "w") do |b|
-        b << biblio.to_json
-      end
-    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