database_cleaner 1.1.1 → 1.2.0

data/Gemfile.lock

@@ -167,21 +167,21 @@ GEM
     redis (3.0.4)
     rest-client (1.6.7)
       mime-types (>= 1.16)
-    rspec (2.12.0)
-      rspec-core (~> 2.12.0)
-      rspec-expectations (~> 2.12.0)
-      rspec-mocks (~> 2.12.0)
-    rspec-core (2.12.2)
-    rspec-expectations (2.12.1)
-      diff-lcs (~> 1.1.3)
-    rspec-mocks (2.12.1)
-    rspec-rails (2.12.1)
+    rspec (2.14.1)
+      rspec-core (~> 2.14.0)
+      rspec-expectations (~> 2.14.0)
+      rspec-mocks (~> 2.14.0)
+    rspec-core (2.14.5)
+    rspec-expectations (2.14.2)
+      diff-lcs (>= 1.1.3, < 2.0)
+    rspec-mocks (2.14.3)
+    rspec-rails (2.14.0)
       actionpack (>= 3.0)
       activesupport (>= 3.0)
       railties (>= 3.0)
-      rspec-core (~> 2.12.0)
-      rspec-expectations (~> 2.12.0)
-      rspec-mocks (~> 2.12.0)
+      rspec-core (~> 2.14.0)
+      rspec-expectations (~> 2.14.0)
+      rspec-mocks (~> 2.14.0)
     sequel (3.21.0)
     slop (3.3.3)
     sprockets (2.2.2)

data/History.rdoc

@@ -1,3 +1,20 @@
+== 1.2.0 2013-10-09
+
+A huge thanks goes to @tommeier for fixing the bug with class loading that was cuasing the wrong adapters
+to be used in certain cases.
+
+=== New Features/Changes
+
+  * Upgraded RSpec to remove deprecation warnings (John Rowe)
+  * Caching of tables to truncate is now optional (@marcoow)
+
+=== Bug Fixes
+
+  * Use class_eval loading of superclasses to ensure right version of class is patched. (Tom Meier, Joel Nimety, Ernesto Tagwerker)
+  * Add truncate_tables method to SQLiteAdapter. (Chris Mo)
+  * Fixes missing #uses_sequence invokation in adapter classes for sqlite and sqlite3 (Lefteris Laskaridis)
+
+
 == 1.1.1 2013-08-01
 
 === Bug Fixes

data/README.markdown

@@ -181,6 +181,10 @@ The following options are available for ActiveRecord's `:truncation` strategy _o
 * `: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?](#what-strategy-is-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`.
 
+The following option is available for ActiveRecord's `:truncation` and `:deletion` strategy for any DB.
+
+* `:cache_tables` - When set to `true` the list of tables to truncate or delete from will only be read from the DB once, otherwise it will be read before each cleanup run. Set this to `false` if you create and drop tables in your tests. Defaults to `true`.
+
 
 ### RSpec Example
 

data/Rakefile

@@ -14,6 +14,7 @@ begin
     s.description = "Strategies for cleaning databases.  Can be used to ensure a clean state for testing."
     s.files = FileList["[A-Z]*.*", "{examples,lib,features,spec}/**/*", "Rakefile", "cucumber.yml"]
     s.authors = ["Ben Mabey"]
+    s.licence  = 'MIT'
   end
 rescue LoadError
   puts "Jeweler not available. Install it with: sudo gem install technicalpickles-jeweler -s http://gems.github.com"

data/VERSION.yml

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

data/examples/Gemfile.lock

@@ -167,21 +167,21 @@ GEM
     redis (3.0.4)
     rest-client (1.6.7)
       mime-types (>= 1.16)
