relaton-iho 1.16.1 → 1.17.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9081030fd9879044f6a850380bd33459ce7ecdd76869c37364b0364e5b4069cd
-  data.tar.gz: e65329781f6306a9eda0850bbff0951d348aaff0359067de4d9c9636dcf31ebb
+  metadata.gz: a34fe61f191f15b4f9bd2896026ad6135ca6ae4e9682668ccc44b3015a83e367
+  data.tar.gz: fb58a578ac9a5af772237ee218cfb160e18b932cf88fa79497da1410e30cd220
 SHA512:
-  metadata.gz: 584611520dcf2fc502065c40755d328b720026811164bdf265a16e121b2e26e1f77f81ae06e42ca71ba37fd16214ee52ed149a9f3c8529cb2074d895cad3302f
-  data.tar.gz: 68bee2e7910c5863aae0411af064c6825f124fff7a996550fdf983f5300bd45deeae128a6aeeac2e3da39bf272c8efe9e3af4c9e0117c7451bbf8aa0a2146fd0
+  metadata.gz: cf24b4b1dfec02601c32c3be5b0130d5a099bf3cd238dc091834d601c0290fecc89a3fc1a6b9e669996cff94ce968a638ce182edf299a0001b9e250c78cd309c
+  data.tar.gz: a927a1545ff80aeda7cf65cdb888b27fda1d2f7d878fefd96cafcfe1085fb2fbf283cae2163dbf722b9cb1e76717eaf7b40d35eed5b5a04d6aa1547776b9e794

data/README.adoc

@@ -37,26 +37,37 @@ $ gem install relaton-iho
 
 == Usage
 
-=== Search for a standard using keywords
+=== Configuration
 
-Reference can be specified with or without an edition. References without an edition will return the latest edition of the standard. References with an edition will return the standard with the specified edition.
+Configuration is optional. The available option is `logger` which is a `Logger` instance. By default, the logger is `Logger.new($stderr)` with `Logger::WARN` level. To change the logger level, use `RelatonIho.configure` block.
 
 [source,ruby]
 ----
 require 'relaton_iho'
 => true
 
+RelatonIho.configure do |config|
+  config.logger.level = Logger::DEBUG
+end
+----
+
+=== Search for a standard using keywords
+
+Reference can be specified with or without an edition. References without an edition will return the latest edition of the standard. References with an edition will return the standard with the specified edition.
+
+[source,ruby]
+----
 # Search for a standard using a reference without an edition
 item = RelatonIho::IhoBibliography.search("IHO B-11")
-[relaton-iho] ("IHO B-11") fetching...
-[relaton-iho] ("IHO B-11") found B-11
+[relaton-iho] (IHO B-11) Fetching from Relaton repository ...
+[relaton-iho] (IHO B-11) Found: `B-11`
 => #<RelatonIho::IhoBibliographicItem:0x007fe74fc80800
 ...
 
 # Search for a standard using a reference with an edition
 item = RelatonIho::IhoBibliography.search("IHO B-11 1.0.0")
-[relaton-iho] ("IHO B-11 1.0.0") fetching...
-[relaton-iho] ("IHO B-11 1.0.0") found B-11
+[relaton-iho] (IHO B-11 1.0.0) Fetchint from Rlaont repository ...
+[relaton-iho] (IHO B-11 1.0.0) Found: `B-11`
 => #<RelatonIho::IhoBibliographicItem:0x00007fe79d0ed698
 ...
 ----
@@ -95,8 +106,8 @@ item.to_xml bibdata: true
 [source,ruby]
 ----
 RelatonIho::IhoBibliography.get "IHO B-11"
-[relaton-iho] ("IHO B-11") fetching...
-[relaton-iho] ("IHO B-11") found B-11
+[relaton-iho] (IHO B-11) Fetching from Relaton repository ...
+[relaton-iho] (IHO B-11) Found: `B-11`
 => #<RelatonIho::IhoBibliographicItem:0x007fe78dbb7c78
 ...
 ----

data/grammars/basicdoc.rng

@@ -346,6 +346,8 @@
           <ref name="keyword"/>
           <ref name="xref"/>
           <ref name="hyperlink"/>
+          <ref name="index"/>
+          <ref name="index-xref"/>
         </choice>
       </oneOrMore>
     </element>
@@ -623,6 +625,8 @@
           <ref name="eref"/>
           <ref name="xref"/>
           <ref name="hyperlink"/>
