redis_set_store 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 6ac6e8cf904c707147866668a3a1d37d972e626e
+  data.tar.gz: 5e1d14b39c935d4dabc255fe3529f29b6bae2428
+SHA512:
+  metadata.gz: 79db8b27bc1d7cc47275b411a9e4f5c73e93f5954d53bf6e2bf059ae1109aac0710d7e448f573a7320d9e5468bd9848589c95ebc24ad09a1ff4430b72d08cc80
+  data.tar.gz: 54d6ee3eb1528c1e50c300224e54f5cf13c4e359083c889cde83100b747bfa742e6fae273c57e8778e5bd8c723da4bbcf2eb29a4337ed80489fbfd76e3b5a9ce

data/.gitignore

@@ -0,0 +1,29 @@
+*.gem
+*.rbc
+.bundle
+.config
+coverage
+InstalledFiles
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+.rspec_status
+
+# YARD artifacts
+.yardoc
+_yardoc
+doc/
+
+# Bundler artifacts
+/Gemfile.lock
+/coverage/
+/doc/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/.rubocop.yml

@@ -0,0 +1,25 @@
+Documentation:
+  Exclude:
+    - "**/railtie.rb"
+    - "spec/**/*"
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+Metrics/LineLength:
+  Max: 120
+Layout/AlignHash:
+  EnforcedHashRocketStyle: table
+  EnforcedColonStyle: table
+Layout/SpaceInsideHashLiteralBraces:
+  EnforcedStyle: no_space
+Style/RaiseArgs:
+  EnforcedStyle: compact
+
+Metrics/BlockLength:
+  Exclude:
+    - "redis_set_store.gemspec"
+    - "spec/**/*"
+
+Layout/EmptyLinesAroundBlockBody:
+  Exclude:
+    - "spec/**/*"

data/.ruby-gemset

@@ -0,0 +1 @@
+redis_set_store

data/.ruby-version

@@ -0,0 +1 @@
+2.4.1

data/Appraisals

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+appraise "rails-4-2" do
+  gem "rails", "4.2.9"
+end
+
+appraise "rails-5-0" do
+  gem "rails", "5.0.5"
+end
+
+appraise "rails-5-1" do
+  gem "rails", "5.1.3"
+end

data/Gemfile

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in redis_set_store.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,20 @@
+The MIT License (MIT)
+
+Copyright (c) 2014 Nine By Blue
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
+the Software, and to permit persons to whom the Software is furnished to do so,
+subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,157 @@
+# RedisSetStore
+
+A Rails cache implementation that is backed by redis and uses sets to track
+keys for rapid expiration of large numbers of keys.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'redis_set_store'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install redis_set_store
+
+## Usage
+
+You can use the `RedisSetStore` as you would any other Rails cache store by
+configuring it in your environment files:
+
+```ruby
+# config/application.rb
+config.cache_store = :redis_set_store
+```
+
+`RedisSetStore` allows you to regularly remove large numbers of keys with
+wildcard patterns, using `#delete_matched`.
+
+```ruby
+def cache_key_prefix
+  "#{self.class.to_s.tableize.singularize}:#{id}:"
+end
+
+def expire_cache
+  Rails.cache.delete_matched("#{cache_key_prefix}*")
+end
+```
+
+### How it works
+
+Under the original [`RedisStore`](https://github.com/redis-store/redis-store)
+`#delete_matched` calls the Redis `KEYS` method which scans _every_ key in your
+database. If you have millions of cache keys this can take a long time and make
+your server unresponsive.
+
+`RedisSetStore` resolves this by maintaining a `set` of keys and checking the
+members of that set when matching. Additionally, it partitions sets based on
+a pattern. The default pattern is `\A[^:]\d+`, so if you have keys named as
+follows, there would be a set for each object (e.g. `user:1`, `user:2`,
+`report:1`, etc.):
+
+```
+user:1:profile
+user:1:reports
+user:2:profile
+user:2:reports
+report:1:metadata
+report:2:metadata
+```
+
+Partitioning the sets allows for much faster look up of matched keys because
+the cache doesn't have to retrieve all the keys in your database and try to
+match every one.
+
+Depending on your cache names, you may want to use a different pattern. You
+can configure this with the first parameter to the `cache_store` configuration
+value as shown above (e.g. `/\Auser:\d+/`). Note that the pattern does not have
+to be a prefix. It could match any part of the key.
+
+### Configuration
+
+In your `config/application.rb`, (or files in `config/environments`), you can
+pass a regular expression to partition your keys for sets and parameters for
+the redis instance to connect to. If you don't want to change the default
+partitioning pattern, the redis options can be the first parameter:
+
+```ruby
+config.cache_store = :redis_set_store
+# or
+config.cache_store = :redis_set_store, "redis://localhost:6379/0"
+# or
+config.cache_store = :redis_set_store, {
+                                         host: "localhost",
+                                         port: 6379,
+                                         db: 0,
+                                         password: "mysecret",
+                                         namespace: "cache"
+                                       }
+```
+
+If you are setting the regular expression for partitioning, then you must pass
+that as the first parameter, and redis configuration follows.
+
+```ruby
+config.cache_store = :redis_set_store, /\Auser:\d+/
+# or
+config.cache_store = :redis_set_store, /\Auser:\d+/, "redis://localhost:6379/0"
+# or
+config.cache_store = :redis_set_store, /\Auser:\d+/, {
+                                                       host: "localhost",
+                                                       port: 6379,
+                                                       db: 0,
+                                                       password: "mysecret",
+                                                       namespace: "cache"
+                                                     }
+```
+
+See the [`redis-rails`](https://github.com/redis-store/redis-rails) gem for
+more details on how to configure the redis connection.
+
+### Migrating an Existing Cache
+
+As `RedisSetStore` looks up cache keys in redis sets, 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 this we provide the `RedisSetStore::Bootstrap` utility. See the
+documentation for that class for details.
+
+## Contributing
+
+1. Fork it ( https://github.com/keylimetoolbox/redis_set_store/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request
+
+
+### Redis Installation
+
+#### Option 1: Homebrew
+
+MacOS X users should use [Homebrew](https://github.com/mxcl/homebrew) to
+install Redis:
+
+```shell
+brew install redis
+```
+
+#### Option 2: From Source
+
+Download and install Redis from [the download page](http://redis.io//download)
+and follow the instructions.
+
+### Running tests
+
+```shell
+bin/setup
+bundle exec rake
+```

data/Rakefile

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "redis_set_store"
+require "rspec/core/rake_task"
+require "rubocop/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+RuboCop::RakeTask.new
+require "bundler/audit/task"
+Bundler::Audit::Task.new
+
+# Remove default and replace with a series of test tasks
+task default: []
+Rake::Task[:default].clear
+
+task default: %w[spec rubocop bundle:audit]

data/bin/console

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "redis_set_store"
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,6 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install

data/gemfiles/rails_4_2.gemfile

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

data/gemfiles/rails_4_2.gemfile.lock

@@ -0,0 +1,178 @@
+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:
+    actionmailer (4.2.9)
+      actionpack (= 4.2.9)
+      actionview (= 4.2.9)
+      activejob (= 4.2.9)
+      mail (~> 2.5, >= 2.5.4)
+      rails-dom-testing (~> 1.0, >= 1.0.5)
+    actionpack (4.2.9)
+      actionview (= 4.2.9)
+      activesupport (= 4.2.9)
+      rack (~> 1.6)
+      rack-test (~> 0.6.2)
+      rails-dom-testing (~> 1.0, >= 1.0.5)
+      rails-html-sanitizer (~> 1.0, >= 1.0.2)
+    actionview (4.2.9)
+      activesupport (= 4.2.9)
+      builder (~> 3.1)
+      erubis (~> 2.7.0)
+      rails-dom-testing (~> 1.0, >= 1.0.5)
+      rails-html-sanitizer (~> 1.0, >= 1.0.3)
+    activejob (4.2.9)
+      activesupport (= 4.2.9)
+      globalid (>= 0.3.0)
+    activemodel (4.2.9)
+      activesupport (= 4.2.9)
+      builder (~> 3.1)
+    activerecord (4.2.9)
+      activemodel (= 4.2.9)
+      activesupport (= 4.2.9)
+      arel (~> 6.0)
+    activesupport (4.2.9)
+      i18n (~> 0.7)
+      minitest (~> 5.1)
+      thread_safe (~> 0.3, >= 0.3.4)
+      tzinfo (~> 1.1)
+    appraisal (2.2.0)
+      bundler
+      rake
+      thor (>= 0.14.0)
+    arel (6.0.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)
+    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)
+    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 (1.6.8)
+    rack-test (0.6.3)
+      rack (>= 1.0)
+    rails (4.2.9)
+      actionmailer (= 4.2.9)
+      actionpack (= 4.2.9)
+      actionview (= 4.2.9)
+      activejob (= 4.2.9)
+      activemodel (= 4.2.9)
+      activerecord (= 4.2.9)
+      activesupport (= 4.2.9)
+      bundler (>= 1.3.0, < 2.0)
+      railties (= 4.2.9)
+      sprockets-rails
+    rails-deprecated_sanitizer (1.0.3)
+      activesupport (>= 4.2.0.alpha)
+    rails-dom-testing (1.0.8)
+      activesupport (>= 4.2.0.beta, < 5.0)
+      nokogiri (~> 1.6)
+      rails-deprecated_sanitizer (>= 1.0.1)
+    rails-html-sanitizer (1.0.3)
+      loofah (~> 2.0)
+    railties (4.2.9)
+      actionpack (= 4.2.9)
+      activesupport (= 4.2.9)
+      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)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  appraisal (~> 2.0)
+  bundler (~> 1.15)
+  bundler-audit (~> 0)
+  mocha (~> 1)
+  rails (= 4.2.9)
+  rake (~> 10.0)
+  redis_set_store!
+  rspec (~> 3.0)
+  rubocop (~> 0)
+
+BUNDLED WITH
+   1.15.3