async-redis 0.11.0 → 0.11.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c93d4c6fc6b638cb339e1593a9f459041d886a2a6bebb1d195fb168af3076ecd
-  data.tar.gz: 10e62c4f23691e541cb9b3430f5b7333c851f712308926d8249e5062a88eff59
+  metadata.gz: 4307fa3fa26652c590ff6c371541d216944b0e724fb67f8ffa3799e1f120c37c
+  data.tar.gz: 3d1320e98619fcaf9b5e3f80ec7cef3533a25f62ec19047478c87aacb3c15bec
 SHA512:
-  metadata.gz: c1f44727870268dc6916e45addea89230d11af79d6d4546e1bd43140c534744b61acf5c6ee9bd301e7c9bb4ef69862b859556cccaac7e00af04ab5ce88552eca
-  data.tar.gz: 66d6d26209c7de1d87cd5095685c4f1fed235409d0e41966e1c55fc10c5e1e1a7469b734b144b654b072b18b1933bcf2c2e7b8ee1f7204f4f3a18b9af43ec3e6
+  metadata.gz: a79be2158187c9dbb6b59eec5a709f899d5e41d94be7e83977b500680888a739d50e4cb06bf53e7676540a49cdd1be50a3458f9002f0951866ea61f91ceb6299
+  data.tar.gz: 81829d10c42316190844935547406678a1593c291bbc51fe69da274d495dc5eec9b590e6ade56af997ac453a520dbffc5d916cee4c962408979261e1010d300b

data/lib/async/redis/client.rb

@@ -23,10 +23,18 @@ module Async
 		# Legacy.
 		ServerError = ::Protocol::Redis::ServerError
 		
+		# A Redis client that provides connection pooling and context management.
 		class Client
 			include ::Protocol::Redis::Methods
 			
+			# Methods module providing Redis-specific functionality.
 			module Methods
+				# Subscribe to one or more channels for pub/sub messaging.
+				# @parameter channels [Array(String)] The channels to subscribe to.
+				# @yields {|context| ...} If a block is given, it will be executed within the subscription context.
+				# 	@parameter context [Context::Subscribe] The subscription context.
+				# @returns [Object] The result of the block if block given.
+				# @returns [Context::Subscribe] The subscription context if no block given.
 				def subscribe(*channels)
 					context = Context::Subscribe.new(@pool, channels)
 					
@@ -39,6 +47,11 @@ module Async
 					end
 				end
 				
+				# Execute commands within a Redis transaction.
+				# @yields {|context| ...} If a block is given, it will be executed within the transaction context.
+				# 	@parameter context [Context::Transaction] The transaction context.
+				# @returns [Object] The result of the block if block given.
+				# @returns [Context::Transaction] Else if no block is given, returns the transaction context.
 				def transaction(&block)
 					context = Context::Transaction.new(@pool)
 					
@@ -53,6 +66,11 @@ module Async
 				
 				alias multi transaction
 				
+				# Execute commands in a pipeline for improved performance.
+				# @yields {|context| ...} If a block is given, it will be executed within the pipeline context.
+				# 	@parameter context [Context::Pipeline] The pipeline context.
+				# @returns [Object] The result of the block if block given.
+				# @returns [Context::Pipeline] The pipeline context if no block given.
 				def pipeline(&block)
 					context = Context::Pipeline.new(@pool)
 					
@@ -68,6 +86,9 @@ module Async
 				# Deprecated.
 				alias nested pipeline
 				
+				# Execute a Redis command directly.
+				# @parameter arguments [Array] The command and its arguments.
+				# @returns [Object] The response from the Redis server.
 				def call(*arguments)
 					@pool.acquire do |connection|
 						connection.write_request(arguments)
@@ -78,6 +99,7 @@ module Async
 					end
 				end
 				
+				# Close the client and all its connections.
 				def close
 					@pool.close
 				end
@@ -85,6 +107,10 @@ module Async
 			
 			include Methods
 			
+			# Create a new Redis client.
+			# @parameter endpoint [Endpoint] The Redis endpoint to connect to.
+			# @parameter protocol [Protocol] The protocol to use for communication.
+			# @parameter options [Hash] Additional options for the connection pool.
 			def initialize(endpoint = Endpoint.local, protocol: endpoint.protocol, **options)
 				@endpoint = endpoint
 				@protocol = protocol
