relaton-iana 1.13.0 → 1.14.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b49d0c8b26b49087faa09c396eb7edf1ab022ca47d839df6bfcfb561bb0e7ed9
-  data.tar.gz: af63f2c69e7e8d3aef16a633ff0bad87352519d2ca0f28d2be864f3d6ac6612a
+  metadata.gz: a9fa046f24a4997ea2ea0b7d4e5b5ae7c19393ef915776cc1e250112920e65fc
+  data.tar.gz: f03595906501b1b7e24dc5e993e63d06a600584e5944126738e1d2f9088551ae
 SHA512:
-  metadata.gz: 6f75255c79c47aed5811deaf20d249c49c0b96dae3fe2c0347b1fcec80abd3b36be860712c0f960f2e08bcef1411867aab6a45772ced5ce2587457cbe3737134
-  data.tar.gz: f4a2584fbb673b9edc47e3c929ef319319d5e4461cbe92efd9a2d366cab5d48a6845b7a7e44541c8cfa6d08113b9c7fc7c933b55ebc8e0c35dfd9ab4597692e4
+  metadata.gz: 5db184297758c4d09b76979bbe1ba281ad630a261b884ffd50a9adf66f7cd29004270f0d1ee6b38e5360906c112023907825489f7d7ae52924c37a6bba957721
+  data.tar.gz: c8f99fd5e3795d9bc41bf248e4e302ac739c1646fd0abc634fb09943dcf00fa507c8c398f4d12243c5dd4510404e06c8186182f4addcd37f849287d1da3c0714

data/.github/workflows/rake.yml

@@ -5,7 +5,6 @@ name: rake
 on:
   push:
     branches: [ master, main ]
-    tags: [ v* ]
   pull_request:
 
 jobs:

data/.github/workflows/release.yml

@@ -0,0 +1,22 @@
+# Auto-generated by Cimas: Do not edit it manually!
+# See https://github.com/metanorma/cimas
+name: release
+
+on:
+  workflow_dispatch:
+    inputs:
+      next_version:
+        description: |
+          Next release version. Possible values: x.y.z, major, minor, patch or pre|rc|etc
+        required: true
+        default: 'skip'
+  push:
+    tags: [ v* ]
+
+jobs:
+  release:
+    uses: relaton/support/.github/workflows/release.yml@master
+    with:
+      next_version: ${{ github.event.inputs.next_version }}
+    secrets:
+      rubygems-api-key: ${{ secrets.RELATON_CI_RUBYGEMS_API_KEY }}

data/README.adoc

@@ -2,7 +2,7 @@
 
 RelatonIana is a Ruby gem that implements the https://github.com/metanorma/metanorma-model-iso#iso-bibliographic-item[IsoBibliographicItem model].
 
-You can use it to retrieve metadata of W3C Standards from https://w3.org, and access such metadata through the `BibliographicItem` object.
+You can use it to retrieve metadata of W3C Standards from https://w3.org, and access such metadata through the `IanaBibliographicItem` object.
 
 == Installation
 
@@ -33,7 +33,7 @@ require 'relaton_iana'
 item = RelatonIana::IanaBibliography.get "IANA service-names-port-numbers" 
 [relaton-iana] ("IANA service-names-port-numbers") fetching...
 [relaton-iana] ("IANA service-names-port-numbers") found IANA service-names-port-numbers
-=> #<RelatonBib::BibliographicItem:0x00007f7c6cc024d0
+=> #<RelatonIana::IanaBibliographicItem:0x00007f7c6cc024d0
 ...
 ----
 
@@ -42,25 +42,13 @@ item = RelatonIana::IanaBibliography.get "IANA service-names-port-numbers"
 [source,ruby]
 ----
 item.to_xml
