pubid-core 1.15.8 → 1.15.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c5c31d4deef63e50446985a9cb117bbadfa57e80fc26c32a3350ab48da0c28cf
-  data.tar.gz: c65ab12c6d8536dd373e6081ecd726b064a79df590cf585731f15dc4f1a88af8
+  metadata.gz: 9ee18d5ea661ba3c87383873d963bb0ec1c90fa682dfbf324f1af363a15c6a5f
+  data.tar.gz: 922cfb88f6e81323c9f8be88a8e7bf09e96ac438de16ffb50aa80f39106d89b0
 SHA512:
-  metadata.gz: 89290bcf1072622aabe37cd9921e7bde25957b69b3f17c7dd460063887962f6d759d5a5e7d3b580eafd776f3999c4b7728c42a11b72ee47cb8af0333cfdbe755
-  data.tar.gz: 35cd0cb46c87e39c1c0d4a01c85c83ab36850607de001d92ff9fc16d52fe54eccd8f1b8ee32d1e7db1ba6df96a539697a05b739bb5f2cde03c0e530ff2631f30
+  metadata.gz: 3d5ea2932415a5f336f7e29dcd3199ee6e7b8593a0d87f11685be119131989683af38e07e39a49e2d9199320bb583d245b3f59102c27901c1faa119c0bcea21d
+  data.tar.gz: 4ac1d13c7b2ff1422352b57f692b77f4bb061727381f02b69bfeb2a479fb85b016183a2dc379488da96e9a082e6da9f09a9b14a76fb18a827933571226de4bbb

data/README.adoc

@@ -29,6 +29,26 @@ pubid.to_h
 => { publisher: "ISO", number: 1, year: 1999 }
 ----
 
+=== Annotated rendering
+
+Use `to_s(annotated: true)` to produce HTML output where each semantic component
+is wrapped in a `<span>` tag with a CSS class. This is useful for styling
+individual parts of an identifier in web UIs.
+
+[source,ruby]
+----
+pubid = Identifier.parse("ISO 1234-1:2013")
+pubid.to_s(annotated: true)
+=> '<span class="publisher">ISO</span> <span class="docnumber">1234</span>-<span class="part">1</span>:<span class="year">2013</span>'
+----
+
+Available CSS classes: `publisher`, `docnumber`, `part`, `year`, `edition`,
+`amendment`, `corrigendum`, `language`, `doctype`, `stage`, `iteration`,
+`addendum`.
+
+The `annotated:` option can be combined with other `to_s` options such as
+`format:` and `lang:`.
+
 === Using #new_edition_of? to compare identifiers
 
 [source,ruby]

data/lib/pubid/core/identifier/base.rb

@@ -103,8 +103,9 @@ module Pubid::Core
       end
 
       # Render identifier using default renderer
-      def to_s
-        self.class.get_renderer_class.new(to_h(deep: false)).render
+      # @param annotated [Boolean] wrap semantic components in <span> tags
+      def to_s(annotated: false)
+        self.class.get_renderer_class.new(to_h(deep: false)).render(annotated: annotated)
       end
 
       def exclude(*args)

data/lib/pubid/core/renderer/base.rb

@@ -1,3 +1,5 @@
+require "set"
+
 module Pubid::Core::Renderer
   class Base
     attr_accessor :params
@@ -10,10 +12,58 @@ module Pubid::Core::Renderer
       "es" => "S",
     }.freeze
 
+    SEMANTIC_CLASSES = {
+      publisher: "publisher",
+      number: "docnumber",
+      part: "part",
+      year: "year",
+      edition: "edition",
+      amendments: "amendment",
+      corrigendums: "corrigendum",
+      language: "language",
+      typed_stage: "doctype",
+      stage: "stage",
+      iteration: "iteration",
+      addendum: "addendum",
+    }.freeze
+
+    SEPARATOR_CHARS = Set.new(["-", ":", "/", " ", ",", "."]).freeze
+
     def initialize(params)
       @params = params
     end
 
+    # Wraps rendered value in a <span> tag with a semantic CSS class.
+    # Leading/trailing separator characters are preserved outside the span.
+    # @param key [Symbol] parameter key (e.g. :publisher, :number)
+    # @param rendered_value [String] the rendered string value
+    # @return [String] annotated or original value
+    def annotate_value(key, rendered_value)
+      css_class = SEMANTIC_CLASSES[key]
+      return rendered_value if css_class.nil?
+
+      str = rendered_value.to_s
+      return str if str.empty?
+
+      # Extract leading separators
+      leading = ""
+      while !str.empty? && SEPARATOR_CHARS.include?(str[0])
+        leading << str[0]
+        str = str[1..]
+      end
+
+      # Extract trailing separators
+      trailing = ""
+      while !str.empty? && SEPARATOR_CHARS.include?(str[-1])
+        trailing = str[-1] + trailing
+        str = str[0..-2]
+      end
+
+      return rendered_value if str.empty?
+
+      "#{leading}<span class=\"#{css_class}\">#{str}</span>#{trailing}"
+    end
+
     # Prerender parameters and store in @prerendered_params
     # @param opts [Hash] options for render method, eg. { with_language_code: :single, with_date: true }
     # @return [Renderer::Base] self
@@ -33,11 +83,13 @@ module Pubid::Core::Renderer
     def prerender_params(params, opts)
       params.map do |key, value|
         next unless value
-        if respond_to?("render_#{key}")
-          [key, send("render_#{key}", value, opts, params)]
-        else
-          [key, value]
-        end
+        rendered = if respond_to?("render_#{key}")
+                     send("render_#{key}", value, opts, params)
+                   else
+                     value
+                   end
+        rendered = annotate_value(key, rendered) if opts[:annotated] && rendered
+        [key, rendered]
       end.compact.to_h
     end
 
@@ -78,8 +130,8 @@ module Pubid::Core::Renderer
     # Render identifier
     # @param with_date [Boolean] include year in output
     # @param with_language_code [:iso,:single] render document language as 2-letter ISO 639-1 language code or single code
-    def render(with_date: true, with_language_code: :iso, **args)
-      render_base_identifier(**args.merge({ with_date: with_date, with_language_code: with_language_code})) + @prerendered_params[:language].to_s
+    def render(with_date: true, with_language_code: :iso, annotated: false, **args)
+      render_base_identifier(**args.merge({ with_date: with_date, with_language_code: with_language_code, annotated: annotated})) + @prerendered_params[:language].to_s
     end
 
     def render_identifier(params)

data/lib/pubid/core/version.rb

@@ -1,5 +1,5 @@
 module Pubid
   module Core
-    VERSION = "1.15.8".freeze
+    VERSION = "1.15.9".freeze
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pubid-core
 version: !ruby/object:Gem::Version
-  version: 1.15.8
+  version: 1.15.9
 platform: ruby
 authors:
 - Ribose Inc.
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2026-03-19 00:00:00.000000000 Z
+date: 2026-03-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: parslet