Class: Redis::Namespace

Inherits:
Object
  • Object
show all
Defined in:
lib/redis/namespace.rb

Constant Summary collapse

COMMANDS =

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

{
  "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 ]
}

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(namespace, options = {}) ⇒ Namespace

Returns a new instance of Namespace.



122
123
124
125
 
# File 'lib/redis/namespace.rb', line 122

def initialize(namespace, options = {})
  @namespace = namespace
  @redis = options[:redis]
end

Dynamic Method Handling

This class handles dynamic methods through the method_missing method

#method_missing(command, *args, &block) ⇒ Object 



133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
 
# File 'lib/redis/namespace.rb', line 133

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

  # 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

Instance Attribute Details

#namespace ⇒ Object

Returns the value of attribute namespace.



120
121
122
 
# File 'lib/redis/namespace.rb', line 120

def namespace
  @namespace
end

Instance Method Details

#type(key) ⇒ Object

Ruby defines a now deprecated type method so we need to override it here since it will never hit method_missing



129
130
131
 
# File 'lib/redis/namespace.rb', line 129

def type(key)
  method_missing(:type, key)
end