pubid 2.0.0.pre.alpha.2 → 2.0.0.pre.alpha.3

data/lib/pubid/ashrae/identifier.rb

@@ -2,7 +2,13 @@
 
 module Pubid
   module Ashrae
+    # `extend Pubid::IdentifierFacade` adds polymorphic `from_hash` and pairs
+    # with `include Pubid::Ashrae::Identifier` in Identifiers::Base for identity
+    # (`is_a?`/`===`), so a consumer handed this module can deserialize and
+    # identity-check ASHRAE ids through it.
     module Identifier
+      extend Pubid::IdentifierFacade
+
       # Parse an ASHRAE identifier string into an identifier object
       # @param identifier [String] The ASHRAE identifier string to parse
       # @return [Identifiers::Base] The appropriate identifier object
@@ -13,45 +19,6 @@ module Pubid
       rescue Parslet::ParseFailed => e
         raise "Failed to parse ASHRAE identifier '#{identifier}': #{e.message}"
       end
-
-      # Factory that builds an ASHRAE identifier from a hash of primitives.
-      # Dispatch on `:type` to the matching subclass; default is
-      # {Identifiers::Standard}.
-      TYPE_KEY_TO_KLASS = {
-        standard:         "Standard",
-        guideline:        "Guideline",
-        addendum:         "Addendum",
-        addenda_package:  "AddendaPackage",
-        combined_addenda: "CombinedAddenda",
-        errata:           "Errata",
-        interpretation:   "Interpretation",
-      }.freeze
-
-      def self.create(type: nil, **opts)
-        klass = resolve_create_class(type)
-        klass.new(**coerce_create_attrs(opts))
-      end
-
-      def self.resolve_create_class(type)
-        return Identifiers::Standard if type.nil?
-
-        klass_name = TYPE_KEY_TO_KLASS[type.to_sym]
-        raise ArgumentError, "Unknown ASHRAE type: #{type.inspect}" unless klass_name
-
-        Identifiers.const_get(klass_name)
-      end
-
-      def self.coerce_create_attrs(opts)
-        attrs = { publisher: (opts[:publisher] || "ASHRAE").to_s }
-        if (v = opts[:code] || opts[:number])
-          attrs[:code] = v.to_s
-        end
-        %i[year suffix amendment reaffirmed copublisher].each do |k|
-          attrs[k] = opts[k].to_s unless opts[k].nil?
-        end
-        attrs
-      end
-      private_class_method :resolve_create_class, :coerce_create_attrs
     end
   end
 end

data/lib/pubid/ashrae/identifiers/addenda_package.rb

@@ -27,16 +27,6 @@ module Pubid
             short: "Addenda Package" }
         end
 
-        def to_s
-          return base_identifier.to_s unless base_identifier
-
-          # Format: ASHRAE Standard 52.2-1999: Addenda Supplement Package
-          result = "ASHRAE #{base_identifier.type || 'Standard'} #{base_identifier.code}"
-          result += "-#{base_identifier.year}" if base_identifier.year
-          result += ": Addenda #{package_description}" if package_description
-          result
-        end
-
         def copublisher
           base_identifier&.copublisher
         end

data/lib/pubid/ashrae/identifiers/addendum.rb

@@ -27,25 +27,6 @@ module Pubid
           { key: :addendum, title: "ASHRAE Addendum", short: "Addendum" }
         end
 
-        def to_s
-          return base_identifier.to_s unless base_identifier
-
-          # Determine base type name for rendering
-          base_type = base_identifier.type || "Standard"
-
-          if copublisher
-            # Format: ANSI/ASHRAE Addendum a to ANSI/ASHRAE Standard 15-2019
-            result = "#{copublisher} Addendum #{addendum_code} to #{base_identifier}"
-          else
-            # Format: ASHRAE Addendum a to Standard 15-2001
-            result = "ASHRAE Addendum #{addendum_code} to #{base_type} #{base_identifier.code}"
-            result += "-#{base_identifier.year}" if base_identifier.year
-          end
-
-          result += " (#{addendum_date})" if addendum_date
-          result
-        end
-
         def copublisher
           base_identifier&.copublisher
         end

