relaton-iec 1.7.4 → 1.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8a149738910c8542c434a360acc80e28b47d0a506610644c46c59ac0b5275bd4
-  data.tar.gz: cef0a735b8ee7049e2f7efe845f60773c9bba620a236422ea52d4dee9b63e83a
+  metadata.gz: 7427ca1b33596a9bec83d8f3abc0710879b3daf6c194521dadc222b782ce5107
+  data.tar.gz: 1d5fcf9d30f78f44bfc50c54981923327df06d197dc53c746438201dacd701ff
 SHA512:
-  metadata.gz: cf5dced7765bf8060ed5b0b1f73a404f930d2ce3bad4e4b7f500b66c74b24f9d255495e0a049ebd1a3cae99b9c0af4d5f52710f42d5f8eb8e07de2b32a2abf3b
-  data.tar.gz: 7367a1efe7c9ed2e8d976051286c7d2672da7253c0943a00c9e9c100637aff3ece058abb7e69cb8ee74fddb91c908c9df2f1d58741c7a27f1afa513102068c85
+  metadata.gz: c777d27e4cda11e19603f55351fb881f92ae68d370385e806de2f379f4f696b400b23256a270afb131913ac6d8dc1c46cf9e2a0789b2316e89f9c8fb6d3f1b9c
+  data.tar.gz: ac81157fe613cf6af53b0ed92f7dc5f189d7fa9535f5f614e0497f2e478750d1da11e7971b33cc8c03d318fedeb03acef9ce378fcc1afe37679d4bbfa1487ada

data/.github/workflows/rake.yml

@@ -0,0 +1,46 @@
+# Auto-generated by Cimas: Do not edit it manually!
+# See https://github.com/metanorma/cimas
+name: rake
+
+on:
+  push:
+    branches: [ master, main ]
+    tags: [ v* ]
+  pull_request:
+
+jobs:
+  rake:
+    name: Test on Ruby ${{ matrix.ruby }} ${{ matrix.os }}
+    runs-on: ${{ matrix.os }}
+    continue-on-error: ${{ matrix.experimental }}
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby: [ '2.7', '2.6', '2.5', '2.4' ]
+        os: [ ubuntu-latest, windows-latest, macos-latest ]
+        experimental: [ false ]
+        include:
+          - ruby: '3.0'
+            os: 'ubuntu-latest'
+            experimental: true
+          - ruby: '3.0'
+            os: 'windows-latest'
+            experimental: true
+          - ruby: '3.0'
+            os: 'macos-latest'
+            experimental: true
+    steps:
+      - uses: actions/checkout@v2
+        with:
+          submodules: true
+
+      # https://github.com/ruby-debug/debase/issues/89#issuecomment-686827382
+      - if: matrix.os == 'macos-latest' && matrix.ruby == '2.5'
+        run: echo BUNDLE_BUILD__DEBASE="--with-cflags=\"-Wno-error=implicit-function-declaration\"" >> $GITHUB_ENV
+
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+          bundler-cache: true
+
+      - run: bundle exec rake

data/README.adoc

@@ -31,7 +31,236 @@ Or install it yourself as:
 
 == Usage
 