-=> "<bibitem id="IANAservice-names-port-numbers" type="standard">
-  <fetched>2021-11-24</fetched>
-  <title format="text/plain">Service Name and Transport Protocol Port Number Registry</title>
-  <uri type="src">http://www.iana.org/assignments/service-names-port-numbers</uri>
-  <docidentifier type="IANA">IANA service-names-port-numbers</docidentifier>
-  <docnumber>service-names-port-numbers</docnumber>
-  <date type="updated">
-    <on>2021-11-12</on>
-  </date>
-  <contributor>
-    <role type="publisher"/>
-    <organization>
-      <name>Internet Assigned Numbers Authority</name>
-      <abbreviation>IANA</abbreviation>
-    </organization>
-  </contributor>
-  <language>en</language>
-  <script>Latn</script>
-</bibitem>"
+=> "<bibitem id="IANAservice-names-port-numbers" type="standard" schema-version="v1.2.1">
+      <fetched>2022-12-03</fetched>
+      <title format="text/plain">Service Name and Transport Protocol Port Number Registry</title>
+      <uri type="src">http://www.iana.org/assignments/service-names-port-numbers</uri>
+      <docidentifier type="IANA" primary="true">IANA service-names-port-numbers</docidentifier>
+      ...
+    </bibitem>"
 ----
 
 === Typed links
@@ -79,38 +67,38 @@ item.link.first.content
 === Create bibliographic item from XML
 [source,ruby]
 ----
-RelatonBib::XMLParser.from_xml File.read('spec/fixtures/service-names-port-numbers.xml')
-=> #<RelatonBib::BibliographicItem:0x00007f7c6b837248
+RelatonIana::XMLParser.from_xml File.read('spec/fixtures/auto-response-parameters.xml')
+=> #<RelatonIana::IanaBibliographicItem:0x00007fa5da1bd118
 ...
 ----
 
 === Create bibliographic item from YAML
 [source,ruby]
 ----