data/lib/pubid/ashrae/identifiers/base.rb

@@ -5,6 +5,9 @@ module Pubid
     module Identifiers
       # Base class for all ASHRAE identifiers
       class Base < Pubid::Identifier
+        # Identity for the Pubid::Ashrae::Identifier facade (see its comment).
+        include Pubid::Ashrae::Identifier
+
         attribute :publisher, :string, default: "ASHRAE"
         attribute :code, :string
         attribute :year, :string

data/lib/pubid/ashrae/identifiers/combined_addenda.rb

@@ -27,21 +27,6 @@ module Pubid
             short: "Addenda" }
         end
 
-        def to_s
-          return base_identifier.to_s unless base_identifier
-
-          base_type = base_identifier.type || "Standard"
-          if addendum_codes
-            # Format: ASHRAE Addenda c and d to Standard 15-1994
-            result = "ASHRAE Addenda #{addendum_codes} to #{base_type} #{base_identifier.code}"
-          else
-            # Format: ASHRAE Addenda to Standard 15-1994 (no specific codes)
-            result = "ASHRAE Addenda to #{base_type} #{base_identifier.code}"
-          end
-          result += "-#{base_identifier.year}" if base_identifier.year
-          result
-        end
-
         def copublisher
           base_identifier&.copublisher
         end

data/lib/pubid/ashrae/identifiers/errata.rb

@@ -24,16 +24,6 @@ module Pubid
         def self.type
           { key: :errata, title: "ASHRAE Errata", short: "Errata" }
         end
-
-        def to_s
-          return base_identifier.to_s unless base_identifier
-
-          # Format: ASHRAE Guideline 0-2005 Errata (September 28, 2011)
-          result = base_identifier.to_s
-          result += " Errata"
-          result += " (#{errata_date})" if errata_date
-          result
-        end
       end
     end
   end

data/lib/pubid/ashrae/identifiers/interpretation.rb

@@ -23,16 +23,6 @@ module Pubid
           { key: :interpretation, title: "ASHRAE Interpretations",
             short: "Interpretations" }
         end
-
-        def to_s
-          return base_identifier.to_s unless base_identifier
-
-          # Format: Interpretations for Standard 15.2-2022
-          base_type = base_identifier.type || "Standard"
-          result = "Interpretations for #{base_type} #{base_identifier.code}"
-          result += "-#{base_identifier.year}" if base_identifier.year
-          result
-        end
       end
     end
   end

data/lib/pubid/ashrae/renderer.rb

@@ -0,0 +1,117 @@
+# frozen_string_literal: true
+
+module Pubid
+  module Ashrae
+    # Human-readable renderer for ASHRAE identifiers.
+    #
+    # Produces strings like:
+    #   "ASHRAE Standard 15-2024"
+    #   "ASHRAE Guideline 0-2019"
+    #   "ASHRAE Addendum a to Standard 15-2001"
+    #   "ASHRAE Standard 52.2-1999: Addenda Supplement Package"
+    #   "ASHRAE Addenda c and d to Standard 15-1994"
+    #   "ASHRAE Guideline 0-2005 Errata (September 28, 2011)"
+    #   "Interpretations for Standard 15.2-2022"
+    #
+    # The renderer is registered as the +:human+ format in the ASHRAE format
+    # registry and invoked via +render(format: :human)+.
+    class Renderer < ::Pubid::Renderers::Base
+      def render(context: nil, **_opts)
+        id = @id
+
+        case id
+        when Identifiers::Addendum
+          render_addendum(id)
+        when Identifiers::AddendaPackage
+          render_addenda_package(id)
+        when Identifiers::CombinedAddenda
+          render_combined_addenda(id)
+        when Identifiers::Errata
+          render_errata(id)
+        when Identifiers::Interpretation
+          render_interpretation(id)
+        when SingleIdentifier
+          render_single(id)
+        else
+          render_single(id)
+        end
+      end
+
+      private
+
+      # SingleIdentifier (Standard, Guideline): "ASHRAE Standard 15-2024"
+      def render_single(id)
+        parts = []
+        parts << id.publisher if id.publisher
+        parts << id.type.to_s if id.type
+        result = parts.join(" ")
+        result += " " if result.length.positive?
+        result += id.code.to_s
+        result += "-#{id.year}" if id.year
+        result += " (#{id.amendment})" if id.amendment
+        result += id.suffix if id.suffix
+        result += " (RA#{id.reaffirmed})" if id.reaffirmed
+        result
+      end
+
+      # Addendum: "ASHRAE Addendum a to Standard 15-2001"
+      def render_addendum(id)
+        return id.base_identifier.to_s unless id.base_identifier
+
+        base_type = id.base_identifier.type || "Standard"
+
+        if id.copublisher
+          "#{id.copublisher} Addendum #{id.addendum_code} to #{id.base_identifier}"
+        else
+          result = "ASHRAE Addendum #{id.addendum_code} to #{base_type} #{id.base_identifier.code}"
+          result += "-#{id.base_identifier.year}" if id.base_identifier.year
+          result
+        end.tap { |r| r << " (#{id.addendum_date})" if id.addendum_date }
+      end
+
+      # AddendaPackage: "ASHRAE Standard 52.2-1999: Addenda Supplement Package"
+      def render_addenda_package(id)
+        return id.base_identifier.to_s unless id.base_identifier
+
+        result = "ASHRAE #{id.base_identifier.type || 'Standard'} #{id.base_identifier.code}"
+        result += "-#{id.base_identifier.year}" if id.base_identifier.year
+        result += ": Addenda #{id.package_description}" if id.package_description
+        result
+      end
+
+      # CombinedAddenda: "ASHRAE Addenda c and d to Standard 15-1994"
+      def render_combined_addenda(id)
+        return id.base_identifier.to_s unless id.base_identifier
+
+        base_type = id.base_identifier.type || "Standard"
+        if id.addendum_codes
+          result = "ASHRAE Addenda #{id.addendum_codes} to #{base_type} #{id.base_identifier.code}"
+        else
+          result = "ASHRAE Addenda to #{base_type} #{id.base_identifier.code}"
+        end
+        result += "-#{id.base_identifier.year}" if id.base_identifier.year
+        result
+      end
+
+      # Errata: "ASHRAE Guideline 0-2005 Errata (September 28, 2011)"
+      def render_errata(id)
+        return id.base_identifier.to_s unless id.base_identifier
+
+        result = id.base_identifier.to_s
+        result += " Errata"
+        result += " (#{id.errata_date})" if id.errata_date
+        result
+      end
+
+      # Interpretation: "Interpretations for Standard 15.2-2022"
+      def render_interpretation(id)
+        return id.base_identifier.to_s unless id.base_identifier
+
+        base_type = id.base_identifier.type || "Standard"
+        result = "Interpretations for #{base_type} #{id.base_identifier.code}"
+        result += "-#{id.base_identifier.year}" if id.base_identifier.year
+        result
+      end
+    end
+  end
+end

data/lib/pubid/ashrae/single_identifier.rb

@@ -5,19 +5,6 @@ module Pubid
     # Base class for single (non-supplement) ASHRAE identifiers
     # Includes: Guideline, Standard
     class SingleIdentifier < Identifiers::Base
-      def to_s
-        parts = []
-        parts << publisher if publisher
-        parts << type.to_s if type
-        result = parts.join(" ")
-        result += " " if result.length.positive?
-        result += code.to_s
-        result += "-#{year}" if year
-        result += " (#{amendment})" if amendment
-        result += suffix if suffix
-        result += " (RA#{reaffirmed})" if reaffirmed
-        result
-      end
     end
   end
 end

data/lib/pubid/ashrae/urn_generator.rb

@@ -9,14 +9,6 @@ module Pubid
         identifier.code.to_s
       end
 
