lib/redis/namespace.rb
# 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
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.

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
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 . 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
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
      args.map! {|arg| clone_args(arg)}
      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.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(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
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 args . map! { | arg | clone_args ( arg ) } 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 . 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 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 result = @redis . send ( command , * args , & block ) return result if result . is_a? ( Redis :: Future ) 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
The following tables define how input parameters and result
values should be modified for the namespace.
The following tables define how input parameters and result values should be modified for the namespace .
# Modify the local *args array in-place, no need to copy it. # Add the namespace to any parameters that are keys. # 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. # Dispatch the command to Redis and store the result. # Don't try to remove namespace from a Redis::Future, you can't. # Remove the namespace from results that are keys.
command
args
block