iev 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e6e6ba63fb8c18b055cf2915c1deddd1e92b77ddf7d78410b472e2602739e5d4
-  data.tar.gz: 951d226d50c412cbe91c4beac9f2b3eb85c302c9d6deb2032171c68f9899c956
+  metadata.gz: 1dd87e06f2d1a737fd1233fc30716689f6c25812a8dcb18f74babd9e275d6345
+  data.tar.gz: 202a491fe395342bfc8a227e25442d87b8c4a85ed7c512aed621a721263359f5
 SHA512:
-  metadata.gz: 9f404a23da498ae4aae84d826f96f434b95c059c0c94b9ad12e67d9fb00c21175fff9f5e79e565ec967743a081098a73697c5378061b19b2c623da33a6802786
-  data.tar.gz: 6f51cd0ac4f6e975d1dfd41f65cddeab55c2d521da913dee581bcf3bde8a075282ab34ece5d7ebbe5a75aa1a11d325748dfca34bb906d18655c58a142bb30673
+  metadata.gz: 1e614046c3e48693dd000c611e2b25f8b8e028466c55e0b6297ac77d09be72c928d79db480850643aff3577d9edc4b08239816bf49db0dcc0288924739942e2c
+  data.tar.gz: 1ce017de6aed35931abbfb71d2d4a2155c2cb2aeb1163d39636a118b8313627f02a75e26c732703c6d559b3c01156efabb4b34009834e2699fc71a36e0490e5a

data/.hound.yml

@@ -0,0 +1,3 @@
+ruby:
+  Enabled: true
+  config_file: .rubocop.yml

data/.rubocop.yml

@@ -0,0 +1,10 @@
+# This project follows the Ribose OSS style guide.
+# https://github.com/riboseinc/oss-guides
+# All project-specific additions and overrides should be specified in this file.
+
+inherit_from:
+  - https://raw.githubusercontent.com/riboseinc/oss-guides/master/ci/rubocop.yml
+AllCops:
+  TargetRubyVersion: 2.3
+Rails:
+  Enabled: true

data/Gemfile.lock

@@ -12,30 +12,30 @@ GEM
     diff-lcs (1.3)
     docile (1.3.1)
     json (2.1.0)
-    method_source (0.9.0)
-    mini_portile2 (2.3.0)
-    nokogiri (1.8.4)
-      mini_portile2 (~> 2.3.0)
-    pry (0.11.3)
+    method_source (0.9.2)
+    mini_portile2 (2.4.0)
+    nokogiri (1.10.1)
+      mini_portile2 (~> 2.4.0)
+    pry (0.12.2)
       coderay (~> 1.1.0)
       method_source (~> 0.9.0)
     pry-byebug (3.6.0)
       byebug (~> 10.0)
       pry (~> 0.10)
     rake (10.5.0)
-    rspec (3.7.0)
-      rspec-core (~> 3.7.0)
-      rspec-expectations (~> 3.7.0)
-      rspec-mocks (~> 3.7.0)
-    rspec-core (3.7.1)
-      rspec-support (~> 3.7.0)
-    rspec-expectations (3.7.0)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.0)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.2)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.7.0)
-    rspec-mocks (3.7.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.7.0)
-    rspec-support (3.7.1)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.0)
     simplecov (0.16.1)
       docile (~> 1.1)
       json (>= 1.8, < 3)
@@ -46,7 +46,7 @@ PLATFORMS
   ruby
 
 DEPENDENCIES
-  bundler (~> 1.16)
+  bundler (~> 2.0.1)
   iev!
   pry-byebug
   rake (~> 10.0)
@@ -54,4 +54,4 @@ DEPENDENCIES
   simplecov
 
 BUNDLED WITH
-   1.16.2
+   2.0.1

data/LICENSE.txt

@@ -1,21 +1,25 @@
-The MIT License (MIT)
+BSD 2-Clause License
 
-Copyright (c) 2018 Andrei Kislichenko
+Copyright (c) 2018, Ribose
+All rights reserved.
 
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
 
-The above copyright notice and this permission notice shall be included in
-all copies or substantial portions of the Software.
+* Redistributions of source code must retain the above copyright notice, this
+  list of conditions and the following disclaimer.
 
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
-THE SOFTWARE.
+* Redistributions in binary form must reproduce the above copyright notice,
+  this list of conditions and the following disclaimer in the documentation
+  and/or other materials provided with the distribution.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/README.adoc

@@ -1,5 +1,9 @@
 = Iev
 
+image:https://img.shields.io/gem/v/iev.svg["Gem Version", link="https://rubygems.org/gems/iev"]
+image:https://img.shields.io/travis/metanorma/iev/master.svg["Build Status", link="https://travis-ci.com/metanorma/iev"]
+image:https://codeclimate.com/github/metanorma/iev/badges/gpa.svg["Code Climate", link="https://codeclimate.com/github/metanorma/iev"]
+
 Fetch and encode IEV term from Electropedia.
 
 == Installation

data/iev.gemspec

@@ -10,8 +10,8 @@ Gem::Specification.new do |spec|
 
   spec.summary       = %q{IEV: Fetch and encode IEV term from Electropedia}
   spec.description   = %q{IEV: Fetch and encode IEV term from Electropedia}
-  spec.homepage      = "https://github.com/riboseinc/iev"
-  spec.license       = "MIT"
+  spec.homepage      = "https://github.com/metanorma/iev"
+  spec.license       = "BSD-2-Clause"
 
   spec.files         = `git ls-files -z`.split("\x0").reject do |f|
     f.match(%r{^(test|spec|features)/})
@@ -19,8 +19,9 @@ Gem::Specification.new do |spec|
   spec.bindir        = "exe"
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
 