-      def urn_year
-        if identifier.year
-          return identifier.year.to_s
-        end
-
-        nil
-      end
-
       def urn_suffix
         identifier.suffix&.to_s&.downcase
       end

data/lib/pubid/ashrae/urn_parser.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module Pubid
+  module Ashrae
+    # Parses ASHRAE URNs back into identifiers.
+    #
+    # UrnGenerator emits:
+    #   urn:ashrae:{number}:{year}:{type}[:{suffix}][:amd.{N}][:reaff.{Y}]
+    #
+    # The type token follows the year; the human-readable form prefixes the
+    # type ("ASHRAE Standard 90.1-2019"). The year separator is `-`.
+    #
+    # Examples:
+    # - urn:ashrae:90.1:2019:standard → ASHRAE Standard 90.1-2019
+    class UrnParser < Pubid::UrnParser::Base
+      def parse_urn(urn)
+        body = strip_namespace(urn)
+        parts = split_parts(body)
+
+        number, year = parts
+        text = "ASHRAE Standard #{number}"
+        text += "-#{year}" if year
+        flavor_parse(text)
+      end
+    end
+  end
+end

data/lib/pubid/ashrae.rb

@@ -6,16 +6,57 @@ module Pubid
     autoload :Identifier, "#{__dir__}/ashrae/identifier"
     autoload :Identifiers, "#{__dir__}/ashrae/identifiers"
     autoload :Parser, "#{__dir__}/ashrae/parser"
-    autoload :Scheme, "#{__dir__}/ashrae/scheme"
+    autoload :Renderer, "#{__dir__}/ashrae/renderer"
     autoload :SingleIdentifier, "#{__dir__}/ashrae/single_identifier"
     autoload :SupplementIdentifier, "#{__dir__}/ashrae/supplement_identifier"
     autoload :UrnGenerator, "#{__dir__}/ashrae/urn_generator"
+    autoload :UrnParser, "#{__dir__}/ashrae/urn_parser"
 
     def self.parse(identifier)
       Identifier.parse(identifier)
     end
+
+    # Auto-discover all identifier types from the Identifiers namespace
+    # @return [Array<Class>] identifier classes that define a self.type Hash
+    def self.identifier_types
+      @identifier_types ||= Identifiers.constants
+        .filter_map { |c| begin; Identifiers.const_get(c); rescue NameError; nil; end }
+        .select { |c| c.is_a?(Class) && c.singleton_methods(false).include?(:type) }
+        .select { |c| c.type.is_a?(Hash) }
+    end
+
+    # Build typed stage index from identifier types
+    # @return [Array<Pubid::Components::TypedStage>] all typed stages
+    def self.all_typed_stages
+      @all_typed_stages ||= identifier_types.flat_map do |klass|
+        if klass.const_defined?(:TYPED_STAGES)
+          klass.const_get(:TYPED_STAGES)
+        else
+          []
+        end
+      end
+    end
+
+    # Lookup: type code -> identifier class
+    # @param code [String, Symbol] the type key to find
+    # @return [Class, nil] the matching identifier class
+    def self.locate_type(code)
+      identifier_types.find { |t| t.type[:key].to_s == code.to_s }
+    end
+
+    # Lookup: abbreviation -> typed stage
+    # @param abbr [String, Symbol] the abbreviation to find
+    # @return [Pubid::Components::TypedStage, nil] the matching typed stage
+    def self.locate_stage(abbr)
+      abbr_str = abbr.to_s.upcase
+      all_typed_stages.find { |s| s.abbr.any? { |a| a.to_s.upcase == abbr_str } }
+    end
   end
 end
 
 # Register Uashrae flavor with the registry
 Pubid::Registry.register(:ashrae, Pubid::Ashrae)
+
+# Per-flavor format registry: inherits global formats, overrides :human
+Pubid::Ashrae::Identifiers::Base.format_registry = Pubid::FormatRegistry.new(parent: Pubid::Identifier.format_registry)
+Pubid::Ashrae::Identifiers::Base.format_registry.register(:human, renderer: Pubid::Ashrae::Renderer)

