relaton 0.3.4 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0fc173e172f5bce023b95d084eb5ea993e956e1db7528d62a03573c9043b3dfd
-  data.tar.gz: 41467a22d7174a6dcbe76cf4ac85c3d7123be298f034ad85429219e722df96c8
+  metadata.gz: 00f79ee6d4b4884984fe6749a60932b026822a6355416f7620c06dbb0bc3f4e7
+  data.tar.gz: 6cd7711482a8e44df75b278b6e0c5f19e7de48319e8cd4949c121e6ca5d8055f
 SHA512:
-  metadata.gz: 221238fd7ab1b8c83d85c6e954fe2598bd6bd43354572b3d5a67c70d79a67f1e6ff65b7210c4d05303517dcf43ed4bed455530bbb5ffd96abf3ce65c4f1827da
-  data.tar.gz: 308dfe38a070836311eca5911d77e2b6cd289f8fe4ffd5c2e20324457ef2ae16b899e88853e82f64800a638b0eaac7b68d80f5e6a48ff5cfbf52bc4c61bb81f5
+  metadata.gz: cb0a9e93a381597c95513a6966d6795822dd0eca1f3fa903de22218416570ebc41f9424082bf3f79423a6e2fa23b387d34e40bb9df822118e4a2c719a7a06751
+  data.tar.gz: fd679aacb503d9ec7ee0b6483048dda5de8fcf203a2ffd45d1f376f1fc37bf82896bc735f467579f7283ef6bae9abe2529269505ca8eef551fc968e4c95e3b71

data/.gitignore

@@ -3,4 +3,8 @@ coverage/
 .rspec_status
 
 testcache
-testcache2
+testcache2
+globalcahe/
+localcahe/
+.rubocop-https---raw-githubusercontent-com-riboseinc-oss-guides-master-ci-rubocop-yml
+.vscode/

data/.travis.yml

@@ -1,3 +1,5 @@
+# Auto-generated !!! Do not edit it manually
+# use ci-master https://github.com/metanorma/metanorma-build-scripts
 language: ruby
 cache: bundler
 os:
@@ -6,12 +8,10 @@ os:
 rvm:
 - 2.5
 - 2.4
-- 2.3
 - ruby-head
-before_install:
+before_install: 
 - gem install bundler -v 2.0.1
 - bundle update
 matrix:
   allow_failures:
     - rvm: ruby-head
-

data/Gemfile.lock

@@ -1,14 +1,15 @@
 PATH
   remote: .
   specs:
-    relaton (0.3.4)
+    relaton (0.4.0)
       algoliasearch
-      gbbib (~> 0.4.0)
-      iecbib (~> 0.2.0)
-      ietfbib (~> 0.4.2)
-      iso-bib-item (~> 0.4.2)
-      isobib (~> 0.4.0)
-      nistbib (~> 0.1.1)
+      relaton-gb (~> 0.5.0)
+      relaton-iec (~> 0.3.0)
+      relaton-ietf (~> 0.5.0)
+      relaton-iso (~> 0.5.0)
+      relaton-iso-bib (~> 0.2.0)
+      relaton-itu (~> 0.2.0)
+      relaton-nist (~> 0.2.0)
 
 GEM
   remote: https://rubygems.org/
@@ -24,17 +25,16 @@ GEM
     coderay (1.1.2)
     crack (0.4.3)
       safe_yaml (~> 1.0.0)
+    debase (0.2.2)
+      debase-ruby_core_source (>= 0.10.2)
+    debase-ruby_core_source (0.10.5)
     diff-lcs (1.3)
-    docile (1.3.1)
+    docile (1.3.2)
     equivalent-xml (0.6.0)
       nokogiri (>= 1.4.3)
-    ffi (1.10.0)
+    ffi (1.11.1)
     formatador (0.2.5)
     gb-agencies (0.0.5)
