redis-client 0.19.1 → 0.20.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 920d97dcf258796ba88bb2f087fa89c1595dd245f67292c7432893848baacd0b
-  data.tar.gz: 07151d3aa036f7c513e7baa2cc94c22a7f9b4af8a09e132b1943716cd458c408
+  metadata.gz: 154db13231ff43137f013f9ef224846201eabf5fef93059a5ed48206e558f238
+  data.tar.gz: 882208c7ad423619cc19cdc3c0b9ae02bd75e425bd702e29b1f2104896a4e0cc
 SHA512:
-  metadata.gz: a6f664cf2c5fe77115606dc15e031e6bccc55c440b55d521ef5429653acb89bf55597dd4e5cd4892fb61f9452790a2ca41e32e72c6f824c7da9609987b14ff42
-  data.tar.gz: c6a34fe93aac6d5ae5c8995881e17581e64a762d0fdc3d3fe1772b07b1759196b2ca5a27e14e00c826399d03a1259f799c816ac1ca1ee001314d9b32f341ecb8
+  metadata.gz: 6e3d3fa8d9684387519cdcc90a7c43319678defa957087902fdb2297ada820cbe746c7821126bcfbdc1f35877bb642382c7b5abebd4a227b2b60a24b8944b4f8
+  data.tar.gz: 40ceb06e68a8fabd9dd067ab177f5e6ca83b9af04e04b8f166bdc36e33ddd642190c400446e029c91b8416eb44f17aeb5cea950b06b7afc2daf6fa5514bef3f3

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 # Unreleased
 
+# 0.20.0
+
+- Accept `unix://` schemes as well as simple paths in the `url:` config parameter. #170.
+- Make basic usage Ractor compatible.
+
 # 0.19.1
 
 - Fixed a bug in `hiredis-client` that could cause a crash if interrupted by `Timeout.timeout` or other `Thread#raise` based mecanism.

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    redis-client (0.19.1)
+    redis-client (0.20.0)
       connection_pool
 
 GEM
@@ -13,34 +13,40 @@ GEM
     connection_pool (2.4.1)
     hiredis (0.6.3)
     hiredis (0.6.3-java)
-    minitest (5.15.0)
-    parallel (1.22.1)
-    parser (3.1.2.1)
+    json (2.7.1)
+    json (2.7.1-java)
+    minitest (5.22.0)
+    parallel (1.24.0)
+    parser (3.3.0.5)
       ast (~> 2.4.1)
+      racc
+    racc (1.7.3)
+    racc (1.7.3-java)
     rainbow (3.1.1)
     rake (13.1.0)
-    rake-compiler (1.2.5)
+    rake-compiler (1.2.7)
       rake
     redis (4.6.0)
-    regexp_parser (2.5.0)
-    rexml (3.2.5)
-    rubocop (1.28.2)
+    regexp_parser (2.9.0)
+    rexml (3.2.6)
+    rubocop (1.50.2)
+      json (~> 2.3)
       parallel (~> 1.10)
-      parser (>= 3.1.0.0)
+      parser (>= 3.2.0.0)
       rainbow (>= 2.2.2, < 4.0)
       regexp_parser (>= 1.8, < 3.0)
-      rexml
-      rubocop-ast (>= 1.17.0, < 2.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.28.0, < 2.0)
       ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 1.4.0, < 3.0)
-    rubocop-ast (1.17.0)
-      parser (>= 3.1.1.0)
-    rubocop-minitest (0.19.1)
-      rubocop (>= 0.90, < 2.0)
-    ruby-progressbar (1.11.0)
-    stackprof (0.2.25)
+      unicode-display_width (>= 2.4.0, < 3.0)
+    rubocop-ast (1.30.0)
+      parser (>= 3.2.1.0)
+    rubocop-minitest (0.30.0)
+      rubocop (>= 1.39, < 2.0)
+    ruby-progressbar (1.13.0)
+    stackprof (0.2.26)
     toxiproxy (2.0.2)
-    unicode-display_width (2.2.0)
+    unicode-display_width (2.5.0)
 
 PLATFORMS
   ruby

data/README.md

@@ -62,7 +62,9 @@ redis.call("GET", "mykey")
 
 ### Configuration
 
-- `url`: A Redis connection URL, e.g. `redis://example.com:6379/5`, a `rediss://` scheme enable SSL, and the path is interpreted as a database number.
+- `url`: A Redis connection URL, e.g. `redis://example.com:6379/5` - a `rediss://` scheme enables SSL, and the path is interpreted as a database number.
+  To connect to UNIX domain sockets, the `url` can also just be a path, and the database specified as query parameter: `/run/redis/foo.sock?db=5`, or optionally
+  have a `unix://` scheme: `unix:///run/redis/foo.sock?db=5`
   Note that all other configurations take precedence, e.g. `RedisClient.config(url: "redis://localhost:3000", port: 6380)` will connect on port `6380`.
 - `host`: The server hostname or IP address. Defaults to `"localhost"`.
 - `port`: The server port. Defaults to `6379`.

