database_cleaner 1.0.0.RC1 → 1.0.1

data/Gemfile.lock

@@ -135,6 +135,10 @@ GEM
     multi_json (1.5.0)
     mysql (2.8.1)
     mysql2 (0.3.11)
+    nest (1.1.2)
+      redis
+    ohm (0.1.5)
+      nest (~> 1.0)
     origin (1.0.11)
     pg (0.14.1)
     plucky (0.5.2)
@@ -160,6 +164,7 @@ GEM
     rake (10.0.3)
     rdoc (3.12)
       json (~> 1.4)
+    redis (3.0.4)
     rest-client (1.6.7)
       mime-types (>= 1.16)
     rspec (2.12.0)
@@ -213,6 +218,7 @@ DEPENDENCIES
   mongoid
   mysql (~> 2.8.1)
   mysql2
+  ohm (~> 0.1.3)
   pg
   rake
   rspec-rails

data/History.txt

@@ -1,20 +1,28 @@
-== 1.0.0 2012-03-xx
+== 1.0.1 2013-05-13
+
+  * Patch release to fix broken gemspec file.  Sorry folks!
+
+== 1.0.0 2013-05-13
 
  === New Features/Changes
 
   * Dropping support for Ruby 1.8.x; Only 1.9.x and beyond will be supported going forward.
-  * Now supporting (and testing against 2.0.x).
+  * Now supporting (and testing against ruby 2.0.x).
   * Adds support for AR 4.0 by using `begin_transaction` (David Chelimsky and Steve Madsen)
   * Adds Rails 4 support for SQLite3Adapter
+  * Suppport for Moped when used without Mongoid (Cyprian Kowalczyk)
+  * Redis & Ohm support (Hengbin Qiu, James Conroy-Finn)
 
   * CI Improvements (Jan Vlnas, Murahashi Sanemat Kenichi, Samer Masry, Jordan Hollinger)
