redis-client 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '097ad5acec4f5ea01788629c3fe2c606e54c1a2a0749c4e489487cf6bd446eae'
-  data.tar.gz: 275d778806cb7848d99ddcba33f1e932853efc9f0d149d6409692d1b39452d86
+  metadata.gz: 6bd28ab66722c23791118818d83505de8cbc1b141c75959f2408b8a0c90cb6ad
+  data.tar.gz: 30f85f2bb0df340facd9a743f63dcfd2ff8fa8b8a3e363c9fdeb2f1101d5d076
 SHA512:
-  metadata.gz: c553d706fe8b955a0c6b65a28e9d6a1ddcdec156a562ec5092396a0bca9fa72a251441b8675484fff2d4db3d8e2f335043d226bb4c9c3359e84acc9b7605543f
-  data.tar.gz: 68dcc5d81b1632dd60d22651d0ef600903fe607230d3ac396d5e98aab7694d374d5e577777234d7e514fc4df04b332e0fdb31b3c9971fb116c6b0e87c1ddc5f5
+  metadata.gz: 528b4cd6f9377f083a19ca1da7b117625ad32c1849c8cc53d795dc5af8e6d23c372fdb5714c043b7c796a6fcfda54ef28ee0142268846445cbfb60e00eabf625
+  data.tar.gz: af0040e6a5cf498587818b5161122d57e3057a39a22d0eb5fc8252e4cb56e71ad61c0a381fbe35c75cd6f5e5e2998169487e33b74f7635f7e025f6e06d7351ca

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Unreleased
 
+# 0.4.0
+
+- The `hiredis` driver have been moved to the `hiredis-client` gem.
+
 # 0.3.0
 
 - `hiredis` is now the default driver when available.

data/Gemfile

@@ -3,9 +3,8 @@
 source "https://rubygems.org"
 
 # Specify your gem's dependencies in redis-client.gemspec
-gemspec
+gemspec name: "redis-client"
 
-gem "connection_pool"
 gem "minitest"
 gem "rake", "~> 13.0"
 gem "rake-compiler"

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    redis-client (0.3.0)
+    redis-client (0.4.0)
       connection_pool
 
 GEM
@@ -51,7 +51,6 @@ PLATFORMS
 DEPENDENCIES
   benchmark-ips
   byebug
-  connection_pool
   hiredis
   minitest
   rake (~> 13.0)

data/README.md

@@ -389,21 +389,17 @@ redis.call_once("INCR", "counter") # Won't be retried.
 
 ### Drivers
 
-`redis-client` ships with two connection implementations, a `hiredis` binding and a pure Ruby implementation.
+`redis-client` ships with a pure Ruby socket implementation.
 
-The hiredis binding is only available on Linux, macOS and other POSIX platforms. When available it is the default.
-
-The default driver can be set through `RedisClient.default_driver=`:
+For increased performance, you can enable the `hiredis` binding by adding `hiredis-client` to your Gemfile:
 
 ```ruby
-RedisClient.default_driver = :ruby
+gem "hiredis-client"
 ```
 
-You can also select the driver on a per connection basis:
+The hiredis binding is only available on Linux, macOS and other POSIX platforms. You can install the gem on other platforms, but it won't have any effect.
 
-```ruby
-redis_config = RedisClient.config(driver: :ruby, ...)
-```
+The default driver can be set through `RedisClient.default_driver=`:
 
 ## Notable differences with the `redis` gem
 

data/Rakefile

@@ -1,34 +1,53 @@
 # frozen_string_literal: true
 
-require "bundler/gem_tasks"
 require "rake/extensiontask"
 require "rake/testtask"
 require 'rubocop/rake_task'
 
 RuboCop::RakeTask.new
 
+require "rake/clean"
+CLOBBER.include "pkg"
+require "bundler/gem_helper"
+Bundler::GemHelper.install_tasks(name: "redis-client")
+Bundler::GemHelper.install_tasks(dir: "hiredis-client", name: "hiredis-client")
+
 gemspec = Gem::Specification.load("redis-client.gemspec")
 Rake::ExtensionTask.new do |ext|
   ext.name = "hiredis_connection"
-  ext.ext_dir = "ext/redis_client/hiredis"
-  ext.lib_dir = "lib/redis_client"
+  ext.ext_dir = "hiredis-client/ext/redis_client/hiredis"
+  ext.lib_dir = "hiredis-client/lib/redis_client"
   ext.gem_spec = gemspec
   CLEAN.add("#{ext.ext_dir}/vendor/*.{a,o}")
 end
 
