relaton-iho 1.3.2 → 1.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7898af6b5b9c984bcb5888c925df80918f797b3ded43f86ad41e749ebd45b50b
-  data.tar.gz: b1af3d18334b55e941c18c79cf6e3b060b1ac3ecc6c2f0a82757bf4c0e5df05d
+  metadata.gz: e8d151683ce6fe8bff93b6cc28a70324c4c69a8352cdfb71288f5ce8e596fed7
+  data.tar.gz: e0d3504f2ac5a4b179e704bae5387db2db153f91d9d476739c5cbede50cced8f
 SHA512:
-  metadata.gz: 4eb5ce96479f46296bd0c67294d06e1efb646296051ed4e013ba3ce42eddeaa1ba081a0fce26787d02c3fe4157263d29cc0c81adc4150e8214b7d807f6c95de9
-  data.tar.gz: d840e8461f613ba954bba1719519d7df704ef73e18cfaeb75648a3216893146f67256296b91e8e7046be7968d2d373581be3366d725255ccc584ee586dd737fb
+  metadata.gz: 6a240acc120cb59c70bfa6e51191d901055592fefb04ea280160c749ea60d65f0de1449e8a62498ba9eab1784ae26903895f7574968d87f3362d23cad991ad4c
+  data.tar.gz: b20879fb27f85a8abdf6448c0334daa70ff3de5b785f5f4d3f678440e04a0a33662500beda3f8246cc6ad9f5d3eb0679a3293943f41e2bc9a5b132c7ed208a0c

data/.github/workflows/macos.yml

@@ -26,6 +26,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

@@ -32,7 +32,7 @@ Or install it yourself as:
 
 [source,sh]
 ----
-$ gem install relaton_iho
+$ gem install relaton-iho
 ----
 
 == Usage
@@ -41,11 +41,13 @@ $ gem install relaton_iho
 
 [source,ruby]
 ----
-hits = RelatonIho::IhoBibliography.search("OGC 19-025r1")
-=> [<RelatonIho::Hit:0x007fcab6b9aab8 @text="OGC 19-025r1" @fetched="false" @fullIdentifier="" @title="">]
+pry(main)> require 'relaton_iho'
+=> true
 
-tem = hits[0].fetch
-=> #<RelatonIho::IhoBibliographicItem:0x007fcab3cb4758
+item = RelatonIho::IhoBibliography.search("B-11")
+[relaton-iho] ("B-11") fetching...
+[relaton-iho] ("B-11") found B-11
+=> #<RelatonIho::IhoBibliographicItem:0x007fe74fc80800
 ...
 ----
 
@@ -53,14 +55,12 @@ tem = hits[0].fetch
 [source,ruby]
 ----
 item.to_xml
-=> "<bibitem id="19-025r1" type="standard">
-      <title type="title-main" format="text/plain" language="en" script="Latn">Development of Spatial Data Infrastructures for Marine Data Management</title>
-      <title type="main" format="text/plain" language="en" script="Latn">Development of Spatial Data Infrastructures for Marine Data Management</title>
-      <uri type="obp">https://portal.opengeospatial.org/files/?artifact_id=88037</uri>
-      <docidentifier type="OGC">19-025r1</docidentifier>
-      <date type="published">
-        <on>2019</on>
-      </date>
+=> "<bibitem id="B-11" type="standard">
+      <fetched>2020-03-29</fetched>
+      <title type="main" format="text/plain" language="en">IHO-IOC GEBCO Cook Book</title>
+      <title type="main" format="text/plain" language="fr">Livre de recettes GEBCO OHI-COI</title>
+      <uri type="pdf">https://www.star.nesdis.noaa.gov/socd/lsa/GEBCO_Cookbook/documents/CookBook_20191031.pdf</uri>
+      <docidentifier type="IHO">B-11</docidentifier>
       ...
     </bibitem>"
 ----
