relaton 1.6.pre1 → 1.7.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b956fc7fd36ca9f3e36617be9762afcb6a14c832a0fb0bb933b9aae453f6346f
-  data.tar.gz: a8ffebce4bfa7399ae0680d2ec017074f681bb88158fad0d979732030553c0fd
+  metadata.gz: f957d5a962fa3529fb21f4289ff4dc648029497ec3bf209e084b85c49a336531
+  data.tar.gz: 6e6ad879c1552c8396c8f365c4bdc9c088197424f695b68b0dbeec9cc272f1a4
 SHA512:
-  metadata.gz: 3c9571963e0834af9ac8dcf1b21ac20ad78c47705296c1dc06624a079d8cc2068b892c0281a225ba349612e8267a00e277cbe4c6e9d396a7fc37c27a97535f36
-  data.tar.gz: d5a6d165f0975ddc6361d91d08e937be957d52b536ef576cceda9a04733ff657eb3b4b68fd4a8e48b1c4176e490a1fdf8a4e79b35548c1fdf53efc6035613718
+  metadata.gz: f87f3d11aae3e805fa2fe3d9875692c2004a7b7a51fc1235181f8a4a9b314cf0403e50a4134fb093edc0da2cdb42339a7fe4ee7024e25de92d7923bf5029ab35
+  data.tar.gz: 2684a909260936e26f9a2b987c667e61d24e96c01f326bc008deaf9358f1dc349f216c239932ee5780325057bfb192426173d1e226c031880743ff4ce0ad4d12

data/docs/README.adoc

@@ -62,6 +62,8 @@ e.g. `get("ISO 19115-1", "2014", all_parts: true)` is transformed into a referen
 
 == Usage
 
+=== Create DB
+
 [source,ruby]
 ----
 require "relaton"
@@ -93,7 +95,14 @@ db = Relaton::Db.new("globalcache", "localcache")
  @local_db=#<Relaton::DbCache:0x007faabc8fa5c0 @dir="localcache", @ext="xml">,
  @local_db_name="localcache",
 ...
+----
+
+=== Fetch documens
 
+==== Fetch by references
+
+[source,ruby]
+----
 x = db.fetch("IEEE 19011")
 [relaton-ieee] ("IEEE 19011") fetching...
 [relaton-ieee] WARNING: no match found online for IEEE 19011. The code must be exactly like it is on the standards website.
@@ -116,10 +125,85 @@ x = db.fetch("ISO 19115", nil, all_parts: true)
 [relaton-iso] ("ISO 19115") found ISO 19115 (all parts)
 => #<RelatonIsoBib::IsoBibliographicItem:0x007fb1d0ae8bf0
 ...
+----
+
+==== Fetch by URN
+
+This functionality works only for IEC documents.
+
+[source,ruby]
+----
+x = db.fetch "urn:iec:std:iec:60050-102:2007:::"
+[relaton-iec] ("IEC 60050-102") fetching...
+[relaton-iec] ("IEC 60050-102") found IEC 60050-102:2007
+=> #<RelatonIec::IecBibliographicItem:0x007fbd6c3790e8
+...
+----
+
+=== Fetch combined documents
+
+This functionality works only for ISO, IEC, ITU, and NIST documents.
+
+==== Fetch included documents
+[source,ruby]
+----
+bib = db.fetch "ISO 19115-1 + Amd 1"
+[relaton-iso] ("ISO 19115-1") fetching...
+[relaton-iso] ("ISO 19115-1") found ISO 19115-1:2014
+[relaton-iso] ("ISO 19115-1/Amd 1") fetching...
+[relaton-iso] ("ISO 19115-1/Amd 1") found ISO 19115-1:2014/Amd 1:2018
+=> #<RelatonIsoBib::IsoBibliographicItem:0x007f95a929a748
+
+bib.docidentifier[0].id
+=> "ISO 19115-1 + Amd 1"
+
+bib.relation[0].type
+=> "updates"
+
+bib.relation[0].bibitem.docidentifier[0].id
+=> "ISO 19115-1"
 
