Class: Redis::Namespace

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

Constant Summary collapse

NAMESPACED_COMMANDS =

The following tables define 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
:exclude_options
  Add the namespace to all arguments, except the last argument,
  if the last argument is a hash of options.
    ZUNIONSTORE key1 2 key2 key3 WEIGHTS 2 1 =>
    ZUNIONSTORE namespace:key1 2 namespace:key2 namespace:key3 WEIGHTS 2 1
:alternate
  Add the namespace to every other argument, e.g.
    MSET key1 value1 key2 value2 =>
    MSET namespace:key1 value1 namespace:key2 value2
:sort
  Add namespace to first argument if it is non-nil
  Add namespace to second arg's :by and :store if second arg is a Hash
  Add namespace to each element in second arg's :get if second arg is
    a Hash; forces second arg's :get to be an Array if present.
:eval_style
  Add namespace to each element in keys argument (via options hash or multi-args)
:scan_style
  Add namespace to :match option, or supplies "#{namespace}:*" if not present.

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

{
  "append"           => [ :first ],
  "bitcount"         => [ :first ],
  "bitop"            => [ :exclude_first ],
  "bitpos"           => [ :first ],
  "blpop"            => [ :exclude_last, :first ],
  "brpop"            => [ :exclude_last, :first ],
  "brpoplpush"       => [ :exclude_last ],
  "bzpopmin"         => [ :first ],
  "bzpopmax"         => [ :first ],
  "debug"            => [ :exclude_first ],
  "decr"             => [ :first ],
  "decrby"           => [ :first ],
  "del"              => [ :all   ],
  "dump"             => [ :first ],
  "exists"           => [ :all ],
  "exists?"          => [ :all ],
  "expire"           => [ :first ],
  "expireat"         => [ :first ],
  "eval"             => [ :eval_style ],
  "evalsha"          => [ :eval_style ],
  "get"              => [ :first ],
  "getex"            => [ :first ],
  "getbit"           => [ :first ],
  "getrange"         => [ :first ],
  "getset"           => [ :first ],
  "hset"             => [ :first ],
  "hsetnx"           => [ :first ],
  "hget"             => [ :first ],
  "hincrby"          => [ :first ],
  "hincrbyfloat"     => [ :first ],
  "hmget"            => [ :first ],
  "hmset"            => [ :first ],
  "hdel"             => [ :first ],
  "hexists"          => [ :first ],
  "hlen"             => [ :first ],
  "hkeys"            => [ :first ],
  "hscan"            => [ :first ],
  "hscan_each"       => [ :first ],
  "hvals"            => [ :first ],
  "hgetall"          => [ :first ],
  "incr"             => [ :first ],
  "incrby"           => [ :first ],
  "incrbyfloat"      => [ :first ],
  "keys"             => [ :first, :all ],
  "lindex"           => [ :first ],
  "linsert"          => [ :first ],
  "llen"             => [ :first ],
  "lpop"             => [ :first ],
  "lpush"            => [ :first ],
  "lpushx"           => [ :first ],
  "lrange"           => [ :first ],
  "lrem"             => [ :first ],
  "lset"             => [ :first ],
  "ltrim"            => [ :first ],
  "mapped_hmset"     => [ :first ],
  "mapped_hmget"     => [ :first ],
  "mapped_mget"      => [ :all, :all ],
  "mapped_mset"      => [ :all ],
  "mapped_msetnx"    => [ :all ],
  "mget"             => [ :all ],
  "monitor"          => [ :monitor ],
  "move"             => [ :first ],
  "mset"             => [ :alternate ],
  "msetnx"           => [ :alternate ],
  "object"           => [ :exclude_first ],
  "persist"          => [ :first ],
  "pexpire"          => [ :first ],
  "pexpireat"        => [ :first ],
  "pfadd"            => [ :first ],
  "pfcount"          => [ :all ],
  "pfmerge"          => [ :all ],
  "psetex"           => [ :first ],
  "psubscribe"       => [ :all ],
  "pttl"             => [ :first ],
  "publish"          => [ :first ],
  "punsubscribe"     => [ :all ],
  "rename"           => [ :all ],
  "renamenx"         => [ :all ],
  "restore"          => [ :first ],
  "rpop"             => [ :first ],
  "rpoplpush"        => [ :all ],
  "rpush"            => [ :first ],
  "rpushx"           => [ :first ],
  "sadd"             => [ :first ],
  "scard"            => [ :first ],
  "scan"             => [ :scan_style, :second ],
  "scan_each"        => [ :scan_style, :all ],
  "sdiff"            => [ :all ],
  "sdiffstore"       => [ :all ],
  "set"              => [ :first ],
  "setbit"           => [ :first ],
  "setex"            => [ :first ],
  "setnx"            => [ :first ],
  "setrange"         => [ :first ],
  "sinter"           => [ :all ],
  "sinterstore"      => [ :all ],
  "sismember"        => [ :first ],
  "smembers"         => [ :first ],
  "smismember"       => [ :first ],
  "smove"            => [ :exclude_last ],
  "sort"             => [ :sort  ],
  "spop"             => [ :first ],
  "srandmember"      => [ :first ],
  "srem"             => [ :first ],
  "sscan"            => [ :first ],
  "sscan_each"       => [ :first ],
  "strlen"           => [ :first ],
  "subscribe"        => [ :all ],
  "sunion"           => [ :all ],
  "sunionstore"      => [ :all ],
  "ttl"              => [ :first ],
  "type"             => [ :first ],
  "unlink"           => [ :all   ],
  "unsubscribe"      => [ :all ],
  "zadd"             => [ :first ],
  "zcard"            => [ :first ],
  "zcount"           => [ :first ],
  "zincrby"          => [ :first ],
  "zinterstore"      => [ :exclude_options ],
  "zpopmin"          => [ :first ],
  "zpopmax"          => [ :first ],
  "zrange"           => [ :first ],
  "zrangebyscore"    => [ :first ],
  "zrangebylex"      => [ :first ],
  "zrank"            => [ :first ],
  "zrem"             => [ :first ],
  "zremrangebyrank"  => [ :first ],
  "zremrangebyscore" => [ :first ],
  "zremrangebylex"   => [ :first ],
  "zrevrange"        => [ :first ],
  "zrevrangebyscore" => [ :first ],
  "zrevrangebylex"   => [ :first ],
  "zrevrank"         => [ :first ],
  "zscan"            => [ :first ],
  "zscan_each"       => [ :first ],
  "zscore"           => [ :first ],
  "zunionstore"      => [ :exclude_options ]
}
TRANSACTION_COMMANDS = 
{
  "discard"          => [],
  "exec"             => [],
  "multi"            => [],
  "unwatch"          => [ :all ],
  "watch"            => [ :all ],
}
HELPER_COMMANDS = 
{
  "auth"             => [],
  "disconnect!"      => [],
  "echo"             => [],
  "ping"             => [],
  "time"             => [],
}
ADMINISTRATIVE_COMMANDS = 
{
  "bgrewriteaof"     => [],
  "bgsave"           => [],
  "config"           => [],
  "dbsize"           => [],
  "flushall"         => [],
  "flushdb"          => [],
  "info"             => [],
  "lastsave"         => [],
  "quit"             => [],
  "randomkey"        => [],
  "save"             => [],
  "script"           => [],
  "select"           => [],
  "shutdown"         => [],
  "slaveof"          => [],
}
DEPRECATED_COMMANDS = 
[
  ADMINISTRATIVE_COMMANDS
].compact.reduce(:merge)
COMMANDS = 
[
  NAMESPACED_COMMANDS,
  TRANSACTION_COMMANDS,
  HELPER_COMMANDS,
  ADMINISTRATIVE_COMMANDS,
].compact.reduce(:merge)
Enumerator =