-    gbbib (0.4.4)
-      cnccs (~> 0.1.1)
-      gb-agencies (~> 0.0.1)
-      iso-bib-item (~> 0.4.2)
     guard (2.15.0)
       formatador (>= 0.2.4)
       listen (>= 2.7, < 4.0)
@@ -49,21 +49,8 @@ GEM
       guard (~> 2.1)
       guard-compat (~> 1.1)
       rspec (>= 2.99.0, < 4.0)
-    hashdiff (0.3.8)
+    hashdiff (0.4.0)
     httpclient (2.8.3)
-    iecbib (0.2.2)
-      addressable
-      iso-bib-item (~> 0.4.2)
-    ietfbib (0.4.5)
-      iso-bib-item (~> 0.4.2)
-    iso-bib-item (0.4.5)
-      isoics (~> 0.1.6)
-      nokogiri (~> 1.8.4)
-      ruby_deep_clone (~> 0.8.0)
-    isobib (0.4.4)
-      algoliasearch
-      iecbib (~> 0.2.1)
-      iso-bib-item (~> 0.4.2)
     isoics (0.1.7)
     json (2.2.0)
     listen (3.1.5)
@@ -74,15 +61,13 @@ GEM
     method_source (0.9.2)
     mini_portile2 (2.3.0)
     nenv (0.3.0)
-    nistbib (0.1.1)
-      iso-bib-item (~> 0.4.2)
     nokogiri (1.8.5)
       mini_portile2 (~> 2.3.0)
     notiffany (0.1.1)
       nenv (~> 0.1)
       shellany (~> 0.0)
     parallel (1.17.0)
-    parser (2.6.2.1)
+    parser (2.6.3.0)
       ast (~> 2.4.0)
     powerpack (0.1.2)
     pry (0.12.2)
@@ -91,25 +76,50 @@ GEM
     pry-byebug (3.6.0)
       byebug (~> 10.0)
       pry (~> 0.10)
-    public_suffix (3.0.3)
+    public_suffix (3.1.0)
     rainbow (3.0.0)
     rake (12.3.2)
     rb-fsevent (0.10.3)
     rb-inotify (0.10.0)
       ffi (~> 1.0)
+    relaton-bib (0.2.0)
+      addressable
+      nokogiri (~> 1.8.4)
+    relaton-gb (0.5.0)
+      cnccs (~> 0.1.1)
+      gb-agencies (~> 0.0.1)
+      relaton-iso-bib (~> 0.2.0)
+    relaton-iec (0.3.0)
+      addressable
+      relaton-iso-bib (~> 0.2.0)
+    relaton-ietf (0.5.0)
+      relaton-iso-bib (~> 0.2.0)
+    relaton-iso (0.5.0)
+      algoliasearch
+      relaton-iec (~> 0.3.0)
+      relaton-iso-bib (~> 0.2.0)
+    relaton-iso-bib (0.2.0)
+      isoics (~> 0.1.6)
+      nokogiri (~> 1.8.4)
+      relaton-bib (~> 0.2.0)
+      ruby_deep_clone (~> 0.8.0)
+    relaton-itu (0.2.0)
+      relaton-iso-bib (~> 0.2.0)
+    relaton-nist (0.2.0)
+      relaton-bib (~> 0.2.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-core (3.8.1)
       rspec-support (~> 3.8.0)
-    rspec-expectations (3.8.2)
+    rspec-expectations (3.8.4)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.8.0)
-    rspec-mocks (3.8.0)
+    rspec-mocks (3.8.1)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.8.0)
-    rspec-support (3.8.0)
+    rspec-support (3.8.2)
     rubocop (0.54.0)
       parallel (~> 1.10)
       parser (>= 2.5)
