relaton-iho 1.2.0 → 1.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 755c6ac56aa46490e81370a3d6c033012ac8bf4e4175f1f8bae0dceb57cb0975
-  data.tar.gz: 95b3967bc7566b81e02f0e66fedaff2684c3a1bc2054aa51949bf9ab56f6131a
+  metadata.gz: a6a255a7706913443c4114b78fb417b67de9955f843cd434959c9ef6eb4009f6
+  data.tar.gz: 0d367ff3ad8c25f6873223bbc846c95c92e21c9dfdd5df6034abbb5f59b7cb40
 SHA512:
-  metadata.gz: 8d13aac298a850152010b1e88398a3ecd8c3ca6bbc0bc66c2903f9d537c4f9c8cf99b6957696d98a2cb77a3d7dd62e4094e55b2a4276d14466bf85c2b1eba624
-  data.tar.gz: bf793889594e5f7cfbed2a15d5699c0c7e348553f903221db6d40ef17c493c75f615ff1994a5487562f902c3ea46b3a3c8a4adf2667d48de20f00ae51527f4d6
+  metadata.gz: 4c1f2e6df7dece59c0efdfd2e1605475045f2d6c9305ad9b0650ff68db17a76513412061ffb6663a0c370f2751e4dcae31a12e9acca34878a99378c546f2f846
+  data.tar.gz: 4fe6fad0a66d7b15c898ca52b420926f3232ec0db93e49590870dc9c2dc8062b1d5aa187219b0bd7f837967822fe798b6780ec5a15ae5ee7efafe5ed0e35a9f3

data/.rubocop.yml

@@ -5,6 +5,6 @@
 inherit_from:
   - https://raw.githubusercontent.com/riboseinc/oss-guides/master/ci/rubocop.yml
 AllCops:
-  TargetRubyVersion: 2.3
+  TargetRubyVersion: 2.4
 Rails:
-  Enabled: true
+  Enabled: false

data/lib/relaton_iho.rb

@@ -5,6 +5,7 @@ require "relaton_iho/iho_bibliography"
 require "relaton_iho/hash_converter"
 require "relaton_iho/xml_parser"
 require "relaton_iho/editorial_group"
+require "relaton_iho/iho_group"
 require "relaton_iho/comment_periond"
 require "relaton_iho/iho_bibliographic_item"
 

data/lib/relaton_iho/comment_periond.rb

@@ -27,5 +27,15 @@ module RelatonIho
       hash["to"] = to.to_s if to
       hash
     end
+
+    # @param prefix [String]
+    # @return [String]
+    def to_asciibib(prefix)
+      pref = prefix.empty? ? prefix : prefix + "."
+      pref += "commentperiod"
+      out = "#{pref}.from:: #{from}\n"
+      out += "#{pref}.to:: #{to}\n" if to
+      out
+    end
   end
 end

data/lib/relaton_iho/editorial_group.rb

@@ -1,11 +1,10 @@
 module RelatonIho
   class EditorialGroupCollection
     extend Forwardable
-    include RelatonBib
 
     def_delegators :@collection, :first, :any?
 
-    # @return [Array<RelatonIho::editorialgroup]
+    # @return [Array<RelatonIho::EditorialGroup]
     attr_reader :collection
 
     # @param collection [Array<RelatonIho::EditorialGroup>]
@@ -18,9 +17,15 @@ module RelatonIho
       collection.each { |eg| eg.to_xml builder }
     end
 
-    # @return [Hash]
+    # @return [Hash, Array<Hash>]
     def to_hash
-      single_element_array collection
+      collection.map &:to_hash
+    end
+
+    # @param prefix [String]
+    # @return [String]
+    def to_asciibib(prefix)
+      collection.map { |ed| ed.to_asciibib prefix, collection.size }.join
     end
 
     # @return [Boolean]
@@ -30,30 +35,39 @@ module RelatonIho
   end
 
   class EditorialGroup
-    # @return [String]
-    attr_reader :committee, :workgroup
+    include RelatonBib
 
