database_cleaner 0.8.0 → 0.9.1

data/Gemfile.lock

@@ -1,28 +1,49 @@
 GEM
   remote: http://rubygems.org/
   specs:
-    ZenTest (4.3.3)
-    activerecord (2.3.8)
-      activesupport (= 2.3.8)
-    activesupport (2.3.8)
-    addressable (2.2.0)
-    bson (1.0.4)
-    builder (2.1.2)
-    columnize (0.3.1)
-    couch_potato (0.3.0)
-      couchrest (>= 0.24)
+    ZenTest (4.8.1)
+    actionpack (3.2.6)
+      activemodel (= 3.2.6)
+      activesupport (= 3.2.6)
+      builder (~> 3.0.0)
+      erubis (~> 2.7.0)
+      journey (~> 1.0.1)
+      rack (~> 1.4.0)
+      rack-cache (~> 1.2)
+      rack-test (~> 0.6.1)
+      sprockets (~> 2.1.3)
+    activemodel (3.2.6)
+      activesupport (= 3.2.6)
+      builder (~> 3.0.0)
+    activerecord (3.2.6)
+      activemodel (= 3.2.6)
+      activesupport (= 3.2.6)
+      arel (~> 3.0.2)
+      tzinfo (~> 0.3.29)
+    activesupport (3.2.6)
+      i18n (~> 0.6)
+      multi_json (~> 1.0)
+    addressable (2.2.8)
+    arel (3.0.2)
+    bson (1.6.4)
+    bson_ext (1.6.4)
+      bson (~> 1.6.4)
+    builder (3.0.0)
+    columnize (0.3.6)
+    couch_potato (0.5.7)
+      activemodel
+      couchrest (>= 1.0.1)
       json
     couchrest (1.0.1)
       json (>= 1.4.6)
       mime-types (>= 1.15)
       rest-client (>= 1.5.1)
-    cucumber (0.8.5)
-      builder (~> 2.1.2)
-      diff-lcs (~> 1.1.2)
-      gherkin (~> 2.1.4)
-      json_pure (~> 1.4.3)
-      term-ansicolor (~> 1.0.4)
-    data_objects (0.10.2)
+    cucumber (1.2.1)
+      builder (>= 2.1.2)
+      diff-lcs (>= 1.1.3)
+      gherkin (~> 2.11.0)
+      json (>= 1.4.6)
+    data_objects (0.10.8)
       addressable (~> 2.1)
     datamapper (1.0.0)
       dm-aggregates (= 1.0.0)
@@ -35,7 +56,7 @@ GEM
       dm-transactions (= 1.0.0)
       dm-types (= 1.0.0)
       dm-validations (= 1.0.0)
-    diff-lcs (1.1.2)
+    diff-lcs (1.1.3)
     dm-aggregates (1.0.0)
       dm-core (~> 1.0.0)
     dm-constraints (1.0.0)
@@ -68,96 +89,143 @@ GEM
       uuidtools (~> 2.1.1)
     dm-validations (1.0.0)
       dm-core (~> 1.0.0)
-    do_sqlite3 (0.10.2)
-      data_objects (= 0.10.2)
-    durran-validatable (2.0.1)
+    do_sqlite3 (0.10.8)
+      data_objects (= 0.10.8)
+    erubis (2.7.0)
     extlib (0.9.15)
-    fastercsv (1.5.3)
-    ffi (0.6.3)
-      rake (>= 0.8.7)
-    gemcutter (0.6.1)
-    gherkin (2.1.5)
-      trollop (~> 1.16.2)
+    fastercsv (1.5.5)
+    ffi (1.1.4)
+    gherkin (2.11.1)
+      json (>= 1.4.6)
     git (1.2.5)
