pooled_redis 0.1.1 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7c1008020f33e7fb0c5ee8f942f1faa53e08bcae
-  data.tar.gz: 6baa77f39c12fef7c17e6537fee979a52f938435
+  metadata.gz: 6af491df29d1c98965ba53d08ec10f9e954d6075
+  data.tar.gz: 5fa63b3fa1a39d9267452634eb702e773a02cf64
 SHA512:
-  metadata.gz: 3ddf41949911ae044d4a716de9b69c849730b04310c0f7f42241328b4092415734d0f9a5e3064d7b26722d890c44ac82d5965aa0cb311b2dbfd3c783c0cb9982
-  data.tar.gz: efbedc61537f7215cfa0643f2884c9ac4e3b20d116cff9579b4f461de9057fa6a818a29c76ed1103d2bf3f3a3dc13a55dd6966b2e6824df8edb1300fd747fb2e
+  metadata.gz: 28240f414268fe1bfeb0eafdc9579731c255fe64b9b2ea116efeb16d0e29836b55424106e62ec1c57e8bd01fbb85bdf2b760ca525db4bccf622239ad14586183
+  data.tar.gz: e9583b6fcf0aa30212149693d3e768c22cd6534d818448f6899d931db097212777182e8c96e759205abb3896b32302a1d9771548301b8bee5d67696308451c6c

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,8 @@
+language: ruby
+cache: bundler
+rvm:
+  - 2.2.0
+  - jruby-21mode
+  - rbx-2.5.2
+notifications:
+  email: false

data/Gemfile

@@ -1,3 +1,11 @@
 source 'https://rubygems.org'
 
 gemspec
+
+group :development do
+  gem 'redis-activesupport', '~> 4.0.0',
+    github: 'redis-store/redis-activesupport', ref: 'd09ae04'
+  gem 'pry', '~> 0.10.1'
+  gem 'pry-byebug', '~> 2.0.0', platforms: [:mri_20, :mri_21]
+  gem 'pry-coolline', '~> 0.2.5'
+end

data/README.md

@@ -1,5 +1,8 @@
 # PooledRedis
 
