relaton 3.0.0.pre.alpha.5 → 3.0.0.pre.alpha.7

data/lib/relaton/oasis/bibliography.rb

@@ -16,16 +16,16 @@ module Relaton
       OPTIONAL = %i[version stage part label].freeze
 
       class << self
-        def search(text, _year = nil, _opts = {}) # rubocop:disable Metrics/MethodLength
-          Util.info "Fetching from Relaton repository ...", key: text
-          row = find_index_entry(text)
+        def search(ref, _year = nil, _opts = {}) # rubocop:disable Metrics/MethodLength
+          Util.info "Fetching from Relaton repository ...", key: ref.to_s
+          row = find_index_entry(ref)
           unless row
-            Util.info "Not found.", key: text
+            Util.info "Not found.", key: ref.to_s
             return
           end
 
           uri = URI("#{ENDPOINT}#{row[:file]}")
-          parse_item(fetch_yaml(uri), text)
+          parse_item(fetch_yaml(uri), ref)
         rescue SocketError, Errno::EINVAL, Errno::ECONNRESET, EOFError,
                Net::HTTPBadResponse, Net::HTTPHeaderSyntaxError,
                Net::ProtocolError, Net::ReadTimeout,
@@ -78,11 +78,11 @@ module Relaton
         # by substring, so `OASIS amqp` resolved to some `amqp-core` record;
         # v2 matches identifiers, so a partial name no longer resolves.
         #
-        # @param text [String] the reference as the caller wrote it
+        # @param ref [String] the reference as the caller wrote it
         # @return [Hash, nil] the index row, or nil
         #
-        def find_index_entry(text)
-          pubid = parse_ref text
+        def find_index_entry(ref)
+          pubid = parse_ref ref
           return unless pubid
 
           rows = index.search(pubid)
@@ -111,12 +111,15 @@ module Relaton
         # Rescuing here would collapse "this identifier is malformed" into "no
         # such document", leaving a caller unable to tell them apart.
         #
-        # @param text [String]
+        # @param ref [String, Pubid::Oasis::Identifier]
         # @return [Pubid::Oasis::Identifier]
         # @raise [Pubid::Errors::ParseError]
         #
