redis_util 0.5.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c0982a8f3706eaf058b21298a4a852948b03b0c4
+  data.tar.gz: 79f9c6340a25b9fa608d615e7b7f0495207b4a83
+SHA512:
+  metadata.gz: afdf9c67bc79d11578bae562a4a2a6053857834b8bd11dd01e561360049a7f778abf640e5f1e39882031998025a6fd378f4435ed418cc2537c4ca0928a570c63
+  data.tar.gz: 0dded02a0fb006b26564331c37f73d92408bd913e3d69fcabdc7c6dd962e173cc0a163495856944a644bf5ea7eeea0e307be482681447467b11585e0069565c6

data/.coveralls.yml

@@ -0,0 +1 @@
+service_name: travis-ci

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.travis.yml

@@ -0,0 +1,8 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - jruby-19mode
+  - rbx-19mode
+  
+script: bundle exec rake

data/Gemfile

@@ -0,0 +1,7 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in redis_util.gemspec
+gemspec
+
+# for code coverage during travis-ci test runs
+gem 'coveralls', :require => false

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Matt Conway
+
+MIT License
+
+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,53 @@
+# RedisUtil
+
+An aggregation of redis utility code, including:
+
+* A factory which allows you to define redis connections in a config file, and keeps track of them for reconnecting in forks
+* Test helpers
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'redis_util'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install redis_util
+
+Then setup a config file in config/redis.yml that could look like:
+
+    common: &common
+      host: localhost
+      port: 6379
+      thread_safe: true
+    
+    development:
+      resque:
+        <<: *common
+        db: 0
+      redis_objects:
+        <<: *common
+        db: 1
+    
+    test:
+      resque:
+        <<: *common
+        db: 10
+      redis_objects:
+        <<: *common
+        db: 11
+
+If not running in rails, an additional step is needed to set the config_file and env:
+
+    RedisUtil::Factory.config_file = "#{root}/config/redis.yml"
+    RedisUtil::Factory.env = "development"
+  
+## Usage
+
+    redis = RedisUtil::Factory.connect(:foo)
+    redis.keys('*')

data/Rakefile

@@ -0,0 +1,18 @@
+require "bundler/gem_tasks"
+require 'rake'
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.pattern = 'test/**/*_test.rb'
+  t.libs.push 'test'
+end
+
+task :default => :test
+
+task :console do
+  Bundler.require
+  require "redis_util"
+  ARGV.clear
+  require "irb"
+  IRB.start
+end

data/lib/redis_util.rb

@@ -0,0 +1,3 @@
+require 'gem_logger'
+require "redis_util/version"
+require "redis_util/factory"

data/lib/redis_util/factory.rb

