relaton 0.1.6 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 461a1144fc2a8bcad638809bba2487dc86a28e0ec7faacd552a63c81228ac109
-  data.tar.gz: b87e444bdbbd5a16ae12269fa9feb2fecb957175f1fffc29b4959944ee523e83
+  metadata.gz: 33f253d144e0c65c1566fbca9cf1ed1091bc3cbc45684ba6018ed55931b74bf2
+  data.tar.gz: 45512a29a7ca17f7163d6b1ad638b24f27362bf664d36b46e8d46ca1e18d189d
 SHA512:
-  metadata.gz: 22f6aa0825ee61196b772b6a225711fd2164110f89135ae2f3922ed88f4db3230eea7221cf3324bee869708176919a3cf6b01117b309b4a80b9e63c1ffc57ab4
-  data.tar.gz: 44d21285d3569156d2364eadab4c42781c88c95cbbd2f1220e5b988a26d6212496a8b61013e53ca745755859119ee9d6c59ceb43bf55771a48185bbb508feb0e
+  metadata.gz: f0faf8d0629d94b8903ffb8bccc8b6a136a15845c7deaeabeb25a95a8ede5fb8290b37d40dd5d8eaf5d7eb0819452f859f653d4f232e8c9d7fa4879e3cd0770e
+  data.tar.gz: a8016b0c497a30e2f2af7d82d1f6ffe47114ace623ad825fd5654ead94591d7cb4cb7daedd5be4cb4a5e991d3c35f9534552ce75848e9007039420b861033afd

data/Gemfile.lock

@@ -1,12 +1,12 @@
 PATH
   remote: .
   specs:
-    relaton (0.1.6)
+    relaton (0.2.0)
       algoliasearch
-      gbbib (~> 0.2.1)
-      iso-bib-item (~> 0.2.3)
-      isobib (~> 0.2.0)
-      rfcbib (~> 0.2.2)
+      gbbib (~> 0.3.0)
+      iso-bib-item (~> 0.3.0)
+      isobib (~> 0.3.0)
+      rfcbib (~> 0.3.0)
 
 GEM
   remote: https://rubygems.org/
@@ -15,7 +15,7 @@ GEM
       httpclient (~> 2.8, >= 2.8.3)
       json (>= 1.5.1)
     ast (2.4.0)
-    byebug (9.1.0)
+    byebug (10.0.2)
     cnccs (0.1.3)
     coderay (1.1.2)
     diff-lcs (1.3)
@@ -25,10 +25,10 @@ GEM
     ffi (1.9.25)
     formatador (0.2.5)
     gb-agencies (0.0.3)
-    gbbib (0.2.3)
+    gbbib (0.3.0)
       cnccs (~> 0.1.1)
       gb-agencies (~> 0.0.1)
-      iso-bib-item (~> 0.2)
+      iso-bib-item (~> 0.3.0)
     guard (2.14.2)
       formatador (>= 0.2.4)
       listen (>= 2.7, < 4.0)
@@ -44,13 +44,13 @@ GEM
       guard-compat (~> 1.1)
       rspec (>= 2.99.0, < 4.0)
     httpclient (2.8.3)
-    iso-bib-item (0.2.5)
+    iso-bib-item (0.3.0)
       isoics (~> 0.1.6)
       nokogiri (~> 1.8.4)
       ruby_deep_clone (~> 0.8.0)
-    isobib (0.2.5)
+    isobib (0.3.0)
       algoliasearch
-      iso-bib-item (~> 0.2.4)
+      iso-bib-item (~> 0.3.0)
     isoics (0.1.7)
     jaro_winkler (1.5.1)
     json (2.1.0)
@@ -74,16 +74,16 @@ GEM
     pry (0.11.3)
       coderay (~> 1.1.0)
       method_source (~> 0.9.0)
-    pry-byebug (3.5.1)
-      byebug (~> 9.1)
+    pry-byebug (3.6.0)
+      byebug (~> 10.0)
       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.2.2)
-      iso-bib-item (~> 0.2.0)
+    rfcbib (0.3.0)
+      iso-bib-item (~> 0.3.0)
     rspec (3.8.0)
       rspec-core (~> 3.8.0)
       rspec-expectations (~> 3.8.0)
@@ -123,7 +123,7 @@ PLATFORMS
 
 DEPENDENCIES
   bundler (~> 1.15)
-  byebug (~> 9.1)
+  byebug (~> 10.0)
   equivalent-xml (~> 0.6)
   guard (~> 2.14)
   guard-rspec (~> 4.7)

data/README.adoc

@@ -18,14 +18,20 @@ Entries are serialised to and from an internal data model, and multiple formats
 
 Relaton imports bibliographic entries from:
 
-* ISO and IEC through the iso.org website, via the https://github.com/riboseinc/isobib[isobib] gem
-* GB (Chinese national standards) through the GB websites, via the https://github.com/riboseinc/gbbib[gbbib] gem [in progress]
-* IETF standards (Internet Drafts, RFC) through the http://xml2rfc.tools.ietf.org website, via the https://github.com/riboseinc/rfcbib[rfcbib] gem [in progress]
+* ISO through the iso.org website, via the https://github.com/riboseinc/isobib[isobib] gem
+* GB (Chinese national standards) through the GB websites, via the https://github.com/riboseinc/gbbib[gbbib] gem 
+* IETF standards (Internet Drafts, RFC) through the http://xml2rfc.tools.ietf.org website, via the https://github.com/riboseinc/rfcbib[rfcbib] 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.
+* 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
 
 * `@short`, the name of the gem
-* `@prefix`, the regex constraining the standards code to be processed
+* `@prefix`, the regex which scopes the identifier, and constrains it to belong to a particular standards class. 
+* `@defaultprefix`, the identifier prefixes which can be recognised without a scope wrapper.
 * `get(code, date, opts)`, which takes a standards code, a year, and a hash of options, and returns an iso-bib-item bibliographic entry
 ** `date == nil`: an ISO reference is treated as a generic reference to the latest available version of the reference. The latest
 version retrieved has its date of publicatipn stripped. The dated reference is retained as an `instanceOf` relation to the reference.
@@ -39,15 +45,12 @@ e.g. `get("ISO 19115-1", "2014", all_parts: true)` is transformed into a referen
 
 == Behaviours
 
-* Bibliographic entries are identified for retrieval and caching by a prefix specific to the standards class, followed by the conventional code of the standard.
-** ISO standards are identified by `ISO` followed by space or slash. For example, `ISO/IEC DIR 2:2018`
-** IEC standards are identified by `IEC` followed by space or slash
-** GB standards are identified by `GB Standard`. For example, `GB Standard GM/T 0009-2012`
-** IETF stadnards are identified by `IETF`. Foe example, `IETF RFC 7991`
 * If an entry is defined in both the local and the global cache, the local cache entry is used.
 * If an ISO entry has no date, the latest version available for the entry is retrieved.
 * If a cached ISO entry has no date, and was last retrieved more than 60 days ago, the gem fetches it again, in case there is a newer edition of the standard available.
+* Entries are always saved to the cache with a scope-wrapped identifier; e.g. under `ISO(ISO 639-1)`, and not `ISO 639-1`.
 * Note that the gem does not currently support the totality of the Relaton model; it will only support the information available in the source websites. We do not expect to support cartographic information, for example.
+* Document identifiers are returned with a scope indication; for example, `<docidentifier type="IETF">RFC 8000</docidentifier>`. It is up to the client whether to render this with the scope indication (_IETF RFC 8000_) or without (_RFC 8000_).
 
 == Usage
 
@@ -89,13 +92,13 @@ x.to_xml
 db.to_xml
 => "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<documents>\n <bibitem type=\"international-standard\"...."
 
-db.load_entry("ISO 19011")
+db.load_entry("ISO(ISO 19011)")
 => #<IsoBibItem::IsoBibliographicItem:...>
 
-db.save_entry("ISO 19011", nil)
+db.save_entry("ISO(ISO 19011)", nil)
 => nil
 
-db.load_entry("ISO 19011")
+db.load_entry("ISO(ISO 19011)")
 => nil
 
 ----

data/lib/relaton/db.rb

@@ -1,5 +1,4 @@
 require "pstore"
-# require "iso_bib_item"
 require_relative "registry"
 
 module Relaton
@@ -78,22 +77,24 @@ module Relaton
 
     def standard_class(code)
       @registry.processors.each do |name, processor|
-        return name if processor.prefix.match(code)
+        return name if /#{processor.prefix}/.match(code) ||
+          processor.defaultprefix.match(code)
       end
       allowed = @registry.processors.reduce([]) do |m, (_k, v)|
-        m << v.prefix.inspect
+        m << v.prefix
       end
       warn "#{code} does not have a recognised prefix: #{allowed.join(', ')}"
       nil
     end
 
     # TODO: i18n
-    def std_id(code, year, opts, _stdclass)
+    def std_id(code, year, opts, stdclass)
+      prefix = @registry.processors[stdclass].prefix
+      code = code.sub(/^#{prefix}\((.+)\)$/, "\\1")
       ret = code
       ret += ":#{year}" if year
       ret += " (all parts)" if opts[:all_parts]
-      code = code.sub(/^(GB Standard|IETF( Standard)?) /, "")
-      [ret, code]
+      ["#{prefix}(#{ret})", code]
     end
 
     def bib_retval(entry)

data/lib/relaton/processor.rb

@@ -3,6 +3,7 @@ module Relaton
 
     attr_reader :short
     attr_reader :prefix
+    attr_reader :defaultprefix
 
     def initialize
       raise "This is an abstract class!"

data/lib/relaton/version.rb

@@ -1,3 +1,3 @@
 module Relaton
-  VERSION = "0.1.6".freeze
+  VERSION = "0.2.0".freeze
 end

data/relaton.gemspec

@@ -28,13 +28,13 @@ Gem::Specification.new do |spec|
   spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
 
   spec.add_dependency "algoliasearch"
-  spec.add_dependency "gbbib", "~> 0.2.1"
-  spec.add_dependency "isobib", "~> 0.2.0"
-  spec.add_dependency "rfcbib", "~> 0.2.2"
-  spec.add_dependency 'iso-bib-item', '~> 0.2.3'
+  spec.add_dependency "gbbib", "~> 0.3.0"
+  spec.add_dependency "isobib", "~> 0.3.0"
+  spec.add_dependency "rfcbib", "~> 0.3.0"
+  spec.add_dependency 'iso-bib-item', '~> 0.3.0'
 
   spec.add_development_dependency "bundler", "~> 1.15"
-  spec.add_development_dependency "byebug", "~> 9.1"
+  spec.add_development_dependency "byebug", "~> 10.0"
   spec.add_development_dependency "equivalent-xml", "~> 0.6"
   spec.add_development_dependency "guard", "~> 2.14"
   spec.add_development_dependency "guard-rspec", "~> 4.7"

data/spec/relaton/relaton_spec.rb

@@ -29,11 +29,11 @@ RSpec.describe Relaton::Db do
     expect(File.exist?("testcache2")).to be true
     testcache = PStore.new "testcache"
     testcache.transaction true do
-      expect(testcache["ISO 19115-1"]["bib"].to_xml).to include "<bibitem type=\"international-standard\" id=\"ISO19115-1\">"
+      expect(testcache["ISO(ISO 19115-1)"]["bib"].to_xml).to include "<bibitem type=\"international-standard\" id=\"ISO19115-1\">"
     end
     testcache = PStore.new "testcache2"
     testcache.transaction do
-      expect(testcache["ISO 19115-1"]["bib"].to_xml).to include "<bibitem type=\"international-standard\" id=\"ISO19115-1\">"
+      expect(testcache["ISO(ISO 19115-1)"]["bib"].to_xml).to include "<bibitem type=\"international-standard\" id=\"ISO19115-1\">"
     end
   end
 
@@ -45,13 +45,13 @@ RSpec.describe Relaton::Db do
     expect(File.exist?("testcache2")).to be true
     testcache = PStore.new "testcache"
     testcache.transaction do
-      expect(testcache["ISO 111111119115-1"]["fetched"].to_s).to eq Date.today.to_s
-      expect(testcache["ISO 111111119115-1"]["bib"]).to eq "not_found"
+      expect(testcache["ISO(ISO 111111119115-1)"]["fetched"].to_s).to eq Date.today.to_s
+      expect(testcache["ISO(ISO 111111119115-1)"]["bib"]).to eq "not_found"
     end
     testcache = PStore.new "testcache2"
     testcache.transaction do
-      expect(testcache["ISO 111111119115-1"]["fetched"].to_s).to eq Date.today.to_s
-      expect(testcache["ISO 111111119115-1"]["bib"]).to eq "not_found"
+      expect(testcache["ISO(ISO 111111119115-1)"]["fetched"].to_s).to eq Date.today.to_s
+      expect(testcache["ISO(ISO 111111119115-1)"]["bib"]).to eq "not_found"
     end
   end
 
@@ -72,18 +72,18 @@ RSpec.describe Relaton::Db do
 
   it "get GB reference and cache it" do
     stub_bib Gbbib::GbBibliography
-    bib = @db.fetch "GB Standard GB/T 20223", "2006", {}
+    bib = @db.fetch "CN(GB/T 20223)", "2006", {}
     expect(bib).to be_instance_of Gbbib::GbBibliographicItem
     expect(bib.to_xml).to include "<bibitem type=\"standard\" id=\"GB/T20223\">"
     expect(File.exist?("testcache")).to be true
     expect(File.exist?("testcache2")).to be true
     testcache = PStore.new "testcache"
     testcache.transaction true do
-      expect(testcache["GB Standard GB/T 20223:2006"]["bib"].to_xml).to include "<bibitem type=\"standard\" id=\"GB/T20223\">"
+      expect(testcache["CN(GB/T 20223:2006)"]["bib"].to_xml).to include "<bibitem type=\"standard\" id=\"GB/T20223\">"
     end
     testcache = PStore.new "testcache2"
     testcache.transaction do
-      expect(testcache["GB Standard GB/T 20223:2006"]["bib"].to_xml).to include "<bibitem type=\"standard\" id=\"GB/T20223\">"
+      expect(testcache["CN(GB/T 20223:2006)"]["bib"].to_xml).to include "<bibitem type=\"standard\" id=\"GB/T20223\">"
     end
   end
 
@@ -96,11 +96,11 @@ RSpec.describe Relaton::Db do
     expect(File.exist?("testcache2")).to be true
     testcache = PStore.new "testcache"
     testcache.transaction true do
-      expect(testcache["RFC 8341"]["bib"].to_xml).to include "<bibitem id=\"RFC8341\">"
+      expect(testcache["IETF(RFC 8341)"]["bib"].to_xml).to include "<bibitem id=\"RFC8341\">"
     end
     testcache = PStore.new "testcache2"
     testcache.transaction do
-      expect(testcache["RFC 8341"]["bib"].to_xml).to include "<bibitem id=\"RFC8341\">"
+      expect(testcache["IETF(RFC 8341)"]["bib"].to_xml).to include "<bibitem id=\"RFC8341\">"
     end
   end
 

data/spec/support/list_entries.xml

@@ -6,7 +6,7 @@
     <uri type="src">https://www.iso.org/standard/53798.html</uri>
     <uri type="obp">https://www.iso.org/obp/ui/#!iso:std:53798:en</uri>
     <uri type="rss">https://www.iso.org/contents/data/standard/05/37/53798.detail.rss</uri>
-    <docidentifier>ISO 19115-1</docidentifier>
+    <docidentifier type="ISO">ISO 19115-1</docidentifier>
     <contributor>
       <role type="publisher"/>
       <organization>
@@ -53,7 +53,7 @@
         <uri type="src">https://www.iso.org/standard/53798.html</uri>
         <uri type="obp">https://www.iso.org/obp/ui/#!iso:std:53798:en</uri>
         <uri type="rss">https://www.iso.org/contents/data/standard/05/37/53798.detail.rss</uri>
-        <docidentifier>ISO 19115-1</docidentifier>
+        <docidentifier type="ISO">ISO 19115-1:2014</docidentifier>
         <date type="published">
           <on>2014</on>
         </date>
@@ -121,7 +121,7 @@
     <uri type="src">https://www.iso.org/standard/39229.html</uri>
     <uri type="obp">https://www.iso.org/obp/ui/#!iso:std:39229:en</uri>
     <uri type="rss">https://www.iso.org/contents/data/standard/03/92/39229.detail.rss</uri>
-    <docidentifier>ISO 19115-2</docidentifier>
+    <docidentifier type="ISO">ISO 19115-2</docidentifier>
     <contributor>
       <role type="publisher"/>
       <organization>
@@ -158,7 +158,7 @@
         <uri type="src">https://www.iso.org/standard/39229.html</uri>
         <uri type="obp">https://www.iso.org/obp/ui/#!iso:std:39229:en</uri>
         <uri type="rss">https://www.iso.org/contents/data/standard/03/92/39229.detail.rss</uri>
-        <docidentifier>ISO 19115-2</docidentifier>
+        <docidentifier type="ISO">ISO 19115-2:2009</docidentifier>
         <date type="published">
           <on>2009</on>
         </date>

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: relaton
 version: !ruby/object:Gem::Version
-  version: 0.1.6
+  version: 0.2.0
 platform: ruby
 authors:
 - Ribose Inc.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-08-25 00:00:00.000000000 Z
+date: 2018-09-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: algoliasearch
@@ -30,56 +30,56 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.2.1
+        version: 0.3.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.2.1
+        version: 0.3.0
 - !ruby/object:Gem::Dependency
   name: isobib
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.2.0
+        version: 0.3.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.2.0
+        version: 0.3.0
 - !ruby/object:Gem::Dependency
   name: rfcbib
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.2.2
+        version: 0.3.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.2.2
+        version: 0.3.0
 - !ruby/object:Gem::Dependency
   name: iso-bib-item
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.2.3
+        version: 0.3.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.2.3
+        version: 0.3.0
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -100,14 +100,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '9.1'
+        version: '10.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '9.1'
+        version: '10.0'
 - !ruby/object:Gem::Dependency
   name: equivalent-xml
   requirement: !ruby/object:Gem::Requirement