@@ -117,7 +127,9 @@ GEM
       rainbow (>= 2.2.2, < 4.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (~> 1.0, >= 1.0.1)
-    ruby-progressbar (1.10.0)
+    ruby-debug-ide (0.7.0)
+      rake (>= 0.8.1)
+    ruby-progressbar (1.10.1)
     ruby_deep_clone (0.8.0)
     ruby_dep (1.5.0)
     safe_yaml (1.0.5)
@@ -129,12 +141,12 @@ GEM
     simplecov-html (0.10.2)
     thor (0.20.3)
     timecop (0.9.1)
-    unicode-display_width (1.5.0)
-    vcr (4.0.0)
-    webmock (3.5.1)
+    unicode-display_width (1.6.0)
+    vcr (5.0.0)
+    webmock (3.6.0)
       addressable (>= 2.3.6)
       crack (>= 0.3.2)
-      hashdiff
+      hashdiff (>= 0.4.0, < 2.0.0)
 
 PLATFORMS
   ruby
@@ -142,6 +154,7 @@ PLATFORMS
 DEPENDENCIES
   bundler (~> 2.0.1)
   byebug (~> 10.0)
+  debase
   equivalent-xml (~> 0.6)
   guard (~> 2.14)
   guard-rspec (~> 4.7)
@@ -150,6 +163,7 @@ DEPENDENCIES
   relaton!
   rspec (~> 3.6)
   rubocop (= 0.54.0)
+  ruby-debug-ide
   simplecov (~> 0.15)
   timecop (~> 0.9)
   vcr

data/appveyor.yml

@@ -1,10 +1,14 @@
+# Auto-generated !!! Do not edit it manually
+# use ci-master https://github.com/metanorma/metanorma-build-scripts
 version: '{build}'
 
+cache:
+  - vendor/bundle
+
 environment:
   matrix:
     - RUBY_VERSION: 25
     - RUBY_VERSION: 24
-    - RUBY_VERSION: 23
     - RUBY_VERSION: _trunk
 
 matrix:
@@ -17,6 +21,8 @@ install:
 
 build_script:
   - set PATH=C:\Ruby%RUBY_VERSION%\bin;%PATH%
+  - set GIT_TERMINAL_PROMPT=0
+  - bundle config --local path vendor/bundle
   - bundle update
   - bundle install
 
@@ -27,4 +33,3 @@ before_test:
 
 test_script:
   - bundle exec rake
-

data/docs/README.adoc

@@ -19,15 +19,16 @@ Entries are serialised to and from an internal data model, and multiple formats
 
 Relaton imports bibliographic entries from:
 
-* ISO through the iso.org website, via the https://github.com/metanorma/isobib[isobib] gem
-* IEC through the iec.ch website, via the https://github.com/metanorma/iecbib[isobib] gem
-* GB (Chinese national standards) through the GB websites, via the https://github.com/metanorma/gbbib[gbbib] gem 
-* IETF standards (Internet Drafts, RFC) through the http://xml2rfc.tools.ietf.org website, via the https://github.com/metanorma/ietfbib[ietfbib] gem 
+* ISO through the iso.org website, via the https://github.com/metanorma/relaton-iso[relaton-iso] gem
+* IEC through the iec.ch website, via the https://github.com/metanorma/relaton-iec[relaton-iec] gem
+* GB (Chinese national standards) through the GB websites, via the https://github.com/metanorma/relaton-gb[relaton-gb] gem 
+* IETF standards (Internet Drafts, RFC) through the http://xml2rfc.tools.ietf.org website, via the https://github.com/metanorma/relaton-ietf[relaton-ietf] gem 
+* NIST standards through the nist.gov website, via the https://github.com/metanorma/relaton-nist[relaotn-nist] gem
 
 The identifiers for which bibliographic entries are to be retrieved need to indicate which standards body they belong to. To do so, this gem adopts the convention of bracketing identifiers, and preceding them with a code that indicates the standards body:
 
-* If the standards body is national, the wrapper uses the ISO country code. So `CN(GM/T 0009-2012)` is Chinese sector standard GM/T 0009-2012.
-* If the standards body is international, the wrappers uses the agreed abbreviation of the standards body. So `IETF(I-D.ribose-asciirfc-08)` identifiers `I-D.ribose-asciirfc` as an Internet Engineering Task Force identifier.
+* If the standards body is the national standards body, the wrapper uses the ISO country code. So `CN(GM/T 0009-2012)` is Chinese sector standard GM/T 0009-2012.
+* Otherwise, the wrappers uses the agreed abbreviation of the standards body. So `IETF(I-D.ribose-asciirfc-08)` identifies `I-D.ribose-asciirfc` as an Internet Engineering Task Force identifier.
 * Some prefixes to identifiers indicate the standards body they belong to unambiguously; e.g. `ISO` followed by slash or space. The scope wrapper is not required for those prefixes: `ISO(ISO 639-1)` can be recognised as just `ISO 639-1`.
 
 The gem can be extended to use other standards-specific gems. Standards-specific gems like isobib register themselves against Relaton using `Relaton::Registry.instance.register`, which takes as an argument a subclass of `Relaton::Processor` defined in the gem; see isobib/lib/relaton for an example. The processor within the standards-specific gem needs to define
@@ -65,44 +66,62 @@ require "relaton"
 
 # Do not cache any entries retrieved
 db = Relaton::Db.new(nil, nil)
+[relaton] Info: detecting backends:
+[relaton] processor "relaton_iec" registered
+[relaton] processor "relaton_iso" registered
+[relaton] processor "relaton_ietf" registered
+[relaton] processor "relaton_gb" registered
+[relaton] processor "relaton_nist" registered
+=> #<Relaton::Db:0x007fb1d2a75fe0
+...
 
 # Use only the global cache for any entries retrieved
-db = Relaton::Db.new("global cache filename", nil)
+db = Relaton::Db.new("globalcache", nil)
+[relaton] Info: detecting backends:
+=> #<Relaton::Db:0x007fb1d2856fc0
+...
 
 # Use both a local and a global cache
-db = Relaton::Db.new("global cache filename", "local cache filename")
-[relaton] detecting backends:
-isobib
-[relaton] processor "isobib" registered
-=> #<Relaton::Db:...>
+db = Relaton::Db.new("globalcahe", "localcahe")
+[relaton] Info: detecting backends:
+=> #<Relaton::Db:0x007fb1d0ab9328
+...
 
 x = db.fetch("IEEE 19011")
-"IEEE 19011 does not have a recognised prefix: /^(ISO|IEC)[ \/]|^IEV($| )/"
+IEEE 19011 does not have a recognised prefix: IEC, ISO, IETF, CN, NIST
 => nil
 
 x = db.fetch("ISO 19011")
 fetching ISO 19011...
-=> #<IsoBibItem::IsoBibliographicItem:...>
+=> #<RelatonIsoBib::IsoBibliographicItem:0x007fb1d0ab2f00
+...
 
 x = db.fetch("ISO 19011", "2011")
 fetching ISO 19011...
-=> #<IsoBibItem::IsoBibliographicItem:...>
+=> #<RelatonIsoBib::IsoBibliographicItem:0x007fb1d2593068
+...
 
 x = db.fetch("ISO 19011", "2011", allparts: true)
-fetching ISO 19011...
-=> #<IsoBibItem::IsoBibliographicItem:...>
+=> #<RelatonIsoBib::IsoBibliographicItem:0x007fb1d0ae8bf0
+...
 
-x = db.docid_type("CN(GB/T 1.1)")
+db.docid_type("CN(GB/T 1.1)")
 => ["Chinese Standard", "GB/T 1.1"]
 
 x.to_xml
-=> "<bib-item type=\"international-standard\" id=\"ISO19011\">...."
+=> "<bibitem id="ISO19011-2011">...."
 
 db.to_xml
-=> "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<documents>\n <bibitem type=\"international-standard\"...."
+=> "<?xml version\"1.0" encoding="UTF-8"?><documents><bibdata>...."
+
+x.to_xml
+=> "<bibitem id="ISO19011-2011">..."
+
+x.to_xml
+=> "<bibdata>..."
 
 db.load_entry("ISO(ISO 19011)")
-=> #<IsoBibItem::IsoBibliographicItem:...>
+=> "<bibdata>..."
 
 db.save_entry("ISO(ISO 19011)", nil)
 => nil

data/lib/relaton.rb

@@ -1,4 +1,5 @@
 require_relative "relaton/db"
+require_relative "relaton/db_cache"
 require_relative "relaton/version"
 require_relative "relaton/registry"
 require_relative "relaton/processor"

data/lib/relaton/db.rb

@@ -1,12 +1,12 @@
 # require "pstore"
 require_relative "registry"
-require_relative 'db_cache'
+require_relative "db_cache"
 
 module Relaton
   class RelatonError < StandardError; end
 
   class Db
-    SUPPORTED_GEMS = %w[isobib ietfbib gbbib iecbib nistbib].freeze
+    SUPPORTED_GEMS = %w[relaton_iso relaton_ietf relaton_gb relaton_iec relaton_nist].freeze
 
     # @param global_cache [String] directory of global DB
     # @param local_cache [String] directory of local DB
@@ -42,28 +42,28 @@ module Relaton
       check_bibliocache(code, year, opts, stdclass)
     end
 
-    def fetch_std(code, year = nil, stdclass = nil, opts = {})
-      std = nil
-      @registry.processors.each do |name, processor|
-        std = name if processor.prefix == stdclass
-      end
-      unless std
-        std = standard_class(code) or return nil
-      end
-      check_bibliocache(code, year, opts, std)
-    end
+    # def fetch_std(code, year = nil, stdclass = nil, opts = {})
+    #   std = nil
+    #   @registry.processors.each do |name, processor|
+    #     std = name if processor.prefix == stdclass
+    #   end
+    #   unless std
+    #     std = standard_class(code) or return nil
+    #   end
+    #   check_bibliocache(code, year, opts, std)
+    # end
 
-    def fetched(key)
-      return @local_db.fetched key if @local_db
-      return @db.fetched key if @db
+    # def fetched(key)
+    #   return @local_db.fetched key if @local_db
+    #   return @db.fetched key if @db
 
-      ""
-    end
+    #   ""
+    # end
 
     # The document identifier class corresponding to the given code
     def docid_type(code)
       stdclass = standard_class(code) or return [nil, code]
-      prefix, code = strip_id_wrapper(code, stdclass)
+      _prefix, code = strip_id_wrapper(code, stdclass)
       [@registry.processors[stdclass].idtype, code]
     end
 
@@ -103,7 +103,7 @@ module Relaton
     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
@@ -170,7 +170,7 @@ module Relaton
     # @return [Hash]
     def new_bib_entry(code, year, opts, stdclass)
       bib = @registry.processors[stdclass].get(code, year, opts)
-      bib = bib.to_xml if bib.respond_to? :to_xml
+      bib = bib.to_xml(bibdata: true) if bib.respond_to? :to_xml
       bib = "not_found #{Date.today}" if bib.nil? || bib.empty?
       bib
     end
@@ -188,21 +188,22 @@ module Relaton
     # @return [PStore]
     def open_cache_biblio(dir, global: true)
       return nil if dir.nil?
+
       db = DbCache.new dir
-      if File.exist? dir
-        if global
-          unless db.check_version?
-            FileUtils.rm_rf(Dir.glob(dir + '/*'), secure: true)
-            warn "Global cache version is obsolete and cleared."
-          end
-          db.set_version
-        elsif db.check_version? then db
-        else
-          warn "Local cache version is obsolete."
-          nil
+      # if File.exist? dir
+      if global
+        unless db.check_version?
+          FileUtils.rm_rf(Dir.glob(dir + "/*"), secure: true)
+          warn "Global cache version is obsolete and cleared."
         end
-      else db.set_version
+        db.set_version
+      elsif db.check_version? then db
+      else
+        warn "Local cache version is obsolete."
+        nil
       end
+      # else db.set_version
+      # end
     end
 
     # Check if version of the DB match to the gem version.