redis-store 1.6.0 → 1.9.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 7d09e598db500a23547cfabf8b0ee023aa473aa5
-  data.tar.gz: 34fea83415585fe81210982d30f1f8891e4f90c5
+SHA256:
+  metadata.gz: 7a70e9a1e720591e28f5abee4cbfff877503f808a9318143234579ea942dc073
+  data.tar.gz: 037aa5824d933374d37e0f922c8992034ed48d05bf00069be6040d52a6706b2e
 SHA512:
-  metadata.gz: a50a647e8edc5a25a1a2d9c2038bac4bec7d77cdc4b68734004c9f5cf4aec105a6d737172cf2a4759239309484aaf9470f73a0db14f0b08bec76718d8a5bd242
-  data.tar.gz: 24c45f122e99129e14c8dc352875ed7be76c3461623f4b101f955fa2322a4eb16ed0c53c62e1da936480c6e0d096284c77fed18c816f95c64957a9e8776396ad
+  metadata.gz: fe1f61f58277a706a19100e85433bd7177b23b8245c6f1354cbe49abdcb2aa9abed9a3956686b074d5c9edb7006f5dbb8f8715d579f316832eecf711a656dab1
+  data.tar.gz: 22d18ed2621e2075d2e02a7f830d4ad2de45f834405f62650e9f41f19bff6b6d3a5017d1247fe0de893e5d3c21f71c3aed63f742c8823d05bef5cf6148c74c4d

data/.github/auto-assign-issues.yml

@@ -0,0 +1,2 @@
+assignees:
+  - tubbo

data/.github/release.yml

@@ -0,0 +1,13 @@
+changelog:
+  exclude:
+    labels: [dependencies]
+    authors: [renovate-bot]
+  categories:
+    - title: Breaking Changes
+      labels: [breaking]
+    - title: New Features
+      labels: [enhancement]
+    - title: Bug Fixes
+      labels: [bug]
+    - title: Other Changes
+      labels: ["*"]

data/.github/workflows/ci.yml

@@ -0,0 +1,62 @@
+name: CI
+on:
+  push:
+    branches-ignore: [master]
+    tags-ignore: [v*]
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+jobs:
+  test:
+    name: "test (ruby: ${{ matrix.ruby }}, redis.rb: ${{ matrix.redis }})"
+    runs-on: ubuntu-latest
+    continue-on-error: ${{ contains(matrix.ruby, 'head') }}
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby:
+          - "2.7"
+          - "3.0"
+          - "3.1"
+          # - 'head'
+          - "jruby"
+          # - 'jruby-head'
+          - "truffleruby"
+          # - 'truffleruby-head'
+        redis:
+          - 4_0_x
+          - 4_1_x
+          - 4_x
+    env:
+      BUNDLE_GEMFILE: ${{ github.workspace }}/gemfiles/redis_${{ matrix.redis }}.gemfile
+    services:
+      redis:
+        image: redis
+        ports:
+          - 6379:6379
+      distributed1:
+        image: redis
+        ports:
+          - 6380:6380
+      distributed2:
+        image: redis
+        ports:
+          - 6381:6381
+    steps:
+      - uses: actions/checkout@v3
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+          bundler-cache: true
+      - run: bundle exec rake
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+        with:
+          fetch-depth: 0
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: 3.1
+          bundler-cache: true
+      - run: bundle exec rake lint

data/.github/workflows/publish.yml

@@ -0,0 +1,32 @@
+name: Publish
+on:
+  push:
+    tags: [v*]
+permissions:
+  contents: write
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+jobs:
+  release:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: "3.1"
+          bundler-cache: true
+      - run: |
+          mkdir -p ~/.gem
+          cat << EOF > ~/.gem/credentials
+          ---
+          :rubygems_api_key: ${{ secrets.RUBYGEMS_API_KEY }}
+          EOF
+
+          chmod 0600 ~/.gem/credentials
+      - run: bundle exec rake release
+      - uses: softprops/action-gh-release@v1
+        with:
+          files: "*.gem"
+          generate_release_notes: true
+          prerelease: ${{ contains(github.ref, '.pre') }}

data/.rubocop.yml

@@ -5,18 +5,12 @@ AllCops:
   # to ignore them, so only the ones explicitly set in this file are enabled.
   DisabledByDefault: true
   Exclude:
