database_rewinder 0.7.1 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1db1d33a8c34c0c729cda2c399f9572fa9517154
-  data.tar.gz: 95bc85096e0150ef5260931297b9461b0a9e65f2
+  metadata.gz: 5f5c97bcefcc1123d7adf1d809c1ef4107ce0ef8
+  data.tar.gz: 889bc139276c81073d6d89870eedecfb4bafa664
 SHA512:
-  metadata.gz: db16fa1ceed189ce34db7f1c54a335014635614069d04d66e44836a18275e68d325de537d4205c86bf24dc1620b3764f5b21b14f49f9f614894781d83ba8d9b5
-  data.tar.gz: ba26cdae5c9433f37726c95e4d103e534f767ad3ce257f4752094716adb843171c7a803ae8f922ed1ddd2c0a0387a1de0ecb30699d68823b42f6473874fb6d5f
+  metadata.gz: 8b9b9cfa9c8bce163ef37ac406aaa3b90c5c5046cb5852eb697d1ae3e48316035ab26378a3294a12d948a189654e17978d932c86f585952f865d09ca296293d2
+  data.tar.gz: 38cf26cf1d6d947c3eb726bdf28b58175e599decb8757c8185ebfcab2e8d21bb90aadb23b727ab669ae53bf495c01d029e3a076624e67e1a7a14fc91fb3f2cb3

data/.travis.yml

@@ -1,5 +1,7 @@
 language: ruby
 
+cache: bundler
+
 env:
   - DB=sqlite3
   - DB=mysql
@@ -8,8 +10,8 @@ env:
 rvm:
   - 2.0.0
   - 2.1.10
-  - 2.2.5
-  - 2.3.1
+  - 2.2.6
+  - 2.3.3
 
 gemfile:
   - gemfiles/rails_40.gemfile

data/README.md

@@ -15,6 +15,7 @@ database\_rewinder is a minimalist's tiny and ultra-fast database cleaner.
 database\_rewinder memorizes every table name into which `INSERT` SQL was performed during each test case.
 Then it executes `DELETE` SQL only against these tables when cleaning.
 So, the more number of tables you have in your database, the more benefit you will get.
+Also, database\_rewinder joins all `DELETE` SQL statements and casts it in one DB server call.
 
 ### Credit
 