-    # @parma committee [String]
-    # @param workgroup [String]
-    def initialize(committee:, workgroup:)
-      unless %[hssc ircc].include? committee
-        warn "[relaton-iho] WARNING: invalid committee: #{committee}"
-      end
-      @committee = committee
+    # @return [Array<RelatonIho::Committee, RelatonIho::Commission,
+    #          RelatonIho::Workgroup>]
+    attr_accessor :workgroup
+
+    # @param workgroup [Array<RelatonIho::Committee, RelatonIho::Commission,
+    #                   RelatonIho::Workgroup>]
+    def initialize(workgroup)
       @workgroup = workgroup
     end
 
     # @param builder [Nokogiro::XML::Builder]
     def to_xml(builder)
       builder.editorialgroup do
-        builder.committee committee
-        builder.workgroup workgroup
+        workgroup.each { |wg| wg.to_xml builder }
       end
     end
 
-    # @return [Hash]
+    # @return [Hash, Array<Hash>]
     def to_hash
-      { "committee" => committee, "workgroup" => workgroup }
+      single_element_array workgroup
+    end
+
+    # @param prefix [String]
+    # @param count [Integer]
+    # @return [Strin]
+    def to_asciibib(prefix, count)
+      pref = prefix.empty? ? prefix : prefix + "."
+      pref += "editorialgroup"
+      out = count > 1 ? "#{pref}::\n" : ""
+      workgroup.each { |wg| out += wg.to_asciibib pref, workgroup.size }
+      out
     end
   end
 end

data/lib/relaton_iho/eg.yml

@@ -0,0 +1,191 @@
+HSSC:
+  previously: CHRIS
+  name: Hydrographic Services and Standards Committee
+  class: Committee
+  subgroup:
+    S-100WG: 
+      name: S-100 Working Group
+      class: Workgroup
+    ENCWG:
+      name: ENC STANDARDS MAINTENANCE WORKING GROUP
+      class: Workgroup
+    NCWG:
+      previously: CSPCWG
+      name: NAUTICAL CARTOGRAPHY WORKING GROUP
+      class: Workgroup
+    NIPWG:
+      name: NAUTICAL INFORMATION PROVISION WORKING GROUP
+      class: Workgroup
+    DQWG:
+      name: DATA QUALITY WORKING GROUP
+      class: Workgroup
+    TWCWG:
+      name: Tides, Water Level and Currents Working Group
+      class: Workgroup
+    HDWG:
+      name: Hydrographic Dictionary Working Group
+      class: Workgroup
+    ABLOS:
+      name: Advisory Board on Law of the Sea
+      class: Workgroup
+    HSPT:
+      name: Project Team on Standards for Hydrographic Surveys
+      class: Workgroup
+    CPRNW:
+      name: Commission for the Promulgation of Radio Navigation Warnings
+      class: Commission
+    TSMAD:
+      name: Transfer Standard Maintenance and Application Development Working Group
+      class: Workgroup
+IRCC:
+  name: Inter-Regional Coordination Committee
+  class: Committee
+  subgroup:
+    RHCs:
+      name: Regional Hydrographic Commissions
+      class: Commission
+      subgroup:
+        NHC:
+          name: Nordic HC
+          class: Commission
+        NSHC:
+          name: North Sea HC
+          class: Commission
+        MBSHC:
+          name: Mediterranean and Black Seas HC
+          class: Commission
+          subgroup:
+            BASWG:
+              name: Black and Azov Seas Working Group
+              class: Workgroup
+        ARHC:
+          name: Arctic RHC
+          class: Commission
+        BHSC:
+          name: Baltic Sea HC
+          class: Commission
+        USCHC:
+          name: US / Canada HC
+          class: Commission
+        EAHS:
+          name: East Asia HC
+          class: Commission
+        EAtHC:
+          name: Eastern Atlantic HC
+          class: Commission
+        SEPRHC:
+          name: South-East Pacific RHC
+          class: Commission
+        SWPHC:
+          name: South-West Pacific HC
+          class: Commission
+          subgroup:
+            ICCWG:
+              name: International Charting Coordination Working Group
+              class: Workgroup
+        MACHC:
+          name: Meso American & Caribbean Sea HC
+          class: Commission
+        SAIHC:
+          name: Southern African and Islands HC
+          class: Commission
+        NIOHC:
+          name: North Indian Ocean HC
+          class: Commission
+        RSAHC:
+          name: ROPME Sea Area HC
+          class: Commission
+          subgroup:
+            ICCWG:
+              name: International Charting Coordination Working Group
+              class: Workgroup
+        SWAtHC:
+          name: South West Atlantic HC
+          class: Commission
+    HCA:
+      name: Hydrographic Commission on Antarctica
+      class: Commission
+      subgroup:
+        HPWG:
+          name: HCA Hydrography Priorities Working Group
+          class: Workgroup
+    WWNWS:
+      name: World-Wide Navigational Warning Service
+      class: Committee
+      subgroup:
+        S-124PT:
+          name: S-124 Project Team
+          class: Workgroup
+    CBSC:
+      name: CAPACITY BUILDING SUB-COMMITTEE
+      class: Committee
+    WENDWG:
+      name: WORLDWIDE ENC DATABASE WORKING GROUP
+      class: Workgroup
+    MSDIWG:
+      name: MARINE SPATIAL DATA INFRASTRUCTURES WORKING GROUP
+      class: Workgroup
+    EC-IHO:
+      name: IENWG & EC - IHO Cooperation WG
+      class: Workgroup
+      subgroup:
+        IENWG:
+          name: COOPERATION BETWEEN THE EUROPEAN COMMISSION (EC) AND THE IHO
+          class: Workgroup
+    CSBWG:
+      name: CROWDSOURCED BATHYMETRY WORKING GROUP
+      class: Workgroup
+    IBSC:
+      name: FIG/IHO/ICA INTERNATIONAL BOARD ON STANDARDS OF COMPETENCE FOR HYDROGRAPHIC SURVEYORS AND NAUTICAL CARTOGRAPHERS
+      class: Committee
+    DCDB:
+      name: IHO Data Centre for Digital Bathymetry
+      class: Committee
+    GEBCO:
+      name: JOINT IHO-IOC GUIDING COMMITTEE FOR THE GENERAL BATHYMETRIC CHART OF THE OCEANS
+      class: Committee
+      subgroup:
+        GGC:
+          name: GEBCO Guiding Committee
+          class: Committee
+        SCUFN:
+          name: GEBCO SUB-COMMITTEE ON UNDERSEA FEATURE NAMES
+          class: Committee
+        TSCOM:
+          name: GEBCO TECHNICAL SUB-COMMITTEE ON OCEAN MAPPING
+          class: Committee
+        SCRUM:
+          name: SUB-COMMITTEE ON REGIONAL UNDERSEA MAPPING
+          class: Committee
+        SCOPE:
+          name: SUB-COMMITTEE ON COMMUNICATIONS, OUTREACH AND PUBLIC ENGAGEMENT
+          class: Committee
+Council:
+  class: Committee
+  subgroup:
+    SPRWG:
+      name: Strategic Plan Review Working Group
+      class: Workgroup
+IHR:
+  name: International Hydrography Review
+  class: Committee
+  subgroup:
+    IHR:
+      name: International Hydrography Review
+      class: Committee
+    IHREB:
+      name: International Hydrography Review Editorial Board
+      class: Committee
+BUREAU:
+  name: International Hydrography Bureau
+  class: Committee
+IMO MSC:
+  name: Maritime Safety Committee
+  class: Committee
+  subgroup:
+    NCSR:
+      name: Sub-Committee on Navigation, Communications and Search and Rescue
+      class: Committee
+DCDB:
+  name: IHO Data Centre for Digital Bathymetry
+  class: Committee

