redis-namespace 1.5.2 → 1.5.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d8a331998a5b4c5b9f5f323da912dc2e4555a2db
+  data.tar.gz: da08789df8269adf261ff47f7c1da894718ddc88
+SHA512:
+  metadata.gz: 68d3325257b3c5a9ba0a7e461c39d30ce9de639304e8926e809e5f51256c5da41a8cdb2f29a5c2cd5c700032dc6d4e5b42be3e29327bcdaf0439c93f4db03f0a
+  data.tar.gz: cffdb70935cade3a38e66e46a71ad9082afb074ebbbc05627113b6504e5b6337ec8c917734eeaf871e6dea271e9483bdfa11b22bdf1b772eab04e0f973fc3bdc

data/README.md

@@ -1,38 +1,106 @@
 redis-namespace
----------------
+===============
 
-Requires the redis gem.
+Redis::Namespace provides an interface to a namespaced subset of your [redis][] keyspace (e.g., keys with a common beginning), and requires the [redis-rb][] gem.
 
-Namespaces all Redis calls.
+~~~ irb
+require 'redis-namespace'
+# => true
 
-``` ruby
-r = Redis::Namespace.new(:ns, :redis => @r)
-r['foo'] = 1000
-```
+redis_connection = Redis.new
+# => #<Redis client v3.1.0 for redis://127.0.0.1:6379/0>
+namespaced_redis = Redis::Namespace.new(:ns, :redis => redis_connection)
+# => #<Redis::Namespace v1.5.0 with client v3.1.0 for redis://127.0.0.1:6379/0/ns>
 
-This will perform the equivalent of:
+namespaced_redis.set('foo', 'bar') # redis_connection.set('ns:foo', 'bar')
+# => "OK"
 
-    redis-cli set ns:foo 1000
+# Redis::Namespace automatically prepended our namespace to the key
+# before sending it to our redis client.
 
-Useful when you have multiple systems using Redis differently in your app.
+namespaced_redis.get('foo')
+# => "bar"
+redis_connection.get('ns:foo')
+# => "bar"
 
+namespaced_redis.del('foo')
+# => 1
+namespaced_redis.get('foo')
+# => nil
+redis_connection.get('ns:foo')
+# => nil
+~~~
 
 Installation
 ============
 
+Redis::Namespace is packaged as the redis-namespace gem, and hosted on rubygems.org.
+
+From the command line:
+
     $ gem install redis-namespace
 
+Or in your Gemfile:
 
+~~~ ruby
+gem 'redis-namespace'
+~~~
 
-Testing
+Caveats
 =======
 
-    $ bundle install
-    $ rake
+`Redis::Namespace` provides a namespaced interface to `Redis` by keeping an internal registry of the method signatures in `Redis` provided by the redis-rb gem;
+we keep track of which arguments need the namespace added, and which return values need the namespace removed.
+
+Blind Passthrough
+-----------------
+If your version of this gem doesn't know about a particular command, it can't namespace it.
+Historically, this has meant that Redis::Namespace blindly passes unknown commands on to the underlying redis connection without modification which can lead to surprising effects.
+
+As of v1.5.0, blind passthrough has been deprecated, and the functionality will be removed entirely in 2.0.
+
+If you come across a command that is not yet supported, please open an issue on the [issue tracker][] or submit a pull-request.
+
+Administrative Commands
+-----------------------
+The effects of some redis commands cannot be limited to a particular namespace (e.g., `FLUSHALL`, which literally truncates all databases in your redis server, regardless of keyspace).
+Historically, this has meant that Redis::Namespace intentionally passes administrative commands on to the underlying redis connection without modification, which can lead to surprising effects.
+
+As of v1.6.0, the direct use of administrative commands has been deprecated, and the functionality will be removed entirely in 2.0;
+while such commands are often useful for testing or administration, their meaning is inherently hidden when placed behind an interface that implies it will namespace everything.
+
+The prefered way to send an administrative command is on the redis connection
+itself, which is publicly exposed as `Redis::Namespace#redis`:
+
+~~~ ruby
+namespaced.redis.flushall()
+# => "OK"
+~~~
+
+2.x Planned Breaking Changes
+============================
+
+As mentioned above, 2.0 will remove blind passthrough and the administrative command passthrough.
+By default in 1.5+, deprecation warnings are present and enabled;
+they can be silenced by initializing `Redis::Namespace` with `warnings: false` or by setting the `REDIS_NAMESPACE_QUIET` environment variable.
+
+Early opt-in
+------------
+
+To enable testing against the 2.x interface before its release, in addition to deprecation warnings, early opt-in to these changes can be enabled by initializing `Redis::Namespace` with `deprecations: true` or by setting the `REDIS_NAMESPACE_DEPRECATIONS` environment variable.
+This should only be done once all warnings have been addressed.
+
+Authors
+=======
 