-    growl (1.0.3)
-    jeweler (1.4.0)
-      gemcutter (>= 0.1.0)
+    guard (1.3.0)
+      listen (>= 0.4.2)
+      thor (>= 0.14.6)
+    guard-rspec (1.2.1)
+      guard (>= 1.1)
+    hike (1.2.1)
+    i18n (0.6.0)
+    jeweler (1.8.4)
+      bundler (~> 1.0)
       git (>= 1.2.5)
-      rubyforge (>= 2.0.0)
-    jnunemaker-validatable (1.8.4)
-      activesupport (>= 2.3.4)
-    json (1.4.6)
+      rake
+      rdoc
+    journey (1.0.4)
+    json (1.7.3)
     json_pure (1.4.6)
-    libnotify (0.2.0)
-      ffi (>= 0.6.2)
-    linecache (0.43)
-    mime-types (1.16)
-    mongo (1.0.7)
-      bson (>= 1.0.4)
-    mongo_mapper (0.8.2)
-      activesupport (>= 2.3.4)
-      jnunemaker-validatable (~> 1.8.4)
-      plucky (~> 0.3.1)
-    mongoid (1.9.1)
-      activesupport (<= 3.0.0)
-      bson (~> 1.0.1)
-      durran-validatable (>= 2.0.1)
-      mongo (~> 1.0.1)
-      will_paginate (< 2.9)
-    plucky (0.3.4)
-      mongo (~> 1.0.7)
-    rake (0.8.7)
-    rb-inotify (0.8.1)
+    linecache (0.46)
+      rbx-require-relative (> 0.0.4)
+    listen (0.4.7)
+      rb-fchange (~> 0.0.5)
+      rb-fsevent (~> 0.9.1)
+      rb-inotify (~> 0.8.8)
+    mime-types (1.19)
+    mongo (1.6.4)
+      bson (~> 1.6.4)
+    mongo_ext (0.19.3)
+    mongo_mapper (0.11.1)
+      activemodel (~> 3.0)
+      activesupport (~> 3.0)
+      plucky (~> 0.4.0)
+    mongoid (3.0.1)
+      activemodel (~> 3.1)
+      moped (~> 1.1.1)
+      origin (~> 1.0.3)
+      tzinfo (~> 0.3.22)
+    moped (1.1.2)
+    multi_json (1.3.6)
+    mysql (2.8.1)
+    mysql2 (0.3.11)
+    origin (1.0.4)
+    pg (0.14.0)
+    plucky (0.4.4)
+      mongo (~> 1.5)
+    rack (1.4.1)
+    rack-cache (1.2)
+      rack (>= 0.4)
+    rack-ssl (1.3.2)
+      rack
+    rack-test (0.6.1)
+      rack (>= 1.0)
+    railties (3.2.6)
+      actionpack (= 3.2.6)
+      activesupport (= 3.2.6)
+      rack-ssl (~> 1.3.2)
+      rake (>= 0.8.7)
+      rdoc (~> 3.4)
+      thor (>= 0.14.6, < 2.0)
+    rake (0.9.2.2)
+    rb-fchange (0.0.5)
+      ffi
+    rb-fsevent (0.9.1)
+    rb-inotify (0.8.8)
       ffi (>= 0.5.0)
-    rcov (0.9.8)
-    rest-client (1.6.0)
+    rbx-require-relative (0.0.9)
+    rcov (1.0.0)
+    rdoc (3.12)
+      json (~> 1.4)
+    rest-client (1.6.7)
       mime-types (>= 1.16)
-    rspactor (0.7.0.beta.6)
-      bundler (>= 1.0.0.rc.5)
-      growl (>= 1.0.3)
-      libnotify (>= 0.1.3)
-      rb-inotify
-      sys-uname (>= 0.8.4)
-      trollop (>= 1.16.2)
-    rspec (1.3.0)
-    ruby-debug (0.10.3)
+    rspactor (0.6.4)
+    rspec (2.11.0)
+      rspec-core (~> 2.11.0)
+      rspec-expectations (~> 2.11.0)
+      rspec-mocks (~> 2.11.0)
+    rspec-core (2.11.1)
+    rspec-expectations (2.11.1)
+      diff-lcs (~> 1.1.3)
+    rspec-mocks (2.11.1)
+    rspec-rails (2.11.0)
+      actionpack (>= 3.0)
+      activesupport (>= 3.0)
+      railties (>= 3.0)
+      rspec (~> 2.11.0)
+    ruby-debug (0.10.4)
       columnize (>= 0.1)