-        def parse_ref(text)
-          slug = text.to_s.strip.sub(/\A#{Regexp.escape PREFIX}/i, "")
+        def parse_ref(ref)
+          # A parsed pubid comes from Relaton::Db (relaton#205); it is used as it is.
+          return ref unless ref.is_a?(String)
+
+          slug = ref.to_s.strip.sub(/\A#{Regexp.escape PREFIX}/i, "")
           ::Pubid::Oasis::Identifier.parse "#{PREFIX}#{slug}"
         end
 
@@ -190,9 +193,9 @@ module Relaton
           resp.body
         end
 
-        def parse_item(yaml, text)
+        def parse_item(yaml, ref)
           item = Item.from_yaml yaml
-          Util.info "Found: `#{item.docidentifier.first.content}`", key: text
+          Util.info "Found: `#{item.docidentifier.first.content}`", key: ref.to_s
           item.tap { |i| i.fetched = Date.today.to_s }
         end
       end

data/lib/relaton/ogc/bibliography.rb

@@ -3,36 +3,37 @@ module Relaton
     module Bibliography
       extend self
 
-      # @param text [String]
+      # @param ref [String, Pubid::Ogc::Identifier]
       # @param year [String, nil]
       # @return [Relaton::Ogc::HitCollection]
-      def search(text, year = nil, _opts = {})
-        code = text.sub(/^OGC\s/, "")
+      def search(ref, year = nil, _opts = {})
+        code = ref.is_a?(String) ? ref.sub(/^OGC\s/, "") : ref
         HitCollection.new(code, year).find
       rescue Faraday::ConnectionFailed, Faraday::SSLError
         raise Relaton::RequestError, HitCollection::ENDPOINT
       end
 
-      # @param code [String]
+      # @param ref [String, Pubid::Ogc::Identifier] a reference, or its parse
+      #   from Relaton::Db (relaton#205), which is used as it is
       # @param year [String, nil]
       # @param opts [Hash]
       # @return [Relaton::Ogc::ItemData, nil]
-      def get(code, year = nil, opts = {})
-        result = bib_search_filter(code, year, opts) || (return nil)
+      def get(ref, year = nil, opts = {})
+        result = bib_search_filter(ref, year, opts) || (return nil)
         ret = bib_results_filter(result, year)
         if ret[:ret]
-          Util.info "Found: `#{ret[:ret].docidentifier.first.content}`", key: code
+          Util.info "Found: `#{ret[:ret].docidentifier.first.content}`", key: ref.to_s
           ret[:ret]
         else
-          fetch_ref_err(code, year, ret[:years])
+          fetch_ref_err(ref, year, ret[:years])
         end
       end
 
       private
 
-      def bib_search_filter(code, year, opts)
-        Util.info "Fetching from Relaton repository ...", key: code
-        search(code, year, opts)
+      def bib_search_filter(ref, year, opts)
+        Util.info "Fetching from Relaton repository ...", key: ref.to_s
+        search(ref, year, opts)
       end
 
       def bib_results_filter(result, year)
@@ -51,11 +52,11 @@ module Relaton
         { years: missed_years }
       end
 
-      def fetch_ref_err(code, year, missed_years)
-        Util.info "Not found.", key: code
+      def fetch_ref_err(ref, year, missed_years)
+        Util.info "Not found.", key: ref.to_s
         unless missed_years.empty?
           Util.info "There was no match for `#{year}`, though there " \
-                    "were matches found for `#{missed_years.join('`, `')}`.", key: code
+                    "were matches found for `#{missed_years.join('`, `')}`.", key: ref.to_s
         end
         nil
       end

data/lib/relaton/ogc/hit_collection.rb

@@ -8,7 +8,7 @@ module Relaton
 
       # @return [self]
       def find
-        return self if ref.nil? || ref.empty?
+        return self if ref.nil? || ref.to_s.empty?
 
         row = best_match ref
         return self unless row
@@ -50,7 +50,7 @@ module Relaton
       # `<nnn>` field alone, so one bucket holds every year that reused the
       # number (`05-007` and `17-007` share bucket `007`).
       #
-      # @param text [String]
+      # @param ref [String, Pubid::Ogc::Identifier]
       # @return [Hash, nil]
       #
       # The substring-scan fallback this used to take when parsing failed is
@@ -59,8 +59,8 @@ module Relaton
       # ids, so an ambiguous reference silently resolved to whichever row
       # sorted first, instead of telling the caller the reference is not an
       # identifier. ecma, w3c and xsf never had one.
-      def best_match(text)
-        pubid = parse_ref text
+      def best_match(ref)
+        pubid = parse_ref ref
         rows = index.search(pubid)
         rows.max_by { |r| [revision_key(r[:id].revision), r[:file]] }
       end
@@ -93,7 +93,7 @@ module Relaton
       # lowercases the revision, so `OGC 19-025r1`, `19-025r1`, `11-038R2` and
       # the revision-less `16-079` all parse without normalization here.
       #
-      # @param text [String]
+      # @param ref [String, Pubid::Ogc::Identifier] a pubid is returned as it is
       # @return [Pubid::Ogc::Identifier, nil]
       #
       # An unrecognized reference **raises**; like ISO, ETSI and 3GPP we let it
@@ -103,8 +103,10 @@ module Relaton
       # logs it through the `StandardError` arm at `lib/relaton/db.rb:122`.
       # Rescuing here would collapse "this identifier is malformed" into "no
       # such document", leaving a caller unable to tell them apart.
-      def parse_ref(text)
-        ::Pubid::Ogc::Identifier.parse text.to_s.strip
+      def parse_ref(ref)
+        return ref unless ref.is_a?(String)
+
+        ::Pubid::Ogc::Identifier.parse ref.strip
       end
     end
   end

data/lib/relaton/ogc/processor.rb

@@ -21,10 +21,16 @@ module Relaton
         Bibliography.get(code, date, opts)
       end
 
+      # OGC documents print their identifier without the `OGC ` token
+      # (`19-025r1`).
+      def bare_identifiers?
+        true
+      end
+
       # The `year` argument filters by publication year, but an OGC pubid's
       # `year` is the year in the document number (`19` in `OGC 19-025r1`),
       # so it cannot be folded into the key: such a query is not cached.
-      def cache_key(ref, year, opts)
+      def cache_key(ref, year, opts, parsed = nil)
         year ? nil : super
       end
 

data/lib/relaton/omg/bibliography.rb

@@ -6,23 +6,23 @@ module Relaton
     module Bibliography
       extend self
 
-      # @param text [String] the OMG standard reference
+      # @param ref [String, Pubid::Omg::Identifier] the OMG standard reference
       # @return [Relaton::Omg::Item]
-      def search(text)
-        Scraper.scrape_page text
+      def search(ref)
+        Scraper.scrape_page ref
       end
 
-      # @param code [String] the OMG standard reference
+      # @param ref [String, Pubid::Omg::Identifier] the OMG standard reference
       # @param year [String] the year the standard was published (optional)
       # @param opts [Hash] options
       # @return [Relaton::Omg::Item]
-      def get(code, _year = nil, _opts = {})
-        Util.info "Fetching from www.omg.org ...", key: code
-        result = search code
+      def get(ref, _year = nil, _opts = {})
+        Util.info "Fetching from www.omg.org ...", key: ref.to_s
+        result = search ref
         if result
-          Util.info "Found: `#{result.docidentifier.first.content}`", key: code
+          Util.info "Found: `#{result.docidentifier.first.content}`", key: ref.to_s
         else
-          Util.info "Not found.", key: code
+          Util.info "Not found.", key: ref.to_s
         end
         result
       end

data/lib/relaton/omg/scraper.rb

@@ -19,12 +19,13 @@ module Relaton
         @part = part
       end
 
-      # @param ref [String] the OMG reference, e.g. "OMG UML 2.1.1 Superstructure"
+      # @param ref [String, Pubid::Omg::Identifier] the OMG reference, e.g.
+      #   "OMG UML 2.1.1 Superstructure", or its parse from Relaton::Db
       # @return [Relaton::Omg::ItemData, nil] nil when the page is not found
       # @raise [Pubid::Errors::ParseError] when the reference is not an OMG
       #   identifier
       def self.scrape_page(ref)
-        pubid = ::Pubid::Omg::Identifier.parse(ref)
+        pubid = ref.is_a?(String) ? ::Pubid::Omg::Identifier.parse(ref) : ref
         scraper = new(pubid.acronym, pubid.version, pubid.part)
         doc = scraper.get_doc
         return if doc.nil? || scraper.fetch_link.empty?

data/lib/relaton/plateau/bibliography.rb

@@ -3,22 +3,24 @@ module Relaton
     module Bibliography
       extend self
 
-      def search(code)
-        HitCollection.new(code).find
+      # @param ref [String, Pubid::Plateau::Identifier] the reference, or the
+      #   parse that Relaton::Db routed with (relaton#205)
+      def search(ref)
+        HitCollection.new(ref).find
       end
 
       # Only a transport failure is rescued, and it becomes the
       # Relaton::RequestError that Relaton::Db retries. Anything else keeps
       # its own class: an unrecognized reference raises Pubid::Errors::ParseError
       # (relaton-cli reports it), and a bug keeps its backtrace.
-      def get(code, _year = nil, _opts = {}) # rubocop:disable Metrics/MethodLength
-        Util.info "Fetching ...", key: code
-        result = search(code).fetch_doc
+      def get(ref, _year = nil, _opts = {}) # rubocop:disable Metrics/MethodLength
+        Util.info "Fetching ...", key: ref.to_s
+        result = search(ref).fetch_doc
         if result
-          Util.info "Found `#{result.docidentifier.first.content}`", key: code
+          Util.info "Found `#{result.docidentifier.first.content}`", key: ref.to_s
           result
         else
-          Util.warn "Not found.", key: code
+          Util.warn "Not found.", key: ref.to_s
         end
       rescue SocketError, Errno::EINVAL, Errno::ECONNRESET, EOFError,
              Net::HTTPBadResponse, Net::HTTPHeaderSyntaxError,

data/lib/relaton/plateau/hit_collection.rb

@@ -44,8 +44,9 @@ module Relaton
       # (metanorma/pubid #269) — so search accepts both forms. An unrecognized
       # reference raises; like ISO and 3GPP we let it propagate — relaton-cli
       # rescues Pubid::Errors::Error. See lib/relaton/plateau/CLAUDE.md.
+      # Relaton::Db passes the reference already parsed (relaton#205).
       def pubid_ref
-        @pubid_ref ||= ::Pubid::Plateau.parse(ref)
+        @pubid_ref ||= ref.is_a?(String) ? ::Pubid::Plateau.parse(ref) : ref
       end
 
       # A reference with no edition (`PLATEAU Handbook #00`, or any Technical

data/lib/relaton/version.rb

@@ -1,3 +1,3 @@
 module Relaton
-  VERSION = "3.0.0.pre.alpha.5".freeze
+  VERSION = "3.0.0.pre.alpha.7".freeze
 end

data/lib/relaton/xsf/bibliography.rb

@@ -35,16 +35,18 @@ module Relaton
         HitCollection.new(parse_ref(ref)).search
       end
 
-      def get(code, _year = nil, _opts = {})
-        Util.info "Fetching from Relaton repository ...", key: code
-        result = search(code)
+      # @param ref [String, Pubid::Xsf::Identifier] the reference, or the
+      #   parse that Relaton::Db routed with (relaton#205)
+      def get(ref, _year = nil, _opts = {})
+        Util.info "Fetching from Relaton repository ...", key: ref.to_s
+        result = search(ref)
         if result.empty?
-          Util.info "Not found.", key: code
+          Util.info "Not found.", key: ref.to_s
           return
         end
 
         bib = result.first.item
-        Util.info "Found: `#{bib.docidentifier.first.content}`", key: code
+        Util.info "Found: `#{bib.docidentifier.first.content}`", key: ref.to_s
         bib
       end
 
@@ -66,11 +68,14 @@ module Relaton
       # Anything else raises -- see `.search`. `Pubid::Errors::ParseError`
       # includes `Pubid::Errors::Error`, which is the class relaton-cli rescues.
       #
-      # @param ref [String]
+      # @param ref [String, Pubid::Xsf::Identifier]
       # @return [Pubid::Xsf::Identifier]
       # @raise [Pubid::Errors::ParseError]
       #
       def parse_ref(ref)
+        # A parsed pubid comes from Relaton::Db (relaton#205); it is used as it is.
+        return ref unless ref.is_a?(String)
+
         ::Pubid::Xsf::Identifier.parse normalize_ref(ref)
       end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: relaton
 version: !ruby/object:Gem::Version
-  version: 3.0.0.pre.alpha.5
+  version: 3.0.0.pre.alpha.7
 platform: ruby
 authors:
 - Ribose Inc.
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2026-09-30 00:00:00.000000000 Z
+date: 2026-10-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable
@@ -428,14 +428,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.0.0.pre.alpha.13
+        version: 2.0.0.pre.alpha.21
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.0.0.pre.alpha.13
+        version: 2.0.0.pre.alpha.21
 - !ruby/object:Gem::Dependency
   name: yeptris
   requirement: !ruby/object:Gem::Requirement
@@ -450,6 +450,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0.4'
+- !ruby/object:Gem::Dependency
+  name: relaton-render
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.4.0.pre.alpha.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.4.0.pre.alpha.1
 - !ruby/object:Gem::Dependency
   name: rfcxml
   requirement: !ruby/object:Gem::Requirement