-Rake::TestTask.new(:test) do |t|
-  t.libs << "test"
-  t.libs << "lib"
-  t.test_files = FileList["test/**/*_test.rb"].exclude("test/sentinel/*_test.rb")
-end
-
 namespace :test do
+  Rake::TestTask.new(:ruby) do |t|
+    t.libs << "test"
+    t.libs << "lib"
+    t.test_files = FileList["test/**/*_test.rb"].exclude("test/sentinel/*_test.rb")
+  end
+
   Rake::TestTask.new(:sentinel) do |t|
     t.libs << "test/sentinel"
     t.libs << "test"
     t.libs << "lib"
     t.test_files = FileList["test/sentinel/*_test.rb"]
   end
+
+  Rake::TestTask.new(:hiredis) do |t|
+    t.libs << "test/hiredis"
+    t.libs << "test"
+    t.libs << "lib"
+    t.test_files = FileList["test/**/*_test.rb"].exclude("test/sentinel/*_test.rb")
+  end
+end
+
+hiredis_supported = RUBY_ENGINE == "ruby" && !RUBY_PLATFORM.match?(/mswin/)
+if hiredis_supported
+  task test: %i[test:ruby test:hiredis test:sentinel]
+else
+  task test: %i[test:ruby test:sentinel]
 end
 
 namespace :hiredis do
@@ -37,10 +56,14 @@ namespace :hiredis do
     archive_path = "tmp/hiredis-#{version}.tar.gz"
     url = "https://github.com/redis/hiredis/archive/refs/tags/v#{version}.tar.gz"
     system("curl", "-L", url, out: archive_path) or raise "Downloading of #{url} failed"
-    system("rm", "-rf", "ext/redis_client/hiredis/vendor/")
-    system("mkdir", "-p", "ext/redis_client/hiredis/vendor/")
-    system("tar", "xvzf", archive_path, "-C", "ext/redis_client/hiredis/vendor", "--strip-components", "1")
-    system("rm", "-rf", "ext/redis_client/hiredis/vendor/examples")
+    system("rm", "-rf", "hiredis-client/ext/redis_client/hiredis/vendor/")
+    system("mkdir", "-p", "hiredis-client/ext/redis_client/hiredis/vendor/")
+    system(
+      "tar", "xvzf", archive_path,
+      "-C", "hiredis-client/ext/redis_client/hiredis/vendor",
+      "--strip-components", "1",
+    )
+    system("rm", "-rf", "hiredis-client/ext/redis_client/hiredis/vendor/examples")
   end
 end
 
@@ -82,14 +105,10 @@ namespace :benchmark do
   end
 end
 
-if RUBY_PLATFORM == "java"
-  task default: %i[test test:sentinel rubocop]
-else
-  task default: %i[compile test test:sentinel rubocop]
-end
-
-if ENV["DRIVER"] == "hiredis"
-  task ci: %i[compile test test:sentinel]
+if hiredis_supported
+  task default: %i[compile test rubocop]
+  task ci: %i[compile test]
 else
-  task ci: %i[test test:sentinel]
+  task default: %i[test rubocop]
+  task ci: %i[test]
 end

data/lib/redis_client/version.rb

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

data/lib/redis_client.rb

@@ -24,7 +24,7 @@ class RedisClient
 
       name = name.to_sym
       unless @driver_definitions.key?(name)
-        raise ArgumentError, "Unknown driver #{name.inspect}, expected one of: `#{DRIVER_DEFINITIONS.keys.inspect}`"
+        raise ArgumentError, "Unknown driver #{name.inspect}, expected one of: `#{@driver_definitions.keys.inspect}`"
       end
 
       @drivers[name] ||= @driver_definitions[name]&.call
@@ -47,11 +47,6 @@ class RedisClient
     end
   end
 
-  register_driver :hiredis do
-    require "redis_client/hiredis_connection"
-    HiredisConnection
-  end
-
   register_driver :ruby do
     require "redis_client/ruby_connection"
     RubyConnection

data/redis-client.gemspec

@@ -10,6 +10,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.metadata["allowed_push_host"] = "https://rubygems.org"
@@ -22,13 +23,10 @@ Gem::Specification.new do |spec|
   # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
   spec.files = Dir.chdir(File.expand_path(__dir__)) do
     `git ls-files -z`.split("\x0").reject do |f|