@@ -0,0 +1,144 @@
+require 'redis'
+require 'redis-namespace'
+
+module RedisUtil
+  
+  # A factory class for creating redis connections, useful for
+  # reconnecting them after a fork
+  #
+  class Factory
+    include GemLogger::LoggerSupport
+    extend MonitorMixin
+  
+    class << self
+      
+      # Set the path to the yml config file which defines all the redis connections.
+      # If running in rails, it will default to "#{Rails.root}/config/redis.yml"
+      attr_accessor :config_file
+      
+      # Set the environment we are running in (development/test/etc).
+      # If running in rails, it will default to Rails.env
+      attr_accessor :env
+      
+      attr_accessor :clients, :configuration
+      
+      # Creates/retrieves a single redis client for the given named configuration
+      #
+      # @param [Symbol] name The name of the redis configuration (config/redis.yml) to use
+      # @return [Redis] A redis client object
+      def connect(name)
+        conf = lookup_config(name)
+        synchronize do
+          clients[name] ||= []
+          if clients[name].first.nil?
+            clients[name] << new_redis_client(conf)
+          end
+        end
+        clients[name].first
+      end
+    
+      # Always create and return a new redis client for the given named configuration
+      #
+      # @param [Symbol] name The name of the redis configuration (config/redis.yml) to use
+      # @return [Redis] A redis client object
+      def create(name)
+        conf = lookup_config(name)
+        synchronize do
+          clients[name] ||= []
+          clients[name] << new_redis_client(conf)
+        end
+        clients[name].last
+      end
+    
+      # Disconnect all known redis clients
+      #
+      # @param [Symbol] key (optional, defaults to all) The name of the redis configuration (config/redis.yml) to disconnect
+      def disconnect(key=nil)
+        logger.debug "RedisUtil::Factory.disconnect start"
+        synchronize do
+          clients.clone.each do |name, client|
+            next if key && name != key
+    
+            connections = clients.delete(name) || []
+            connections.each do |connection|
+              begin
+                logger.debug "Disconnecting Redis client: #{connection}"
+                connection.quit
+              rescue => e
+                logger.warn("Exception while disconnecting: #{e}")
+              end
+            end
+          end
+        end
+        logger.debug "RedisUtil::Factory.disconnect complete"
+        nil
+      end
+    
+      # Reconnect all known redis clients
+      #
+      # @param [Symbol] key (optional, defaults to all) The name of the redis configuration (config/redis.yml) to reconnect
+      def reconnect(key=nil)
+        logger.debug "RedisUtil::Factory.reconnect start"
+        synchronize do
+          clients.each do |name, connections|
+            next if key && name != key
+            
+            connections.each do |connection|
+              logger.debug "Reconnecting Redis client: #{connection}"
+              connection.client.reconnect
+            end
+          end
+        end
+        logger.debug "RedisUtil::Factory.reconnect complete"    
+      end
+
+      def configuration
+        synchronize do
+          @configuration ||= begin
+                                
+            if config_file.nil? || env.nil?
+              if defined?(Rails)
+                self.config_file ||= "#{Rails.root}/config/redis.yml"
+                self.env ||= Rails.env.to_s
+              else
+                raise "You need to initialize with an env and config file"
+              end
+            end
+            
+            self.clients = {}
+            require 'erb'
+            config = YAML::load(ERB.new(IO.read(config_file)).result)
+            symbolize(config[env])
+          end
+        end
+      end
+      
+      private
+      
+      def lookup_config(name)
+        conf = configuration[name]
+        raise "No redis configuration for #{env} environment in redis.yml for #{name}" unless conf
+        conf
+      end
+      
+      def new_redis_client(conf)
+        redis = ::Redis.new(conf)
+        if conf[:namespace]
+          redis = Redis::Namespace.new(conf[:namespace].to_sym, :redis => redis)
+        end
+        redis
+      end
+          
+      def symbolize(hash)
+        hash.inject({}) do |options, (key, value)|
+          value = symbolize(value) if value.kind_of?(Hash)
+          options[key.to_sym || key] = value
+          options
+        end
+      end
+
+    end
+    
+  end
+
+end

data/lib/redis_util/test_helper.rb

@@ -0,0 +1,37 @@
+module RedisUtil
+  
+  # Test helpers for working with redis in tests
+  module TestHelper
+    
+    # flushes all redis connections that are configured for
+    # this environment in redis.yml
+    def redis_util_truncate_redis
+      RedisUtil::Factory.configuration.keys.each do |k|
+        RedisUtil::Factory.connect(k).flushdb()
+      end
+    end
+    
+    def redis_util_dump_redis
+      result = {}
+      RedisUtil::Factory.configuration.keys.each do |k|
+        redis = RedisUtil::Factory.connect(k)
+        result[k] = {}
+        redis.keys("*").each do |key|
+          type = redis.type(key)
+          result[k]["#{key} (#{type})"] = case type
+            when 'string' then redis.get(key)
+            when 'list' then redis.lrange(key, 0, -1)
+            when 'zset' then redis.zrange(key, 0, -1, :with_scores => true)
+            when 'set' then redis.smembers(key)
+            when 'hash' then redis.hgetall(key)
+            else type
+          end
+        end
+      end
+      return result
+    end
+    
+    
+  end
+
+end

data/lib/redis_util/version.rb

@@ -0,0 +1,3 @@
+module RedisUtil
+  VERSION = "0.5.0"
+end

data/redis_util.gemspec

