relaton-iho 1.17.0 → 1.19.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a34fe61f191f15b4f9bd2896026ad6135ca6ae4e9682668ccc44b3015a83e367
-  data.tar.gz: fb58a578ac9a5af772237ee218cfb160e18b932cf88fa79497da1410e30cd220
+  metadata.gz: af09b151cd27cb724b5ee702811515777a020e5cc751053f59d6700810e677b1
+  data.tar.gz: 0b5a2fb2a3e7c8a552de0da8c7be9a04ef74f47830f64eb9b09a2fd95aaa38b9
 SHA512:
-  metadata.gz: cf24b4b1dfec02601c32c3be5b0130d5a099bf3cd238dc091834d601c0290fecc89a3fc1a6b9e669996cff94ce968a638ce182edf299a0001b9e250c78cd309c
-  data.tar.gz: a927a1545ff80aeda7cf65cdb888b27fda1d2f7d878fefd96cafcfe1085fb2fbf283cae2163dbf722b9cb1e76717eaf7b40d35eed5b5a04d6aa1547776b9e794
+  metadata.gz: 92d5f66d23261995ad13ec91b807d13566e2c4d89270537c307cca53b3c08d2dc531f7354f5de2b894b8ef38a439f6763fdb097c9fe700aa8c6f04d63161ed1c
+  data.tar.gz: 9a9914fd40cd47b0a34a447eb8485c970da7077b8c9afe366707734bb0788e574c32366c8e0b5a5b72b5ac8577071d62a580d955585735e8d8138696066debb8

data/.github/workflows/rake.yml

@@ -10,4 +10,4 @@ on:
 
 jobs:
   rake:
-    uses: relaton/support/.github/workflows/rake.yml@master
+    uses: relaton/support/.github/workflows/rake.yml@main

data/.github/workflows/release.yml

@@ -17,7 +17,7 @@ on:
 
 jobs:
   release:
-    uses: relaton/support/.github/workflows/release.yml@master
+    uses: relaton/support/.github/workflows/release.yml@main
     with:
       next_version: ${{ github.event.inputs.next_version }}
     secrets:

data/README.adoc

@@ -37,26 +37,15 @@ $ gem install relaton-iho
 
 == Usage
 
-=== Configuration
+=== Search for a standard using keywords
 
-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.
+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]
 ----
 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 from Relaton repository ...
@@ -142,6 +131,10 @@ RelatonIho::IhoBibliographicItem.from_hash hash
 ...
 ----
 
+=== Logging
+
+RelatonIho uses the relaton-logger gem for logging. By default, it logs to STDOUT. To change the log levels and add other loggers, read the https://github.com/relaton/relaton-logger#usage[relaton-logger] documentation.
+
 == Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/grammars/basicdoc.rng

@@ -95,8 +95,89 @@
       <ref name="pagebreak"/>
       <ref name="hr"/>
       <ref name="bookmark"/>
+      <ref name="amend"/>
     </choice>
   </define>
+  <define name="amend">
+    <element name="amend">
+      <ref name="AmendType"/>
+    </element>
+  </define>
+  <define name="AmendType">
+    <optional>
+      <attribute name="id">
+        <data type="ID"/>
+      </attribute>
+    </optional>
+    <attribute name="change">
+      <choice>
+        <value>add</value>
+        <value>modify</value>
+        <value>delete</value>
+        <value>replace</value>
+      </choice>
+    </attribute>
+    <optional>
+      <attribute name="path"/>
+    </optional>
+    <optional>
+      <attribute name="path_end"/>
+    </optional>
+    <optional>
+      <attribute name="title"/>
+    </optional>
+    <optional>
+      <element name="location">
+        <zeroOrMore>
+          <choice>
+            <ref name="locality"/>
+            <ref name="localityStack"/>
+          </choice>
+        </zeroOrMore>
+      </element>
+    </optional>
+    <optional>
+      <element name="description">
+        <zeroOrMore>
+          <ref name="BasicBlock"/>
+        </zeroOrMore>
+      </element>
+    </optional>
+    <optional>
+      <element name="newcontent">
+        <optional>
+          <attribute name="id">
+            <data type="ID"/>
+          </attribute>
+        </optional>
+        <zeroOrMore>
+          <ref name="BasicBlock"/>
+        </zeroOrMore>
+      </element>
+    </optional>
+    <zeroOrMore>
+      <ref name="classification"/>
+    </zeroOrMore>
+    <zeroOrMore>
+      <ref name="contributor"/>
+    </zeroOrMore>
+  </define>
+  <define name="classification">
+    <element name="classification">
+      <ref name="classification_tag"/>
+      <ref name="classification_value"/>
+    </element>
+  </define>
+  <define name="classification_tag">
+    <element name="tag">
+      <text/>
+    </element>
+  </define>
+  <define name="classification_value">
+    <element name="value">
+      <text/>
+    </element>
+  </define>
   <define name="paragraph">
     <element name="p">
       <ref name="ParagraphType"/>
@@ -163,6 +244,9 @@
         <data type="ID"/>
       </attribute>
       <attribute name="reviewer"/>