Support 1.8.7 by providing a namespaced reference to Enumerable::Enumerator

Enumerable::Enumerator
VERSION = 
'1.9.0'

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

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

Returns a new instance of Namespace.



245
246
247
248
249
250
251
252
253
254
255
 
# File 'lib/redis/namespace.rb', line 245

def initialize(namespace, options = {})
  @namespace = namespace
  @redis = options[:redis] || Redis.new
  @warning = !!options.fetch(:warning) do
               !ENV['REDIS_NAMESPACE_QUIET']
             end
  @deprecations = !!options.fetch(:deprecations) do
                    ENV['REDIS_NAMESPACE_DEPRECATIONS']
                  end
  @has_new_client_method = @redis.respond_to?(:_client)
end

Dynamic Method Handling

This class handles dynamic methods through the method_missing method

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



359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
 
# File 'lib/redis/namespace.rb', line 359

def method_missing(command, *args, &block)
  normalized_command = command.to_s.downcase

  if COMMANDS.include?(normalized_command)
    send(normalized_command, *args, &block)
  elsif @redis.respond_to?(normalized_command) && !deprecations?
    # blind passthrough is deprecated and will be removed in 2.0
    # redis-namespace does not know how to handle this command.
    # Passing it to @redis as is, where redis-namespace shows
    # a warning message if @warning is set.
    if warning?
      warn("Passing '#{command}' command to redis as is; blind " +
           "passthrough has been deprecated and will be removed in " +
           "redis-namespace 2.0 (at #{call_site})")
    end
    @redis.send(command, *args, &block)
  else
    super
  end