-      ruby-debug-base (~> 0.10.3.0)
-    ruby-debug-base (0.10.3)
+      ruby-debug-base (~> 0.10.4.0)
+    ruby-debug-base (0.10.4)
       linecache (>= 0.3)
-    rubyforge (2.0.4)
-      json_pure (>= 1.1.7)
     sequel (3.21.0)
-    sqlite3-ruby (1.3.1)
+    sprockets (2.1.3)
+      hike (~> 1.2)
+      rack (~> 1.0)
+      tilt (~> 1.1, != 1.3.0)
+    sqlite3 (1.3.6)
+    sqlite3-ruby (1.3.3)
+      sqlite3 (>= 1.3.3)
     stringex (1.1.0)
-    sys-uname (0.8.4)
-    term-ansicolor (1.0.5)
-    trollop (1.16.2)
-    tzinfo (0.3.22)
-    uuidtools (2.1.1)
-    will_paginate (2.3.14)
+    thor (0.15.4)
+    tilt (1.3.3)
+    tzinfo (0.3.33)
+    uuidtools (2.1.3)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
   ZenTest
-  activerecord (= 2.3.8)
+  activerecord
+  bson_ext
   bundler
-  couch_potato (= 0.3.0)
+  couch_potato
   cucumber
   datamapper (= 1.0.0)
   dm-migrations (= 1.0.0)
   dm-sqlite-adapter (= 1.0.0)
+  guard-rspec
   jeweler
   json_pure
-  mongo_mapper (= 0.8.2)
-  mongoid (= 1.9.1)
+  mongo_ext
+  mongo_mapper
+  mongoid
+  mysql
+  mysql2
+  pg
   rake
   rcov
   rspactor
-  rspec
+  rspec-rails
   ruby-debug
   sequel (~> 3.21.0)
   sqlite3-ruby
-  tzinfo (= 0.3.22)
+  tzinfo

data/History.txt

@@ -1,7 +1,25 @@
-== 0.8.x (in git)
+== 0.9.0 2012-10-11
+
+ === New Features
+
+  * New options for AR :truncation for speed.  See README for details. (Stanislaw Pankevich)
+  * view caching works with the schema_plus gem loaded
+    * ActiveRecord::ConnectionAdapters::AbstractAdapter#views was renamed to an internal name
+  * ActiveRecord truncation strategy caches the list of tables #130 (Petteri Räty)
+  * Caches AR DB connections which speeds up cleaning with multiple DBs and allows for transation strategy.
+  * MongoDB :truncation strategy (wihtout use of additional library like Mogoid). #138 (Christopher Darrell & Richard Luther/@sidereel)
+  * Add Sequel support for multiple migration storage names in #148 (Jack Chu)
+  * Multiple database support for Mongoid 3 #149 (Luke Francl)
+
+ === Bug Fixes
+  * :deletion for AR Postgres in JRuby now works #140 (Heiko Seebach)
+  * Rescue LoadError when AR adapters not available. #145 (Garrow Bedrossian)
+  * Fixes DatabaseCleaner::[] to cache cleaners.
 
 == 0.8.0 2012-06-02
 
+  * Faster truncation strategy for ActiveRecord with MySQL or PostgreSQL
+  * Upgrade to RSpec 2
   * Support for Mongoid 3/Moped (Andrew Bennett)
   * Postgres Adapter no longer generates invalid SQL when no tables provided. (Michael-Keith Bernard)
 

data/README.textile

