simple_redis_store 0.0.1

data/.gitignore

@@ -0,0 +1,5 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*
+tmp/*

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in simple_redis_store.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Kieran Pilkington
+
+MIT License
+
+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,39 @@
+# Simple Redis Store for ActiveSupport::Cache
+
+__`simple_redis_store`__ provides a lightweight Redis cache store for ActiveSupport::Cache.
+
+## Prerequisites
+
+__`simple_redis_store`__ relies on Redis being installed and running.
+
+Mac users can install Redis via `brew install redis`.
+
+Everyone else, check the package manager of your operating system.
+
+## Installation
+
+Add this line to your application's Gemfile then run `bundle`:
+
+    gem 'simple_redis_store'
+
+## Usage
+
+### Ruby on Rails
+
+    # config/environments/production.rb
+    config.action_controller.perform_caching = true
+    config.cache_store = :simple_redis_store
+
+### Standalone
+
+    ActiveSupport::Cache.lookup_store :simple_redis_store
+
+## TODO
+
+* Implement multi key retrieval (`def read_multi`)
+* Improve configuration support
+* Tests
+
+## Copyright
+
+(c) 2012 Kieran Pilkington, release under the MIT license

data/Rakefile

@@ -0,0 +1,2 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"

data/lib/active_support/cache/simple_redis_store.rb

@@ -0,0 +1,88 @@
+require 'redis'
+
+# References:
+# https://github.com/redis/redis-rb/blob/master/lib/redis.rb
+# https://github.com/jodosha/redis-store/blob/master/redis-activesupport/lib/active_support/cache/redis_store.rb
+
+module ActiveSupport
+  module Cache
+    class SimpleRedisStore < Store
+
+      def initialize(options = {})
+        super(options)
+      end
+
+      def delete_matched(matcher, options = nil)
+        instrument(:delete_matched, matcher.inspect) do
+          return unless keys = execute(:keys, matcher)
+          execute(:del, *keys) if keys.any?
+        end
+      end
+
+      def increment(name, amount = 1, options = nil)
+        instrument(:increment, name, :amount => amount) do
+          execute(:incrby, name, amount)
+        end
+      end
+
+      def decrement(name, amount = 1, options = nil)
+        instrument(:decrement, name, :amount => amount) do
+          execute(:decrby, name, amount)
+        end
+      end
+
+      def clear(options = nil)
+        instrument(:clear, nil, nil) do
+          execute(:flushdb)
+        end
+      end
+
+      protected
+
+      def connection(options = {})
+        @redis ||= Redis.new(options)
+      rescue Redis::CannotConnectError
+        @redis = nil
+      end
+
+      def execute(method, *args)
+        return false unless connection
+        connection.send(method, *args)
+      rescue Redis::CannotConnectError
+        false
+      end
+
+      def key_matcher(pattern, options)
+        if pattern.is_a?(Regexp)
+          raise "Regexps not supported. Use wildcards (*) instead."
+        end
+
+        namespace = options[:namespace]
+        namespace = options[:namespace].call if namespace.is_a?(Proc)
+        [namespace, pattern].compact.join(':')
+      end
+
+      def read_entry(key, options)
+        instrument(:read_entry, key) do
+          return unless entry = execute(:get, key)
+          entry = Marshal.load(entry) rescue entry
+          entry.is_a?(Entry) ? entry : Entry.new(entry)
+        end
+      end
+
+      def write_entry(key, entry, options)
+        instrument(:write_entry, key) do
+          entry = Marshal.dump(entry)
+          execute(:set, key, entry)
+        end
+      end
+
+      def delete_entry(key, options)
+        instrument(:delete_entry, key) do
+          execute(:del, key)
+        end
+      end
+
+    end
+  end
+end

data/lib/simple_redis_store.rb

@@ -0,0 +1,2 @@
+require "active_support/cache"
+require "active_support/cache/simple_redis_store"

data/lib/simple_redis_store/version.rb

@@ -0,0 +1,3 @@
+module SimpleRedisStore
+  VERSION = "0.0.1"
+end

data/simple_redis_store.gemspec

@@ -0,0 +1,20 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/simple_redis_store/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Kieran Pilkington"]
+  gem.email         = ["kieran776@gmail.com"]
+  gem.description   = %q{A lightweight Redis cache store for ActiveSupport::Cache}
+  gem.summary       = %q{A lightweight Redis cache store for ActiveSupport::Cache}
+  gem.homepage      = "https://github.com/KieranP/simple_redis_store"
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "simple_redis_store"
+  gem.require_paths = ["lib"]
+  gem.version       = SimpleRedisStore::VERSION
+
+  gem.add_runtime_dependency "activesupport", "~> 3.0"
+  gem.add_runtime_dependency "redis", "~> 3.0.0"
+end

metadata

@@ -0,0 +1,86 @@
+--- !ruby/object:Gem::Specification
+name: simple_redis_store
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Kieran Pilkington
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-10-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: redis
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+description: A lightweight Redis cache store for ActiveSupport::Cache
+email:
+- kieran776@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/active_support/cache/simple_redis_store.rb
+- lib/simple_redis_store.rb
+- lib/simple_redis_store/version.rb
+- simple_redis_store.gemspec
+homepage: https://github.com/KieranP/simple_redis_store
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: A lightweight Redis cache store for ActiveSupport::Cache
+test_files: []