-      (f == __FILE__) || f.match(%r{\A(?:(?:bin|test|spec|features|benchmark)/|\.(?:git|travis|circleci)|appveyor)})
+      (f == __FILE__) || f.match(%r{\A(?:(?:bin|hiredis-client|test|spec|features|benchmark)/|\.(?:git|rubocop))})
     end
   end
-  spec.bindir = "exe"
-  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
-  spec.extensions = ["ext/redis_client/hiredis/extconf.rb"]
 
   spec.add_runtime_dependency "connection_pool"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: redis-client
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Jean Boussier
 autorequire:
-bindir: exe
+bindir: bin
 cert_chain: []
-date: 2022-05-05 00:00:00.000000000 Z
+date: 2022-05-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: connection_pool
@@ -28,72 +28,21 @@ description:
 email:
 - jean.boussier@gmail.com
 executables: []
-extensions:
-- ext/redis_client/hiredis/extconf.rb
+extensions: []
 extra_rdoc_files: []
 files:
-- ".rubocop.yml"
 - CHANGELOG.md
 - Gemfile
 - Gemfile.lock
 - LICENSE.md
 - README.md
 - Rakefile
-- ext/redis_client/hiredis/export.clang
-- ext/redis_client/hiredis/export.gcc
-- ext/redis_client/hiredis/extconf.rb
-- ext/redis_client/hiredis/hiredis_connection.c
-- ext/redis_client/hiredis/vendor/.gitignore
-- ext/redis_client/hiredis/vendor/.travis.yml
-- ext/redis_client/hiredis/vendor/CHANGELOG.md
-- ext/redis_client/hiredis/vendor/CMakeLists.txt
-- ext/redis_client/hiredis/vendor/COPYING
-- ext/redis_client/hiredis/vendor/Makefile
-- ext/redis_client/hiredis/vendor/README.md
-- ext/redis_client/hiredis/vendor/adapters/ae.h
-- ext/redis_client/hiredis/vendor/adapters/glib.h
-- ext/redis_client/hiredis/vendor/adapters/ivykis.h
-- ext/redis_client/hiredis/vendor/adapters/libev.h
-- ext/redis_client/hiredis/vendor/adapters/libevent.h
-- ext/redis_client/hiredis/vendor/adapters/libuv.h
-- ext/redis_client/hiredis/vendor/adapters/macosx.h
-- ext/redis_client/hiredis/vendor/adapters/qt.h
-- ext/redis_client/hiredis/vendor/alloc.c
-- ext/redis_client/hiredis/vendor/alloc.h
-- ext/redis_client/hiredis/vendor/appveyor.yml
-- ext/redis_client/hiredis/vendor/async.c
-- ext/redis_client/hiredis/vendor/async.h
-- ext/redis_client/hiredis/vendor/async_private.h
-- ext/redis_client/hiredis/vendor/dict.c
-- ext/redis_client/hiredis/vendor/dict.h
-- ext/redis_client/hiredis/vendor/fmacros.h
-- ext/redis_client/hiredis/vendor/hiredis-config.cmake.in
-- ext/redis_client/hiredis/vendor/hiredis.c
-- ext/redis_client/hiredis/vendor/hiredis.h
-- ext/redis_client/hiredis/vendor/hiredis.pc.in
-- ext/redis_client/hiredis/vendor/hiredis_ssl-config.cmake.in
-- ext/redis_client/hiredis/vendor/hiredis_ssl.h
-- ext/redis_client/hiredis/vendor/hiredis_ssl.pc.in
-- ext/redis_client/hiredis/vendor/net.c
-- ext/redis_client/hiredis/vendor/net.h
-- ext/redis_client/hiredis/vendor/read.c
-- ext/redis_client/hiredis/vendor/read.h
-- ext/redis_client/hiredis/vendor/sds.c
-- ext/redis_client/hiredis/vendor/sds.h
-- ext/redis_client/hiredis/vendor/sdsalloc.h
-- ext/redis_client/hiredis/vendor/sockcompat.c
-- ext/redis_client/hiredis/vendor/sockcompat.h
-- ext/redis_client/hiredis/vendor/ssl.c
-- ext/redis_client/hiredis/vendor/test.c
-- ext/redis_client/hiredis/vendor/test.sh
-- ext/redis_client/hiredis/vendor/win32.h
 - lib/redis-client.rb
 - lib/redis_client.rb
 - lib/redis_client/command_builder.rb
 - lib/redis_client/config.rb
 - lib/redis_client/connection_mixin.rb
 - lib/redis_client/decorator.rb