+[![Gem Version](https://badge.fury.io/rb/pooled_redis.svg)](http://badge.fury.io/rb/pooled_redis)
+[![Build Status](https://travis-ci.org/printercu/pooled_redis.svg)](https://travis-ci.org/printercu/pooled_redis)
+
 Simple way to access redis connections without global variables.
 
 Provides `Rails.redis_pool` & `Rails.redis` methods and configuration via `database.yml`.
@@ -31,6 +34,8 @@ production:
 
 - You can also provide `pool` & `timeout` values for ConnectionPool.
 - Use `debug: true` to set redis logger to `Rails.logger`.
+- Pass `namespace` if you want to use
+  [redis-namespace](https://github.com/resque/redis-namespace).
 - Use `Rails.redis_pool` & `Rails.redis` method.
 
 PooledRedis uses ConnectionPool for pooling connections.
@@ -100,6 +105,11 @@ Storage.redis_pool.with { |r| r.get :some_key }
 Storage.redis.get :some_key
 ```
 
+### Advanced usage
+
+You can return hash containing `:block` from `redis_config`. This block
+will be used as a block to instantiate connection in ConnectionPool.
+
 # Licence
 
 MIT

data/Rakefile

@@ -1 +1,6 @@
 require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/lib/pooled_redis.rb

@@ -1,6 +1,15 @@
 require 'pooled_redis/version'
 require 'connection_pool'
 
+# If someone added hiredis to Gemfile, I hope he want to use it.
+# This makes all Redis.new use hiredis.
+if defined?(Hiredis)
+  begin
+    require 'redis/connection/hiredis'
+  rescue LoadError
+  end
+end
+
 ConnectionPool.class_eval do
   # Wraps pool and proxies every method to checked out connection.
   # Similar to Wrapper, but works on existing pool.
@@ -26,31 +35,11 @@ ConnectionPool.class_eval do
 end
 
 module PooledRedis
-  # Override this method unless using Rails.
-  def redis_config
-    @redis_config = begin
-      config = ActiveRecord::Base.connection_config[:redis].with_indifferent_access
-      config[:logger] = Rails.logger if config.delete(:debug)
-      config
+  class << self
+    def extend_rails
+      Rails.class_eval { extend PooledRedis } if defined?(Rails)
     end
-  end
 
-  def redis_pool_config
-    @redis_pool_config ||= {
-      pool:     redis_config.delete(:pool)    || 5,
-      timeout:  redis_config.delete(:timeout) || 5,
-    }
-  end
-
-  def redis_pool
-    @redis_pool ||= ConnectionPool.new(redis_pool_config) { Redis.new(redis_config) }
-  end
-
-  def redis
-    @redis ||= redis_pool.simple_connection
-  end
-
-  class << self
     def setup_rails_cache(app)
       # We need to use initializer to be able to access
       # Rails.configuration.database_configuration.
@@ -73,7 +62,40 @@ module PooledRedis
       end
     end
   end
+
+  # Override this method unless using Rails.
+  def redis_config
+    @redis_config ||= begin
+      config = ActiveRecord::Base.connection_config[:redis].with_indifferent_access
+      config[:logger] = Rails.logger if config.delete(:debug)
+      require 'redis/namespace' if config[:namespace]
+      config
+    end
+  end
+
+  def redis_pool_config
+    @redis_pool_config ||= {
+      pool:     redis_config.delete(:pool)    || 5,
+      timeout:  redis_config.delete(:timeout) || 5,
+    }
+  end
+
+  def redis_pool
+    @redis_pool ||= begin
+      block = if redis_config[:block]
+        redis_config[:block]
+      elsif redis_config[:namespace]
+        -> { Redis::Namespace.new(redis_config[:namespace], redis: Redis.new(redis_config)) }
+      else
+        -> { Redis.new(redis_config) }
+      end
+      ConnectionPool.new(redis_pool_config, &block)
+    end
+  end
+
+  def redis
+    @redis ||= redis_pool.simple_connection
+  end
 end
 
-# Use Rails module methods to access redis client.
-Rails.class_eval { extend PooledRedis } if defined?(Rails)
+PooledRedis.extend_rails

data/lib/pooled_redis/version.rb

@@ -1,5 +1,5 @@
 module PooledRedis
-  VERSION = '0.1.1'
+  VERSION = '0.2.1'
 
   def self.gem_version
     Gem::Version.new VERSION

data/pooled_redis.gemspec

@@ -22,4 +22,10 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency 'bundler', '~> 1.7'
   spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.1.0'
+  spec.add_development_dependency 'rspec-its', '~> 1.2.0'
+  spec.add_development_dependency 'redis-namespace', '~> 1.5.1'
+  if defined?(RUBY_ENGINE) && RUBY_ENGINE == 'ruby'
+    spec.add_development_dependency 'hiredis', '~> 0.6.0'
+  end
 end

data/spec/lib/pooled_redis_spec.rb

@@ -0,0 +1,55 @@
+RSpec.describe PooledRedis do
+  context '.extend_rails' do
+    subject { -> { described_class.extend_rails } }
+    before do
+      expect(defined?(Rails)).to be_falsy
+      subject.call # ensure it doesnt fail
+      module Rails; end # stub
+    end
+
+    it 'adds methods to rails' do
+      subject.call
+      expect(Rails).to respond_to(:redis_pool, :redis)
+    end
+  end
+
+  describe '#redis_pool' do
+    subject { instance.redis_pool }
+    let(:instance) { double(redis_config: redis_config).tap { |x| x.extend described_class } }
+    let(:redis_config) { {} }
+
+    its(:class) { should be ConnectionPool }
+    its('checkout.class') { should be Redis }
+
+    if defined?(RUBY_ENGINE) && RUBY_ENGINE == 'ruby'
+      context 'on mri when hiredis is available' do
+        its('checkout.client.driver.name') { should eq 'Redis::Connection::Hiredis' }
+      end
+    end
+
+    context 'when config contains :namespace' do
+      before do
+        # Redis::Namespace must not use Redis.current
+        expect(Redis).to_not receive(:current)
+        expect(Redis).to receive(:new).and_call_original
+      end
+
+      let(:redis_config) { {namespace: 'test_ns'} }
+      its('checkout.class') { should be Redis::Namespace }
+      its('checkout.namespace') { should eq 'test_ns' }
+    end
+
+    context 'when config contains :block' do
+      let(:redis_config) { {block: -> { block_result } } }
+      let(:block_result) { Object.new }
+      its('checkout.class') { should eq block_result.class }
+      its('checkout') { should be block_result }
+    end
+
+    context 'calling multiple times' do
+      subject { -> { instance.redis_pool } }
+      let(:original_value) { subject.call }
+      its(:call) { should be original_value }
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,27 @@
+require 'bundler/setup'
+Bundler.setup
+Bundler.require(:development)
+
+require 'pooled_redis'
+
+RSpec.configure do |config|
+  config.expect_with :rspec do |expectations|
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  config.mock_with :rspec do |mocks|
+    mocks.verify_partial_doubles = true
+  end
+
+  config.filter_run :focus
+  config.run_all_when_everything_filtered = true
+
+  config.disable_monkey_patching!
+
+  if config.files_to_run.one?
+    config.default_formatter = 'doc'
+  end
+
+  config.order = :random
+  Kernel.srand config.seed
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pooled_redis
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.1
 platform: ruby
 authors:
 - Max Melentiev
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-26 00:00:00.000000000 Z
+date: 2015-03-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redis
@@ -66,6 +66,62 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+- !ruby/object:Gem::Dependency
+  name: rspec-its
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.2.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.2.0
+- !ruby/object:Gem::Dependency
+  name: redis-namespace
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.5.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.5.1
+- !ruby/object:Gem::Dependency
+  name: hiredis
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.6.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.6.0
 description: Provides `Rails.redis_pool` & `Rails.redis` methods and configuration
   via `database.yml`.
 email:
@@ -75,6 +131,8 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".rspec"
+- ".travis.yml"
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -82,6 +140,8 @@ files:
 - lib/pooled_redis.rb
 - lib/pooled_redis/version.rb
 - pooled_redis.gemspec
+- spec/lib/pooled_redis_spec.rb
+- spec/spec_helper.rb
 homepage: https://github.com/printercu/pooled_redis
 licenses:
 - MIT
@@ -106,4 +166,6 @@ rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: Simple way to access redis connections without global variables.
-test_files: []
+test_files:
+- spec/lib/pooled_redis_spec.rb
+- spec/spec_helper.rb