relaton-iec 1.3.0 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 58bd5350a766064feb49d44f4ae38525bed90d76fb5a774113f1ac42cec2c311
-  data.tar.gz: 375bb57f5a86886a35bb290d0566c78aa934d8b9523bfa371d0c32a1849f37c7
+  metadata.gz: 65fa43b33e0cdb77a7d1a5b1676bcd0faba83a9db12e2783f496720293c7ae27
+  data.tar.gz: d332ff1d57ba0361de302fda88728d8de4ee6db846113a347b3527487ce41240
 SHA512:
-  metadata.gz: e70d23a8f9fb1e234d64af5ac62fce3a80dbab157aa0ea232616b589ff9eb3967c5d078339f8c4e07d01c4923c24d477ed4e7e444ed385db4aef50bfdfc91eb0
-  data.tar.gz: fd87346034a81e6075cbac9fc442515665ea71ff87ab33907f102ab9e3965e77072b4b0ae83fe6b3c3d42d3117782abab194419682530b4c7f8e3672ed20a430
+  metadata.gz: 8353ba28d571539340b1a63847775e1fb7aa3024627e1dc4989d5d6f54ca3b4a78d839a7ff402799aa021fec22e9af88c701271a34ac1b0d0ec449590ad51c66
+  data.tar.gz: 3dda62a896d79eeed6b64fecca9eb45487d7fd430b9c257b1c9c2f414efda8e420ba018ba1613711559d6daec67cf61215e2c105337d11d2f1b3b7f058909aa6

data/README.adoc

@@ -31,7 +31,7 @@ Or install it yourself as:
 
 == Usage
 
-Refer to https://github.com/metanorma/relaton-iso/blob/master/README.adoc: the usage interface is identical.
+Refer to https://github.com/relaton/relaton-iso/blob/master/README.adoc the usage interface is identical.
 
 == Development
 

data/grammars/isodoc.rng

@@ -42,8 +42,11 @@
     </define>
     <define name="xref">
       <element name="xref">
+        <!-- attribute target { xsd:IDREF }, -->
         <attribute name="target">
-          <data type="IDREF"/>
+          <data type="string">
+            <param name="pattern">\i\c*|\c+#\c+</param>
+          </data>
         </attribute>
         <optional>
           <attribute name="type">
@@ -61,6 +64,11 @@
             </choice>
           </attribute>
         </optional>
+        <optional>
+          <attribute name="droploc">
+            <data type="boolean"/>
+          </attribute>
+        </optional>
         <text/>
       </element>
     </define>
@@ -578,6 +586,8 @@
             <ref name="ol"/>
             <ref name="dl"/>
             <ref name="formula"/>
+            <ref name="quote"/>
+            <ref name="sourcecode"/>
           </choice>
         </oneOrMore>
       </element>
@@ -661,6 +671,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>
             <choice>
@@ -697,6 +717,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>
             <choice>
@@ -855,7 +885,7 @@
       <oneOrMore>
         <choice>
           <ref name="content"/>
-          <ref name="preface_abstract"/>
+          <ref name="abstract"/>
           <ref name="foreword"/>
           <ref name="introduction"/>
           <ref name="acknowledgements"/>
@@ -922,6 +952,9 @@
       <optional>
         <attribute name="script"/>
       </optional>
+      <optional>
+        <attribute name="type"/>
+      </optional>
       <optional>
         <attribute name="obligation">
           <choice>
@@ -961,9 +994,6 @@
   </define>
   <define name="content-subsection">
     <element name="clause">
-      <optional>
-        <attribute name="type"/>
-      </optional>
       <ref name="Content-Section"/>
     </element>
   </define>
@@ -992,6 +1022,9 @@
         </choice>
       </attribute>
     </optional>
+    <optional>
+      <attribute name="type"/>
+    </optional>
     <optional>
       <ref name="section-title"/>
     </optional>
@@ -1011,9 +1044,6 @@
   </define>
   <define name="clause">
     <element name="clause">
-      <optional>
-        <attribute name="type"/>
-      </optional>
       <ref name="Clause-Section"/>
     </element>
   </define>
@@ -1042,18 +1072,24 @@
         </choice>
       </attribute>
     </optional>
+    <optional>
+      <attribute name="type"/>
+    </optional>
     <optional>
       <ref name="section-title"/>
     </optional>
     <group>
