pubid-ieee 1.15.20 → 1.15.21

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 38d7e58ff2f4e451874d717947c4d2dce138a1a62c0c36f9787386d827ada798
-  data.tar.gz: a63b04818ec29b81d7f32db27db39b892f4c721128c135cf2a029a8f2627a4c0
+  metadata.gz: 75b9839570a5fb3f9ee5de1ca4061d4942f67b41edadf02f6677573fb05bd069
+  data.tar.gz: b09e077b53a3f6b7994fdff617ab86a89fb05f6f586d71a98ff248127f7fa6a6
 SHA512:
-  metadata.gz: 57f33fb06e1e6be76ce76c3ce716203ff996cba8129a1e49b9a547a829f596a81973d3a49f6965f487d74b546c059ee208dd5f8f0cb944967b14f14fd4958b89
-  data.tar.gz: 52315f910038b01d0ecbc10bc7b0931261673c4f9ba264b52a460bef62ce8ece1bf75a93d678beafed8261e15fef9902cded155d8aa5caa2eb32a759387fc59a
+  metadata.gz: 3e4437f8a8aefec0dfc5b17f79b31783ba079715aa77e786d3cd4a8fac09355cb8e9122308d450f30e123490b5cc469397f23c1af1bef24ffb988a6d592a7476
+  data.tar.gz: f3ac0c314d7f9c46e8947681e81d2ad1bdc7a7b354689bf6a00f702adce1011002baa3dd6895633e8a8d45c40d9abd987e7443e7b23dce98f804d196e2db751a

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

@@ -143,16 +143,68 @@ module Pubid::Ieee
         Identifier.create(**identifier_params)
       end
 
+      # IEEE series carrying a registered trademark ("\u00AE"); everything else
+      # takes the unregistered mark ("\u2122"). 8802 is the ISO/IEC co-published
+      # form of the 802 series, and a project number keeps its series identity,
+      # so a leading "P" is stripped before the lookup.
+      REGISTERED_SERIES = %w[802 8802 2030].freeze
+
+      # The ISO/IEC adoption of IEEE 802: the number alone identifies the
+      # series, whatever publishers are printed.
+      ISO_ADOPTED_SERIES = "8802".freeze
+
       # @param [:short, :full] format
       def to_s(format = :short, with_trademark: false, annotated: false)
         opts = { format: format, with_trademark: with_trademark, annotated: annotated }
+        params = to_h(deep: false)
+        # IEEE attaches the mark to the standard number, before the year and
+        # every suffix ("IEEE Std 1619\u2122-2007"), so it is rendered from a
+        # dedicated slot in the format templates rather than appended to the
+        # finished string. An identifier without a number of its own (an
+        # ISO-led co-publication) carries its IEEE designation in the
+        # parenthesised alternative, which is marked by the renderer instead.
+        params[:trademark] = trademark(@number) if with_trademark && @number
         (@iso_identifier ? @iso_identifier.to_s(format: :ref_num_short, with_edition: true, annotated: annotated) : "") +
-          self.class.get_renderer_class.new(to_h(deep: false)).render(**opts) +
-          (with_trademark ? trademark(@number) : "")
+          self.class.get_renderer_class.new(params).render(**opts) +
+          (with_trademark && !marks_a_number? ? trademark(fallback_number) : "")
       end
 
+      # True when the rendered string carries the mark on a number of its own:
+      # either this identifier's number, or the IEEE designation it renders as
+      # a parenthesised alternative. A form that renders neither -- an
+      # ISO-led document with no IEEE designation of its own, such as
+      # "ISO/IEC/IEEE 8802-11:2012/Amd.1:2013(E)" or "IEC 61588:2009(E)" --
+      # keeps the trailing mark rather than losing it altogether.
+      def marks_a_number?
+        !@number.nil? || !@alternative.nil?
+      end
+
+      # Document number to pick the symbol from when the mark falls back to the
+      # end of the string. The ISO identifier holds the only number there is,
+      # and for a supplement it is the *base* document that carries the series
+      # (an amendment's own `number` is its ordinal, "1").
+      def fallback_number
+        return @number if @number
+
+        iso = @iso_identifier
+        iso = iso.base while iso.respond_to?(:base) && iso.base
+        iso&.number
+      end
+
+      # The registered mark belongs to IEEE, so it is claimed only when IEEE
+      # is among the printed publishers -- another body may simply have
+      # numbered a document 802 or 2030 ("AIEE Std No. 802" predates the IEEE
+      # 802 series by two decades). The ISO/IEC adoption 8802 is identified by
+      # its number alone, whatever publishers are printed.
       def trademark(number)