@@ -92,11 +118,18 @@ module Async
 				@pool = make_pool(**options)
 			end
 			
+			# @attribute [Endpoint] The Redis endpoint.
 			attr :endpoint
+			
+			# @attribute [Protocol] The communication protocol.
 			attr :protocol
 			
-			# @return [client] if no block provided.
-			# @yield [client, task] yield the client in an async task.
+			# Open a Redis client and optionally yield it in an async task.
+			# @yields {|client, task| ...} If a block is given, yield the client in an async task.
+			# 	@parameter client [Client] The Redis client instance.
+			# 	@parameter task [Async::Task] The async task.
+			# @returns [Client] The client if no block provided.
+			# @returns [Object] The result of the block if block given.
 			def self.open(*arguments, **options, &block)
 				client = self.new(*arguments, **options)
 				

data/lib/async/redis/cluster_client.rb

@@ -1,33 +1,47 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2024, by Samuel Williams.
+# Copyright, 2024-2025, by Samuel Williams.
+# Copyright, 2025, by Travis Bell.
 
 require_relative "client"
 require "io/stream"
 
 module Async
 	module Redis
+		# A Redis cluster client that manages multiple Redis instances and handles cluster operations.
 		class ClusterClient
+			# Raised when cluster configuration cannot be reloaded.
 			class ReloadError < StandardError
 			end
 			
+			# Raised when no nodes are found for a specific slot.
 			class SlotError < StandardError
 			end
 			
 			Node = Struct.new(:id, :endpoint, :role, :health, :client)
 			
+			# A map that stores ranges and their associated values for efficient lookup.
 			class RangeMap
+				# Initialize a new RangeMap.
 				def initialize
 					@ranges = []
 				end
 				
+				# Add a range-value pair to the map.
+				# @parameter range [Range] The range to map.
+				# @parameter value [Object] The value to associate with the range.
+				# @returns [Object] The added value.
 				def add(range, value)
 					@ranges << [range, value]
 					
 					return value
 				end
 				
+				# Find the value associated with a key within any range.
+				# @parameter key [Object] The key to find.
+				# @yields {...} Block called if no range contains the key.
+				# @returns [Object] The value if found, result of block if given, or nil.
 				def find(key)
 					@ranges.each do |range, value|
 						return value if range.include?(key)
@@ -40,12 +54,16 @@ module Async
 					return nil
 				end
 				
+				# Iterate over all values in the map.
+				# @yields {|value| ...} Block called for each value.
+				# 	@parameter value [Object] The value from the range-value pair.
 				def each
 					@ranges.each do |range, value|
 						yield value
 					end
 				end
 				
+				# Clear all ranges from the map.
 				def clear
 					@ranges.clear
 				end
@@ -56,9 +74,17 @@ module Async
 			# @property endpoints [Array(Endpoint)] The list of cluster endpoints.
 			def initialize(endpoints, **options)
 				@endpoints = endpoints
+				@options = options
 				@shards = nil
 			end
 			
+			# Execute a block with clients for the given keys, grouped by cluster slot.
+			# @parameter keys [Array] The keys to find clients for.
+			# @parameter role [Symbol] The role of nodes to use (:master or :slave).
+			# @parameter attempts [Integer] Number of retry attempts for cluster errors.
+			# @yields {|client, keys| ...} Block called for each client-keys pair.
+			# 	@parameter client [Client] The Redis client for the slot.
+			# 	@parameter keys [Array] The keys handled by this client.
 			def clients_for(*keys, role: :master, attempts: 3)
 				slots = slots_for(keys)
 				
@@ -81,6 +107,10 @@ module Async
 				end
 			end
 			
+			# Get a client for a specific slot.
+			# @parameter slot [Integer] The cluster slot number.
+			# @parameter role [Symbol] The role of node to get (:master or :slave).
+			# @returns [Client] The Redis client for the slot.
 			def client_for(slot, role = :master)
 				unless @shards
 					reload_cluster!