+          <ref name="index"/>
+          <ref name="index-xref"/>
         </choice>
       </zeroOrMore>
     </element>
@@ -636,6 +640,8 @@
           <ref name="eref"/>
           <ref name="xref"/>
           <ref name="hyperlink"/>
+          <ref name="index"/>
+          <ref name="index-xref"/>
         </choice>
       </zeroOrMore>
     </element>
@@ -648,6 +654,8 @@
           <ref name="eref"/>
           <ref name="xref"/>
           <ref name="hyperlink"/>
+          <ref name="index"/>
+          <ref name="index-xref"/>
         </choice>
       </zeroOrMore>
     </element>
@@ -655,7 +663,11 @@
   <define name="keyword">
     <element name="keyword">
       <zeroOrMore>
-        <ref name="PureTextElement"/>
+        <choice>
+          <ref name="PureTextElement"/>
+          <ref name="index"/>
+          <ref name="index-xref"/>
+        </choice>
       </zeroOrMore>
     </element>
   </define>
@@ -676,7 +688,11 @@
   <define name="strike">
     <element name="strike">
       <zeroOrMore>
-        <ref name="PureTextElement"/>
+        <choice>
+          <ref name="PureTextElement"/>
+          <ref name="index"/>
+          <ref name="index-xref"/>
+        </choice>
       </zeroOrMore>
     </element>
   </define>

data/grammars/biblio.rng

@@ -942,6 +942,7 @@
       <value>obsoleted</value>
       <value>confirmed</value>
       <value>updated</value>
+      <value>corrected</value>
       <value>issued</value>
       <value>transmitted</value>
       <value>copied</value>

data/lib/relaton_iho/document_type.rb

@@ -0,0 +1,17 @@
+module RelatonIho
+  class DocumentType < RelatonBib::DocumentType
+    DOCTYPES = %w[policy-and-procedures best-practices supporting-document
+               report legal directives proposal standard].freeze
+
+    def initialize(type:, abbreviation: nil)
+      check_type type
+      super
+    end
+
+    def check_type(type)
+      unless DOCTYPES.include? type
+        Util.warn "WARNING: invalid doctype: `#{type}`"
+      end
+    end
+  end
+end

data/lib/relaton_iho/hash_converter.rb

@@ -1,54 +1,58 @@
 module RelatonIho
-  class HashConverter < RelatonBib::HashConverter
-    class << self
-      # @override RelatonIsoBib::HashConverter.hash_to_bib
-      # @param args [Hash]
-      # @param nested [TrueClass, FalseClass]
-      # @return [Hash]
-      def hash_to_bib(args)
-        ret = super
-        return if ret.nil?
-
-        commentperiod_hash_to_bib ret
-        ret
-      end
+  module HashConverter
+    include RelatonBib::HashConverter
+    extend self
+    # @override RelatonIsoBib::HashConverter.hash_to_bib
+    # @param args [Hash]
+    # @param nested [TrueClass, FalseClass]
+    # @return [Hash]
+    def hash_to_bib(args)
+      ret = super
+      return if ret.nil?
+
+      commentperiod_hash_to_bib ret
+      ret
+    end
 
-      private
+    private
 
-      # @param item_hash [Hash]
-      # @return [RelatonBib::BibliographicItem]
-      def bib_item(**item_hash)
-        IhoBibliographicItem.new(**item_hash)
-      end
+    # @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])
-      end
+    # @param ret [Hash]
+    def commentperiod_hash_to_bib(ret)
+      ret[:commentperiod] &&= CommentPeriond.new(**ret[:commentperiod])
+    end
 
-      # @param ret [Hash]
-      def editorialgroup_hash_to_bib(ret)
-        eg = ret[:editorialgroup]
-        return unless eg.is_a?(Hash) || eg&.any?
+    # @param ret [Hash]
+    def editorialgroup_hash_to_bib(ret)
+      eg = ret[:editorialgroup]
+      return unless eg.is_a?(Hash) || eg&.any?
 
-        collection = RelatonBib.array(eg).map do |g|
-          EditorialGroup.new(RelatonBib.array(g).map { |wg| iho_workgroup wg })
-        end
-        ret[:editorialgroup] = EditorialGroupCollection.new collection
+      collection = RelatonBib.array(eg).map do |g|
+        EditorialGroup.new(RelatonBib.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}"
-        wgs = %i[committee workgroup commission]
-        subwg = value.select { |k, _| wgs.include? k }
-        klass.new value[:abbreviation], value[:name], iho_workgroup(subwg)
-      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}"
+      wgs = %i[committee workgroup commission]
+      subwg = value.select { |k, _| wgs.include? k }
+      klass.new value[:abbreviation], value[:name], iho_workgroup(subwg)
+    end
+
+    def create_doctype(**args)
+      DocumentType.new(**args)
     end
   end
 end

