relaton-ieee 1.3.0 → 1.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0e0e03b2f85ee56f80bbd4ad30a72d425529341e03f249b3333a4f336d1e920b
-  data.tar.gz: 772e49ae0ddc4a603cab2ba60d89e6f7ad8cff104cf01e3a0631afd5e9ca26d8
+  metadata.gz: 1937aa373837e30e20dc867652fc5b0174a578401884580c3aa4b848f4cece2a
+  data.tar.gz: 86b054738cb15afa9d0f2eaa8a01d1fa8977571159763e2ada75a8188f6bd56c
 SHA512:
-  metadata.gz: a110efa667c5dc009675b1ba87171621aa317ecd649259077fd2d56e79bdfa2c67c8c8874cfb3d7ccb0376f02b007994cbd2afe9cf363ebc38c5acd0041622f4
-  data.tar.gz: e55165748b2625663efefabfc8ecb572c1122137b96525b472430cae40fe017e9376814e3d162d646aacfc63a17f9d02c5626a3a2a2a991a183341f45ed2d6ca
+  metadata.gz: 9af5049b460d91c47a8e882ef6d935725fabb2805a273ea841ea51f801fef311a6b723bedd6d443929bc8b375b47e683972153aba522dab28eea221d2e560b75
+  data.tar.gz: 03776c7931ac6a0e021c8f35b33680ee41747fc54b64569b24dfba24613424201f5b0e5864d056d92e59c8af37f320961ecec02d3c119867ef6e4b4e6b6ce22a

data/.github/workflows/macos.yml

@@ -32,6 +32,8 @@ jobs:
       - name: Update gems
         run: |
           sudo gem install bundler --force
+          ruby -v | grep 2.5 && bundle config set build.debase --with-cflags="-Wno-error=implicit-function-declaration"
+          ruby -v | grep 2.5 && bundle config set build.ruby-debug-ide --with-cflags="-Wno-error=implicit-function-declaration"
           bundle install --jobs 4 --retry 3
       - name: Run specs
         run: |

data/README.adoc

@@ -8,7 +8,7 @@ You can use it to retrieve metadata of IEEE Standards from standards.ieee.org, a
 
 Add this line to your application's Gemfile:
 
-[sourse,ruby]
+[source,ruby]
 ----
 gem 'relaton-ieee'
 ----
@@ -25,35 +25,37 @@ Or install it yourself as:
 
 === Search for a standard using keywords
 
+[source,ruby]
 ----
-> require 'relaton_ieee'
+require 'relaton_ieee'
 => true
 
-> hits = RelatonIeee::IeeeBibliography.search("IEEE 528-2019")
+hits = RelatonIeee::IeeeBibliography.search("IEEE 528-2019")
 => <RelatonIeee::HitCollection:0x007f84c0085308 @ref=IEEE 528-2019 @fetched=false>
 
-> item = hits[0].fetch
+item = hits[0].fetch
  => #<RelatonIeee::IeeeBibliographicItem:0x007f84bf839c30
  ...
 ----
 
 === XML serialization
 
+[source,ruby]
 ----
-> item.to_xml
- => "<bibitem id=\"528-2019\">
+item.to_xml
+ => "<bibitem id="IEEE528-2019">
       <fetched>2020-06-01</fetched>
-      <title type=\"main\" format=\"text/plain\" language=\"en\" script=\"Latn\">528-2019 - IEEE Standard for Inertial Sensor Terminology</title>
-      <uri type=\"src\">https://standards.ieee.org/content/ieee-standards/en/standard/528-2019.html</uri>
-      <docidentifier type=\"IEEE\">528-2019</docidentifier>
-      <date type=\"issued\">
+      <title type="main" format="text/plain" language="en" script="Latn">IEEE 528-2019 - IEEE Standard for Inertial Sensor Terminology</title>
+      <uri type="src">https://standards.ieee.org/content/ieee-standards/en/standard/528-2019.html</uri>
+      <docidentifier type="IEEE">IEEE 528-2019</docidentifier>
+      <date type="issued">
         <on>2019</on>
       </date>
-      <date type=\"published\">
+      <date type="published">
         <on>2019</on>
       </date>
       <contributor>
-        <role type=\"author\"/>
+        <role type="author"/>
         <person>
           <name>
             <completename>Ashley Moran</completename>
@@ -62,7 +64,7 @@ Or install it yourself as:
       </contributor>
       <language>en</language>
       <script>Latn</script>