@@ -93,7 +123,7 @@ module Async
 				end
 				
 				if node = nodes.sample
-					return (node.client ||= Client.new(node.endpoint))
+					return (node.client ||= Client.new(node.endpoint, **@options))
 				end
 			end
 			
@@ -101,7 +131,7 @@ module Async
 			
 			def reload_cluster!(endpoints = @endpoints)
 				@endpoints.each do |endpoint|
-					client = Client.new(endpoint)
+					client = Client.new(endpoint, **@options)
 					
 					shards = RangeMap.new
 					endpoints = []
@@ -114,7 +144,7 @@ module Async
 						
 						nodes = shard["nodes"].map do |node|
 							node = node.each_slice(2).to_h
-							endpoint = Endpoint.remote(node["ip"], node["port"])
+							endpoint = Endpoint.for(endpoint.scheme, node["endpoint"], port: node["port"])
 							
 							# Collect all endpoints:
 							endpoints << endpoint
@@ -201,6 +231,9 @@ module Async
 				return crc16(key) % HASH_SLOTS
 			end
 			
+			# Calculate the hash slots for multiple keys.
+			# @parameter keys [Array] The keys to calculate slots for.
+			# @returns [Hash] A hash mapping slot numbers to arrays of keys.
 			def slots_for(keys)
 				slots = Hash.new{|hash, key| hash[key] = []}
 				

data/lib/async/redis/context/generic.rb

@@ -2,19 +2,25 @@
 
 # Released under the MIT License.
 # Copyright, 2019, by Mikael Henriksson.
-# Copyright, 2019-2023, by Samuel Williams.
+# Copyright, 2019-2025, by Samuel Williams.
 
 require "protocol/redis/methods"
 
 module Async
 	module Redis
+		# @namespace
 		module Context
+			# Base class for Redis command execution contexts.
 			class Generic
+				# Initialize a new generic context.
+				# @parameter pool [Pool] The connection pool to use.
+				# @parameter arguments [Array] Additional arguments for the context.
 				def initialize(pool, *arguments)
 					@pool = pool
 					@connection = pool.acquire
 				end
 				
+				# Close the context and release the connection back to the pool.
 				def close
 					if @connection
 						@pool.release(@connection)
@@ -22,16 +28,25 @@ module Async
 					end
 				end
 				
+				# Write a Redis command request to the connection.
+				# @parameter command [String] The Redis command.
+				# @parameter arguments [Array] The command arguments.
 				def write_request(command, *arguments)
 					@connection.write_request([command, *arguments])
 				end
 				
+				# Read a response from the Redis connection.
+				# @returns [Object] The Redis response.
 				def read_response
 					@connection.flush
 					
 					return @connection.read_response
 				end
 				
+				# Execute a Redis command and return the response.
+				# @parameter command [String] The Redis command.
+				# @parameter arguments [Array] The command arguments.
+				# @returns [Object] The Redis response.
 				def call(command, *arguments)
 					write_request(command, *arguments)
 					

data/lib/async/redis/context/pipeline.rb

@@ -14,9 +14,12 @@ module Async
 			class Pipeline < Generic
 				include ::Protocol::Redis::Methods
 				
+				# A synchronous wrapper for pipeline operations that executes one command at a time.
 				class Sync
 					include ::Protocol::Redis::Methods
 					
+					# Initialize a new sync wrapper.
+					# @parameter pipeline [Pipeline] The pipeline to wrap.
 					def initialize(pipeline)
 						@pipeline = pipeline
 					end
@@ -31,6 +34,8 @@ module Async
 					end
 				end
 				
+				# Initialize a new pipeline context.
+				# @parameter pool [Pool] The connection pool to use.
 				def initialize(pool)
 					super(pool)
 					
@@ -46,6 +51,9 @@ module Async
 					end
 				end
 				
+				# Collect all pending responses.
+				# @yields {...} Optional block to execute while collecting responses.
+				# @returns [Array] Array of all responses if no block given.
 				def collect
 					if block_given?
 						flush
@@ -55,6 +63,8 @@ module Async
 					@count.times.map{read_response}
 				end
 				
