opengotham_redis-namespace 0.4.4

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Chris Wanstrath
+
+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,27 @@
+redis-namespace
+---------------
+
+Requires the redis gem.
+
+Namespaces all Redis calls.
+
+    r = Redis::Namespace.new(:ns, :redis => @r)
+    r['foo'] = 1000
+
+This will perform the equivalent of:
+
+    redis-cli set ns:foo 1000
+
+Useful when you have multiple systems using Redis differently in your app.
+
+
+Installation
+============
+
+    $ gem install redis-namespace
+
+
+Author
+=====
+
+Chris Wanstrath :: chris@ozmm.org

data/Rakefile

@@ -0,0 +1,32 @@
+task :default => :spec
+task :test    => :spec
+
+desc "Build a gem"
+task :gem => [ :gemspec, :build ]
+
+desc "Run specs"
+task :spec do
+  exec "spec spec/redis_spec.rb"
+end
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gemspec|
+    gemspec.name = "opengotham_redis-namespace"
+    gemspec.summary = "Namespaces Redis commands."
+    gemspec.email = "mjording@opengotham.com"
+    gemspec.homepage = "http://github.com/opengotham/redis-namespace"
+    gemspec.authors = ["Matthew Jording"]
+    gemspec.version = '0.4.4'
+    gemspec.add_dependency 'redis', ">= 2.0.0.rc2"
+    gemspec.description = <<description
+Adds a Redis::Namespace class which can be used to namespace calls
+to Redis. This is useful when using a single instance of Redis with
+multiple, different applications.
+description
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  warn "Jeweler not available. Install it with:"
+  warn "gem install jeweler"
+end

data/lib/redis/namespace.rb

