database_cleaner 0.7.0 → 0.7.1

data/History.txt

@@ -1,5 +1,20 @@
 == 0.7.x (in git)
 
+== 0.7.1 2012-01-15
+
+ === New Features
+
+ * Support for Rails 3.2. (David Demaree)
+
+=== Bugfixes
+
+  * Truncation resets the id count on SQLite. (Jordan Hollinger)
+  * AR delete strategy now disables referential integrity. (Ben Mabey)
+  * Fixes Postgres adapter for JRuby. (Dmytrii Nagirniak, Uģis Ozols)
+  * Documenation fixes. (Josh Rendek, Joshua Flanagan)
+  * Fixes bad error message when no database is specified for AR. (issue #72, Ben Mabey)
+
+
 == 0.7.0 2011-11-12
 
  === New Features

data/README.textile

@@ -5,7 +5,7 @@ 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, MongoMapper, Mongoid, and CouchPotato are supported.
+ActiveRecord, DataMapper, Sequel, MongoMapper, Mongoid, and CouchPotato are supported.
 
 Here is an overview of the strategies supported for each library:
 
@@ -14,15 +14,16 @@ Here is an overview of the strategies supported for each library:
 | DataMapper   | Yes            | **Yes**         | No             |
 | CouchPotato  | **Yes**        | No              | No             |
 | MongoMapper  | **Yes**        | No              | No             |
-| Mongoid      | **Yes**        | No              | No             |
+| Sequel       | **Yes**        | Yes             | No             |
 
 (Default strategy for each library is denoted in bold)
 
-The ActiveRecord @:deletion@ strategy is only useful for when the @:truncation@ strategy causes
-locks (as reported by some Oracle DB users).  The @:truncation@ strategy is the preferred option
-since it is much faster.
+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.
 
-Database Cleaner also includes a @null@ strategy (that does no cleaning at all) which can be used 
+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@.
 
 h2. How to use
@@ -70,7 +71,7 @@ strategy the remaining time.  To accomplish this you can say:
   # then make the DatabaseCleaner.start and DatabaseCleaner.clean calls appropriately
 </pre>
 
-Example usage with RSpec:
+h3. RSpec Example
 
 <pre>
 RSpec.configure do |config|
@@ -91,7 +92,38 @@ RSpec.configure do |config|
 end
 </pre>
 
-For use in Cucumber please see the section below.
+h3. Cucumber Example
+
+Add this to your features/support/env.rb file:
+
+<pre>
+begin
+  require 'database_cleaner'
+  require 'database_cleaner/cucumber'
+  DatabaseCleaner.strategy = :truncation
+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
+
+After do |scenario|
+  DatabaseCleaner.clean
+end
+</pre>
+
+This should cover the basics of tear down between scenarios and keeping your database clean.
+For more examples see the section "Why?"
+
+h2. Common Errors
 
 In rare cases DatabaseCleaner will encounter errors that it will log.  By default it uses STDOUT set to the ERROR level but you can configure this to use whatever Logger you desire.  Here's an example of using the Rails.logger in env.rb:
 
@@ -114,7 +146,7 @@ Sometimes you need to use multiple ORMs in your application. You can use Databas
   #How to specify particular orms
   DatabaseCleaner[:active_record].strategy = :transaction
   DatabaseCleaner[:mongo_mapper].strategy = :truncation
-  
+
   #How to specify particular connections
   DatabaseCleaner[:active_record,{:connection => :two}]
 </pre>
@@ -130,6 +162,7 @@ Configuration options
 | Mongo Mapper  | DatabaseCleaner[:mongo_mapper]  | Multiple connections not yet supported                                   |
 | Mongoid       | DatabaseCleaner[:mongoid]       | Multiple connections not yet supported                                   |
 | Couch Potato  | DatabaseCleaner[:couch_potato]  | Multiple connections not yet supported                                   |
+| Sequel        | DatabaseCleaner[:sequel]        | ?                                                                        |
 
 h2. Why?
 

data/VERSION.yml

@@ -2,4 +2,4 @@
 :major: 0
 :build: 
 :minor: 7
-:patch: 0
+:patch: 1

data/lib/database_cleaner/active_record/base.rb

@@ -43,7 +43,7 @@ module DatabaseCleaner
       end
 
       def connection_klass
-        return ::ActiveRecord::Base if connection_hash.nil?
+        return ::ActiveRecord::Base unless connection_hash
         klass = create_connection_klass
         klass.send :establish_connection, connection_hash
         klass

data/lib/database_cleaner/active_record/deletion.rb

@@ -54,8 +54,10 @@ module DatabaseCleaner::ActiveRecord
 
     def clean
       connection = connection_klass.connection
-      tables_to_truncate(connection).each do |table_name|
-        connection.delete_table table_name
+      connection.disable_referential_integrity do
+        tables_to_truncate(connection).each do |table_name|
+          connection.delete_table table_name
+        end
       end
     end
 

data/lib/database_cleaner/active_record/transaction.rb

@@ -14,6 +14,8 @@ module DatabaseCleaner::ActiveRecord
 
 
     def clean
+      return unless connection_klass.connection.open_transactions > 0
+
       connection_klass.connection.rollback_db_transaction
 
       if connection_klass.connection.respond_to?(:decrement_open_transactions)

data/lib/database_cleaner/active_record/truncation.rb

@@ -29,8 +29,17 @@ module ActiveRecord
       end
     end
 
-    MYSQL_ADAPTER_PARENT = USE_ARJDBC_WORKAROUND ? JdbcAdapter : AbstractAdapter
+    # ActiveRecord 3.1 support
+    if defined?(AbstractMysqlAdapter)
+      MYSQL_ADAPTER_PARENT = USE_ARJDBC_WORKAROUND ? JdbcAdapter : AbstractMysqlAdapter
+      MYSQL2_ADAPTER_PARENT = AbstractMysqlAdapter
+    else
+      MYSQL_ADAPTER_PARENT = USE_ARJDBC_WORKAROUND ? JdbcAdapter : AbstractAdapter
+      MYSQL2_ADAPTER_PARENT = AbstractAdapter
+    end
+    
     SQLITE_ADAPTER_PARENT = USE_ARJDBC_WORKAROUND ? JdbcAdapter : SQLiteAdapter
+    POSTGRE_ADAPTER_PARENT = USE_ARJDBC_WORKAROUND ? JdbcAdapter : AbstractAdapter
 
     class MysqlAdapter < MYSQL_ADAPTER_PARENT
       def truncate_table(table_name)
@@ -38,7 +47,7 @@ module ActiveRecord
       end
     end
 
-    class Mysql2Adapter < AbstractAdapter
+    class Mysql2Adapter < MYSQL2_ADAPTER_PARENT
       def truncate_table(table_name)
         execute("TRUNCATE TABLE #{quote_table_name(table_name)};")
       end
@@ -53,6 +62,7 @@ module ActiveRecord
     class SQLite3Adapter < SQLITE_ADAPTER_PARENT
       def delete_table(table_name)
         execute("DELETE FROM #{quote_table_name(table_name)};")
+        execute("DELETE FROM sqlite_sequence where name = '#{table_name}';")
       end
       alias truncate_table delete_table
     end
@@ -67,7 +77,7 @@ module ActiveRecord
       end
     end
 
-    class PostgreSQLAdapter < AbstractAdapter
+    class PostgreSQLAdapter < POSTGRE_ADAPTER_PARENT
 
       def db_version
         @db_version ||= postgresql_version
@@ -138,3 +148,4 @@ module DatabaseCleaner::ActiveRecord
 end
 
 
+

data/lib/database_cleaner/base.rb

@@ -80,7 +80,7 @@ module DatabaseCleaner
     alias clean! clean
 
     def auto_detected?
-      return true unless @autodetected.nil?
+      !!@autodetected
     end
 
     #TODO make strategies directly comparable

data/lib/database_cleaner/configuration.rb

@@ -7,7 +7,7 @@ module DatabaseCleaner
 
   class << self
     def [](orm,opts = {})
-      raise NoORMDetected if orm.nil?
+      raise NoORMDetected unless orm
       @connections ||= []
       cleaner = DatabaseCleaner::Base.new(orm,opts)
       connections.push cleaner

data/lib/database_cleaner/data_mapper/transaction.rb

@@ -3,9 +3,8 @@ require 'database_cleaner/data_mapper/base'
 module DatabaseCleaner::DataMapper
   class Transaction
     include ::DatabaseCleaner::DataMapper::Base
-    #TODO Figure out repositories, may have to refactor connection_klass to something more sensible
-    def start(repository = nil)
-      repository = self.db if repository.nil?
+
+    def start(repository = self.db)
       ::DataMapper.repository(repository) do |r|
         transaction = DataMapper::Transaction.new(r)
         transaction.begin
@@ -13,8 +12,7 @@ module DatabaseCleaner::DataMapper
       end
     end
 
-    def clean(repository = nil)
-      repository = self.db if repository.nil?
+    def clean(repository = self.db)
       ::DataMapper.repository(repository) do |r|
         adapter = r.adapter
         while adapter.current_transaction

data/lib/database_cleaner/data_mapper/truncation.rb

@@ -53,6 +53,7 @@ module DataMapper
 
       def truncate_table(table_name)
         execute("DELETE FROM #{quote_name(table_name)};")
+        execute("DELETE FROM sqlite_sequence where name = '#{table_name}';")
       end
 
       # this is a no-op copied from activerecord
@@ -79,6 +80,7 @@ module DataMapper
 
       def truncate_table(table_name)
         execute("DELETE FROM #{quote_name(table_name)};")
+        execute("DELETE FROM sqlite_sequence where name = '#{table_name}';")
       end
 
       # this is a no-op copied from activerecord
@@ -107,7 +109,7 @@ module DataMapper
       end
 
       def truncate_table(table_name)
-        execute("TRUNCATE TABLE #{quote_name(table_name)} CASCADE;")
+        execute("TRUNCATE TABLE #{quote_name(table_name)} RESTART IDENTITY CASCADE;")
       end
 
       # FIXME
@@ -148,8 +150,7 @@ module DatabaseCleaner
       include ::DatabaseCleaner::DataMapper::Base
       include ::DatabaseCleaner::Generic::Truncation
 
-      def clean(repository = nil)
-        repository = self.db if repository.nil?
+      def clean(repository = self.db)
         adapter = ::DataMapper.repository(repository).adapter
         adapter.disable_referential_integrity do
           tables_to_truncate(repository).each do |table_name|
@@ -160,8 +161,7 @@ module DatabaseCleaner
 
       private
 
-      def tables_to_truncate(repository = nil)
-        repository = self.db if repository.nil?
+      def tables_to_truncate(repository = self.db)
         (@only || ::DataMapper.repository(repository).adapter.storage_names(repository)) - @tables_to_exclude
       end
 

data/lib/database_cleaner/generic/truncation.rb

@@ -1,42 +1,36 @@
 module DatabaseCleaner
   module Generic
     module Truncation
-      def self.included(base)
-       base.send(:include, InstanceMethods)
-      end
-
-      module InstanceMethods
-        def initialize(opts={})
-          if !opts.empty? && !(opts.keys - [:only, :except]).empty?
-            raise ArgumentError, "The only valid options are :only and :except. You specified #{opts.keys.join(',')}."
-          end
-          if opts.has_key?(:only) && opts.has_key?(:except)
-            raise ArgumentError, "You may only specify either :only or :either.  Doing both doesn't really make sense does it?"
-          end
-
-          @only = opts[:only]
-          @tables_to_exclude = (opts[:except] || []).dup
-          @tables_to_exclude << migration_storage_name unless migration_storage_name.nil?
+      def initialize(opts={})
+        if !opts.empty? && !(opts.keys - [:only, :except]).empty?
+          raise ArgumentError, "The only valid options are :only and :except. You specified #{opts.keys.join(',')}."
         end
-
-        def start
-          #included for compatability reasons, do nothing if you don't need to
+        if opts.has_key?(:only) && opts.has_key?(:except)
+          raise ArgumentError, "You may only specify either :only or :except.  Doing both doesn't really make sense does it?"
         end
 
-        def clean
-          raise NotImplementedError
-        end
+        @only = opts[:only]
+        @tables_to_exclude = (opts[:except] || []).dup
+        @tables_to_exclude << migration_storage_name if migration_storage_name
+      end
 
-        private
-          def tables_to_truncate
-            raise NotImplementedError
-          end
+      def start
+        #included for compatability reasons, do nothing if you don't need to
+      end
+
+      def clean
+        raise NotImplementedError
+      end
+
+      private
+      def tables_to_truncate
+        raise NotImplementedError
+      end
 
-          # overwrite in subclasses
-          # default implementation given because migration storage need not be present
-          def migration_storage_name
-            nil
-          end
+      # overwrite in subclasses
+      # default implementation given because migration storage need not be present
+      def migration_storage_name
+        nil
       end
     end
   end

data/spec/database_cleaner/active_record/base_spec.rb

@@ -34,7 +34,6 @@ module DatabaseCleaner
       it_should_behave_like "a generic strategy"
 
       describe "db" do
-        it { should respond_to(:db=) }
 
         it "should store my desired db" do
           subject.stub(:load_config)
@@ -55,9 +54,8 @@ module DatabaseCleaner
 
       describe "load_config" do
 
-        it { should respond_to(:load_config) }
-
         before do
+          subject.db = :my_db
           yaml = <<-Y
 my_db:
   database: <%= "ONE".downcase %>
@@ -81,7 +79,6 @@ my_db:
         end
 
         it "should store the relevant config in connection_hash" do
-          subject.should_receive(:db).and_return(:my_db)
           subject.load_config
           subject.connection_hash.should == {"database" => "one"}
         end
@@ -91,11 +88,17 @@ my_db:
           subject.load_config
           subject.connection_hash.should be_blank
         end
+
+        it "skips the file when the db is set to :default" do
+          # to avoid https://github.com/bmabey/database_cleaner/issues/72
+          subject.db = :default
+          YAML.should_not_receive(:load)
+          subject.load_config
+        end
+
       end
 
       describe "connection_hash" do
-        it { should respond_to(:connection_hash) }
-        it { should respond_to(:connection_hash=) }
         it "should store connection_hash" do
           subject.connection_hash = { :key => "value" }
           subject.connection_hash.should == { :key => "value" }

data/spec/database_cleaner/active_record/transaction_spec.rb

@@ -38,12 +38,17 @@ module DatabaseCleaner
 
       describe "#clean" do
         it "should start a transaction" do
+            connection.should_receive(:open_transactions).and_return(1)
+
             connection.stub!(:decrement_open_transactions)
 
             connection.should_receive(:rollback_db_transaction)
             Transaction.new.clean
         end
+
         it "should decrement open transactions if possible" do
+          connection.should_receive(:open_transactions).and_return(1)
+
           connection.stub!(:respond_to?).with(:decrement_open_transactions).and_return(true)
           connection.stub!(:rollback_db_transaction)
 
@@ -51,7 +56,14 @@ module DatabaseCleaner
           Transaction.new.clean
         end
 
+        it "should not try to decrement or rollback if open_transactions is 0 for whatever reason" do
+          connection.should_receive(:open_transactions).and_return(0)
+
+          Transaction.new.clean
+        end
+
         it "should decrement connection via ActiveRecord::Base if connection won't" do
+          connection.should_receive(:open_transactions).and_return(1)
           connection.stub!(:respond_to?).with(:decrement_open_transactions).and_return(false)
           connection.stub!(:rollback_db_transaction)
 

data/spec/database_cleaner/sequel/base_spec.rb

@@ -24,6 +24,7 @@ module DatabaseCleaner
       end
 
       it "should default to :default" do
+        pending "I figure out how to use Sequel and write some real tests for it..."
         subject.db.should == :default
       end
     end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: database_cleaner
 version: !ruby/object:Gem::Version 
-  hash: 3
+  hash: 1
   prerelease: 
   segments: 
   - 0
   - 7
-  - 0
-  version: 0.7.0
+  - 1
+  version: 0.7.1
 platform: ruby
 authors: 
 - Ben Mabey
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-11-12 00:00:00 Z
+date: 2012-01-15 00:00:00 Z
 dependencies: []
 
 description: Strategies for cleaning databases.  Can be used to ensure a clean state for testing.