+				# Get a synchronous wrapper for this pipeline.
+				# @returns [Sync] A synchronous wrapper that executes commands immediately.
 				def sync
 					@sync ||= Sync.new(self)
 				end
@@ -73,6 +83,8 @@ module Async
 					return nil
 				end
 				
+				# Read a response from the pipeline.
+				# @returns [Object] The next response in the pipeline.
 				def read_response
 					if @count > 0
 						@count -= 1
@@ -82,6 +94,7 @@ module Async
 					end
 				end
 				
+				# Close the pipeline and flush all pending responses.
 				def close
 					flush
 				ensure

data/lib/async/redis/context/subscribe.rb

@@ -9,15 +9,20 @@ require_relative "generic"
 module Async
 	module Redis
 		module Context
+			# Context for Redis pub/sub subscription operations.
 			class Subscribe < Generic
 				MESSAGE = "message"
 				
+				# Initialize a new subscription context.
+				# @parameter pool [Pool] The connection pool to use.
+				# @parameter channels [Array(String)] The channels to subscribe to.
 				def initialize(pool, channels)
 					super(pool)
 					
 					subscribe(channels)
 				end
 				
+				# Close the subscription context.
 				def close
 					# There is no way to reset subscription state. On Redis v6+ you can use RESET, but this is not supported in <= v6.
 					@connection&.close
@@ -25,12 +30,17 @@ module Async
 					super
 				end
 				
+				# Listen for the next message from subscribed channels.
+				# @returns [Array] The next message response, or nil if connection closed.
 				def listen
 					while response = @connection.read_response
 						return response if response.first == MESSAGE
 					end
 				end
 				
+				# Iterate over all messages from subscribed channels.
+				# @yields {|response| ...} Block called for each message.
+				# 	@parameter response [Array] The message response.
 				def each
 					return to_enum unless block_given?
 					
@@ -39,11 +49,15 @@ module Async
 					end
 				end
 				
+				# Subscribe to additional channels.
+				# @parameter channels [Array(String)] The channels to subscribe to.
 				def subscribe(channels)
 					@connection.write_request ["SUBSCRIBE", *channels]
 					@connection.flush
 				end
 				
+				# Unsubscribe from channels.
+				# @parameter channels [Array(String)] The channels to unsubscribe from.
 				def unsubscribe(channels)
 					@connection.write_request ["UNSUBSCRIBE", *channels]
 					@connection.flush

data/lib/async/redis/context/transaction.rb

@@ -2,22 +2,29 @@
 
 # Released under the MIT License.
 # Copyright, 2018, by Huba Nagy.
-# Copyright, 2018-2023, by Samuel Williams.
+# Copyright, 2018-2025, by Samuel Williams.
 
 require_relative "pipeline"
 
 module Async
 	module Redis
 		module Context
+			# Context for Redis transaction operations using MULTI/EXEC.
 			class Transaction < Pipeline
+				# Initialize a new transaction context.
+				# @parameter pool [Pool] The connection pool to use.
+				# @parameter arguments [Array] Additional arguments for the transaction.
 				def initialize(pool, *arguments)
 					super(pool)
 				end
 				
+				# Begin a transaction block.
 				def multi
 					call("MULTI")
 				end
 				
+				# Watch keys for changes during the transaction.
+				# @parameter keys [Array(String)] The keys to watch.
 				def watch(*keys)
 					sync.call("WATCH", *keys)
 				end
@@ -27,6 +34,7 @@ module Async
 					sync.call("EXEC")
 				end
 				
+				# Discard all queued commands in the transaction.
 				def discard
 					sync.call("DISCARD")
 				end

data/lib/async/redis/endpoint.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2024, by Samuel Williams.
+# Copyright, 2024-2025, by Samuel Williams.
 
 require "io/endpoint"
 require "io/endpoint/host_endpoint"
@@ -13,20 +13,32 @@ require_relative "protocol/selected"
 
 module Async
 	module Redis
+		# Create a local Redis endpoint.
+		# @parameter options [Hash] Options for the endpoint.
+		# @returns [Endpoint] A local Redis endpoint.
 		def self.local_endpoint(**options)
 			Endpoint.local(**options)
 		end
 		
 		# Represents a way to connect to a remote Redis server.
 		class Endpoint < ::IO::Endpoint::Generic
