redis-namespace 0.2.1 → 0.3.0

data/Rakefile

@@ -1,5 +1,5 @@
 task :default => :spec
-task :test => :spec
+task :test    => :spec
 
 desc "Run specs"
 task :spec do
@@ -15,10 +15,10 @@ begin
     gemspec.email = "chris@ozmm.org"
     gemspec.homepage = "http://github.com/defunkt/redis-namespace"
     gemspec.authors = ["Chris Wanstrath"]
-    gemspec.version = '0.2.1'
+    gemspec.version = '0.3.0'
     gemspec.add_dependency 'redis'
   end
 rescue LoadError
-  puts "Jeweler not available. Install it with:"
-  puts "gem install jeweler"
+  warn "Jeweler not available. Install it with:"
+  warn "gem install jeweler"
 end

data/lib/redis/namespace.rb

@@ -2,86 +2,120 @@ require 'redis'
 
 class Redis
   class Namespace
-    # Generated from http://code.google.com/p/redis/wiki/CommandReference
-    # using the following jQuery:
+    # The following table defines how input parameters and result
+    # values should be modified for the namespace.
     #
-    # $('.vt li a').map(function(i,e){return $(e).text().toLowerCase()}).sort().toArray()
-    COMMANDS = [
-      "auth",
-      "bgrewriteaof",
-      "bgsave",
-      "blpop",
-      "brpop",
-      "dbsize",
-      "decr",
-      "decrby",
-      "del",
-      "exists",
-      "expire",
-      "flushall",
-      "flushdb",
-      "get",
-      "getset",
-      "incr",
-      "incrby",
-      "info",
-      "keys",
-      "lastsave",
-      "lindex",
-      "llen",
-      "lpop",
-      "lpush",
-      "lrange",
-      "lrem",
-      "lset",
-      "ltrim",
-      "mget",
-      "monitor",
-      "move",
-      "mset",
-      "msetnx",
-      "quit",
-      "randomkey",
-      "rename",
-      "renamenx",
-      "rpop",
-      "rpoplpush",
-      "rpush",
-      "sadd",
-      "save",
-      "scard",
-      "sdiff",
-      "sdiffstore",
-      "select",
-      "set",
-      "setnx",
-      "shutdown",
-      "sinter",
-      "sinterstore",
-      "sismember",
-      "slaveof",
-      "smembers",
-      "smove",
-      "sort",
-      "spop",
-      "srandmember",
-      "srem",
-      "sunion",
-      "sunionstore",
-      "ttl",
-      "type",
-      "zadd",
-      "zcard",
-      "zincrby",
-      "zrange",
-      "zrangebyscore",
-      "zrem",
-      "zremrangebyscore",
-      "zrevrange",
-      "zscore",
-      "[]",
-      "[]="
-    ]
+    # COMMANDS is a hash. Each key is the name of a command and each
+    # value is a two element array.
+    #
+    # The first element in the value array describes how to modify the
+    # arguments passed. It can be one of:
+    #
+    #   nil
+    #     Do nothing.
+    #   :first
+    #     Add the namespace to the first argument passed, e.g.
+    #       GET key => GET namespace:key
+    #   :all
+    #     Add the namespace to all arguments passed, e.g.
+    #       MGET key1 key2 => MGET namespace:key1 namespace:key2
+    #   :exclude_first
+    #     Add the namespace to all arguments but the first, e.g.
+    #   :exclude_last
+    #     Add the namespace to all arguments but the last, e.g.
+    #       BLPOP key1 key2 timeout =>
+    #       BLPOP namespace:key1 namespace:key2 timeout
+    #   :alternate
+    #     Add the namespace to every other argument, e.g.
+    #       MSET key1 value1 key2 value2 =>
+    #       MSET namespace:key1 value1 namespace:key2 value2
+    #
+    # The second element in the value array describes how to modify
+    # the return value of the Redis call. It can be one of:
+    #
+    #   nil
+    #     Do nothing.
+    #   :all
+    #     Add the namespace to all elements returned, e.g.
+    #       key1 key2 => namespace:key1 namespace:key2
+    COMMANDS = {
+      "auth"             => [],
+      "bgrewriteaof"     => [],
+      "bgsave"           => [],
+      "blpop"            => [ :exclude_last ],
+      "brpop"            => [ :exclude_last ],
+      "dbsize"           => [],
+      "decr"             => [ :first ],
+      "decrby"           => [ :first ],
+      "del"              => [ :all   ],
+      "exists"           => [ :first ],
+      "expire"           => [ :first ],
+      "flushall"         => [],
+      "flushdb"          => [],
+      "get"              => [ :first ],
+      "getset"           => [ :first ],
+      "incr"             => [ :first ],
+      "incrby"           => [ :first ],
+      "info"             => [],
+      "keys"             => [ :first, :all ],
+      "lastsave"         => [],
+      "lindex"           => [ :first ],
+      "llen"             => [ :first ],
+      "lpop"             => [ :first ],
+      "lpush"            => [ :first ],
+      "lrange"           => [ :first ],
+      "lrem"             => [ :first ],
+      "lset"             => [ :first ],
+      "ltrim"            => [ :first ],
+      "mapped_mget"      => [ :all, :all ],
+      "mget"             => [ :all ],
+      "monitor"          => [ :monitor ],
+      "move"             => [ :first ],
+      "mset"             => [ :alternate ],
+      "msetnx"           => [ :alternate ],
+      "quit"             => [],
+      "randomkey"        => [],
+      "rename"           => [ :all ],
+      "renamenx"         => [ :all ],
+      "rpop"             => [ :first ],
+      "rpoplpush"        => [ :all ],
+      "rpush"            => [ :first ],
+      "sadd"             => [ :first ],
+      "save"             => [],
+      "scard"            => [ :first ],
+      "sdiff"            => [ :all ],
+      "sdiffstore"       => [ :all ],
+      "select"           => [],
+      "set"              => [ :first ],
+      "setnx"            => [ :first ],
+      "shutdown"         => [],
+      "sinter"           => [ :all ],
+      "sinterstore"      => [ :all ],
+      "sismember"        => [ :first ],
+      "slaveof"          => [],
+      "smembers"         => [ :first ],
+      "smove"            => [ :exclude_last ],
+      "sort"             => [ :sort  ],
+      "spop"             => [ :first ],
+      "srandmember"      => [ :first ],
+      "srem"             => [ :first ],
+      "sunion"           => [ :all ],
+      "sunionstore"      => [ :all ],
+      "ttl"              => [ :first ],
+      "type"             => [ :first ],
+      "zadd"             => [ :first ],
+      "zcard"            => [ :first ],
+      "zincrby"          => [ :first ],
+      "zrange"           => [ :first ],
+      "zrangebyscore"    => [ :first ],
+      "zrem"             => [ :first ],
+      "zremrangebyscore" => [ :first ],
+      "zrevrange"        => [ :first ],
+      "zscore"           => [ :first ],
+      "[]"               => [ :first ],
+      "[]="              => [ :first ]
+    }
+
 
     attr_accessor :namespace
 
