relaton-iho 2.0.0.pre.alpha.3 → 2.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5857d0036fa3059a90923736f457dc8b38583be92860ea91ae73e3f401057ae9
-  data.tar.gz: 1cf8ff7208ecfefa13ae943cb2fbdd7d8d6332dbbecf2276ea2ca11186d09c9b
+  metadata.gz: 925a166a381b8adb5378310ef223267789270224fe165464a13f925077509b4d
+  data.tar.gz: 370e60d822569a76887517f7a78406573974ba1696cc6b789960c34108e2b61a
 SHA512:
-  metadata.gz: 863b486a65712fa0341f123163ff3fdf36705ca6466a6c075de916b10d85d3c93f1dcb26ce8f53a2e046d00359f01b69521c1ae7093db6145beb6eb88884b77b
-  data.tar.gz: 9062b35aaae23d8739f01d32d0a513e0047116b17dee1be2a2608bc43c3bfbbf9270e0f258cd4d3abc9298d483dc8972b225a81fd3a01f2670e8949bbe54fbcf
+  metadata.gz: 17f0a775934419440d44bb7eebfa9dea5e9057c0d642ddd508756a5f03b6e5c19ba8afbc84d295455d93b75d667f5abb7429d6bf3e43c8f1364b78020e2077e2
+  data.tar.gz: 67634f4b8e47c58e46e03ab5c6a27856c8cfa4ea0b9187ae93e957ff3612578c119dc586740eea0fd23140fa2ab333d62ec4794c1c11c6ce6357710a197a175e

data/CLAUDE.md

@@ -64,3 +64,7 @@ In `item.rb`, `require_relative "relation"` is placed **after** the `Item` class
 ### IHO-Specific Document Types
 
 policy-and-procedures, best-practices, supporting-document, report, legal, directives, proposal, standard
+
+## Testing
+
+- **Index fixture:** `spec/fixtures/index-v1.zip` is pre-loaded into `Relaton::Index` pool in `before(:suite)` (configured in `spec/support/webmock.rb`). Run `rake spec:update_index` to refresh from relaton-data-iho.

data/README.adoc

@@ -137,6 +137,8 @@ RelatonIho uses the relaton-logger gem for logging. By default, it logs to STDOU
 
 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.
 
+To update the index test fixture (used by tests), run `rake spec:update_index`. This downloads the latest `index-v1.zip` from the https://github.com/relaton/relaton-data-iho[relaton-data-iho] repository.
+
 To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to https://rubygems.org[rubygems.org].
 
 == Contributing

data/Rakefile

@@ -4,3 +4,27 @@ require "rspec/core/rake_task"
 RSpec::Core::RakeTask.new(:spec)
 
 task :default => :spec
+
+namespace :spec do
+  desc "Download latest IHO index fixture from relaton-data-iho"
+  task :update_index do
+    require "net/http"
+    require "uri"
+    require_relative "lib/relaton/iho"
+
+    filename = "#{Relaton::Iho::INDEXFILE}.zip"
+    url = "https://raw.githubusercontent.com/relaton/relaton-data-iho/data-v2/\#{filename}"
+    dest = File.join(__dir__, "spec", "fixtures", filename)
+
+    puts "Downloading \#{url} ..."
+    uri = URI.parse(url)
+    response = Net::HTTP.get_response(uri)
+
+    if response.is_a?(Net::HTTPSuccess)
+      File.binwrite(dest, response.body)
+      puts "Updated \#{dest} (\#{response.body.bytesize} bytes)"
+    else
+      abort "Failed to download: HTTP \#{response.code}"
+    end
+  end
+end

data/lib/relaton/iho/bibliography.rb

@@ -2,7 +2,7 @@ require "net/http"
 
 module Relaton
   module Iho
-      module Bibliography
+    module Bibliography
       ENDPOINT = "https://raw.githubusercontent.com/relaton/relaton-data-iho/refs/heads/data-v2/".freeze
 
       class << self
@@ -14,12 +14,11 @@ module Relaton
         # @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.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}#{INDEXFILE}.zip"
-          row = index.search(ref).min_by { |r| r[:id] }
+          pubid = text.is_a?(String) ? ::Pubid::Iho::Identifier.parse(text) : text
+          Util.info "Fetching from Relaton repository ...", key: pubid.to_s
+          row = index.search { |r| pubid_match?(r[:id], pubid) }.min_by { |r| row_version(r[:id]) }
           unless row
-            Util.info "Not found.", key: text
+            Util.info "Not found.", key: pubid.to_s
             return
           end
 
@@ -30,7 +29,8 @@ module Relaton
           end
 
           item = Relaton::Iho::Item.from_yaml resp.body
-          Util.info "Found: `#{item.docidentifier.first.content}`", key: text
+          enrich_with_pubid(item, pubid)
+          Util.info "Found: `#{item.docidentifier.first.content}`", key: pubid.to_s
           item.tap { |i| i.fetched = Date.today.to_s }
         rescue SocketError, Errno::EINVAL, Errno::ECONNRESET, EOFError,
               Net::HTTPBadResponse, Net::HTTPHeaderSyntaxError,