data/lib/relaton_iho/hash_converter.rb

@@ -25,9 +25,25 @@ module RelatonIho
         eg = ret[:editorialgroup]
         return unless eg.is_a?(Hash) || eg&.any?
 
-        collection = array(eg).map { |g| EditorialGroup.new g }
+        collection = array(eg).map do |g|
+          EditorialGroup.new(array(g).map { |wg| iho_workgroup wg })
+        end
         ret[:editorialgroup] = EditorialGroupCollection.new collection
       end
+
+      # @param ihowg [Hash]
+      # @return [RelatonIho::Committee, RelatonIho::Workgroup,
+      #          RelatonIho::Commission]
+      def iho_workgroup(ihowg)
+        key, value = ihowg&.first
+        return unless key && value.is_a?(Hash)
+
+        klass = Object.const_get "RelatonIho::#{key.capitalize}"
+        subwg = value.select do |k, _|
+          %i[committee workgroup commission].include? k
+        end
+        klass.new value[:abbreviation], value[:name], iho_workgroup(subwg)
+      end
     end
   end
 end

data/lib/relaton_iho/iho_bibliographic_item.rb

@@ -15,7 +15,7 @@ module RelatonIho
 
     # @param builder [Nokogiri::XML::Builder]
     # @param bibdata [TrueClasss, FalseClass, NilClass]