+      <optional>
+        <attribute name="type"/>
+      </optional>
       <optional>
         <attribute name="date">
           <data type="dateTime"/>
@@ -715,27 +799,36 @@
   </define>
   <define name="ruby">
     <element name="ruby">
-      <zeroOrMore>
-        <choice>
-          <ref name="PureTextElement"/>
-          <ref name="rp"/>
-          <ref name="rt"/>
-        </choice>
-      </zeroOrMore>
+      <choice>
+        <ref name="ruby_pronunciation"/>
+        <ref name="ruby_annotation"/>
+      </choice>
+      <choice>
+        <text/>
+        <ref name="ruby"/>
+      </choice>
     </element>
   </define>
-  <define name="rp">
-    <element name="rp">
-      <zeroOrMore>
-        <ref name="PureTextElement"/>
-      </zeroOrMore>
+  <define name="ruby_pronunciation">
+    <element name="pronunciation">
+      <attribute name="value"/>
+      <optional>
+        <attribute name="script"/>
+      </optional>
+      <optional>
+        <attribute name="lang"/>
+      </optional>
     </element>
   </define>
-  <define name="rt">
-    <element name="rt">
-      <zeroOrMore>
-        <ref name="PureTextElement"/>
-      </zeroOrMore>
+  <define name="ruby_annotation">
+    <element name="annotation">
+      <attribute name="value"/>
+      <optional>
+        <attribute name="script"/>
+      </optional>
+      <optional>
+        <attribute name="lang"/>
+      </optional>
     </element>
   </define>
   <define name="br">
@@ -914,44 +1007,49 @@
   -->
   <define name="image">
     <element name="image">
-      <attribute name="id">
-        <data type="ID"/>
+      <ref name="Image"/>
+    </element>
+  </define>
+  <define name="Image">
+    <attribute name="id">
+      <data type="ID"/>
+    </attribute>
+    <attribute name="src">
+      <data type="anyURI"/>
+    </attribute>
+    <attribute name="mimetype"/>
+    <optional>
+      <attribute name="filename"/>
+    </optional>
+    <optional>
+      <attribute name="width">
+        <ref name="ImageSize"/>
       </attribute>
-      <attribute name="src">
+    </optional>
+    <optional>
+      <attribute name="height">
+        <ref name="ImageSize"/>
+      </attribute>
+    </optional>
+    <optional>
+      <attribute name="alt"/>
+    </optional>
+    <optional>
+      <attribute name="title"/>
+    </optional>
+    <optional>
+      <attribute name="longdesc">
         <data type="anyURI"/>
       </attribute>
-      <attribute name="mimetype"/>
-      <optional>
-        <attribute name="filename"/>
-      </optional>
-      <optional>
-        <attribute name="width">
-          <choice>
-            <data type="int"/>
-            <value>auto</value>
-          </choice>
-        </attribute>
-      </optional>
-      <optional>
-        <attribute name="height">
-          <choice>
-            <data type="int"/>
-            <value>auto</value>
-          </choice>
-        </attribute>
-      </optional>
-      <optional>
-        <attribute name="alt"/>
-      </optional>
-      <optional>
-        <attribute name="title"/>
-      </optional>
-      <optional>
-        <attribute name="longdesc">
-          <data type="anyURI"/>
-        </attribute>
-      </optional>
-    </element>
+    </optional>
+  </define>
+  <define name="ImageSize">
+    <choice>
+      <data type="string">
+        <param name="pattern">\d+([.]\d+)?(%?)</param>
+      </data>
+      <value>auto</value>
+    </choice>
   </define>
   <define name="video">
     <element name="video">

data/grammars/biblio-standoc.rng

@@ -9,11 +9,42 @@
   -->
   <include href="biblio.rng">
     <define name="BibData">
-      <ref name="BibliographicItem"/>
+      <ref name="StandardBibliographicItem"/>
       <optional>
         <ref name="ext"/>
       </optional>
     </define>
+    <define name="docrelation">
+      <element name="relation">
+        <attribute name="type">
+          <ref name="DocRelationType"/>
+        </attribute>
+        <optional>
+          <element name="description">
+            <ref name="FormattedString"/>
+          </element>
+        </optional>
+        <element name="bibitem">
+          <ref name="StandardReducedBibliographicItem"/>
+        </element>
+        <choice>
+          <zeroOrMore>
+            <ref name="locality"/>
+          </zeroOrMore>
+          <zeroOrMore>
+            <ref name="localityStack"/>
+          </zeroOrMore>
+        </choice>
+        <choice>
+          <zeroOrMore>
+            <ref name="sourceLocality"/>
+          </zeroOrMore>
+          <zeroOrMore>
+            <ref name="sourceLocalityStack"/>
+          </zeroOrMore>
+        </choice>
+      </element>
+    </define>
   </include>
   <define name="ext">
     <element name="ext">
@@ -161,4 +192,16 @@
       </optional>
     </element>
   </define>
