jodosha-redis-store 0.0.3 → 0.1.0

data/README.textile

@@ -24,13 +24,27 @@ In your configuration files:
 
 h2. How to use with Merb
 
-  dependency "redis-store", "0.0.3"
+  dependency "jodosha-redis-store", "0.1.0"
   dependency("merb-cache", merb_gems_version) do
     Merb::Cache.setup do
       register(:redis, Merb::Cache::RedisStore, :servers => ["127.0.0.1:6379"])
     end
   end
 
+h2. How to use with Sinatra
+
+  require 'rubygems'
+  require 'sinatra'
+  require 'jodosha-redis-store'
+
+  class MyApp < Sinatra::Base
+    register Sinatra::Cache
+
+    get '/hi' do
+      cache.fetch("greet") { "Hello, World!" }
+    end
+  end
+
 h2. Copyright
 
 (c) 2009 Luca Guidi - http://lucaguidi.com, released under the MIT license

data/Rakefile

@@ -5,7 +5,7 @@ require 'rake/testtask'
 require 'rake/rdoctask'
 require 'spec/rake/spectask'
 
-REDIS_STORE_VERSION = "0.0.3"
+REDIS_STORE_VERSION = "0.1.0"
 
 task :default => :spec
 

data/lib/cache/sinatra/redis_store.rb

@@ -0,0 +1,131 @@
+module Sinatra
+  module Cache
+    class << self
+      def register(app)
+        app.set :cache, RedisStore.new
+      end
+    end
+
+    class RedisStore
+      # Instantiate the store.
+      #
+      # Example:
+      #   RedisStore.new                       # => host: localhost,   port: 6379,  db: 0
+      #   RedisStore.new "example.com"         # => host: example.com, port: 6379,  db: 0
+      #   RedisStore.new "example.com:23682"   # => host: example.com, port: 23682, db: 0
+      #   RedisStore.new "example.com:23682/1" # => host: example.com, port: 23682, db: 1
+      #   RedisStore.new "localhost:6379/0", "localhost:6380/0" # => instantiate a cluster
+      def initialize(*addresses)
+        addresses = extract_addresses(addresses)
+        @data = if addresses.size > 1
+          DistributedMarshaledRedis.new addresses
+        else
+          MarshaledRedis.new addresses.first || {}
+        end
+      end
+
+      def write(key, value, options = nil)
+        method = options && options[:unless_exist] ? :set_unless_exists : :set
+        @data.send method, key, value, options
+      end
+
+      def read(key, options = nil)
+        @data.get key, options
+      end
+
+      def delete(key, options = nil)
+        @data.delete key
+      end
+
+      def exist?(key, options = nil)
+        @data.key? key
+      end
+
+      # Increment a key in the store.
+      #
+      # If the key doesn't exist it will be initialized on 0.
+      # If the key exist but it isn't a Fixnum it will be initialized on 0.
+      #
+      # Example:
+      #   We have two objects in cache:
+      #     counter # => 23
+      #     rabbit  # => #<Rabbit:0x5eee6c>
+      #
+      #   cache.increment "counter"
+      #   cache.read "counter", :raw => true      # => "24"
+      #
+      #   cache.increment "counter", 6
+      #   cache.read "counter", :raw => true      # => "30"
+      #
+      #   cache.increment "a counter"
+      #   cache.read "a counter", :raw => true    # => "1"
+      #
+      #   cache.increment "rabbit"
+      #   cache.read "rabbit", :raw => true       # => "1"
+      def increment(key, amount = 1)
+        @data.incr key, amount
+      end
+
+      # Decrement a key in the store
+      #
+      # If the key doesn't exist it will be initialized on 0.
+      # If the key exist but it isn't a Fixnum it will be initialized on 0.
+      #
+      # Example:
+      #   We have two objects in cache:
+      #     counter # => 23
+      #     rabbit  # => #<Rabbit:0x5eee6c>
+      #
+      #   cache.decrement "counter"
+      #   cache.read "counter", :raw => true      # => "22"
+      #
+      #   cache.decrement "counter", 2
+      #   cache.read "counter", :raw => true      # => "20"
+      #
+      #   cache.decrement "a counter"
+      #   cache.read "a counter", :raw => true    # => "-1"
+      #
+      #   cache.decrement "rabbit"
+      #   cache.read "rabbit", :raw => true       # => "-1"
+      def decrement(key, amount = 1)
+        @data.decr key, amount
+      end
+
+      # Delete objects for matched keys.
+      #
+      # Example:
+      #   cache.delete_matched "rab*"
+      def delete_matched(matcher, options = nil)
+        @data.keys(matcher).each { |key| @data.delete key }
+      end
+
+      def fetch(key, options = {})
+        (!options[:force] && data = read(key, options)) || (write key, yield, options if block_given?)
+      end
+
+      # Clear all the data from the store.
+      def clear
+        @data.flush_db
+      end
+
+      def stats
+        @data.info
+      end
+
+      private
+        def extract_addresses(addresses) # TODO extract in a module or a class
+          addresses = addresses.flatten.compact
+          addresses.inject([]) do |result, address|
+            host, port = address.split /\:/
+            port, db   = port.split /\// if port
+            address = {}
+            address[:host] = host if host
+            address[:port] = port if port
+            address[:db]  = db.to_i if db
+            result << address
+            result
+          end
+        end
+    end
+  end
+end