+bib.relation[1].type
+=> "derivedFrom"
+
+bib.relation[1].bibitem.docidentifier[0].id
+=> "ISO 19115-1/Amd 1:2018"
+
+bib.docidentifier[0].id
+=> "ISO 19115-1, Amd 1"
+
+bib.relation[0].type
+=> "updates"
+
+bib.relation[0].bibitem.docidentifier[0].id
+=> "ISO 19115-1"
+
+bib.relation[1].type
+=> "complements"
+
+bib.relation[1].description
+=> "amendment"
+
+bib.relation[1].bibitem.docidentifier[0].id
+=> "ISO 19115-1/Amd 1:2018"
+----
+
+==== Fetch applied documents
+[source,ruby]
+----
+bib = db.fetch "ISO 19115-1, Amd 1"
+----
+
+=== Get document type
+[source,ruby]
+----
 db.docid_type("CN(GB/T 1.1)")
 => ["Chinese Standard", "GB/T 1.1"]
+----
 
+=== Serializing
+[source,ruby]
+----
 x.to_xml
 => "<bibitem id="ISO19115(allparts)" type="standard">
       ...
@@ -146,11 +230,14 @@ db.load_entry("ISO(ISO 19011)")
 => "<bibdata type="standard">
       ...
     <?bibdata>"
+----
 
+=== Entry manipulation
+[source,ruby]
+----
 db.save_entry("ISO(ISO 19011)", nil)
 => nil
 
 db.load_entry("ISO(ISO 19011)")
 => nil
-
 ----

data/globalcache/iec/iec_60050_102_2007.xml

@@ -0,0 +1,58 @@
+<bibdata type="standard">
+  <fetched>2021-02-03</fetched>
+  <title type="title-main" format="text/plain" language="en" script="Latn">International Electrotechnical Vocabulary (IEV)</title>
+  <title type="title-part" format="text/plain" language="en" script="Latn">Part 102: Mathematics -- General concepts and linear algebra</title>
+  <title type="main" format="text/plain" language="en" script="Latn">International Electrotechnical Vocabulary (IEV) - Part 102: Mathematics -- General concepts and linear algebra</title>
+  <uri type="src">https://webstore.iec.ch/publication/160</uri>
+  <uri type="obp">/preview/info_iec60050-102%7Bed1.0%7Db.pdf</uri>
+  <docidentifier type="IEC">IEC 60050-102:2007</docidentifier>
+  <docidentifier type="URN">urn:iec:std:iec:60050-102:2007:::en</docidentifier>
+  <date type="published">
+    <on>2007-08-27</on>
+  </date>
+  <contributor>
+    <role type="publisher"/>
+    <organization>
+      <name>International Electrotechnical Commission</name>
+      <abbreviation>IEC</abbreviation>
+      <uri>www.iec.ch</uri>
+    </organization>
+  </contributor>
+  <edition>1.0</edition>
+  <language>en</language>
+  <script>Latn</script>
+  <abstract format="text/plain" language="en" script="Latn">This part of IEC 60050 gives the general mathematical terminology used in the fields of electricity, electronics and telecommunications, together with basic concepts in linear algebra. It maintains a clear distinction between mathematical concepts and physical concepts, even if some terms are used in both cases. Another part will deal with functions.&#13;
+It has the status of a horizontal standard in accordance with IEC Guide 108.</abstract>
+  <status>
+    <stage>60</stage>
+    <substage>60</substage>
+  </status>
+  <copyright>
+    <from>2007</from>
+    <owner>
+      <organization>
+        <name>International Electrotechnical Commission</name>
+        <abbreviation>IEC</abbreviation>
+        <uri>www.iec.ch</uri>
+      </organization>
+    </owner>
+  </copyright>
+  <place>Geneva</place>
+  <ext>
+    <doctype>international-standard</doctype>
+    <editorialgroup>
+      <technical-committee number="1" type="technicalCommittee">TC 1 - Terminology</technical-committee>
+    </editorialgroup>
+    <ics>
+      <code>01.040.07</code>
+      <text>Natural and applied sciences (Vocabularies)</text>
+    </ics>
+    <ics>
+      <code>07.020</code>
+      <text>Mathematics</text>
+    </ics>
+    <structuredidentifier type="IEC">
+      <project-number>60050</project-number>
+    </structuredidentifier>
+  </ext>
+</bibdata>