-Refer to https://github.com/relaton/relaton-iso/blob/master/README.adoc the usage interface is identical.
+=== Search for a standard using keywords
+
+`RelatonIec::IecBibliography.search(ref, year)` method returns hits collection. Each hit can be used to fetch a document.
+
+- `ref` - reference to search document
+- `year` - filter by year (optional)
+
+[source,ruby]
+----
+require 'relaton_iec'
+=> true
+
+hit_collection = RelatonIec::IecBibliography.search("60050")
+=> <RelatonIec::HitCollection:0x007fe0d7126f28 @ref=60050 @fetched=false>
+
+hit_collection.first
+=> <RelatonIec::Hit:0x007fe1068b4d10 @text="60050" @fetched="false" @fullIdentifier="" @title="IEC 60050-102:2007">
+
+item = hit_collection[2].fetch
+=> #<RelatonIec::IecBibliographicItem:0x007fe1171a06f8
+...
+
+item.docidentifier
+=> [#<RelatonBib::DocumentIdentifier:0x007fe1171bb930 @id="IEC 60050-112:2010", @scope=nil, @type="IEC">,
+ #<RelatonBib::DocumentIdentifier:0x007fe1171bb728 @id="urn:iec:std:iec:60050-112:2010:::en", @scope=nil, @type="URN">]
+
+item.docidentifier.detect { |di| di.type == "URN" }.id
+=> "urn:iec:std:iec:60050-112:2010:::en"
+----
+
+=== Fetch documen by keywords
+
+`RelatonIec::IecBibliography.get(ref, year, opts)` method returns document.
+
+- `ref` - reference to search document
+- `year` - filter by year (optional)
+- `opts` - hash of options (optional). Supported options are `:all_parts` (boolean), `:keep_year` (boolean).
+
+[source,ruby]
+----
+item = RelatonIec::IecBibliography.get("IEC 60050-112:2010")
+[relaton-iec] ("IEC 60050-112") fetching...
+[relaton-iec] ("IEC 60050-112") found IEC 60050-112:2010
+=> #<RelatonIec::IecBibliographicItem:0x007fa64e874f78
+
+item = RelatonIec::IecBibliography.get("IEC 60050-112", "2010", all_parts: true)
+[relaton-iec] ("IEC 60050-112") fetching...
+[relaton-iec] ("IEC 60050-112") found IEC 60050 (all parts)
+=> #<RelatonIec::IecBibliographicItem:0x007fa69e9b3948
+
+item.docidentifier.first
+=> #<RelatonBib::DocumentIdentifier:0x007fa69e9abd10 @id="IEC 60050 (all parts)", @scope=nil, @type="IEC">
+
+item = RelatonIec::IecBibliography.get("IEC 60050-112", "2010")
+[relaton-iec] ("IEC 60050-112") fetching...
+[relaton-iec] ("IEC 60050-112") found IEC 60050-112:2010
+=> #<RelatonIec::IecBibliographicItem:0x007fa69f296da8
+
+item.docidentifier.first
+=> #<RelatonBib::DocumentIdentifier:0x007fa69f2a65f0 @id="IEC 60050-112:2010", @scope=nil, @type="IEC">
+----
+
+=== Search for ISO/IEC Directives
+
+The ISO/IEC Derectives are stored in a static cache in a relaton gem. It needs to use the relaton gem to fetch the ISO/IEC Directives. Folloving reaferences are allowed to fetch:
+
+- ISO/IEC DIR 1 - Procedures for the technical work
+- ISO/IEC DIR 1 IEC SUP - Procedures for the technical work – Procedures specific to IEC
+- ISO/IEC DIR 1 ISO SUP - Consolidated ISO Supplement -- Procedures specific to ISO
+- ISO/IEC DIR 2 IEC - Principles and rules for the structure and drafting of ISO and IEC documents
+- ISO/IEC DIR 2 ISO - Principles and rules for the structure and drafting of ISO and IEC documents
+- ISO/IEC DIR IEC SUP - Procedures specific to IEC
+- ISO/IEC DIR JTC 1 SUP - Procedures specific to JTC 1
+
+=== XML serialization
+
+Possible options:
+
+- *bibdata* - If true then wrapp item with _bibdata_ element and add _ext_ element.
+- *note* - Array of hashes `{ text: "Note", type: "note" }`. These notes will be added to XML.
+
+[source,ruby]
+----
+item.to_xml
+=> "<bibitem id="IEC60050-112-2010" type="standard">
+      <fetched>2021-01-28</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 112: Quantities and units</title>
+      <title type="main" format="text/plain" language="en" script="Latn">International Electrotechnical Vocabulary (IEV) - Part 112: Quantities and units</title>
+      <uri type="src">https://webstore.iec.ch/publication/162</uri>
+      <uri type="obp">/preview/info_iec60050-112%7Bed1.0%7Db.pdf</uri>
+      <docidentifier type="IEC">IEC 60050-112:2010</docidentifier>
+      <docidentifier type="URN">urn:iec:std:iec:60050-112:2010:::en</docidentifier>
+      <date type="published">
+        <on>2010-01-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">
+        IEC 60050-112:2010 gives the general terminology concerning quantities and units, the terminology of SI, terms used in names and definitions of quantities, and some basic concepts in metrology. It cancels and replaces Sections 111-11 and 111-12 of International Standard IEC 60050-111:1996. 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>2010</from>
+        <owner>
+          <organization>
+            <name>International Electrotechnical Commission</name>
+            <abbreviation>IEC</abbreviation>
+            <uri>www.iec.ch</uri>
+          </organization>
+        </owner>
+      </copyright>
+      <place>Geneva</place>
+    </bibitem>"
+
+item.to_xml bibdata: true
+=> "<bibdata type="standard">
+      <fetched>2021-01-28</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 112: Quantities and units</title>
+      <title type="main" format="text/plain" language="en" script="Latn">International Electrotechnical Vocabulary (IEV) - Part 112: Quantities and units</title>
+      <uri type="src">https://webstore.iec.ch/publication/162</uri>
+      <uri type="obp">/preview/info_iec60050-112%7Bed1.0%7Db.pdf</uri>
+      <docidentifier type="IEC">IEC 60050-112:2010</docidentifier>
+      <docidentifier type="URN">urn:iec:std:iec:60050-112:2010:::en</docidentifier>
+      ...
+      <ext>
+        <doctype>international-standard</doctype>
+        <editorialgroup>
+          <technical-committee number="1" type="technicalCommittee">TC 1 - Terminology</technical-committee>
+        </editorialgroup>
+        <ics>
+          <code>01.040.01</code>
+          <text>Generalities. Terminology. Standardization. Documentation (Vocabularies)</text>
+        </ics>
+        <ics>
+          <code>01.060</code>
+          <text>Quantities and units</text>
+        </ics>
+        <structuredidentifier type="IEC">
+          <project-number>60050</project-number>
+        </structuredidentifier>
+      </ext>
+    </bibdata>"
+
+item.to_xml note: [{ text: "Note", type: "note" }]
+=> "<bibitem id="IEC60050-112-2010" type="standard">
+      ...
+      <note format="text/plain" type="note">Note</note>
+      ...
+    </bibitem>"
+----
+
+=== Create bibliography item from hash
+
+[source,ruby]
+----
+hash = YAML.load_file "spec/examples/hit.yaml"
+=> {"id"=>"IEC61058-2-4-1995+AMD1-2003CSV",
+...
+
+RelatonIec::IecBibliographicItem.from_hash hash
+=> #<RelatonIec::IecBibliographicItem:0x00007fe16f032d40
+...
+----
+
+=== Converting reference to URN
+
+URN is document a identifier format. It has fields delimited by colon. If any field is absent then it's place is empty. All values are in lower-case.
+
+URN structure: +
+`urn:sdo_namespace:content_type_namespace:header:project_number:date:type:deliverable:language:relation:adjunct_type:adjunct_number:date[#/=]component_or_related_asset`
+
+* prefix
+- `urn` - value: urn
+- `sdo_namespace` - value: iec
+- `content_type_namespace` - value: std
+* base document information
+- `header` - possible values are: iec, iso, iec-iso, iec-ieee, iec-itu, iec-astm
+- `project_number` - number and partnumber. For example 67654, 60601-1, 61076-7-101
+- `date` - document date (optional). Examples: 2010-03, 2010, 2010-10-11 etc.
+- `type` - documant type (optional). Possible values: ts, tr, pas, guide, is, ser.
+- `deliverable` - (optional) possible values: prv, csv, exv, rlv, cmv
+- `language` - (optional) examples: en, fr, ru, en-fr, en-fr-ru etc.
+* adjunct document information (optional)
+- `relation` - "plus" for consolidations of ajancts with a base document or "/" for ajancts itself
+- `adjunct_type` - possible values: amd, cor, ish
+- `adjunct_number` - adjunct number. Examples: 1, 2, 3, etc.
+- `date` - adjanct date. Example: 2009
+* component or related asset information (optional)
+- `component_or_related_asset` - # or = followed by component id or related asset. Exammples: #fig-1, #sec-1, =forum
+
+For more information see https://github.com/relaton/relaton-iec/issues/22
+
+The method `RelatonIec.code_to_urn(code, lang)` converts document identifier to URN.
+
+* `code` is a document identifier
+* `lang` is a laguage code (optional). Examples: en, fr, en-fr etc.
+
+[source,ruby]
+----
+RelatonIec.code_to_urn "IEC 60050-102:2007/AMD1:2017"
+=> "urn:iec:std:iec:60050-102:2007:::::amd:1:2017"
+
+RelatonIec.code_to_urn "IEC 60034-1:1969+AMD1:1977+AMD2:1979+AMD3:1980 CSV", "en-fr"
+=> "urn:iec:std:iec:60034-1:1969::csv:en-fr:plus:amd:1:1977:plus:amd:2:1979:plus:amd:3:1980"
+----
+
+The method `RelatonIec.urn_to_code(urn)` converts URN to document identifier.
+
+[source,ruby]
+----
+RelatonIec.urn_to_code "urn:iec:std:iec:60050-102:2007:::::amd:1:2017"
+=> ["IEC 60050-102:2007/AMD1:2017", ""]
+
+RelatonIec.urn_to_code "urn:iec:std:iec:60034-1:1969::csv:en-fr:plus:amd:1:1977:plus:amd:2:1979:plus:amd:3:1980"
+=> ["IEC 60034-1:1969+AMD1:1977+AMD2:1979+AMD3:1980 CSV", "en-fr"]
+----
 
 == Development
 

data/bin/rspec

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# 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)
+
+bundle_binstub = File.expand_path("../bundle", __FILE__)
+
+if File.file?(bundle_binstub)
+  if File.read(bundle_binstub, 300) =~ /This file was generated by Bundler/
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("rspec-core", "rspec")

data/grammars/basicdoc.rng

@@ -1,9 +1,10 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <grammar xmlns="http://relaxng.org/ns/structure/1.0" datatypeLibrary="http://www.w3.org/2001/XMLSchema-datatypes">
-  <include href="biblio.rng"/>
-  <start>
-    <ref name="document"/>
-  </start>
+  <include href="biblio.rng">
+    <start>
+      <ref name="document"/>
+    </start>
+  </include>
   <define name="document">
     <element name="document">
       <optional>
@@ -43,13 +44,16 @@
       </attribute>
     </optional>
     <optional>
-      <ref name="section-title"/>
+      <attribute name="language"/>
     </optional>
     <optional>
-      <ref name="BasicBlock"/>
+      <attribute name="script"/>
+    </optional>
+    <optional>
+      <ref name="section-title"/>
     </optional>
     <zeroOrMore>
-      <ref name="note"/>
+      <ref name="BasicBlock"/>
     </zeroOrMore>
   </define>
   <define name="references">
@@ -92,6 +96,10 @@
       <ref name="example"/>
       <ref name="review"/>
       <ref name="pre"/>
+      <ref name="note"/>
+      <ref name="pagebreak"/>
+      <ref name="hr"/>
+      <ref name="bookmark"/>
     </choice>
   </define>
   <define name="paragraph">
@@ -188,6 +196,14 @@
           <data type="boolean"/>
         </attribute>
       </optional>
+      <optional>
+        <attribute name="subsequence"/>
+      </optional>
+      <optional>
+        <attribute name="inequality">
+          <data type="boolean"/>
+        </attribute>
+      </optional>
       <ref name="stem"/>
       <optional>
         <ref name="dl"/>
@@ -241,6 +257,9 @@
           <data type="boolean"/>
         </attribute>
       </optional>
+      <optional>
+        <attribute name="subsequence"/>
+      </optional>
       <optional>
         <attribute name="lang"/>
       </optional>
@@ -266,6 +285,9 @@
       <attribute name="id">
         <data type="ID"/>
       </attribute>
+      <optional>
+        <attribute name="alt"/>
+      </optional>
       <optional>
         <ref name="tname"/>
       </optional>
@@ -285,9 +307,15 @@
           <data type="boolean"/>
         </attribute>
       </optional>
+      <optional>
+        <attribute name="subsequence"/>
+      </optional>
       <optional>
         <attribute name="alt"/>
       </optional>
+      <optional>
+        <attribute name="summary"/>
+      </optional>
       <optional>
         <attribute name="uri">
           <data type="anyURI"/>
@@ -313,12 +341,16 @@
   </define>
   <define name="tname">
     <element name="name">
-      <text/>
-    </element>
-  </define>
-  <define name="tclass">
-    <element name="name">
-      <text/>
+      <oneOrMore>
+        <choice>
+          <ref name="PureTextElement"/>
+          <ref name="eref"/>
+          <ref name="stem"/>
+          <ref name="keyword"/>
+          <ref name="xref"/>
+          <ref name="hyperlink"/>
+        </choice>
+      </oneOrMore>
     </element>
   </define>
   <define name="thead">
@@ -370,6 +402,16 @@
           </choice>
         </attribute>
       </optional>
+      <optional>
+        <attribute name="valign">
+          <choice>
+            <value>top</value>
+            <value>middle</value>
+            <value>bottom</value>
+            <value>baseline</value>
+          </choice>
+        </attribute>
+      </optional>
       <choice>
         <zeroOrMore>
           <ref name="TextElement"/>
@@ -397,6 +439,16 @@
           </choice>
         </attribute>
       </optional>
+      <optional>
+        <attribute name="valign">
+          <choice>
+            <value>top</value>
+            <value>middle</value>
+            <value>bottom</value>
+            <value>baseline</value>
+          </choice>
+        </attribute>
+      </optional>
       <choice>
         <zeroOrMore>
           <ref name="TextElement"/>
@@ -417,6 +469,12 @@
           <data type="boolean"/>
         </attribute>
       </optional>
+      <optional>
+        <attribute name="subsequence"/>
+      </optional>
+      <optional>
+        <ref name="tname"/>
+      </optional>
       <oneOrMore>
         <choice>
           <ref name="formula"/>
@@ -481,17 +539,25 @@
         </attribute>
       </optional>
       <optional>
-        <ref name="source"/>
+        <attribute name="subsequence"/>
       </optional>
       <optional>
-        <ref name="tname"/>
+        <attribute name="class"/>
       </optional>
       <optional>
-        <ref name="tclass"/>
+        <ref name="source"/>
+      </optional>
+      <optional>
+        <ref name="tname"/>
       </optional>
       <choice>
         <ref name="image"/>
+        <ref name="video"/>
+        <ref name="audio"/>
         <ref name="pre"/>
+        <oneOrMore>
+          <ref name="paragraph-with-footnote"/>
+        </oneOrMore>
         <zeroOrMore>
           <ref name="figure"/>
         </zeroOrMore>
@@ -529,6 +595,8 @@
       <ref name="pagebreak"/>
       <ref name="bookmark"/>
       <ref name="image"/>
+      <ref name="index"/>
+      <ref name="index-xref"/>
     </choice>
   </define>
   <define name="PureTextElement">
@@ -553,14 +621,20 @@
   <define name="em">
     <element name="em">
       <zeroOrMore>
-        <ref name="PureTextElement"/>
+        <choice>
+          <ref name="PureTextElement"/>
+          <ref name="stem"/>
+        </choice>
       </zeroOrMore>
     </element>
   </define>
   <define name="strong">
     <element name="strong">
       <zeroOrMore>
-        <ref name="PureTextElement"/>
+        <choice>
+          <ref name="PureTextElement"/>
+          <ref name="stem"/>
+        </choice>
       </zeroOrMore>
     </element>
   </define>
@@ -653,6 +727,65 @@
       <empty/>
     </element>
   </define>
+  <define name="index">
+    <element name="index">
+      <optional>
+        <attribute name="to">
+          <data type="IDREF"/>
+        </attribute>
+      </optional>
+      <element name="primary">
+        <oneOrMore>
+          <ref name="PureTextElement"/>
+        </oneOrMore>
+      </element>
+      <optional>
+        <element name="secondary">
+          <oneOrMore>
+            <ref name="PureTextElement"/>
+          </oneOrMore>
+        </element>
+      </optional>
+      <optional>
+        <element name="tertiary">
+          <oneOrMore>
+            <ref name="PureTextElement"/>
+          </oneOrMore>
+        </element>
+      </optional>
+    </element>
+  </define>
+  <define name="index-xref">
+    <element name="index-xref">
+      <attribute name="also">
+        <data type="boolean"/>
+      </attribute>
+      <element name="primary">
+        <oneOrMore>
+          <ref name="PureTextElement"/>
+        </oneOrMore>
+      </element>
+      <optional>
+        <element name="secondary">
+          <oneOrMore>
+            <ref name="PureTextElement"/>
+          </oneOrMore>
+        </element>
+      </optional>
+      <optional>
+        <element name="tertiary">
+          <oneOrMore>
+            <ref name="PureTextElement"/>
+          </oneOrMore>
+        </element>
+      </optional>
+      <element name="target">
+        <oneOrMore>
+          <ref name="PureTextElement"/>
+        </oneOrMore>
+      </element>
+    </element>
+  </define>
   <!-- bare ID element, used for referencing arbitrary spans of text -->
   <define name="bookmark">
     <element name="bookmark">
@@ -778,6 +911,9 @@
       <optional>
         <attribute name="alt"/>
       </optional>
+      <optional>
+        <attribute name="title"/>
+      </optional>
       <optional>
         <attribute name="longdesc">
           <data type="anyURI"/>
@@ -786,7 +922,7 @@
     </element>
   </define>
   <define name="video">
-    <element name="image">
+    <element name="video">
       <attribute name="id">
         <data type="ID"/>
       </attribute>
@@ -816,6 +952,9 @@
       <optional>
         <attribute name="alt"/>
       </optional>
+      <optional>
+        <attribute name="title"/>
+      </optional>
       <optional>
         <attribute name="longdesc">
           <data type="anyURI"/>
@@ -827,7 +966,7 @@
     </element>
   </define>
   <define name="audio">
-    <element name="image">
+    <element name="audio">
       <attribute name="id">
         <data type="ID"/>
       </attribute>
@@ -841,6 +980,9 @@
       <optional>
         <attribute name="alt"/>
       </optional>
+      <optional>
+        <attribute name="title"/>
+      </optional>
       <optional>
         <attribute name="longdesc">
           <data type="anyURI"/>
@@ -925,6 +1067,9 @@
           <value>alphabet_upper</value>
         </choice>
       </attribute>
+      <optional>
+        <attribute name="start"/>
+      </optional>
       <oneOrMore>
         <ref name="li"/>
       </oneOrMore>