redis_set_store 0.1.0

data/gemfiles/rails_5_0.gemfile

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

data/gemfiles/rails_5_0.gemfile.lock

@@ -0,0 +1,185 @@
+PATH
+  remote: ..
+  specs:
+    redis_set_store (0.1.0)
+      activesupport (>= 4.2)
+      railties (>= 4.2)
+      redis (~> 3.0)
+      redis-rails (~> 5.0)
+      redis-store (~> 1.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actioncable (5.0.5)
+      actionpack (= 5.0.5)
+      nio4r (>= 1.2, < 3.0)
+      websocket-driver (~> 0.6.1)
+    actionmailer (5.0.5)
+      actionpack (= 5.0.5)
+      actionview (= 5.0.5)
+      activejob (= 5.0.5)
+      mail (~> 2.5, >= 2.5.4)
+      rails-dom-testing (~> 2.0)
+    actionpack (5.0.5)
+      actionview (= 5.0.5)
+      activesupport (= 5.0.5)
+      rack (~> 2.0)
+      rack-test (~> 0.6.3)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.0.2)
+    actionview (5.0.5)
+      activesupport (= 5.0.5)
+      builder (~> 3.1)
+      erubis (~> 2.7.0)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.0.3)
+    activejob (5.0.5)
+      activesupport (= 5.0.5)
+      globalid (>= 0.3.6)
+    activemodel (5.0.5)
+      activesupport (= 5.0.5)
+    activerecord (5.0.5)
+      activemodel (= 5.0.5)
+      activesupport (= 5.0.5)
+      arel (~> 7.0)
+    activesupport (5.0.5)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (~> 0.7)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+    appraisal (2.2.0)
+      bundler
+      rake
+      thor (>= 0.14.0)
+    arel (7.1.4)
+    ast (2.3.0)
+    builder (3.2.3)
+    bundler-audit (0.6.0)
+      bundler (~> 1.2)
+      thor (~> 0.18)
+    concurrent-ruby (1.0.5)
+    diff-lcs (1.3)
+    erubis (2.7.0)
+    globalid (0.4.0)
+      activesupport (>= 4.2.0)
+    i18n (0.8.6)
+    loofah (2.0.3)
+      nokogiri (>= 1.5.9)
+    mail (2.6.6)
+      mime-types (>= 1.16, < 4)
+    metaclass (0.0.4)
+    method_source (0.8.2)
+    mime-types (3.1)
+      mime-types-data (~> 3.2015)
+    mime-types-data (3.2016.0521)
+    mini_portile2 (2.2.0)
+    minitest (5.10.3)
+    mocha (1.2.1)
+      metaclass (~> 0.0.1)
+    nio4r (2.1.0)
+    nokogiri (1.8.0)
+      mini_portile2 (~> 2.2.0)
+    parallel (1.12.0)
+    parser (2.4.0.0)
+      ast (~> 2.2)
+    powerpack (0.1.1)
+    rack (2.0.3)
+    rack-test (0.6.3)
+      rack (>= 1.0)
+    rails (5.0.5)
+      actioncable (= 5.0.5)
+      actionmailer (= 5.0.5)
+      actionpack (= 5.0.5)
+      actionview (= 5.0.5)
+      activejob (= 5.0.5)
+      activemodel (= 5.0.5)
+      activerecord (= 5.0.5)
+      activesupport (= 5.0.5)
+      bundler (>= 1.3.0)
+      railties (= 5.0.5)
+      sprockets-rails (>= 2.0.0)
+    rails-dom-testing (2.0.3)
+      activesupport (>= 4.2.0)
+      nokogiri (>= 1.6)
+    rails-html-sanitizer (1.0.3)
+      loofah (~> 2.0)
+    railties (5.0.5)
+      actionpack (= 5.0.5)
+      activesupport (= 5.0.5)
+      method_source
+      rake (>= 0.8.7)
+      thor (>= 0.18.1, < 2.0)
+    rainbow (2.2.2)
+      rake
+    rake (10.5.0)
+    redis (3.3.3)
+    redis-actionpack (5.0.1)
+      actionpack (>= 4.0, < 6)
+      redis-rack (>= 1, < 3)
+      redis-store (>= 1.1.0, < 1.4.0)
+    redis-activesupport (5.0.3)
+      activesupport (>= 3, < 6)
+      redis-store (~> 1.3.0)
+    redis-rack (2.0.2)
+      rack (>= 1.5, < 3)
+      redis-store (>= 1.2, < 1.4)
+    redis-rails (5.0.2)
+      redis-actionpack (>= 5.0, < 6)
+      redis-activesupport (>= 5.0, < 6)
+      redis-store (>= 1.2, < 2)
+    redis-store (1.3.0)
+      redis (>= 2.2)
+    rspec (3.5.0)
+      rspec-core (~> 3.5.0)
+      rspec-expectations (~> 3.5.0)
+      rspec-mocks (~> 3.5.0)
+    rspec-core (3.5.4)
+      rspec-support (~> 3.5.0)
+    rspec-expectations (3.5.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.5.0)
+    rspec-mocks (3.5.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.5.0)
+    rspec-support (3.5.0)
+    rubocop (0.49.1)
+      parallel (~> 1.10)
+      parser (>= 2.3.3.1, < 3.0)
+      powerpack (~> 0.1)
+      rainbow (>= 1.99.1, < 3.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (~> 1.0, >= 1.0.1)
+    ruby-progressbar (1.8.1)
+    sprockets (3.7.1)
+      concurrent-ruby (~> 1.0)
+      rack (> 1, < 3)
+    sprockets-rails (3.2.0)
+      actionpack (>= 4.0)
+      activesupport (>= 4.0)
+      sprockets (>= 3.0.0)
+    thor (0.19.4)
+    thread_safe (0.3.6)
+    tzinfo (1.2.3)
+      thread_safe (~> 0.1)
+    unicode-display_width (1.3.0)
+    websocket-driver (0.6.5)
+      websocket-extensions (>= 0.1.0)
+    websocket-extensions (0.1.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  appraisal (~> 2.0)
+  bundler (~> 1.15)
+  bundler-audit (~> 0)
+  mocha (~> 1)
+  rails (= 5.0.5)
+  rake (~> 10.0)
+  redis_set_store!
+  rspec (~> 3.0)
+  rubocop (~> 0)
+
+BUNDLED WITH
+   1.15.3

data/gemfiles/rails_5_1.gemfile

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

data/gemfiles/rails_5_1.gemfile.lock

@@ -0,0 +1,185 @@
+PATH
+  remote: ..
+  specs:
+    redis_set_store (0.1.0)
+      activesupport (>= 4.2)
+      railties (>= 4.2)
+      redis (~> 3.0)
+      redis-rails (~> 5.0)
+      redis-store (~> 1.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actioncable (5.1.3)
+      actionpack (= 5.1.3)
+      nio4r (~> 2.0)
+      websocket-driver (~> 0.6.1)
+    actionmailer (5.1.3)
+      actionpack (= 5.1.3)
+      actionview (= 5.1.3)
+      activejob (= 5.1.3)
+      mail (~> 2.5, >= 2.5.4)
+      rails-dom-testing (~> 2.0)
+    actionpack (5.1.3)
+      actionview (= 5.1.3)
+      activesupport (= 5.1.3)
+      rack (~> 2.0)
+      rack-test (~> 0.6.3)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.0.2)
+    actionview (5.1.3)
+      activesupport (= 5.1.3)
+      builder (~> 3.1)
+      erubi (~> 1.4)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.0.3)
+    activejob (5.1.3)
+      activesupport (= 5.1.3)
+      globalid (>= 0.3.6)
+    activemodel (5.1.3)
+      activesupport (= 5.1.3)
+    activerecord (5.1.3)
+      activemodel (= 5.1.3)
+      activesupport (= 5.1.3)
+      arel (~> 8.0)
+    activesupport (5.1.3)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (~> 0.7)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+    appraisal (2.2.0)
+      bundler
+      rake
+      thor (>= 0.14.0)
+    arel (8.0.0)
+    ast (2.3.0)
+    builder (3.2.3)
+    bundler-audit (0.6.0)
+      bundler (~> 1.2)
+      thor (~> 0.18)
+    concurrent-ruby (1.0.5)
+    diff-lcs (1.3)
+    erubi (1.6.1)
+    globalid (0.4.0)
+      activesupport (>= 4.2.0)
+    i18n (0.8.6)
+    loofah (2.0.3)
+      nokogiri (>= 1.5.9)
+    mail (2.6.6)
+      mime-types (>= 1.16, < 4)
+    metaclass (0.0.4)
+    method_source (0.8.2)
+    mime-types (3.1)
+      mime-types-data (~> 3.2015)
+    mime-types-data (3.2016.0521)
+    mini_portile2 (2.2.0)
+    minitest (5.10.3)
+    mocha (1.2.1)
+      metaclass (~> 0.0.1)
+    nio4r (2.1.0)
+    nokogiri (1.8.0)
+      mini_portile2 (~> 2.2.0)
+    parallel (1.12.0)
+    parser (2.4.0.0)
+      ast (~> 2.2)
+    powerpack (0.1.1)
+    rack (2.0.3)
+    rack-test (0.6.3)
+      rack (>= 1.0)
+    rails (5.1.3)
+      actioncable (= 5.1.3)
+      actionmailer (= 5.1.3)
+      actionpack (= 5.1.3)
+      actionview (= 5.1.3)
+      activejob (= 5.1.3)
+      activemodel (= 5.1.3)
+      activerecord (= 5.1.3)
+      activesupport (= 5.1.3)
+      bundler (>= 1.3.0)
+      railties (= 5.1.3)
+      sprockets-rails (>= 2.0.0)
+    rails-dom-testing (2.0.3)
+      activesupport (>= 4.2.0)
+      nokogiri (>= 1.6)
+    rails-html-sanitizer (1.0.3)
+      loofah (~> 2.0)
+    railties (5.1.3)
+      actionpack (= 5.1.3)
+      activesupport (= 5.1.3)
+      method_source
+      rake (>= 0.8.7)
+      thor (>= 0.18.1, < 2.0)
+    rainbow (2.2.2)
+      rake
+    rake (10.5.0)
+    redis (3.3.3)
+    redis-actionpack (5.0.1)
+      actionpack (>= 4.0, < 6)
+      redis-rack (>= 1, < 3)
+      redis-store (>= 1.1.0, < 1.4.0)
+    redis-activesupport (5.0.3)
+      activesupport (>= 3, < 6)
+      redis-store (~> 1.3.0)
+    redis-rack (2.0.2)
+      rack (>= 1.5, < 3)
+      redis-store (>= 1.2, < 1.4)
+    redis-rails (5.0.2)
+      redis-actionpack (>= 5.0, < 6)
+      redis-activesupport (>= 5.0, < 6)
+      redis-store (>= 1.2, < 2)
+    redis-store (1.3.0)
+      redis (>= 2.2)
+    rspec (3.6.0)
+      rspec-core (~> 3.6.0)
+      rspec-expectations (~> 3.6.0)
+      rspec-mocks (~> 3.6.0)
+    rspec-core (3.6.0)
+      rspec-support (~> 3.6.0)
+    rspec-expectations (3.6.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.6.0)
+    rspec-mocks (3.6.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.6.0)
+    rspec-support (3.6.0)
+    rubocop (0.49.1)
+      parallel (~> 1.10)
+      parser (>= 2.3.3.1, < 3.0)
+      powerpack (~> 0.1)
+      rainbow (>= 1.99.1, < 3.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (~> 1.0, >= 1.0.1)
+    ruby-progressbar (1.8.1)
+    sprockets (3.7.1)
+      concurrent-ruby (~> 1.0)
+      rack (> 1, < 3)
+    sprockets-rails (3.2.0)
+      actionpack (>= 4.0)
+      activesupport (>= 4.0)
+      sprockets (>= 3.0.0)
+    thor (0.19.4)
+    thread_safe (0.3.6)
+    tzinfo (1.2.3)
+      thread_safe (~> 0.1)
+    unicode-display_width (1.3.0)
+    websocket-driver (0.6.5)
+      websocket-extensions (>= 0.1.0)
+    websocket-extensions (0.1.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  appraisal (~> 2.0)
+  bundler (~> 1.15)
+  bundler-audit (~> 0)
+  mocha (~> 1)
+  rails (= 5.1.3)
+  rake (~> 10.0)
+  redis_set_store!
+  rspec (~> 3.0)
+  rubocop (~> 0)
+
+BUNDLED WITH
+   1.15.3

data/lib/active_support/cache/redis_set_store.rb

@@ -0,0 +1,169 @@
+# frozen_string_literal: true
+
+module ActiveSupport
+  module Cache
+    # A Rails cache implementation that is backed by redis and uses sets to
+    # track keys for rapid expiration of large numbers of keys.
+    #
+    # Generally you would set this up in your Rails environment files:
+    #
+    #   # production.rb
+    #   Rails.application.configure do
+    #     config.cache_store = :redis_set_store, /\Auser:\d+/
+    #   end
+    class RedisSetStore < RedisStore
+      # Instantiate the store.
+      #
+      # set_owner_regexp: A regular expression that identifies keys within a given
+      #                   Set Owner's Redis set.
+      #
+      #                   For example, assume a Site model owns cache sets.
+      #                   These are defined with the cache key prefix
+      #                   "site:#{site.id}". So the appropriate argument would
+      #                   be: `/\Asite:\d+/`
+      #
+      #                   If not provided (or `nil` is provided), the default
+      #                   pattern is `/\A[^:]+:\d+/`. That is, it matches
+      #                   any pattern like "type:1", assuming
+      #
+      # redis_options: Standard redis_options for a ActiveSupport::Cache::RedisStore
+      #
+      # Example:
+      #   RedisSetStore.new
+      #     # => pattern: /\A[^:]+:\d+/, host: localhost,   port: 6379,  db: 0
+      #
+      #   RedisSetStore.new(/\Asite:\d+/)
+      #     # => pattern: /\Asite:\d+/,  host: localhost,   port: 6379,  db: 0
+      #
+      #   RedisSetStore.new(/\Asite:\d+/, "example.com")
+      #     # => pattern: /\Asite:\d+/,  host: example.com, port: 6379,  db: 0
+      #
+      #   RedisSetStore.new(/\Asite:\d+/, "example.com:23682")
+      #     # => pattern: /\Asite:\d+/,  host: example.com, port: 23682, db: 0
+      #
+      #   RedisSetStore.new(/\Asite:\d+/, "example.com:23682/1")
+      #     # => pattern: /\Asite:\d+/,  host: example.com, port: 23682, db: 1
+      #
+      # See more examples at ActiveSupport::Cache::RedisStore
+      def initialize(set_owner_regexp = nil, redis_options = {})
+        if set_owner_regexp.is_a?(Regexp)
+          @set_owner_regexp = set_owner_regexp
+        else
+          redis_options    = set_owner_regexp
+          set_owner_regexp = nil
+        end
+        @set_owner_regexp = set_owner_regexp || /\A[^:]+:\d+/
+
+        super(redis_options)
+      end
+
+      # Delete objects for matched keys.
+      #
+      # Example:
+      #   cache.delete_matched("user:1:rab*")
+      #
+      # Returns number of keys that were deleted or `nil` if a connection error occurs.
+      def delete_matched(matcher, _options = nil)
+        SetOwner.new(@set_owner_regexp, matcher, @data).delete_matched
+      rescue Errno::ECONNREFUSED
+        nil
+      end
+
+      # Find matched keys.
+      #
+      # Example:
+      #   cache.matched("user:1:rab*")
+      #
+      # Returns an array of matching keys or `nil` if a connection error occurs.
+      def matched(key)
+        SetOwner.new(@set_owner_regexp, key, @data).matched
+      rescue Errno::ECONNREFUSED
+        []
+      end
+
+      # Ping the server.
+      #
+      # Returns "PONG" on success.
+      def ping
+        SetOwner::STORE&.ping if defined?(SetOwner::STORE)
+        redis.ping
+      end
+
+      # Instance of redis where the cache data is stored.
+      #
+      # Returns a Redis instance.
+      def redis
+        @data
+      end
+
+      protected
+
+      def write_entry(key, entry, options)
+        if key.include?("*")
+          raise ArgumentError.new("Unsupported Redis key character for ActiveSupport::Cache::RedisSetStore: *")
+        end
+
+        SetOwner.new(@set_owner_regexp, key, @data).sadd
+
+        super
+      rescue Errno::ECONNREFUSED
+        false
+      end
+
+      def delete_entry(key, options)
+        SetOwner.new(@set_owner_regexp, key, @data).srem
+
+        super
+      rescue Errno::ECONNREFUSED
+        false
+      end
+
+      # Redis set wrapper for a given partition.
+      class SetOwner
+        def initialize(set_owner_regexp, key, redis)
+          @key = key
+          @set = nil
+          match = set_owner_regexp.match(key)
+          @set = match[0] if match
+          @redis = redis
+          @redis_set_store = STORE if defined?(STORE)
+          @redis_set_store ||= @redis
+        end
+
+        def sadd
+          return unless @set && @key
+          @redis_set_store.sadd(@set, @key)
+        end
+
+        def srem
+          return unless @set && @key
+          @redis_set_store.srem(@set, @key)
+        end
+
+        def delete_matched
+          return unless @set && @key
+
+          srem_list = matched
+          return if srem_list.blank?
+
+          @redis_set_store.srem(@set, srem_list)
+          @redis.del(srem_list)
+        end
+
+        def matched
+          return unless @set && @key
+          matcher_regexp = Regexp.compile(convert_wildcards_to_regex)
+          @redis_set_store.smembers(@set).select { |smember| matcher_regexp.match(smember) }
+        end
+
+        # Redis wildcard character "*" is converted to the Regexp ".*".
+        # All other special characters are normally-escaped.
+        def convert_wildcards_to_regex
+          key = Regexp.escape(@key.to_s)
+          key = key.to_s.gsub("\\*", ".*")
+          key << "$"
+        end
+      end
+    end
+  end
+end