redis-central 0.1.0

data/LICENCE

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Simon Wilkins
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,57 @@
+# Redis::Central
+
+redis-central providers a helper for providing access and configuration to a single per-application/thread, optionally namespaced, redis client.
+
+## Installation
+
+    gem install redis-central
+    
+## Usage
+
+### Shared client
+At it's most basic (and it's all pretty basic), redis-central provides your classes and objects with a "redis" helper method for accessing a single redis client. In this form it will return a [Redis](https://github.com/redis/redis-rb) instance
+
+	require 'redis-central'
+	
+	class User
+	
+	  include Redis::Central
+	  
+	  attr_accessor :id, :name
+	  
+	  def self.find(id)
+	    user = User.new
+	    user.name = redis.get "users:#{id}:name"
+	  end
+	  
+	  def save
+	    redis.set "users:#{id}:name", name
+	  end
+	  
+	end
+	
+Both the class and its instances will have access to the redis method. Other classes can also include Redis::Central, and these will have access to the same redis client instance.
+
+Configuration options which would normally be passed to the Redis instance can be set on the ``Redis::Central`` class, eg.
+
+    Redis::Central.port = 1234
+
+### Namespacing
+The real motivation for this library, however, is to provide an easy means of centrally namespacing redis keys for an application.
+
+This is particularly useful where a single redis server is being used for multiple deployments of the same application, or for applications which share a model/ models which are persisted through redis, or simply scenarios were redis keys could clash between applications. 
+
+So for instance you could have an initializer containing something like this:
+
+	app_name = RAILS_ROOT.split(File::SEPARATOR).last
+	Redis::Central.namespace = app_name
+	
+In this scenario calls to the redis method will return an instance of [Redis::Namespace](https://github.com/defunkt/redis-namespace), namespaced with the given setting. All queries to this object will then be prefixed accordingly.
+
+## Testing
+
+    bundle install
+    rake test
+
+## Author
+Si Wilkins

data/Rakefile

@@ -0,0 +1,7 @@
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs.push 'lib'
+  t.test_files = FileList['spec/**/*_spec.rb']
+  t.verbose    = true
+end

data/lib/redis/central/version.rb

@@ -0,0 +1,9 @@
+class Redis
+  
+  module Central
+
+    VERSION = '0.1.0'
+
+  end
+
+end

data/lib/redis/central.rb

@@ -0,0 +1,67 @@
+require 'redis-namespace'
+
+class Redis
+  
+  module Central
+
+    class << self
+
+      REDIS_CLIENT_OPTIONS = [
+        :scheme,
+        :host,
+        :port,
+        :path,
+        :timeout,
+        :password,
+        :db
+      ] 
+
+      attr_writer *REDIS_CLIENT_OPTIONS
+      attr_writer :namespace
+
+      def redis
+        @redis ||= begin
+          redis = Redis.new(client_options)
+          if @namespace && @namespace =~ /\w/
+            Redis::Namespace.new(@namespace, :redis => redis)
+          else
+            redis
+          end
+         end
+      end
+
+      private
+      def client_options
+        REDIS_CLIENT_OPTIONS.inject({}) do |memo, option|
+          option_value = instance_variable_get("@#{option}")
+          memo[option] = option_value if option_value
+          memo
+        end
+      end
+
+      def reset!
+        @redis     = nil
+        @namespace = nil
+        REDIS_CLIENT_OPTIONS.each do |option|
+          self.send("#{option}=", nil)
+        end
+      end
+
+    end
+
+    def self.included(base)
+      base.send(:include, Access)
+      base.extend(Access)
+    end
+
+    module Access
+
+      def redis
+        Redis::Central.redis
+      end
+
+    end
+
+  end
+
+end

data/lib/redis-central.rb

@@ -0,0 +1 @@
+require File.expand_path('../redis/central.rb', __FILE__)

data/spec/redis/central_spec.rb

@@ -0,0 +1,107 @@
+require File.expand_path('../../spec_helper', __FILE__)
+
+class DummyModel
+  include Redis::Central
+end
+
+describe "a class including Redis::Central" do
+
+  it "should delegate calls to redis to Redis::Central" do
+    redis = mock
+    Redis::Central.expects(:redis).returns redis
+    DummyModel.redis.must_equal redis
+  end
+
+end
+
+describe "an instance of a class including Redis::Central" do
+
+  it "should delegate calls to redis to Redis::Central" do
+    redis = mock
+    Redis::Central.expects(:redis).returns redis
+    DummyModel.new.redis.must_equal redis
+  end
+
+end
+
+def test_option(option, value)
+  Redis::Central.send("#{option}=", value)
+  Redis.expects(:new).with({option => value})
+  Redis::Central.redis
+end
+
+describe Redis::Central do
+
+  describe "with options" do
+
+    before do
+      Redis::Central.send(:reset!)
+    end
+
+    it "should pass scheme to Redis.new when set" do
+      test_option(:scheme, 'tcp')
+    end
+
+    it "should pass host to Redis.new when set" do
+      test_option(:host, 'localhost')
+    end
+
+    it "should pass port to Redis.new when set" do
+      test_option(:port, 1234)
+    end
+
+    it "should pass path to Redis.new when set" do
+      test_option(:path, '/path/to/redis')
+    end
+
+    it "should pass timeout to Redis.new when set" do
+      test_option(:timeout, 10.0)
+    end
+
+    it "should pass password to Redis.new when set" do
+      test_option(:password, 'pa55w0rd')
+    end
+
+    it "should pass db to Redis.new when set" do
+      test_option(:db, 1)
+    end
+
+  end
+
+  describe "when namespaced" do
+
+    before do
+      Redis::Central.send(:reset!)
+      Redis::Central.namespace = 'my:app'
+    end
+
+    it "should return a Redis::Namespace on call to redis" do
+      Redis::Central.redis.must_be_instance_of Redis::Namespace
+    end
+
+    it "should cache the instance" do
+      redis = mock
+      Redis::Namespace.expects(:new).once.returns redis
+      [Redis::Central.redis, Redis::Central.redis].must_equal [redis, redis]
+    end
+  end
+
+  describe "when not namespaced" do
+
+    before do
+      Redis::Central.send(:reset!)
+    end
+
+    it "should return a Redis on call to redis" do
+      Redis::Central.redis.must_be_instance_of Redis
+    end
+
+    it "should cache the instance" do
+      redis = mock
+      Redis.expects(:new).once.returns redis
+      [Redis::Central.redis, Redis::Central.redis].must_equal [redis, redis]
+    end
+
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,7 @@
+require 'rubygems'
+
+require 'minitest/spec'
+require 'minitest/autorun'
+require 'mocha'
+
+require File.expand_path('../../lib/redis-central', __FILE__)

metadata

@@ -0,0 +1,130 @@
+--- !ruby/object:Gem::Specification 
+name: redis-central
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: 
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Si Wilkins
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2012-06-15 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rake
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: redis-namespace
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: minitest
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: mocha
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id004
+description: |
+  Provides an interface for providing access and configuration to a single 
+  per-application/thread, optionally namespaced, redis client.
+
+email: si.wilkins@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- README.md
+- Rakefile
+- LICENCE
+- lib/redis/central/version.rb
+- lib/redis/central.rb
+- lib/redis-central.rb
+- spec/redis/central_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/siwilkins/redis-central
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Provides easy access, and global namespacing, to a single redis client
+test_files: []
+