data/lib/relaton_iho/iho_bibliographic_item.rb

@@ -1,8 +1,5 @@
 module RelatonIho
   class IhoBibliographicItem < RelatonBib::BibliographicItem
-    TYPES = %w[policy-and-procedures best-practices supporting-document
-               report legal directives proposal standard].freeze
-
     # @return [RelatonIho::CommentPeriod, NilClass]
     attr_reader :commentperiod
 
@@ -39,7 +36,7 @@ module RelatonIho
         if opts[:bibdata] && (doctype || editorialgroup&.presence? ||
                               ics.any? || commentperiod)
           ext = b.ext do
-            b.doctype doctype if doctype
+            doctype&.to_xml b
             editorialgroup&.to_xml b
             ics.each { |i| i.to_xml b }
             commentperiod&.to_xml b

data/lib/relaton_iho/iho_bibliography.rb

@@ -14,12 +14,12 @@ module RelatonIho
       # @return [RelatonIho::IhoBibliographicItem, nil] the IHO standard or nil if not found
       #
       def search(text, _year = nil, _opts = {}) # rubocop:disable Metrics/MethodLength, Metrics/AbcSize
-        Util.warn "(#{text}) fetching..."
+        Util.warn "(#{text}) Fetching from Relaton repository ..."
         ref = text.sub(/^IHO\s/, "").sub(/^([[:alpha:]]+)(\d+)/, '\1-\2')
         index = Relaton::Index.find_or_create :iho, url: "#{ENDPOINT}index.zip"
         row = index.search(ref).max_by { |r| r[:id] }
         unless row
-          Util.warn "(#{text}) not found"
+          Util.warn "(#{text}) Not found."
           return
         end
 
@@ -33,7 +33,7 @@ module RelatonIho
         hash = HashConverter.hash_to_bib yaml
         hash[:fetched] = Date.today.to_s
         item = IhoBibliographicItem.new(**hash)
-        Util.warn "(#{text}) found `#{item.docidentifier.first.id}`"
+        Util.warn "(#{text}) Found: `#{item.docidentifier.first.id}`"
         item
       rescue SocketError, Errno::EINVAL, Errno::ECONNRESET, EOFError,
              Net::HTTPBadResponse, Net::HTTPHeaderSyntaxError,

data/lib/relaton_iho/version.rb

@@ -1,3 +1,3 @@
 module RelatonIho
-  VERSION = "1.16.1".freeze
+  VERSION = "1.17.0".freeze
 end

data/lib/relaton_iho.rb

@@ -5,6 +5,7 @@ require "relaton/index"
 require "relaton_iho/version"
 require "relaton_iho/config"
 require "relaton_iho/util"
+require "relaton_iho/document_type"
 require "relaton_iho/iho_bibliography"
 require "relaton_iho/hash_converter"
 require "relaton_iho/xml_parser"

data/relaton_iho.gemspec

@@ -21,6 +21,6 @@ Gem::Specification.new do |s|
   s.require_paths = ["lib"]
   s.required_ruby_version = Gem::Requirement.new(">= 2.7.0")
 
-  s.add_dependency "relaton-bib", "~> 1.16.0"
+  s.add_dependency "relaton-bib", "~> 1.17.0"
   s.add_dependency "relaton-index", "~> 0.2.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: relaton-iho
 version: !ruby/object:Gem::Version
-  version: 1.16.1
+  version: 1.17.0
 platform: ruby
 authors:
 - Ribose Inc.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-09-21 00:00:00.000000000 Z
+date: 2023-11-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: relaton-bib
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.16.0
+        version: 1.17.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.16.0
+        version: 1.17.0
 - !ruby/object:Gem::Dependency
   name: relaton-index
   requirement: !ruby/object:Gem::Requirement
@@ -63,6 +63,7 @@ files:
 - lib/relaton_iho.rb
 - lib/relaton_iho/comment_periond.rb
 - lib/relaton_iho/config.rb
+- lib/relaton_iho/document_type.rb
 - lib/relaton_iho/editorial_group.rb
 - lib/relaton_iho/eg.yml
 - lib/relaton_iho/hash_converter.rb