relaton 0.0.1

data/.rubocop.yml

@@ -0,0 +1,15 @@
+# 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:
+  # Thoughtbot's style guide from: https://github.com/thoughtbot/guides
+  - ".rubocop.tb.yml"
+  # Overrides from Ribose
+  - ".rubocop.ribose.yml"
+AllCops:
+  DisplayCopNames: false
+  StyleGuideCopsOnly: false
+  TargetRubyVersion: 2.5
+Rails:
+  Enabled: true

data/.travis.yml

@@ -0,0 +1,6 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.4.3
+before_install:
+  - gem install bundler -v 1.16.1

data/Gemfile

@@ -0,0 +1,8 @@
+Encoding.default_external = Encoding::UTF_8
+Encoding.default_internal = Encoding::UTF_8
+
+source "https://rubygems.org"
+  
+# Specify your gem's dependencies in gemspec
+gemspec
+

data/Gemfile.lock

@@ -0,0 +1,255 @@
+PATH
+  remote: .
+  specs:
+    relaton (0.0.1)
+      asciidoctor (~> 1.5.7)
+      gbbib (~> 0.1.0)
+      iev (~> 0.1.0)
+      iso-bib-item (~> 0.1.6)
+      isobib (~> 0.1.8)
+      rfcbib (~> 0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    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)
+      cnccs
+      iso-bib-item
+    guard (2.14.2)
+      formatador (>= 0.2.4)
+      listen (>= 2.7, < 4.0)
+      lumberjack (>= 1.0.12, < 2.0)
+      nenv (~> 0.1)
+      notiffany (~> 0.0)
+      pry (>= 0.9.12)
+      shellany (~> 0.0)
+      thor (>= 0.18.1)
+    guard-compat (1.2.1)
+    guard-rspec (4.7.3)
+      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)
+      isoics (~> 0.1.6)
+      nokogiri
+    isobib (0.1.9)
+      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
+    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)
+      mini_portile2 (~> 2.3.0)
+    notiffany (0.1.1)
+      nenv (~> 0.1)
+      shellany (~> 0.0)
+    optout (0.0.2)
+    parallel (1.12.1)
+    parser (2.5.1.0)
+      ast (~> 2.4.0)
+    powerpack (0.1.2)
+    pry (0.11.3)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    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)
+    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)
+    rubocop (0.57.2)
+      jaro_winkler (~> 1.5.1)
+      parallel (~> 1.10)
+      parser (>= 2.5)
+      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_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)
+      json (>= 1.8, < 3)
+      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
+
+DEPENDENCIES
+  bundler (~> 1.15)
+  byebug (~> 9.1)
+  equivalent-xml (~> 0.6)
+  guard (~> 2.14)
+  guard-rspec (~> 4.7)
+  metanorma (~> 0.2.5)
+  rake (~> 12.0)
+  relaton!
+  rspec (~> 3.6)
+  rubocop (~> 0.50)
+  simplecov (~> 0.15)
+  timecop (~> 0.9)
+
+BUNDLED WITH
+   1.16.2

data/LICENSE

@@ -0,0 +1,25 @@
+BSD 2-Clause License
+
+Copyright (c) 2018, Ribose
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+* Redistributions of source code must retain the above copyright notice, this
+  list of conditions and the following disclaimer.
+
+* 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

@@ -0,0 +1,17 @@
+= relaton
+
+gem for importing and caching bibliographic references to technical standards
+
+```ruby
+x = Relaton.fetch("ISO19011")
+=> Relaton::Error "No such fetcher"
+
+require 'relaton-iso'
+x = Relaton.fetch("ISO19011")
+=> <# Relaton::Iso @docidentifier: "ISO 19011:2011" ... >
+
+x.to_xml
+=> <bib-item ...>
+```
+
+

data/bin/rspec

