redis-classy 0.9.1 → 1.0.0

data/Gemfile

@@ -1,9 +1,9 @@
 source "http://rubygems.org"
 
-gem "redis-namespace", "~> 0.10.0"
+gem "redis-namespace", "~> 1.0.0"
 
 group :development do
-  gem "rspec", "~> 2.5.0"
+  gem "rspec", "~> 2.6.0"
   gem "bundler", "~> 1.0.0"
-  gem "jeweler", "~> 1.5.2"
+  gem "jeweler", "~> 1.6.0"
 end

data/Gemfile.lock

@@ -3,28 +3,28 @@ GEM
   specs:
     diff-lcs (1.1.2)
     git (1.2.5)
-    jeweler (1.5.2)
+    jeweler (1.6.0)
       bundler (~> 1.0.0)
       git (>= 1.2.5)
       rake
-    rake (0.8.7)
-    redis (2.1.1)
-    redis-namespace (0.10.0)
+    rake (0.9.0)
+    redis (2.2.0)
+    redis-namespace (1.0.3)
       redis (< 3.0.0)
-    rspec (2.5.0)
-      rspec-core (~> 2.5.0)
-      rspec-expectations (~> 2.5.0)
-      rspec-mocks (~> 2.5.0)
-    rspec-core (2.5.1)
-    rspec-expectations (2.5.0)
+    rspec (2.6.0)
+      rspec-core (~> 2.6.0)
+      rspec-expectations (~> 2.6.0)
+      rspec-mocks (~> 2.6.0)
+    rspec-core (2.6.2)
+    rspec-expectations (2.6.0)
       diff-lcs (~> 1.1.2)
-    rspec-mocks (2.5.0)
+    rspec-mocks (2.6.0)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
   bundler (~> 1.0.0)
-  jeweler (~> 1.5.2)
-  redis-namespace (~> 0.10.0)
-  rspec (~> 2.5.0)
+  jeweler (~> 1.6.0)
+  redis-namespace (~> 1.0.0)
+  rspec (~> 2.6.0)

data/README.md

@@ -0,0 +1,129 @@
+Redis Classy
+============
+
+Class-style namespace prefixing for Redis.
+
+With Redis Classy, class names become the prefix part of the Redis keys.
+
+    class Something < Redis::Classy
+    end
+    
+    Something.set "foo", "bar"      # equivalent of => redis.set "Something:foo", "bar"
+    Something.get "foo"             #               => redis.get "Something:foo"
+     => "bar"
+
+This library contains only 33 lines of code, yet powerful when you need better abstraction on Redis objects to keep things organized.
+
+Requies the `redis-namespace` gem.
+
+What's new:
+
+* v1.0.0: Play nice with Mongoid
+
+Synopsis
+--------
+
+With the vanilla redis gem, you've been doing this:
+
+    redis = Redis.new
+    redis.set "foo", "bar"
+
+With the redis-namespace gem, you can add a prefix in the following manner:
+
+    redis_ns = Redis::Namespace.new('ns', :redis => redis)
+    redis_ns['foo'] = 'bar'      # equivalent of => redis.set "ns:foo", "bar"
+
+Now, with the redis-classy gem, you could finally do:
+
+    class Something < Redis::Classy
+    end
+    
+    Something.set "foo", "bar"      # equivalent of => redis.set "Prefix:foo", "bar"
+    Something.get "foo"
+     => "bar"
+
+Install
+-------
+
+    gem install redis-classy
+
+Usage
+-----
+
+In Gemfile:
+
+    gem "redis-classy"
+
+In config/initializers/redis_classy.rb:
+
+    Redis::Classy.db = Redis.new
+
+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.
+
+    class UniqueUser < Redis::Classy
+     def self.nuke
+       self.keys.each{|key| self.del(key) }
+     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.smembers "2011-02-28"
+    => ["123", "456"]
+    
+    UniqueUser.nuke
+    => ["2011-02-28", "2011-03-01"]
+    
+    UniqueUser.keys
+    => []
+
+In most cases you may be just fine with class methods, but by creating an instance with a key, even further binding is possible.
+
+    class Counter < Redis::Classy
+     def initialize(object)
+       super("#{object.class.name}:#{object.id}")
+     end
+    end
+    
+    class Room < ActiveRecord::Base
+    end
+    
+    @room = Room.create
+    
+    counter = Counter.new(@room)
+    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
+
+    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
+    end
+
+Since the "db" attribute is a class instance variable, you can dynamically assign different databases for each class.
+
+    UniqueUser.db = Redis::Namespace.new("UniqueUser", :redis => Redis.new(:host => "another.host"))
+
+Reference
+---------
+
+Dependency:
+
+* <https://github.com/ezmobius/redis-rb>
+* <https://github.com/defunkt/redis-namespace>
+
+Use case:
+
+* <https://github.com/kenn/redis-mutex>

