rspec-redis_helper 0.1.0

data/.gitignore

@@ -0,0 +1,2 @@
+Gemfile.lock
+pkg

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in rspec-redis_helper.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Mark Lanett
+
+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,55 @@
+# RSpec::RedisHelper
+
+This module will help you write specs which use Redis.
+It sets up two Redis connections.
+It also clears out Redis between examples.
+It uses db 1 on localhost by default.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'rspec-redis_helper'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rspec-redis_helper
+
+## Usage
+
+Configure RSpec in your support or helper file like so:
+
+    RSpec.configure do |spec|
+      spec.include RSpec::RedisHelper, redis: true
+
+      # clean the Redis database around each run
+      # @see https://www.relishapp.com/rspec/rspec-core/docs/hooks/around-hooks
+      spec.around( :each, redis: true ) do |example|
+        with_clean_redis do
+          example.run
+        end
+      end
+    end
+
+You will also need to configure your app to use one of these redis connections,
+or to be initialized from RSpec::RedisHelper::TEST.
+
+Then mark your Redis-using specs with redis: true, like so:
+
+    describe MyApp, redis: true do
+      it "has access to redis" do
+        redis.should_not be_nil
+      end
+    end
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,6 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+task :default => :spec

data/lib/rspec-redis_helper/version.rb

@@ -0,0 +1,5 @@
+module RSpec
+  module RedisHelper
+    VERSION = "0.1.0"
+  end
+end

data/lib/rspec-redis_helper.rb

@@ -0,0 +1,39 @@
+require "rspec-redis_helper/version"
+
+module RSpec
+  module RedisHelper
+
+    TEST = { url: "redis://127.0.0.1:6379/1" }
+
+    def redis
+      @redis ||= ::Redis.connect(TEST)
+    end
+
+    def redis2
+      @redis2 ||= ::Redis.connect(TEST)
+    end
+
+    def with_watch( redis, *args )
+      redis.watch( *args )
+      begin
+        yield
+      ensure
+        redis.unwatch
+      end
+    end
+
+    def with_clean_redis(&block)
+      redis.client.disconnect # auto connect after fork
+      redis2.client.disconnect # auto connect after fork
+      redis.flushall          # clean before run
+      begin
+        yield
+      ensure
+        redis.flushall        # clean up after run
+        redis.quit            # quit (close) connection
+        redis2.quit            # quit (close) connection
+      end
+    end
+
+  end
+end

data/rspec-redis_helper.gemspec

@@ -0,0 +1,22 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/rspec-redis_helper/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Mark Lanett"]
+  gem.email         = ["mark.lanett@gmail.com"]
+  gem.description   = %q{Helper for RSpec tests which use Redis}
+  gem.summary       = %q{Helper for RSpec tests which use Redis}
+  gem.homepage      = "http://github.com/mlanett/rspec-redis_helper"
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "rspec-redis_helper"
+  gem.require_paths = ["lib"]
+  gem.version       = RSpec::RedisHelper::VERSION
+
+  gem.add_dependency "redis"
+
+  gem.add_development_dependency "rake"
+  gem.add_development_dependency "rspec"
+end

data/spec/helper.rb

@@ -0,0 +1,15 @@
+# -*- encoding: utf-8 -*-
+require "bundler/setup"         # set up gem paths
+require "redis"
+require "rspec-redis_helper"    # load this gem
+
+RSpec.configure do |spec|
+  spec.include RSpec::RedisHelper, redis: true
+
+  # clean the Redis database around each example
+  spec.around( :each, redis: true ) do |example|
+    with_clean_redis do
+      example.run
+    end
+  end
+end

data/spec/redis_helper_spec.rb

@@ -0,0 +1,42 @@
+# -*- encoding: utf-8 -*-
+require "helper"
+
+describe RSpec::RedisHelper do
+
+  include RSpec::RedisHelper
+
+  it "should be redis" do
+    redis.should be_kind_of(Redis)
+  end
+
+  it "should clean redis before and after" do
+    redis.set "it", "bar"
+    with_clean_redis do
+      redis.get("it").should eq(nil)
+      redis.set "it", "bar"
+    end
+    redis.get("it").should eq(nil)
+  end
+
+  it "has a watch helper" do
+    with_clean_redis do
+      with_watch( redis, "it" ) do
+        redis.multi do |r|
+          r.set "it", "my value"
+        end
+      end.should eq(["OK"])
+    end
+  end
+
+  it "can use the redis2 connection to intentionally fail transactions" do
+    with_clean_redis do
+      with_watch( redis, "it" ) do
+        redis2.set "it", "interference"
+        redis.multi do |r|
+          r.set "it", "my value"
+        end
+      end.should be_nil
+    end
+  end
+
+end

data/spec/redis_spec.rb

@@ -0,0 +1,30 @@
+# -*- encoding: utf-8 -*-
+require "helper"
+
+describe Redis, redis: true, redis_configuration: true do
+
+  it "should be redis" do
+    redis.should be_kind_of(Redis)
+  end
+
+  it "has sorted sets" do
+    redis.zcard("it").should eq(0)
+    redis.zadd("it", 2, "bar")
+    redis.zadd("it", 3, "goo")
+    redis.zcard("it").should eq(2)
+    redis.zrange("it", 0, 0).should eq(["bar"]) # 0th item = smallest item
+    redis.zrangebyscore( "it", 0, 1, limit: [0,1] ).should eq([])
+    redis.zrangebyscore( "it", 0, 2, limit: [0,1] ).should eq(["bar"])
+  end
+
+  it "can select by score" do
+    redis.zadd "it", 1, "a"
+    redis.zadd "it", 2, "b"
+    redis.zadd "it", 3, "c"
+    redis.zadd "it", 4, "d"
+    # inclusive by default http://redis.io/commands/zrangebyscore
+    redis.zrangebyscore( "it", "-inf", 2 ).should eq(["a","b"])
+    redis.zrangebyscore( "it", "-inf", 2, limit: [0,1] ).should eq(["a"])
+  end
+
+end

metadata

@@ -0,0 +1,94 @@
+--- !ruby/object:Gem::Specification
+name: rspec-redis_helper
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: !!null 
+platform: ruby
+authors:
+- Mark Lanett
+autorequire: !!null 
+bindir: bin
+cert_chain: []
+date: 2012-03-24 00:00:00.000000000 -07:00
+default_executable: !!null 
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: redis
+  requirement: &70259979329660 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70259979329660
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &70259979329200 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70259979329200
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &70259979328740 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70259979328740
+description: Helper for RSpec tests which use Redis
+email:
+- mark.lanett@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/rspec-redis_helper.rb
+- lib/rspec-redis_helper/version.rb
+- rspec-redis_helper.gemspec
+- spec/helper.rb
+- spec/redis_helper_spec.rb
+- spec/redis_spec.rb
+has_rdoc: true
+homepage: http://github.com/mlanett/rspec-redis_helper
+licenses: []
+post_install_message: !!null 
+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: !!null 
+rubygems_version: 1.5.0
+signing_key: !!null 
+specification_version: 3
+summary: Helper for RSpec tests which use Redis
+test_files:
+- spec/helper.rb
+- spec/redis_helper_spec.rb
+- spec/redis_spec.rb