-  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "bundler", "~> 2.0.1"
   spec.add_development_dependency 'pry-byebug'
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "rspec", "~> 3.0"

data/lib/iev/db.rb

@@ -1,4 +1,5 @@
-require 'pstore'
+# require 'pstore'
+require_relative "db_cache"
 
 module Iev
   # Cache class.
@@ -22,65 +23,58 @@ module Iev
     private
 
     def check_bibliocache(code, lang)
-      id = code + '/' + lang
+      id = code + "/" + lang
       return bib_retval(new_bib_entry(code, lang)) if @db.nil?
-      @db.transaction do
-        # @db.delete(id) unless valid_bib_entry?(@db[id])
-        @db[id] ||= new_bib_entry(code, lang)
-        if @local_db.nil? then bib_retval(@db[id])
-        else
-          @local_db.transaction do
-            @local_db[id] ||= @db[id]
-            bib_retval(@local_db[id])
-          end
-        end
+
+      # @db.delete(id) unless valid_bib_entry?(@db[id])
+      @db[id] ||= new_bib_entry(code, lang)
+      if @local_db.nil? then bib_retval(@db[id])
+      else
+        @local_db[id] ||= @db[id]
+        bib_retval(@local_db[id])
       end
     end
 
     def bib_retval(entry)
       # entry['term'] == 'not_found' ? '' : entry['term']
-      entry['term']
+      # entry["term"]
+      entry =~ /^not_found/ ? nil : entry
     end
 
     # @return [Hash]
     def new_bib_entry(code, lang)
-      term = Iev.get(code, lang)
-      # term = 'not_found' if term.nil? || term.empty?
-      { 'term' => term, 'definition' => nil }
+      Iev.get(code, lang)
     end
 
-    # @param filename [String] DB filename
+    # @param dir [String] DB dir
     # @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
-        if global
-          unless check_cache_version(db)
-            File.delete filename
-            warn 'Global cache version is obsolete and cleared.'
-          end
-          save_cache_version db
-        elsif check_cache_version(db) then db
-        else
-          warn 'Local cache version is obsolete.'
-          nil
+    # @return [Iev::DbCache, nil]
+    def open_cache_biblio(dir, global: true)
+      return nil if dir.nil?
+
+      db = DbCache.new dir
+      if global
+        unless db.check_version?
+          FileUtils.rm_rf dir + "/."
+          warn "Global cache version is obsolete and cleared."
         end
+        db.set_version
+      elsif db.check_version? then db
       else
-        save_cache_version db
+        warn "Local cache version is obsolete."
+        nil
       end
     end
 
-    def check_cache_version(cache_db)
-      cache_db.transaction { cache_db[:version] == VERSION }
-    end
+    # def check_cache_version(cache_db)
+    #   cache_db.transaction { cache_db[:version] == VERSION }
+    # end
 
-    def save_cache_version(cache_db)
-      unless File.exist? cache_db.path
-        cache_db.transaction { cache_db[:version] = VERSION }
-      end
-      cache_db
-    end
+    # def save_cache_version(cache_db)
+    #   unless File.exist? cache_db.path
+    #     cache_db.transaction { cache_db[:version] = VERSION }
+    #   end
+    #   cache_db
+    # end
   end
 end

data/lib/iev/db_cache.rb

@@ -0,0 +1,116 @@
+require "fileutils"
+
+module Iev
+  class DbCache
+    # @return [String]
+    attr_reader :dir
+
+    # @param dir [String] DB directory
+    def initialize(dir)
+      @dir = dir
+      FileUtils::mkdir_p @dir
+      file_version = "#{@dir}/version"
+      File.write file_version, VERSION, encoding: "utf-8" unless File.exist? file_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)}"
+      FileUtils::mkdir_p prefix_dir
+      File.write filename(key), value, encoding: "utf-8"
+    end
+
+    # Read item
+    # @param key [String]
+    # @return [String]
+    def [](key)
+      file = filename key
+      return unless File.exist? file
+
+      File.read(file, encoding: "utf-8")
+    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("#{@dir}/**/*.xml").sort.map do |f|
+        File.read(f, encoding: "utf-8")
+      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", encoding: "utf-8"
+      v == VERSION
+    end
+
+    # Set version of the DB to the gem version.
+    # @return [Iev::DbCache]
+    def set_version
+      File.write @dir + "/version", VERSION, encoding: "utf-8"
+      self
+    end
+
+    # if cached reference is undated, expire it after 60 days
+    # @param key [String]
+    # @param year [String]
+    # def valid_entry?(key)
+    #   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

data/lib/iev/version.rb

@@ -1,3 +1,3 @@
 module Iev
-  VERSION = "0.2.0"
+  VERSION = "0.2.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: iev
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Ribose Inc.
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-07-30 00:00:00.000000000 Z
+date: 2019-03-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.16'
+        version: 2.0.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.16'
+        version: 2.0.1
 - !ruby/object:Gem::Dependency
   name: pry-byebug
   requirement: !ruby/object:Gem::Requirement
@@ -102,7 +102,9 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".hound.yml"
 - ".rspec"
+- ".rubocop.yml"
 - ".travis.yml"
 - Gemfile
 - Gemfile.lock
@@ -114,10 +116,11 @@ files:
 - iev.gemspec
 - lib/iev.rb
 - lib/iev/db.rb
+- lib/iev/db_cache.rb
 - lib/iev/version.rb
-homepage: https://github.com/riboseinc/iev
+homepage: https://github.com/metanorma/iev
 licenses:
-- MIT
+- BSD-2-Clause
 metadata: {}
 post_install_message: 
 rdoc_options: []
@@ -127,7 +130,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.3.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="