data/Rakefile

@@ -7,39 +7,22 @@ rescue Bundler::BundlerError => e
   $stderr.puts "Run `bundle install` to install missing gems"
   exit e.status_code
 end
-require 'rake'
+require 'rake/file_utils'
+include FileUtils
 
 require 'jeweler'
 Jeweler::Tasks.new do |gem|
   gem.name = "redis-classy"
   gem.homepage = "http://github.com/kenn/redis-classy"
   gem.license = "MIT"
-  gem.summary = "Model-friendly base class for Redis"
-  gem.description = "Make the prefix part of the Redis keys a class name for your model."
+  gem.summary = "Class-style namespace prefixing for Redis"
+  gem.description = "Class-style namespace prefixing for Redis"
   gem.email = "kenn.ejima@gmail.com"
   gem.authors = ["Kenn Ejima"]
 end
 Jeweler::RubygemsDotOrgTasks.new
 
-require 'rspec/core'
-require 'rspec/core/rake_task'
-RSpec::Core::RakeTask.new(:spec) do |spec|
-  spec.pattern = FileList['spec/**/*_spec.rb']
-end
-
-RSpec::Core::RakeTask.new(:rcov) do |spec|
-  spec.pattern = 'spec/**/*_spec.rb'
-  spec.rcov = true
-end
-
 task :default => :spec
-
-require 'rake/rdoctask'
-Rake::RDocTask.new do |rdoc|
-  version = File.exist?('VERSION') ? File.read('VERSION') : ""
-
-  rdoc.rdoc_dir = 'rdoc'
-  rdoc.title = "redis-classy #{version}"
-  rdoc.rdoc_files.include('README*')
-  rdoc.rdoc_files.include('lib/**/*.rb')
+task :spec do
+  exec "rspec spec/redis-classy_spec.rb"
 end

data/VERSION

@@ -1 +1 @@
-0.9.1
+1.0.0

data/lib/redis/classy.rb

@@ -12,6 +12,12 @@ class Redis
       def method_missing(method_name, *args, &block)
         self.db.send(method_name, *args, &block)
       end
+
+      Redis::Namespace::COMMANDS.keys.each do |key|
+        define_method(key) do |*args|
+          self.db.send(key, *args)
+        end
+      end
     end
 
     attr_accessor :key

data/redis-classy.gemspec

@@ -5,16 +5,16 @@
 
 Gem::Specification.new do |s|
   s.name = %q{redis-classy}