data/lib/redis-store.rb

@@ -3,7 +3,9 @@ require "dist_redis"
 require "redis/marshaled_redis"
 require "redis/distributed_marshaled_redis"
 
-if defined?(Merb)
+if defined?(Sinatra)
+  require "cache/sinatra/redis_store"
+elsif defined?(Merb)
   # HACK for cyclic dependency: redis-store is required before merb-cache
   module Merb; module Cache; class AbstractStore; end end end
   require "cache/merb/redis_store"

data/redis-store.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name               = "redis-store"
-  s.version            = "0.0.3"
+  s.version            = "0.1.0"
   s.date               = "2009-04-30"
   s.summary            = "Redis cache and session stores for Ruby web frameworks"
   s.author             = "Luca Guidi"
@@ -8,7 +8,7 @@ Gem::Specification.new do |s|
   s.homepage           = "http://lucaguidi.com"
   s.description        = "Redis cache and session stores for Ruby web frameworks"
   s.has_rdoc           = true
-  s.files              = ["MIT-LICENSE", "README.textile", "Rakefile", "lib/cache/merb/redis_store.rb", "lib/cache/rails/redis_store.rb", "lib/redis-store.rb", "lib/redis/distributed_marshaled_redis.rb", "lib/redis/marshaled_redis.rb", "redis-store.gemspec", "spec/cache/merb/redis_store_spec.rb", "spec/cache/rails/redis_store_spec.rb", "spec/config/master.conf", "spec/config/single.conf", "spec/config/slave.conf", "spec/redis/distributed_marshaled_redis_spec.rb", "spec/redis/marshaled_redis_spec.rb", "spec/spec_helper.rb"]
-  s.test_files         = ["spec/cache/merb/redis_store_spec.rb", "spec/cache/rails/redis_store_spec.rb", "spec/redis/distributed_marshaled_redis_spec.rb", "spec/redis/marshaled_redis_spec.rb"]
+  s.files              = ["MIT-LICENSE", "README.textile", "Rakefile", "lib/cache/merb/redis_store.rb", "lib/cache/rails/redis_store.rb", "lib/cache/sinatra/redis_store.rb", "lib/redis-store.rb", "lib/redis/distributed_marshaled_redis.rb", "lib/redis/marshaled_redis.rb", "redis-store.gemspec", "spec/cache/merb/redis_store_spec.rb", "spec/cache/rails/redis_store_spec.rb", "spec/cache/sinatra/redis_store_spec.rb", "spec/config/master.conf", "spec/config/single.conf", "spec/config/slave.conf", "spec/redis/distributed_marshaled_redis_spec.rb", "spec/redis/marshaled_redis_spec.rb", "spec/spec_helper.rb"]
+  s.test_files         = ["spec/cache/merb/redis_store_spec.rb", "spec/cache/rails/redis_store_spec.rb", "spec/cache/sinatra/redis_store_spec.rb", "spec/redis/distributed_marshaled_redis_spec.rb", "spec/redis/marshaled_redis_spec.rb"]
   s.extra_rdoc_files   = ["README.textile"]
 end