-        %w(802 2030).include?(number.to_s) ? "\u00AE" : "\u2122"
+        bare = number.to_s.sub(/\AP/, "")
+        return "\u2122" unless REGISTERED_SERIES.include?(bare)
+        return "\u00AE" if bare == ISO_ADOPTED_SERIES
+
+        ieee = [@publisher, *@copublisher].compact.any? do |publisher|
+          publisher.to_s.split("/").include?("IEEE")
+        end
+        ieee ? "\u00AE" : "\u2122"
       end
 
       class << self

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

@@ -1,19 +1,22 @@
 module Pubid::Ieee::Renderer
   class Base < Pubid::Core::Renderer::Base
     def render_identifier(params)
+      # %{trademark} sits immediately after the number (and its part/subpart):
+      # IEEE attaches the mark to the standard number, before the year, the
+      # draft, the corrigendum and every other suffix — "IEEE Std 802.3®-2018".
       if params[:iso_identifier].to_s != "" && params[:number] != ""
-        " (%{publisher}%{stage}%{draft_status}%{type}%{number}%{iteration}%{part}%{subpart}%{month}%{year}%{corrigendum_comment}"\
+        " (%{publisher}%{stage}%{draft_status}%{type}%{number}%{iteration}%{part}%{subpart}%{trademark}%{month}%{year}%{corrigendum_comment}"\
         "%{corrigendum}%{draft}%{edition})%{alternative}%{supersedes}%{reaffirmed}%{incorporates}%{supplement}"\
         "%{revision}%{iso_amendment}%{amendment}%{edition}%{includes}%{redline}%{adoption}" % params
       else
         if params[:day].empty? && params[:month].empty?
           # if only year - edition and draft after year
-          "%{publisher}%{draft_status}%{type}%{number}%{part}%{subpart}%{stage}"\
+          "%{publisher}%{draft_status}%{type}%{number}%{part}%{subpart}%{trademark}%{stage}"\
           "%{year}%{edition}%{corrigendum_comment}%{corrigendum}%{draft}%{alternative}%{supersedes}%{reaffirmed}%{incorporates}%{supplement}"\
           "%{revision}%{iso_amendment}%{amendment}%{includes}%{redline}%{adoption}" % params
         else
           # if year and month - edition and draft before
-          "%{publisher}%{draft_status}%{type}%{number}%{part}%{subpart}%{edition}%{stage}"\
+          "%{publisher}%{draft_status}%{type}%{number}%{part}%{subpart}%{trademark}%{edition}%{stage}"\
           "%{corrigendum_comment}%{corrigendum}%{draft}%{month}%{day}%{year}%{alternative}%{supersedes}%{reaffirmed}%{incorporates}%{supplement}"\
           "%{revision}%{iso_amendment}%{amendment}%{includes}%{redline}%{adoption}" % params
         end
@@ -107,12 +110,21 @@ module Pubid::Ieee::Renderer
       # result
     end
 
-    def render_alternative(alternative, _opts, _params)
-      if alternative.is_a?(Array)
-        " (#{alternative.map { |a| Pubid::Ieee::Identifier::Base.new(**Pubid::Ieee::Identifier.convert_parser_parameters(**a)) }.join(', ')})"
-      else
-        " (#{Pubid::Ieee::Identifier::Base.new(**Pubid::Ieee::Identifier.convert_parser_parameters(**alternative))})"
+    def render_alternative(alternative, opts, params)
+      # An ISO-led co-publication has no IEEE number of its own — its IEEE
+      # designation is this alternative, so the trademark belongs on that
+      # number rather than on the ISO one.
+      with_trademark = opts[:with_trademark] && !params[:number]
+
+      # `annotated` is deliberately not propagated — the nested alternative was
+      # never annotated before, and this must not change plain rendering.
+      alternatives = (alternative.is_a?(Array) ? alternative : [alternative]).map do |a|
+        Pubid::Ieee::Identifier::Base
+          .new(**Pubid::Ieee::Identifier.convert_parser_parameters(**a))
+          .to_s(with_trademark: with_trademark || false)
       end
+
+      " (#{alternatives.join(', ')})"
     end
 
     def render_draft(draft, _opts, params)

data/lib/pubid/ieee/version.rb

@@ -1,5 +1,5 @@
 module Pubid
   module Ieee
-    VERSION = "1.15.20".freeze
+    VERSION = "1.15.21".freeze
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pubid-ieee
 version: !ruby/object:Gem::Version
-  version: 1.15.20
+  version: 1.15.21
 platform: ruby
 authors:
 - Ribose Inc.
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2026-06-26 00:00:00.000000000 Z
+date: 2026-08-17 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.20
+        version: 1.15.21
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.15.20
+        version: 1.15.21
 description: Library to generate, parse and manipulate IEEE PubID.
 email:
 - open.source@ribose.com