data/globalcache/iec/version

@@ -0,0 +1 @@
+407d6f5afdc9ae9ea7abe6e84d27f40b

data/lib/relaton/config.rb

@@ -15,7 +15,7 @@ module Relaton
     attr_accessor :logs
 
     def initialize
-      @logs ||= %i(warning error)
+      @logs = %i(warning error)
     end
   end
 

data/lib/relaton/db.rb

@@ -23,26 +23,77 @@ module Relaton
     # @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 [NilClass, RelatonIsoBib::IsoBibliographicItem,
+    # @return [nil, RelatonBib::BibliographicItem, RelatonIsoBib::IsoBibliographicItem,
     #   RelatonItu::ItuBibliographicItem, RelatonIetf::IetfBibliographicItem,
-    #   RelatonNist::NistBibliongraphicItem, RelatonGb::GbbibliographicItem]
+    #   RelatonIec::IecBibliographicItem, RelatonIeee::IeeeBibliographicItem,
+    #   RelatonNist::NistBibliongraphicItem, RelatonGb::GbbibliographicItem,
+    #   RelatonOgc::OgcBibliographicItem, RelatonCalconnect::CcBibliographicItem]
+    #   RelatonBipm::BipmBibliographicItem, RelatonIho::IhoBibliographicItem,
+    #   RelatonOmg::OmgBibliographicItem RelatinUn::UnBibliographicItem,
+    #   RelatonW3c::W3cBibliographicItem
     def fetch(code, year = nil, opts = {})
       stdclass = standard_class(code) || return
-      check_bibliocache(code, year, opts, stdclass)
+      processor = @registry.processors[stdclass]
+      ref = processor.respond_to?(:urn_to_code) ? processor.urn_to_code(code)&.first : code
+      ref ||= code
+      cd = combine_doc ref, year, opts, stdclass
+      return cd if cd
+
+      check_bibliocache(ref, year, opts, stdclass)
+    end
+
+    # @param code [String]
+    # @param year [String, nil]
+    # @param stdslass [String]
+    # @return [nil, RelatonBib::BibliographicItem, RelatonIsoBib::IsoBibliographicItem,
+    #   RelatonItu::ItuBibliographicItem, RelatonIetf::IetfBibliographicItem,
+    #   RelatonIec::IecBibliographicItem, RelatonIeee::IeeeBibliographicItem,
+    #   RelatonNist::NistBibliongraphicItem, RelatonGb::GbbibliographicItem,
+    #   RelatonOgc::OgcBibliographicItem, RelatonCalconnect::CcBibliographicItem]
+    #   RelatonBipm::BipmBibliographicItem, RelatonIho::IhoBibliographicItem,
+    #   RelatonOmg::OmgBibliographicItem RelatinUn::UnBibliographicItem,
+    #   RelatonW3c::W3cBibliographicItem
+    def combine_doc(code, year, opts, stdclass) # rubocop:disable Metrics/AbcSize,Metrics/MethodLength
+      if (refs = code.split " + ").size > 1
+        reltype = "derivedFrom"
+        reldesc = nil
+      elsif (refs = code.split ", ").size > 1
+        reltype = "complements"
+        reldesc = RelatonBib::FormattedString.new content: "amendment"
+      else return
+      end
+
+      doc = @registry.processors[stdclass].hash_to_bib docid: { id: code }
+      ref = refs[0]
+      updates = check_bibliocache(ref, year, opts, stdclass)
+      doc.relation << RelatonBib::DocumentRelation.new(bibitem: updates, type: "updates") if updates
+      refs[1..-1].each_with_object(doc) do |c, d|
+        bib = check_bibliocache("#{ref}/#{c}", year, opts, stdclass)
+        if bib
+          d.relation << RelatonBib::DocumentRelation.new(type: reltype, description: reldesc, bibitem: bib)
+        end
+      end
     end
 
     # @param code [String]
     # @param year [String, NilClass]
     # @param stdclass [Symbol, NilClass]
     # @param opts [Hash]
