surfliner-metadata_consumer 0.1.0.pre.alpha.7 → 0.1.0.pre.alpha.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c496d7587eb02bc3020be31fb8a9052e67e52aa08b97c3dbc81bb26d44f29fc3
-  data.tar.gz: 57d58bc7f428b049efc1e1f4db521970a8f43e389b966c20fb99156313c6c085
+  metadata.gz: f209e4cf680ce23da67c4caa19fd9448fed117ec03e38d54b50a382b1b6b72a0
+  data.tar.gz: 07a901ae1f7edda577c3cbd272aac1d68e7a31876ee536661b8586c55a0623d4
 SHA512:
-  metadata.gz: ebb4d7a8b61f8b03d4376454a526921d19e18eb94cca49029e8e75736ddee0ec61372a6bde72fafda21162eaa4f0ef655dc759f90150c309c8e20ec5404b450b
-  data.tar.gz: 43a75ff273881bf59ea4c20ae84e299b853b8c6779bc03e48e6fd42d6846a9268236aa034234ce8db6275ce600b255cac5eff23d722540496bc531347a589e7a
+  metadata.gz: 5531263f0ddcac33d04d8ba55d9008b2e1562eda7288f49273631661038d1f61c858030bad5d6ec5dc8f51bd24f7e7ad34be5430eceba021ccfa21013771cece
+  data.tar.gz: 0f9d4c233b2b4be9410509772715c742e76717dbd5f124ca1b693965548d169f033734d262b67dfaa117246e6101a238f0b4894e20b5cfdfbc787c5865e18147

data/CHANGES.md

@@ -1,3 +1,8 @@
+# 0.1.0.pre.alpha.8 (2025-04-29)
+
+- Support comparing configuration objects by value equality, so they can
+  be used as hash keys.
+
 # 0.1.0.pre.alpha.7 (2025-04-28)
 
 - Fix issue where `RABBITMQ_AWAIT_ON_CLOSE` environment variable could

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    surfliner-metadata_consumer (0.1.0.pre.alpha.7)
+    surfliner-metadata_consumer (0.1.0.pre.alpha.8)
       bunny (~> 2.24)
       opentelemetry-exporter-otlp (~> 0.26.3)
       opentelemetry-instrumentation-all (~> 0.60.0)

data/README.md

@@ -91,7 +91,7 @@ And `QueueConfig#from_env` similarly accepts keyword options, which are forwarde
 
 ```ruby
 connection.with_topic(topic_config) do |topic|
-  queue_config = QueueConfig.from_env(exclusive: true, durable: true)
+  queue_config = QueueConfig.from_env(exclusive: true, durable: false)
   queue = topic.bind_queue(queue_config)
   # ...
 end

data/lib/surfliner/metadata_consumer/version.rb

@@ -2,6 +2,6 @@
 module Surfliner
   module MetadataConsumer
     # The gem version
-    VERSION = "0.1.0.pre.alpha.7"
+    VERSION = "0.1.0.pre.alpha.8"
   end
 end

data/lib/surfliner/mq/connection_config.rb

@@ -28,7 +28,7 @@ module Surfliner
       # @param port [String] RabbitMQ AMQP port
       # @param username [String] RabbitMQ username
       # @param password [String] RabbitMQ passsword
-      # @param await_response_on_close [Boolean] whether the RabbitMQ client should wait for a response when closing the connection
+      # @param await_response_on_close [Boolean, String] whether the RabbitMQ client should wait for a response when closing the connection
       # @param opts [Hash] additional RabbitMQ conection options (see Bunny::Session#initialize)
       def initialize(host:, port:, username:, password:, await_response_on_close: true, **opts)
         @host = host
@@ -74,7 +74,34 @@ module Surfliner
         @redacted_url ||= session_url.sub(password, "REDACTED")
       end
 
-      private
+      # Whether `other` represents the same configuration as this object.
+      # Note that if any attributes or connection options are modified, equality becomes unstable.
+      # @return [Boolean] true if `other` represents the same configuration as this object, false otherwise
+      def eql?(other)
+        self == other
+      end
+
+      # Whether `other` represents the same configuration as this object.
+      # Note that if any attributes or connection options are modified, equality becomes unstable.
+      # @return [Boolean] true if `other` represents the same configuration as this object, false otherwise
+      def ==(other)
+        return unless other.class == self.class
+        other.options == options
+      end
+
+      # The hash value of this object. Equal configurations will have equal hash values.
+      # Note that if any attributes or connection options are modified, the hash value becomes unstable.
+      # @return [Integer] a hash value suitable for using equal configs as hash keys
+      def hash
+        options.hash
+      end
+
+      protected
+
+      # @return [Hash] all keyword arguments and connection options, for purposes of equality checking
+      def options
+        {host:, port:, username:, password:, await_response_on_close:, opts:}
+      end
 
       def parse_boolean(v)
         !FALSE_VALUES.include?(v.to_s)

data/lib/surfliner/mq/queue_config.rb

@@ -15,6 +15,30 @@ module Surfliner
         @options = options
       end
 
+      # Whether `other` represents the same configuration as this object.
+      # Note that if `name` or `options` are modified, equality becomes unstable.
+      # @param other [Object, nil] the object to compare
+      # @return [Boolean] true if `other` represents the same configuration as this object, false otherwise
+      def eql?(other)
+        self == other
+      end
+
+      # Whether `other` represents the same configuration as this object.
+      # Note that if `name` or `options` are modified, equality becomes unstable.
+      # @param other [Object, nil] the object to compare
+      # @return [Boolean] true if `other` represents the same configuration as this object, false otherwise
+      def ==(other)
+        return unless other.class == self.class
+        other.name == name && other.options == options
+      end
+
+      # The hash value of this object. Equal configurations will have equal hash values.
+      # Note that if `name` or `options` are modified, the hash value becomes unstable.
+      # @return [Integer] a hash value suitable for using equal configs as hash keys
+      def hash
+        [name, options].hash
+      end
+
       class << self
         # Returns a default (environment-variable-based) configuration with the
         # specified options.

data/lib/surfliner/mq/topic_config.rb

@@ -15,6 +15,30 @@ module Surfliner
         @options = options
       end
 
+      # Whether `other` represents the same configuration as this object.
+      # Note that if `name` or `options` are modified, equality becomes unstable.
+      # @param other [Object, nil] the object to compare
+      # @return [Boolean] true if `other` represents the same configuration as this object, false otherwise
+      def eql?(other)
+        self == other
+      end
+
+      # Whether `other` represents the same configuration as this object.
+      # Note that if `name` or `options` are modified, equality becomes unstable.
+      # @param other [Object, nil] the object to compare
+      # @return [Boolean] true if `other` represents the same configuration as this object, false otherwise
+      def ==(other)
+        return unless other.class == self.class
+        other.name == name && other.options == options
+      end
+
+      # The hash value of this object. Equal configurations will have equal hash values.
+      # Note that if `name` or `options` are modified, the hash value becomes unstable.
+      # @return [Integer] a hash value suitable for using equal configs as hash keys
+      def hash
+        [name, options].hash
+      end
+
       class << self
         # Returns a default (environment-variable-based) configuration with the
         # specified options.

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: surfliner-metadata_consumer
 version: !ruby/object:Gem::Version
-  version: 0.1.0.pre.alpha.7
+  version: 0.1.0.pre.alpha.8
 platform: ruby
 authors:
 - Project Surfliner