data/lib/pubid/asme/components/code.rb

@@ -5,11 +5,19 @@ require "lutaml/model"
 module Pubid
   module Asme
     module Components
+      # Code component for ASME identifiers.
+      #
+      # Stays independent of Pubid::Components::Code because ASME uses
+      # +designator+ (a flavor-specific letter prefix) plus +number+.
       class Code < Lutaml::Model::Serializable
-        attribute :designator, :string    # B, Y, BPVC, etc.
-        attribute :number, :string        # 16.5, 14.43, III.1.NB, etc.
+        attribute :designator, :string
+        attribute :number, :string
 
         def to_s
+          render
+        end
+
+        def render(context: nil)
           "#{designator}#{number}"
         end
       end

data/lib/pubid/asme/identifier.rb

@@ -10,52 +10,6 @@ module Pubid
         parsed = parser.parse(str)
         builder.build(parsed)
       end
-
-      # Factory that builds an ASME identifier from a hash of primitives.
-      # Default is {Identifiers::Standard}. ASME's Code Component has
-      # `:designator` (leading letters, e.g. "B") and `:number` (rest,
-      # e.g. "16.34"); `.create` accepts either an already-split pair or
-      # a combined `:code` string which it splits at the first digit.
-      def self.create(**opts)
-        Identifiers::Standard.new(**coerce_create_attrs(opts))
-      end
-
-      def self.coerce_create_attrs(opts)
-        attrs = { publisher: (opts[:publisher] || "ASME").to_s }
-
-        if opts[:designator] || opts[:number]
-          attrs[:code] = Pubid::Asme::Components::Code.new(
-            designator: opts[:designator]&.to_s,
-            number:     opts[:number]&.to_s,
-          )
-        elsif (combined = opts[:code])
-          designator, number = split_asme_code(combined.to_s)
-          attrs[:code] = Pubid::Asme::Components::Code.new(
-            designator: designator,
-            number:     number,
-          )
-        end
-
-        %i[year reaffirmation language csa_number draft_year
-           revision_note parenthetical_revision ptc_suffix
-           joint_publisher first_publisher first_code].each do |k|
-          attrs[k] = opts[k].to_s unless opts[k].nil?
-        end
-        attrs[:handbook] = opts[:handbook] if opts.key?(:handbook)
-        attrs
-      end
-
-      # ASME codes pair a letter designator with a numeric/dotted number.
-      # Split at the first digit. "B16.34" → ["B", "16.34"]; "Y14.5" →
-      # ["Y", "14.5"]; "BPVC.III.1.NB" → ["BPVC.III.1.NB", nil] (no
-      # leading all-letters before the first digit — pass through).
-      def self.split_asme_code(str)
-        match = str.match(/\A([A-Za-z]+)(\d.*)\z/)
-        return match.captures if match
-
-        [str, nil]
-      end
-      private_class_method :coerce_create_attrs, :split_asme_code
     end
   end
 end

data/lib/pubid/asme/identifiers/base.rb

@@ -4,66 +4,6 @@ module Pubid
   module Asme
     module Identifiers
       class Base < SingleIdentifier
-        def to_s
-          # Handle joint published identifiers
-          parts = []
-          if first_publisher && first_code
-            # CSA B44.10/ASME A17.10 or API 579-2/ASME PTB-14 format
-            parts << first_publisher
-            parts << first_code
-            parts << "/#{second_publisher}" if second_publisher
-            parts << code.to_s if code && code.to_s != ""
-
-          elsif joint_publisher
-            # ISO/ASME or ASME/ANS format
-            parts << joint_publisher
-            parts << code.to_s if code && code.to_s != ""
-
-          else
-            # Standard ASME format
-            parts << publisher if publisher
-            parts << code.to_s if code
-
-          end
-          result = parts.join(" ")
-
-          # PTC suffix (space-separated)
-          if ptc_suffix
-            result += " #{ptc_suffix}"
-          end
-
-          # CSA dual-published (for ASME/CSA format)
-          if csa_number
-            result += "/CSA #{csa_number}"
-          end
-
-          # Handbook keyword
-          if handbook
-            result += " Handbook"
-          end
-
-          # Year
-          if draft_year
-            result += "-#{draft_year}"
-          elsif year
-            result += "-#{year}"
-          end
-
-          # Parenthetical revision (comes after year)
-          result += " #{parenthetical_revision}" if parenthetical_revision
-
-          # Language (can appear in rendered output)
-          result += " (#{language})" if language
-
-          # Reaffirmation
-          result += " (#{reaffirmation})" if reaffirmation
-
-          # Revision note
-          result += " #{revision_note}" if revision_note
-
-          # Normalize all em-dashes (–, —) and en-dashes to regular dash (-)
-          result.gsub(/[–—]/, "-")
-        end
       end
     end
   end