end

Instance Attribute Details

#namespace(desired_namespace = nil) ⇒ Object 



306
307
308
309
310
311
312
313
 
# File 'lib/redis/namespace.rb', line 306

def namespace(desired_namespace = nil)
  if desired_namespace
    yield Redis::Namespace.new(desired_namespace,
                               :redis => @redis)
  end

  @namespace.respond_to?(:call) ? @namespace.call : @namespace
end

#redis ⇒ Object

Returns the value of attribute redis.



242
243
244
 
# File 'lib/redis/namespace.rb', line 242

def redis
  @redis
end

#warning ⇒ Object

Returns the value of attribute warning.



243
244
245
 
# File 'lib/redis/namespace.rb', line 243

def warning
  @warning
end

Instance Method Details

#_client ⇒ Object 



271
272
273
 
# File 'lib/redis/namespace.rb', line 271

def _client
  @has_new_client_method ? @redis._client : @redis.client # for redis-4.0.0
end

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



399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
 
# File 'lib/redis/namespace.rb', line 399

def call_with_namespace(command, *args, &block)
  handling = COMMANDS[command.to_s.downcase]

  if handling.nil?
    fail("Redis::Namespace does not know how to handle '#{command}'.")
  end

  (before, after) = handling

  # Modify the local *args array in-place, no need to copy it.
  args.map! {|arg| clone_args(arg)}

  # Add the namespace to any parameters that are keys.
  case before
  when :first
    args[0] = add_namespace(args[0]) if args[0]
    args[-1] = ruby2_keywords_hash(args[-1]) if args[-1].is_a?(Hash)
  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 unless args.length == 1
    args = add_namespace(args)
    args.push(last) if last
  when :exclude_options
    if args.last.is_a?(Hash)
      last = ruby2_keywords_hash(args.pop)
      args = add_namespace(args)
      args.push(last)
    else
      args = add_namespace(args)
    end
  when :alternate
    args = args.flatten
    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]
    if args[1].is_a?(Hash)
      [:by, :store].each do |key|
        args[1][key] = add_namespace(args[1][key]) if args[1][key]
      end

      args[1][:get] = Array(args[1][:get])

      args[1][:get].each_index do |i|
        args[1][:get][i] = add_namespace(args[1][:get][i]) unless args[1][:get][i] == "#"
      end
      args[1] = ruby2_keywords_hash(args[1])
    end
  when :eval_style
    # redis.eval() and evalsha() can either take the form:
    #
    #   redis.eval(script, [key1, key2], [argv1, argv2])
    #
    # Or:
    #
    #   redis.eval(script, :keys => ['k1', 'k2'], :argv => ['arg1', 'arg2'])
    #
    # This is a tricky + annoying special case, where we only want the `keys`
    # argument to be namespaced.
    if args.last.is_a?(Hash)
      args.last[:keys] = add_namespace(args.last[:keys])
    else
      args[1] = add_namespace(args[1])
    end
  when :scan_style
    options = (args.last.kind_of?(Hash) ? args.pop : {})
    options[:match] = add_namespace(options.fetch(:match, '*'))
    args << ruby2_keywords_hash(options)

    if block
      original_block = block
      block = proc { |key| original_block.call rem_namespace(key) }
    end
  end

  # Dispatch the command to Redis and store the result.
  result = @redis.send(command, *args, &block)

  # Don't try to remove namespace from a Redis::Future, you can't.
  return result if result.is_a?(Redis::Future)

  # Remove the namespace from results that are keys.
  case after
  when :all
    result = rem_namespace(result)
  when :first
    result[0] = rem_namespace(result[0]) if result
  when :second
    result[1] = rem_namespace(result[1]) if result
  end

  result