@@ -69,33 +69,45 @@ With argument `bibdata: true` it ouputs XML wrapped by `bibdata` element and add
 ----
 item.to_xml bibdata: true
 => "<bibdata type="standard">
-      <title type="title-main" format="text/plain" language="en" script="Latn">Development of Spatial Data Infrastructures for Marine Data Management</title>
-      <title type="main" format="text/plain" language="en" script="Latn">Development of Spatial Data Infrastructures for Marine Data Management</title>
-      <uri type="obp">https://portal.opengeospatial.org/files/?artifact_id=88037</uri>
-      <docidentifier type="OGC">19-025r1</docidentifier>
-      <date type="published\">
-        <on>2019</on>
-      </date>
+      <fetched>2020-03-29</fetched>
+      <title type="main" format="text/plain" language="en">IHO-IOC GEBCO Cook Book</title>
+      <title type="main" format="text/plain" language="fr">Livre de recettes GEBCO OHI-COI</title>
+      <uri type="pdf">https://www.star.nesdis.noaa.gov/socd/lsa/GEBCO_Cookbook/documents/CookBook_20191031.pdf</uri>
+      <docidentifier type="IHO">B-11</docidentifier>
       ...
       <ext>
-        <doctype>public-engineering-report</doctype>
+        <editorialgroup>
+      <committee>
+        <name>Hydrographic Services and Standards Committee</name>
+        <abbreviation>HSSC</abbreviation>
+      </committee>
+      <committee>
+        <name>Inter-Regional Coordination Committee</name>
+        <abbreviation>IRCC</abbreviation>
+        <committee>
+          <name>JOINT IHO-IOC GUIDING COMMITTEE FOR THE GENERAL BATHYMETRIC CHART OF THE OCEANS</name>
+          <abbreviation>GEBCO</abbreviation>
+        </committee>
+      </committee>
+    </editorialgroup>
       </ext>
     </bibdata>"
 ----
 
-=== Get code, and year
+=== Get code
 [source,ruby]
 ----
-RelatonIho::IhoBibliography.get "OGC 19-025r1", "2019", {}
-fetching OGC 19-025r1...
-=> #<RelatonIho::IhoBibliographicItem:0x007fc322e9aba0
+RelatonIho::IhoBibliography.get "IHO B-11"
+[relaton-iho] ("IHO B-11") fetching...
+[relaton-iho] ("IHO B-11") found B-11
+=> #<RelatonIho::IhoBibliographicItem:0x007fe78dbb7c78
 ...
 ----
 
 === Create bibliographic item from XML
 [source,ruby]
 ----
-RelatonIho::XMLParser.from_xml File.read('spec/fixtures/ogc_bib_item.xml')
+RelatonIho::XMLParser.from_xml File.read('spec/fixtures/iho.xml')
 => #<RelatonIho::IhoBibliographicItem:0x007fc322ea82c8
 ...
 ----
@@ -103,12 +115,12 @@ RelatonIho::XMLParser.from_xml File.read('spec/fixtures/ogc_bib_item.xml')
 === Create bibliographic item from YAML
 [source,ruby]
 ----