+While there are many authors who have contributed to this project, the following have done so on an ongoing basis with at least 5 commits:
 
-Author
-=====
+ - Chris Wanstrath (@defunkt)
+ - Ryan Biesemeyer (@yaauie)
+ - Steve Klabnik (@steveklabnik)
+ - Terence Lee (@hone)
+ - Eoin Coffey (@ecoffey)
 
-Chris Wanstrath :: chris@ozmm.org
-Terence Lee :: hone02@gmail.com
+[redis]: http://redis.io
+[redis-rb]: https://github.com/redis/redis-rb
+[issue tracker]: https://github.com/resque/redis-namespace/issues

data/lib/redis/namespace.rb

@@ -3,7 +3,7 @@ require 'redis/namespace/version'
 
 class Redis
   class Namespace
-    # The following table defines how input parameters and result
+    # 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
@@ -53,34 +53,23 @@ class Redis
     #   :all
     #     Add the namespace to all elements returned, e.g.
     #       key1 key2 => namespace:key1 namespace:key2
-    COMMANDS = {
-      "append"           => [:first],
-      "auth"             => [],
-      "bgrewriteaof"     => [],
-      "bgsave"           => [],
+    NAMESPACED_COMMANDS = {
+      "append"           => [ :first ],
       "bitcount"         => [ :first ],
       "bitop"            => [ :exclude_first ],
       "blpop"            => [ :exclude_last, :first ],
       "brpop"            => [ :exclude_last, :first ],
       "brpoplpush"       => [ :exclude_last ],
-      "config"           => [],
-      "dbsize"           => [],
       "debug"            => [ :exclude_first ],
       "decr"             => [ :first ],
       "decrby"           => [ :first ],
       "del"              => [ :all   ],
-      "discard"          => [],
-      "disconnect!"      => [],
       "dump"             => [ :first ],
-      "echo"             => [],
       "exists"           => [ :first ],
       "expire"           => [ :first ],
       "expireat"         => [ :first ],
       "eval"             => [ :eval_style ],
       "evalsha"          => [ :eval_style ],
-      "exec"             => [],
-      "flushall"         => [],
-      "flushdb"          => [],
       "get"              => [ :first ],
       "getbit"           => [ :first ],
       "getrange"         => [ :first ],
@@ -103,9 +92,7 @@ class Redis
       "incr"             => [ :first ],
       "incrby"           => [ :first ],
       "incrbyfloat"      => [ :first ],
-      "info"             => [],
       "keys"             => [ :first, :all ],
-      "lastsave"         => [],
       "lindex"           => [ :first ],
       "linsert"          => [ :first ],
       "llen"             => [ :first ],
@@ -124,7 +111,6 @@ class Redis
       "mget"             => [ :all ],
       "monitor"          => [ :monitor ],
       "move"             => [ :first ],
-      "multi"            => [],
       "mset"             => [ :alternate ],
       "msetnx"           => [ :alternate ],
       "object"           => [ :exclude_first ],
@@ -134,14 +120,11 @@ class Redis
       "pfadd"            => [ :first ],
       "pfcount"          => [ :all ],
       "pfmerge"          => [ :all ],
-      "ping"             => [],
       "psetex"           => [ :first ],
       "psubscribe"       => [ :all ],
       "pttl"             => [ :first ],
       "publish"          => [ :first ],
       "punsubscribe"     => [ :all ],
-      "quit"             => [],
-      "randomkey"        => [],
       "rename"           => [ :all ],
       "renamenx"         => [ :all ],
       "restore"          => [ :first ],
@@ -150,24 +133,19 @@ class Redis
       "rpush"            => [ :first ],
       "rpushx"           => [ :first ],
       "sadd"             => [ :first ],
-      "save"             => [],
       "scard"            => [ :first ],
       "scan"             => [ :scan_style, :second ],
       "scan_each"        => [ :scan_style, :all ],
-      "script"           => [],
       "sdiff"            => [ :all ],
       "sdiffstore"       => [ :all ],
-      "select"           => [],
       "set"              => [ :first ],
       "setbit"           => [ :first ],
       "setex"            => [ :first ],
       "setnx"            => [ :first ],
       "setrange"         => [ :first ],
-      "shutdown"         => [],
       "sinter"           => [ :all ],
       "sinterstore"      => [ :all ],
       "sismember"        => [ :first ],
-      "slaveof"          => [],
       "smembers"         => [ :first ],
       "smove"            => [ :exclude_last ],
       "sort"             => [ :sort  ],
@@ -183,8 +161,6 @@ class Redis
       "ttl"              => [ :first ],
       "type"             => [ :first ],
       "unsubscribe"      => [ :all ],
-      "unwatch"          => [ :all ],
-      "watch"            => [ :all ],
       "zadd"             => [ :first ],
       "zcard"            => [ :first ],
       "zcount"           => [ :first ],
@@ -206,6 +182,48 @@ class Redis
       "[]"               => [ :first ],
       "[]="              => [ :first ]
     }
+    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)
 
     # Support 1.8.7 by providing a namespaced reference to Enumerable::Enumerator
     Enumerator = Enumerable::Enumerator unless defined?(::Enumerator)