-- lib/redis_client/hiredis_connection.rb
 - lib/redis_client/middlewares.rb
 - lib/redis_client/pooled.rb
 - lib/redis_client/ruby_connection.rb
@@ -103,7 +52,8 @@ files:
 - lib/redis_client/version.rb
 - redis-client.gemspec
 homepage: https://github.com/redis-rb/redis-client
-licenses: []
+licenses:
+- MIT
 metadata:
   allowed_push_host: https://rubygems.org
   homepage_uri: https://github.com/redis-rb/redis-client

data/.rubocop.yml

@@ -1,191 +0,0 @@
-AllCops:
-  TargetRubyVersion: 2.5
-  NewCops: enable
-  SuggestExtensions: false
-
-Layout/LineLength:
-  Max: 120
-  Exclude:
-    - 'test/**/*'
-    - 'benchmark/**/*'
-
-Layout/CaseIndentation:
-  EnforcedStyle: end
-
-Layout/LineEndStringConcatenationIndentation:
-  EnforcedStyle: indented
-
-Layout/ArgumentAlignment:
-  EnforcedStyle: with_fixed_indentation
-
-Lint/RescueException:
-  Enabled: false
-
-Lint/SuppressedException:
-  Enabled: false
-
-Lint/AssignmentInCondition:
-  Enabled: false
-
-Lint/UnifiedInteger:
-  Enabled: false
-
-Lint/UnderscorePrefixedVariableName:
-  Enabled: false
-
-Lint/EmptyBlock:
-  Enabled: false
-
-Lint/MissingSuper:
-  Enabled: false
-
-Metrics/ClassLength:
-  Enabled: false
-
-Metrics/CyclomaticComplexity:
-  Enabled: false
-
-Metrics/AbcSize:
-  Enabled: false
-
-Metrics/BlockLength:
-  Enabled: false
-
-Metrics/MethodLength:
-  Enabled: false
-
-Metrics/ModuleLength:
-  Enabled: false
-
-Metrics/ParameterLists:
-  Enabled: false
-
-Metrics/PerceivedComplexity:
-  Enabled: false
-
-Style/Alias:
-  EnforcedStyle: prefer_alias_method
-
-Style/PercentLiteralDelimiters:
-  Enabled: false
-
-Style/ParallelAssignment:
-  Enabled: false
-
-Style/NumericPredicate:
-  Enabled: false
-
-Style/NumericLiterals:
-  Enabled: false
-
-Style/IfUnlessModifier:
-  Enabled: false
-
-Style/SignalException:
-  Exclude:
-    - 'lib/redis/connection/synchrony.rb'
-
-Style/StringLiterals:
-  Enabled: false
-
-Style/DoubleNegation:
-  Enabled: false
-
-Style/MultipleComparison:
-  Enabled: false
-
-Style/GuardClause:
-  Enabled: false
-
-Style/Semicolon:
-  Enabled: false
-
-Style/Documentation:
-  Enabled: false
-
-Style/FormatStringToken:
-  Enabled: false
-
-Style/FormatString:
-  Enabled: false
-
-Style/RescueStandardError:
-  Enabled: false
-
-Style/WordArray:
-  Enabled: false
-
-Style/TrailingCommaInArrayLiteral:
-  EnforcedStyleForMultiline: consistent_comma
-
-Style/TrailingCommaInHashLiteral:
-  EnforcedStyleForMultiline: consistent_comma
-
-Style/TrailingCommaInArguments:
-  EnforcedStyleForMultiline: consistent_comma
-
-Lint/NonLocalExitFromIterator:
-  Enabled: false
-
-Layout/FirstArrayElementIndentation:
-  EnforcedStyle: consistent
-
-Layout/FirstHashElementIndentation:
-  EnforcedStyle: consistent
-
-Layout/EndAlignment:
-  EnforcedStyleAlignWith: variable
-
-Layout/ElseAlignment:
-  Enabled: false
-
-Layout/RescueEnsureAlignment:
-  Enabled: false
-
-Naming/HeredocDelimiterNaming:
-  Enabled: false
-
-Naming/FileName:
-  Enabled: false
-
-Naming/RescuedExceptionsVariableName:
-  Enabled: false
-
-Naming/AccessorMethodName:
-  Exclude:
-    - lib/redis/connection/ruby.rb
-
-Naming/MethodParameterName:
-  Enabled: false
-
-Metrics/BlockNesting:
-  Enabled: false
-
-Style/HashTransformValues:
-  Enabled: false
-
-Style/SymbolProc:
-  Exclude:
-    - 'test/**/*'
-
-Style/SoleNestedConditional:
-  Enabled: false
-
-Style/GlobalVars:
-  Exclude:
-    - 'ext/**/*'
-
-Gemspec/RequireMFA:
-  Enabled: false
-
-Style/StderrPuts:
-  Enabled: false
-
-Style/ModuleFunction:
-  Enabled: false
-
-Style/CombinableLoops:
-  Enabled: false
-
-Style/DocumentDynamicEvalDefinition:
-  Enabled: false