@@ -0,0 +1,18 @@
+#!/usr/bin/env ruby
+  
+# This file was generated by Bundler.
+#
+# The application 'rspec' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path(
+  "../../Gemfile", Pathname.new(__FILE__).realpath
+)
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("rspec-core", "rspec")
+

data/lib/relaton.rb

@@ -0,0 +1,4 @@
+require_relative "relaton/relaton"
+require_relative "relaton/version"
+require_relative "relaton/registry"
+require_relative "relaton/processor"

data/lib/relaton/processor.rb

@@ -0,0 +1,16 @@
+module Relaton
+  class Processor
+
+    attr_reader :short
+    attr_reader :prefix
+
+    def initialize
+      raise "This is an abstract class!"
+    end
+
+    def get(code, date, opts)
+      raise "This is an abstract class!"
+    end
+  end
+end
+

data/lib/relaton/registry.rb

@@ -0,0 +1,36 @@
+require 'singleton'
+
+class Error < StandardError
+end
+
+module Relaton
+  class Registry
+    include Singleton
+
+    attr_reader :processors
+
+    def initialize
+      @processors = {}
+    end
+
+    def register processor
+      raise Error unless processor < :: Relaton::Processor
+      p = processor.new
+      puts "[relaton] processor \"#{p.short}\" registered"
+      @processors[p.short] = p
+    end
+
+    def find_processor(short)
+      @processors[short.to_sym]
+    end
+
+    def supported_processors
+      @processors.keys
+    end
+
+    def processors
+      @processors
+    end
+  end
+end
+

data/lib/relaton/relaton.rb

@@ -0,0 +1,120 @@
+require_relative "registry"
+
+module Relaton
+  class RelatonError < StandardError; end
+
+  class Db
+    #PREFIXES = ["GB Standard", "IETF", "ISO", "IEC", "IEV"]
+
+    SUPPORTED_GEMS = %w[ isobib rfcbib gbbib ].freeze
+
+    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
+      register_gems
+      @registry = Relaton::Registry.instance
+    end
+
+    def register_gems
+      puts "[relaton] detecting backends:"
+      SUPPORTED_GEMS.each do |b|
+        puts b
+        require b
+      rescue LoadError
+        puts "[relaton] backend #{b} not present"
+      end
+    end
+
+    # The class of reference requested is determined by the prefix of the code:
+    # GB Standard for gbbib, IETF for rfcbib, ISO or IEC or IEV for isobib
+    # @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
+    def fetch(code, year = nil, opts = {})
+      stdclass = standard_class(code)
+      check_bibliocache(code, year, opts, stdclass)
+    end
+
+    def save()
+      save_cache_biblio(@bibdb, @bibdb_name)
+      save_cache_biblio(@local_bibdb, @local_bibdb_name)
+    end
+
+    private
+
+    def standard_class(code)
+=begin
+      %r{^GB Standard }.match? code and return :gbbib
+      %r{^IETF }.match? code and return :rfcbib
+      %r{^(ISO|IEC)[ /]|IEV($| )}.match? code and return :isobib
+=end
+      @registry.processors.each do |name, processor|
+        processor.prefix.match? code and return name
+      end
+      raise(RelatonError, 
+            "#{code} does not have a recognised prefix: "\
+            "#{@registry.supported_processors.join(', ')}")
+      nil
+    end
+
+    def std_id(code, year, opts, _stdclass)
+      ret = code
+      ret += ":#{year}" if year
+      ret += " (all parts)" if opts[:all_parts]
+      ret
+    end
+
+    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 @local_bibdb[id]["bib"] unless @local_bibdb.nil?
+      @bibdb[id]["bib"]
+    end
+
+    # hash uses => , because the hash is imported from JSON
+    def new_bibcache_entry(code, year, opts, stdclass)
+      bib = @registry.processors[stdclass].get(code, year, opts)
+      return nil 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)
+    end
+
+    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
+    end
+
+    def from_xml(entry)
+      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
+  end
+end