@@ -286,7 +304,20 @@ class Redis
     def method_missing(command, *args, &block)
       normalized_command = command.to_s.downcase
 
-      if COMMANDS.include?(normalized_command)
+      if ADMINISTRATIVE_COMMANDS.include?(normalized_command)
+        # administrative commands usage is deprecated and will be removed in 2.0
+        # redis-namespace cannot safely apply a namespace to their effects.
+        return super if deprecations?
+        if warning?
+          warn("Passing '#{normalized_command}' command to redis as is; " +
+               "administrative commands cannot be effectively namespaced " +
+               "and should be called on the redis connection directly; " +
+               "passthrough has been deprecated and will be removed in " +
+               "redis-namespace 2.0 (at #{call_site})"
+               )
+        end
+        call_with_namespace(command, *args, &block)
+      elsif COMMANDS.include?(normalized_command)
         call_with_namespace(command, *args, &block)
       elsif @redis.respond_to?(normalized_command) && !deprecations?
         # blind passthrough is deprecated and will be removed in 2.0
@@ -294,7 +325,6 @@ class Redis
         # Passing it to @redis as is, where redis-namespace shows
         # a warning message if @warning is set.
         if warning?
-          call_site = caller.reject { |l| l.start_with?(__FILE__) }.first
           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})")
@@ -305,15 +335,24 @@ class Redis
       end
     end
 
+    def inspect
+      "<#{self.class.name} v#{VERSION} with client v#{Redis::VERSION} "\
+      "for #{@redis.id}/#{@namespace}>"
+    end
+
     def respond_to_missing?(command, include_all=false)
-      return true if COMMANDS.include?(command.to_s.downcase)
+      normalized_command = command.to_s.downcase
 
-      # blind passthrough is deprecated and will be removed in 2.0
-      if @redis.respond_to?(command, include_all) && !deprecations?
-        return true
+      case
+      when DEPRECATED_COMMANDS.include?(normalized_command)
+        !deprecations?
+      when COMMANDS.include?(normalized_command)
+        true
+      when !deprecations? && redis.respond_to?(command, include_all)
+        true
+      else
+        defined?(super) && super
       end
-
-      defined?(super) && super
     end
 
     def call_with_namespace(command, *args, &block)
