iev 0.2.0 → 0.2.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e6e6ba63fb8c18b055cf2915c1deddd1e92b77ddf7d78410b472e2602739e5d4
-  data.tar.gz: 951d226d50c412cbe91c4beac9f2b3eb85c302c9d6deb2032171c68f9899c956
+  metadata.gz: 0ecaba7215dbd4d5e7881ef64bd5efb2977acf8a30d3bece44e2c915f485997e
+  data.tar.gz: a9a5ae122e5cf87ff01ff8e7929daa6816b314842078d1c0b875d2ca78a7c7b1
 SHA512:
-  metadata.gz: 9f404a23da498ae4aae84d826f96f434b95c059c0c94b9ad12e67d9fb00c21175fff9f5e79e565ec967743a081098a73697c5378061b19b2c623da33a6802786
-  data.tar.gz: 6f51cd0ac4f6e975d1dfd41f65cddeab55c2d521da913dee581bcf3bde8a075282ab34ece5d7ebbe5a75aa1a11d325748dfca34bb906d18655c58a142bb30673
+  metadata.gz: 8f748be53f10d3889f4c331b0ec46b265d9233797672185149134f2d56d133172337400968ce9a357e949e3bee3119eec5abd8df7e6f255e60ef1dac50aa72cd
+  data.tar.gz: 134e28259355bfc46f6ac2110bcf01544e9e9acaccb917f2f1c0e72ef3d4b27b79b874d5e82cde6d54e261843a07ae71b2add7544de5d0f3f160af2986cc7f12

data/.github/workflows/rake.yml

@@ -0,0 +1,32 @@
+# Auto-generated by Cimas: Do not edit it manually!
+# See https://github.com/metanorma/cimas
+name: rake
+
+on:
+  push:
+    branches: [ master, main ]
+    tags: [ v* ]
+  pull_request:
+
+jobs:
+  rake:
+    name: Test on Ruby ${{ matrix.ruby }} ${{ matrix.os }}
+    runs-on: ${{ matrix.os }}
+    continue-on-error: ${{ matrix.experimental }}
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby: [ '3.0', '2.7', '2.6', '2.5', '2.4' ]
+        os: [ ubuntu-latest, windows-latest, macos-latest ]
+        experimental: [ false ]
+    steps:
+      - uses: actions/checkout@v2
+        with:
+          submodules: true
+
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+          bundler-cache: true
+
+      - run: bundle exec rake

data/.hound.yml

@@ -0,0 +1,5 @@
+# Auto-generated by Cimas: Do not edit it manually!
+# See https://github.com/metanorma/cimas
+ruby:
+  enabled: true
+  config_file: .rubocop.yml

data/.rubocop.yml

@@ -0,0 +1,10 @@
+# Auto-generated by Cimas: Do not edit it manually!
+# See https://github.com/metanorma/cimas
+inherit_from:
+  - https://raw.githubusercontent.com/riboseinc/oss-guides/master/ci/rubocop.yml
+
+# local repo-specific modifications
+# ...
+
+AllCops:
+  TargetRubyVersion: 2.4

data/Gemfile

@@ -1,6 +1,6 @@
 source "https://rubygems.org"
 
-git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
 
 # Specify your gem's dependencies in iev.gemspec
 gemspec

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,11 @@
 = Iev
 
+image:https://img.shields.io/gem/v/iev.svg["Gem Version", link="https://rubygems.org/gems/iev"]
+image:https://github.com/metanorma/iev/workflows/rake/badge.svg["Build Status", link="https://github.com/metanorma/iev/actions?query=workflow%3Arake"]
+image:https://codeclimate.com/github/metanorma/iev/badges/gpa.svg["Code Climate", link="https://codeclimate.com/github/metanorma/iev"]
+image:https://img.shields.io/github/issues-pr-raw/metanorma/iev.svg["Pull Requests", link="https://github.com/metanorma/iev/pulls"]
+image:https://img.shields.io/github/commits-since/metanorma/iev/latest.svg["Commits since latest",link="https://github.com/metanorma/iev/releases"]
+
 Fetch and encode IEV term from Electropedia.
 
 == Installation

data/Rakefile

@@ -3,4 +3,4 @@ require "rspec/core/rake_task"
 
 RSpec::Core::RakeTask.new(:spec)
 
-task :default => :spec
+task default: :spec

data/iev.gemspec