data/spec/cache/rails/redis_store_spec.rb

@@ -11,6 +11,7 @@ module ActiveSupport
         with_store_management do |store|
           store.write  "rabbit", @rabbit
           store.delete "counter"
+          store.delete "rub-a-dub"
         end
       end
 

data/spec/cache/sinatra/redis_store_spec.rb

@@ -0,0 +1,192 @@
+require File.join(File.dirname(__FILE__), "/../../spec_helper")
+
+class App
+  def initialize
+    @values = {}
+  end
+
+  def set(key, value)
+    @values[key] = value
+  end
+  
+  def get(key)
+    @values[key]
+  end
+end
+
+module Sinatra
+  module Cache
+    describe "RedisStore" do
+      before(:each) do
+        @store  = RedisStore.new
+        @dstore = RedisStore.new "localhost:6380/1", "localhost:6381/1"
+        @rabbit = OpenStruct.new :name => "bunny"
+        @white_rabbit = OpenStruct.new :color => "white"
+        with_store_management do |store|
+          store.write  "rabbit", @rabbit
+          store.delete "counter"
+          store.delete "rub-a-dub"
+        end
+      end
+
+      it "should register as extension" do
+        app = App.new
+        Sinatra::Cache.register(app)
+        store = app.get(:cache)
+        store.should be_kind_of(RedisStore)
+      end
+
+      it "should accept connection params" do
+        redis = instantiate_store
+        redis.instance_variable_get(:@db).should == 0
+        redis.host.should == "localhost"
+        redis.port.should == "6379"
+
+        redis = instantiate_store "redis.com"
+        redis.host.should == "redis.com"
+        
+        redis = instantiate_store "redis.com:6380"
+        redis.host.should == "redis.com"
+        redis.port.should == "6380"
+
+        redis = instantiate_store "redis.com:6380/23"
+        redis.instance_variable_get(:@db).should == 23
+        redis.host.should == "redis.com"
+        redis.port.should == "6380"
+      end
+
+      it "should instantiate a ring" do
+        store = instantiate_store
+        store.should be_kind_of(MarshaledRedis)
+        store = instantiate_store ["localhost:6379/0", "localhost:6379/1"]
+        store.should be_kind_of(DistributedMarshaledRedis)
+      end
+
+      it "should read the data" do
+        with_store_management do |store|
+          store.read("rabbit").should === @rabbit
+        end
+      end
+
+      it "should write the data" do
+        with_store_management do |store|
+          store.write "rabbit", @white_rabbit
+          store.read("rabbit").should === @white_rabbit
+        end
+      end
+
+      # it "should write the data with expiration time" do
+      #   @store.write "rabbit", @white_rabbit, :expires_in => 1.second
+      #   @store.read("rabbit").should === @white_rabbit ; sleep 2
+      #   @store.read("rabbit").should be_nil
+      # end
+
+      it "should not write data if :unless_exist option is true" do
+        with_store_management do |store|
+          store.write "rabbit", @white_rabbit, :unless_exist => true
+          store.read("rabbit").should === @rabbit
+        end
+      end
+
+      it "should read raw data" do
+        with_store_management do |store|
+          store.read("rabbit", :raw => true).should == "\004\bU:\017OpenStruct{\006:\tname\"\nbunny"
+        end
+      end
+
+      it "should write raw data" do
+        with_store_management do |store|
+          store.write "rabbit", @white_rabbit, :raw => true
+          store.read("rabbit", :raw => true).should == %(#<OpenStruct color="white">)
+        end
+      end
+
+      it "should delete data" do
+        with_store_management do |store|
+          store.delete "rabbit"
+          store.read("rabbit").should be_nil
+        end
+      end
+
+      it "should delete matched data" do
+        with_store_management do |store|
+          store.delete_matched "rabb*"
+          store.read("rabbit").should be_nil
+        end
+      end
+
+      it "should verify existence of an object in the store" do
+        with_store_management do |store|
+          store.exist?("rabbit").should be_true
+          store.exist?("rab-a-dub").should be_false
+        end
+      end
+
+      it "should increment a key" do
+        with_store_management do |store|
+          3.times { store.increment "counter" }
+          store.read("counter", :raw => true).to_i.should == 3
+        end
+      end
+
+      it "should decrement a key" do
+        with_store_management do |store|
+          3.times { store.increment "counter" }
+          2.times { store.decrement "counter" }
+          store.read("counter", :raw => true).to_i.should == 1
+        end
+      end
+
+      it "should increment a key by given value" do
+        with_store_management do |store|
+          store.increment "counter", 3
+          store.read("counter", :raw => true).to_i.should == 3
+        end
+      end
+
+      it "should decrement a key by given value" do
+        with_store_management do |store|
+          3.times { store.increment "counter" }
+          store.decrement "counter", 2
+          store.read("counter", :raw => true).to_i.should == 1
+        end
+      end
+
+      it "should clear the store" do
+        with_store_management do |store|
+          store.clear
+          store.instance_variable_get(:@data).keys("*").should be_empty
+        end
+      end
+
+      it "should return store stats" do
+        with_store_management do |store|
+          store.stats.should_not be_empty
+        end
+      end
+
+      it "should fetch data" do
+        with_store_management do |store|
+          store.fetch("rabbit").should == @rabbit
+          store.fetch("rub-a-dub").should be_nil
+          store.fetch("rub-a-dub") { "Flora de Cana" }
+          store.fetch("rub-a-dub").should === "Flora de Cana"
+          store.fetch("rabbit", :force => true).should be_nil # force cache miss
+          # store.fetch("rabbit", :force => true, :expires_in => 1.second) { @white_rabbit }
+          # store.fetch("rabbit").should === @white_rabbit ; sleep 2
+          # store.fetch("rabbit").should be_nil
+        end
+      end
+
+      private
+        def instantiate_store(addresses = nil)
+          RedisStore.new(addresses).instance_variable_get(:@data)
+        end
+
+        def with_store_management
+          yield @store
+          yield @dstore
+        end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -7,3 +7,4 @@ require "merb"
 require "redis-store"
 require "activesupport"
 require "cache/rails/redis_store"
+require "cache/sinatra/redis_store"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: jodosha-redis-store
 version: !ruby/object:Gem::Version 
-  version: 0.0.3
+  version: 0.1.0
 platform: ruby
 authors: 
 - Luca Guidi
@@ -27,12 +27,14 @@ files:
 - Rakefile
 - lib/cache/merb/redis_store.rb
 - lib/cache/rails/redis_store.rb
+- lib/cache/sinatra/redis_store.rb
 - lib/redis-store.rb
 - lib/redis/distributed_marshaled_redis.rb
 - lib/redis/marshaled_redis.rb
 - redis-store.gemspec
 - spec/cache/merb/redis_store_spec.rb
 - spec/cache/rails/redis_store_spec.rb
+- spec/cache/sinatra/redis_store_spec.rb
 - spec/config/master.conf
 - spec/config/single.conf
 - spec/config/slave.conf
@@ -68,5 +70,6 @@ summary: Redis cache and session stores for Ruby web frameworks
 test_files: 
 - spec/cache/merb/redis_store_spec.rb
 - spec/cache/rails/redis_store_spec.rb
+- spec/cache/sinatra/redis_store_spec.rb
 - spec/redis/distributed_marshaled_redis_spec.rb
 - spec/redis/marshaled_redis_spec.rb