@@ -0,0 +1,31 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'redis_util/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "redis_util"
+  spec.version       = RedisUtil::VERSION
+  spec.authors       = ["Matt Conway"]
+  spec.email         = ["matt@conwaysplace.com"]
+  spec.description   = %q{An aggregation of redis utility code, including a factory for tracking connections}
+  spec.summary       = %q{Redis utilities}
+  spec.homepage      = "http://github.com/wr0ngway/redis_util"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "minitest"
+  spec.add_development_dependency "minitest_should"
+  spec.add_development_dependency "minitest-reporters"
+  spec.add_development_dependency "mocha"
+
+  spec.add_dependency "gem_logger"
+  spec.add_dependency "redis"
+  spec.add_dependency "redis-namespace"
+end

data/test/test_helper.rb

@@ -0,0 +1,81 @@
+require 'rubygems'
+
+if ENV['CI']
+  require 'coveralls'
+  Coveralls.wear!
+end
+
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+
+require 'minitest/autorun'
+require 'minitest/should'
+require "minitest/reporters"
+require 'mocha/setup'
+
+reporter = ENV['REPORTER']
+reporter = case reporter
+  when 'none' then nil
+  when 'spec' then MiniTest::Reporters::SpecReporter.new
+  when 'progress' then MiniTest::Reporters::ProgressReporter.new
+  else MiniTest::Reporters::DefaultReporter.new
+end
+MiniTest::Reporters.use!(reporter) if reporter
+
+require 'redis_util'
+GemLogger.default_logger = Logger.new("/dev/null")
+
+class MiniTest::Should::TestCase
+
+  require 'redis_util/test_helper'
+  include RedisUtil::TestHelper
+
+end
+
+# Allow triggering single tests when running from rubymine
+# reopen the installed runner so we don't step on runner customizations
+class << MiniTest::Unit.runner
+  # Rubymine sends --name=/\Atest\: <context> should <should>\./
+  # Minitest runs each context as a suite
+  # Minitest filters methods by matching against: <suite>#test_0001_<should>
+  # Nested contexts are separted by spaces in rubymine, but ::s in minitest
+  
+  def _run_suites(suites, type)
+    if options[:filter]
+      if options[:filter] =~ /\/\\Atest\\: (.*) should (.*)\\\.\//
+        context_filter = $1
+        should_filter = $2
+        should_filter.strip!
+        should_filter.gsub!(" ", "_")
+        should_filter.gsub!(/\W/, "")
+        context_filter = context_filter.gsub(" ", "((::)| )")
+        options[:filter] = "/\\A#{context_filter}(Test)?#test(_\\d+)?_should_#{should_filter}\\Z/"
+      end
+    end
+    
+    super
+  end
+  
+  # Prevent "Empty test suite" verbosity when running in rubymine
+  def _run_suite(suite, type)
+    
+    filter = options[:filter] || '/./'
+    filter = Regexp.new $1 if filter =~ /\/(.*)\//    
+    all_test_methods = suite.send "#{type}_methods"
+    filtered_test_methods = all_test_methods.find_all { |m|
+      filter === m || filter === "#{suite}##{m}"
+    }
+    
+    if filtered_test_methods.size > 0    
+      super
+    else
+      [0, 0]
+    end
+  end
+end

data/test/unit/redis_util/factory_test.rb