data/lib/redis_client/config.rb

@@ -151,6 +151,12 @@ class RedisClient
         if @db && @db != 0
           prelude << ["SELECT", @db.to_s]
         end
+
+        # Deep freeze all the strings and commands
+        prelude.map! do |commands|
+          commands = commands.map { |str| str.frozen? ? str : str.dup.freeze }
+          commands.freeze
+        end
         prelude.freeze
       end
     end
@@ -176,15 +182,20 @@ class RedisClient
         }.compact.merge(kwargs)
         host ||= url_config.host
         port ||= url_config.port
+        path ||= url_config.path
         username ||= url_config.username
         password ||= url_config.password
       end
 
       super(username: username, password: password, **kwargs)
 
-      @host = host || DEFAULT_HOST
-      @port = Integer(port || DEFAULT_PORT)
-      @path = path
+      if @path = path
+        @host = nil
+        @port = nil
+      else
+        @host = host || DEFAULT_HOST
+        @port = Integer(port || DEFAULT_PORT)
+      end
     end
   end
 end

data/lib/redis_client/ruby_connection/resp3.rb

@@ -10,12 +10,12 @@ class RedisClient
 
     EOL = "\r\n".b.freeze
     EOL_SIZE = EOL.bytesize
-    DUMP_TYPES = { # rubocop:disable Style/MutableConstant
+    DUMP_TYPES = {
       String => :dump_string,
       Symbol => :dump_symbol,
       Integer => :dump_numeric,
       Float => :dump_numeric,
-    }
+    }.freeze
     PARSER_TYPES = {
       '#' => :parse_boolean,
       '$' => :parse_blob,
@@ -57,7 +57,7 @@ class RedisClient
     def dump_any(object, buffer)
       method = DUMP_TYPES.fetch(object.class) do |unexpected_class|
         if superclass = DUMP_TYPES.keys.find { |t| t > unexpected_class }
-          DUMP_TYPES[unexpected_class] = DUMP_TYPES[superclass]
+          DUMP_TYPES[superclass]
         else
           raise TypeError, "Unsupported command argument type: #{unexpected_class}"
         end

data/lib/redis_client/url_config.rb

@@ -4,26 +4,41 @@ require "uri"
 
 class RedisClient
   class URLConfig
-    DEFAULT_SCHEMA = "redis"
-    SSL_SCHEMA = "rediss"
-
     attr_reader :url, :uri
 
     def initialize(url)
       @url = url
       @uri = URI(url)
-      unless uri.scheme == DEFAULT_SCHEMA || uri.scheme == SSL_SCHEMA
-        raise ArgumentError, "Invalid URL: #{url.inspect}"
+      @unix = false
+      @ssl = false
+      case uri.scheme
+      when "redis"
+        # expected
+      when "rediss"
+        @ssl = true
+      when "unix", nil
+        @unix = true
+      else
+        raise ArgumentError, "Unknown URL scheme: #{url.inspect}"
       end
     end
 
     def ssl?
-      @uri.scheme == SSL_SCHEMA
+      @ssl
     end
 
     def db
-      db_path = uri.path&.delete_prefix("/")
-      Integer(db_path) if db_path && !db_path.empty?
+      unless @unix
+        db_path = uri.path&.delete_prefix("/")
+        return Integer(db_path) if db_path && !db_path.empty?
+      end
+
+      unless uri.query.nil? || uri.query.empty?
+        _, db_query = URI.decode_www_form(uri.query).find do |key, _|
+          key == "db"
+        end
+        return Integer(db_query) if db_query && !db_query.empty?
+      end
     end
 
     def username
@@ -44,6 +59,12 @@ class RedisClient
       uri.host.sub(/\A\[(.*)\]\z/, '\1')
     end
 
+    def path
+      if @unix
+        File.join(*[uri.host, uri.path].compact)
+      end
+    end
+
     def port
       return unless uri.port
 

data/lib/redis_client/version.rb

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

data/redis-client.gemspec

@@ -11,7 +11,7 @@ Gem::Specification.new do |spec|
   spec.summary = "Simple low-level client for Redis 6+"
   spec.homepage = "https://github.com/redis-rb/redis-client"
   spec.license = "MIT"
-  spec.required_ruby_version = ">= 2.5.0"
+  spec.required_ruby_version = ">= 2.6.0"
 
   spec.metadata["allowed_push_host"] = "https://rubygems.org"
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: redis-client
 version: !ruby/object:Gem::Version
-  version: 0.19.1
+  version: 0.20.0
 platform: ruby
 authors:
 - Jean Boussier
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-12-21 00:00:00.000000000 Z
+date: 2024-02-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: connection_pool
@@ -70,14 +70,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.5.0
+      version: 2.6.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.10
+rubygems_version: 3.5.5
 signing_key:
 specification_version: 4
 summary: Simple low-level client for Redis 6+