-			LOCALHOST = URI.parse("redis://localhost").freeze
+			LOCALHOST = URI::Generic.build(scheme: "redis", host: "localhost").freeze
 			
+			# Create a local Redis endpoint.
+			# @parameter options [Hash] Additional options for the endpoint.
+			# @returns [Endpoint] A local Redis endpoint.
 			def self.local(**options)
 				self.new(LOCALHOST, **options)
 			end
 			
+			# Create a remote Redis endpoint.
+			# @parameter host [String] The hostname to connect to.
+			# @parameter port [Integer] The port to connect to.
+			# @parameter options [Hash] Additional options for the endpoint.
+			# @returns [Endpoint] A remote Redis endpoint.
 			def self.remote(host, port = 6379, **options)
-				self.new(URI.parse("redis://#{host}:#{port}"), **options)
+				# URI::Generic.build automatically handles IPv6 addresses correctly:
+				self.new(URI::Generic.build(scheme: "redis", host: host, port: port), **options)
 			end
 			
 			SCHEMES = {
@@ -34,8 +46,13 @@ module Async
 				"rediss" => URI::Generic,
 			}
 			
+			# Parse a Redis URL string into an endpoint.
+			# @parameter string [String] The URL string to parse.
+			# @parameter endpoint [Endpoint] Optional underlying endpoint.
+			# @parameter options [Hash] Additional options for the endpoint.
+			# @returns [Endpoint] The parsed endpoint.
 			def self.parse(string, endpoint = nil, **options)
-				url = URI.parse(string).normalize
+				url = URI.parse(string)
 				
 				return self.new(url, endpoint, **options)
 			end
@@ -45,7 +62,7 @@ module Async
 			# @parameter scheme [String] The scheme to use, e.g. "redis" or "rediss".
 			# @parameter hostname [String] The hostname to connect to (or bind to).
 			# @parameter options [Hash] Additional options, passed to {#initialize}.
-			def self.for(scheme, hostname, credentials: nil, port: nil, database: nil, **options)
+			def self.for(scheme, host, credentials: nil, port: nil, database: nil, **options)
 				uri_klass = SCHEMES.fetch(scheme.downcase) do
 					raise ArgumentError, "Unsupported scheme: #{scheme.inspect}"
 				end
@@ -55,7 +72,13 @@ module Async
 				end
 				
 				self.new(
-					uri_klass.new(scheme, credentials&.join(":"), hostname, port, nil, path, nil, nil, nil).normalize,
+					uri_klass.build(
+						scheme: scheme,
+						userinfo: credentials&.join(":"),
+						host: host,
+						port: port,
+						path: path,
+					),
 					**options
 				)
 			end
@@ -92,6 +115,8 @@ module Async
 				end
 			end
 			
+			# Convert the endpoint to a URL.
+			# @returns [URI] The URL representation of the endpoint.
 			def to_url
 				url = @url.dup
 				
@@ -102,24 +127,34 @@ module Async
 				return url
 			end
 			
+			# Convert the endpoint to a string representation.
+			# @returns [String] A string representation of the endpoint.
 			def to_s
 				"\#<#{self.class} #{self.to_url} #{@options}>"
 			end
 			
+			# Convert the endpoint to an inspectable string.
+			# @returns [String] An inspectable string representation of the endpoint.
 			def inspect
 				"\#<#{self.class} #{self.to_url} #{@options.inspect}>"
 			end
 			
 			attr :url
 			
+			# Get the address of the underlying endpoint.
+			# @returns [String] The address of the endpoint.
 			def address
 				endpoint.address
 			end
 			
+			# Check if the connection is secure (using TLS).
+			# @returns [Boolean] True if the connection uses TLS.
 			def secure?
 				["rediss"].include?(self.scheme)
 			end
 			
+			# Get the protocol for this endpoint.
+			# @returns [Protocol] The protocol instance configured for this endpoint.
 			def protocol
 				protocol = @options.fetch(:protocol, Protocol::RESP2)
 				