-      <abstract format=\"text/plain\" language=\"en\" script=\"Latn\">Terms and definitions relating to inertial sensors are presented in this standard. Usage as understood by the inertial sensor community is given preference over general technical usage of the terms herein. The criterion for inclusion of a term and its definition in this standard is usefulness as related to inertial sensor technology.</abstract>
+      <abstract format="text/plain" language="en" script="Latn">Terms and definitions relating to inertial sensors are presented in this standard. Usage as understood by the inertial sensor community is given preference over general technical usage of the terms herein. The criterion for inclusion of a term and its definition in this standard is usefulness as related to inertial sensor technology.</abstract>
       <status>
         <stage>Active</stage>
       </status>
@@ -71,13 +73,14 @@ Or install it yourself as:
 
 With argument `bibdata: true` it ouputs XML wrapped by `bibdata` element and adds flavour `ext` element.
 
+[source,ruby]
 ----
-> item.to_xml bibdata: true
+item.to_xml bibdata: true
  => "<bibdata>
       <fetched>2020-06-01</fetched>
-      <title type="main" format="text/plain" language="en" script="Latn">528-2019 - IEEE Standard for Inertial Sensor Terminology</title>
+      <title type="main" format="text/plain" language="en" script="Latn">IEEE 528-2019 - IEEE Standard for Inertial Sensor Terminology</title>
       <uri type="src">https://standards.ieee.org/content/ieee-standards/en/standard/528-2019.html</uri>
-      <docidentifier type="IEEE">528-2019</docidentifier>
+      <docidentifier type="IEEE">IEEE 528-2019</docidentifier>
       <date type="issued">
         <on>2019</on>
       </date>
@@ -99,7 +102,7 @@ With argument `bibdata: true` it ouputs XML wrapped by `bibdata` element and add
         <stage>Active</stage>
       </status>
       <ext>
-        <committee type="sponsor">
+        <committee type="standard">
           <name>AES/GA - Gyro Accelerometer Panel</name>
         </committee>
         <committee type="working">
@@ -114,20 +117,21 @@ With argument `bibdata: true` it ouputs XML wrapped by `bibdata` element and add
 ----
 
 === Get document by reference
+[source,ruby]
 ----
-> RelatonIeee::IeeeBibliography.get("IEEE 528-2019")
+RelatonIeee::IeeeBibliography.get("IEEE 528-2019")
 [relaton-ieee] ("IEEE 528-2019") fetching...
 [relaton-ieee] ("IEEE 528-2019") found 528-2019
  => #<RelatonIeee::IeeeBibliographicItem:0x007fceb52a6e40
  ...
 
- > RelatonIeee::IeeeBibliography.get("IEEE 528", "2019")
+ RelatonIeee::IeeeBibliography.get("IEEE 528", "2019")
 [relaton-ieee] ("IEEE 528") fetching...
 [relaton-ieee] ("IEEE 528") found 528-2019
  => #<RelatonIeee::IeeeBibliographicItem:0x007fceb54af7f0
  ...
 
- > RelatonIeee::IeeeBibliography.get("IEEE 528")
+ RelatonIeee::IeeeBibliography.get("IEEE 528")
 [relaton-ieee] ("IEEE 528") fetching...
 [relaton-ieee] ("IEEE 528") found 528-2019
 => #<RelatonIeee::IeeeBibliographicItem:0x007fceb512c510
@@ -135,23 +139,25 @@ With argument `bibdata: true` it ouputs XML wrapped by `bibdata` element and add
 ----
 
 === Create bibliographic item from XML
+[source,ruby]
 ----
-> RelatonIeee::XMLParser.from_xml File.read "spec/fixtures/ieee_528_2019.xml"
+RelatonIeee::XMLParser.from_xml File.read "spec/fixtures/ieee_528_2019.xml"
  => #<RelatonIeee::IeeeBibliographicItem:0x007fceb550c978
  ...
 ----
 
 === Create bibliographic item from YAML
+[source,ruby]
 ----