-hash = YAML.load_file 'spec/fixtures/ogc_bib_item.yml'
-=> {"id"=>"19-025r1",
+hash = YAML.load_file 'spec/fixtures/iho.yaml'
+=> {"id"=>"B-11",
 ...
 
 bib_hash = RelatonIho::HashConverter.hash_to_bib hash
-=> {:id=>"19-025r1",
+=> {:id=>"B-11",
 ...
 
 RelatonIho::IhoBibliographicItem.new bib_hash

data/grammars/iho.rng

@@ -148,6 +148,13 @@
   </define>
   <define name="iho-standard">
     <element name="iho-standard">
+      <attribute name="version"/>
+      <attribute name="type">
+        <choice>
+          <value>semantic</value>
+          <value>presentation</value>
+        </choice>
+      </attribute>
       <ref name="bibdata"/>
       <zeroOrMore>
         <ref name="termdocsource"/>

data/grammars/isodoc.rng

@@ -42,7 +42,6 @@
     </define>
     <define name="xref">
       <element name="xref">
-        <!-- attribute target { xsd:IDREF }, -->
         <attribute name="target">
           <data type="string">
             <param name="pattern">\i\c*|\c+#\c+</param>
@@ -64,6 +63,11 @@
             </choice>
           </attribute>
         </optional>
+        <optional>
+          <attribute name="droploc">
+            <data type="boolean"/>
+          </attribute>
+        </optional>
         <text/>
       </element>
     </define>
@@ -581,6 +585,8 @@
             <ref name="ol"/>
             <ref name="dl"/>
             <ref name="formula"/>
+            <ref name="quote"/>
+            <ref name="sourcecode"/>
           </choice>
         </oneOrMore>
       </element>
@@ -664,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>
@@ -700,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>
@@ -837,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"/>
@@ -858,7 +891,7 @@
       <oneOrMore>
         <choice>
           <ref name="content"/>
-          <ref name="preface_abstract"/>
+          <ref name="abstract"/>
           <ref name="foreword"/>
           <ref name="introduction"/>
           <ref name="acknowledgements"/>
@@ -1052,14 +1085,17 @@
       <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"/>
@@ -1456,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>
@@ -1510,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_iho/hash_converter.rb

@@ -15,6 +15,12 @@ module RelatonIho
 
       private
 
+      # @param item_hash [Hash]
+      # @return [RelatonBib::BibliographicItem]
+      def bib_item(item_hash)
+        IhoBibliographicItem.new item_hash
+      end
+
       # @param ret [Hash]
       def commentperiod_hash_to_bib(ret)
         ret[:commentperiod] &&= CommentPeriond.new(ret[:commentperiod])

data/lib/relaton_iho/iho_bibliographic_item.rb

@@ -13,11 +13,13 @@ module RelatonIho
       super
     end
 
-    # @param builder [Nokogiri::XML::Builder]
-    # @param bibdata [TrueClasss, FalseClass, NilClass]
-    def to_xml(builer = nil, **opts) # rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/MethodLength, Metrics/PerceivedComplexity
-      opts[:ext] = !commentperiod.nil?
-      super do |b|
+    # @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) # rubocop:disable Metrics/AbcSize,Metrics/CyclomaticComplexity,Metrics/MethodLength,Metrics/PerceivedComplexity
+      super ext: !commentperiod.nil?, **opts do |b|
         if opts[:bibdata] && (doctype || editorialgroup&.presence? ||
                               ics.any? || commentperiod)
           b.ext do

data/lib/relaton_iho/iho_bibliography.rb

@@ -10,7 +10,7 @@ module RelatonIho
       # @return [RelatonIho::IhoBibliographicItem]
       def search(text, _year = nil, _opts = {}) # rubocop:disable Metrics/MethodLength, Metrics/AbcSize
         warn "[relaton-iho] (\"#{text}\") fetching..."
-        ref = text.sub(/^IHO\s/, "").downcase
+        ref = text.sub(/^IHO\s/, "").downcase.sub /^([[:alpha:]]+)(\d+)/, '\1-\2'
         uri = URI("#{ENDPOINT}#{ref}.yaml")
         resp = Net::HTTP.get_response uri
         return unless resp.code == "200"
@@ -21,7 +21,7 @@ module RelatonIho
         item
       rescue SocketError, Errno::EINVAL, Errno::ECONNRESET, EOFError,
              Net::HTTPBadResponse, Net::HTTPHeaderSyntaxError,
-             Net::ProtocolError, Net::ReadTimeout, OpenSSL::SSL::SSLError,
+             Net::ProtocolError, Net::ReadTimeout, # OpenSSL::SSL::SSLError,
              Errno::ETIMEDOUT => e
         raise RelatonBib::RequestError, "Could not access #{uri}: #{e.message}"
       end

data/lib/relaton_iho/processor.rb

@@ -35,7 +35,7 @@ module RelatonIho
     # Returns hash of XML grammar
     # @return [String]
     def grammar_hash
-      @grammar_hash ||= ::RelatonIeee.grammar_hash
+      @grammar_hash ||= ::RelatonIho.grammar_hash
     end
   end
 end

data/lib/relaton_iho/version.rb

@@ -1,3 +1,3 @@
 module RelatonIho
-  VERSION = "1.3.2".freeze
+  VERSION = "1.6.0".freeze
 end

data/relaton_iho.gemspec

@@ -32,5 +32,5 @@ Gem::Specification.new do |s|
   s.add_development_dependency "vcr"
   s.add_development_dependency "webmock"
 
-  s.add_dependency "relaton-bib", "~> 1.3.0"
+  s.add_dependency "relaton-bib", "~> 1.6.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: relaton-iho
 version: !ruby/object:Gem::Version
-  version: 1.3.2
+  version: 1.6.0
 platform: ruby
 authors:
 - Ribose Inc.
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-09-02 00:00:00.000000000 Z
+date: 2020-11-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: byebug
@@ -156,14 +156,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: 'RelatonIho: retrieve IHO Standards for bibliographic using the BibliographicItem
   model'
 email:
@@ -192,7 +192,6 @@ files:
 - lib/relaton_iho/editorial_group.rb
 - lib/relaton_iho/eg.yml
 - lib/relaton_iho/hash_converter.rb
-- lib/relaton_iho/hit_collection.rb
 - lib/relaton_iho/iho_bibliographic_item.rb
 - lib/relaton_iho/iho_bibliography.rb
 - lib/relaton_iho/iho_group.rb

data/lib/relaton_iho/hit_collection.rb

@@ -1,73 +0,0 @@
-require "faraday"
-require "yaml"
-require "fileutils"
-
-module RelatonIho
-  class HitCollection < RelatonBib::HitCollection
-    ENDPOINT = "https://raw.githubusercontent.com/relaton/relaton-data-iho/master/data/".freeze
-
-    # @param ref [Strig]
-    # @param year [String]
-    # @param opts [Hash]
-    def initialize(ref, year = nil)
-      super
-      @array = from_yaml(ref).sort_by do |hit|
-        hit.hit["revdate"] ? Date.parse(hit.hit["revdate"]) : Date.new
-      end.reverse
-    end
-
-    private
-
-    #
-    # Fetch data form yaml
-    #
-    # @param docid [String]
-    def from_yaml(docid, **_opts)
-      data["root"]["items"].select do |doc|
-        doc["docid"] && doc["docid"]["id"].include?(docid)
-      end.map { |h| Hit.new(h, self) }
-    end
-
-    #
-    # Fetches YAML data
-    #
-    # @return [Hash]
-    def data
-      FileUtils.mkdir_p DATADIR
-      ctime = File.ctime DATAFILE if File.exist? DATAFILE
-      fetch_data if !ctime || ctime.to_date < Date.today
-      @data ||= YAML.safe_load File.read(DATAFILE, encoding: "UTF-8")
-    end
-
-    #
-    # fetch data form server and save it to file.
-    #
-    def fetch_data
-      resp = Faraday.new(ENDPOINT, headers: { "If-None-Match" => etag }).get
-      # return if there aren't any changes since last fetching
-      return unless resp.status == 200
-
-      self.etag = resp[:etag]
-      @data = YAML.safe_load resp.body
-      File.write DATAFILE, @data.to_yaml, encoding: "UTF-8"
-    end
-
-    #
-    # Read ETag form file
-    #
-    # @return [String, NilClass]
-    def etag
-      @etag ||= if File.exist? ETAGFILE
-                  File.read ETAGFILE, encoding: "UTF-8"
-                end
-    end
-
-    #
-    # Save ETag to file
-    #
-    # @param tag [String]
-    def etag=(e_tag)
-      File.write ETAGFILE, e_tag, encoding: "UTF-8"
-    end
-  end
-end