redis_set_store 0.1.0

data/lib/redis_set_store.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+require "active_support"
+require "redis"
+require "redis-activesupport"
+
+require "redis_set_store/version"
+require "active_support/cache/redis_set_store"
+require "redis_set_store/railtie" if defined? Rails
+
+# A Rails cache implementation that is backed by redis and uses sets to track
+# keys for rapid expiration of large numbers of keys.
+module RedisSetStore
+  mattr_accessor :logger, :cache
+end
+
+unless defined? Rails
+  RedisSetStore.logger = ActiveSupport::TaggedLogging.new(Logger.new(STDOUT))
+  RedisSetStore.cache  = ActiveSupport::Cache::RedisSetStore.new(/\A[^:]+:\d+/)
+end

data/lib/redis_set_store/bootstrap.rb

@@ -0,0 +1,76 @@
+# frozen_string_literal: true
+
+module RedisSetStore
+  # Bootstrap data into your cache to start using the RedisSetStore.
+  #
+  # RedisSetStore depends on looking up cache keys in redis sets to limit the
+  # search scope when matching keys or deleting matched keys. If you have an
+  # existing cache, then those set entries won't exist for the existing cache
+  # entries and the RedisSetStore#matched and RedisSetStore#delete_matched
+  # methods won't find any keys.
+  #
+  # To address that you can bootstrap your existing cache using this utility.
+  #
+  #   require "redis_set_store/bootstrap"
+  #   bootstrap = RedisSetStore::Bootstrap.new
+  #   bootstrap.bootstrap_set("user:1")
+  #   bootstrap.bootstrap_set("user:2")
+  #
+  # Running this will use the redis KEYS method which is very slow (the reason
+  # for this gem), so ideally set up a copy or slave of your cache redis
+  # instance to use as a read source so you don't affect your running cache.
+  # You can the configure the source for migration.
+  #
+  #   require "redis_set_store/bootstrap"
+  #   slave     = Redis.new(host: "10.0.1.1")
+  #   bootstrap = RedisSetStore::Bootstrap.new(source: slave)
+  #   bootstrap.bootstrap_set("user:1")
+  #   bootstrap.bootstrap_set("user:2")
+  class Bootstrap
+    # Creates a new Bootstrap utility.
+    #
+    # source:      The source Redis instance. If not provided uses
+    #              the destination redis or RedisSetStore.cache.redis, which
+    #              under Rails is the configure Rails.cache store.
+    #
+    # destination: The destination Redis instance. If not provided uses
+    #              RedisSetStore.cache.redis as a default, which under Rails
+    #              is the configure Rails.cache store.
+    def initialize(source: nil, destination: nil)
+      @source      = source || destination || RedisSetStore.cache.redis
+      @destination = destination || RedisSetStore.cache.redis
+    end
+
+    # Bootstrap a redis set for the matching keys in the cache.
+    #
+    # prefix: The prefix to match for keys and to use as the set key.
+    #
+    # Reads all keys from the `source` redis instance that match the prefix
+    # (followed by ":") and records them in the set used by RedisSetStore.
+    # The prefix is expected to the be the same as the `set_owner_regexp`
+    # parameters for ActiveSupport::Cache::RedisSetStore.
+    #
+    # Note that because this uses the KEYS method in Redis it scans _every key_
+    # in the database each time it is called which can be slow and will lock
+    # your database. You should configure a separate redis instance to read
+    # from as described in RedisSetStore::Bootstrap or run this with the
+    # cache offline.
+    def bootstrap_set(prefix)
+      keys = @source.keys "#{prefix}:*"
+      return if keys.empty?
+      set_manager.sadd(prefix, keys)
+    end
+
+    private
+
+    def set_manager
+      return @set_manager if @set_manager
+
+      if defined?(ActiveSupport::Cache::RedisSetStore::SetOwner::STORE)
+        return @set_manager = ActiveSupport::Cache::RedisSetStore::SetOwner::STORE
+      end
+
+      @set_manager = @destination
+    end
+  end
+end

data/lib/redis_set_store/railtie.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module RedisSetStore
+  class Railtie < Rails::Railtie
+    initializer "Blueprint::Cache logger" do
+      RedisSetStore.logger = Rails.logger
+    end
+
+    initializer "Blueprint::Cache cache" do
+      RedisSetStore.cache = Rails.cache
+    end
+  end
+end

data/lib/redis_set_store/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module RedisSetStore
+  VERSION = "0.1.0"
+end

data/redis_set_store.gemspec

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "redis_set_store/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "redis_set_store"
+  spec.version       = RedisSetStore::VERSION
+  spec.authors       = ["Jeremy Wadsack"]
+  spec.email         = ["jeremy.wadsack@gmail.com"]
+  spec.summary       = "A Rails cache implementation, backed by redis, for rapid expiration of lots of keys"
+  spec.description   = "A Rails cache implementation that is backed by redis and uses sets to track keys for rapid "\
+                        "expiration of large numbers of keys"
+  spec.homepage      = "https://github.com/keylimetoolbox/redis_set_store"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "bin"
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.15"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "mocha", "~> 1"
+  spec.add_development_dependency "appraisal", "~> 2.0"
+  spec.add_development_dependency "rubocop", "~> 0"
+  spec.add_development_dependency "bundler-audit", "~> 0"
+
+  spec.add_dependency "activesupport", ">= 4.2"
+  spec.add_dependency "railties", ">= 4.2"
+  spec.add_dependency "redis-rails", "~> 5.0"
+  spec.add_dependency "redis", "~> 3.0"
+  spec.add_dependency "redis-store", "~> 1.1"
+end

metadata

@@ -0,0 +1,240 @@
+--- !ruby/object:Gem::Specification
+name: redis_set_store
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Jeremy Wadsack
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-08-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: mocha
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+- !ruby/object:Gem::Dependency
+  name: appraisal
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler-audit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.2'
+- !ruby/object:Gem::Dependency
+  name: railties
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.2'
+- !ruby/object:Gem::Dependency
+  name: redis-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: redis
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: redis-store
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+description: A Rails cache implementation that is backed by redis and uses sets to
+  track keys for rapid expiration of large numbers of keys
+email:
+- jeremy.wadsack@gmail.com
+executables:
+- console
+- setup
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".ruby-gemset"
+- ".ruby-version"
+- Appraisals
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- gemfiles/rails_4_2.gemfile
+- gemfiles/rails_4_2.gemfile.lock
+- gemfiles/rails_5_0.gemfile
+- gemfiles/rails_5_0.gemfile.lock
+- gemfiles/rails_5_1.gemfile
+- gemfiles/rails_5_1.gemfile.lock
+- lib/active_support/cache/redis_set_store.rb
+- lib/redis_set_store.rb
+- lib/redis_set_store/bootstrap.rb
+- lib/redis_set_store/railtie.rb
+- lib/redis_set_store/version.rb
+- redis_set_store.gemspec
+homepage: https://github.com/keylimetoolbox/redis_set_store
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.11
+signing_key: 
+specification_version: 4
+summary: A Rails cache implementation, backed by redis, for rapid expiration of lots
+  of keys
+test_files: []