relaton 0.2.1 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 42657976ee71d76c27bac1941026c136517bea759989c972c648ba32c81158ba
-  data.tar.gz: 7831b19745e10f9c29149062f7a6ca58a5ef57228ea94c979c12304471e9d8a2
+  metadata.gz: b5289c73f7ef9ea82c84ece5379a949d288a60f13cab353b1c5f8b17a580bb3c
+  data.tar.gz: a363758952c22241d932442061fc777d2486d08296797248d59577b0693d7f63
 SHA512:
-  metadata.gz: b7892859942c64071e0d135313201915b97330778e339f296b992846fc10502ff114cec5c826ce6151e6f242439bcd801921f16429038adec040989e06542c78
-  data.tar.gz: deb64d1b2ee5a6222624ab991dba4b8f3178bf44c8a75318d169c952c8f53bf77e872f73b1c83e4a2ac9a59bf9a91860bff79753c63f5c331c568527d0616fa2
+  metadata.gz: a6afe15dbf35ef71b7bc632165f836158413954f4763c04e79f9d47246048c203076e22ff490d40ae2a25a956772e6c95f1e0942ecc08b6ec1aff6e2207bc282
+  data.tar.gz: 7a2dd8e987ba0f042ad8bc09b2ab661328d8644b968029046f3277bd78e5a889a2efd90c3c2d120859c05e2384d444d0833c6e024ec38d6f0c32ecf7bb8b35d3

data/README.adoc

@@ -32,6 +32,7 @@ The gem can be extended to use other standards-specific gems. Standards-specific
 * `@short`, the name of the gem
 * `@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.
+* `@idtype`, the type assigned to document identifiers for the standard class.
 * `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.
@@ -50,7 +51,7 @@ e.g. `get("ISO 19115-1", "2014", all_parts: true)` is transformed into a referen
 * 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_).
+* Document identifiers are returned with a scope indication (`@idtype`); 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
 
@@ -86,6 +87,9 @@ x = db.fetch("ISO 19011", "2011", allparts: true)
 fetching ISO 19011...
 => #<IsoBibItem::IsoBibliographicItem:...>
 
+x = db.docid_type("CN(GB/T 1.1)")
+=> ["Chinese Standard", "GB/T 1.1"]
+
 x.to_xml
 => "<bib-item type=\"international-standard\" id=\"ISO19011\">...."
 

data/lib/relaton/db.rb

@@ -41,6 +41,13 @@ module Relaton
       check_bibliocache(code, year, opts, stdclass)
     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)
+      [@registry.processors[stdclass].idtype, code]
+    end
+
     # @param key [String]
     # @return [Hash]
     def load_entry(key)
@@ -60,7 +67,7 @@ module Relaton
       @local_db.nil? or @local_db.transaction { @local_db[key] = value }
     end
 
-    # list all entris as a serialization
+    # list all entries as a serialization
     def to_xml
       return nil if @db.nil?
       @db.transaction do
@@ -89,14 +96,19 @@ module Relaton
 
     # TODO: i18n
     def std_id(code, year, opts, stdclass)
-      prefix = @registry.processors[stdclass].prefix
-      code = code.sub(/^#{prefix}\((.+)\)$/, "\\1")
+      prefix, code = strip_id_wrapper(code, stdclass)
       ret = code
       ret += ":#{year}" if year
       ret += " (all parts)" if opts[:all_parts]
       ["#{prefix}(#{ret})", code]
     end
 
+    def strip_id_wrapper(code, stdclass)
+      prefix = @registry.processors[stdclass].prefix
+      code = code.sub(/^#{prefix}\((.+)\)$/, "\\1")
+      [prefix, code]
+    end
+
     def bib_retval(entry)
       entry["bib"] == "not_found" ? nil : entry["bib"]
     end

data/lib/relaton/processor.rb

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

data/lib/relaton/version.rb

@@ -1,3 +1,3 @@
 module Relaton
-  VERSION = "0.2.1".freeze
+  VERSION = "0.2.2".freeze
 end

data/relaton.gemspec

@@ -28,9 +28,9 @@ Gem::Specification.new do |spec|
   spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
 
   spec.add_dependency "algoliasearch"
-  spec.add_dependency "gbbib", "~> 0.3.0"
-  spec.add_dependency "isobib", "~> 0.3.0"
-  spec.add_dependency "ietfbib", "~> 0.4.0"
+  spec.add_dependency "gbbib", "~> 0.3.1"
+  spec.add_dependency "isobib", "~> 0.3.1"
+  spec.add_dependency "ietfbib", "~> 0.4.1"
   spec.add_dependency 'iso-bib-item', '~> 0.3.0'
 
   spec.add_development_dependency "bundler", "~> 1.15"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: relaton
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.2.2
 platform: ruby
 authors:
 - Ribose Inc.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-09-09 00:00:00.000000000 Z
+date: 2018-09-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: algoliasearch
@@ -30,42 +30,42 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.3.0
+        version: 0.3.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.3.0
+        version: 0.3.1
 - !ruby/object:Gem::Dependency
   name: isobib
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.3.0
+        version: 0.3.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.3.0
+        version: 0.3.1
 - !ruby/object:Gem::Dependency
   name: ietfbib
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.4.0
+        version: 0.4.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.4.0
+        version: 0.4.1
 - !ruby/object:Gem::Dependency
   name: iso-bib-item
   requirement: !ruby/object:Gem::Requirement