pubid 1.15.21 → 2.0.0.alpha.10

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

@@ -0,0 +1,119 @@
+# frozen_string_literal: true
+
+module Pubid
+  module Ashrae
+    # Base class for all ASHRAE identifiers. Canonical name
+    # Pubid::Ashrae::Identifier; every concrete ASHRAE identifier descends from it.
+    class Identifier < ::Pubid::Identifier
+      # Parse an ASHRAE identifier string into an identifier object
+      # @param identifier [String] The ASHRAE identifier string to parse
+      # @return [Pubid::Ashrae::Identifier] The appropriate identifier object
+      # @raise [Pubid::Errors::ParseError] If parsing fails
+      def self.parse(identifier)
+        parsed = Parser.parse(identifier)
+        Builder.build(parsed)
+      end
+
+      attribute :publisher, :string, default: "ASHRAE"
+      # The document number used to live here as `attribute :code, :string`,
+      # leaving the `number` inherited from ::Pubid::Identifier nil — so
+      # relaton-index, which sorts and bsearches on `id.root.number.to_s`,
+      # keyed all 3,619 ASHRAE rows on "".
+      #
+      # It is now `attribute :number, :string` on the two single-document
+      # LEAVES (Identifiers::Standard and Identifiers::Guideline), never here:
+      # this class is inherited by BOTH SingleIdentifier and
+      # SupplementIdentifier, and redefining the parent's Components::Code-typed
+      # `number` on an inherited-from class resolves nondeterministically under
+      # multi-flavor load. The supplement types carry no number of their own —
+      # they reach it through #root, which walks `base`.
+      attribute :year, :string
+      attribute :type, :string
+      attribute :suffix, :string # R (revision), P (proposed), etc.
+      attribute :amendment, :string
+      attribute :reaffirmed, :string
+      attribute :copublisher, :string
+
+      # --- MR slug hooks -------------------------------------------------
+      #
+      # ASHRAE supplied none, and every base hook looks for something ASHRAE
+      # does not use: `mr_type` reads a typed_stage, `mr_year` reads a
+      # Components::Date. With `number` nil too, ALL 3,619 ids collapsed onto
+      # the single slug "ashrae" — the worst collapse measured in the gem, and
+      # `to_slug` is what consumers use as an output FILENAME.
+      #
+      # `type` distinguishes a Guideline from a Standard of the same number
+      # (Guideline 0 and Standard 0 are different documents), so it has to
+      # reach the slug and not only `==`.
+      def mr_type
+        type&.to_s&.downcase
+      end
+
+      # ASHRAE keeps its edition in a plain `year` string, not the inherited
+      # `date`, so the base hook read nil and every edition of one standard
+      # shared a slug.
+      def mr_year
+        year&.to_s
+      end
+
+      # `copublisher` is in `==` and in `to_s`, so by the project rule it has to
+      # reach the slug too: "ASHRAE Standard 15-2019 Addendum a" and
+      # "ANSI/ASHRAE Addendum a to ANSI/ASHRAE Standard 15-2019" have different
+      # hashes and would otherwise share a filename. (Whether those two strings
+      # ought to normalise to ONE identifier is a separate question, and not one
+      # the slug should paper over.)
+      def mr_publisher
+        mr_sanitize(copublisher || publisher)
+      end
+
+      # Both trailing markers are identity-bearing and must reach the slug, not
+      # only `==`: `reaffirmed` ("RA 2017") separates "ANSI/ASHRAE Standard
+      # 206-2013 (RA 2017)" from the plain "…206-2013", and `suffix` ("R" for
+      # revision, "P" for proposed) separates "ASHRAE Guideline 27-2019" from
+      # "…27-2019R". Their hashes differ, so their filenames must too.
+      # Uses the shared #mr_join rather than a bare `compact.join("-")`, so it
+      # returns nil instead of "" when nothing survives: MrString's own
+      # `compact` drops nil but not the empty string, and a blank segment
+      # yields a double dot in the joined slug.
+      def mr_number_with_part
+        mr_join(mr_sanitize(number),
+                (reaffirmed ? "ra#{mr_sanitize(reaffirmed)}" : nil),
+                mr_sanitize(suffix))
+      end
+
+      # An ASHRAE value can carry characters outside the [a-z0-9.-] charset
+      # Renderers::MrString documents: a comma in the code "90A,B,C", a slash
+      # in the copublisher "ANSI/ASHRAE", spaces in a package description.
+      # Filter BY CHARSET (the BIPM `mr_slug` precedent) rather than by an
+      # enumerated escape list, so a character introduced later cannot reach a
+      # filename.
+      #
+      # Public alongside the hooks above rather than tucked behind `private`,
+      # since the whole MR surface here is public, and the supplement types
+      # call it from their own mr_supplement_suffix. The output emptiness check
+      # matters: a value made only of out-of-charset characters collapses to
+      # "", which is truthy in Ruby and would reach the renderer as a blank
+      # segment, producing a double dot in the joined slug.
+      def mr_sanitize(value)
+        return nil if value.nil? || value.to_s.empty?
+
+        sanitized = value.to_s.downcase
+          .gsub(%r{[^a-z0-9.-]+}, "-").gsub(%r{\A-+|-+\z}, "")
+        sanitized.empty? ? nil : sanitized
+      end
+
+      # ASHRAE stores the publication year in a plain :string scalar, not a
+      # Components::Date, so the base #exclude's :year->:date remap cannot nil
+      # it. Reset the scalar directly (mirroring CSA/BIPM) so a year-less
+      # partial reference is a year wildcard under
+      # matches?(other, ignore: [:year]). super still recurses into the nested
+      # `base` of wrapper types (Errata/Addendum/…), which carry no year scalar.
+      def exclude(*args)
+        result = super
+        year_keys = args & %i[year date]
+        result.year = nil if !year_keys.empty? && result.respond_to?(:year=)
+        result
+      end
+    end
+  end
+end

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

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+require "lutaml/model"
+
+module Pubid
+  module Ashrae
+    module Identifiers
+      # CombinedAddenda identifier for ASHRAE standards and guidelines
+      # Represents multiple addendums grouped together
+      # Examples:
+      # - ASHRAE Addenda c and d to Standard 15-1994
+      # - ASHRAE Addenda f and h for Standard 15-2007
+      class CombinedAddenda < SupplementIdentifier
+        attribute :addendum_codes, :string # Multiple codes like "c and d"
+        attribute :connector, :string # "and" or ","
+
+        # See Errata. The whole letter list is the identity here — "Addenda a,
+        # b" and "Addenda c, d" of one standard are different documents.
+        def mr_supplement_suffix
+          ["adds", mr_sanitize(addendum_codes)]
+            .compact.reject(&:empty?).join(".")
+        end
+
+        TYPED_STAGES = [
+          Components::TypedStage.new(
+            abbr: ["Addenda", "Combined Addenda"],
+            type_code: "combined_addenda",
+            stage_code: "published",
+          ),
+        ].freeze
+
+        def self.type
+          { key: :combined_addenda, title: "ASHRAE Combined Addenda",
+            short: "Addenda" }
+        end
+
+        def copublisher
+          base&.copublisher
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+require "lutaml/model"
+
+module Pubid
+  module Ashrae
+    module Identifiers
+      # Errata identifier for ASHRAE standards and guidelines
+      # Represents corrections/errata for a base standard
+      # Examples:
+      # - ASHRAE Guideline 0-2005 Errata (September 28, 2011)
+      # - ANSI/ASHRAE Standard 62.1-2004 Errata (May 4, 2007)
+      class Errata < SupplementIdentifier
+        attribute :errata_date, :string
+
+        # Make Renderers::MrString recurse into `base` instead of slugging the
+        # supplement flat off attributes it does not have. Without it every
+        # erratum of every standard shared one filename, and `to_slug` is what
+        # consumers use as an output filename.
+        def mr_supplement_suffix
+          ["errata", mr_sanitize(errata_date)]
+            .compact.reject(&:empty?).join(".")
+        end
+
+        TYPED_STAGES = [
+          Components::TypedStage.new(
+            abbr: ["Errata"],
+            type_code: "errata",
+            stage_code: "published",
+          ),
+        ].freeze
+
+        def self.type
+          { key: :errata, title: "ASHRAE Errata", short: "Errata" }
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+require "lutaml/model"
+
+module Pubid
+  module Ashrae
+    module Identifiers
+      # ASHRAE Guideline identifier
+      # Example: ASHRAE Guideline 0-2019, ASHRAE Guideline 1.5
+      class Guideline < SingleIdentifier
+        # The relaton index key. Declared on the LEAF, not on the shared
+        # Identifier that SupplementIdentifier also inherits — see base.rb.
+        attribute :number, :string
+        attribute :type, :string, default: "Guideline"
+
+        TYPED_STAGES = [
+          Components::TypedStage.new(
+            abbr: ["Guideline", "ASHRAE"],
+            type_code: "guideline",
+            stage_code: "published",
+          ),
+          Components::TypedStage.new(
+            abbr: ["P"],
+            type_code: "guideline",
+            stage_code: "proposed",
+            project_status: true,
+          ),
+          Components::TypedStage.new(
+            abbr: ["R"],
+            type_code: "guideline",
+            stage_code: "revision",
+          ),
+        ].freeze
+
+        def self.type
+          { key: :guideline, title: "ASHRAE Guideline", short: "Guideline" }
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+require "lutaml/model"
+
+module Pubid
+  module Ashrae
+    module Identifiers
+      # Interpretation identifier for ASHRAE standards
+      # Represents a collection of interpretations for a base standard
+      # Examples:
+      # - Interpretations for Standard 15.2-2022
+      # - Interpretations for Standard 52.1-1992
+      class Interpretation < SupplementIdentifier
+        # Mirrors its four sibling supplement types: without it
+        # Renderers::MrString slugs the interpretation FLAT off attributes it
+        # does not have, instead of recursing into `base`.
+        #
+        # Currently unreachable, and NOT because of alternation ordering:
+        # rule(:interpretation_identifier) is reached and does match, but it
+        # never wraps its output in `.as(:interpretation_identifier)`, so
+        # Builder#build's branch for that key is dead code and the tree falls
+        # through to the plain-Standard path (pre-existing; pinned in
+        # spec/pubid/ashrae/root_number_spec.rb, hand-off
+        # ashrae-interpretation-collapses-onto-base). Added anyway so that
+        # fixing the dispatch does not silently ship malformed filenames.
+        def mr_supplement_suffix
+          "interp"
+        end
+
+        TYPED_STAGES = [
+          Components::TypedStage.new(
+            abbr: ["Interpretations"],
+            type_code: "interpretation",
+            stage_code: "published",
+          ),
+        ].freeze
+
+        def self.type
+          { key: :interpretation, title: "ASHRAE Interpretations",
+            short: "Interpretations" }
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+require "lutaml/model"
+
+module Pubid
+  module Ashrae
+    module Identifiers
+      # ASHRAE Standard identifier
+      # Example: ASHRAE Standard 15-2024, ASHRAE Standard 90.1-2022
+      class Standard < SingleIdentifier
+        # The relaton index key. Declared on the LEAF, not on the shared
+        # Identifier that SupplementIdentifier also inherits — see base.rb.
+        attribute :number, :string
+        attribute :type, :string, default: "Standard"
+
+        TYPED_STAGES = [
+          Components::TypedStage.new(
+            abbr: ["Standard", "ASHRAE"],
+            type_code: "standard",
+            stage_code: "published",
+          ),
+          Components::TypedStage.new(
+            abbr: ["P"],
+            type_code: "standard",
+            stage_code: "proposed",
+            project_status: true,
+          ),
+          Components::TypedStage.new(
+            abbr: ["R"],
+            type_code: "standard",
+            stage_code: "revision",
+          ),
+        ].freeze
+
+        def self.type
+          { key: :standard, title: "ASHRAE Standard", short: "Standard" }
+        end
+      end
+    end
+  end
+end

data/lib/pubid/ashrae/identifiers.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Pubid
+  module Ashrae
+    module Identifiers
+      autoload :AddendaPackage, "#{__dir__}/identifiers/addenda_package"
+      autoload :Addendum, "#{__dir__}/identifiers/addendum"
+      autoload :CombinedAddenda, "#{__dir__}/identifiers/combined_addenda"
+      autoload :Errata, "#{__dir__}/identifiers/errata"
+      autoload :Guideline, "#{__dir__}/identifiers/guideline"
+      autoload :Interpretation, "#{__dir__}/identifiers/interpretation"
+      autoload :Standard, "#{__dir__}/identifiers/standard"
+    end
+  end
+end