@@ -0,0 +1,137 @@
+require_relative '../../test_helper.rb'
+
+module RedisUtil
+  class FactoryTest < MiniTest::Should::TestCase
+  
+    setup do
+      @config = "config/redis.yml"
+      RedisUtil::Factory.config_file = @config
+      RedisUtil::Factory.env = "test"
+      RedisUtil::Factory.clients = nil
+      RedisUtil::Factory.configuration = nil
+      @config_file_data = <<-EOF
+        test:
+            resque:
+              db: 1
+              host: localhost
+              port: 6379
+              thread_safe: true
+            cache:
+              db: 2
+              host: localhost
+              port: 6379
+              thread_safe: true
+            namespaced:
+              db: 3
+              host: localhost
+              port: 6379
+              thread_safe: true
+              namespace: foobar
+        development:
+            resque:
+              host: bar
+      EOF
+      IO.stubs(:read).with(@config).returns(@config_file_data)
+    end
+  
+    context "#configuration" do
+  
+      should "read in redis yml" do
+        config = RedisUtil::Factory.configuration
+        assert_equal [:resque, :cache, :namespaced], config.keys
+        assert_equal({:db=>1, :host=>"localhost", :port=>6379, :thread_safe=>true}, config[:resque])
+      end
+  
+      should "read in redis yml for different env" do
+        RedisUtil::Factory.env = "development"
+        assert_equal({:resque => {:host=>"bar"}}, RedisUtil::Factory.configuration)
+      end
+      
+      should "use defaults with Rails" do
+        begin
+          RedisUtil::Factory.config_file = nil
+          RedisUtil::Factory.env = nil
+          Object.const_set(:Rails, Class.new)
+          ::Rails.stubs(:env).returns "development"
+          ::Rails.stubs(:root).returns "/root"
+          IO.stubs(:read).with("/root/config/redis.yml").returns(@config_file_data)
+          RedisUtil::Factory.configuration
+          assert_equal "development", RedisUtil::Factory.env
+          assert_equal "/root/config/redis.yml", RedisUtil::Factory.config_file
+        ensure
+          Object.send(:remove_const, "Rails")
+        end
+      end
+  
+    end
+  
+    context "#connect" do
+  
+      should "return client for symbol" do
+        assert_equal 1, RedisUtil::Factory.connect(:resque).client.db
+        assert_equal 2, RedisUtil::Factory.connect(:cache).client.db
+      end
+  
+      should "reuse client for same symbol" do
+        assert_equal RedisUtil::Factory.connect(:resque).object_id, RedisUtil::Factory.connect(:resque).object_id
+      end
+  
+      should "return a standard client if namespace is not present" do
+        client = RedisUtil::Factory.connect(:cache)
+        assert client.instance_of?(Redis)
+      end
+  
+      should "return a namespaced client if namespace is present" do
+        client = RedisUtil::Factory.connect(:namespaced)
+        assert client.instance_of?(Redis::Namespace)
+        assert_equal client.namespace, :foobar
+      end
+  
+    end
+  
+    context "#disconnect" do
+  
+      should "disconnect specific client" do
+        resque_client = RedisUtil::Factory.connect(:resque)
+        cache_client = RedisUtil::Factory.connect(:cache)
+  
+        resque_client.expects(:quit)
+        cache_client.expects(:quit).never
+        RedisUtil::Factory.disconnect(:resque)
+      end
+  
+      should "disconnect all clients" do
+        resque_client = RedisUtil::Factory.connect(:resque)
+        cache_client = RedisUtil::Factory.connect(:cache)
+  
+        resque_client.expects(:quit)
+        cache_client.expects(:quit)
+        RedisUtil::Factory.disconnect
+      end
+  
+    end
+  
+    context "#reconnect" do
+  
+      should "reconnect specific client" do
+        resque_client = RedisUtil::Factory.connect(:resque)
+        cache_client = RedisUtil::Factory.connect(:cache)
+  
+        resque_client.expects(:client).returns(mock('redis', :reconnect => nil))
+        cache_client.expects(:client).never
+        RedisUtil::Factory.reconnect(:resque)
+      end
+  
+      should "reconnect all clients" do
+        resque_client = RedisUtil::Factory.connect(:resque)
+        cache_client = RedisUtil::Factory.connect(:cache)
+  
+        resque_client.expects(:client).returns(mock('redis', :reconnect => nil))
+        cache_client.expects(:client).returns(mock('redis', :reconnect => nil))
+        RedisUtil::Factory.reconnect
+      end
+  
+    end
+  
+  end
+end

metadata

@@ -0,0 +1,187 @@
+--- !ruby/object:Gem::Specification
+name: redis_util
+version: !ruby/object:Gem::Version
+  version: 0.5.0
+platform: ruby
+authors:
+- Matt Conway
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-09-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest_should
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest-reporters
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: mocha
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: gem_logger
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: redis
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: redis-namespace
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: An aggregation of redis utility code, including a factory for tracking
+  connections
+email:
+- matt@conwaysplace.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .coveralls.yml
+- .gitignore
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/redis_util.rb
+- lib/redis_util/factory.rb
+- lib/redis_util/test_helper.rb
+- lib/redis_util/version.rb
+- redis_util.gemspec
+- test/test_helper.rb
+- test/unit/redis_util/factory_test.rb
+homepage: http://github.com/wr0ngway/redis_util
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.6
+signing_key: 
+specification_version: 4
+summary: Redis utilities
+test_files:
+- test/test_helper.rb
+- test/unit/redis_util/factory_test.rb