-      <group>
-        <zeroOrMore>
-          <ref name="BasicBlock"/>
-        </zeroOrMore>
-        <zeroOrMore>
-          <ref name="note"/>
-        </zeroOrMore>
-      </group>
+      <choice>
+        <group>
+          <zeroOrMore>
+            <ref name="BasicBlock"/>
+          </zeroOrMore>
+          <zeroOrMore>
+            <ref name="note"/>
+          </zeroOrMore>
+        </group>
+        <ref name="amend"/>
+      </choice>
       <zeroOrMore>
         <choice>
           <ref name="clause-subsection"/>
@@ -1180,6 +1216,9 @@
       <optional>
         <attribute name="script"/>
       </optional>
+      <optional>
+        <attribute name="type"/>
+      </optional>
       <optional>
         <attribute name="obligation">
           <choice>
@@ -1447,11 +1486,6 @@
       </optional>
     </element>
   </define>
-  <define name="preface_abstract">
-    <element name="abstract">
-      <ref name="Basic-Section"/>
-    </element>
-  </define>
   <define name="term-clause">
     <element name="clause">
       <optional>
@@ -1501,4 +1535,79 @@
       <ref name="CitationType"/>
     </element>
   </define>
+  <define name="amend">
+    <element name="amend">
+      <optional>
+        <attribute name="id">
+          <data type="ID"/>
+        </attribute>
+      </optional>
+      <attribute name="change">
+        <choice>
+          <value>add</value>
+          <value>modify</value>
+          <value>delete</value>
+        </choice>
+      </attribute>
+      <optional>
+        <attribute name="path"/>
+      </optional>
+      <optional>
+        <attribute name="path_end"/>
+      </optional>
+      <optional>
+        <attribute name="title"/>
+      </optional>
+      <optional>
+        <element name="location">
+          <zeroOrMore>
+            <ref name="locality"/>
+          </zeroOrMore>
+        </element>
+      </optional>
+      <zeroOrMore>
+        <ref name="autonumber"/>
+      </zeroOrMore>
+      <optional>
+        <element name="description">
+          <zeroOrMore>
+            <ref name="BasicBlock"/>
+          </zeroOrMore>
+        </element>
+      </optional>
+      <optional>
+        <element name="newcontent">
+          <zeroOrMore>
+            <ref name="BasicBlock"/>
+          </zeroOrMore>
+        </element>
+      </optional>
+      <optional>
+        <element name="description">
+          <zeroOrMore>
+            <ref name="BasicBlock"/>
+          </zeroOrMore>
+        </element>
+      </optional>
+    </element>
+  </define>
+  <define name="autonumber">
+    <element name="autonumber">
+      <attribute name="type">
+        <choice>
+          <value>requirement</value>
+          <value>recommendation</value>
+          <value>permission</value>
+          <value>table</value>
+          <value>figure</value>
+          <value>admonition</value>
+          <value>formula</value>
+          <value>sourcecode</value>
+          <value>example</value>
+          <value>note</value>
+        </choice>
+      </attribute>
+      <text/>
+    </element>
+  </define>
 </grammar>

data/grammars/isostandard.rng

@@ -253,7 +253,7 @@
     <define name="preface">
       <element name="preface">
         <optional>
-          <ref name="preface_abstract"/>
+          <ref name="abstract"/>
         </optional>
         <ref name="foreword"/>
         <optional>

data/lib/relaton_iec/iec_bibliography.rb

@@ -22,7 +22,7 @@ module RelatonIec
       # @param opts [Hash] options; restricted to :all_parts if all-parts
       #   reference is required
       # @return [String] Relaton XML serialisation of reference
-      def get(code, year = nil, opts = {})
+      def get(code, year = nil, opts = {}) # rubocop:disable Metrics/AbcSize,Metrics/CyclomaticComplexity,Metrics/MethodLength,Metrics/PerceivedComplexity
         if year.nil?
           /^(?<code1>[^:]+):(?<year1>[^:]+)/ =~ code
           unless code1.nil?
@@ -45,27 +45,33 @@ module RelatonIec
 
       private
 
-      def fetch_ref_err(code, year, missed_years)
+      def fetch_ref_err(code, year, missed_years) # rubocop:disable Metrics/MethodLength
         id = year ? "#{code}:#{year}" : code
         warn "[relaton-iec] WARNING: no match found online for #{id}. "\
           "The code must be exactly like it is on the standards website."
