pubid-iso 1.15.8 → 1.15.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1893bea151d26da77c42fde6779f38a9bb07f4807115c567a52811ac4e9bb41a
-  data.tar.gz: 68d31036867e076d3f597c22774e95b62662ea01709c3944b22a78d3ed2e3cb5
+  metadata.gz: 9f281981e42f4fe123fb11766a42a161efe7ea7ca67177217cb7b0e25abf605f
+  data.tar.gz: db7553520345a7860be01d909404dd208355f62bd6c3ea89debf80c259c7ca24
 SHA512:
-  metadata.gz: 96ec944e72e01a6b9e53a429ad12fb89250801a6f49570da9d3b68facb03c51ebce36b9088eb6de9b86d4498c3ca14cff4c8819bbcd5c3ce2decf1393b0f090d
-  data.tar.gz: b6553af3511c3de43919bc6b871dd8996200f0620c2e9fb96e73f379d72227ec6d5cb2c8cbb12e165c92e5c4fbb281df1bd9620cf8e6b9b4256cb6c8c6b2d7ed
+  metadata.gz: a892b598fb4be0cb9e2e59bff00f51a55138db6071db1e8d17a9bafc4acdef9afdb16cc48a8cc9be4fe2afa4f5293034e3b26ab4bdf994bc85915721ef8747ce
+  data.tar.gz: f434672ef4e38510f2d8af2c40104e859b7d9e9a2c885063c3555e2c3d4cf349fc89f6f1c7da42b915993c18e76f374212e20f1765a250b85a60a14fd5bf2e95

data/README.adoc

@@ -162,6 +162,30 @@ to see all available options.
 => "ISO 8601-1:2019/DAM 1"
 ----
 
+=== Annotated rendering
+
+Use `to_s(annotated: true)` to wrap each semantic component of the identifier in
+an HTML `<span>` tag with a CSS class, useful for styling in web applications.
+
+[source,ruby]
+----
+> pubid = Pubid::Iso::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>'
+----
+
+With copublisher and document type:
+
+[source,ruby]
+----
+> pubid = Pubid::Iso::Identifier.parse("ISO/IEC TR 2131-1:2013")
+> pubid.to_s(annotated: true)
+=> '<span class="publisher">ISO/IEC</span> <span class="doctype">TR</span> <span class="docnumber">2131</span>-<span class="part">1</span>:<span class="year">2013</span>'
+----
+
+The `annotated:` option can be combined with other `to_s` options like `format:`,
+`lang:`, etc.
+
 === Using language specific rendering
 [source,ruby]
 ----

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

@@ -266,11 +266,12 @@ module Pubid::Iso
       #   :ref_undated -- reference undated: no language code + short form (DAM) + undated
       #   :ref_undated_long -- reference undated long: 1 letter language code + long form (DAmd) + undated
       # @return [String] pubid identifier
-      def to_s(lang: nil, with_edition: false, with_prf: false, format: :ref_dated_long)
+      def to_s(lang: nil, with_edition: false, with_prf: false, format: :ref_dated_long, annotated: false)
         options = resolve_format(format)
         options[:with_edition] = with_edition
         options[:with_prf] = with_prf
         options[:language] = lang
+        options[:annotated] = annotated
 
         self.class.get_renderer_class.new(to_h(deep: false)).render(**options) +
           render_joint_document(@joint_document) + render_all_parts

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

@@ -32,10 +32,11 @@ module Pubid::Iso::Renderer
     # Render identifier
     # @param with_edition [Boolean] include edition in output
     # @see Pubid::Core::Renderer::Base for another options
-    def render(with_edition: true, with_language_code: :iso, with_date: true, **args)
+    def render(with_edition: true, with_language_code: :iso, with_date: true, annotated: false, **args)
       render_base_identifier(**args.merge({ with_date: with_date,
                                             with_language_code: with_language_code,
-                                            with_edition: with_edition })) +
+                                            with_edition: with_edition,
+                                            annotated: annotated })) +
         @prerendered_params[:language].to_s
     end
 
@@ -54,6 +55,10 @@ module Pubid::Iso::Renderer
     def render_identifier(params, opts)
       stage = params.key?(:stage) ? postrender_stage(params[:stage], opts, params) : ""
       type = render_type_prefix(params, opts)
+      if opts[:annotated]
+        stage = annotate_value(:stage, stage) if stage && !stage.to_s.empty?
+        type = annotate_value(:typed_stage, type) if type && !type.to_s.empty?
+      end
       "%<publisher>s#{stage}#{type} %<number>s%<part>s%<iteration>s%<year>s%" \
       "<amendments>s%<corrigendums>s%<addendum>s%<edition>s" % params
     end

data/lib/pubid/iso/renderer/supplement.rb

@@ -7,11 +7,11 @@ module Pubid::Iso::Renderer
     # Render identifier
     # @param with_edition [Boolean] include edition in output
     # @see Pubid::Core::Renderer::Base for another options
-    def render(with_edition: true, with_language_code: :iso, with_date: true, **args) # rubocop:disable Metrics/MethodLength
-      @params[:base].to_s(lang: args[:language], with_edition: with_edition) +
+    def render(with_edition: true, with_language_code: :iso, with_date: true, annotated: false, **args) # rubocop:disable Metrics/MethodLength
+      @params[:base].to_s(lang: args[:language], with_edition: with_edition, annotated: annotated) +
         super(
           with_edition: with_edition, with_language_code: with_language_code, with_date: with_date,
-          base_type: @params[:base].type[:key],
+          annotated: annotated, base_type: @params[:base].type[:key],
           **args
         ) +
         if !@params[:language] && @params[:base].language

data/lib/pubid/iso/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pubid-iso
 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
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.15.8
+        version: 1.15.9
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.15.8
+        version: 1.15.9
 description: Library to generate, parse and manipulate ISO PubID.
 email:
 - open.source@ribose.com