redis-store 1.9.1 → 1.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f1313af60d82044041ee37781a16eb734332476e45ce6bc59d6c2ffa4e90c1d5
-  data.tar.gz: b17aa7cf4cc0439c2e1ee460dd15c4f16a43963370a742c9a3c9180dc970d5dc
+  metadata.gz: 90b9775d198eedd8f7fbfbf48548ea825bf888a80bf430be0b7124d9092b6f7a
+  data.tar.gz: bfa57fa72dafc2bf60885da2501cd377eaceb45892a5e21ca9515d378556f95a
 SHA512:
-  metadata.gz: ff9ea84a0b8daf75b59883ab6d2040a3726caaf43249d52661d1d9aa335ac2c25c7e53c351d45c81f2009b50a34d07bbe6a3d408d2701bdc7c7301959c2cb4dc
-  data.tar.gz: bccc369d3d57af1dcec02e1797b1e8527b3993c051c6ff3db60556638529630adbc3ba5a7b4d53b08ebe991f145abb7eaac37873fac734ca6c4bd6ec0ea31074
+  metadata.gz: c4c0e067c7e20907158913fa39dbc86abc5c5b3a8120f966e2f311dcb3ae380596c824d0bfcb9385ca77681e8fb98d06ff63f45c289dfb51a1916d5448fe7ab4
+  data.tar.gz: d6e2d2bc963b99870f4a4abe0e20ede46dc3177f214685922aa0313e8baa9f2879d1fadd1d7786b5ce6d7dc9b736ee7a1ee74664041bbf4479347e96c44b0421

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,64 @@
+name: CI
+on:
+  pull_request:
+  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
+          - 5_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"
+          bundle-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/.gitignore