+    # @return [nil, RelatonBib::BibliographicItem, RelatonIsoBib::IsoBibliographicItem,
+    #   RelatonItu::ItuBibliographicItem, RelatonIetf::IetfBibliographicItem,
+    #   RelatonIec::IecBibliographicItem, RelatonIeee::IeeeBibliographicItem,
+    #   RelatonNist::NistBibliongraphicItem, RelatonGb::GbbibliographicItem,
+    #   RelatonOgc::OgcBibliographicItem, RelatonCalconnect::CcBibliographicItem]
+    #   RelatonBipm::BipmBibliographicItem, RelatonIho::IhoBibliographicItem,
+    #   RelatonOmg::OmgBibliographicItem RelatinUn::UnBibliographicItem,
+    #   RelatonW3c::W3cBibliographicItem
     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
+      std = standard_class(code) or return nil unless std
+
       check_bibliocache(code, year, opts, std)
     end
 
@@ -90,16 +141,16 @@ module Relaton
     # @return [Symbol] standard class name
     def standard_class(code)
       @registry.processors.each do |name, processor|
-        return name if /^#{processor.prefix}/.match(code) ||
+        return name if /^(urn:)?#{processor.prefix}/i.match?(code) ||
           processor.defaultprefix.match(code)
       end
       allowed = @registry.processors.reduce([]) do |m, (_k, v)|
         m << v.prefix
       end
       warn <<~WARN
-       #{code} does not have a recognised prefix: #{allowed.join(', ')}.
-       See https://github.com/relaton/relaton/ for instructions on prefixing and wrapping document identifiers to disambiguate them.
-       WARN
+        #{code} does not have a recognised prefix: #{allowed.join(', ')}.
+        See https://github.com/relaton/relaton/ for instructions on prefixing and wrapping document identifiers to disambiguate them.
+      WARN
     end
 
     # TODO: i18n
@@ -130,22 +181,31 @@ module Relaton
     # @param entry [String] XML string
     # @param stdclass [Symbol]
     # @param id [String] docid
-    # @return [NilClass, RelatonIsoBib::IsoBibliographicItem,
+    # @return [nil, RelatonBib::BibliographicItem, RelatonIsoBib::IsoBibliographicItem,
     #   RelatonItu::ItuBibliographicItem, RelatonIetf::IetfBibliographicItem,
-    #   RelatonNist::NistBibliongraphicItem, RelatonGb::GbbibliographicItem]
-    def bib_retval(entry, stdclass, id)
-      entry =~ /^not_found/ ? nil : @registry.processors[stdclass].from_xml(entry)
+    #   RelatonIec::IecBibliographicItem, RelatonIeee::IeeeBibliographicItem,
+    #   RelatonNist::NistBibliongraphicItem, RelatonGb::GbbibliographicItem,
+    #   RelatonOgc::OgcBibliographicItem, RelatonCalconnect::CcBibliographicItem]
+    #   RelatonBipm::BipmBibliographicItem, RelatonIho::IhoBibliographicItem,
+    #   RelatonOmg::OmgBibliographicItem RelatinUn::UnBibliographicItem,
+    #   RelatonW3c::W3cBibliographicItem
+    def bib_retval(entry, stdclass, _id)
+      entry.match?(/^not_found/) ? nil : @registry.processors[stdclass].from_xml(entry)
     end
 
     # @param code [String]
     # @param year [String]
     # @param opts [Hash]
     # @param stdclass [Symbol]