-        warn "[relaton-iec] (There was no match for #{year}, though there were matches "\
-          "found for #{missed_years.join(', ')}.)" unless missed_years.empty?
-        if /\d-\d/ =~ code
-          warn "[relaton-iec] The provided document part may not exist, or the document "\
-            "may no longer be published in parts."
+        unless missed_years.empty?
+          warn "[relaton-iec] (There was no match for #{year}, though there "\
+            "were matches found for #{missed_years.join(', ')}.)"
+        end
+        if /\d-\d/.match? code
+          warn "[relaton-iec] The provided document part may not exist, or "\
+            "the document may no longer be published in parts."
         else
-          warn "[relaton-iec] If you wanted to cite all document parts for the reference, "\
-            "use \"#{code} (all parts)\".\nIf the document is not a standard, "\
-            "use its document type abbreviation (TS, TR, PAS, Guide)."
+          warn "[relaton-iec] If you wanted to cite all document parts for "\
+            "the reference, use \"#{code} (all parts)\".\nIf the document is "\
+            "not a standard, use its document type abbreviation (TS, TR, PAS, "\
+            "Guide)."
         end
         nil
       end
 
-      def fetch_pages(s, n)
-        workers = RelatonBib::WorkersPool.new n
+      # @param hits [Array<RelatonIec::Hit>]
+      # @param threads [Integer]
+      # @return [Array<RelatonIec::Hit>]
+      def fetch_pages(hits, threads)
+        workers = RelatonBib::WorkersPool.new threads
         workers.worker { |w| { i: w[:i], hit: w[:hit].fetch } }
-        s.each_with_index { |hit, i| workers << { i: i, hit: hit } }
+        hits.each_with_index { |hit, i| workers << { i: i, hit: hit } }
         workers.end
         workers.result.sort_by { |a| a[:i] }.map { |x| x[:hit] }
       end
@@ -83,45 +89,47 @@ module RelatonIec
       end
 
       def iev(code = "IEC 60050")
-        RelatonIsoBib::XMLParser.from_xml(<<~"END")
-<bibitem>
-  <fetched>#{Date.today}</fetched>
-  <title format="text/plain" language="en" script="Latn">International Electrotechnical Vocabulary</title>
-  <link type="src">http://www.electropedia.org</link>
-  <docidentifier>#{code}:2011</docidentifier>
-  <date type="published"><on>2011</on></date>
-  <contributor>
-    <role type="publisher"/>
-    <organization>
-      <name>International Electrotechnical Commission</name>
-      <abbreviation>IEC</abbreviation>
-      <uri>www.iec.ch</uri>
-    </organization>
-  </contributor>
-  <language>en</language> <language>fr</language>
-  <script>Latn</script>
-  <status> <stage>60</stage> </status>
-  <copyright>
-    <from>2018</from>
-    <owner>
-      <organization>
-      <name>International Electrotechnical Commission</name>
-      <abbreviation>IEC</abbreviation>
-      <uri>www.iec.ch</uri>
-      </organization>
-    </owner>
-  </copyright>
-</bibitem>
-        END
+        RelatonIsoBib::XMLParser.from_xml(<<~"XML")
+          <bibitem>
+            <fetched>#{Date.today}</fetched>
+            <title format="text/plain" language="en" script="Latn">International Electrotechnical Vocabulary</title>
+            <link type="src">http://www.electropedia.org</link>
+            <docidentifier>#{code}:2011</docidentifier>
+            <date type="published"><on>2011</on></date>
+            <contributor>
+              <role type="publisher"/>
+              <organization>
+                <name>International Electrotechnical Commission</name>
+                <abbreviation>IEC</abbreviation>
+                <uri>www.iec.ch</uri>
+              </organization>
+            </contributor>
+            <language>en</language> <language>fr</language>
+            <script>Latn</script>
+            <status> <stage>60</stage> </status>
+            <copyright>
+              <from>2018</from>
+              <owner>
+                <organization>
+                <name>International Electrotechnical Commission</name>
+                <abbreviation>IEC</abbreviation>
+                <uri>www.iec.ch</uri>
+                </organization>
+              </owner>
+            </copyright>
+          </bibitem>
+        XML
       end
 
       # Sort through the results from Isobib, fetching them three at a time,
       # and return the first result that matches the code,