@@ -134,14 +169,20 @@ module Async
 				return protocol
 			end
 			
+			# Get the default port for Redis connections.
+			# @returns [Integer] The default Redis port (6379).
 			def default_port
 				6379
 			end
 			
+			# Check if the endpoint is using the default port.
+			# @returns [Boolean] True if using the default port.
 			def default_port?
 				port == default_port
 			end
 			
+			# Get the port for this endpoint.
+			# @returns [Integer] The port number.
 			def port
 				@options[:port] || @url.port || default_port
 			end
@@ -151,10 +192,14 @@ module Async
 				@options[:hostname] || @url.hostname
 			end
 			
+			# Get the scheme for this endpoint.
+			# @returns [String] The URL scheme (e.g., "redis" or "rediss").
 			def scheme
 				@options[:scheme] || @url.scheme
 			end
 			
+			# Get the database number for this endpoint.
+			# @returns [Integer | Nil] The database number or nil if not specified.
 			def database
 				@options[:database] || extract_database(@url.path)
 			end

data/lib/async/redis/key.rb

@@ -5,35 +5,53 @@
 
 module Async
 	module Redis
+		# Represents a Redis key with utility methods for key manipulation.
 		class Key
+			# Create a new Key instance.
+			# @parameter path [String] The key path.
+			# @returns [Key] A new Key instance.
 			def self.[] path
 				self.new(path)
 			end
 			
 			include Comparable
 			
+			# Initialize a new Key.
+			# @parameter path [String] The key path.
 			def initialize(path)
 				@path = path
 			end
 			
+			# Get the byte size of the key.
+			# @returns [Integer] The byte size of the key path.
 			def size
 				@path.bytesize
 			end
 			
 			attr :path
 			
+			# Convert the key to a string.
+			# @returns [String] The key path as a string.
 			def to_s
 				@path
 			end
 			
+			# Convert the key to a string (for String compatibility).
+			# @returns [String] The key path as a string.
 			def to_str
 				@path
 			end
 			
+			# Create a child key by appending a subkey.
+			# @parameter key [String] The subkey to append.
+			# @returns [Key] A new Key with the appended subkey.
 			def [] key
 				self.class.new("#{@path}:#{key}")
 			end
 			
+			# Compare this key with another key.
+			# @parameter other [Key] The other key to compare with.
+			# @returns [Integer] -1, 0, or 1 for comparison result.
 			def <=> other
 				@path <=> other.to_str
 			end

data/lib/async/redis/protocol/resp2.rb

@@ -7,22 +7,34 @@ require "protocol/redis"
 
 module Async
 	module Redis
+		# @namespace
 		module Protocol
+			# RESP2 protocol implementation for Redis.
 			module RESP2
+				# A connection implementation for RESP2 protocol.
 				class Connection < ::Protocol::Redis::Connection
+					# Get the concurrency level for this connection.
+					# @returns [Integer] The concurrency level (1 for RESP2).
 					def concurrency
 						1
 					end
 					
+					# Check if the connection is viable for use.
+					# @returns [Boolean] True if the stream is readable.
 					def viable?
 						@stream.readable?
 					end
 					
+					# Check if the connection can be reused.
+					# @returns [Boolean] True if the stream is not closed.
 					def reusable?
 						!@stream.closed?
 					end
 				end
 				
+				# Create a new RESP2 client connection.
+				# @parameter stream [IO] The stream to use for communication.
+				# @returns [Connection] A new RESP2 connection.
 				def self.client(stream)
 					Connection.new(stream)
 				end

data/lib/async/redis/sentinel_client.rb

@@ -10,6 +10,7 @@ require "io/stream"
 
 module Async
 	module Redis
+		# A Redis Sentinel client for high availability Redis deployments.
 		class SentinelClient
 			DEFAULT_MASTER_NAME = "mymaster"
 			
@@ -40,6 +41,9 @@ module Async
 			# @attribute [Symbol] The role of the instance that you want to connect to.
 			attr :role
 			
+			# Resolve an address for the specified role.
+			# @parameter role [Symbol] The role to resolve (:master or :slave).
+			# @returns [Endpoint] The resolved endpoint address.
 			def resolve_address(role = @role)
 				case role
 				when :master