@@ -83,6 +84,41 @@ RSpec.configure do |config|
 end
 ```
 
+### MySQL + use\_transactional\_tests Specific Problems
+
+database\_rewinder tries to create a new DB connection for deletion when you're running tests on MySQL.
+You would occasionally hit some weird errors (e.g. query execution timeout) because of this, especially when your tests are run with the `use_transactional_tests` option enabled (which is Rails' default).
+
+#### 1. Properly understand what `use_transactional_tests` means, and consider turning it off
+
+`use_transactional_tests` is the option that surrounds each of your test case with a DB transaction to roll back all your test data after each test run.
+So far as this works properly, you won't really need to use database\_rewinder.
+However, this simple mechanism doesn't work well when you're running integration tests with capybara + js mode.
+In cases of this situation, bundle database\_rewinder and add the following configuration.
+
+```ruby
+RSpec.configure do |config|
+  config.use_transactional_examples = false
+
+  ...
+end
+```
+
+#### 2. Cleaning with `multiple: false` option
+If you're really sure you need to keep using transational tests + database\_rewinder for some reason, then explicitly pass in `multiple: false` option to `DatabaseRewinder.clean_all` and `DatabaseRewinder.clean` invocations as follows. Note that you won't be able to get full performance merit that database\_rewinder provides though.
+
+```ruby
+RSpec.configure do |config|
+  config.before :suite do
+    DatabaseRewinder.clean_all multiple: false
+  end
+
+  config.after :each do
+    DatabaseRewinder.clean multiple: false
+  end
+end
+```
+
 ### Pro Tip
 
 database\_rewinder is designed to be almost compatible with database\_cleaner.

data/database_rewinder.gemspec

@@ -5,7 +5,7 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 Gem::Specification.new do |spec|
   spec.name          = "database_rewinder"
-  spec.version       = '0.7.1'
+  spec.version       = '0.8.0'
   spec.authors       = ["Akira Matsuda"]
   spec.email         = ["ronnie@dio.jp"]
   spec.description   = "A minimalist's tiny and ultra-fast database cleaner"
@@ -25,4 +25,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'sqlite3'
   spec.add_development_dependency 'mysql2'
   spec.add_development_dependency 'pg'
+  spec.required_ruby_version = '>= 2.0.0'
 end

data/lib/database_rewinder.rb

@@ -58,16 +58,16 @@ module DatabaseRewinder
       end
     end
 
-    def clean
+    def clean(multiple: true)
       if @clean_all
-        clean_all
+        clean_all multiple: multiple
       else
-        cleaners.each(&:clean)
+        cleaners.each {|c| c.clean multiple: multiple}
       end
     end
 
-    def clean_all
-      cleaners.each(&:clean_all)
+    def clean_all(multiple: true)
+      cleaners.each {|c| c.clean_all multiple: multiple}
     end
 
     # cache AR connection.tables

data/lib/database_rewinder/active_record_monkey.rb

@@ -13,6 +13,7 @@ module DatabaseRewinder
   end
 end
 
+#FIXME can we not load 'em?
 begin
   require 'active_record/connection_adapters/sqlite3_adapter'
   ::ActiveRecord::ConnectionAdapters::SQLite3Adapter.send :prepend, DatabaseRewinder::InsertRecorder

data/lib/database_rewinder/cleaner.rb

@@ -16,7 +16,7 @@ module DatabaseRewinder
       config['database']
     end
 
-    def clean
+    def clean(multiple: true)
       return if !pool || inserted_tables.empty?
 
       # When the application uses multiple database connections, a connection
@@ -24,19 +24,19 @@ module DatabaseRewinder
       # In this case, we have to reconnect to the database to clean inserted
       # tables.
       with_automatic_reconnect(pool) do
-        delete_all (ar_conn = pool.connection), DatabaseRewinder.all_table_names(ar_conn) & inserted_tables
+        delete_all (ar_conn = pool.connection), DatabaseRewinder.all_table_names(ar_conn) & inserted_tables, multiple: multiple
       end
       reset
     end
 
-    def clean_all
+    def clean_all(multiple: true)
       if pool
         ar_conn = pool.connection
-        delete_all ar_conn, DatabaseRewinder.all_table_names(ar_conn)
+        delete_all ar_conn, DatabaseRewinder.all_table_names(ar_conn), multiple: multiple
       else
         require 'database_rewinder/dummy_model'
         DummyModel.with_temporary_connection(config) do |temporary_connection|
-          delete_all temporary_connection, DatabaseRewinder.all_table_names(temporary_connection)
+          delete_all temporary_connection, DatabaseRewinder.all_table_names(temporary_connection), multiple: multiple
         end
       end
 
@@ -44,18 +44,25 @@ module DatabaseRewinder
     end
 
     private
-    def delete_all(ar_conn, tables)
+    def delete_all(ar_conn, tables, multiple: true)
       tables = tables & @only if @only.any?
       tables -= @except if @except.any?
       return if tables.empty?
 
-      if tables.many? && ar_conn.supports_multiple_statements?
-        ar_conn.execute_multiple tables.map {|t| "DELETE FROM #{ar_conn.quote_table_name(t)}"}.join(';')
-      else
-        ar_conn.disable_referential_integrity do
-          tables.each do |table_name|
-            ar_conn.execute "DELETE FROM #{ar_conn.quote_table_name(table_name)};"
-          end
+      if multiple && tables.many? && ar_conn.supports_multiple_statements?
+        #TODO Use ADAPTER_NAME when we've dropped AR 4.1 support
+        if (ar_conn.class.name == 'ActiveRecord::ConnectionAdapters::Mysql2Adapter') && ar_conn.transaction_open?
+          # Print the warning message, then fall back to non-multiple deletion
+          Kernel.warn "WARNING: You may be executing DatabaseRewinder inside a transactional test. You're presumably misconfiguring your tests. Please read DatabaseRewinder's document, and properly configure your tests."
+        else
+          ar_conn.execute_multiple tables.map {|t| "DELETE FROM #{ar_conn.quote_table_name(t)}"}.join(';')
+          return
+        end
+      end
+
+      ar_conn.disable_referential_integrity do
+        tables.each do |table_name|
+          ar_conn.execute "DELETE FROM #{ar_conn.quote_table_name(table_name)};"
         end
       end
     end

data/lib/database_rewinder/compatibility.rb

@@ -52,10 +52,10 @@ module DatabaseRewinder
 
   class Cleaner
     module Compatibility
-      def clean_with(_strategy, only: nil, except: nil, **)
+      def clean_with(_strategy, only: nil, except: nil, multiple: true, **)
         originals = @only, @except
         self.only, self.except = Array(only), Array(except)
-        clean_all
+        clean_all multiple: multiple
       ensure
         self.only, self.except = originals
       end

data/lib/database_rewinder/multiple_statements_executor.rb

@@ -13,8 +13,7 @@ module DatabaseRewinder
         when 'ActiveRecord::ConnectionAdapters::PostgreSQLAdapter'
           disable_referential_integrity { log(sql) { @connection.exec sql } }
         when 'ActiveRecord::ConnectionAdapters::Mysql2Adapter'
-          query_options = @connection.query_options.dup
-          if query_options[:connect_flags] & Mysql2::Client::MULTI_STATEMENTS != 0
+          if @connection.query_options[:connect_flags] & Mysql2::Client::MULTI_STATEMENTS != 0
             disable_referential_integrity do
               _result = log(sql) { @connection.query sql }
               while @connection.next_result
@@ -23,6 +22,7 @@ module DatabaseRewinder
               end
             end
           else
+            query_options = @connection.query_options.dup
             query_options[:connect_flags] |= Mysql2::Client::MULTI_STATEMENTS
             # opens another connection to the DB
             client = Mysql2::Client.new query_options

data/test/active_record_monkey_test.rb

@@ -10,7 +10,7 @@ class DatabaseRewinder::InsertRecorderTest < ActiveSupport::TestCase
   end
 
   test '#execute' do
-    cleaner = DatabaseRewinder.instance_variable_get(:'@cleaners').detect {|c| c.db == (ENV['DB'] == 'sqlite3' ? 'database_rewinder_test.sqlite3' : 'database_rewinder_test')}
+    cleaner = DatabaseRewinder.instance_variable_get(:'@cleaners').detect {|c| c.db == (ENV['DB'] == 'sqlite3' ? 'db/database_rewinder_test.sqlite3' : 'database_rewinder_test')}
 
     assert_equal %w(foos bars), cleaner.inserted_tables
     assert_not_nil cleaner.pool

data/test/config/database.yml

@@ -1,12 +1,12 @@
 sqlite3: &sqlite3
   adapter: sqlite3
-  database: database_rewinder_test.sqlite3
+  database: db/database_rewinder_test.sqlite3
   pool: 5
   timeout: 5000
 
 sqlite3_2: &sqlite3_2
   adapter: sqlite3
-  database: database_rewinder_test2.sqlite3
+  database: db/database_rewinder_test2.sqlite3
   pool: 5
   timeout: 5000
 

data/test/database_rewinder_test.rb

@@ -66,7 +66,7 @@ class DatabaseRewinder::DatabaseRewinderTest < ActiveSupport::TestCase
     end
 
     def perform_insert(sql)
-      @cleaner = DatabaseRewinder.instance_variable_get(:'@cleaners').detect {|c| c.db == (ENV['DB'] == 'sqlite3' ? 'database_rewinder_test.sqlite3' : 'database_rewinder_test')}
+      @cleaner = DatabaseRewinder.instance_variable_get(:'@cleaners').detect {|c| c.db == (ENV['DB'] == 'sqlite3' ? 'db/database_rewinder_test.sqlite3' : 'database_rewinder_test')}
 
       connection = ::ActiveRecord::Base.connection
       DatabaseRewinder.record_inserted_table(connection, sql)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: database_rewinder
 version: !ruby/object:Gem::Version
-  version: 0.7.1
+  version: 0.8.0
 platform: ruby
 authors:
 - Akira Matsuda
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-11-14 00:00:00.000000000 Z
+date: 2016-12-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -138,6 +138,7 @@ files:
 - test/cleaner_test.rb
 - test/config/database.yml
 - test/database_rewinder_test.rb
+- test/db/.keep
 - test/fake_app.rb
 - test/test_helper.rb
 homepage: https://github.com/amatsuda/database_rewinder
@@ -152,7 +153,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -169,5 +170,6 @@ test_files:
 - test/cleaner_test.rb
 - test/config/database.yml
 - test/database_rewinder_test.rb
+- test/db/.keep
 - test/fake_app.rb
 - test/test_helper.rb