-  * README/Documentation improvements (Marcelo Cajueiro, Donald Ball, TJ Chambers, Nick Huanca
+  * README/Documentation improvements (Marcelo Cajueiro, Donald Ball, TJ Chambers, Nick Huanca, Justin Edwards, Ryota Arai)
 
  === Bug Fixes
   * Fixes transaction errors when using `after_commit` hooks in AR.
   * Fixes truncation error with SQLite (Daniel White)
   * Fixes `pre_count` logic in AR Postgres. (Jordan Hollinger)
   * Sequel fix to normalize all table names to strings. (Lauri Peltola)
+  * #clean_with now works with multiple connections. (John Ferlito)
+  * Always start a AR transaction to prevent nil errors in AR when rolling back (John Hampton, M.Shibuya)
 
 == 0.9.1 2012-10-11 (0.9.0 was released first but was yanked due to bad gemspec)
 

data/README.markdown

@@ -5,7 +5,7 @@ Database Cleaner is a set of strategies for cleaning your database in Ruby.
 The original use case was to ensure a clean state during tests.
 Each strategy is a small amount of code but is code that is usually needed in any ruby app that is testing with a database.
 
-ActiveRecord, DataMapper, Sequel, MongoMapper, Mongoid, and CouchPotato are supported.
+ActiveRecord, DataMapper, Sequel, MongoMapper, Mongoid, CouchPotato, Ohm and Redis are supported.
 
 [![Build Status](https://secure.travis-ci.org/bmabey/database_cleaner.png)](http://travis-ci.org/bmabey/database_cleaner)
 
@@ -55,6 +55,18 @@ Here is an overview of the strategies supported for each library:
       <td> Yes</td>
       <td> No</td>
     </tr>
+    <tr>
+      <td>Redis</td>
+      <td><b>Yes</b></td>
+      <td>No</td>
+      <td>No</td>
+    </tr>
+    <tr>
+      <td>Ohm</td>
+      <td><b>Yes</b></td>
+      <td>No</td>
+      <td>No</td>
+    </tr>
   </tbody>
 </table>
 
@@ -72,6 +84,12 @@ Here is an overview of the strategies supported for each library:
       <td> No</td>
       <td> No</td>
     </tr>
+    <tr>
+      <td> Moped</td>
+      <td> Yes</td>
+      <td> No</td>
+      <td> No</td>
+    </tr>
   </tbody>
 </table>
 
@@ -88,11 +106,11 @@ For the SQL libraries the fastest option will be to use `:transaction` as transa
 
 One common approach is to force all processes to use the same database connection ([common ActiveRecord hack](http://blog.plataformatec.com.br/2011/12/three-tips-to-improve-the-performance-of-your-test-suite/)) however this approach has been reported to result in non-deterministic failures.
 
-Another approach is to have the transactions rolled back in the application's process and relax the isolation level of the database (so the tests can read the uncommited transactions).
+Another approach is to have the transactions rolled back in the application's process and relax the isolation level of the database (so the tests can read the uncommitted transactions).
 
 An easier, but slower, solution is to use the `:truncation` or `:deletion` strategy.
 
-So what is fastest out of `:deletion` and `:truncation`? Well, it depends on your table structure and what percentage of tables you populate in an average test. The reasoning is out the the scope of this README but here is a [good SO answer on this topic for Postgres](http://stackoverflow.com/questions/11419536/postgresql-truncation-speed/11423886#11423886).
+So what is fastest out of `:deletion` and `:truncation`? Well, it depends on your table structure and what percentage of tables you populate in an average test. The reasoning is out of the scope of this README but here is a [good SO answer on this topic for Postgres](http://stackoverflow.com/questions/11419536/postgresql-truncation-speed/11423886#11423886).
 
 Some people report much faster speeds with `:deletion` while others say `:truncation` is faster for them. The best approach therefore is it try all options on your test suite and see what is faster.
 
@@ -123,6 +141,9 @@ DatabaseCleaner.strategy = :truncation, {:only => %w[widgets dogs some_other_tab
 DatabaseCleaner.strategy = :truncation, {:except => %w[widgets]}
 ```
 
+With Ohm and Redis, `:only` and `:except` take a list of strings to be
+passed to [`keys`](http://redis.io/commands/keys)).
+
 (I should point out the truncation strategy will never truncate your schema_migrations table.)
 
 Some strategies require that you call `DatabaseCleaner.start` before calling `clean` (for example the `:transaction` one needs to know to open up a transaction). So you would have:
@@ -276,6 +297,11 @@ Usage beyond that remains the same with `DatabaseCleaner.start` calling any setu
       <td> <code>DatabaseCleaner[:mongoid]</code></td>
       <td> Multiple databases supported for Mongoid 3. Specify <code>DatabaseCleaner[:mongoid, {:connection =&gt; :db_name}]</code> </td>
     </tr>
+    <tr>
+      <td> Moped</td>
+      <td> <code>DatabaseCleaner[:moped]</code></td>
+      <td> It is necessary to configure database name with <code>DatabaseCleaner[:moped].db = db_name</code> otherwise name `default` will be used.</td>
+    </tr>
     <tr>
       <td> Couch Potato</td>
       <td> <code>DatabaseCleaner[:couch_potato]</code></td>
@@ -286,6 +312,16 @@ Usage beyond that remains the same with `DatabaseCleaner.start` calling any setu
       <td> <code>DatabaseCleaner[:sequel]</code></td>
       <td> Multiple databases supported; specify <code>Databasecleaner[:sequel, {:connection =&gt; Sequel.connect(uri)}]</code></td>
     </tr>
+    <tr>
+      <td>Redis</td>
+      <td><code>DatabaseCleaner[:redis]</code></td>
+      <td>Connection specified as Redis URI</td>
+    </tr>
+    <tr>
+      <td>Ohm</td>
+      <td><code>DatabaseCleaner[:ohm]</code></td>
+      <td>Connection specified as Redis URI</td>
+    </tr>
   </tbody>
 </table>
 

data/VERSION.yml

@@ -1,5 +1,5 @@
 ---
 :minor: 0
-:build: RC1
-:patch: 0
+:build:
+:patch: 1
 :major: 1

data/examples/Gemfile

@@ -26,6 +26,8 @@ group :development do
   gem 'mysql', '~> 2.8.1'
   gem 'mysql2'
   gem 'pg'
+  gem 'sqlite3'
+  gem 'ohm', '~> 0.1.3'
 
   gem 'guard-rspec'
 end

data/examples/Gemfile.lock

@@ -135,6 +135,10 @@ GEM
     multi_json (1.5.0)
     mysql (2.8.1)
     mysql2 (0.3.11)
+    nest (1.1.2)
+      redis
+    ohm (0.1.5)
+      nest (~> 1.0)
     origin (1.0.11)
     pg (0.14.1)
     plucky (0.5.2)
@@ -160,6 +164,7 @@ GEM
     rake (10.0.3)
     rdoc (3.12)
       json (~> 1.4)
+    redis (3.0.4)
     rest-client (1.6.7)
       mime-types (>= 1.16)
     rspec (2.12.0)
@@ -213,6 +218,7 @@ DEPENDENCIES
   mongoid
   mysql (~> 2.8.1)
   mysql2
+  ohm (~> 0.1.3)
   pg
   rake
   rspec-rails

data/examples/config/redis.yml

@@ -0,0 +1,8 @@
+test:
+  url: 'redis://localhost:6379/0'
+
+one:
+  url: 'redis://localhost:6379/1'
+
+two:
+  url: 'redis://localhost:6379/2'

data/examples/features/support/env.rb

@@ -15,6 +15,10 @@ another_orm = ENV['ANOTHER_ORM']
 strategy    = ENV['STRATEGY']
 multiple_db = ENV['MULTIPLE_DBS']
 
+config = YAML::load(File.open("#{File.dirname(__FILE__)}/../../config/redis.yml"))
+ENV['REDIS_URL'] = config['test']['url']
+ENV['REDIS_URL_ONE'] = config['one']['url']
+ENV['REDIS_URL_TWO'] = config['two']['url']
 
 if orm && strategy
   $:.unshift(File.dirname(__FILE__) + '/../../../lib')
@@ -37,6 +41,9 @@ if orm && strategy
     when :mongo_mapper
       DatabaseCleaner[ orm_sym, {:connection => 'database_cleaner_test_one'} ].strategy = strategy.to_sym
       DatabaseCleaner[ orm_sym, {:connection => 'database_cleaner_test_two'} ].strategy = strategy.to_sym
+    when :redis, :ohm
+      DatabaseCleaner[ orm_sym, {:connection => ENV['REDIS_URL_ONE']} ].strategy = strategy.to_sym
+      DatabaseCleaner[ orm_sym, {:connection => ENV['REDIS_URL_TWO']} ].strategy = strategy.to_sym
     when :active_record
       DatabaseCleaner[:active_record, {:model => ActiveRecordWidgetUsingDatabaseOne} ].strategy = strategy.to_sym
       DatabaseCleaner[:active_record, {:model => ActiveRecordWidgetUsingDatabaseTwo} ].strategy = strategy.to_sym
@@ -53,5 +60,5 @@ if orm && strategy
   end
 
 else
-  raise "Run 'ORM=ActiveRecord|DataMapper|MongoMapper|CouchPotato [ANOTHER_ORM=...] [MULTIPLE_DBS=true] STRATEGY=transaction|truncation|default cucumber examples/features'"
+  raise "Run 'ORM=ActiveRecord|DataMapper|MongoMapper|CouchPotato|Ohm|Redis [ANOTHER_ORM=...] [MULTIPLE_DBS=true] STRATEGY=transaction|truncation|default cucumber examples/features'"
 end

data/examples/lib/mongoid_models.rb

@@ -2,7 +2,7 @@ require 'mongoid'
 
 Mongoid.configure do |config|
   name = 'database_cleaner_test'
-  config.master = Mongo::Connection.new.db(name)
+  config.connect_to(name)
 end
 
 

data/examples/lib/ohm_models.rb

@@ -0,0 +1,43 @@
+require 'ohm'
+
+Ohm.connect :url => ENV['REDIS_URL']
+
+class OhmWidget < Ohm::Model
+  attribute :name
+
+  def self.create!(attrs = {})
+    new({:name => 'some widget'}.merge(attrs)).save
+  end
+
+  def self.count
+    all.count
+  end
+
+end
+
+class OhmWidgetUsingDatabaseOne < Ohm::Model
+  connect :url => ENV['REDIS_URL_ONE']
+  attribute :name
+
+  def self.create!(attrs = {})
+    new({:name => 'a widget using database one'}.merge(attrs)).save
+  end
+
+  def self.count
+    all.count
+  end
+
+end
+
+class OhmWidgetUsingDatabaseTwo < Ohm::Model
+  connect :url => ENV['REDIS_URL_TWO']
+  attribute :name
+
+  def self.create!(attrs = {})
+    new({:name => 'a widget using database two'}.merge(attrs)).save
+  end
+
+  def self.count
+    all.count
+  end
+end

data/examples/lib/redis_models.rb

@@ -0,0 +1,65 @@
+require 'redis'
+
+class RedisWidget
+
+  def self.redis
+    threaded ||= Redis.connect
+  end
+
+  def self.redis=(connection)
+    threaded = connection
+  end
+
+  def self.threaded
+    Thread.current[self.class.to_s] ||= {}
+  end
+
+  def initialize(options = {})
+    options = options.dup
+    @name = options[:name]
+  end
+
+  def connection
+    self.class.redis
+  end
+
+  def save
+    unless connection.get(self.class.to_s + ':id')
+      @id = 0
+      connection.set(self.class.to_s + ':id', @id)
+    end
+    @id = connection.incr(self.class.to_s + ':id')
+    connection.set(self.class.to_s + ':%d:name' % @id, @name)
+  end
+
+  def self.count
+    self.redis.keys(self.to_s + '*name').size
+  end
+
+  def self.create!
+    new(:name => 'some widget').save
+
+  end
+end
+
+class RedisWidgetUsingDatabaseOne < RedisWidget
+
+  def self.redis
+    threaded[self.class.to_s] ||= Redis.connect :url => ENV['REDIS_URL_ONE']
+  end
+
+  def self.create!
+    new(:name => 'a widget using database one').save
+  end
+end
+
+class RedisWidgetUsingDatabaseTwo < RedisWidget
+
+  def self.redis
+    threaded[self.class.to_s] ||= Redis.connect :url => ENV['REDIS_URL_TWO']
+  end
+
+  def self.create!
+    new(:name => 'a widget using database two').save
+  end
+end

data/features/cleaning.feature

@@ -11,12 +11,14 @@ Feature: database cleaning
     Then I should see all green
 
   Examples:
-    | ORM          | Strategy      |
-    | ActiveRecord | transaction   |
-    | ActiveRecord | truncation    |
-    | ActiveRecord | deletion      |
-    | DataMapper   | transaction   |
-    | DataMapper   | truncation    |
-    | MongoMapper  | truncation    |
-    | Mongoid      | truncation    |
-    | CouchPotato  | truncation    |
+    | ORM          | Strategy    |
+    | ActiveRecord | transaction |
+    | ActiveRecord | truncation  |
+    | ActiveRecord | deletion    |
+    | DataMapper   | transaction |
+    | DataMapper   | truncation  |
+    | MongoMapper  | truncation  |
+    | Mongoid      | truncation  |
+    | CouchPotato  | truncation  |
+    | Redis        | truncation  |
+    | Ohm          | truncation  |

data/features/cleaning_default_strategy.feature

@@ -17,3 +17,5 @@ Feature: database cleaning
     | MongoMapper  |
     | Mongoid      |
     | CouchPotato  |
+    | Redis        |
+    | Ohm          |

data/features/cleaning_multiple_orms.feature

@@ -15,15 +15,34 @@ Feature: database cleaning using multiple ORMs
     | ActiveRecord | MongoMapper  |
     | ActiveRecord | Mongoid      |
     | ActiveRecord | CouchPotato  |
+    | ActiveRecord | Ohm          |
+    | ActiveRecord | Redis        |
     | DataMapper   | ActiveRecord |
     | DataMapper   | MongoMapper  |
     | DataMapper   | Mongoid      |
     | DataMapper   | CouchPotato  |
+    | DataMapper   | Ohm          |
+    | DataMapper   | Redis        |
     | MongoMapper  | ActiveRecord |
     | MongoMapper  | DataMapper   |
     | MongoMapper  | Mongoid      |
     | MongoMapper  | CouchPotato  |
+    | MongoMapper  | Ohm          |
+    | MongoMapper  | Redis        |
     | CouchPotato  | ActiveRecord |
     | CouchPotato  | DataMapper   |
     | CouchPotato  | MongoMapper  |
     | CouchPotato  | Mongoid      |
+    | CouchPotato  | Ohm          |
+    | CouchPotato  | Redis        |
+    | Ohm          | ActiveRecord |
+    | Ohm          | DataMapper   |
+    | Ohm          | MongoMapper  |
+    | Ohm          | Mongoid      |
+    | Ohm          | CouchPotato  |
+    | Redis        | ActiveRecord |
+    | Redis        | DataMapper   |
+    | Redis        | MongoMapper  |
+    | Redis        | Mongoid      |
+    | Redis        | CouchPotato  |
+    | Redis        | Ohm          |

data/features/step_definitions/database_cleaner_steps.rb

@@ -1,10 +1,11 @@
+orms_pattern = /(ActiveRecord|DataMapper|MongoMapper|Mongoid|CouchPotato|Redis|Ohm)/
 
-Given /^I am using (ActiveRecord|DataMapper|MongoMapper|Mongoid|CouchPotato)$/ do |orm|
+Given /^I am using #{orms_pattern}$/ do |orm|
   @feature_runner = FeatureRunner.new
   @feature_runner.orm = orm
 end
 
-Given /^I am using (ActiveRecord|DataMapper|MongoMapper|CouchPotato|Mongoid) and (ActiveRecord|DataMapper|MongoMapper|CouchPotato|Mongoid)$/ do |orm1,orm2|
+Given /^I am using #{orms_pattern} and #{orms_pattern}$/ do |orm1,orm2|
   @feature_runner = FeatureRunner.new
   @feature_runner.orm         = orm1
   @feature_runner.another_orm = orm2

data/features/step_definitions/ohm_steps.rb

@@ -0,0 +1,31 @@
+Given /^I have setup database cleaner to clean multiple databases using ohm$/ do
+  #DatabaseCleaner
+  # require "#{File.dirname(__FILE__)}/../../../lib/ohm_models"
+  #
+  # DatabaseCleaner[:ohm, {:connection => ENV['REDIS_URL_ONE']} ].strategy = :truncation
+  # DatabaseCleaner[:ohm, {:connection => ENV['REDIS_URL_TWO']} ].strategy = :truncation
+end
+
+When /^I create a widget using ohm$/ do
+  OhmWidget.create!
+end
+
+Then /^I should see ([\d]+) widget using ohm$/ do |widget_count|
+  OhmWidget.count.should == widget_count.to_i
+end
+
+When /^I create a widget in one db using ohm$/ do
+  OhmWidgetUsingDatabaseOne.create!
+end
+
+When /^I create a widget in another db using ohm$/ do
+  OhmWidgetUsingDatabaseTwo.create!
+end
+
+Then /^I should see ([\d]+) widget in one db using ohm$/ do |widget_count|
+  OhmWidgetUsingDatabaseOne.count.should == widget_count.to_i
+end
+
+Then /^I should see ([\d]+) widget in another db using ohm$/ do |widget_count|
+  OhmWidgetUsingDatabaseTwo.count.should == widget_count.to_i
+end