@@ -325,6 +364,9 @@ class Redis
 
       (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
@@ -410,6 +452,21 @@ class Redis
 
   private
 
+    # Avoid modifying the caller's (pass-by-reference) arguments.
+    def clone_args(arg)
+      if arg.is_a?(Array)
+        arg.map {|sub_arg| clone_args(sub_arg)}
+      elsif arg.is_a?(Hash)
+        Hash[arg.map {|k, v| [clone_args(k), clone_args(v)]}]
+      else
+        arg # Some objects (e.g. symbol) can't be dup'd.
+      end
+    end
+
+    def call_site
+      caller.reject { |l| l.start_with?(__FILE__) }.first
+    end
+
     def namespaced_block(command, &block)
       redis.send(command) do |r|
         begin
@@ -426,9 +483,10 @@ class Redis
 
       case key
       when Array
-        key.map {|k| add_namespace k}
+        key.map! {|k| add_namespace k}
       when Hash
-        Hash[*key.map {|k, v| [ add_namespace(k), v ]}.flatten]
+        key.keys.each {|k| key[add_namespace(k)] = key.delete(k)}
+        key
       else
         "#{@namespace}:#{key}"
       end

data/lib/redis/namespace/version.rb

@@ -2,6 +2,6 @@
 
 class Redis
   class Namespace
-    VERSION = '1.5.2'
+    VERSION = '1.5.3'
   end
 end

data/spec/deprecation_spec.rb

@@ -34,6 +34,7 @@ describe Redis::Namespace do
       allow(redis).to receive(:unhandled) do |*args| 
         "unhandled(#{args.inspect})"
       end
+      allow(redis).to receive(:flushdb).and_return("OK")
     end
 
     # This behaviour will hold true after the 2.x migration
@@ -50,6 +51,16 @@ describe Redis::Namespace do
           end.to raise_exception NoMethodError
         end
       end
+
+      context('with an administrative command') do
+        it { should_not respond_to :flushdb }
+
+        it('raises a NoMethodError') do
+          expect do
+            namespaced.flushdb
+          end.to raise_exception NoMethodError
+        end
+      end
     end
 
     # This behaviour will no longer be available after the 2.x migration
@@ -77,6 +88,7 @@ describe Redis::Namespace do
 
           expect(warning).to_not be_empty
           expect(warning).to include %q(Passing 'unhandled' command to redis as is)
+          expect(warning).to include %q(blind passthrough)
           expect(warning).to include __FILE__
         end
 
@@ -87,10 +99,30 @@ describe Redis::Namespace do
               namespaced.unhandled('bar')
             end
             warning = stderr.tap(&:rewind).read
+
             expect(warning).to be_empty
           end
         end
       end
+
+      context('with an administrative command') do
+        it { should respond_to :flushdb }
+        it 'processes the command' do
+          expect(redis).to receive(:flushdb)
+          capture_stderr { namespaced.flushdb }
+        end
+        it 'warns with helpful output' do
+          capture_stderr(stderr = StringIO.new) do
+            namespaced.flushdb
+          end
+          warning = stderr.tap(&:rewind).read
+
+          expect(warning).to_not be_empty
+          expect(warning).to include %q(Passing 'flushdb' command to redis as is)
+          expect(warning).to include %q(administrative)
+          expect(warning).to include __FILE__
+        end
+      end
     end
   end
 end

data/spec/redis_spec.rb

@@ -12,7 +12,7 @@ describe "redis" do
 
   before(:each) do
     @namespaced = Redis::Namespace.new(:ns, :redis => @redis)
-    @namespaced.flushdb
+    @redis.flushdb
     @redis['foo'] = 'bar'
   end
 
@@ -485,9 +485,17 @@ describe "redis" do
           should eq(%w[ns:k1 ns:k2])
       end
 
+      it "should namespace eval keys passed in as hash args unmodified" do
+        args = { :keys => %w[k1 k2], :argv => %w[arg1 arg2] }
+        args.freeze
+        @namespaced.
+          eval("return {KEYS[1], KEYS[2]}", args).
+          should eq(%w[ns:k1 ns:k2])
+      end
+
       context '#evalsha' do
         let!(:sha) do
-          @namespaced.script(:load, "return {KEYS[1], KEYS[2]}")
+          @redis.script(:load, "return {KEYS[1], KEYS[2]}")
         end
 
         it "should namespace evalsha keys passed in as array args" do
@@ -501,11 +509,19 @@ describe "redis" do
             evalsha(sha, :keys => %w[k1 k2], :argv => %w[arg1 arg2]).
             should eq(%w[ns:k1 ns:k2])
         end
+
+        it "should namespace evalsha keys passed in as hash args unmodified" do
+          args = { :keys => %w[k1 k2], :argv => %w[arg1 arg2] }
+          args.freeze
+          @namespaced.
+            evalsha(sha, args).
+            should eq(%w[ns:k1 ns:k2])
+        end
       end
 
       context "in a nested namespace" do
         let(:nested_namespace) { Redis::Namespace.new(:nest, :redis => @namespaced) }
-        let(:sha) { nested_namespace.script(:load, "return {KEYS[1], KEYS[2]}") }
+        let(:sha) { @redis.script(:load, "return {KEYS[1], KEYS[2]}") }
 
         it "should namespace eval keys passed in as hash args" do
           nested_namespace.

metadata

@@ -1,8 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: redis-namespace
 version: !ruby/object:Gem::Version
-  version: 1.5.2
-  prerelease: 
+  version: 1.5.3
 platform: ruby
 authors:
 - Chris Wanstrath
@@ -12,69 +11,60 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-30 00:00:00.000000000 Z
+date: 2017-02-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redis
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 3.0.4
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 3.0.4
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '10.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '10.1'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '2.14'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '2.14'
-description: ! 'Adds a Redis::Namespace class which can be used to namespace calls
-
+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:
 - chris@ozmm.org
 - hone02@gmail.com
@@ -84,39 +74,37 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- LICENSE
 - README.md
 - Rakefile
-- LICENSE
-- lib/redis/namespace/version.rb
-- lib/redis/namespace.rb
 - lib/redis-namespace.rb
+- lib/redis/namespace.rb
+- lib/redis/namespace/version.rb
 - spec/deprecation_spec.rb
 - spec/redis_spec.rb
 - spec/spec_helper.rb
 homepage: http://github.com/resque/redis-namespace
 licenses:
 - MIT
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.23
+rubygems_version: 2.5.1
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Namespaces Redis commands.
 test_files: []
-has_rdoc: false