-    # @return [NilClass, RelatonIsoBib::IsoBibliographicItem,
+    # @return [nil, RelatonBib::BibliographicItem, RelatonIsoBib::IsoBibliographicItem,
     #   RelatonItu::ItuBibliographicItem, RelatonIetf::IetfBibliographicItem,
+    #   RelatonIec::IecBibliographicItem, RelatonIeee::IeeeBibliographicItem,
     #   RelatonNist::NistBibliongraphicItem, RelatonGb::GbbibliographicItem,
     #   RelatonOgc::OgcBibliographicItem, RelatonCalconnect::CcBibliographicItem]
-    def check_bibliocache(code, year, opts, stdclass)
+    #   RelatonBipm::BipmBibliographicItem, RelatonIho::IhoBibliographicItem,
+    #   RelatonOmg::OmgBibliographicItem RelatinUn::UnBibliographicItem,
+    #   RelatonW3c::W3cBibliographicItem
+    def check_bibliocache(code, year, opts, stdclass) # rubocop:disable Metrics/AbcSize,Metrics/CyclomaticComplexity,Metrics/MethodLength,Metrics/PerceivedComplexity
       id, searchcode = std_id(code, year, opts, stdclass)
       yaml = @static_db[id]
       return @registry.processors[stdclass].hash_to_bib YAML.safe_load(yaml) if yaml
@@ -176,7 +236,7 @@ module Relaton
     # @param db [Relaton::DbCache,`NilClass]
     # @param id [String] docid
     # @return [String]
-    def new_bib_entry(code, year, opts, stdclass, **args)
+    def new_bib_entry(code, year, opts, stdclass, **args) # rubocop:disable Metrics/AbcSize,Metrics/CyclomaticComplexity,Metrics/PerceivedComplexity
       bib = @registry.processors[stdclass].get(code, year, opts)
       bib_id = bib&.docidentifier&.first&.id
 

data/lib/relaton/db_cache.rb

@@ -26,7 +26,7 @@ module Relaton
       prefix_dir = "#{@dir}/#{prefix(key)}"
       FileUtils::mkdir_p prefix_dir unless Dir.exist? prefix_dir
       set_version prefix_dir
-      File.write "#{filename(key)}.#{ext(value)}", value, encoding: "utf-8"
+      file_safe_write "#{filename(key)}.#{ext(value)}", value
     end
 
     # @param value [String]
@@ -65,7 +65,7 @@ module Relaton
       value = self[key]
       return unless value
 
-      if value =~ /^not_found/
+      if value.match? /^not_found/
         value.match(/\d{4}-\d{2}-\d{2}/).to_s
       else
         doc = Nokogiri::XML value
@@ -106,7 +106,7 @@ module Relaton
     def set_version(fdir)
       file_version = "#{fdir}/version"
       unless File.exist? file_version
-        File.write file_version, grammar_hash(fdir), encoding: "utf-8"
+        file_safe_write file_version, grammar_hash(fdir)
       end
       self
     end