@@ -55,6 +59,7 @@ module Async
 				address or raise RuntimeError, "Unable to fetch #{role} via Sentinel."
 			end
 			
+			# Close the sentinel client and all connections.
 			def close
 				super
 				
@@ -63,24 +68,34 @@ module Async
 				end
 			end
 			
+			# Initiate a failover for the specified master.
+			# @parameter name [String] The name of the master to failover.
+			# @returns [Object] The result of the failover command.
 			def failover(name = @master_name)
 				sentinels do |client|
 					return client.call("SENTINEL", "FAILOVER", name)
 				end
 			end
 			
+			# Get information about all masters.
+			# @returns [Array(Hash)] Array of master information hashes.
 			def masters
 				sentinels do |client|
 					return client.call("SENTINEL", "MASTERS").map{|fields| fields.each_slice(2).to_h}
 				end
 			end
 			
+			# Get information about a specific master.
+			# @parameter name [String] The name of the master.
+			# @returns [Hash] The master information hash.
 			def master(name = @master_name)
 				sentinels do |client|
 					return client.call("SENTINEL", "MASTER", name).each_slice(2).to_h
 				end
 			end
 			
+			# Resolve the master endpoint address.
+			# @returns [Endpoint | Nil] The master endpoint or nil if not found.
 			def resolve_master
 				sentinels do |client|
 					begin
@@ -95,6 +110,8 @@ module Async
 				return nil
 			end
 			
+			# Resolve a slave endpoint address.
+			# @returns [Endpoint | Nil] A slave endpoint or nil if not found.
 			def resolve_slave
 				sentinels do |client|
 					begin

data/lib/async/redis/version.rb

@@ -1,10 +1,10 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2018-2024, by Samuel Williams.
+# Copyright, 2018-2025, by Samuel Williams.
 
 module Async
 	module Redis
-		VERSION = "0.11.0"
+		VERSION = "0.11.2"
 	end
 end

data/lib/async/redis.rb

@@ -6,6 +6,14 @@
 
 require_relative "redis/version"
 require_relative "redis/client"
+require_relative "redis/endpoint"
 
 require_relative "redis/cluster_client"
 require_relative "redis/sentinel_client"
+
+# @namespace
+module Async
+	# @namespace
+	module Redis
+	end
+end

data/license.md

@@ -1,6 +1,6 @@
 # MIT License
 
-Copyright, 2018-2024, by Samuel Williams.  
+Copyright, 2018-2025, by Samuel Williams.  
 Copyright, 2018, by Huba Nagy.  
 Copyright, 2019-2020, by David Ortiz.  
 Copyright, 2019, by Pierre Montelle.  
@@ -13,6 +13,7 @@ Copyright, 2021, by Troex Nevelin.
 Copyright, 2022, by Tim Willard.  
 Copyright, 2022, by Gleb Sinyavskiy.  
 Copyright, 2024, by Joan Lledó.  
+Copyright, 2025, by Travis Bell.  
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/readme.md