+  <define name="StandardBibliographicItem">
+    <ref name="BibliographicItem"/>
+    <zeroOrMore>
+      <ref name="amend"/>
+    </zeroOrMore>
+  </define>
+  <define name="StandardReducedBibliographicItem">
+    <ref name="ReducedBibliographicItem"/>
+    <zeroOrMore>
+      <ref name="amend"/>
+    </zeroOrMore>
+  </define>
 </grammar>

data/grammars/biblio.rng

@@ -241,6 +241,9 @@
     </element>
   </define>
   <define name="FullNameType">
+    <optional>
+      <ref name="name_abbreviation"/>
+    </optional>
     <choice>
       <group>
         <zeroOrMore>
@@ -266,6 +269,11 @@
       <ref name="variantname"/>
     </zeroOrMore>
   </define>
+  <define name="name_abbreviation">
+    <element name="abbreviation">
+      <ref name="LocalizedString"/>
+    </element>
+  </define>
   <define name="prefix">
     <element name="prefix">
       <ref name="LocalizedString"/>
@@ -348,6 +356,9 @@
       <zeroOrMore>
         <ref name="contact"/>
       </zeroOrMore>
+      <optional>
+        <ref name="logo"/>
+      </optional>
     </element>
   </define>
   <define name="orgname">
@@ -366,6 +377,21 @@
       </choice>
     </element>
   </define>
+  <define name="logo">
+    <element name="logo">
+      <ref name="image"/>
+    </element>
+  </define>
+  <define name="depiction">
+    <element name="depiction">
+      <optional>
+        <attribute name="scope"/>
+      </optional>
+      <zeroOrMore>
+        <ref name="image"/>
+      </zeroOrMore>
+    </element>
+  </define>
   <define name="NameWithVariants">
     <element name="primary">
       <ref name="LocalizedString"/>
@@ -752,6 +778,9 @@
     <optional>
       <ref name="validity"/>
     </optional>
+    <optional>
+      <ref name="depiction"/>
+    </optional>
   </define>
   <define name="ReducedBibliographicItem">
     <optional>
@@ -849,6 +878,9 @@
     <optional>
       <ref name="validity"/>
     </optional>
+    <optional>
+      <ref name="depiction"/>
+    </optional>
   </define>
   <define name="btitle">
     <element name="title">

data/lib/relaton_iho/document_type.rb

@@ -10,7 +10,7 @@ module RelatonIho
 
     def check_type(type)
       unless DOCTYPES.include? type
-        Util.warn "WARNING: invalid doctype: `#{type}`"
+        Util.warn "invalid doctype: `#{type}`"
       end
     end
   end

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 from Relaton repository ..."
+        Util.info "Fetching from Relaton repository ...", key: text
         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.info "Not found.", key: text
           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.info "Found: `#{item.docidentifier.first.id}`", key: text
         item
       rescue SocketError, Errno::EINVAL, Errno::ECONNRESET, EOFError,
              Net::HTTPBadResponse, Net::HTTPHeaderSyntaxError,

data/lib/relaton_iho/util.rb

@@ -1,9 +1,6 @@
 module RelatonIho
   module Util
     extend RelatonBib::Util
-
-    def self.logger
-      RelatonIho.configuration.logger
-    end
+    PROGNAME = "relaton-iho".freeze
   end
 end

data/lib/relaton_iho/version.rb

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

data/lib/relaton_iho/xml_parser.rb

@@ -53,6 +53,10 @@ module RelatonIho
 
         CommentPeriond.new from: cp.at("from")&.text, to: cp.at("to")&.text
       end
+
+      def create_doctype(type)
+        DocumentType.new type: type.text, abbreviation: type[:abbreviation]
+      end
     end
   end
 end

data/lib/relaton_iho.rb

@@ -3,7 +3,6 @@ require "yaml"
 require "relaton_bib"
 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"

data/relaton_iho.gemspec

@@ -21,6 +21,7 @@ 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.17.0"
+  s.add_dependency "base64"
+  s.add_dependency "relaton-bib", "~> 1.19.0"
   s.add_dependency "relaton-index", "~> 0.2.0"
 end

metadata

@@ -1,29 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: relaton-iho
 version: !ruby/object:Gem::Version
-  version: 1.17.0
+  version: 1.19.0
 platform: ruby
 authors:
 - Ribose Inc.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-11-27 00:00:00.000000000 Z
+date: 2024-07-03 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: base64
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: relaton-bib
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.17.0
+        version: 1.19.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.17.0
+        version: 1.19.0
 - !ruby/object:Gem::Dependency
   name: relaton-index
   requirement: !ruby/object:Gem::Requirement
@@ -62,7 +76,6 @@ files:
 - grammars/relaton-iho.rng
 - 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
@@ -94,7 +107,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.26
+rubygems_version: 3.3.27
 signing_key: 
 specification_version: 4
 summary: 'RelatonIho: retrieve IHO Standards for bibliographic using the BibliographicItem

data/lib/relaton_iho/config.rb

@@ -1,10 +0,0 @@
-module RelatonIho
-  module Config
-    include RelatonBib::Config
-  end
-  extend Config
-
-  class Configuration < RelatonBib::Configuration
-    PROGNAME = "relaton-iho".freeze
-  end
-end