data/ext/redis_client/hiredis/export.clang

@@ -1,2 +0,0 @@
-_Init_hiredis_connection
-_ruby_abi_version

data/ext/redis_client/hiredis/export.gcc

@@ -1,7 +0,0 @@
-hiredis_connection_1.0 { 
-  global: 
-    Init_hiredis_connection;
-    ruby_abi_version;
-  local: 
-    *;
-};

data/ext/redis_client/hiredis/extconf.rb

@@ -1,69 +0,0 @@
-# frozen_string_literal: true
-
-require "mkmf"
-
-if RUBY_ENGINE == "ruby" && !RUBY_ENGINE.match?(/mswin/)
-  have_func("rb_hash_new_capa", "ruby.h")
-
-  hiredis_dir = File.expand_path('vendor', __dir__)
-
-  make_program = with_config("make-prog", ENV["MAKE"])
-  make_program ||= case RUBY_PLATFORM
-  when /(bsd|solaris)/
-    'gmake'
-  else
-    'make'
-  end
-
-  openssl_include, openssl_lib = dir_config("openssl")
-
-  openssl_include ||= dir_config("opt").first
-    &.split(File::PATH_SEPARATOR)
-    &.detect { |dir| dir.include?("openssl") }
-
-  openssl_lib ||= dir_config("opt").last
-    &.split(File::PATH_SEPARATOR)
-    &.detect { |dir| dir.include?("openssl") }
-
-  if (!openssl_include || !openssl_lib) && !have_header("openssl/ssl.h")
-    raise "OpenSSL library could not be found. You might want to use --with-openssl-dir=<dir> option to specify the " \
-      "prefix where OpenSSL is installed."
-  end
-
-  Dir.chdir(hiredis_dir) do
-    flags = ["static", "USE_SSL=1"]
-    if openssl_lib
-      flags << %(CFLAGS="-I#{openssl_include}") << %(SSL_LDFLAGS="-L#{openssl_lib}")
-    end
-
-    flags << "OPTIMIZATION=-g" if ENV["EXT_PEDANTIC"]
-
-    unless system(make_program, *flags)
-      raise "Building hiredis failed"
-    end
-  end
-
-  $CFLAGS << " -I#{hiredis_dir}"
-  $LDFLAGS << " -lssl -lcrypto"
-  $libs << " #{hiredis_dir}/libhiredis.a #{hiredis_dir}/libhiredis_ssl.a "
-  $CFLAGS << " -std=c99 "
-  if ENV["EXT_PEDANTIC"]
-    $CFLAGS << " -Werror"
-    $CFLAGS << " -g "
-  else
-    $CFLAGS << " -O3 "
-  end
-
-  if `cc --version`.match?(/ clang /i) || RbConfig::CONFIG['CC'].match?(/clang/i)
-    $LDFLAGS << ' -Wl,-exported_symbols_list,"' << File.join(__dir__, 'export.clang') << '"'
-  elsif RbConfig::CONFIG['CC'].match?(/gcc/i)
-    $LDFLAGS << ' -Wl,--version-script="' << File.join(__dir__, 'export.gcc') << '"'
-  end
-
-  $CFLAGS << " -Wno-declaration-after-statement" # Older compilers
-  $CFLAGS << " -Wno-compound-token-split-by-macro" # Older rubies on macos
-
-  create_makefile("redis_client/hiredis_connection")
-else
-  File.write("Makefile", dummy_makefile($srcdir).join)
-end