@@ -4,12 +4,34 @@ An asynchronous client for Redis including TLS. Support for streaming requests a
 
 [![Development Status](https://github.com/socketry/async-redis/workflows/Test/badge.svg)](https://github.com/socketry/async-redis/actions?workflow=Test)
 
+## Support
+
+This gem supports both Valkey and Redis. It is designed to be compatible with the latest versions of both libraries. We also test Redis sentinel and cluster configurations.
+
 ## Usage
 
 Please see the [project documentation](https://socketry.github.io/async-redis/) for more details.
 
   - [Getting Started](https://socketry.github.io/async-redis/guides/getting-started/index) - This guide explains how to use the `async-redis` gem to connect to a Redis server and perform basic operations.
 
+## Releases
+
+Please see the [project releases](https://socketry.github.io/async-redis/releases/index) for all releases.
+
+### v0.11.2
+
+  - Fix handling of IPv6 address literals, including those returned by Redis Cluster / Sentinel.
+
+### v0.11.1
+
+  - Correctly pass `@options` to `Async::Redis::Client` instances created by `Async::Redis::ClusterClient`.
+
+### v0.10.0
+
+  - [Add support for Redis Clusters](https://socketry.github.io/async-redis/releases/index#add-support-for-redis-clusters)
+  - [Add support for Redis Sentinels](https://socketry.github.io/async-redis/releases/index#add-support-for-redis-sentinels)
+  - [Improved Integration Tests](https://socketry.github.io/async-redis/releases/index#improved-integration-tests)
+
 ## Contributing
 
 We welcome contributions to this project.

data/{changes.md → releases.md}

@@ -1,10 +1,20 @@
-# v0.10.0
+# Releases
 
-## Cluster Client
+## v0.11.2
+
+  - Fix handling of IPv6 address literals, including those returned by Redis Cluster / Sentinel.
+
+## v0.11.1
+
+  - Correctly pass `@options` to `Async::Redis::Client` instances created by `Async::Redis::ClusterClient`.
+
+## v0.10.0
+
+### Add support for Redis Clusters
 
 `Async::Redis::ClusterClient` is a new class that provides a high-level interface to a Redis Cluster. Due to the way clustering works, it does not provide the same interface as the `Async::Redis::Client` class. Instead, you must request an appropriate client for the key you are working with.
 
-```ruby
+``` ruby
 endpoints = [
 	Async::Redis::Endpoint.parse("redis://redis-a"),
 	Async::Redis::Endpoint.parse("redis://redis-b"),
@@ -18,11 +28,11 @@ cluster_client.clients_for("key") do |client|
 end
 ```
 
-## Sentinel Client
+### Add support for Redis Sentinels
 
 The previous implementation `Async::Redis::SentinelsClient` has been replaced with `Async::Redis::SentinelClient`. This new class uses `Async::Redis::Endpoint` objects to represent the sentinels and the master.
 
-```ruby
+``` ruby
 sentinels = [
 	Async::Redis::Endpoint.parse("redis://redis-sentinel-a"),
 	Async::Redis::Endpoint.parse("redis://redis-sentinel-b"),
@@ -41,6 +51,6 @@ slave_client.session do |session|
 end
 ```
 
-## Integration Tests
+### Improved Integration Tests
 
 Integration tests for Redis Cluster and Sentinel have been added, using `docker-compose` to start the required services and run the tests. These tests are not part of the default test suite and must be run separately. See the documentation in the `sentinel/` and `cluster/` directories for more information.

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: async-redis
 version: !ruby/object:Gem::Version
-  version: 0.11.0
+  version: 0.11.2
 platform: ruby
 authors:
 - Samuel Williams
@@ -9,6 +9,7 @@ authors:
 - David Ortiz
 - Gleb Sinyavskiy
 - Mikael Henriksson
+- Travis Bell
 - Troex Nevelin
 - Alex Matchneer
 - Jeremy Jung
@@ -17,7 +18,6 @@ authors:
 - Pierre Montelle
 - Salim Semaoune
 - Tim Willard
-autorequire:
 bindir: bin
 cert_chain:
 - |
@@ -49,7 +49,7 @@ cert_chain:
   Q2K9NVun/S785AP05vKkXZEFYxqG6EW012U4oLcFl5MySFajYXRYbuUpH6AY+HP8
   voD0MPg1DssDLKwXyt1eKD/+Fq0bFWhwVM/1XiAXL7lyYUyOq24KHgQ2Csg=
   -----END CERTIFICATE-----
-date: 2024-11-12 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: async
@@ -121,13 +121,10 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.9'
-description:
-email:
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- changes.md
 - lib/async/redis.rb
 - lib/async/redis/client.rb
 - lib/async/redis/cluster_client.rb
@@ -144,13 +141,13 @@ files:
 - lib/async/redis/version.rb
 - license.md
 - readme.md
+- releases.md
 homepage: https://github.com/socketry/async-redis
 licenses:
 - MIT
 metadata:
   documentation_uri: https://socketry.github.io/async-redis/
   source_code_uri: https://github.com/socketry/async-redis.git
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -158,15 +155,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '3.1'
+      version: '3.2'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.22
-signing_key:
+rubygems_version: 3.6.7
 specification_version: 4
 summary: A Redis client library.
 test_files: []