@@ -1,4 +1,4 @@
-lib = File.expand_path("../lib", __FILE__)
+lib = File.expand_path("lib", __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require "iev/version"
 
@@ -8,10 +8,10 @@ Gem::Specification.new do |spec|
   spec.authors       = ["Ribose Inc."]
   spec.email         = ["open.source@ribose.com"]
 
-  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.summary       = "IEV: Fetch and encode IEV term from Electropedia"
+  spec.description   = "IEV: Fetch and encode IEV term from Electropedia"
+  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,12 +19,13 @@ 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.4.0")
 
-  spec.add_development_dependency "bundler", "~> 1.16"
-  spec.add_development_dependency 'pry-byebug'
-  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "pry-byebug"
+  spec.add_development_dependency "rake", "~> 13.0"
   spec.add_development_dependency "rspec", "~> 3.0"
-  spec.add_development_dependency 'simplecov'
+  spec.add_development_dependency "simplecov"
 
-  spec.add_dependency 'nokogiri'
+  spec.add_dependency "nokogiri", "~> 1.11"
 end

data/lib/iev.rb

@@ -10,13 +10,16 @@ module Iev
   # @param [String] code for example "103-01-02"
   # @param [String] lang language code, for examle "en"
   #
-  # @return [String, nil] if found than term, if code not found then empty string,
-  #   if langguage not fiund then nil.
+  # @return [String, nil] if found than term,
+  # if code not found then empty string,
+  #   if language not found then nil.
   #
   def self.get(code, lang)
-    url = "http://www.electropedia.org/iev/iev.nsf/display?openform&ievref=#{code}"
+    url = "http://www.electropedia.org/iev/iev.nsf/"\
+      "display?openform&ievref=#{code}"
     doc = Nokogiri::HTML OpenURI.open_uri(url), nil, "UTF-8"
-    xpath = "//table/tr/td/div/font[.=\"#{lang}\"]/../../following-sibling::td[2]"
+    xpath = "//table/tr/td/div/font[.=\"#{lang}\"]/../../"\
+      "following-sibling::td[2]"
     doc.at(xpath)&.text&.strip
   end
 end

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"]
+      /^not_found/.match?(entry) ? 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.glob(File.join(dir, "*")), secure: true)
+          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,117 @@
+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.exist? file_version or
+        File.write file_version, VERSION, encoding: "utf-8"
+    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.5".freeze
 end

metadata

@@ -1,29 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: iev
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.5
 platform: ruby
 authors:
 - Ribose Inc.
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2018-07-30 00:00:00.000000000 Z
+date: 2021-06-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.16'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.16'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: pry-byebug
   requirement: !ruby/object:Gem::Requirement
@@ -44,14 +44,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -84,16 +84,16 @@ dependencies:
   name: nokogiri
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.11'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.11'
 description: 'IEV: Fetch and encode IEV term from Electropedia'
 email:
 - open.source@ribose.com
@@ -101,11 +101,12 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/rake.yml"
 - ".gitignore"
+- ".hound.yml"
 - ".rspec"
-- ".travis.yml"
+- ".rubocop.yml"
 - Gemfile
-- Gemfile.lock
 - LICENSE.txt
 - README.adoc
 - Rakefile
@@ -114,12 +115,13 @@ 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: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -127,16 +129,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.4.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
-signing_key: 
+rubygems_version: 3.1.4
+signing_key:
 specification_version: 4
 summary: 'IEV: Fetch and encode IEV term from Electropedia'
 test_files: []

data/.travis.yml

@@ -1,14 +0,0 @@
-sudo: false
-language: ruby
-
-rvm:
-  - 2.5
-  - 2.4
-  - 2.3
-  - ruby-head
-
-before_install: gem install bundler -v 1.16.1
-
-matrix:
-  allow_failures:
-    - rvm: ruby-head

data/Gemfile.lock

@@ -1,57 +0,0 @@
-PATH
-  remote: .
-  specs:
-    iev (0.2.0)
-      nokogiri
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    byebug (10.0.2)
-    coderay (1.1.2)
-    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)
-      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)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.7.0)
-    rspec-mocks (3.7.0)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.7.0)
-    rspec-support (3.7.1)
-    simplecov (0.16.1)
-      docile (~> 1.1)
-      json (>= 1.8, < 3)
-      simplecov-html (~> 0.10.0)
-    simplecov-html (0.10.2)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  bundler (~> 1.16)
-  iev!
-  pry-byebug
-  rake (~> 10.0)
-  rspec (~> 3.0)
-  simplecov
-
-BUNDLED WITH
-   1.16.2