data/lib/pubid/asme/renderer.rb

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+
+module Pubid
+  module Asme
+    # Human-readable renderer for ASME identifiers.
+    #
+    # Produces strings like:
+    #   "ASME B16.5-2020"
+    #   "CSA B44.10/ASME A17.10"
+    #   "ASME BPVC III.1.NB-2023"
+    #   "ASME PTC 4-2013"
+    #
+    # The renderer is registered as the `:human` format in the ASME format
+    # registry and invoked via `render(format: :human)`.
+    class Renderer < ::Pubid::Renderers::Base
+      def render(context: nil, **opts)
+        id = @id
+        parts = []
+
+        if id.first_publisher && id.first_code
+          # CSA B44.10/ASME A17.10 or API 579-2/ASME PTB-14 format
+          parts << id.first_publisher
+          parts << id.first_code
+          parts << "/#{id.second_publisher}" if id.second_publisher
+          parts << id.code.to_s if id.code && id.code.to_s != ""
+        elsif id.joint_publisher
+          # ISO/ASME or ASME/ANS format
+          parts << id.joint_publisher
+          parts << id.code.to_s if id.code && id.code.to_s != ""
+        else
+          # Standard ASME format
+          parts << id.publisher if id.publisher
+          parts << id.code.to_s if id.code
+        end
+
+        result = parts.join(" ")
+
+        if id.ptc_suffix
+          result += " #{id.ptc_suffix}"
+        end
+
+        if id.csa_number
+          result += "/CSA #{id.csa_number}"
+        end
+
+        if id.handbook
+          result += " Handbook"
+        end
+
+        if id.draft_year
+          result += "-#{id.draft_year}"
+        elsif id.year
+          result += "-#{id.year}"
+        end
+
+        result += " #{id.parenthetical_revision}" if id.parenthetical_revision
+        result += " (#{id.language})" if id.language
+        result += " (#{id.reaffirmation})" if id.reaffirmation
+        result += " #{id.revision_note}" if id.revision_note
+
+        # Normalize all em-dashes and en-dashes to regular dash
+        result.gsub(/[–—]/, "-")
+      end
+    end
+  end
+end

data/lib/pubid/asme/urn_parser.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module Pubid
+  module Asme
+    # Parses ASME URNs back into identifiers.
+    #
+    # UrnGenerator emits:
+    #   urn:asme:{publisher}:{code}:{year}
+    #
+    # publisher is the lowercase publisher string. code is the alphanumeric
+    # designation (e.g., "B16.5", "PTC1", "BPVC-2023"). The year separator
+    # in human-readable form is `-`, not `:`.
+    #
+    # Examples:
+    # - urn:asme:asme:B16.5:2020   → ASME B16.5-2020
+    # - urn:asme:asme:PTC1:2020    → ASME PTC1-2020
+    # - urn:asme:asme:BPVC-2023    → ASME BPVC-2023
+    class UrnParser < Pubid::UrnParser::Base
+      def parse_urn(urn)
+        body = strip_namespace(urn)
+        parts = split_parts(body)
+
+        _publisher, code, year = parts
+
+        text = "ASME #{code}"
+        text += "-#{year}" if year
+        flavor_parse(text)
+      end
+    end
+  end
+end