-      # matches the year (if provided), and which # has a title (amendments do not).
+      # matches the year (if provided), and which
+      # has a title (amendments do not).
       # Only expects the first page of results to be populated.
       # Does not match corrigenda etc (e.g. ISO 3166-1:2006/Cor 1:2007)
-      # If no match, returns any years which caused mismatch, for error reporting
-      def isobib_results_filter(result, year)
+      # If no match, returns any years which caused mismatch, for error
+      # reporting
+      def isobib_results_filter(result, year) # rubocop:disable Metrics/AbcSize,Metrics/CyclomaticComplexity,Metrics/MethodLength
         missed_years = []
         result.each_slice(3) do |s| # ISO website only allows 3 connections
           fetch_pages(s, 3).each_with_index do |r, _i|
@@ -143,7 +151,8 @@ module RelatonIec
         result = isobib_search_filter(code) || return
         ret = isobib_results_filter(result, year)
         if ret[:ret]
-          warn "[relaton-iec] (\"#{code}\") found #{ret[:ret].docidentifier.first.id}"
+          warn "[relaton-iec] (\"#{code}\") found "\
+          "#{ret[:ret].docidentifier.first.id}"
           ret[:ret]
         else
           fetch_ref_err(code, year, ret[:years])

data/lib/relaton_iec/scrapper.rb

@@ -29,21 +29,21 @@ module RelatonIec
       # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
 
       # Parse page.
-      # @param hit [Hash]
+      # @param hit_data [Hash]
       # @return [Hash]
       def parse_page(hit_data)
         doc = get_page hit_data[:url]
 
         # Fetch edition.
         edition = doc.at(
-          "//th[contains(., 'Edition')]/following-sibling::td/span",
+          "//th[contains(., 'Edition')]/following-sibling::td/span"
         ).text
 
         status, relations = fetch_status_relations hit_data[:url]
 
         IecBibliographicItem.new(
           fetched: Date.today.to_s,
-          docid: [RelatonBib::DocumentIdentifier.new(id: hit_data[:code], type: "IEC")],
+          docid: fetch_docid(hit_data),
           structuredidentifier: fetch_structuredidentifier(doc),
           edition: edition,
           language: ["en"],
@@ -59,13 +59,48 @@ module RelatonIec
           copyright: fetch_copyright(hit_data[:code], doc),
           link: fetch_link(doc, hit_data[:url]),
           relation: relations,
-          place: ["Geneva"],
+          place: ["Geneva"]
         )
       end
       # rubocop:enable Metrics/AbcSize, Metrics/MethodLength
 
       private
 
+      # @param hit [Hash]
+      # @return [Array<RelatonBib::DocumentIdentifier>]
+      def fetch_docid(hit)
+        rest = hit[:code].downcase.sub(%r{
+          (?<head>[^\s]+)\s
+          (?<type>is|ts|tr|pas|srd|guide|tec|wp)?(?(<type>)\s)
+          (?<pnum>[\d-]+)\s?
+          (?<_dd>:)?(?(<_dd>)(?<date>[\d-]+)\s?)
+        }x, "")
+        m = $~
+        deliv = /cmv|csv|exv|prv|rlv|ser/.match(hit[:code].downcase).to_s
+        urn = ["urn", "iec", "std", m[:head].split("/").join("-"), m[:pnum],
+               m[:date], m[:type], deliv, "en"]
+        urn += fetch_ajunct(rest)
+        [
+          RelatonBib::DocumentIdentifier.new(id: hit[:code], type: "IEC"),
+          RelatonBib::DocumentIdentifier.new(id: urn.join(":"), type: "URN"),
+        ]
+      end
+
+      # @param rest [String]
+      # @return [Array<String, nil>]
+      def fetch_ajunct(rest)
+        r = rest.sub(%r{
+          (?<_pl>\+)(?(<_pl>)(?<adjunct>amd)(?<adjnum>\d+)\s?)
+          (?<_d2>:)?(?(<_d2>)(?<adjdt>[\d-]+)\s?)
+        }x, "")
+        m = $~ || {}
+        return [] unless m[:adjunct]
+
+        plus = m[:adjunct] && "plus"
+        urn = [plus, m[:adjunct], m[:adjnum], m[:adjdt]]
+        urn + fetch_ajunct(r)
+      end
+
       # Fetch abstracts.
       # @param doc [Nokigiri::HTML::Document]
       # @return [Array<Array>]
