database_cleaner 1.5.1 → 1.6.0

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    database_cleaner (1.5.1)
+    database_cleaner (1.6.0)
 
 GEM
   remote: https://rubygems.org/
@@ -69,7 +69,7 @@ GEM
       dm-transactions (~> 1.2.0)
       dm-types (~> 1.2.0)
       dm-validations (~> 1.2.0)
-    diff-lcs (1.1.3)
+    diff-lcs (1.2.5)
     dm-aggregates (1.2.0)
       dm-core (~> 1.2.0)
     dm-constraints (1.2.0)
@@ -210,7 +210,7 @@ GEM
       activesupport (= 3.0.0)
       rake (>= 0.8.4)
       thor (~> 0.14.0)
-    rake (10.3.2)
+    rake (11.1.2)
     rb-fsevent (0.9.4)
     rb-inotify (0.9.5)
       ffi (>= 0.5.0)
@@ -222,19 +222,22 @@ GEM
     rest-client (1.6.8)
       mime-types (~> 1.16)
       rdoc (>= 2.4.2)
-    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.3)
-      diff-lcs (~> 1.1.3)
-    rspec-mocks (2.11.3)
-    rspec-rails (2.11.4)
+    rspec (2.14.1)
+      rspec-core (~> 2.14.0)
+      rspec-expectations (~> 2.14.0)
+      rspec-mocks (~> 2.14.0)
+    rspec-core (2.14.8)
+    rspec-expectations (2.14.5)
+      diff-lcs (>= 1.1.3, < 2.0)
+    rspec-mocks (2.14.6)
+    rspec-rails (2.14.2)
       actionpack (>= 3.0)
+      activemodel (>= 3.0)
       activesupport (>= 3.0)
       railties (>= 3.0)
-      rspec (~> 2.11.0)
+      rspec-core (~> 2.14.0)
+      rspec-expectations (~> 2.14.0)
+      rspec-mocks (~> 2.14.0)
     sequel (3.21.0)
     slop (3.6.0)
     spoon (0.0.4)
@@ -242,7 +245,7 @@ GEM
     sqlite3 (1.3.10)
     stringex (1.5.1)
     thor (0.14.6)
-    tzinfo (0.3.41)
+    tzinfo (0.3.48)
     uuidtools (2.1.5)
     zip (2.0.2)
 
@@ -274,10 +277,10 @@ DEPENDENCIES
   ohm (~> 0.1.3)
   pg
   rake
-  rspec-rails (~> 2.11.0)
+  rspec-rails (~> 2.14.2)
   sequel (~> 3.21.0)
   sqlite3
   tzinfo
 
 BUNDLED WITH
-   1.10.5
+   1.14.6

data/History.rdoc

@@ -1,5 +1,47 @@
 == Development (master)
 
+== 1.5.3 2016-04-22
+
+=== Bug Fixes
+  * @P9GIT fixed issue #436
+
+== 1.5.2 2016-04-17
+
+=== New Features/Changes
+  * Use default_client with mongoid 5.0 (@stjhimy)
+  * Added comparable support for strategies (@st0012)
+  * Better README instructions that suggest `append_after` (@jrochkind)
+  * Removed deprecation warnings for Rails 5.0+ (@pschambacher)
+  * Upgrade to RSpec 2.14 (@skalee)
+
+=== Bug Fixes
+  * @dmitrypol fixed issue #409
+  * @schmierkov fixed the Travis builds with PR #416
+  * @shosti fixed issue #345
+  * @kylev fixed issue #379
+  * @skalee fixed the Travis builds for Neo4j with PR #433
+
+== 1.5.1 2015-09-05
+
+== Bug Fix
+  * Added mongo2 missing files to the gemspec. (@geerzo)
+
+== 1.5.0 2015-09-02
+
+=== New Features/Changes
+  * Use ensure within the cleaning method. (@cema-sp)
+  * Restored mysql2 + jruby support. (@ahorek)
+  * Added required ruby version to gemspec. (@garethrees)
+  * Added support for Mongoid 5.0 and Mongo Ruby Driver 2.0. (@jprincipe)
+  * Added support for additional Neo4j::Session.open options. (@brienw)
+  * And a bunch of code style and README improvements
+
+=== Bug Fixes
+  * Fixed truncation for MongoDB 3. (@andreale)
+  * Fixed YAML error when building gem. (@joshnesbitt)
+  * Fixed deletion strategy for JDBC MySQL. (@DanElbert)
+  * Fixed open transactions for multiple connections. (@claptimes5)
+
 == 1.4.1 2015-03-09
   * Support for deletion with Sequel. (@cyberdelia)
   * Use ActiveRecord::Base configuration when different from config file. (@wendy0402)