-    rspec (2.12.0)
-      rspec-core (~> 2.12.0)
-      rspec-expectations (~> 2.12.0)
-      rspec-mocks (~> 2.12.0)
-    rspec-core (2.12.2)
-    rspec-expectations (2.12.1)
-      diff-lcs (~> 1.1.3)
-    rspec-mocks (2.12.1)
-    rspec-rails (2.12.1)
+    rspec (2.14.1)
+      rspec-core (~> 2.14.0)
+      rspec-expectations (~> 2.14.0)
+      rspec-mocks (~> 2.14.0)
+    rspec-core (2.14.5)
+    rspec-expectations (2.14.2)
+      diff-lcs (>= 1.1.3, < 2.0)
+    rspec-mocks (2.14.3)
+    rspec-rails (2.14.0)
       actionpack (>= 3.0)
       activesupport (>= 3.0)
       railties (>= 3.0)
-      rspec-core (~> 2.12.0)
-      rspec-expectations (~> 2.12.0)
-      rspec-mocks (~> 2.12.0)
+      rspec-core (~> 2.14.0)
+      rspec-expectations (~> 2.14.0)
+      rspec-mocks (~> 2.14.0)
     sequel (3.21.0)
     slop (3.3.3)
     sprockets (2.2.2)

data/lib/database_cleaner/active_record/base.rb

@@ -28,7 +28,7 @@ module DatabaseCleaner
       end
 
       def db
-        @db || super
+        @db ||= super
       end
 
       def load_config
@@ -39,8 +39,8 @@ module DatabaseCleaner
       end
 
       def connection_class
-        @connection_class ||= if @db && !@db.is_a?(Symbol)
-                                @db
+        @connection_class ||= if db && !db.is_a?(Symbol)
+                                db
                               elsif connection_hash
                                 lookup_from_connection_pool || establish_connection
                               else

data/lib/database_cleaner/active_record/deletion.rb

@@ -3,55 +3,41 @@ require 'active_record/connection_adapters/abstract_adapter'
 require "database_cleaner/generic/truncation"
 require 'database_cleaner/active_record/base'
 require 'database_cleaner/active_record/truncation'
-# This file may seem to have duplication with that of truncation, but by keeping them separate
-# we avoiding loading this code when it is not being used (which is the common case).
 
-module ActiveRecord
+module DatabaseCleaner
   module ConnectionAdapters
-
-    class MysqlAdapter < MYSQL_ADAPTER_PARENT
-      def delete_table(table_name)
-        execute("DELETE FROM #{quote_table_name(table_name)};")
-      end
-    end
-
-    class Mysql2Adapter < MYSQL2_ADAPTER_PARENT
-      def delete_table(table_name)
-        execute("DELETE FROM #{quote_table_name(table_name)};")
-      end
-    end
-
-    class JdbcAdapter < AbstractAdapter
-      def delete_table(table_name)
-          execute("DELETE FROM #{quote_table_name(table_name)};")
-      end
-    end
-
-    class PostgreSQLAdapter < POSTGRES_ADAPTER_PARENT
+    module AbstractDeleteAdapter
       def delete_table(table_name)
-        execute("DELETE FROM #{quote_table_name(table_name)};")
+        raise NotImplementedError
       end
     end
 
-    class SQLServerAdapter < AbstractAdapter
+    module GenericDeleteAdapter
       def delete_table(table_name)
         execute("DELETE FROM #{quote_table_name(table_name)};")
       end
     end
-
-    class OracleEnhancedAdapter < AbstractAdapter
-      def delete_table(table_name)
-        execute("DELETE FROM #{quote_table_name(table_name)}")
-      end
-    end
-
   end
 end
 
+module ActiveRecord
+  module ConnectionAdapters
+    AbstractAdapter.class_eval { include DatabaseCleaner::ConnectionAdapters::AbstractDeleteAdapter }
+
+    JdbcAdapter.class_eval { include ::DatabaseCleaner::ConnectionAdapters::GenericDeleteAdapter } if defined?(JdbcAdapter)
+    AbstractMysqlAdapter.class_eval { include ::DatabaseCleaner::ConnectionAdapters::GenericDeleteAdapter } if defined?(AbstractMysqlAdapter)
+    Mysql2Adapter.class_eval { include ::DatabaseCleaner::ConnectionAdapters::GenericDeleteAdapter } if defined?(Mysql2Adapter)
+    SQLiteAdapter.class_eval { include ::DatabaseCleaner::ConnectionAdapters::GenericDeleteAdapter } if defined?(SQLiteAdapter)
+    SQLite3Adapter.class_eval { include ::DatabaseCleaner::ConnectionAdapters::GenericDeleteAdapter } if defined?(SQLite3Adapter)
+    PostgreSQLAdapter.class_eval { include ::DatabaseCleaner::ConnectionAdapters::GenericDeleteAdapter } if defined?(PostgreSQLAdapter)
+    IBM_DBAdapter.class_eval { include ::DatabaseCleaner::ConnectionAdapters::GenericDeleteAdapter } if defined?(IBM_DBAdapter)
+    SQLServerAdapter.class_eval { include ::DatabaseCleaner::ConnectionAdapters::GenericDeleteAdapter } if defined?(SQLServerAdapter)
+    OracleEnhancedAdapter.class_eval { include ::DatabaseCleaner::ConnectionAdapters::GenericDeleteAdapter } if defined?(OracleEnhancedAdapter)
+  end
+end
 
 module DatabaseCleaner::ActiveRecord
   class Deletion < Truncation
-
     def clean
       connection = connection_class.connection
       connection.disable_referential_integrity do
@@ -60,8 +46,5 @@ module DatabaseCleaner::ActiveRecord
         end
       end
     end
-
   end
 end
-
-

data/lib/database_cleaner/active_record/truncation.rb

@@ -2,16 +2,19 @@ require 'active_record/base'
 
 require 'active_record/connection_adapters/abstract_adapter'
 
-begin
-  require 'active_record/connection_adapters/abstract_mysql_adapter'
-rescue LoadError
+#Load available connection adapters
+%w( abstract_mysql_adapter postgresql_adapter sqlite3_adapter ).each do |known_adapter|
+  begin
+    require "active_record/connection_adapters/#{known_adapter}"
+  rescue LoadError
+  end
 end
 
 require "database_cleaner/generic/truncation"
 require 'database_cleaner/active_record/base'
 
 module DatabaseCleaner
-  module ActiveRecord
+  module ConnectionAdapters
 
     module AbstractAdapter
       # used to be called views but that can clash with gems like schema_plus
@@ -19,7 +22,6 @@ module DatabaseCleaner
       def database_cleaner_view_cache
         @views ||= select_values("select table_name from information_schema.views where table_schema = '#{current_database}'") rescue []
       end
-
       def database_cleaner_table_cache
         # the adapters don't do caching (#130) but we make the assumption that the list stays the same in tests
         @database_cleaner_tables ||= tables
@@ -36,8 +38,7 @@ module DatabaseCleaner
       end
     end
 
-    module MysqlAdapter
-
+    module AbstractMysqlAdapter
       def truncate_table(table_name)
         execute("TRUNCATE TABLE #{quote_table_name(table_name)};")
       end
@@ -53,7 +54,6 @@ module DatabaseCleaner
 
       private
 
-
       def row_count(table)
         # Patch for MysqlAdapter with ActiveRecord 3.2.7 later
         # select_value("SELECT 1") #=> "1"
@@ -65,15 +65,15 @@ module DatabaseCleaner
       # but then the table is cleaned.  In other words, this function tells us if the given table
       # was ever inserted into.
       def has_been_used?(table)
-        if row_count(table) > 0
+        if has_rows?(table)
           true
         else
           # Patch for MysqlAdapter with ActiveRecord 3.2.7 later
           # select_value("SELECT 1") #=> "1"
           select_value(<<-SQL).to_i > 1 # returns nil if not present
-              SELECT Auto_increment
-              FROM information_schema.tables
-              WHERE table_name='#{table}';
+          SELECT Auto_increment
+          FROM information_schema.tables
+          WHERE table_name='#{table}';
           SQL
         end
       end
@@ -83,14 +83,12 @@ module DatabaseCleaner
       end
     end
 
-
     module IBM_DBAdapter
       def truncate_table(table_name)
         execute("TRUNCATE #{quote_table_name(table_name)} IMMEDIATE")
       end
     end
 
-
     module SQLiteAdapter
       def delete_table(table_name)
         execute("DELETE FROM #{quote_table_name(table_name)};")
@@ -100,6 +98,10 @@ module DatabaseCleaner
       end
       alias truncate_table delete_table
 
+      def truncate_tables(tables)
+        tables.each { |t| truncate_table(t) }
+      end
+
       private
 
       # Returns a boolean indicating if the SQLite database is using the sqlite_sequence table.
@@ -118,6 +120,12 @@ module DatabaseCleaner
       end
     end
 
+    module OracleEnhancedAdapter
+      def truncate_table(table_name)
+        execute("TRUNCATE TABLE #{quote_table_name(table_name)}")
+      end
+    end
+
     module PostgreSQLAdapter
       def db_version
         @db_version ||= postgresql_version
@@ -160,66 +168,26 @@ module DatabaseCleaner
         select_value("SELECT true FROM #{table} LIMIT 1;")
       end
     end
-
-    module OracleEnhancedAdapter
-      def truncate_table(table_name)
-        execute("TRUNCATE TABLE #{quote_table_name(table_name)}")
-      end
-    end
-
   end
 end
 
-#TODO: Remove monkeypatching and decorate the connection instead!
-
 module ActiveRecord
   module ConnectionAdapters
-    # Activerecord-jdbc-adapter defines class dependencies a bit differently - if it is present, confirm to ArJdbc hierarchy to avoid 'superclass mismatch' errors.
-    USE_ARJDBC_WORKAROUND = defined?(ArJdbc)
-    # ActiveRecord 3.1+ support
-    MYSQL_ABSTRACT_ADAPTER = defined?(AbstractMysqlAdapter) ? AbstractMysqlAdapter : AbstractAdapter
-
-    AbstractAdapter.send(:include, ::DatabaseCleaner::ActiveRecord::AbstractAdapter)
-
-    if USE_ARJDBC_WORKAROUND
-      MYSQL_ADAPTER_PARENT  = JdbcAdapter
-    else
-      MYSQL_ADAPTER_PARENT  = MYSQL_ABSTRACT_ADAPTER
-      class SQLiteAdapter < AbstractAdapter; end
-    end
-    MYSQL2_ADAPTER_PARENT = MYSQL_ABSTRACT_ADAPTER
-
-    if defined?(SQLite3Adapter) && SQLite3Adapter.superclass == ActiveRecord::ConnectionAdapters::AbstractAdapter
-      SQLITE_ADAPTER_PARENT = USE_ARJDBC_WORKAROUND ? JdbcAdapter : AbstractAdapter
-    else
-      SQLITE_ADAPTER_PARENT = USE_ARJDBC_WORKAROUND ? JdbcAdapter : SQLiteAdapter
-    end
-    POSTGRES_ADAPTER_PARENT = USE_ARJDBC_WORKAROUND ? JdbcAdapter : AbstractAdapter
-
-    MYSQL_ADAPTER_PARENT.class_eval     { include ::DatabaseCleaner::ActiveRecord::MysqlAdapter }
-    MYSQL2_ADAPTER_PARENT.class_eval    { include ::DatabaseCleaner::ActiveRecord::MysqlAdapter }
-    SQLITE_ADAPTER_PARENT.class_eval    { include ::DatabaseCleaner::ActiveRecord::SQLiteAdapter }
-    POSTGRES_ADAPTER_PARENT.class_eval  { include ::DatabaseCleaner::ActiveRecord::PostgreSQLAdapter }
-
-    class IBM_DBAdapter < AbstractAdapter
-      include ::DatabaseCleaner::ActiveRecord::IBM_DBAdapter
-    end
-
-    class JdbcAdapter < AbstractAdapter
-      include ::DatabaseCleaner::ActiveRecord::TruncateOrDelete
-    end
-
-    class SQLServerAdapter < AbstractAdapter
-      include ::DatabaseCleaner::ActiveRecord::TruncateOrDelete
-    end
-
-    class OracleEnhancedAdapter < AbstractAdapter
-      include ::DatabaseCleaner::ActiveRecord::OracleEnhancedAdapter
-    end
+    #Apply adapter decoraters where applicable (adapter should be loaded)
+    AbstractAdapter.class_eval { include DatabaseCleaner::ConnectionAdapters::AbstractAdapter }
+
+    JdbcAdapter.class_eval { include ::DatabaseCleaner::ConnectionAdapters::TruncateOrDelete } if defined?(JdbcAdapter)
+    AbstractMysqlAdapter.class_eval { include ::DatabaseCleaner::ConnectionAdapters::AbstractMysqlAdapter } if defined?(AbstractMysqlAdapter)
+    Mysql2Adapter.class_eval { include ::DatabaseCleaner::ConnectionAdapters::AbstractMysqlAdapter } if defined?(Mysql2Adapter)
+    SQLiteAdapter.class_eval { include ::DatabaseCleaner::ConnectionAdapters::SQLiteAdapter } if defined?(SQLiteAdapter)
+    SQLite3Adapter.class_eval { include ::DatabaseCleaner::ConnectionAdapters::SQLiteAdapter } if defined?(SQLite3Adapter)
+    PostgreSQLAdapter.class_eval { include ::DatabaseCleaner::ConnectionAdapters::PostgreSQLAdapter } if defined?(PostgreSQLAdapter)
+    IBM_DBAdapter.class_eval { include ::DatabaseCleaner::ConnectionAdapters::IBM_DBAdapter } if defined?(IBM_DBAdapter)
+    SQLServerAdapter.class_eval { include ::DatabaseCleaner::ConnectionAdapters::TruncateOrDelete } if defined?(SQLServerAdapter)
+    OracleEnhancedAdapter.class_eval { include ::DatabaseCleaner::ConnectionAdapters::OracleEnhancedAdapter } if defined?(OracleEnhancedAdapter)
   end
 end
 
-
 module DatabaseCleaner::ActiveRecord
   class Truncation
     include ::DatabaseCleaner::ActiveRecord::Base
@@ -239,7 +207,8 @@ module DatabaseCleaner::ActiveRecord
     private
 
     def tables_to_truncate(connection)
-      (@only || connection.database_cleaner_table_cache) - @tables_to_exclude - connection.database_cleaner_view_cache
+      tables_in_db = cache_tables? ? connection.database_cleaner_table_cache : connection.tables
+      (@only || tables_in_db) - @tables_to_exclude - connection.database_cleaner_view_cache
     end
 
     # overwritten
@@ -247,6 +216,10 @@ module DatabaseCleaner::ActiveRecord
       [::ActiveRecord::Migrator.schema_migrations_table_name]
     end
 
+    def cache_tables?
+      !!@cache_tables
+    end
+
     def pre_count?
       @pre_count == true
     end

data/lib/database_cleaner/base.rb

@@ -25,7 +25,7 @@ module DatabaseCleaner
     end
 
     def db
-      @db || :default
+      @db ||= :default
     end
 
     def create_strategy(*args)
@@ -67,7 +67,7 @@ module DatabaseCleaner
     end
 
     def strategy
-      @strategy || NullStrategy
+      @strategy ||= NullStrategy
     end
 
     def orm=(desired_orm)
@@ -128,7 +128,7 @@ module DatabaseCleaner
     def orm_strategy(strategy)
       require "database_cleaner/#{orm.to_s}/#{strategy.to_s}"
       orm_module.const_get(strategy.to_s.capitalize)
-    rescue LoadError => e
+    rescue LoadError
       if orm_module.respond_to? :available_strategies
         raise UnknownStrategySpecified, "The '#{strategy}' strategy does not exist for the #{orm} ORM!  Available strategies: #{orm_module.available_strategies.join(', ')}"
       else