-hash = YAML.load_file 'spec/fixtures/service-names-port-numbers.yaml'
-=> {"id"=>"IANAservice-names-port-numbers",
- "title"=>{"content"=>"Service Name and Transport Protocol Port Number Registry", "format"=>"text/plain"},
+YAML.load_file 'spec/fixtures/auto-response-parameters.yaml'
+=> {"schema-version"=>"v1.2.1",
+ "id"=>"IANAauto-response-parameters",
 ...
 
 bib_hash = RelatonIana::HashConverter.hash_to_bib hash
-=> {:id=>"IANAservice-names-port-numbers",
- :title=>{:content=>"Service Name and Transport Protocol Port Number Registry", :format=>"text/plain"},
+=> {:"schema-version"=>"v1.2.1",
+ :id=>"IANAauto-response-parameters",
 ...
 
-RelatonBib::BibliographicItem.new **bib_hash
-=> #<RelatonBib::BibliographicItem:0x007f9381ec6a00
+RelatonIana::IanaBibliographicItem.new **bib_hash
+=> #<RelatonIana::IanaBibliographicItem:0x007f9381ec6a00
 ...
 ----
 
 === Fetch data
 
-There is a IANA dataset https://github.com/ietf-ribose/iana-registries which can be converted into RelatonXML/BibXML/BibYAML formats.
+There is an IANA dataset https://github.com/ietf-ribose/iana-registries which can be converted into RelatonXML/BibXML/BibYAML formats.
 
-The method `RelatonIana::DataFetcher.fetch(output: "data", format: "yaml")` converts all the documents from the dataset and save them to the `./data` folder in YAML format.
+The method `RelatonIana::DataFetcher.fetch(output: "data", format: "yaml")` converts all the documents from the dataset and saves them to the `./data` folder in YAML format.
 Arguments:
 
 - `output` - folder to save documents (default './data').
-- `format` - format in which the documents are saved. Possimle formats are: `yaml`, `xml`, `bibxml` (default `yaml`).
+- `format` - the format in which the documents are saved. Possible formats are: `yaml`, `xml`, `bibxml` (default `yaml`).
 
 [source,ruby]
 ----
@@ -121,9 +109,9 @@ Done in: 155 sec.
 => nil
 ----
 
-This method uses GitHub search API to fetch the documents. The search API has a https://docs.github.com/en/rest/reference/search#rate-limit[rate limitaion] of 30 requests per minute for authenticated users and 10 requests per minute for unauthenticated users. Usually, the rate limit is not reached because the search API is used only for the files list fetching. But if you run the method multiple times in a short period, it is possible that the rate limit will be reached. In this case, the method will wait until the rate limit is reset.
+This method uses GitHub search API to fetch the documents. The search API has a https://docs.github.com/en/rest/reference/search#rate-limit[rate limitaion] of 30 requests per minute for authenticated users and 10 requests per minute for unauthenticated users. Usually, the rate limit is not reached because the search API is used only for the file list fetching. But if you run the method multiple times in a short period, the rate limit may be reached. In this case, the method will wait until the rate limit is reset.
 
-You can use pesonal access token to increase the rate limit. To do this, add your pesonal access token to the `GITHUB_TOKEN` environment variable.
+You can use a personal access token to increase the rate limit. To do this, add your personal access token to the `GITHUB_TOKEN` environment variable.
 
 == Development
 

data/grammars/basicdoc.rng

@@ -1,10 +1,5 @@
 <?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>
   <define name="document">
     <element name="document">
       <optional>
@@ -688,6 +683,9 @@
   </define>
   <define name="underline">
     <element name="underline">
+      <optional>
+        <attribute name="style"/>
+      </optional>
       <zeroOrMore>
         <ref name="PureTextElement"/>
       </zeroOrMore>
@@ -1125,26 +1123,4 @@
       </zeroOrMore>
     </element>
   </define>
-  <define name="ext">
-    <element name="ext">
-      <ref name="BibDataExtensionType"/>
-    </element>
-  </define>
-  <define name="BibDataExtensionType">
-    <ref name="doctype"/>
-  </define>
-  <define name="doctype">
-    <element name="doctype">
-      <ref name="DocumentType"/>
-    </element>
-  </define>
-  <define name="DocumentType">
-    <value>document</value>
-  </define>
-  <define name="BibData">
-    <ref name="BibliographicItem"/>
-    <optional>
-      <ref name="ext"/>
-    </optional>
-  </define>
 </grammar>

data/grammars/biblio-standoc.rng

@@ -0,0 +1,164 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<grammar xmlns="http://relaxng.org/ns/structure/1.0">
+  <!--
+    Add-ons to biblio.rnc for standoc model: defines the extension point BibDataExtensionType
+    of relaton
+    
+    Specialisations as for biblio.rnc. Extension point can be redefined completely for a flavour of standoc
+    (SDO); but other elements in Bibdata can only be extended (more specialised vocabularies for Bibdata)
+  -->
+  <include href="biblio.rng">
+    <define name="BibData">
+      <ref name="BibliographicItem"/>
+      <optional>
+        <ref name="ext"/>
+      </optional>
+    </define>
+  </include>
+  <define name="ext">
+    <element name="ext">
+      <ref name="BibDataExtensionType"/>
+    </element>
+  </define>
+  <define name="BibDataExtensionType">
+    <optional>
+      <attribute name="schema-version"/>
+    </optional>
+    <ref name="doctype"/>
+    <optional>
+      <ref name="docsubtype"/>
+    </optional>
+    <optional>
+      <ref name="editorialgroup"/>
+    </optional>
+    <zeroOrMore>
+      <ref name="ics"/>
+    </zeroOrMore>
+    <zeroOrMore>
+      <ref name="structuredidentifier"/>
+    </zeroOrMore>
+  </define>
+  <define name="doctype">
+    <element name="doctype">
+      <optional>
+        <attribute name="abbreviation"/>
+      </optional>
+      <ref name="DocumentType"/>
+    </element>
+  </define>
+  <define name="DocumentType">
+    <text/>
+  </define>
+  <define name="docsubtype">
+    <element name="subdoctype">
+      <ref name="DocumentSubtype"/>
+    </element>
+  </define>
+  <define name="DocumentSubtype">
+    <text/>
+  </define>
+  <define name="editorialgroup">
+    <element name="editorialgroup">
+      <oneOrMore>
+        <ref name="technical-committee"/>
+      </oneOrMore>
+    </element>
+  </define>
+  <define name="technical-committee">
+    <element name="technical-committee">
+      <ref name="IsoWorkgroup"/>
+    </element>
+  </define>
+  <define name="IsoWorkgroup">
+    <optional>
+      <attribute name="number"/>
+    </optional>
+    <optional>
+      <attribute name="type"/>
+    </optional>
+    <optional>
+      <attribute name="identifier"/>
+    </optional>
+    <optional>
+      <attribute name="prefix"/>
+    </optional>
+    <text/>
+  </define>
+  <define name="ics">
+    <element name="ics">
+      <element name="code">
+        <text/>
+      </element>
+      <optional>
+        <element name="text">
+          <text/>
+        </element>
+      </optional>
+    </element>
+  </define>
+  <define name="structuredidentifier">
+    <element name="structuredidentifier">
+      <optional>
+        <attribute name="type"/>
+      </optional>
+      <oneOrMore>
+        <element name="agency">
+          <text/>
+        </element>
+      </oneOrMore>
+      <optional>
+        <element name="class">
+          <text/>
+        </element>
+      </optional>
+      <element name="docnumber">
+        <text/>
+      </element>
+      <optional>
+        <element name="partnumber">
+          <text/>
+        </element>
+      </optional>
+      <optional>
+        <element name="edition">
+          <text/>
+        </element>
+      </optional>
+      <optional>
+        <element name="version">
+          <text/>
+        </element>
+      </optional>
+      <optional>
+        <element name="supplementtype">
+          <text/>
+        </element>
+      </optional>
+      <optional>
+        <element name="supplementnumber">
+          <text/>
+        </element>
+      </optional>
+      <optional>
+        <element name="amendment">
+          <text/>
+        </element>
+      </optional>
+      <optional>
+        <element name="corrigendum">
+          <text/>
+        </element>
+      </optional>
+      <optional>
+        <element name="language">
+          <text/>
+        </element>
+      </optional>
+      <optional>
+        <element name="year">
+          <text/>
+        </element>
+      </optional>
+    </element>
+  </define>
+</grammar>

data/grammars/biblio.rng

@@ -33,9 +33,10 @@
       <param name="pattern">([\+\-]?\d{4})((-?)((0[1-9]|1[0-2])((-?)([12]\d|0[1-9]|3[01]))?|W([0-4]\d|5[0-2])(-?[1-7])?|(00[1-9]|0[1-9]\d|[12]\d{2}|3([0-5]\d|6[1-6]))))?</param>
     </data>
   </define>
-  <start>
-    <ref name="bibitem"/>
-  </start>
+  <!-- start = bibitem -->
+  <define name="BibData">
+    <ref name="BibliographicItem"/>
+  </define>
   <define name="status">
     <element name="status">
       <ref name="stage"/>
@@ -73,8 +74,14 @@
       <text/>
     </element>
   </define>
-  <define name="script">
+  <define name="locale">
     <a:documentation>ISO-639</a:documentation>
+    <element name="locale">
+      <text/>
+    </element>
+  </define>
+  <define name="script">
+    <a:documentation>ISO-3166</a:documentation>
     <element name="script">
       <text/>
     </element>
@@ -93,6 +100,9 @@
       <!-- multiple languages and scripts possible: comma delimit them if so -->
       <attribute name="language"/>
     </optional>
+    <optional>
+      <attribute name="locale"/>
+    </optional>
     <optional>
       <attribute name="script"/>
     </optional>
@@ -136,6 +146,9 @@
       <!-- multiple languages and scripts possible: comma delimit them if so -->
       <attribute name="language"/>
     </optional>
+    <optional>
+      <attribute name="locale"/>
+    </optional>
     <optional>
       <attribute name="script"/>
     </optional>
@@ -158,27 +171,30 @@
   </define>
   <define name="contributor">
     <element name="contributor">
-      <zeroOrMore>
+      <oneOrMore>
         <ref name="role"/>
-      </zeroOrMore>
+      </oneOrMore>
       <ref name="ContributorInfo"/>
     </element>
   </define>
   <define name="role">
     <element name="role">
-      <optional>
-        <attribute name="type">
-          <choice>
-            <value>author</value>
-            <value>performer</value>
-            <value>publisher</value>
-            <value>editor</value>
-            <value>adapter</value>
-            <value>translator</value>
-            <value>distributor</value>
-          </choice>
-        </attribute>
-      </optional>
+      <attribute name="type">
+        <choice>
+          <value>author</value>
+          <value>performer</value>
+          <value>publisher</value>
+          <value>editor</value>
+          <value>adapter</value>
+          <value>translator</value>
+          <value>distributor</value>
+          <value>realizer</value>
+          <value>owner</value>
+          <value>authorizer</value>
+          <value>enabler</value>
+          <value>subject</value>
+        </choice>
+      </attribute>
       <zeroOrMore>
         <ref name="roledescription"/>
       </zeroOrMore>
@@ -500,6 +516,17 @@
   </define>
   <define name="localityStack">
     <element name="localityStack">
+      <optional>
+        <attribute name="connective">
+          <choice>
+            <value>and</value>
+            <value>or</value>
+            <value>from</value>
+            <value>to</value>
+            <value/>
+          </choice>
+        </attribute>
+      </optional>
       <zeroOrMore>
         <ref name="locality"/>
       </zeroOrMore>
@@ -512,6 +539,17 @@
   </define>
   <define name="sourceLocalityStack">
     <element name="sourceLocalityStack">
+      <optional>
+        <attribute name="connective">
+          <choice>
+            <value>and</value>
+            <value>or</value>
+            <value>from</value>
+            <value>to</value>
+            <value/>
+          </choice>
+        </attribute>
+      </optional>
       <zeroOrMore>
         <ref name="sourceLocality"/>
       </zeroOrMore>
@@ -614,6 +652,9 @@
         <ref name="BibItemType"/>
       </attribute>
     </optional>
+    <optional>
+      <attribute name="schema-version"/>
+    </optional>
     <optional>
       <ref name="fetched"/>
     </optional>
@@ -650,6 +691,9 @@
     <zeroOrMore>
       <ref name="language"/>
     </zeroOrMore>
+    <zeroOrMore>
+      <ref name="locale"/>
+    </zeroOrMore>
     <zeroOrMore>
       <ref name="script"/>
     </zeroOrMore>
@@ -705,6 +749,9 @@
         <ref name="BibItemType"/>
       </attribute>
     </optional>
+    <optional>
+      <attribute name="schema-version"/>
+    </optional>
     <optional>
       <ref name="fetched"/>
     </optional>
@@ -741,6 +788,9 @@
     <zeroOrMore>
       <ref name="language"/>
     </zeroOrMore>
+    <zeroOrMore>
+      <ref name="locale"/>
+    </zeroOrMore>
     <zeroOrMore>
       <ref name="script"/>
     </zeroOrMore>
@@ -854,6 +904,15 @@
     <optional>
       <attribute name="type"/>
     </optional>
+    <optional>
+      <attribute name="language"/>
+    </optional>
+    <optional>
+      <attribute name="locale"/>
+    </optional>
+    <optional>
+      <attribute name="script"/>
+    </optional>
     <data type="anyURI"/>
   </define>
   <define name="DateType">
@@ -882,6 +941,7 @@
       <value>vote-started</value>
       <value>vote-ended</value>
       <value>announced</value>
+      <value>stable-until</value>
     </choice>
   </define>
   <define name="bdate">
@@ -930,6 +990,9 @@
       <optional>
         <attribute name="language"/>
       </optional>
+      <optional>
+        <attribute name="locale"/>
+      </optional>
       <optional>
         <attribute name="script"/>
       </optional>

data/grammars/relaton-iana-compile.rng

@@ -0,0 +1,11 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<grammar xmlns="http://relaxng.org/ns/structure/1.0">
+  <include href="basicdoc.rng"/>
+  <include href="relaton-iana.rng"/>
+  <start>
+    <choice>
+      <ref name="bibitem"/>
+      <ref name="bibdata"/>
+    </choice>
+  </start>
+</grammar>

data/grammars/relaton-iana.rng

@@ -0,0 +1,4 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<grammar xmlns="http://relaxng.org/ns/structure/1.0">
+  <include href="biblio-standoc.rng"/>
+</grammar>

data/lib/relaton_iana/data_fetcher.rb

@@ -92,7 +92,7 @@ module RelatonIana
     #
     # Save document to file
     #
-    # @param [RelatonW3c::W3cBibliographicItem, nil] bib bibliographic item
+    # @param [RelatonIana::IanaBibliographicItem, nil] bib bibliographic item
     #
     def save_doc(bib) # rubocop:disable Metrics/MethodLength
       return unless bib
@@ -114,7 +114,7 @@ module RelatonIana
     #
     # Generate file name
     #
-    # @param [RelatonW3c::W3cBibliographicItem] bib bibliographic item
+    # @param [RelatonIana::IanaBibliographicItem] bib bibliographic item
     #
     # @return [String] file name
     #

data/lib/relaton_iana/hash_converter.rb

@@ -0,0 +1,9 @@
+module RelatonIana
+  class HashConverter < RelatonBib::HashConverter
+    # @param item_hash [Hash]
+    # @return [RelatonIana::IanaBibliographicItem]
+    def self.bib_item(item_hash)
+      IanaBibliographicItem.new(**item_hash)
+    end
+  end
+end

data/lib/relaton_iana/iana_bibliographic_item.rb

@@ -1,5 +1,13 @@
 module RelatonIana
   # IANA Bibliographic Item
   class IanaBibliographicItem < RelatonBib::BibliographicItem
+    #
+    # Fetch flavor schema version
+    #
+    # @return [String] flavor schema version
+    #
+    def ext_schema
+      @ext_schema ||= schema_versions["relaton-model-iana"]
+    end
   end
 end

data/lib/relaton_iana/iana_bibliography.rb

@@ -6,7 +6,7 @@ module RelatonIana
     SOURCE = "https://raw.githubusercontent.com/relaton/relaton-data-iana/main/data/"
 
     # @param text [String]
-    # @return [RelatonBib::BibliographicItem]
+    # @return [RelatonIana::IanaBibliographicItem]
     def search(text) # rubocop:disable Metrics/MethodLength
       file = text.sub(/^IANA\s/, "").gsub(/[\s,:\/]/, "_").downcase
       url = "#{SOURCE}#{file}.yaml"
@@ -14,7 +14,8 @@ module RelatonIana
       return unless resp.code == "200"
 
       hash = YAML.safe_load resp.body
-      RelatonBib::BibliographicItem.from_hash hash
+      hash["fetched"] = Date.today.to_s
+      IanaBibliographicItem.from_hash hash
     rescue SocketError, Timeout::Error, Errno::EINVAL, Errno::ECONNRESET,
            EOFError, Net::HTTPBadResponse, Net::HTTPHeaderSyntaxError,
            Net::ProtocolError, Errno::ETIMEDOUT => e
@@ -24,7 +25,7 @@ module RelatonIana
     # @param ref [String] the W3C standard Code to look up
     # @param year [String, NilClass] not used
     # @param opts [Hash] options
-    # @return [RelatonBib::BibliographicItem]
+    # @return [RelatonIana::IanaBibliographicItem]
     def get(ref, _year = nil, _opts = {})
       warn "[relaton-iana] (\"#{ref}\") fetching..."
       result = search(ref)