@@ -159,7 +159,7 @@ module Relaton
     def filename(key)
       prefcode = key.downcase.match /^(?<prefix>[^\(]+)\((?<code>[^\)]+)/
       fn = if prefcode
-             "#{prefcode[:prefix]}/#{prefcode[:code].gsub(/[-:\s\/\()]/, '_').squeeze("_")}"
+             "#{prefcode[:prefix]}/#{prefcode[:code].gsub(/[-:\s\/\()]/, '_').squeeze('_')}"
            else
              key.gsub(/[-:\s]/, "_")
            end
@@ -189,6 +189,15 @@ module Relaton
       key.downcase.match(/^[^\(]+(?=\()/).to_s
     end
 
+    # @param file [String]
+    # @content [String]
+    def file_safe_write(file, content)
+      File.open file, File::RDWR | File::CREAT, encoding: "UTF-8" do |f|
+        Timeout.timeout(1) { f.flock File::LOCK_EX }
+        f.write content
+      end
+    end
+
     class << self
       private
 
@@ -209,7 +218,7 @@ module Relaton
       # local_cache: local cache name; none created if nil; "relaton" created
       # if empty global_cache: boolean to create global_cache
       # flush_caches: flush caches
-      def init_bib_caches(opts)
+      def init_bib_caches(opts) # rubocop:disable Metrics/CyclomaticComplexity
         globalname = global_bibliocache_name if opts[:global_cache]
         localname = local_bibliocache_name(opts[:local_cache])
         localname = "relaton" if localname&.empty?

data/lib/relaton/registry.rb

@@ -8,7 +8,7 @@ module Relaton
     SUPPORTED_GEMS = %w[
       relaton_gb relaton_iec relaton_ietf relaton_iso relaton_itu relaton_nist
       relaton_ogc relaton_calconnect relaton_omg relaton_un relaton_w3c
-      relaton_ieee relaton_iho relaton_bipm
+      relaton_ieee relaton_iho relaton_bipm relaton_ecma
     ].freeze
 
     include Singleton

data/lib/relaton/version.rb

@@ -1,3 +1,3 @@
 module Relaton
-  VERSION = "1.6.pre1".freeze
+  VERSION = "1.7.3".freeze
 end

data/localcache/iec/iec_60050_102_2007.xml

@@ -0,0 +1,58 @@
+<bibdata type="standard">
+  <fetched>2021-02-03</fetched>
+  <title type="title-main" format="text/plain" language="en" script="Latn">International Electrotechnical Vocabulary (IEV)</title>
+  <title type="title-part" format="text/plain" language="en" script="Latn">Part 102: Mathematics -- General concepts and linear algebra</title>
+  <title type="main" format="text/plain" language="en" script="Latn">International Electrotechnical Vocabulary (IEV) - Part 102: Mathematics -- General concepts and linear algebra</title>
+  <uri type="src">https://webstore.iec.ch/publication/160</uri>
+  <uri type="obp">/preview/info_iec60050-102%7Bed1.0%7Db.pdf</uri>
+  <docidentifier type="IEC">IEC 60050-102:2007</docidentifier>
+  <docidentifier type="URN">urn:iec:std:iec:60050-102:2007:::en</docidentifier>
+  <date type="published">
+    <on>2007-08-27</on>
+  </date>
+  <contributor>
+    <role type="publisher"/>
+    <organization>
+      <name>International Electrotechnical Commission</name>
+      <abbreviation>IEC</abbreviation>
+      <uri>www.iec.ch</uri>
+    </organization>
+  </contributor>
+  <edition>1.0</edition>
+  <language>en</language>
+  <script>Latn</script>
+  <abstract format="text/plain" language="en" script="Latn">This part of IEC 60050 gives the general mathematical terminology used in the fields of electricity, electronics and telecommunications, together with basic concepts in linear algebra. It maintains a clear distinction between mathematical concepts and physical concepts, even if some terms are used in both cases. Another part will deal with functions.&#13;
+It has the status of a horizontal standard in accordance with IEC Guide 108.</abstract>
+  <status>
+    <stage>60</stage>
+    <substage>60</substage>
+  </status>
+  <copyright>
+    <from>2007</from>
+    <owner>
+      <organization>
+        <name>International Electrotechnical Commission</name>
+        <abbreviation>IEC</abbreviation>
+        <uri>www.iec.ch</uri>
+      </organization>
+    </owner>
+  </copyright>
+  <place>Geneva</place>
+  <ext>
+    <doctype>international-standard</doctype>
+    <editorialgroup>
+      <technical-committee number="1" type="technicalCommittee">TC 1 - Terminology</technical-committee>
+    </editorialgroup>
+    <ics>
+      <code>01.040.07</code>
+      <text>Natural and applied sciences (Vocabularies)</text>
+    </ics>
+    <ics>
+      <code>07.020</code>
+      <text>Mathematics</text>
+    </ics>
+    <structuredidentifier type="IEC">
+      <project-number>60050</project-number>
+    </structuredidentifier>
+  </ext>
+</bibdata>