@@ -39,6 +39,31 @@ module Relaton
           raise Relaton::RequestError, "Could not access #{uri}: #{e.message}"
         end
 
+        # Populate ext.structuredidentifier from the parsed Pubid when the
+        # fetched record doesn't already provide one. Maps `pubid.number`
+        # (with type prefix, e.g. `S-100`) -> docnumber, `pubid.part` -> part,
+        # `pubid.appendix` -> appendixid, `pubid.annex` -> annexid,
+        # `pubid.supplement` -> supplementid.
+        def enrich_with_pubid(item, pubid)
+          return if item.ext&.structuredidentifier&.any?
+
+          sid = StructuredIdentifier.new(
+            docnumber: pubid_docnumber(pubid),
+            part: pubid.part,
+            appendixid: (pubid.appendix if pubid.respond_to?(:appendix)),
+            annexid: (pubid.annex if pubid.respond_to?(:annex)),
+            supplementid: (pubid.supplement if pubid.respond_to?(:supplement)),
+          )
+          item.ext ||= Ext.new
+          item.ext.structuredidentifier = [sid]
+        end
+
+        # "S-100" rather than "100" — keeps the type prefix that distinguishes
+        # the IHO series (S/P/M/B/C). Matches spec/fixtures/iho_part.xml.
+        def pubid_docnumber(pubid)
+          pubid.to_s.sub(/^IHO\s/, "").split(/\s+/, 2).first
+        end
+
         # @param ref [String] the IHO standard Code to look up (e..g "IHO B-11")
         # @param year [String] the year the standard was published (optional)
         #
@@ -51,6 +76,49 @@ module Relaton
         def get(ref, year = nil, opts = {})
           search(ref, year, opts)
         end
+
+        private
+
+        def index
+          Relaton::Index.find_or_create(
+            :iho,
+            url: "#{ENDPOINT}#{INDEXFILE}.zip",
+            file: "#{INDEXFILE}.yaml",
+            id_keys: %i[publisher number type version part appendix annex supplement],
+            pubid_class: ::Pubid::Iho::Identifier,
+          )
+        end
+
+        def pubid_match?(row_id, query)
+          row_attrs = row_attributes(row_id)
+          return false unless row_attrs
+
+          query_attrs = query.to_h
+          # Subdivision keys (part/appendix/annex/supplement) use strict
+          # equality — a nil query must match a nil row (the umbrella),
+          # not an arbitrary subdivision under the same (number, version).
+          # Only :version stays nil-tolerant: an unqualified `IHO B-11`
+          # query is expected to find the latest edition.
+          row_attrs[:publisher] == query_attrs[:publisher] &&
+            row_attrs[:type] == query_attrs[:type] &&
+            row_attrs[:number] == query_attrs[:number] &&
+            (query_attrs[:version].nil? || row_attrs[:version].to_s == query_attrs[:version].to_s) &&
+            row_attrs[:part].to_s == query_attrs[:part].to_s &&
+            row_attrs[:appendix].to_s == query_attrs[:appendix].to_s &&
+            row_attrs[:annex].to_s == query_attrs[:annex].to_s &&
+            row_attrs[:supplement].to_s == query_attrs[:supplement].to_s
+        end
+
+        def row_attributes(row_id)
+          return row_id.to_h if row_id.is_a?(::Pubid::Core::Identifier::Base)
+          return row_id if row_id.is_a?(Hash)
+
+          nil
+        end
+
+        def row_version(row_id)
+          row_attributes(row_id)&.dig(:version).to_s
+        end
       end
     end
   end

data/lib/relaton/iho/docidentifier.rb

@@ -0,0 +1,35 @@
+module Relaton
+  module Iho
+    class Docidentifier < Bib::Docidentifier
+      attr_reader :pubid
+
+      def initialize(attrs = {}, options = {})
+        pubid = attrs.is_a?(Hash) ? attrs.delete(:pubid) : nil
+        attrs[:content] ||= pubid.to_s if pubid
+        super
+        @pubid = pubid if pubid
+      end
+
+      def content=(value)
+        super
+        @pubid = ::Pubid::Iho::Identifier.parse(value) if value
+      end
+
+      def to_h
+        @pubid&.to_h || super
+      end
+
+      def remove_part!
+        @pubid&.part = nil
+      end
+
+      def remove_date!
+        @pubid&.year = nil
+      end
+
+      def to_all_parts!
+        @pubid&.all_parts = true
+      end
+    end
+  end
+end

data/lib/relaton/iho/ext.rb

@@ -1,11 +1,14 @@
 require_relative "doctype"
 require_relative "comment_period"
+require_relative "structured_identifier"
 
 module Relaton
   module Iho
     class Ext < Bib::Ext
       attribute :doctype, Doctype, default: -> { Doctype.new(content: "standard") }
       attribute :commentperiod, CommentPeriod
+      attribute :structuredidentifier, StructuredIdentifier,
+                collection: true, initialize_empty: true
 
       xml do
         map_element "commentperiod", to: :commentperiod