end

#client ⇒ Object 



265
266
267
268
269
 
# File 'lib/redis/namespace.rb', line 265

def client
  warn("The client method is deprecated as of redis-rb 4.0.0, please use the new _client " +
        "method instead. Support for the old method will be removed in redis-namespace 2.0.") if @has_new_client_method && deprecations?
  _client
end

#connection ⇒ Object 



319
320
321
 
# File 'lib/redis/namespace.rb', line 319

def connection
  @redis.connection.tap { |info| info[:namespace] = namespace }
end

#deprecations? ⇒ Boolean

Returns:

  • (Boolean) 


257
258
259
 
# File 'lib/redis/namespace.rb', line 257

def deprecations?
  @deprecations
end

#eval(*args) ⇒ Object 



327
328
329
 
# File 'lib/redis/namespace.rb', line 327

def eval(*args)
  call_with_namespace(:eval, *args)
end

#exec ⇒ Object 



323
324
325
 
# File 'lib/redis/namespace.rb', line 323

def exec
  call_with_namespace(:exec)
end

#full_namespace ⇒ Object 



315
316
317
 
# File 'lib/redis/namespace.rb', line 315

def full_namespace
  redis.is_a?(Namespace) ? "#{redis.full_namespace}:#{namespace}" : namespace.to_s
end

#inspect ⇒ Object 



381
382
383
384
 
# File 'lib/redis/namespace.rb', line 381

def inspect
  "<#{self.class.name} v#{VERSION} with client v#{Redis::VERSION} "\
  "for #{@redis.id}/#{full_namespace}>"
end

#keys(query = nil) ⇒ Object 



290
291
292
 
# File 'lib/redis/namespace.rb', line 290

def keys(query = nil)
  call_with_namespace(:keys, query || '*')
end

#multi(&block) ⇒ Object 



294
295
296
297
298
299
300
 
# File 'lib/redis/namespace.rb', line 294

def multi(&block)
  if block_given?
    namespaced_block(:multi, &block)
  else
    call_with_namespace(:multi)
  end
end

#pipelined(&block) ⇒ Object 



302
303
304
 
# File 'lib/redis/namespace.rb', line 302

def pipelined(&block)
  namespaced_block(:pipelined, &block)
end

#respond_to?(command, include_private = false) ⇒ Boolean

emulate Ruby 1.9+ and keep respond_to_missing? logic together.

Returns:

  • (Boolean) 


284
285
286
287
288
 
# File 'lib/redis/namespace.rb', line 284

def respond_to?(command, include_private=false)
  return !deprecations? if DEPRECATED_COMMANDS.include?(command.to_s.downcase)

  respond_to_missing?(command, include_private) or super
end

#respond_to_missing?(command, include_all = false) ⇒ Boolean

Returns:

  • (Boolean) 


386
387
388
389
390
391
392
393
394
395
396
397
 
# File 'lib/redis/namespace.rb', line 386

def respond_to_missing?(command, include_all=false)
  normalized_command = command.to_s.downcase

  case
  when COMMANDS.include?(normalized_command)
    true
  when !deprecations? && redis.respond_to?(command, include_all)
    true
  else
    defined?(super) && super
  end
end

#self_respond_to? ⇒ Object 



281
 
# File 'lib/redis/namespace.rb', line 281

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



277
278
279
 
# File 'lib/redis/namespace.rb', line 277

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

#warning? ⇒ Boolean

Returns:

  • (Boolean) 


261
262
263
 
# File 'lib/redis/namespace.rb', line 261

def warning?
  @warning
end