@@ -7,6 +7,8 @@ that is testing with a database.
 
 ActiveRecord, DataMapper, Sequel, MongoMapper, Mongoid, and CouchPotato are supported.
 
+!https://secure.travis-ci.org/bmabey/database_cleaner.png(Build Status)!:http://travis-ci.org/bmabey/database_cleaner
+
 Here is an overview of the strategies supported for each library:
 
 |_. ORM        |_.  Truncation  |_.  Transaction  |_.  Deletion    |
@@ -17,18 +19,36 @@ Here is an overview of the strategies supported for each library:
 | Mongoid      | **Yes**        | No              | No             |
 | Sequel       | **Yes**        | Yes             | No             |
 
-(Default strategy for each library is denoted in bold)
+|_. Driver     |_.  Truncation  |_.  Transaction  |_.  Deletion    |
+| Mongo        | Yes            | No              | No             |
 
-The ActiveRecord @:deletion@ strategy is useful for when the @:truncation@ strategy causes
-locks (as reported by some Oracle DB users).  The @:deletion@ option has been reported to
-be faster than @:truncation@ in some cases as well.  In general, the best approach is to use
-@:transaction@ since it is the fastest.
+(Default strategy for each library is denoted in bold)
 
 Database Cleaner also includes a @null@ strategy (that does no cleaning at all) which can be used
 with any ORM library. You can also explicitly use it by setting your strategy to @nil@.
 
 For support or to discuss development please use the "Google Group":http://groups.google.com/group/database_cleaner.
 
+h2(fastest). What strategy is fastest?
+
+For the SQL libraries the fastest option will be to use @:transaction@ as transactions are
+simply rolled back.  If you can use this strategy you should.  However, if you wind up needing 
+to use multiple database connections in your tests (i.e. your tests run in a different proceess 
+than your application) then using this strategy becomes a bit more difficult. You can get around the 
+problem a number of ways.  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).  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. 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.  If you are using ActiveRecord then take a look 
+at the "additional options":#ar_truncation available for  @:truncation@.
+
 h2. Dependencies
 
 Because database_cleaner supports multiple ORMs, it doesn't make sense to include all the dependencies
@@ -80,21 +100,18 @@ strategy the remaining time.  To accomplish this you can say:
   # then make the DatabaseCleaner.start and DatabaseCleaner.clean calls appropriately
 </pre>
 