data/README.markdown

@@ -1,13 +1,25 @@
 # Database Cleaner
 
+[![Build Status](https://travis-ci.org/DatabaseCleaner/database_cleaner.svg?branch=master)](https://travis-ci.org/DatabaseCleaner/database_cleaner)
+[![Code Climate](https://codeclimate.com/github/DatabaseCleaner/database_cleaner/badges/gpa.svg)](https://codeclimate.com/github/DatabaseCleaner/database_cleaner)
+
 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, CouchPotato, Ohm and Redis are supported.
+## Gem Setup
+
+```ruby
+# Gemfile
+group :test do
+  gem 'database_cleaner'
+end
+```
 
-[![Build Status](https://travis-ci.org/DatabaseCleaner/database_cleaner.svg?branch=master)](https://travis-ci.org/DatabaseCleaner/database_cleaner) [![Code Climate](https://codeclimate.com/github/DatabaseCleaner/database_cleaner/badges/gpa.svg)](https://codeclimate.com/github/DatabaseCleaner/database_cleaner)
+## Supported Databases, Libraries and Strategies
+
+ActiveRecord, DataMapper, Sequel, MongoMapper, Mongoid, CouchPotato, Ohm and Redis are supported.
 
 Here is an overview of the strategies supported for each library:
 
@@ -76,7 +88,7 @@ Here is an overview of the strategies supported for each library:
   </tbody>
 </table>
 
-* Truncation and Deletion strategies for Neo4j will just delete all nodes and relationships from the database.
+\* Truncation and Deletion strategies for Neo4j will just delete all nodes and relationships from the database.
 
 <table>
   <tbody>
@@ -154,7 +166,7 @@ passed to [`keys`](http://redis.io/commands/keys)).
 
 (I should point out the truncation strategy will never truncate your schema_migrations table.)
 
-Some strategies need to be started before tests are run (for example the `:transaction` strategy needs to know to open up a transaction). This can be accomplished by calling `DatabaseCleaner.start` at the beginning of the run, or by running the tests inside a block to `Database.cleaning`. So you would have:
+Some strategies need to be started before tests are run (for example the `:transaction` strategy needs to know to open up a transaction). This can be accomplished by calling `DatabaseCleaner.start` at the beginning of the run, or by running the tests inside a block to `DatabaseCleaner.cleaning`. So you would have:
 
 ```ruby
 require 'database_cleaner'
@@ -221,23 +233,81 @@ end
 
 ### RSpec with Capybara Example
 
-If you're using Capybara with RSpec and using an external browser (not using RackTest) you'll almost certainly need to use truncation rather than transactions for tests tagged `:js`.
+You'll typically discover a feature spec is incorrectly using transaction
+instead of truncation strategy when the data created in the spec is not
+visible in the app-under-test.
+
+A frequently occurring example of this is when, after creating a user in a
+spec, the spec mysteriously fails to login with the user. This happens because
+the user is created inside of an uncommitted transaction on one database
+connection, while the login attempt is made using a separate database
+connection. This separate database connection cannot access the
+uncommitted user data created over the first database connection due to
+transaction isolation.
+
+For feature specs using a Capybara driver for an external
+JavaScript-capable browser (in practice this is all drivers except
+`:rack_test`), the Rack app under test and the specs do not share a
+database connection.
+
+When a spec and app-under-test do not share a database connection,
+you'll likely need to use the truncation strategy instead of the
+transaction strategy.
+
+See the suggested config below to temporarily enable truncation strategy
+for affected feature specs only. This config continues to use transaction
+strategy for all other specs.
+
+It's also recommended to use `append_after` to ensure `DatabaseCleaner.clean`
+runs *after* the after-test cleanup `capybara/rspec` installs.
 
 ```ruby
+require 'capybara/rspec'
+
+#...
+
 RSpec.configure do |config|
 
   config.use_transactional_fixtures = false
 
   config.before(:suite) do
+    if config.use_transactional_fixtures?
+      raise(<<-MSG)
+        Delete line `config.use_transactional_fixtures = true` from rails_helper.rb
+        (or set it to false) to prevent uncommitted transactions being used in
+        JavaScript-dependent specs.
+
+        During testing, the app-under-test that the browser driver connects to
+        uses a different database connection to the database connection used by
+        the spec. The app's database connection would not be able to access
+        uncommitted transaction data setup over the spec's database connection.
+      MSG
+    end
     DatabaseCleaner.clean_with(:truncation)
   end
 
-  config.before(:each) do |example|
-    DatabaseCleaner.strategy = example.metadata[:js] ? :truncation : :transaction
+  config.before(:each) do
+    DatabaseCleaner.strategy = :transaction
+  end
+
+  config.before(:each, type: :feature) do
+    # :rack_test driver's Rack app under test shares database connection
+    # with the specs, so continue to use transaction strategy for speed.
+    driver_shares_db_connection_with_specs = Capybara.current_driver == :rack_test
+
+    if !driver_shares_db_connection_with_specs
+      # Driver is probably for an external browser with an app
+      # under test that does *not* share a database connection with the
+      # specs, so use truncation strategy.
+      DatabaseCleaner.strategy = :truncation
+    end
+  end
+
+  config.before(:each) do
     DatabaseCleaner.start
   end
 
-  config.after(:each) do
+  config.append_after(:each) do
     DatabaseCleaner.clean
   end
 
@@ -412,7 +482,7 @@ For ActiveRecord, you add the following parameter in your database.yml file:
 test:
   adapter: postgresql
   # ...
-  min_messages: WARNING  
+  min_messages: WARNING
 </pre>
 
 ### Nothing happens in JRuby with Sequel using transactions

data/VERSION.yml

@@ -1,4 +1,4 @@
 ---
 :major: 1
-:minor: 5
-:patch: 1
+:minor: 6
+:patch: 0

data/examples/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    database_cleaner (1.5.1)
+    database_cleaner (1.6.0)
 
 GEM
   remote: https://rubygems.org/
@@ -69,7 +69,7 @@ GEM
       dm-transactions (~> 1.2.0)
       dm-types (~> 1.2.0)
       dm-validations (~> 1.2.0)
-    diff-lcs (1.1.3)
+    diff-lcs (1.2.5)
     dm-aggregates (1.2.0)
       dm-core (~> 1.2.0)
     dm-constraints (1.2.0)
@@ -210,7 +210,7 @@ GEM
       activesupport (= 3.0.0)
       rake (>= 0.8.4)
       thor (~> 0.14.0)
-    rake (10.3.2)
+    rake (11.1.2)
     rb-fsevent (0.9.4)
     rb-inotify (0.9.5)
       ffi (>= 0.5.0)
@@ -222,19 +222,22 @@ GEM
     rest-client (1.6.8)
       mime-types (~> 1.16)
       rdoc (>= 2.4.2)
-    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.3)
-      diff-lcs (~> 1.1.3)
-    rspec-mocks (2.11.3)
-    rspec-rails (2.11.4)
+    rspec (2.14.1)
+      rspec-core (~> 2.14.0)
+      rspec-expectations (~> 2.14.0)
+      rspec-mocks (~> 2.14.0)
+    rspec-core (2.14.8)
+    rspec-expectations (2.14.5)
+      diff-lcs (>= 1.1.3, < 2.0)
+    rspec-mocks (2.14.6)
+    rspec-rails (2.14.2)
       actionpack (>= 3.0)
+      activemodel (>= 3.0)
       activesupport (>= 3.0)
       railties (>= 3.0)
-      rspec (~> 2.11.0)
+      rspec-core (~> 2.14.0)
+      rspec-expectations (~> 2.14.0)
+      rspec-mocks (~> 2.14.0)
     sequel (3.21.0)
     slop (3.6.0)
     spoon (0.0.4)
@@ -242,7 +245,7 @@ GEM
     sqlite3 (1.3.10)
     stringex (1.5.1)
     thor (0.14.6)
-    tzinfo (0.3.41)
+    tzinfo (0.3.48)
     uuidtools (2.1.5)
     zip (2.0.2)
 
@@ -274,10 +277,10 @@ DEPENDENCIES
   ohm (~> 0.1.3)
   pg
   rake
-  rspec-rails (~> 2.11.0)
+  rspec-rails (~> 2.14.2)
   sequel (~> 3.21.0)
   sqlite3
   tzinfo
 
 BUNDLED WITH
-   1.10.5
+   1.14.6

data/examples/lib/redis_models.rb

@@ -3,7 +3,7 @@ require 'redis'
 class RedisWidget
 
   def self.redis
-    threaded ||= Redis.connect
+    threaded ||= Redis.new
   end
 
   def self.redis=(connection)
@@ -45,7 +45,7 @@ end
 class RedisWidgetUsingDatabaseOne < RedisWidget
 
   def self.redis
-    threaded[self.class.to_s] ||= Redis.connect :url => ENV['REDIS_URL_ONE']
+    threaded[self.class.to_s] ||= Redis.new :url => ENV['REDIS_URL_ONE']
   end
 
   def self.create!
@@ -56,7 +56,7 @@ end
 class RedisWidgetUsingDatabaseTwo < RedisWidget
 
   def self.redis
-    threaded[self.class.to_s] ||= Redis.connect :url => ENV['REDIS_URL_TWO']
+    threaded[self.class.to_s] ||= Redis.new :url => ENV['REDIS_URL_TWO']
   end
 
   def self.create!

data/lib/database_cleaner/active_record/base.rb

@@ -57,6 +57,14 @@ module DatabaseCleaner
                               end
       end
 
+      def self.migration_table_name
+        if ::ActiveRecord::VERSION::MAJOR < 5
+          ::ActiveRecord::Migrator.schema_migrations_table_name
+        else
+          ::ActiveRecord::SchemaMigration.table_name
+        end
+      end
+
       private
 
       def lookup_from_connection_pool

data/lib/database_cleaner/active_record/deletion.rb

@@ -54,11 +54,31 @@ module DatabaseCleaner::ActiveRecord
 
     def tables_with_new_rows(connection)
       @db_name ||= connection.instance_variable_get('@config')[:database]
-      result = connection.exec_query("SELECT table_name FROM information_schema.tables WHERE table_schema = '#{@db_name}' AND table_rows > 0")
-      result.map{ |row| row['table_name'] } - ['schema_migrations']
+      stats = table_stats_query(connection, @db_name)
+      if stats != ''
+        connection.exec_query(stats).inject([]) {|all, stat| all << stat['table_name'] if stat['exact_row_count'] > 0; all }
+      else
+        []
+      end
+    end
+
+    def table_stats_query(connection, db_name)
+      if @cache_tables && !@table_stats_query.nil?
+        return @table_stats_query
+      else
+        @table_stats_query = connection.select_values(<<-SQL).join(' UNION ')
+               SELECT CONCAT('SELECT \"', table_name, '\" AS table_name, COUNT(*) AS exact_row_count FROM ', table_name)
+               FROM
+               INFORMATION_SCHEMA.TABLES
+               WHERE
+               table_schema = '#{db_name}'
+               AND table_name <> '#{migration_table_name}';
+        SQL
+      end
     end
 
     def information_schema_exists? connection
+      return false unless connection.is_a? ActiveRecord::ConnectionAdapters::Mysql2Adapter
       @information_schema_exists ||=
         begin
           connection.execute("SELECT 1 FROM information_schema.tables")

data/lib/database_cleaner/active_record/truncation.rb

@@ -27,7 +27,7 @@ module DatabaseCleaner
 
       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
+        @database_cleaner_tables ||= ::ActiveRecord::VERSION::MAJOR >= 5 ? data_sources : tables
       end
 
       def truncate_table(table_name)
@@ -192,7 +192,7 @@ module DatabaseCleaner
           FROM pg_tables
           WHERE
             tablename !~ '_prt_' AND
-            tablename <> '#{::ActiveRecord::Migrator.schema_migrations_table_name}' AND
+            tablename <> '#{::DatabaseCleaner::ActiveRecord::Base.migration_table_name}' AND
             schemaname = ANY (current_schemas(false))
         _SQL
         rows.collect { |result| result.first }
@@ -257,7 +257,7 @@ module DatabaseCleaner::ActiveRecord
 
     # overwritten
     def migration_storage_names
-      [::ActiveRecord::Migrator.schema_migrations_table_name]
+      [::DatabaseCleaner::ActiveRecord::Base.migration_table_name]
     end
 
     def cache_tables?

data/lib/database_cleaner/base.rb

@@ -1,6 +1,12 @@
 require 'database_cleaner/null_strategy'
 module DatabaseCleaner
   class Base
+    include Comparable
+
+    def <=>(other)
+      (self.orm <=> other.orm) == 0 ? self.db <=> other.db : self.orm <=> other.orm
+    end
+
     def initialize(desired_orm = nil,opts = {})
       if [:autodetect, nil, "autodetect"].include?(desired_orm)
         autodetect
@@ -96,11 +102,6 @@ module DatabaseCleaner
       !!@autodetected
     end
 
-    #TODO make strategies directly comparable
-    def ==(other)
-      self.orm == other.orm && self.db == other.db
-    end
-
     def autodetect_orm
       if defined? ::ActiveRecord
         :active_record

data/lib/database_cleaner/mongo/truncation_mixin.rb

@@ -4,9 +4,9 @@ module DatabaseCleaner
 
       def clean
         if @only
-          collections.each { |c| c.remove if @only.include?(c.name) }
+          collections.each { |c| c.send(truncate_method_name) if @only.include?(c.name) }
         else
-          collections.each { |c| c.remove unless @tables_to_exclude.include?(c.name) }
+          collections.each { |c| c.send(truncate_method_name) unless @tables_to_exclude.include?(c.name) }
         end
         true
       end
@@ -17,6 +17,10 @@ module DatabaseCleaner
         database.collections.select { |c| c.name !~ /^system\./ }
       end
 
+      def truncate_method_name
+        # This constant only exists in the 2.x series.
+        defined?(::Mongo::VERSION) ? :delete_many : :remove
+      end
     end
   end
 end

data/lib/database_cleaner/mongo2/truncation_mixin.rb

@@ -26,10 +26,12 @@ module DatabaseCleaner
           database.use(db)
         end
 
-        database['system.namespaces'].find(:name => { '$not' => /\.system\.|\$/ }).to_a.map do |collection|
-          _, name = collection['name'].split('.', 2)
-          name
-        end
+        database.collections.collect { |c| c.namespace.split('.',2)[1] }
+
+        # database['system.namespaces'].find(:name => { '$not' => /\.system\.|\$/ }).to_a.map do |collection|
+        #   _, name = collection['name'].split('.', 2)
+        #   name
+        # end
       end
 
     end

data/lib/database_cleaner/mongoid/truncation.rb

@@ -28,7 +28,7 @@ module DatabaseCleaner
         private
 
         def session
-          ::Mongoid.default_session
+          ::Mongoid::VERSION > "5.0.0" ? ::Mongoid.default_client : ::Mongoid.default_session
         end
 
         def database

data/lib/database_cleaner/null_strategy.rb

@@ -11,5 +11,10 @@ module DatabaseCleaner
     def self.clean
       # no-op
     end
+
+    def self.cleaning(&block)
+      # no-op
+      yield
+    end
   end
 end

data/lib/database_cleaner/redis/base.rb

@@ -22,10 +22,16 @@ module DatabaseCleaner
       private
 
       def connection
-        @connection ||= url == :default ? ::Redis.connect : ::Redis.connect(:url => url)
+        @connection ||= begin
+          if url == :default
+            ::Redis.new
+          elsif db.is_a?(::Redis) # pass directly the connection
+            db
+          else
+            ::Redis.new(:url => url)
+          end
+        end
       end
-
     end
   end
 end
-

data/spec/database_cleaner/active_record/truncation_spec.rb

@@ -40,7 +40,7 @@ module DatabaseCleaner
           Truncation.new.clean
         end
 
-        it "should use ActiveRecord's schema_migrations_table_name" do
+        it "should use ActiveRecord's SchemaMigration.table_name" do
           connection.stub(:database_cleaner_table_cache).and_return(%w[pre_schema_migrations_suf widgets dogs])
           ::ActiveRecord::Base.stub(:table_name_prefix).and_return('pre_')
           ::ActiveRecord::Base.stub(:table_name_suffix).and_return('_suf')
@@ -118,7 +118,7 @@ module DatabaseCleaner
             connection.should_receive(:database_cleaner_table_cache).and_return([])
             connection.should_not_receive(:tables)
 
-            connection.stub!(:truncate_tables)
+            connection.stub(:truncate_tables)
             Truncation.new({ :cache_tables => true }).clean
           end
         end
@@ -128,7 +128,7 @@ module DatabaseCleaner
             connection.should_not_receive(:database_cleaner_table_cache)
             connection.should_receive(:tables).and_return([])
 
-            connection.stub!(:truncate_tables)
+            connection.stub(:truncate_tables)
             Truncation.new({ :cache_tables => false }).clean
           end
         end