@@ -96,48 +130,62 @@ class Redis
       method_missing(:type, key)
     end
 
-    def mapped_mget(*keys)
-      result = {}
-      mget(*keys).each do |value|
-        key = keys.shift
-        result.merge!(key => value) unless value.nil?
+    def method_missing(command, *args, &block)
+      (before, after) = COMMANDS[command.to_s] ||
+        COMMANDS[Redis::ALIASES[command.to_s]]
+
+      # Add the namespace to any parameters that are keys.
+      case before
+      when :first
+        args[0] = add_namespace(args[0]) if args[0]
+      when :all
+        args = add_namespace(args)
+      when :exclude_first
+        first = args.shift
+        args = add_namespace(args)
+        args.unshift(first) if first
+      when :exclude_last
+        last = args.pop
+        args = add_namespace(args)
+        args.push(last) if last
+      when :alternate
+        args = [ add_namespace(Hash[*args]) ]
       end
-      result
-    end
 
-    def mget(*keys)
-      keys = keys.map { |key| "#{@namespace}:#{key}"} if @namespace
-      call_command([:mget] + keys)
-    end
+      # Dispatch the command to Redis and store the result.
+      result = @redis.send(command, *args, &block)
 
-    def mset(keys)
-      call_mset(:mset, keys)
-    end
+      # Remove the namespace from results that are keys.
+      result = rem_namespace(result) if after == :all
 
-    def msetnx(keys)
-      call_mset(:msetnx, keys)
+      result
     end
 
-    def method_missing(command, *args, &block)
-      if COMMANDS.include?(command.to_s) && args[0]
-        args[0] = "#{@namespace}:#{args[0]}"
-      end
+  private
+    def add_namespace(key)
+      return key unless key && @namespace
 
-      @redis.send(command, *args, &block)
+      case key
+      when Array
+        key.map {|k| add_namespace k}
+      when Hash
+        Hash[*key.map {|k, v| [ add_namespace(k), v ]}.flatten]
+      else
+        "#{@namespace}:#{key}"
+      end
     end
 