-h3. Minitest Example
+h3(#ar_truncation). Additional ActiveRecord options for Truncation
 
-<pre>
-DatabaseCleaner.strategy = :transaction
+The following options are available for ActiveRecord's @:truncation@ strategy _only_ for 
+MySQL and Postgres.
 
-class MiniTest::Spec
-  before :each do
-    DatabaseCleaner.clean
-  end
+* @:pre_count@ - When set to @true@ this will check each table for existing rows before 
+truncating it.  This can speed up test suites when many of the tables to be truncated 
+are never populated. Defaults to @:false@. (Also, see the section on "What strategy is fastest?":#fastest)
+* @:reset_ids@ - This only matters when @:pre_count@ is used, and it will make sure that a 
+tables auto-incrementing id is reset even if there are no rows in the table (e.g. records 
+were created in the test but also removed before DatabaseCleaner gets to it). Defaults to @true@.
 
-  after :each do
-    DatabaseCleaner.clean
-  end
-end
-</pre>
 
 h3. RSpec Example
 
@@ -117,9 +134,27 @@ RSpec.configure do |config|
 end
 </pre>
 
+h3. Minitest Example
+
+<pre>
+DatabaseCleaner.strategy = :transaction
+
+class MiniTest::Spec
+  before :each do
+    DatabaseCleaner.start
+  end
+
+  after :each do
+    DatabaseCleaner.clean
+  end
+end
+</pre>
+
 h3. Cucumber Example
 
-Add this to your features/support/env.rb file:
+If you're using Cucumber with Rails, just use the generator that ships with cucumber-rails, and that will create all the code you need to integrate DatabaseCleaner into your Rails project.
+
+Otherwise, to add DatabaseCleaner to your project by hand, create a file features/support/database_cleaner.rb that looks like this:
 
 <pre>
 begin
@@ -129,13 +164,7 @@ begin
 rescue NameError
   raise "You need to add database_cleaner to your Gemfile (in the :test group) if you wish to use it."
 end
-</pre>
-
-A good idea is to create the before and after hooks to use the DatabaseCleaner.start and DatabaseCleaner.clean methods.
-
-Inside features/support/hooks.rb:
 
-<pre>
 Before do
   DatabaseCleaner.start
 end
@@ -159,6 +188,9 @@ Sometimes you need to use multiple ORMs in your application. You can use Databas
 
   #How to specify particular connections
   DatabaseCleaner[:active_record,{:connection => :two}]
+
+  # You may also pass in the model directly:
+  DatabaseCleaner[:active_record,{:model => ModelWithDifferentConnection}]
 </pre>
 
 Usage beyond that remains the same with DatabaseCleaner.start calling any setup on the different configured connections, and DatabaseCleaner.clean executing afterwards.
@@ -167,48 +199,18 @@ Configuration options
 
 
 |_. ORM         |_.   How to access               |_.   Notes                                                                |
-| Active Record | DatabaseCleaner[:active_record] | Connection specified as :symbol keys, loaded from config/database.yml    |
+| Active Record | DatabaseCleaner[:active_record] | Connection specified as :symbol keys, loaded from config/database.yml. You may also pass in the ActiveRecord model under the @:model@ key.    |
 | Data Mapper   | DatabaseCleaner[:data_mapper]   | Connection specified as :symbol keys, loaded via Datamapper repositories |
 | Mongo Mapper  | DatabaseCleaner[:mongo_mapper]  | Multiple connections not yet supported                                   |
-| Mongoid       | DatabaseCleaner[:mongoid]       | Multiple connections not yet supported                                   |
+| Mongoid       | DatabaseCleaner[:mongoid]       | Multiple databases supported for Mongoid 3. Specify DatabaseCleaner[:mongoid, {:connection => :db_name}] |
 | Couch Potato  | DatabaseCleaner[:couch_potato]  | Multiple connections not yet supported                                   |
 | Sequel        | DatabaseCleaner[:sequel]        | ?                                                                        |
 
 h2. Why?
 
-One of my motivations for writing this library was to have an easy way to
-turn on what Rails calls "transactional_fixtures" in my non-rails
-ActiveRecord projects.  For example, Cucumber ships with a Rails world that
-will wrap each scenario in a transaction.  This is great, but what if you are
-using ActiveRecord in a non-rails project?  You used to have to copy-and-paste
-the needed code, but with DatabaseCleaner you can now say:
-
-<pre>
-  #env.rb
-  require 'database_cleaner'
-  require 'database_cleaner/cucumber'
-  DatabaseCleaner.strategy = :transaction
-</pre>
-
-Now lets say you are running your features and it requires that another process be
-involved (i.e. Selenium running against your app's server.)  You can simply change
-your strategy type:
-
-<pre>
-  #env.rb
-  require 'database_cleaner'
-  require 'database_cleaner/cucumber'
-  DatabaseCleaner.strategy = :truncation
-</pre>
-
-You can have the best of both worlds and use the best one for the job:
-<pre>
-  #env.rb
-  require 'database_cleaner'
-  require 'database_cleaner/cucumber'
-  DatabaseCleaner.strategy = (ENV['SELENIUM'] == 'true') ? :truncation : :transaction
-</pre>
-
+One of my motivations for writing this library was to have an easy way to turn on what Rails calls "transactional_fixtures" 
+in my non-rails ActiveRecord projects.  After copying and pasting code to do this several times I decided to package it up 
+as a gem and same everyone a bit of time.
 
 h2. Common Errors