@@ -111,12 +146,12 @@ module RelatonIec
         item_ref = doc.at("//span[@itemprop='productID']")
         unless item_ref
           return RelatonIsoBib::StructuredIdentifier.new(
-            project_number: "?", part_number: "", prefix: nil, id: "?",
+            project_number: "?", part_number: "", prefix: nil, id: "?"
           )
         end
 
         m = item_ref.text.match(
-          /(?<=\s)(?<project>\d+)-?(?<part>(?<=-)\d+|)-?(?<subpart>(?<=-)\d+|)/,
+          /(?<=\s)(?<project>\d+)-?(?<part>(?<=-)\d+|)-?(?<subpart>(?<=-)\d+|)/
         )
         RelatonIsoBib::StructuredIdentifier.new(
           project_number: m[:project],
@@ -124,7 +159,7 @@ module RelatonIec
           subpart_number: m[:subpart],
           prefix: nil,
           type: "IEC",
-          id: item_ref.text,
+          id: item_ref.text
         )
       end
 
@@ -168,8 +203,8 @@ module RelatonIec
       # @return [Array<Hash>]
       # rubocop:disable Metrics/MethodLength
       def fetch_relations(doc)
-        doc.xpath('//ROW[STATUS[.!="PREPARING"]][STATUS[.!="PUBLISHED"]]').
-          map do |r|
+        doc.xpath('//ROW[STATUS[.!="PREPARING"]][STATUS[.!="PUBLISHED"]]')
+          .map do |r|
           r_type = r.at("STATUS").text.downcase
           type = case r_type
                  # when 'published' then 'obsoletes' # Valid
@@ -178,7 +213,7 @@ module RelatonIec
                  else r_type
                  end
           fref = RelatonBib::FormattedRef.new(
-            content: r.at("FULL_NAME").text, format: "text/plain",
+            content: r.at("FULL_NAME").text, format: "text/plain"
           )
           bibitem = IecBibliographicItem.new(formattedref: fref)
           { type: type, bibitem: bibitem }
@@ -203,7 +238,7 @@ module RelatonIec
       # @return [String]
       def fetch_type(doc)
         doc.at(
-          '//th[contains(., "Publication type")]/following-sibling::td/span',
+          '//th[contains(., "Publication type")]/following-sibling::td/span'
         ).text.downcase.tr " ", "-"
       end
 
@@ -249,7 +284,7 @@ module RelatonIec
       # @return [Array<Hash>]
       def fetch_ics(doc)
         doc.xpath(
-          '//th[contains(text(), "ICS")]/following-sibling::td/a',
+          '//th[contains(text(), "ICS")]/following-sibling::td/a'
         ).map do |i|
           code = i.text.match(/[\d\.]+/).to_s.split "."
           { field: code[0], group: code[1], subgroup: code[2] }
@@ -281,8 +316,8 @@ module RelatonIec
         end
         from = code.match(/(?<=:)\d{4}/).to_s
         if from.empty?
-          from = doc.xpath("//span[@itemprop='releaseDate']").text.
-            match(/\d{4}/).to_s
+          from = doc.xpath("//span[@itemprop='releaseDate']").text
+            .match(/\d{4}/).to_s
         end
         [{
           owner: [{ name: name, abbreviation: abbreviation, url: url }],

data/lib/relaton_iec/version.rb

@@ -1,3 +1,3 @@
 module RelatonIec
-  VERSION = "1.3.0".freeze
+  VERSION = "1.4.0".freeze
 end

data/relaton_iec.gemspec

@@ -35,5 +35,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "webmock"
 
   spec.add_dependency "addressable"
-  spec.add_dependency "relaton-iso-bib", "~> 1.3.0"
+  spec.add_dependency "relaton-iso-bib", "~> 1.4.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: relaton-iec
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 1.4.0
 platform: ruby
 authors:
 - Ribose Inc.
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-08-20 00:00:00.000000000 Z
+date: 2020-09-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: debase
@@ -170,14 +170,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.3.0
+        version: 1.4.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.3.0
+        version: 1.4.0
 description: 'RelatonIec: retrieve IEC Standards for bibliographic use using the IecBibliographicItem
   model'
 email:
@@ -220,7 +220,7 @@ homepage: https://github.com/metanorma/relaton-iec
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -236,7 +236,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.0.6
-signing_key: 
+signing_key:
 specification_version: 4
 summary: 'RelatonIec: retrieve IEC Standards for bibliographic use using the IecBibliographicItem
   model'