Class: Redis::Namespace
- Inherits:
-
Object
- Object
- Redis::Namespace
- 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" => [], "debug" => [ :exclude_first ], "decr" => [ :first ], "decrby" => [ :first ], "del" => [ :all ], "exists" => [ :first ], "expire" => [ :first ], "flushall" => [], "flushdb" => [], "get" => [ :first ], "getset" => [ :first ], "hset" => [ :first ], "hsetnx" => [ :first ], "hget" => [ :first ], "hincrby" => [ :first ], "hmget" => [ :first ], "hmset" => [ :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_hmset" => [ :first ], "mapped_mget" => [ :all, :all ], "mget" => [ :all ], "monitor" => [ :monitor ], "move" => [ :first ], "mset" => [ :alternate ], "msetnx" => [ :alternate ], "psubscribe" => [ :all ], "publish" => [ :first ], "punsubscribe" => [ :all ], "quit" => [], "randomkey" => [], "rename" => [ :all ], "renamenx" => [ :all ], "rpop" => [ :first ], "rpoplpush" => [ :all ], "rpush" => [ :first ], "sadd" => [ :first ], "save" => [], "scard" => [ :first ], "sdiff" => [ :all ], "sdiffstore" => [ :all ], "select" => [], "set" => [ :first ], "setex" => [ :first ], "setnx" => [ :first ], "shutdown" => [], "sinter" => [ :all ], "sinterstore" => [ :all ], "sismember" => [ :first ], "slaveof" => [], "smembers" => [ :first ], "smove" => [ :exclude_last ], "sort" => [ :sort ], "spop" => [ :first ], "srandmember" => [ :first ], "srem" => [ :first ], "subscribe" => [ :all ], "sunion" => [ :all ], "sunionstore" => [ :all ], "ttl" => [ :first ], "type" => [ :first ], "unsubscribe" => [ :all ], "watch" => [ :all ], "zadd" => [ :first ], "zcard" => [ :first ], "zcount" => [ :first ], "zincrby" => [ :first ], "zrange" => [ :first ], "zrangebyscore" => [ :first ], "zrank" => [ :first ], "zrem" => [ :first ], "zremrangebyrank" => [ :first ], "zremrangebyscore" => [ :first ], "zrevrange" => [ :first ], "zrevrank" => [ :first ], "zscore" => [ :first ], "[]" => [ :first ], "[]=" => [ :first ] }
- ALIASES =
support previous versions of redis gem
case when defined? Redis::Client::ALIASES then Redis::Client::ALIASES when defined? Redis::ALIASES then Redis::ALIASES else {} end
Instance Attribute Summary collapse
-
#namespace ⇒ Object
Returns the value of attribute namespace.
Instance Method Summary collapse
-
#initialize(namespace, options = {}) ⇒ Namespace
constructor
A new instance of Namespace.
- #keys(query = nil) ⇒ Object
- #method_missing(command, *args, &block) ⇒ Object
- #respond_to?(*args) ⇒ Boolean
- #self_respond_to? ⇒ Object
-
#type(key) ⇒ Object
Ruby defines a now deprecated type method so we need to override it here since it will never hit method_missing.
Constructor Details
#initialize(namespace, options = {}) ⇒ Namespace
Returns a new instance of Namespace.
153 154 155 156 |
# File 'lib/redis/namespace.rb', line 153 def initialize(namespace, = {}) @namespace = namespace @redis = [:redis] end |
Dynamic Method Handling
This class handles dynamic methods through the method_missing method
#method_missing(command, *args, &block) ⇒ Object
178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 |
# File 'lib/redis/namespace.rb', line 178 def method_missing(command, *args, &block) handling = COMMANDS[command.to_s] || COMMANDS[ALIASES[command.to_s]] # redis-namespace does not know how to handle this command. # Passing it to @redis as is. if handling.nil? return @redis.send(command, *args, &block) end (before, after) = handling # 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.each_with_index { |a, i| args[i] = add_namespace(a) if i.even? } when :sort args[0] = add_namespace(args[0]) if args[0] [:by, :get, :store].each do |key| args[1][key] = add_namespace(args[1][key]) if args[1][key] end if args[1].is_a?(Hash) 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.
151 152 153 |
# File 'lib/redis/namespace.rb', line 151 def namespace @namespace end |
Instance Method Details
#keys(query = nil) ⇒ Object
174 175 176 |
# File 'lib/redis/namespace.rb', line 174 def keys(query = nil) query.nil? ? super("*") : super end |
#respond_to?(*args) ⇒ Boolean
166 167 168 169 170 171 172 |
# File 'lib/redis/namespace.rb', line 166 def respond_to?(*args) if self_respond_to?(*args) true else @redis.respond_to?(*args) end end |
#self_respond_to? ⇒ Object
164 |
# File 'lib/redis/namespace.rb', line 164 alias_method :self_respond_to?, :respond_to? |
#type(key) ⇒ Object
Ruby defines a now deprecated type method so we need to override it here since it will never hit method_missing
160 161 162 |
# File 'lib/redis/namespace.rb', line 160 def type(key) method_missing(:type, key) end |