-    def to_xml(builer = nil, **opts)
+    def to_xml(builer = nil, **opts) # rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/MethodLength, Metrics/PerceivedComplexity
       opts[:ext] = !commentperiod.nil?
       super do |b|
         if opts[:bibdata] && (doctype || editorialgroup&.presence? ||
@@ -36,5 +36,13 @@ module RelatonIho
       hash["commentperiod"] = commentperiod.to_hash if commentperiod
       hash
     end
+
+    # @param prefix [String]
+    # @return [String]
+    def to_asciibib(prefix = "")
+      out = super
+      out += commentperiod.to_asciibib prefix if commentperiod
+      out
+    end
   end
 end

data/lib/relaton_iho/iho_bibliography.rb

@@ -1,3 +1,5 @@
+require "net/http"
+
 module RelatonIho
   class IhoBibliography
     ENDPOINT = "https://raw.githubusercontent.com/relaton/relaton-data-iho/"\
@@ -6,12 +8,12 @@ module RelatonIho
     class << self
       # @param text [String]
       # @return [RelatonIho::IhoBibliographicItem]
-      def search(text, _year = nil, _opts = {})
+      def search(text, _year = nil, _opts = {}) # rubocop:disable Metrics/MethodLength, Metrics/AbcSize
         warn "[relaton-iho] (\"#{text}\") fetching..."
         ref = text.sub(/^IHO\s/, "").downcase
         uri = URI("#{ENDPOINT}#{ref}.yaml")
         resp = Net::HTTP.get_response uri
-        returm unless resp.code == "200"
+        return unless resp.code == "200"
 
         hash = HashConverter.hash_to_bib YAML.safe_load(resp.body, [Date])
         item = IhoBibliographicItem.new hash

data/lib/relaton_iho/iho_group.rb

@@ -0,0 +1,146 @@
+module RelatonIho
+  class IHOGroup
+    # @return [String]
+    attr_reader :abbreviation
+
+    # @return [String, nil]
+    attr_reader :name
+
+    # @return [RelatonIho::Committee, RelatonIho::Workgroup,
+    #          RelatonIho::Commission, nil]
+    attr_reader :subgroup
+
+    # @param abbreviation [String]
+    # @param name [String, nil]
+    # @param subgroup [RelatonIho::Committee, RelatonIho::Workgroup,
+    #                  RelatonIho::Commission, nil]
+    def initialize(abbreviation, name = nil, subgroup = nil)
+      @abbreviation = abbreviation
+      @name = name
+      @subgroup = subgroup
+    end
+
+    class << self
+      # @param abbr [String]
+      # @return [RelatonIho::EditorialGroup]
+      def expand(abbr)
+        struct = YAML.load_file File.expand_path("eg.yml", __dir__)
+        from_abbr abbr.upcase, struct
+      end
+
+      private
+
+      # @param abbr [String]
+      # @param struct [Hash]
+      # @return [RelatonIho::Committee, RelatonIho::Commission,
+      #          RelatonIho::Workgroup]
+      def from_abbr(abbr, struct)
+        return unless struct
+
+        gr = struct.detect { |k, v| k == abbr || v["previously"] == abbr }
+        return klass(gr[1]["class"]).new abbr, gr[1]["name"] if gr
+
+        expand_from_abbr abbr, struct
+      end
+
+      # @param abbr [String]
+      # @param struct [Hash]
+      # @return [RelatonIho::Committee, RelatonIho::Commission,
+      #          RelatonIho::Workgroup]
+      def expand_from_abbr(abbr, struct)
+        struct.each do |k, g|
+          wg = from_abbr abbr, g["subgroup"]
+          return klass(g["class"]).new k, g["name"], wg if wg
+        end
+        nil
+      end
+
+      def klass(name)
+        Object.const_get "RelatonIho::" + name
+      end
+    end
+
+    # @param builder [Nokogiri::XML::Builder]
+    def to_xml(builder)
+      builder.name name if name
+      builder.abbreviation abbreviation
+      subgroup&.to_xml builder
+    end
+
+    # @return [Hash]
+    def to_hash
+      hash = { "abbreviation" => abbreviation }
+      hash["name"] = name if name
+      hash.merge! subgroup.to_hash if subgroup
+      hash
+    end
+
+    # @param prefix [String]
+    # @param count [Integer]
+    # @return [Strin]
+    def to_asciibib(prefix, count = 1)
+      out = count > 1 ? "#{prefix}::\n" : ""
+      out += "#{prefix}.abbreviation:: #{abbreviation}\n"
+      out += "#{prefix}.name:: #{name}\n" if name
+      out += subgroup.to_asciibib prefix if subgroup
+      out
+    end
+  end
+
+  class Committee < IHOGroup
+    # @param builder [Nokogiri::XML::Builder]
+    def to_xml(builder)
+      builder.committee { |b| super b }
+    end
+
+    # @return [Hash]
+    def to_hash
+      { "committee" => super }
+    end
+
+    # @param prefix [String]
+    # @param count [Integer]
+    # @return [Strin]
+    def to_asciibib(prefix, count = 1)
+      super prefix + ".committee", count
+    end
+  end
+
+  class Workgroup < IHOGroup
+    # @param builder [Nokogiri::XML::Builder]
+    def to_xml(builder)
+      builder.workgroup { |b| super b }
+    end
+
+    # @return [Hash]
+    def to_hash
+      { "workgroup" => super }
+    end
+
+    # @param prefix [String]
+    # @param count [Integer]
+    # @return [Strin]
+    def to_asciibib(prefix, count = 1)
+      super prefix + ".workgroup", count
+    end
+  end
+
+  class Commission < IHOGroup
+    # @param builder [Nokogiri::XML::Builder]
+    def to_xml(builder)
+      builder.commisstion { |b| super b }
+    end
+
+    # @return [Hash]
+    def to_hash
+      { "commission" => super }
+    end
+
+    # @param prefix [String]
+    # @param count [Integer]
+    # @return [Strin]
+    def to_asciibib(prefix, count = 1)
+      super prefix + ".commission", count
+    end
+  end
+end

data/lib/relaton_iho/version.rb

@@ -1,3 +1,3 @@
 module RelatonIho
-  VERSION = "1.2.0".freeze
+  VERSION = "1.3.1".freeze
 end

data/lib/relaton_iho/xml_parser.rb

@@ -27,12 +27,25 @@ module RelatonIho
         return unless ext
 
         egs = ext.xpath("editorialgroup").map do |eg|
-          EditorialGroup.new(committee: eg.at("committee")&.text,
-                             workgroup: eg.at("workgroup")&.text)
+          grps = eg.xpath("committee|workgroup|commission").map do |ig|
+            iho_group ig
+          end
+          EditorialGroup.new grps
         end
         EditorialGroupCollection.new egs if egs.any?
       end
 
+      # @param ext [Nokogiri::XML::Element. nil]
+      # @return [RelatonIho::Committee, RelatonIho::Commission,
+      #   RelatonIho::Workgroup, nil]
+      def iho_group(ihgrp)
+        return unless ihgrp
+
+        klass = Object.const_get "RelatonIho::" + ihgrp.name.capitalize
+        subg = iho_group ihgrp.at("./committee|./workgroup|./commission")
+        klass.new ihgrp.at("abbreviation").text, ihgrp.at("name")&.text, subg
+      end
+
       # @param ext [Nokogiri::XML::Element]
       # @return [RelatonIho::CommentPeriod, nil]
       def fetch_commentperiond(ext)

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.2.0"
+  s.add_dependency "relaton-bib", "~> 1.3.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: relaton-iho
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.3.1
 platform: ruby
 authors:
 - Ribose Inc.
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-06-26 00:00:00.000000000 Z
+date: 2020-09-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: byebug
@@ -156,14 +156,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.2.0
+        version: 1.3.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.2.0
+        version: 1.3.0
 description: 'RelatonIho: retrieve IHO Standards for bibliographic using the BibliographicItem
   model'
 email:
@@ -190,10 +190,12 @@ files:
 - lib/relaton_iho.rb
 - lib/relaton_iho/comment_periond.rb
 - 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
 - lib/relaton_iho/processor.rb
 - lib/relaton_iho/version.rb
 - lib/relaton_iho/xml_parser.rb
@@ -202,7 +204,7 @@ homepage: https://github.com/relaton/relaton-iho
 licenses:
 - BSD-2-Clause
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -218,7 +220,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.0.6
-signing_key: 
+signing_key:
 specification_version: 4
 summary: 'RelatonIho: retrieve IHO Standards for bibliographic using the BibliographicItem
   model'