-  s.version = "0.9.1"
+  s.version = "1.0.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Kenn Ejima"]
-  s.date = %q{2011-03-16}
-  s.description = %q{Make the prefix part of the Redis keys a class name for your model.}
+  s.date = %q{2011-05-21}
+  s.description = %q{Class-style namespace prefixing for Redis}
   s.email = %q{kenn.ejima@gmail.com}
   s.extra_rdoc_files = [
     "LICENSE.txt",
-    "README.rdoc"
+    "README.md"
   ]
   s.files = [
     ".document",
@@ -22,7 +22,7 @@ Gem::Specification.new do |s|
     "Gemfile",
     "Gemfile.lock",
     "LICENSE.txt",
-    "README.rdoc",
+    "README.md",
     "Rakefile",
     "VERSION",
     "lib/redis-classy.rb",
@@ -34,32 +34,28 @@ Gem::Specification.new do |s|
   s.homepage = %q{http://github.com/kenn/redis-classy}
   s.licenses = ["MIT"]
   s.require_paths = ["lib"]
-  s.rubygems_version = %q{1.5.3}
-  s.summary = %q{Model-friendly base class for Redis}
-  s.test_files = [
-    "spec/redis-classy_spec.rb",
-    "spec/spec_helper.rb"
-  ]
+  s.rubygems_version = %q{1.6.2}
+  s.summary = %q{Class-style namespace prefixing for Redis}
 
   if s.respond_to? :specification_version then
     s.specification_version = 3
 
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
-      s.add_runtime_dependency(%q<redis-namespace>, ["~> 0.10.0"])
-      s.add_development_dependency(%q<rspec>, ["~> 2.5.0"])
+      s.add_runtime_dependency(%q<redis-namespace>, ["~> 1.0.0"])
+      s.add_development_dependency(%q<rspec>, ["~> 2.6.0"])
       s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
-      s.add_development_dependency(%q<jeweler>, ["~> 1.5.2"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.6.0"])
     else
-      s.add_dependency(%q<redis-namespace>, ["~> 0.10.0"])
-      s.add_dependency(%q<rspec>, ["~> 2.5.0"])
+      s.add_dependency(%q<redis-namespace>, ["~> 1.0.0"])
+      s.add_dependency(%q<rspec>, ["~> 2.6.0"])
       s.add_dependency(%q<bundler>, ["~> 1.0.0"])
-      s.add_dependency(%q<jeweler>, ["~> 1.5.2"])
+      s.add_dependency(%q<jeweler>, ["~> 1.6.0"])
     end
   else
-    s.add_dependency(%q<redis-namespace>, ["~> 0.10.0"])
-    s.add_dependency(%q<rspec>, ["~> 2.5.0"])
+    s.add_dependency(%q<redis-namespace>, ["~> 1.0.0"])
+    s.add_dependency(%q<rspec>, ["~> 2.6.0"])
     s.add_dependency(%q<bundler>, ["~> 1.0.0"])
-    s.add_dependency(%q<jeweler>, ["~> 1.5.2"])
+    s.add_dependency(%q<jeweler>, ["~> 1.6.0"])
   end
 end
 

data/spec/redis-classy_spec.rb

@@ -1,7 +1,65 @@
 require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
 
+class Something < Redis::Classy
+end
+
 describe "RedisClassy" do
-  pending "fails" do
-    fail "hey buddy, you should probably rename this file and start specing for real"
+  before(:each) do
+    Redis::Classy.flushdb
+  end
+  
+  after(:each) do
+    Redis::Classy.flushdb
+  end
+  
+  after(:all) do
+    Redis::Classy.quit
+  end
+  
+  it "should prepend class name to the key" do
+    Something.set("foo", "bar")
+    
+    Something.keys.should     == ["foo"]
+    Redis::Classy.keys.should == ["Something:foo"]
+  end
+  
+  it "should delegate class methods" do
+    Something.get("foo").should == nil
+    Something.set("foo", "bar")
+    Something.get("foo").should == "bar"
+  end
+  
+  it "should delegate instance methods with the key binding" do
+    something = Something.new("foo")
+    
+    something.get.should == nil
+    something.set("bar")
+    something.get.should == "bar"
+  end
+  
+  it "should handle multi block" do
+    Redis::Classy.multi do
+      Something.sadd "foo", "bar"
+      Something.sadd "foo", "baz"
+    end
+    
+    Something.smembers("foo").should == ["baz", "bar"]
+  end
+  
+  it "should battle against mongoid" do
+    # Emulate notorious Mongoid::Extensions::Object::Conversions
+    class Object
+      def self.get(value)
+        value
+      end
+    end
+    
+    # This would have returned "foo" instead of nil, unless we explicitly defined
+    # class methods from Redis::Namespace::COMMANDS
+    Something.get("foo").should == nil
+    
+    class << Object
+      remove_method :get
+    end
   end
 end

data/spec/spec_helper.rb

@@ -8,5 +8,6 @@ require 'redis-classy'
 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)
 end

metadata

@@ -2,7 +2,7 @@
 name: redis-classy
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.9.1
+  version: 1.0.0
 platform: ruby
 authors: 
 - Kenn Ejima
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-03-16 00:00:00 -07:00
+date: 2011-05-21 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -20,7 +20,7 @@ dependencies:
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        version: 0.10.0
+        version: 1.0.0
   type: :runtime
   prerelease: false
   version_requirements: *id001
@@ -31,7 +31,7 @@ dependencies:
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        version: 2.5.0
+        version: 2.6.0
   type: :development
   prerelease: false
   version_requirements: *id002
@@ -53,11 +53,11 @@ dependencies:
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        version: 1.5.2
+        version: 1.6.0
   type: :development
   prerelease: false
   version_requirements: *id004
-description: Make the prefix part of the Redis keys a class name for your model.
+description: Class-style namespace prefixing for Redis
 email: kenn.ejima@gmail.com
 executables: []
 
@@ -65,14 +65,14 @@ extensions: []
 
 extra_rdoc_files: 
 - LICENSE.txt
-- README.rdoc
+- README.md
 files: 
 - .document
 - .rspec
 - Gemfile
 - Gemfile.lock
 - LICENSE.txt
-- README.rdoc
+- README.md
 - Rakefile
 - VERSION
 - lib/redis-classy.rb
@@ -94,7 +94,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: -2882799030924789426
+      hash: 1700316394967053203
       segments: 
       - 0
       version: "0"
@@ -107,10 +107,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.5.3
+rubygems_version: 1.6.2
 signing_key: 
 specification_version: 3
-summary: Model-friendly base class for Redis
-test_files: 
-- spec/redis-classy_spec.rb
-- spec/spec_helper.rb
+summary: Class-style namespace prefixing for Redis
+test_files: []
+

data/README.rdoc

@@ -1,106 +0,0 @@
-= Redis Classy
-
-Model-friendly base class for Redis.
-
-With this library, the class name of your model becomes the prefix part of the Redis keys.
-
-This library contains only 27 lines of code, yet powerful when you need more abstraction on Redis objects rather than dealing with complicated keys in all strings.
-
-Requies the redis-namespace gem.
-
-== Synopsis
-
-With the vanilla redis gem, you've been normally doing this:
-
- redis = Redis.new
- redis.set "foo", "bar"
-
-With the redis-namespace gem, you could add a prefix in the following manner:
-
- redis_ns = Redis::Namespace.new('ns', :redis => redis)
- redis_ns['foo'] = 'bar'      # equivalent of => redis.set "ns:foo", "bar"
-
-Now, with the redis-classy gem, you could finally do:
-
- class Prefix < Redis::Classy
- end
- 
- Prefix.set "foo", "bar"      # equivalent of => redis.set "Prefix:foo", "bar"
- Prefix.get "foo"
- => "bar"
-
-== Install
-
- gem install redis-classy
-
-== Usage
-
-In Gemfile:
-
- gem "redis-classy"
-
-In config/initializers/redis_classy.rb:
-
- Redis::Classy.db = Redis.new
-
-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.
-
- class UniqueUser < Redis::Classy
-   def self.nuke
-     self.keys.each{|key| self.del(key) }
-   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.smembers "2011-02-28"
- => ["123", "456"]
- 
- UniqueUser.nuke
- => ["2011-02-28", "2011-03-01"]
- 
- UniqueUser.keys
- => []
-
-In most cases you may be just fine with class methods, but by creating an instance with a key, even further binding is possible.
-
- class Counter < Redis::Classy
-   def initialize(object)
-     super("#{object.class.name}:#{object.id}")
-   end
- end
- 
- counter = Counter.new(@room)
- 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
-
- 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
- end
-
-Since the "db" attribute is a class instance variable, you can dynamically assign different databases for each class.
-
- UniqueUser.db = Redis::Namespace.new("UniqueUser", :redis => Redis.new(:host => "another.host"))
-
-== Reference
-
-Dependency:
-https://github.com/ezmobius/redis-rb
-https://github.com/defunkt/redis-namespace
-
-Use case:
-https://github.com/kenn/redis-mutex