@@ -4,3 +4,6 @@ tmp/
 stdout
 # Gemfile locks generated by Appraisals
 gemfiles/*.gemfile.lock
+gemfiles/.bundle/
+# ASDF
+.tool-versions

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,4 +1,3 @@
-
 appraise "redis_4_0_x" do
   gem "redis", "~> 4.0.0"
 end
@@ -7,6 +6,14 @@ appraise "redis_4_1_x" do
   gem "redis", "~> 4.1.0"
 end
 
+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,12 @@
 # Changelog
 
+## 1.10.0 and future
+
+As at 1.10 and above, changelog information will be on this project's releases page:
+
+https://github.com/redis-store/redis-store/releases
+
+
 ## 1.9.0
 
 Breaking Changes

data/README.md

@@ -46,7 +46,7 @@ s.add_dependency 'redis-store', '>= 1.4', '< 2'
 ## Status
 
 [![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)
+[![Build Status](https://github.com/redis-store/redis-store/actions/workflows/ci.yml/badge.svg)](https://github.com/redis-store/redis-store/actions/workflows/ci.yml)
 [![Code Climate](https://codeclimate.com/github/redis-store/redis-store.svg)](https://codeclimate.com/github/redis-store/redis-store)
 
 ## Copyright

data/Rakefile

@@ -1,14 +1,15 @@
 require 'bundler/setup'
 require 'rake'
 require 'bundler/gem_tasks'
-require 'redis-store/testing/tasks'
 require 'appraisal'
 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
+else
+  require 'redis-store/testing/tasks'
 end

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_5_x.gemfile

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

data/lib/redis/distributed_store.rb

@@ -7,6 +7,8 @@ class Redis
 
     def initialize(addresses, options = {})
       _extend_namespace options
+      # `@tag` introduced in `redis-rb` 5.0
+      @tag = options[:tag] || /^\{(.+?)\}/
       @ring = options[:ring] || Redis::HashRing.new([], options[:replicas] || Redis::HashRing::POINTS_PER_SERVER)
 
       addresses.each do |address|

data/lib/redis/store/factory.rb

@@ -1,3 +1,4 @@
+require 'cgi'
 require 'uri'
 
 class Redis

data/lib/redis/store/namespace.rb

@@ -47,7 +47,7 @@ class Redis
         if match
           namespace(match) do |pattern|
             cursor, keys = super(cursor, match: pattern, **kwargs)
-            [ cursor, keys.map{ |key| strip_namespace(key) } ]
+            [ cursor, keys.map { |key| strip_namespace(key) } ]
           end
         else
           super(cursor, **kwargs)

data/lib/redis/store/ttl.rb

@@ -20,8 +20,13 @@ class Redis
       protected
         def setnx_with_expire(key, value, ttl, options = {})
           with_multi_or_pipelined(options) do |transaction|
-            transaction.setnx(key, value, :raw => true)
-            transaction.expire(key, ttl)
+            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
 

data/lib/redis/store/version.rb

@@ -1,5 +1,12 @@
 class Redis
   class Store < self
-    VERSION = '1.9.1'
+    VERSION = '1.10.0'
+
+    def self.redis_client_defined?
+      # Doesn't work if declared as constant
+      # due to unpredictable gem loading order
+      # https://github.com/redis-rb/redis-client
+      defined?(::RedisClient::VERSION)
+    end
   end
 end

data/lib/redis/store.rb

@@ -14,9 +14,13 @@ class Redis
     include Ttl, Interface, RedisVersion
 
     def initialize(options = {})
-      super
+      orig_options = options.dup
 
-      unless options[:marshalling].nil?
+      _remove_unsupported_options(options)
+      # The options here is updated
+      super(options)
+
+      unless orig_options[:marshalling].nil?
         puts %(
           DEPRECATED: You are passing the :marshalling option, which has been
           replaced with `serializer: Marshal` to support pluggable serialization
@@ -27,14 +31,15 @@ class Redis
         )
       end
 
-      @serializer = options.key?(:serializer) ? options[:serializer] : Marshal
+      @serializer = orig_options.key?(:serializer) ? orig_options.delete(:serializer) : Marshal
 
-      unless options[:marshalling].nil?
-        @serializer = options[:marshalling] ? Marshal : nil
+      unless orig_options[:marshalling].nil?
+        # `marshalling` only used here, might not be supported in `super`
+        @serializer = orig_options.delete(:marshalling) ? Marshal : nil
       end
 
-      _extend_marshalling options
-      _extend_namespace   options
+      _extend_marshalling
+      _extend_namespace orig_options
     end
 
     def reconnect
@@ -56,7 +61,19 @@ class Redis
     end
 
     private
-      def _extend_marshalling(options)
+      def _remove_unsupported_options(options)
+        return unless self.class.redis_client_defined?
+
+        # Unsupported keywords should be removed to avoid errors
+        # https://github.com/redis-rb/redis-client/blob/v0.13.0/lib/redis_client/config.rb#L21
+        options.delete(:raw)
+        options.delete(:serializer)
+        options.delete(:marshalling)
+        options.delete(:namespace)
+        options.delete(:scheme)
+      end
+
+      def _extend_marshalling
         extend Serialization unless @serializer.nil?
       end
 

data/redis-store.gemspec

@@ -16,11 +16,11 @@ Gem::Specification.new do |s|
   s.require_paths = ["lib"]
   s.license       = 'MIT'
 
-  s.add_dependency 'redis', '>= 4', '< 5'
+  s.add_dependency 'redis', '>= 4', '< 6'
 
   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 'mocha',    '~> 2.1.0'
   s.add_development_dependency 'minitest', '~> 5'
   s.add_development_dependency 'git',      '~> 1.2'
   s.add_development_dependency 'pry-nav',  '~> 0.2.4'

data/test/redis/distributed_store_test.rb

@@ -17,9 +17,9 @@ describe "Redis::DistributedStore" do
 
   it "accepts connection params" do
     dmr = Redis::DistributedStore.new [ :host => "localhost", :port => "6380", :db => "1" ]
-    dmr.ring.nodes.size == 1
+    _(dmr.ring.nodes.size).must_equal(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']