+    def rem_namespace(key)
+      return key unless key && @namespace
 
-    private
-
-
-    def call_mset(command, keys)
-      if @namespace
-        namespaced_keys = {}
-        keys.each { |key, value| namespaced_keys["#{@namespace}:#{key}"] = value }
-        keys = namespaced_keys
+      case key
+      when Array
+        key.map {|k| rem_namespace k}
+      when Hash
+        Hash[*key.map {|k, v| [ rem_namespace(k), v ]}.flatten]
+      else
+        key.to_s.gsub /^#{@namespace}:/, ""
       end
-
-      call_command([command] + [keys])
     end
   end
 end

data/spec/redis_spec.rb

@@ -6,10 +6,10 @@ describe "redis" do
   before(:all) do
     # use database 15 for testing so we dont accidentally step on you real data
     @redis = Redis.new :db => 15
-    @namespaced = Redis::Namespace.new(:ns, :redis => @redis)
   end
 
   before(:each) do
+    @namespaced = Redis::Namespace.new(:ns, :redis => @redis)
     @namespaced.flushdb
     @redis['foo'] = 'bar'
   end
@@ -35,6 +35,17 @@ describe "redis" do
     @namespaced.type('counter').should == 'string'
   end
 
+  it "should be able to use a namespace with del" do
+    @namespaced['foo'] = 1000
+    @namespaced['bar'] = 2000
+    @namespaced['baz'] = 3000
+    @namespaced.del 'foo'
+    @namespaced['foo'].should == nil
+    @namespaced.del 'bar', 'baz'
+    @namespaced['bar'].should == nil
+    @namespaced['baz'].should == nil
+  end
+
   it "should be able to use a namespace with mget" do
     @namespaced['foo'] = 1000
     @namespaced['bar'] = 2000
@@ -54,6 +65,33 @@ describe "redis" do
     @namespaced.mapped_mget('foo', 'baz', 'bar').should == { 'foo' => '1000', 'bar' => '2000'}
   end
 
+  it "should properly intersect three sets" do
+    @namespaced.sadd('foo', 1)
+    @namespaced.sadd('foo', 2)
+    @namespaced.sadd('foo', 3)
+    @namespaced.sadd('bar', 2)
+    @namespaced.sadd('bar', 3)
+    @namespaced.sadd('bar', 4)
+    @namespaced.sadd('baz', 3)
+    @namespaced.sinter('foo', 'bar', 'baz').should == %w( 3 )
+  end
+
+  it "should properly union two sets" do
+    @namespaced.sadd('foo', 1)
+    @namespaced.sadd('foo', 2)
+    @namespaced.sadd('bar', 2)
+    @namespaced.sadd('bar', 3)
+    @namespaced.sadd('bar', 4)
+    @namespaced.sunion('foo', 'bar').sort.should == %w( 1 2 3 4 )
+  end
+
+  it "should yield the correct list of keys" do
+    @namespaced["foo"] = 1
+    @namespaced["bar"] = 2
+    @namespaced["baz"] = 3
+    @namespaced.keys("*").sort.should == %w( bar baz foo )
+  end
+
   it "can change its namespace" do
     @namespaced['foo'].should == nil
     @namespaced['foo'] = 'chris'
@@ -67,4 +105,31 @@ describe "redis" do
     @namespaced['foo'] = 'chris'
     @namespaced['foo'].should == 'chris'
   end
+
+  it "should support command aliases (delete)" do 
+    @namespaced.delete('foo')
+    @redis.should_not have_key('ns:foo')
+  end
+
+  it "should support command aliases (set_add)" do 
+    @namespaced.set_add('bar', 'quux')
+    @namespaced.smembers('bar').should include('quux')
+  end
+
+  it "should support command aliases (push_head)" do 
+    @namespaced.push_head('bar', 'quux')
+    @redis.llen('ns:bar').should == 1
+  end
+
+  it "should support command aliases (zset_add)" do 
+    @namespaced.zset_add('bar', 1, 'quux')
+    @redis.zcard('ns:bar').should == 1
+  end
+
+
+  Spec::Matchers.define :have_key do |expected|
+    match do |redis|
+      redis.exists(expected)
+    end
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: redis-namespace
 version: !ruby/object:Gem::Version 
-  version: 0.2.1
+  version: 0.3.0
 platform: ruby
 authors: 
 - Chris Wanstrath
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-02-16 00:00:00 -08:00
+date: 2010-03-12 00:00:00 -08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency