redis-classy 1.0.1 → 1.0.2

data/README.md

@@ -10,16 +10,17 @@ class Something < Redis::Classy
 end
 
 Something.set 'foo', 'bar'      # equivalent of => redis.set 'Something:foo', 'bar'
-Something.get 'foo'             #               => redis.get 'Something:foo'
+Something.get 'foo'             # equivalent of => redis.get 'Something:foo'
  => "bar"
 ```
 
-This library contains only 30+ lines of code, yet powerful when you need better abstraction on Redis objects to keep things organized.
+All methods are delegated to the `redis-namespace` gems.
 
-Requies the `redis-namespace` gem.
+This library contains only 30+ lines of code, yet powerful when you need better abstraction on Redis objects to keep things organized.
 
-What's new:
+### What's new:
 
+* v1.0.1: Relaxed version dependency on redis-namespace
 * v1.0.0: Play nice with Mongoid
 
 Synopsis
@@ -30,23 +31,32 @@ With the vanilla `redis` gem, you've been doing this:
 ```ruby
 redis = Redis.new
 redis.set 'foo', 'bar'
+redis.get 'foo'
+ => "bar"
 ```
 
 With the `redis-namespace` gem, you can add a prefix in the following manner:
 
 ```ruby
 redis_ns = Redis::Namespace.new('ns', :redis => redis)
-redis_ns['foo'] = 'bar'      # equivalent of => redis.set 'ns:foo', 'bar'
+redis_ns['foo'] = 'bar'         # equivalent of => redis.set 'ns:foo', 'bar'
+redis_ns['foo']                 # equivalent of => redis.get 'ns:foo'
+ => "bar"
 ```
 
-Now, with the redis-classy gem, you could finally do:
+Now, with the `redis-classy` gem, you finally achieve a class-based encapsulation:
 
 ```ruby
 class Something < Redis::Classy
 end
 
-Something.set 'foo', 'bar'      # equivalent of => redis.set 'Prefix:foo', 'bar'
-Something.get 'foo'
+Something.set 'foo', 'bar'      # equivalent of => redis.set 'Something:foo', 'bar'
+Something.get 'foo'             # equivalent of => redis.get 'Something:foo'
+ => "bar"
+
+something = Something.new('foo')
+something.set 'bar'
+something.get
  => "bar"
 ```
 
@@ -64,14 +74,14 @@ In Gemfile:
 gem 'redis-classy'
 ```
 
-In config/initializers/redis_classy.rb:
+Register the Redis server: (e.g. in `config/initializers/redis_classy.rb` for Rails)
 
 ```ruby
-Redis::Classy.db = Redis.new
+Redis::Classy.db = Redis.new(:host => 'localhost')
 ```
 
-Now you can write models that inherit the Redis::Classy class, automatically prefixing keys with its class name.
-You can use any Redis commands on the class, since they are simply passed to the Redis instance.
+Now you can write models that inherit `Redis::Classy`, automatically prefixing keys with its class name.
+You can use any Redis commands on the class, as they are eventually passed to the `redis` gem.
 
 ```ruby
 class UniqueUser < Redis::Classy
@@ -80,16 +90,17 @@ class UniqueUser < Redis::Classy
   end
 end
 
-UniqueUser.sadd '2011-02-28', @user_a.id
-UniqueUser.sadd '2011-02-28', @user_b.id
-UniqueUser.sadd '2011-03-01', @user_c.id
+UniqueUser.sadd '2011-02-28', '123'
+UniqueUser.sadd '2011-02-28', '456'
+UniqueUser.sadd '2011-03-01', '789'
 
 UniqueUser.smembers '2011-02-28'
  => ["123", "456"]
 
-UniqueUser.nuke
+UniqueUser.keys
  => ["2011-02-28", "2011-03-01"]
 
+UniqueUser.nuke
 UniqueUser.keys
  => []
 ```
@@ -109,24 +120,27 @@ end
 @room = Room.create
 
 counter = Counter.new(@room)
+counter.key
+ => "Room:123"
+
 counter.incr
 counter.incr
 counter.get
  => "2"
-
-counter.key
- => "Room:123"
 ```
 
-You also have access to the non-namespaced, raw Redis instance via Redis::Classy
+You also have access to the non-namespaced, raw Redis instance via `Redis::Classy`.
 
 ```ruby
+Redis::Classy.keys
+ => ["UniqueUser:2011-02-28", "UniqueUser:2011-03-01", "Counter:Room:123"]
+
 Redis::Classy.keys 'UniqueUser:*'
  => ["UniqueUser:2011-02-28", "UniqueUser:2011-03-01"]
 
 Redis::Classy.multi do
-  UniqueUser.sadd '2011-02-28', @user_a.id
-  UniqueUser.sadd '2011-02-28', @user_b.id
+  UniqueUser.sadd '2011-02-28', '123'
+  UniqueUser.sadd '2011-02-28', '456'
 end
 ```
 

data/Rakefile

@@ -22,6 +22,12 @@ Jeweler::Tasks.new do |gem|
 end
 Jeweler::RubygemsDotOrgTasks.new
 
+desc "Flush the test database"
+task :flushdb do
+  require 'redis'
+  Redis.new(:db => 15).flushdb
+end
+
 task :default => :spec
 task :spec do
   exec "rspec spec"

data/VERSION

@@ -1 +1 @@
-1.0.1
+1.0.2

data/lib/redis/classy.rb

@@ -4,7 +4,7 @@ class Redis
       attr_accessor :db
 
       def inherited(subclass)
-        subclass.db = Redis::Namespace.new(subclass.name, :redis => self.db)
+        subclass.db = Redis::Namespace.new(subclass.name, :redis => Redis::Classy.db)
       end
 
       def method_missing(method_name, *args, &block)

data/redis-classy.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = "redis-classy"
-  s.version = "1.0.1"
+  s.version = "1.0.2"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Kenn Ejima"]
-  s.date = "2011-11-05"
+  s.date = "2011-12-13"
   s.description = "Class-style namespace prefixing for Redis"
   s.email = "kenn.ejima@gmail.com"
   s.extra_rdoc_files = [
@@ -34,7 +34,7 @@ Gem::Specification.new do |s|
   s.homepage = "http://github.com/kenn/redis-classy"
   s.licenses = ["MIT"]
   s.require_paths = ["lib"]
-  s.rubygems_version = "1.8.11"
+  s.rubygems_version = "1.8.10"
   s.summary = "Class-style namespace prefixing for Redis"
 
   if s.respond_to? :specification_version then

data/spec/redis_classy_spec.rb

@@ -1,14 +1,22 @@
-require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+require 'spec_helper'
 
 class Something < Redis::Classy
 end
 
+class Another < Something
+end
+
+module Deep
+  class Klass < Another
+  end
+end
+
 describe "RedisClassy" do
-  before(:each) do
+  before do
     Redis::Classy.flushdb
   end
 
-  after(:each) do
+  after do
     Redis::Classy.flushdb
   end
 
@@ -18,9 +26,16 @@ describe "RedisClassy" do
 
   it "should prepend class name to the key" do
     Something.set("foo", "bar")
+    Something.keys.should == ["foo"]
+    Redis::Classy.keys.should include "Something:foo"
+
+    Another.set("foo", "bar")
+    Another.keys.should == ["foo"]
+    Redis::Classy.keys.should include "Another:foo"
 
-    Something.keys.should     == ["foo"]
-    Redis::Classy.keys.should == ["Something:foo"]
+    Deep::Klass.set("foo", "bar")
+    Deep::Klass.keys.should == ["foo"]
+    Redis::Classy.keys.should include "Deep::Klass:foo"
   end
 
   it "should delegate class methods" do

data/spec/spec_helper.rb

@@ -10,4 +10,8 @@ Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
 RSpec.configure do |config|
   # Use database 15 for testing so we don't accidentally step on you real data.
   Redis::Classy.db = Redis.new(:db => 15)
+  unless Redis::Classy.keys.empty?
+    puts '[ERROR]: Redis database 15 not empty! If you are sure, run "rake flushdb" beforehand.'
+    exit!
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: redis-classy
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-11-05 00:00:00.000000000 Z
+date: 2011-12-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redis-namespace
-  requirement: &70246658294580 !ruby/object:Gem::Requirement
+  requirement: &2158303540 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +21,10 @@ dependencies:
         version: '1.0'
   type: :runtime
   prerelease: false
-  version_requirements: *70246658294580
+  version_requirements: *2158303540
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70246658294100 !ruby/object:Gem::Requirement
+  requirement: &2158302700 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70246658294100
+  version_requirements: *2158302700
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &70246658293560 !ruby/object:Gem::Requirement
+  requirement: &2158301960 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70246658293560
+  version_requirements: *2158301960
 - !ruby/object:Gem::Dependency
   name: jeweler
-  requirement: &70246658293060 !ruby/object:Gem::Requirement
+  requirement: &2158301360 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,7 +54,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70246658293060
+  version_requirements: *2158301360
 description: Class-style namespace prefixing for Redis
 email: kenn.ejima@gmail.com
 executables: []
@@ -91,7 +91,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -3343369064691227206
+      hash: 2229584726006491915
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -100,7 +100,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.11
+rubygems_version: 1.8.10
 signing_key: 
 specification_version: 3
 summary: Class-style namespace prefixing for Redis