redis-activesupport 5.0.7 → 5.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 1a846eea37c0ff4100e7d31590cf05e621192ae2
-  data.tar.gz: b02058a9fc69299ec9306796df202d64e1c6f4d7
+SHA256:
+  metadata.gz: 1701d0f906647612a49e32325e5e3d4cef491fa6e4742b145482a7ad3f2b97b8
+  data.tar.gz: 4fcc1fa74965a7d624aa505874af54c2f49f379357deb5c0ce59efb1e4c7a91e
 SHA512:
-  metadata.gz: ff311cba47a47387cab50b61b6f62f3f01428828e0c1a446040e752fdebc9e3494317413e52d7058805d162fbeccc5c4c6c7d5b2fbd2d632efaf8720266a72e4
-  data.tar.gz: 9f6b6d1a4c639ded371d22afeee967896a0917644cf4e42cc321c39e6ac071ffd0b1dc0b958d0a0db6311f81e00818d1fe7e9a1dafbc7bc5f350ed614edd4a4c
+  metadata.gz: '08fed28507f699223f4fd6ccc344a87d81f135e23837effc913353a8790f1db867dac62e54df107346b4eb01e441873b16675085714673c7fa1efcf9078a62e3'
+  data.tar.gz: 0527ae9cd279eb6b23a0519593a218ad46bc2e2b31cdef48f79571d1f1792b58f2cd92122d7e4b4c2417ab027240cccce47b23435c32f339dcd2d852c52d7738

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

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

data/.travis.yml

@@ -1,30 +1,47 @@
 language: ruby
-script: 'bundle exec rake'
+script: bundle exec rake
 rvm:
-  - 2.0
-  - 2.1
-  - 2.2
-  - 2.3
-  - 2.4
-  - ruby-head
-  - jruby-head
+- 2.0
+- 2.1
+- 2.3
+- 2.4
+- 2.5
+- 2.6
+- ruby-head
+- jruby-head
 services:
-  - redis-server
+- redis-server
 matrix:
   allow_failures:
-    - rvm: jruby-head
-    - rvm: ruby-head
-    - rvm: 2.0
-      gemfile: gemfiles/Gemfile.activesupport-5.x
-    - rvm: 2.1
-      gemfile: gemfiles/Gemfile.activesupport-5.x
+  - rvm: jruby-head
+  - rvm: ruby-head
+  exclude:
+  - rvm: 2.0
+    gemfile: gemfiles/activesupport_50.gemfile
+  - rvm: 2.1
+    gemfile: gemfiles/activesupport_50.gemfile
+  - rvm: 2.0
+    gemfile: gemfiles/activesupport_51.gemfile
+  - rvm: 2.1
+    gemfile: gemfiles/activesupport_51.gemfile
+  - rvm: 2.0
+    gemfile: gemfiles/activesupport_52.gemfile
+  - rvm: 2.1
+    gemfile: gemfiles/activesupport_52.gemfile
 notifications:
   webhooks: https://www.travisbuddy.com/
   on_success: never
-# Put this in your .travis.yml
 gemfile:
-  - gemfiles/activesupport_3.gemfile
-  - gemfiles/activesupport_4.gemfile
-  - gemfiles/activesupport_50.gemfile
-  - gemfiles/activesupport_51.gemfile
-  - gemfiles/activesupport_52.gemfile
+- gemfiles/activesupport_3.gemfile
+- gemfiles/activesupport_4.gemfile
+- gemfiles/activesupport_50.gemfile
+- gemfiles/activesupport_51.gemfile
+- gemfiles/activesupport_52.gemfile
+deploy:
+  provider: rubygems
+  api_key:
+    secure: VHWLUgCtqlKjeS5uGOxS4tnEUSPiapyvBvgSpr+FUeQnjAE9jgJvz+rAmiNy/pp8fAhjH5FdyIUXuh2rE2sWcBYrOa1rCvrc7eBHdnpZ4U7ULJwQKhC/4dOE33ClaZX2pex4pv12I2218ZH5TsqdmQ0Ci0ccfNZJv0vs+IFP+kQ=
+  gem: redis-activesupport
+  on:
+    tags: true
+    repo: redis-store/redis-activesupport