-    - '**/vendor/**/*'
+    - "**/vendor/**/*"
 
 # Prefer &&/|| over and/or.
 Style/AndOr:
   Enabled: true
 
-# Do not use braces for hash literals when they are the last argument of a
-# method call.
-Style/BracesAroundHashParameters:
-  Enabled: true
-  EnforcedStyle: context_dependent
-
 # Align comments with method definitions.
 Layout/CommentIndentation:
   Enabled: true
@@ -46,7 +40,7 @@ Layout/FirstParameterIndentation:
 # extra level of indentation.
 Layout/IndentationConsistency:
   Enabled: true
-  EnforcedStyle: rails
+  EnforcedStyle: indented_internal_methods
 
 # Two spaces, no tabs (for indentation).
 Layout/IndentationWidth:
@@ -99,11 +93,11 @@ Layout/SpaceInsideParens:
   Enabled: true
 
 # Detect hard tabs, no hard tabs.
-Layout/Tab:
+Layout/IndentationStyle:
   Enabled: true
 
 # Blank lines should not have any spaces.
-Layout/TrailingBlankLines:
+Layout/TrailingEmptyLines:
   Enabled: true
 
 # No trailing whitespace.
@@ -111,7 +105,7 @@ Layout/TrailingWhitespace:
   Enabled: true
 
 # Use quotes for string literals when they are enough.
-Style/UnneededPercentQ:
+Style/RedundantPercentQ:
   Enabled: true
 
 # Align `end` with the matching keyword or starting expression except for

data/Appraisals

@@ -1,8 +1,19 @@
+appraise "redis_4_0_x" do
+  gem "redis", "~> 4.0.0"
+end
+
+appraise "redis_4_1_x" do
+  gem "redis", "~> 4.1.0"
+end
 
-appraise "redis_3_x" do
-  gem "redis", "~> 3.0"
+appraise "redis_4_6_x" do
+  gem "redis", "~> 4.6.0"
 end
 
 appraise "redis_4_x" do
   gem "redis", "~> 4.0"
 end
+
+appraise "redis_5_x" do
+  gem "redis", "~> 5.0"
+end

data/CHANGELOG.md

@@ -1,5 +1,63 @@
 # Changelog
 