-> hash = YAML.load_file 'spec/fixtures/ieee_528_2019.yaml'
+hash = YAML.load_file 'spec/fixtures/ieee_528_2019.yaml'
  => {"id"=>"528-2019", "title"=>{
  ...
 
- > bib_hash = RelatonIeee::HashConverter.hash_to_bib hash
+ bib_hash = RelatonIeee::HashConverter.hash_to_bib hash
  => {:id=>"528-2019", :title=>[{
  ...
 
- > RelatonIeee::IeeeBibliographicItem.new bib_hash
+ RelatonIeee::IeeeBibliographicItem.new bib_hash
  => #<RelatonIeee::IeeeBibliographicItem:0x007fce940b3eb0
  ...
 ----

data/grammars/isodoc.rng

@@ -43,7 +43,9 @@
     <define name="xref">
       <element name="xref">
         <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 +63,11 @@
             </choice>
           </attribute>
         </optional>
+        <optional>
+          <attribute name="droploc">
+            <data type="boolean"/>
+          </attribute>
+        </optional>
         <text/>
       </element>
     </define>
@@ -578,6 +585,8 @@
             <ref name="ol"/>
             <ref name="dl"/>
             <ref name="formula"/>
+            <ref name="quote"/>
+            <ref name="sourcecode"/>
           </choice>
         </oneOrMore>
       </element>
@@ -661,6 +670,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 +716,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>
@@ -834,6 +863,13 @@
   </define>
   <define name="standard-document">
     <element name="standard-document">
+      <attribute name="version"/>
+      <attribute name="type">
+        <choice>
+          <value>semantic</value>
+          <value>presentation</value>
+        </choice>
+      </attribute>
       <ref name="bibdata"/>
       <optional>
         <ref name="boilerplate"/>
@@ -855,7 +891,7 @@
       <oneOrMore>
         <choice>
           <ref name="content"/>
-          <ref name="preface_abstract"/>
+          <ref name="abstract"/>
           <ref name="foreword"/>
           <ref name="introduction"/>
           <ref name="acknowledgements"/>
@@ -922,6 +958,9 @@
       <optional>
         <attribute name="script"/>
       </optional>
+      <optional>
+        <attribute name="type"/>
+      </optional>
       <optional>
         <attribute name="obligation">
           <choice>
@@ -961,9 +1000,6 @@
   </define>
   <define name="content-subsection">
     <element name="clause">
-      <optional>
-        <attribute name="type"/>
-      </optional>
       <ref name="Content-Section"/>
     </element>
   </define>
@@ -992,6 +1028,9 @@
         </choice>
       </attribute>
     </optional>
+    <optional>
+      <attribute name="type"/>
+    </optional>
     <optional>
       <ref name="section-title"/>
     </optional>
@@ -1011,9 +1050,6 @@
   </define>
   <define name="clause">
     <element name="clause">
-      <optional>
-        <attribute name="type"/>
-      </optional>
       <ref name="Clause-Section"/>
     </element>
   </define>
@@ -1042,18 +1078,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 +1222,9 @@
       <optional>
         <attribute name="script"/>
       </optional>
+      <optional>
+        <attribute name="type"/>
+      </optional>
       <optional>
         <attribute name="obligation">
           <choice>
@@ -1447,11 +1492,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 +1541,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/lib/relaton_ieee/hit_collection.rb

@@ -13,7 +13,7 @@ module RelatonIeee
 
     # @param ref [Strig]
     # @param opts [Hash]
-    def initialize(ref)
+    def initialize(ref) # rubocop:disable Metrics/MethodLength
       super
       code = ref.sub /^IEEE\s/, ""
       search = CGI.escape({ data: { searchTerm: code } }.to_json)
@@ -21,9 +21,9 @@ module RelatonIeee
       resp = Faraday.get url
       resp_json = JSON.parse resp.body
       json = JSON.parse resp_json["message"]
-      @array = json["response"]["searchResults"]["resultsMapList"].
-        reduce([]) do |s, hit|
-          /^(?<id>\d+)-(?<year>\d{4})/ =~ hit["record"]["recordTitle"]
+      @array = json["response"]["searchResults"]["resultsMapList"]
+        .reduce([]) do |s, hit|
+          /^(?:\w+\s)?(?<id>[^-\/]+)(-(?<year>\d{4}))?/ =~ hit["record"]["recordTitle"]
           next s unless id && code =~ %r{^#{id}}
 
           s << Hit.new(hit["record"].merge(code: id, year: year.to_i), self)

data/lib/relaton_ieee/ieee_bibliographic_item.rb

@@ -9,10 +9,13 @@ module RelatonIeee
       super
     end
 
-    # @param builder [Nokogiri::XML::Bilder]
-    # @parma bibdata [TrueClass, FalseClass, NilClass]
-    def to_xml(builder = nil, **opts)
-      super do |bldr|
+    # @param opts [Hash]
+    # @option opts [Nokogiri::XML::Builder] :builder XML builder
+    # @option opts [Boolean] :bibdata
+    # @option opts [String] :lang language
+    # @return [String] XML
+    def to_xml(**opts)
+      super **opts do |bldr|
         if opts[:bibdata] && committee.any?
           bldr.ext do |b|
             committee.each { |c| c.to_xml b }

data/lib/relaton_ieee/scrapper.rb

@@ -18,7 +18,7 @@ module RelatonIeee
           language: ["en"],
           script: ["Latn"],
           date: fetch_date(doc),
-          committee: fetch_committee(doc),
+          committee: fetch_committee(doc)
         )
       end
       # rubocop:enable Metrics/MethodLength, Metrics/AbcSize
@@ -30,7 +30,7 @@ module RelatonIeee
       def fetch_title(title)
         [
           RelatonBib::TypedTitleString.new(
-            type: "main", content: title, language: "en", script: "Latn",
+            type: "main", content: title, language: "en", script: "Latn"
           ),
         ]
       end
@@ -38,7 +38,7 @@ module RelatonIeee
       # @param title [String]
       # @return [Array<RelatonBib::DocumentIdentifier>]
       def fetch_docid(title)
-        /^(?<identifier>\S+)/ =~ title
+        /^(?<identifier>(?:\w+\s)?\S+)/ =~ title
         [RelatonBib::DocumentIdentifier.new(id: identifier, type: "IEEE")]
       end
 
@@ -78,7 +78,7 @@ module RelatonIeee
       # @return [Array<RelatonBib::ContributionInfo>]
       def fetch_contributor(doc)
         name = doc.at(
-          "//td[.='IEEE Program Manager']/following-sibling::td/div/a",
+          "//td[.='IEEE Program Manager']/following-sibling::td/div/a"
         )
         return [] unless name
 
@@ -89,11 +89,11 @@ module RelatonIeee
       # @return [RelatonBib::ContributionInfo]
       def personn_contrib(name)
         fname = RelatonBib::FullName.new(
-          completename: RelatonBib::LocalizedString.new(name),
+          completename: RelatonBib::LocalizedString.new(name)
         )
         entity = RelatonBib::Person.new(name: fname)
         RelatonBib::ContributionInfo.new(
-          entity: entity, role: [type: "author"],
+          entity: entity, role: [type: "author"]
         )
       end
 
@@ -117,8 +117,8 @@ module RelatonIeee
           dates << RelatonBib::BibliographicDate.new(type: "issued",
                                                      on: issued.text)
         end
-        published = doc.at("//td[.='History']/following-sibling::td/div")&.
-          text&.match(/(?<=Published Date:)[\d-]+/)&.to_s
+        published = doc.at("//td[.='History']/following-sibling::td/div")
+          &.text&.match(/(?<=Published Date:)[\d-]+/)&.to_s
         if published
           dates << RelatonBib::BibliographicDate.new(type: "published",
                                                      on: published)
@@ -136,6 +136,10 @@ module RelatonIeee
         if sponsor
           committees << Committee.new(type: "sponsor", name: sponsor.text)
         end
+        sponsor = doc.at "//td[.='Standards Committee']/following-sibling::td/div/a"
+        if sponsor
+          committees << Committee.new(type: "standard", name: sponsor.text)
+        end
         working = doc.at "//td[.='Working Group']/following-sibling::td/div"
         chair = doc.at "//td[.='Working Group Chair']/following-sibling::td/div"
         if working

data/lib/relaton_ieee/version.rb

@@ -1,3 +1,3 @@
 module RelatonIeee
-  VERSION = "1.3.0".freeze
+  VERSION = "1.6.0".freeze
 end

data/relaton_ieee.gemspec

@@ -43,5 +43,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "webmock"
 
   spec.add_dependency "faraday", "~> 1.0.0"
-  spec.add_dependency "relaton-bib", "~> 1.3.0"
+  spec.add_dependency "relaton-bib", "~> 1.6.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: relaton-ieee
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 1.6.0
 platform: ruby
 authors:
 - Ribose Inc.
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-08-21 00:00:00.000000000 Z
+date: 2020-11-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: debase
@@ -142,14 +142,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.3.0
+        version: 1.6.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.3.0
+        version: 1.6.0
 description: 'RelatonIeee: retrieve IEEE Standards for bibliographic use using the
   IeeeBibliographicItem model'
 email:
@@ -193,7 +193,7 @@ licenses:
 metadata:
   homepage_uri: https://github.com/relaton/relaton-ieee
   source_code_uri: https://github.com/relaton/relaton-ieee
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -209,7 +209,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.0.6
-signing_key: 
+signing_key:
 specification_version: 4
 summary: 'RelatonIeee: retrieve IEEE Standards for bibliographic use using the IeeeBibliographicItem
   model'