data/lib/relaton/iho/hash_parser_v1.rb

@@ -19,9 +19,20 @@ module Relaton
         ret[:ext][:flavor] ||= flavor(ret)
         ics_hash_to_bib ret
         commentperiod_hash_to_bib ret
+        structuredidentifier_hash_to_bib ret
         ret[:ext] = Ext.new(**ret[:ext])
       end
 
+      def structuredidentifier_hash_to_bib(ret)
+        sid = ret.dig(:ext, :structuredidentifier) || ret[:structuredidentifier]
+        return unless sid
+
+        ret[:ext]&.delete(:structuredidentifier)
+        ret.delete(:structuredidentifier)
+        ret[:ext][:structuredidentifier] =
+          array(sid).map { |s| StructuredIdentifier.new(**s) }
+      end
+
       def commentperiod_hash_to_bib(ret)
         cp = ret.dig(:ext, :commentperiod) || ret[:commentperiod]
         return unless cp
@@ -124,6 +135,10 @@ module Relaton
       def create_relation(rel)
         Relation.new(**rel)
       end
+
+      def create_docid(**args)
+        Docidentifier.new(**args)
+      end
     end
   end
 end

data/lib/relaton/iho/item.rb

@@ -1,5 +1,6 @@
 require_relative "item_data"
 require_relative "ext"
+require_relative "docidentifier"
 
 module Relaton
   module Iho
@@ -7,6 +8,8 @@ module Relaton
       model ItemData
 
       attribute :ext, Ext
+      attribute :docidentifier, Docidentifier, collection: true,
+                                               initialize_empty: true
     end
   end
 end

data/lib/relaton/iho/structured_identifier.rb

@@ -0,0 +1,20 @@
+module Relaton
+  module Iho
+    class StructuredIdentifier < Lutaml::Model::Serializable
+      attribute :docnumber, :string
+      attribute :part, :string
+      attribute :annexid, :string
+      attribute :appendixid, :string
+      attribute :supplementid, :string
+
+      xml do
+        root "structuredidentifier"
+        map_element "docnumber", to: :docnumber
+        map_element "part", to: :part
+        map_element "annexid", to: :annexid
+        map_element "appendixid", to: :appendixid
+        map_element "supplementid", to: :supplementid
+      end
+    end
+  end
+end

data/lib/relaton/iho/version.rb

@@ -1,5 +1,5 @@
 module Relaton
   module Iho
-    VERSION = "2.0.0-alpha.3".freeze
+    VERSION = "2.0.3".freeze
   end
 end

data/lib/relaton/iho.rb

@@ -1,7 +1,9 @@
 require "relaton/bib"
 require "relaton/index"
+require "pubid/iho"
 require_relative "iho/version"
 require_relative "iho/util"
+require_relative "iho/docidentifier"
 require_relative "iho/item"
 require_relative "iho/bibitem"
 require_relative "iho/bibdata"
@@ -9,7 +11,7 @@ require_relative "iho/bibliography"
 
 module Relaton
   module Iho
-    INDEXFILE = "index-v1".freeze
+    INDEXFILE = "index-v2".freeze
 
     class Error < StandardError; end
 

data/relaton_iho.gemspec

@@ -22,7 +22,8 @@ Gem::Specification.new do |s|
   s.required_ruby_version = Gem::Requirement.new(">= 3.2.0")
 
   s.add_dependency "base64"
-  s.add_dependency "relaton-bib", "~> 2.0.0-alpha.7"
+  s.add_dependency "pubid-iho", "~> 1.15.15"
+  s.add_dependency "relaton-bib", "~> 2.0.0"
   s.add_dependency "relaton-core", "~> 0.0.13"
   s.add_dependency "relaton-index", "~> 0.2.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: relaton-iho
 version: !ruby/object:Gem::Version
-  version: 2.0.0.pre.alpha.3
+  version: 2.0.3
 platform: ruby
 authors:
 - Ribose Inc.
@@ -23,20 +23,34 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: pubid-iho
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.15.15
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.15.15
 - !ruby/object:Gem::Dependency
   name: relaton-bib
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.0.0.pre.alpha.7
+        version: 2.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.0.0.pre.alpha.7
+        version: 2.0.0
 - !ruby/object:Gem::Dependency
   name: relaton-core
   requirement: !ruby/object:Gem::Requirement
@@ -93,6 +107,7 @@ files:
 - lib/relaton/iho/bibitem.rb
 - lib/relaton/iho/bibliography.rb
 - lib/relaton/iho/comment_period.rb
+- lib/relaton/iho/docidentifier.rb
 - lib/relaton/iho/doctype.rb
 - lib/relaton/iho/ext.rb
 - lib/relaton/iho/hash_parser_v1.rb
@@ -101,6 +116,7 @@ files:
 - lib/relaton/iho/item_data.rb
 - lib/relaton/iho/processor.rb
 - lib/relaton/iho/relation.rb
+- lib/relaton/iho/structured_identifier.rb
 - lib/relaton/iho/util.rb
 - lib/relaton/iho/version.rb
 - relaton_iho.gemspec