+## 1.9.0
+
+Breaking Changes
+
+* As a factor of updates for Redis v4.2.x, support for Ruby 2.1 and 2.2
+  has been dropped. These Ruby versions are end-of-life anyway.
+
+Fixed
+
+* [Compatibility with Redis client v4.2.x](https://github.com/redis-store/redis-store/pull/333)
+
+Added
+
+* [Support for edge Ruby's keyword arguments](https://github.com/redis-store/redis-store/pull/334)
+
+## 1.8.2
+
+Breaking Changes
+
+* None
+
+Added
+
+* [Add namespace to zincrby and zscore](https://github.com/redis-store/redis-store/pull/323)
+* [Add namespace to zadd and zrem](https://github.com/redis-store/redis-store/pull/326)
+
+Fixed
+
+* None
+
+## 1.8.1
+
+Breaking Changes
+
+* None
+
+Added
+
+* None
+
+Fixed
+
+* [Add namespace to remaining hash methods](https://github.com/redis-store/redis-store/pull/321)
+
+## 1.8.0
+
+Breaking Changes
+
+* None
+
+Added
+
+* [Redis Cluster Support](https://github.com/redis-store/redis-store/pull/318)
+
+Fixed
+
+* None
+
 ## 1.6.0
 
 Breaking Changes
@@ -59,7 +117,7 @@ Added
 
 Fixed
 
-* Conventional `Marshal.dump` usage allowing potential security vulnerability (CVE-2017-1000248) 
+* Conventional `Marshal.dump` usage allowing potential security vulnerability (CVE-2017-1000248)
 
 ## 1.3.0
 

data/CODEOWNERS

@@ -0,0 +1 @@
+* @tubbo

data/README.md

@@ -45,9 +45,9 @@ s.add_dependency 'redis-store', '>= 1.4', '< 2'
 
 ## Status
 
-[![Gem Version](https://badge.fury.io/rb/redis-store.png)](http://badge.fury.io/rb/redis-store)
-[![Build Status](https://secure.travis-ci.org/redis-store/redis-store.png?branch=master)](http://travis-ci.org/redis-store/redis-store?branch=master)
-[![Code Climate](https://codeclimate.com/github/redis-store/redis-store.png)](https://codeclimate.com/github/redis-store/redis-store)
+[![Gem Version](https://badge.fury.io/rb/redis-store.svg)](http://badge.fury.io/rb/redis-store)
+[![Build Status](https://secure.travis-ci.org/redis-store/redis-store.svg?branch=master)](http://travis-ci.org/redis-store/redis-store?branch=master)
+[![Code Climate](https://codeclimate.com/github/redis-store/redis-store.svg)](https://codeclimate.com/github/redis-store/redis-store)
 
 ## Copyright
 

data/Rakefile

@@ -7,7 +7,7 @@ require 'rubocop/rake_task'
 
 RuboCop::RakeTask.new :lint
 
-if !ENV["APPRAISAL_INITIALIZED"] && !ENV["TRAVIS"]
+if !ENV["APPRAISAL_INITIALIZED"] && !ENV["CI"]
   task :default do
     sh "appraisal install && rake appraisal default"
   end

data/gemfiles/redis_4_0_x.gemfile

@@ -0,0 +1,7 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "redis", "~> 4.0.0"
+
+gemspec path: "../"

data/gemfiles/redis_4_1_x.gemfile

@@ -0,0 +1,7 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "redis", "~> 4.1.0"
+
+gemspec path: "../"

data/gemfiles/redis_4_6_x.gemfile

@@ -0,0 +1,7 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "redis", "~> 4.6.0"
+
+gemspec path: "../"

data/gemfiles/{redis_3_x.gemfile → redis_5_x.gemfile}

@@ -2,6 +2,6 @@
 
 source "https://rubygems.org"
 
-gem "redis", "~> 3.0"
+gem "redis", "~> 5.0"
 
 gemspec path: "../"

data/lib/redis/store/interface.rb

@@ -5,8 +5,16 @@ class Redis
         super(key)
       end
 
+      REDIS_SET_OPTIONS = %i(ex px nx xx keepttl).freeze
+      private_constant :REDIS_SET_OPTIONS
+
       def set(key, value, options = nil)
-        super(key, value, options || {})
+        if options && REDIS_SET_OPTIONS.any? { |k| options.key?(k) }
+          kwargs = REDIS_SET_OPTIONS.each_with_object({}) { |key, h| h[key] = options[key] if options.key?(key) }
+          super(key, value, **kwargs)
+        else
+          super(key, value)
+        end
       end
 
       def setnx(key, value, options = nil)

data/lib/redis/store/namespace.rb

@@ -3,28 +3,32 @@ class Redis
     module Namespace
       FLUSHDB_BATCH_SIZE = 1000
 
-      def set(key, val, options = nil)
-        namespace(key) { |k| super(k, val, options) }
+      def set(key, *args)
+        namespace(key) { |k| super(k, *args) }
       end
 
-      def setex(key, ttl, val, options = nil)
-        namespace(key) { |k| super(k, ttl, val, options) }
+      def setex(key, *args)
+        namespace(key) { |k| super(k, *args) }
       end
 
-      def setnx(key, val, options = nil)
-        namespace(key) { |k| super(k, val, options) }
+      def setnx(key, *args)
+        namespace(key) { |k| super(k, *args) }
       end
 
       def ttl(key, options = nil)
         namespace(key) { |k| super(k) }
       end
 
-      def get(key, options = nil)
-        namespace(key) { |k| super(k, options) }
+      def get(key, *args)
+        namespace(key) { |k| super(k, *args) }
       end
 
-      def exists(key)
-        namespace(key) { |k| super(k) }
+      def exists(*keys)
+        super(*keys.map { |key| interpolate(key) })
+      end
+
+      def exists?(*keys)
+        super(*keys.map { |key| interpolate(key) })
       end
 
       def incrby(key, increment)
@@ -39,10 +43,25 @@ class Redis
         namespace(pattern) { |p| super(p).map { |key| strip_namespace(key) } }
       end
 
+      def scan(cursor, match: nil, **kwargs)
+        if match
+          namespace(match) do |pattern|
+            cursor, keys = super(cursor, match: pattern, **kwargs)
+            [ cursor, keys.map { |key| strip_namespace(key) } ]
+          end
+        else
+          super(cursor, **kwargs)
+        end
+      end
+
       def del(*keys)
         super(*keys.map { |key| interpolate(key) }) if keys.any?
       end
 
+      def unlink(*keys)
+        super(*keys.map { |key| interpolate(key) }) if keys.any?
+      end
+
       def watch(*keys)
         super(*keys.map { |key| interpolate(key) }) if keys.any?
       end
@@ -63,6 +82,86 @@ class Redis
         namespace(key) { |k| super(k, ttl) }
       end
 
+      def hdel(key, *fields)
+        namespace(key) { |k| super(k, *fields) }
+      end
+
+      def hget(key, field)
+        namespace(key) { |k| super(k, field) }
+      end
+
+      def hgetall(key)
+        namespace(key) { |k| super(k) }
+      end
+
+      def hexists(key, field)
+        namespace(key) { |k| super(k, field) }
+      end
+
+      def hincrby(key, field, increment)
+        namespace(key) { |k| super(k, field, increment) }
+      end
+
+      def hincrbyfloat(key, field, increment)
+        namespace(key) { |k| super(k, field, increment) }
+      end
+
+      def hkeys(key)
+        namespace(key) { |k| super(k) }
+      end
+
+      def hlen(key)
+        namespace(key) { |k| super(k) }
+      end
+
+      def hmget(key, *fields, &blk)
+        namespace(key) { |k| super(k, *fields, &blk) }
+      end
+
+      def hmset(key, *attrs)
+        namespace(key) { |k| super(k, *attrs) }
+      end
+
+      def hset(key, *args)
+        namespace(key) { |k| super(k, *args) }
+      end
+
+      def hsetnx(key, field, val)
+        namespace(key) { |k| super(k, field, val) }
+      end
+
+      def hvals(key)
+        namespace(key) { |k| super(k) }
+      end
+
+      def hscan(key, *args)
+        namespace(key) { |k| super(k, *args) }
+      end
+
+      def hscan_each(key, *args)
+        namespace(key) { |k| super(k, *args) }
+      end
+
+      def zincrby(key, increment, member)
+        namespace(key) { |k| super(k, increment, member) }
+      end
+
+      def zscore(key, member)
+        namespace(key) { |k| super(k, member) }
+      end
+
+      def zadd(key, *args)
+        namespace(key) { |k| super(k, *args) }
+      end
+
+      def zrem(key, member)
+        namespace(key) { |k| super(k, member) }
+      end
+
+      if respond_to?(:ruby2_keywords, true)
+        ruby2_keywords :set, :setex, :setnx, :hscan, :hscan_each
+      end
+
       def to_s
         if namespace_str
           "#{super} with namespace #{namespace_str}"

data/lib/redis/store/ttl.rb

@@ -19,9 +19,14 @@ class Redis
 
       protected
         def setnx_with_expire(key, value, ttl, options = {})
-          with_multi_or_pipelined(options) do
-            setnx(key, value, :raw => true)
-            expire(key, ttl)
+          with_multi_or_pipelined(options) do |transaction|
+            if transaction.is_a?(Redis::Store) # for redis < 4.6
+              setnx(key, value, :raw => true)
+              expire(key, ttl)
+            else
+              transaction.setnx(key, value)
+              transaction.expire(key, ttl)
+            end
           end
         end
 
@@ -34,7 +39,7 @@ class Redis
         end
 
         def with_multi_or_pipelined(options, &block)
-          return pipelined(&block) if options[:avoid_multi_commands]
+          return pipelined(&block) if options.key?(:cluster) || options[:avoid_multi_commands]
           multi(&block)
         end
     end

data/lib/redis/store/version.rb

@@ -1,5 +1,5 @@
 class Redis
   class Store < self
-    VERSION = '1.6.0'
+    VERSION = '1.9.2'
   end
 end

data/redis-store.gemspec

@@ -12,18 +12,14 @@ Gem::Specification.new do |s|
   s.summary     = 'Redis stores for Ruby frameworks'
   s.description = 'Namespaced Rack::Session, Rack::Cache, I18n and cache Redis stores for Ruby web frameworks.'
 
-  s.rubyforge_project = 'redis-store'
-
   s.files         = `git ls-files`.split("\n")
-  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
-  s.executables   = `git ls-files -- bin/*`.split("\n").map { |f| File.basename(f) }
   s.require_paths = ["lib"]
   s.license       = 'MIT'
 
-  s.add_dependency 'redis', '>= 2.2', '< 5'
+  s.add_dependency 'redis', '>= 4', '< 6'
 
-  s.add_development_dependency 'rake',     '~> 10'
-  s.add_development_dependency 'bundler',  '~> 1.3'
+  s.add_development_dependency 'rake',     '>= 12.3.3'
+  s.add_development_dependency 'bundler'
   s.add_development_dependency 'mocha',    '~> 0.14.0'
   s.add_development_dependency 'minitest', '~> 5'
   s.add_development_dependency 'git',      '~> 1.2'

data/test/redis/distributed_store_test.rb

@@ -19,7 +19,7 @@ describe "Redis::DistributedStore" do
     dmr = Redis::DistributedStore.new [ :host => "localhost", :port => "6380", :db => "1" ]
     dmr.ring.nodes.size == 1
     mr = dmr.ring.nodes.first
-    mr.to_s.must_equal("Redis Client connected to localhost:6380 against DB 1")
+    _(mr.to_s).must_equal("Redis Client connected to localhost:6380 against DB 1")
   end
 
   it "forces reconnection" do
@@ -32,11 +32,11 @@ describe "Redis::DistributedStore" do
 
   it "sets an object" do
     @dmr.set "rabbit", @white_rabbit
-    @dmr.get("rabbit").must_equal(@white_rabbit)
+    _(@dmr.get("rabbit")).must_equal(@white_rabbit)
   end
 
   it "gets an object" do
-    @dmr.get("rabbit").must_equal(@rabbit)
+    _(@dmr.get("rabbit")).must_equal(@rabbit)
   end
 
   it "mget" do
@@ -44,9 +44,9 @@ describe "Redis::DistributedStore" do
     begin
       @dmr.mget "rabbit", "rabbit2" do |rabbits|
         rabbit, rabbit2 = rabbits
-        rabbits.length.must_equal(2)
-        rabbit.must_equal(@rabbit)
-        rabbit2.must_equal(@white_rabbit)
+        _(rabbits.length).must_equal(2)
+        _(rabbit).must_equal(@rabbit)
+        _(rabbit2).must_equal(@white_rabbit)
       end
     rescue Redis::Distributed::CannotDistribute
       # Not supported on redis-rb < 4, and hence Ruby < 2.2.
@@ -57,9 +57,9 @@ describe "Redis::DistributedStore" do
     @dmr.set "rabbit2", @white_rabbit
     begin
       result = @dmr.mapped_mget("rabbit", "rabbit2")
-      result.keys.must_equal %w[ rabbit rabbit2 ]
-      result["rabbit"].must_equal @rabbit
-      result["rabbit2"].must_equal @white_rabbit
+      _(result.keys).must_equal %w[ rabbit rabbit2 ]
+      _(result["rabbit"]).must_equal @rabbit
+      _(result["rabbit2"]).must_equal @white_rabbit
     rescue Redis::Distributed::CannotDistribute
       # Not supported on redis-rb < 4, and hence Ruby < 2.2.
     end
@@ -70,7 +70,7 @@ describe "Redis::DistributedStore" do
                                     { :host => "localhost", :port => "6380", :db => 0 },
                                     { :host => "localhost", :port => "6381", :db => 0 }
                                 ], replicas: 1024
-    dmr.ring.replicas.must_equal 1024
+    _(dmr.ring.replicas).must_equal 1024
   end
 
   it "uses a custom ring object" do
@@ -79,8 +79,8 @@ describe "Redis::DistributedStore" do
                                           { :host => "localhost", :port => "6380", :db => 0 },
                                           { :host => "localhost", :port => "6381", :db => 0 }
                                       ], ring: my_ring
-    dmr.ring.must_equal my_ring
-    dmr.ring.nodes.length.must_equal 2
+    _(dmr.ring).must_equal my_ring
+    _(dmr.ring.nodes.length).must_equal 2
   end
 
   describe '#redis_version' do
@@ -108,4 +108,4 @@ describe "Redis::DistributedStore" do
       @dmr.get "rabbit"
     end
   end
-end
+end unless ENV['CI']