@@ -0,0 +1,243 @@
+require 'redis'
+
+class Redis
+  class Namespace
+    # The following table defines how input parameters and result
+    # values should be modified for the namespace.
+    #
+    # 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 ],
+      "hset"             => [ :first ],
+      "hget"             => [ :first ],
+      "hdel"             => [ :first ],
+      "hexists"          => [ :first ],
+      "hlen"             => [ :first ],
+      "hkeys"            => [ :first ],
+      "hvals"            => [ :first ],
+      "hgetall"          => [ :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 ]
+    }
+    ALIASES = {
+          "flush_db" => "flushdb",
+          "flush_all" => "flushall",
+          "last_save" => "lastsave",
+          "key?" => "exists",
+          "delete" => "del",
+          "randkey" => "randomkey",
+          "list_length" => "llen",
+          "push_tail" => "rpush",
+          "push_head" => "lpush",
+          "pop_tail" => "rpop",
+          "pop_head" => "lpop",
+          "list_set" => "lset",
+          "list_range" => "lrange",
+          "list_trim" => "ltrim",
+          "list_index" => "lindex",
+          "list_rm" => "lrem",
+          "set_add" => "sadd",
+          "set_delete" => "srem",
+          "set_count" => "scard",
+          "set_member?" => "sismember",
+          "set_members" => "smembers",
+          "set_intersect" => "sinter",
+          "set_intersect_store" => "sinterstore",
+          "set_inter_store" => "sinterstore",
+          "set_union" => "sunion",
+          "set_union_store" => "sunionstore",
+          "set_diff" => "sdiff",
+          "set_diff_store" => "sdiffstore",
+          "set_move" => "smove",
+          "set_unless_exists" => "setnx",
+          "rename_unless_exists" => "renamenx",
+          "type?" => "type",
+          "zset_add" => "zadd",
+          "zset_count" => "zcard",
+          "zset_range_by_score" => "zrangebyscore",
+          "zset_reverse_range" => "zrevrange",
+          "zset_range" => "zrange",
+          "zset_delete" => "zrem",
+          "zset_score" => "zscore",
+          "zset_incr_by" => "zincrby",
+          "zset_increment_by" => "zincrby"
+        }
+    # support previous versions of redis gem
+    #ALIASES = (defined? Redis::Client) ? Redis::Client::ALIASES : Redis::ALIASES
+    #ALIASES = (defined? Redis::Client) ? Redis.instance_methods : Redis::ALIASES
+    attr_accessor :namespace
+
+    def initialize(namespace, options = {})
+      @namespace = namespace
+      @redis = options[:redis]
+    end
+
+    # Ruby defines a now deprecated type method so we need to override it here
+    # since it will never hit method_missing
+    def type(key)
+      method_missing(:type, key)
+    end
+
+    def method_missing(command, *args, &block)
+      (before, after) = COMMANDS[command.to_s] ||
+        COMMANDS[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
+
+      # Dispatch the command to Redis and store the result.
+      result = @redis.send(command, *args, &block)
+
+      # Remove the namespace from results that are keys.
+      result = rem_namespace(result) if after == :all
+
+      result
+    end
+
+  private
+    def add_namespace(key)
+      return key unless key && @namespace
+
+      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
+
+      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
+    end
+  end
+end

data/spec/redis_spec.rb

@@ -0,0 +1,144 @@
+require File.dirname(__FILE__) + '/spec_helper'
+require 'redis/namespace'
+require 'logger'
+
+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
+  end
+
+  before(:each) do
+    @namespaced = Redis::Namespace.new(:ns, :redis => @redis)
+    @namespaced.flushdb
+    @redis['foo'] = 'bar'
+  end
+
+  after(:each) do
+    @redis.flushdb
+  end
+
+  after(:all) do
+    @redis.quit
+  end
+
+  it "should be able to use a namespace" do
+    @namespaced['foo'].should == nil
+    @namespaced['foo'] = 'chris'
+    @namespaced['foo'].should == 'chris'
+    @redis['foo'] = 'bob'
+    @redis['foo'].should == 'bob'
+
+    @namespaced.incrby('counter', 2)
+    @namespaced['counter'].to_i.should == 2
+    @redis['counter'].should == nil
+    @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
+    @namespaced.mapped_mget('foo', 'bar').should == { 'foo' => '1000', 'bar' => '2000' }
+    @namespaced.mapped_mget('foo', 'baz', 'bar').should == {'foo'=>'1000', 'bar'=>'2000'}
+  end
+
+  it "should be able to use a namespace with mset" do
+    @namespaced.mset('foo' => '1000', 'bar' => '2000')
+    @namespaced.mapped_mget('foo', 'bar').should == { 'foo' => '1000', 'bar' => '2000' }
+    @namespaced.mapped_mget('foo', 'baz', 'bar').should == { 'foo' => '1000', 'bar' => '2000'}
+  end
+
+  it "should be able to use a namespace with msetnx" do
+    @namespaced.msetnx('foo' => '1000', 'bar' => '2000')
+    @namespaced.mapped_mget('foo', 'bar').should == { 'foo' => '1000', 'bar' => '2000' }
+    @namespaced.mapped_mget('foo', 'baz', 'bar').should == { 'foo' => '1000', 'bar' => '2000'}
+  end
+
+  it "should be able to use a namespace with hashes" do
+    @namespaced.hset('foo', 'key', 'value')
+    @namespaced.hset('foo', 'key1', 'value1')
+    @namespaced.hget('foo', 'key').should == 'value'
+    @namespaced.hgetall('foo').should == {'key' => 'value', 'key1' => 'value1'}
+    @namespaced.hlen('foo').should == 2
+    @namespaced.hkeys('foo').should == ['key', 'key1']
+  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'
+    @namespaced['foo'].should == 'chris'
+
+    @namespaced.namespace.should == :ns
+    @namespaced.namespace = :spec
+    @namespaced.namespace.should == :spec
+
+    @namespaced['foo'].should == nil
+    @namespaced['foo'] = 'chris'
+    @namespaced['foo'].should == 'chris'
+  end
+
+  it "should support command aliases (delete)" do 
+    @namespaced.del('foo')
+    @redis.should_not have_key('ns:foo')
+  end
+
+  it "should support command aliases (set_add)" do 
+    @namespaced.sadd('bar', 'quux')
+    @namespaced.smembers('bar').should include('quux')
+  end
+
+  it "should support command aliases (push_head)" do 
+    @namespaced.lpush('bar', 'quux')
+    @redis.llen('ns:bar').should == 1
+  end
+
+  it "should support command aliases (zset_add)" do 
+    @namespaced.zadd('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

data/spec/spec_helper.rb

@@ -0,0 +1,4 @@
+require 'rubygems'
+$TESTING=true
+$:.unshift File.join(File.dirname(__FILE__), '..', 'lib')
+require 'redis'

metadata

@@ -0,0 +1,87 @@
+--- !ruby/object:Gem::Specification 
+name: opengotham_redis-namespace
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 4
+  - 4
+  version: 0.4.4
+platform: ruby
+authors: 
+- Matthew Jording
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-05-06 00:00:00 -04:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: redis
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 2
+        - 0
+        - 0
+        - rc2
+        version: 2.0.0.rc2
+  type: :runtime
+  version_requirements: *id001
+description: |
+  Adds a Redis::Namespace class which can be used to namespace calls
+  to Redis. This is useful when using a single instance of Redis with
+  multiple, different applications.
+
+email: mjording@opengotham.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.md
+files: 
+- LICENSE
+- README.md
+- Rakefile
+- lib/redis/namespace.rb
+- spec/redis_spec.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/opengotham/redis-namespace
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: Namespaces Redis commands.
+test_files: 
+- spec/redis_spec.rb
+- spec/spec_helper.rb