data/CODEOWNERS

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

data/README.md

@@ -1,3 +1,11 @@
+# This gem is in LTS mode.
+
+Rails 5.2.0 [includes a Redis cache store out of the
+box](https://github.com/rails/rails/pull/31134), so you don't really
+need this anymore if you're generating a new Rails application. We
+are no longer accepting new features for this gem, only security
+updates will be considered for new pull requests.
+
 # Redis stores for ActiveSupport
 
 __`redis-activesupport`__ provides a cache for __ActiveSupport__. 
@@ -9,14 +17,6 @@ For information on how to use this library in a Rails app, see the [documentatio
 
 If, for some reason, you're using `ActiveSupport::Cache` and not in a Rails app, read on to learn how to install/use this gem by itself!
 
-## A quick note about Rails 5.2
-
-Rails 5.2.0 [includes a Redis cache store out of the
-box](https://github.com/rails/rails/pull/31134), so you don't really
-need this anymore if you're generating a new Rails application. We
-are no longer accepting new features for this gem, only pull requests
-for security and compatibility fixes will be accepted.
-
 ## Installation
 
 ```ruby

data/lib/active_support/cache/redis_store.rb

@@ -13,6 +13,12 @@ module ActiveSupport
         Redis::BaseConnectionError
       ].freeze
 
+      DEFAULT_ERROR_HANDLER = -> (method: nil, returning: nil, exception: nil) do
+        if logger
+          logger.error { "RedisStore: #{method} failed, returned #{returning.inspect}: #{exception.class}: #{exception.message}" }
+        end
+      end
+
       attr_reader :data
 
       # Instantiate the store.
@@ -24,25 +30,25 @@ module ActiveSupport
       #   RedisStore.new client: Redis.new(url: "redis://127.0.0.1:6380/1")
       #     # => host: localhost,   port: 6379,  db: 0
       #
-      #   RedisStore.new "example.com"
+      #   RedisStore.new "redis://example.com"
       #     # => host: example.com, port: 6379,  db: 0
       #
-      #   RedisStore.new "example.com:23682"
+      #   RedisStore.new "redis://example.com:23682"
       #     # => host: example.com, port: 23682, db: 0
       #
-      #   RedisStore.new "example.com:23682/1"
+      #   RedisStore.new "redis://example.com:23682/1"
       #     # => host: example.com, port: 23682, db: 1
       #
-      #   RedisStore.new "example.com:23682/1/theplaylist"
+      #   RedisStore.new "redis://example.com:23682/1/theplaylist"
       #     # => host: example.com, port: 23682, db: 1, namespace: theplaylist
       #
-      #   RedisStore.new "localhost:6379/0", "localhost:6380/0"
+      #   RedisStore.new "redis://localhost:6379/0", "redis://localhost:6380/0"
       #     # => instantiate a cluster
       #
-      #   RedisStore.new "localhost:6379/0", "localhost:6380/0", pool_size: 5, pool_timeout: 10
+      #   RedisStore.new "redis://localhost:6379/0", "redis://localhost:6380/0", pool_size: 5, pool_timeout: 10
       #     # => use a ConnectionPool
       #
-      #   RedisStore.new "localhost:6379/0", "localhost:6380/0",
+      #   RedisStore.new "redis://localhost:6379/0", "redis://localhost:6380/0",
       #     pool: ::ConnectionPool.new(size: 1, timeout: 1) { ::Redis::Store::Factory.create("localhost:6379/0") })
       #     # => supply an existing connection pool (e.g. for use with redis-sentinel or redis-failover)
       def initialize(*addresses)
@@ -65,16 +71,18 @@ module ActiveSupport
                   ::Redis::Store::Factory.create(*addresses, @options)
                 end
 
+        @error_handler = @options[:error_handler] || DEFAULT_ERROR_HANDLER
+
         super(@options)
       end
 
       def write(name, value, options = nil)
-        options = merged_options(options)
-        instrument(:write, name, options) do |payload|
-          entry = options[:raw].present? ? value : Entry.new(value, options)
+        options = merged_options(options.to_h.symbolize_keys)
+        instrument(:write, name, options) do |_payload|
           if options[:expires_in].present? && options[:race_condition_ttl].present? && options[:raw].blank?
             options[:expires_in] = options[:expires_in].to_f + options[:race_condition_ttl].to_f
           end
+          entry = options[:raw].present? ? value : Entry.new(value, **options)
           write_entry(normalize_key(name, options), entry, options)
         end
       end
@@ -91,14 +99,13 @@ module ActiveSupport
       def delete_matched(matcher, options = nil)
         options = merged_options(options)
         instrument(:delete_matched, matcher.inspect) do
-          matcher = key_matcher(matcher, options)
-          begin
-            with do |store|
-              !(keys = store.keys(matcher)).empty? && store.del(*keys)
+          failsafe(:read_multi, returning: false) do
+            matcher = key_matcher(matcher, options)
+            begin
+              with do |store|
+                !(keys = store.keys(matcher)).empty? && store.del(*keys)
+              end
             end
-          rescue *ERRORS_TO_RESCUE
-            raise if raise_errors?
-            false
           end
         end
       end
@@ -118,16 +125,15 @@ module ActiveSupport
         args.flatten!
 
         instrument(:read_multi, names) do |payload|
-          values = with { |c| c.mget(*args) }
-          values.map! { |v| v.is_a?(ActiveSupport::Cache::Entry) ? v.value : v }
+          failsafe(:read_multi, returning: {}) do
+            values = with { |c| c.mget(*args) }
+            values.map! { |v| v.is_a?(ActiveSupport::Cache::Entry) ? v.value : v }
 
-          Hash[names.zip(values)].reject{|k,v| v.nil?}.tap do |result|
-            payload[:hits] = result.keys if payload
+            Hash[names.zip(values)].reject{|k,v| v.nil?}.tap do |result|
+              payload[:hits] = result.keys if payload
+            end
           end
         end
-      rescue *ERRORS_TO_RESCUE
-        raise if raise_errors?
-        {}
       end
 
       def fetch_multi(*names)
@@ -147,7 +153,7 @@ module ActiveSupport
           memo
         end
 
-        begin
+        failsafe(:fetch_multi_write) do
           with do |c|
             c.multi do
               need_writes.each do |name, value|
@@ -155,8 +161,6 @@ module ActiveSupport
               end
             end
           end
-        rescue *ERRORS_TO_RESCUE
-          raise if raise_errors?
         end
 
         fetched
@@ -183,10 +187,18 @@ module ActiveSupport
       #
       #   cache.increment "rabbit"
       #   cache.read "rabbit", :raw => true       # => "1"
-      def increment(key, amount = 1, options = {})
-        options = merged_options(options)
-        instrument(:increment, key, :amount => amount) do
-          with{|c| c.incrby normalize_key(key, options), amount}
+      def increment(name, amount = 1, options = {})
+        instrument :increment, name, amount: amount do
+          failsafe :increment do
+            options = merged_options(options)
+            key = normalize_key(name, options)
+
+            with do |c|
+              c.incrby(key, amount).tap do
+                write_key_expiry(c, key, options)
+              end
+            end
+          end
         end
       end
 
@@ -211,10 +223,18 @@ module ActiveSupport
       #
       #   cache.decrement "rabbit"
       #   cache.read "rabbit", :raw => true       # => "-1"
-      def decrement(key, amount = 1, options = {})
-        options = merged_options(options)
-        instrument(:decrement, key, :amount => amount) do
-          with{|c| c.decrby normalize_key(key, options), amount}
+      def decrement(name, amount = 1, options = {})
+        instrument :decrement, name, amount: amount do
+          failsafe :decrement do
+            options = merged_options(options)
+            key = normalize_key(name, options)
+
+            with do |c|
+              c.decrby(key, amount).tap do
+                write_key_expiry(c, key, options)
+              end
+            end
+          end
         end
       end
 
@@ -226,7 +246,9 @@ module ActiveSupport
       # Clear all the data from the store.
       def clear
         instrument(:clear, nil, nil) do
-          with(&:flushdb)
+          failsafe(:clear) do
+            with(&:flushdb)
+          end
         end
       end
 
@@ -255,20 +277,24 @@ module ActiveSupport
 
       protected
         def write_entry(key, entry, options)
-          method = options && options[:unless_exist] ? :setnx : :set
-          with { |client| client.send method, key, entry, options }
-        rescue *ERRORS_TO_RESCUE
-          raise if raise_errors?
-          false
+          failsafe(:write_entry, returning: false) do
+            method = options && options[:unless_exist] ? :setnx : :set
+            with { |client| client.send method, key, entry, options }
+          end
         end
 
         def read_entry(key, options)
-          entry = with { |c| c.get key, options }
-          return unless entry
-          entry.is_a?(Entry) ? entry : Entry.new(entry)
-        rescue *ERRORS_TO_RESCUE
-          raise if raise_errors?
-          nil
+          failsafe(:read_entry) do
+            entry = with { |c| c.get key, options }
+            return unless entry
+            entry.is_a?(Entry) ? entry : Entry.new(entry)
+          end
+        end
+
+        def write_key_expiry(client, key, options)
+          if options[:expires_in] && client.ttl(key) < 0
+            client.expire key, options[:expires_in].to_i
+          end
         end
 
         ##
@@ -276,11 +302,10 @@ module ActiveSupport
         #
         # It's really needed and use
         #
-        def delete_entry(key, options)
-          with { |c| c.del key }
-        rescue *ERRORS_TO_RESCUE
-          raise if raise_errors?
-          false
+        def delete_entry(key, **options)
+          failsafe(:delete_entry, returning: false) do
+            with { |c| c.del key }
+          end
         end
 
         def raise_errors?
@@ -305,12 +330,27 @@ module ActiveSupport
         end
 
       private
-
         if ActiveSupport::VERSION::MAJOR < 5
           def normalize_key(*args)
             namespaced_key(*args)
           end
         end
+
+        def failsafe(method, returning: nil)
+          yield
+        rescue ::Redis::BaseConnectionError => e
+          raise if raise_errors?
+          handle_exception(exception: e, method: method, returning: returning)
+          returning
+        end
+
+        def handle_exception(exception: nil, method: nil, returning: nil)
+          if @error_handler
+            @error_handler.(method: method, exception: exception, returning: returning)
+          end
+        rescue => failsafe
+          warn("RedisStore ignored exception in handle_exception: #{failsafe.class}: #{failsafe.message}\n  #{failsafe.backtrace.join("\n  ")}")
+        end
     end
   end
 end

data/lib/redis/active_support/version.rb

@@ -1,5 +1,5 @@
 class Redis
   module ActiveSupport
-    VERSION = '5.0.7'
+    VERSION = '5.3.0'
   end
 end

data/redis-activesupport.gemspec

@@ -13,21 +13,20 @@ Gem::Specification.new do |s|
   s.description = %q{Redis store for ActiveSupport}
   s.license     = 'MIT'
 
-  s.rubyforge_project = 'redis-activesupport'
-
   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.add_runtime_dependency "redis-store",   '>= 1.3', '< 2'
-  s.add_runtime_dependency 'activesupport', '>= 3', '< 6'
+  s.add_runtime_dependency 'activesupport', '>= 3', '< 8'
 
-  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', '>= 4.2', '< 6'
-  s.add_development_dependency 'connection_pool', '~> 2.2.0'
+  s.add_development_dependency 'connection_pool', '= 2.2.2'
   s.add_development_dependency 'redis-store-testing'
   s.add_development_dependency 'appraisal', '~> 2.0'
+  s.add_development_dependency 'pry-byebug', '~> 3'
 end

data/test/active_support/cache/redis_store_test.rb

@@ -335,6 +335,24 @@ describe ActiveSupport::Cache::RedisStore do
     end
   end
 
+  it "increments a key with expiration time" do
+    with_store_management do |store|
+      store.increment "counter", 1, :expires_in => 1.second
+      store.read("counter", :raw => true).to_i.must_equal(1)
+      sleep 2
+      store.read("counter", :raw => true).must_be_nil
+    end
+  end
+
+  it "decrements a key with expiration time" do
+    with_store_management do |store|
+      store.decrement "counter", 1, :expires_in => 1.second
+      store.read("counter", :raw => true).to_i.must_equal(-1)
+      sleep 2
+      store.read("counter", :raw => true).must_be_nil
+    end
+  end
+
   it "clears the store" do
     with_store_management do |store|
       store.clear
@@ -377,7 +395,7 @@ describe ActiveSupport::Cache::RedisStore do
 
   describe "race_condition_ttl on fetch" do
     it "persist entry for longer than given ttl" do
-      options = { force: true, expires_in: 1.second, race_condition_ttl: 2.seconds }
+      options = { force: true, expires_in: 1.second, race_condition_ttl: 2.seconds, version: Time.now.to_i }
       @store.fetch("rabbit", options) { @rabbit }
       sleep 1.1
       @store.delete("rabbit").must_equal(1)
@@ -385,12 +403,12 @@ describe ActiveSupport::Cache::RedisStore do
 
     it "limits stampede time to read-write duration" do
       first_rabbit = second_rabbit = nil
-      options = { force: true, expires_in: 1.second, race_condition_ttl: 2.seconds }
+      options = { force: true, expires_in: 1.second, race_condition_ttl: 2.seconds, version: Time.now.to_i }
       @store.fetch("rabbit", options) { @rabbit }
       sleep 1
 
       th1 = Thread.new do
-        first_rabbit = @store.fetch("rabbit", race_condition_ttl: 2) do
+        first_rabbit = @store.fetch("rabbit", options) do
           sleep 1
           @white_rabbit
         end

data/test/test_helper.rb

@@ -4,4 +4,4 @@ require 'mocha/setup'
 require 'active_support'
 require 'active_support/cache/redis_store'
 
-puts "Testing against ActiveSupport v.#{ActiveSupport::VERSION::STRING}"
+puts "Testing against ActiveSupport v#{ActiveSupport::VERSION::STRING}"

metadata

@@ -1,15 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: redis-activesupport
 version: !ruby/object:Gem::Version
-  version: 5.0.7
+  version: 5.3.0
 platform: ruby
 authors:
 - Luca Guidi
 - Ryan Bigg
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2018-07-13 00:00:00.000000000 Z
+date: 2022-01-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redis-store
@@ -40,7 +40,7 @@ dependencies:
         version: '3'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '6'
+        version: '8'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -50,35 +50,35 @@ dependencies:
         version: '3'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '6'
+        version: '8'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10'
+        version: 12.3.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10'
+        version: 12.3.3
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: mocha
   requirement: !ruby/object:Gem::Requirement
@@ -117,16 +117,16 @@ dependencies:
   name: connection_pool
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: 2.2.0
+        version: 2.2.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: 2.2.0
+        version: 2.2.2
 - !ruby/object:Gem::Dependency
   name: redis-store-testing
   requirement: !ruby/object:Gem::Requirement
@@ -155,6 +155,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
 description: Redis store for ActiveSupport
 email:
 - me@lucaguidi.com
@@ -163,9 +177,11 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/auto-assign-issues.yml"
 - ".gitignore"
 - ".travis.yml"
 - Appraisals
+- CODEOWNERS
 - Gemfile
 - MIT-LICENSE
 - README.md
@@ -185,7 +201,7 @@ homepage: http://redis-store.org/redis-activesupport
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -200,9 +216,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: redis-activesupport
-rubygems_version: 2.6.14
-signing_key: 
+rubygems_version: 3.2.11
+signing_key:
 specification_version: 4
 summary: Redis store for ActiveSupport
 test_files: