redis-client 0.15.0 → 0.16.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: aa81349f7f830db128f2637bc4c782543b9c51a16075b54fdc4700810a95ae83
-  data.tar.gz: d34e19d6229292bb6b15e61aebeda57729780040e098f0fae1beb534f9717ff9
+  metadata.gz: 35ff65a4af6127cb60acff6a3d3b2d2e5e65ddeffc0e8e808b7dec90792697a6
+  data.tar.gz: 854f82d7548c5462b53ae29a637dc208cdc70b3399b28d0c61f38e02f073e37e
 SHA512:
-  metadata.gz: 01ed887cfc90ffc36ff82669a459d1c9b13b72c9d81f66ca770e7642c16cba90d30cfd31768029b81a1519778f6af2905b145ab606f070008ac471192ce812fa
-  data.tar.gz: 64320bfdcdaa3fd4402ae41350dc0451127f895e3f224d916140ea3fc5813dfe9344f04dc18c20d82e9c3a0878d19ade9b3716274278a21fbe3fd1c5da855797
+  metadata.gz: 2c9e8e564662e86f4e1a24ca9528a5d909a096218eaf62bd7b58838402db390e7bec65d79a43aa89a2b98d22f9645ca7e412ae2db4010dc4131cbf2133d2666f
+  data.tar.gz: c6400693a10e28e377bf52792ee54f41afb2b2c97ea49578a90eba767b6e3b6a7f37eaeaccf41a38a8222827f461f44aa0b1f75881084dc30a521e407508e277

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 # Unreleased
 
+# 0.16.0
+
+- Add `RedisClient#disable_reconnection`.
+- Reverted the special discard of connection. A regular `close(2)` should be enough.
+
 # 0.15.0
 
 - Discard sockets rather than explictly close them when a fork is detected. #126.

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    redis-client (0.15.0)
+    redis-client (0.16.0)
       connection_pool
 
 GEM
@@ -19,7 +19,7 @@ GEM
       ast (~> 2.4.1)
     rainbow (3.1.1)
     rake (13.0.6)
-    rake-compiler (1.2.3)
+    rake-compiler (1.2.5)
       rake
     redis (4.6.0)
     regexp_parser (2.5.0)

data/README.md

@@ -42,7 +42,7 @@ redis.with do |r|
 end
 ```
 
-If you are working in a single threaded environment, or wish to use your own connection pooling mechanism,
+If you are working in a single-threaded environment, or wish to use your own connection pooling mechanism,
 you can obtain a raw client with `#new_client`
 
 ```ruby
@@ -67,11 +67,11 @@ redis.call("GET", "mykey")
 - `host`: The server hostname or IP address. Defaults to `"localhost"`.
 - `port`: The server port. Defaults to `6379`.
 - `path`: The path to a UNIX socket, if set `url`, `host` and `port` are ignored.
-- `ssl`: Wether to connect using SSL or not.
+- `ssl`: Whether to connect using SSL or not.
 - `ssl_params`: A configuration Hash passed to [`OpenSSL::SSL::SSLContext#set_params`](https://www.rubydoc.info/stdlib/openssl/OpenSSL%2FSSL%2FSSLContext:set_params), notable options include:
   - `cert`: The path to the client certificate (e.g. `client.crt`).
   - `key`: The path to the client key (e.g. `client.key`).
-  - `ca_file`: The certificate authority to use, useful for self signed certificates (e.g. `ca.crt`),
+  - `ca_file`: The certificate authority to use, useful for self-signed certificates (e.g. `ca.crt`),
 - `db`: The database to select after connecting, defaults to `0`.
 - `id` ID for the client connection, assigns name to current connection by sending `CLIENT SETNAME`.
 - `username` Username to authenticate against server, defaults to `"default"`.
@@ -83,7 +83,7 @@ redis.call("GET", "mykey")
 - `reconnect_attempts`: Specify how many times the client should retry to send queries. Defaults to `0`. Makes sure to read the [reconnection section](#reconnection) before enabling it.
 - `circuit_breaker`: A Hash with circuit breaker configuration. Defaults to `nil`. See the [circuit breaker section](#circuit-breaker) for details.
 - `protocol:` The version of the RESP protocol to use. Default to `3`.
-- `custom`: A user owned value ignored by `redis-client` but available as `Config#custom`. This can be used to hold middleware configurations and other user specific metadatas.
+- `custom`: A user-owned value ignored by `redis-client` but available as `Config#custom`. This can be used to hold middleware configurations and other user-specific metadata.
 
 ### Sentinel support
 
@@ -344,7 +344,7 @@ end
 ```
 
 *Note*: pubsub connections are stateful, as such they won't ever reconnect automatically.
-The caller is resonsible for reconnecting if the connection is lost and to resubscribe to
+The caller is responsible for reconnecting if the connection is lost and to resubscribe to
 all channels.
 
 ## Production
@@ -380,7 +380,7 @@ redis_config = RedisClient.config(middlewares: [AnotherRedisInstrumentation])
 redis_config.new_client
 ```
 
-If middlewares need a client specific configuration, `Config#custom` can be used
+If middlewares need a client-specific configuration, `Config#custom` can be used
 
 ```ruby
 module MyGlobalRedisInstrumentation
@@ -454,9 +454,9 @@ redis_config = RedisClient.config(reconnect_attempts: [0, 0.05, 0.1])
 ```
 
 This configuration is generally used when the Redis server is expected to failover or recover relatively quickly and
-that it's not really possibe to continue without issuing the command.
+that it's not really possible to continue without issuing the command.
 
-When the Redis server is used as an ephemeral cache, circuit breakers are generally prefered.
+When the Redis server is used as an ephemeral cache, circuit breakers are generally preferred.
 
 ### Circuit Breaker
 

data/lib/redis_client/ruby_connection/buffered_io.rb

@@ -24,10 +24,6 @@ class RedisClient
         @io.to_io.close
       end
 
-      def reopen(*args)
-        @io.to_io.reopen(*args)
-      end
-
       def closed?
         @io.to_io.closed?
       end

data/lib/redis_client/ruby_connection.rb

@@ -58,13 +58,6 @@ class RedisClient
       super
     end
 
-    def discard
-      unless @io.closed?
-        @io.reopen(File::NULL)
-      end
-      close
-    end
-
     def read_timeout=(timeout)
       @read_timeout = timeout
       @io.read_timeout = timeout if @io

data/lib/redis_client/sentinel_config.rb

@@ -10,7 +10,7 @@ class RedisClient
     attr_reader :name
 
     def initialize(sentinels:, role: :master, name: nil, url: nil, **client_config)
-      unless %i(master replica slave).include?(role)
+      unless %i(master replica slave).include?(role.to_sym)
         raise ArgumentError, "Expected role to be either :master or :replica, got: #{role.inspect}"
       end
 
@@ -43,7 +43,7 @@ class RedisClient
       end
 
       @sentinels = {}.compare_by_identity
-      @role = role
+      @role = role.to_sym
       @mutex = Mutex.new
       @config = nil
 

data/lib/redis_client/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 class RedisClient
-  VERSION = "0.15.0"
+  VERSION = "0.16.0"
 end

data/lib/redis_client.rb

@@ -358,9 +358,8 @@ class RedisClient
     self
   end
 
-  def discard
-    @raw_connection&.discard
-    self
+  def disable_reconnection(&block)
+    ensure_connected(retryable: false, &block)
   end
 
   def pipelined
@@ -623,7 +622,7 @@ class RedisClient
   end
 
   def ensure_connected(retryable: true)
-    discard if !config.inherit_socket && @pid != PIDCache.pid
+    close if !config.inherit_socket && @pid != PIDCache.pid
 
     if @disable_reconnection
       if block_given?

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: redis-client
 version: !ruby/object:Gem::Version
-  version: 0.15.0
+  version: 0.16.0
 platform: ruby
 authors:
 - Jean Boussier
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-08-01 00:00:00.000000000 Z
+date: 2023-08-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: connection_pool
@@ -77,7 +77,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
+rubygems_version: 3.4.10
 signing_key:
 specification_version: 4
 summary: Simple low-level client for Redis 6+