database_cleaner 1.6.2 → 1.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 5e5f677e2a786401bf752e1c2c1d52166244c50b
-  data.tar.gz: 940e89a60acc778efb0bc71ca4c75c45205f5b72
+SHA256:
+  metadata.gz: 5a0ef67709709d9ad8373dbc723dc3c5b965766a7e48b40badf5d4392558a6bd
+  data.tar.gz: 141f0a4e38d548ca0f100dd25f7c305cf459d87970eff5b8283d1a7b79eb0734
 SHA512:
-  metadata.gz: 814c2563fecfc2c9951f59872630d144f300b367df97bd796bcbe7880afc8edfb4d23cab864ace6be2d34c7a3f295497152702f7f4500c90f8d7a052500d55cb
-  data.tar.gz: ddf414110b85f545a6872f6e45804d4a43f7f7020d0d71eb886f840a4bdaa1b8fd11476f009fead47c9a6d716135bd1158e5adc2d9999b966f6cb6430a34e549
+  metadata.gz: f8161cfd306d227da75c2d997eeae124f191d9382b81a7e884ac43a5e272b4a931386427e700ef11af9f5416f6916c467c77104e46441b6b9a5e6329191c3516
+  data.tar.gz: 52f01680d172a214fa97d9f495c644b329014c74e53c862aa7aa7c91c26b0ca0769e684632997c564a2001f60fc212e03dabca789e0b27b3d1a93d1cd964f5aa

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    database_cleaner (1.6.2)
+    database_cleaner (1.6.3)
 
 GEM
   remote: https://rubygems.org/
@@ -141,8 +141,8 @@ GEM
     httpclient (2.5.3.3)
     i18n (0.4.2)
     jdbc-sqlite3 (3.8.10.1)
-    json (1.8.1)
-    json (1.8.1-java)
+    json (1.8.6)
+    json (1.8.6-java)
     json_pure (1.8.1)
     listen (1.3.1)
       rb-fsevent (>= 0.9.3)

data/History.rdoc

@@ -1,5 +1,28 @@
 == Development (master)
 
+=== Bug Fixes
+=== Changes
+
+== 1.7.0 2017-04-19
+
+=== Bug Fixes
+  * Remove unnecessary folders from gem: https://github.com/DatabaseCleaner/database_cleaner/pull/508
+  * Properly quote table names: https://github.com/DatabaseCleaner/database_cleaner/pull/501
+  * Use more idiomatic Ruby in README: https://github.com/DatabaseCleaner/database_cleaner/pull/510
+  * Return ::ActiveRecord::Base from `establish_connection`: https://github.com/DatabaseCleaner/database_cleaner/pull/399
+
+=== Changes
+  * Safeguard against running in production or running against a remote database: https://github.com/DatabaseCleaner/database_cleaner/pull/521
+
+== 1.6.2 2017-10-29
+
+=== Bug Fixes
+  * ActiveRecord::Base namespace patch: https://github.com/DatabaseCleaner/database_cleaner/pull/490
+  * Better exclusion condition based on Rails version: https://github.com/DatabaseCleaner/database_cleaner/pull/487
+
+=== Changes
+  * Better documentation. Typos were fixed. Sequel deletion is supported: https://github.com/DatabaseCleaner/database_cleaner/pull/500
+
 == 1.6.1 2017-05-09
 
 === Bug Fixes

data/README.markdown

@@ -295,7 +295,7 @@ RSpec.configure do |config|
     # 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
+    unless 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.
@@ -502,6 +502,29 @@ Dir["#{Rails.root}/app/models/**/*.rb"].each do |model|
 end
 ```
 
+## Safeguards
+
+DatabaseCleaner comes with safeguards against:
+
+* Running in production (checking for `ENV`, `RACK_ENV`, and `RAILS_ENV`)
+* Running against a remote database (checking for a `DATABASE_URL` that does not include `localhost`)
+
+Both safeguards can be disabled separately as follows.
+
+Using environment variables:
+
+```
+export DATABASE_CLEANER_ALLOW_PRODUCTION=true
+export DATABASE_CLEANER_ALLOW_REMOTE_DATABASE_URL=true
+```
+
+In Ruby:
+
+```ruby
+DatabaseCleaner.allow_production = true
+DatabaseCleaner.allow_remote_database_url = true
+```
+
 ## Debugging
 
 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.

data/VERSION.yml

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

data/lib/database_cleaner.rb

@@ -2,7 +2,11 @@ $LOAD_PATH.unshift(File.expand_path(File.dirname(__FILE__))) unless $LOAD_PATH.i
 require 'database_cleaner/configuration'
 
 module DatabaseCleaner
-  def self.can_detect_orm?
-    DatabaseCleaner::Base.autodetect_orm
+  class << self
+    attr_accessor :allow_remote_database_url, :allow_production
+
+    def can_detect_orm?
+      DatabaseCleaner::Base.autodetect_orm
+    end
   end
 end

data/lib/database_cleaner/active_record/base.rb

@@ -85,8 +85,8 @@ module DatabaseCleaner
 
       def establish_connection
         ::ActiveRecord::Base.establish_connection(connection_hash)
+        ::ActiveRecord::Base
       end
-
     end
   end
 end

data/lib/database_cleaner/active_record/deletion.rb

@@ -66,14 +66,16 @@ module DatabaseCleaner::ActiveRecord
       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 #{::DatabaseCleaner::ActiveRecord::Base.exclusion_condition('table_name')};
+        tables = connection.select_values(<<-SQL)
+          SELECT table_name
+          FROM information_schema.tables
+          WHERE table_schema = '#{db_name}'
+          AND #{::DatabaseCleaner::ActiveRecord::Base.exclusion_condition('table_name')};
         SQL
+        queries = tables.map do |table|
+          "SELECT #{connection.quote(table)} AS table_name, COUNT(*) AS exact_row_count FROM #{connection.quote_table_name(table)}"
+        end
+        @table_stats_query = queries.join(' UNION ')
       end
     end
 

data/lib/database_cleaner/base.rb

@@ -1,4 +1,5 @@
 require 'database_cleaner/null_strategy'
+require 'database_cleaner/safeguard'
 module DatabaseCleaner
   class Base
     include Comparable
@@ -15,6 +16,7 @@ module DatabaseCleaner
       end
       self.db = opts[:connection] || opts[:model] if opts.has_key?(:connection) || opts.has_key?(:model)
       set_default_orm_strategy
+      Safeguard.new.run
     end
 
     def db=(desired_db)

data/lib/database_cleaner/safeguard.rb

@@ -0,0 +1,72 @@
+module DatabaseCleaner
+  class Safeguard
+    class Error < Exception
+      class RemoteDatabaseUrl < Error
+        def initialize
+          super("ENV['DATABASE_URL'] is set to a remote URL. Please refer to https://github.com/DatabaseCleaner/database_cleaner#safeguards")
+        end
+      end
+
+      class ProductionEnv < Error
+        def initialize(env)
+          super("ENV['#{env}'] is set to production. Please refer to https://github.com/DatabaseCleaner/database_cleaner#safeguards")
+        end
+      end
+    end
+
+    class RemoteDatabaseUrl
+      LOCAL = %w(localhost 127.0.0.1)
+
+      def run
+        raise Error::RemoteDatabaseUrl if !skip? && given?
+      end
+
+      private
+
+        def given?
+          remote?(ENV['DATABASE_URL'])
+        end
+
+        def remote?(url)
+          url && !LOCAL.any? { |str| url.include?(str) }
+        end
+
+        def skip?
+          ENV['DATABASE_CLEANER_ALLOW_REMOTE_DATABASE_URL'] ||
+            DatabaseCleaner.allow_remote_database_url
+        end
+    end
+
+    class Production
+      KEYS = %w(ENV RACK_ENV RAILS_ENV)
+
+      def run
+        raise Error::ProductionEnv.new(key) if !skip? && given?
+      end
+
+      private
+
+        def given?
+          !!key
+        end
+
+        def key
+          @key ||= KEYS.detect { |key| ENV[key] == 'production' }
+        end
+
+        def skip?
+          ENV['DATABASE_CLEANER_ALLOW_PRODUCTION'] ||
+            DatabaseCleaner.allow_production
+        end
+    end
+
+    CHECKS = [
+      RemoteDatabaseUrl,
+      Production
+    ]
+
+    def run
+      CHECKS.each { |const| const.new.run }
+    end
+  end
+end

metadata

@@ -1,14 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: database_cleaner
 version: !ruby/object:Gem::Version
-  version: 1.6.2
+  version: 1.7.0
 platform: ruby
 authors:
 - Ben Mabey
+- Ernesto Tagwerker
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-10-30 00:00:00.000000000 Z
+date: 2018-04-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -376,7 +377,7 @@ dependencies:
         version: '0'
 description: Strategies for cleaning databases. Can be used to ensure a clean state
   for testing.
-email: ben@benmabey.com
+email: ernesto@ombulabs.com
 executables: []
 extensions: []
 extra_rdoc_files:
@@ -393,40 +394,6 @@ files:
 - TODO
 - VERSION.yml
 - cucumber.yml
-- examples/Gemfile
-- examples/Gemfile.lock
-- examples/config/database.yml.example
-- examples/config/redis.yml
-- examples/db/sqlite_databases_go_here
-- examples/features/example.feature
-- examples/features/example_multiple_db.feature
-- examples/features/example_multiple_orm.feature
-- examples/features/step_definitions/activerecord_steps.rb
-- examples/features/step_definitions/couchpotato_steps.rb
-- examples/features/step_definitions/datamapper_steps.rb
-- examples/features/step_definitions/mongoid_steps.rb
-- examples/features/step_definitions/mongomapper_steps.rb
-- examples/features/step_definitions/neo4j_steps.rb
-- examples/features/step_definitions/ohm_steps.rb
-- examples/features/step_definitions/redis_steps.rb
-- examples/features/step_definitions/translation_steps.rb
-- examples/features/support/env.rb
-- examples/lib/activerecord_models.rb
-- examples/lib/couchpotato_models.rb
-- examples/lib/datamapper_models.rb
-- examples/lib/mongoid_models.rb
-- examples/lib/mongomapper_models.rb
-- examples/lib/neo4j_models.rb
-- examples/lib/ohm_models.rb
-- examples/lib/redis_models.rb
-- examples/lib/sequel_models.rb
-- features/cleaning.feature
-- features/cleaning_default_strategy.feature
-- features/cleaning_multiple_dbs.feature
-- features/cleaning_multiple_orms.feature
-- features/step_definitions/database_cleaner_steps.rb
-- features/support/env.rb
-- features/support/feature_runner.rb
 - lib/database_cleaner.rb
 - lib/database_cleaner/active_record/base.rb
 - lib/database_cleaner/active_record/deletion.rb
@@ -463,58 +430,11 @@ files:
 - lib/database_cleaner/ohm/truncation.rb
 - lib/database_cleaner/redis/base.rb
 - lib/database_cleaner/redis/truncation.rb
+- lib/database_cleaner/safeguard.rb
 - lib/database_cleaner/sequel/base.rb
 - lib/database_cleaner/sequel/deletion.rb
 - lib/database_cleaner/sequel/transaction.rb
 - lib/database_cleaner/sequel/truncation.rb
-- spec/database_cleaner/active_record/base_spec.rb
-- spec/database_cleaner/active_record/transaction_spec.rb
-- spec/database_cleaner/active_record/truncation/mysql2_spec.rb
-- spec/database_cleaner/active_record/truncation/mysql_spec.rb
-- spec/database_cleaner/active_record/truncation/postgresql_spec.rb
-- spec/database_cleaner/active_record/truncation/shared_fast_truncation.rb
-- spec/database_cleaner/active_record/truncation/sqlite3_spec.rb
-- spec/database_cleaner/active_record/truncation_spec.rb
-- spec/database_cleaner/base_spec.rb
-- spec/database_cleaner/configuration_spec.rb
-- spec/database_cleaner/couch_potato/truncation_spec.rb
-- spec/database_cleaner/data_mapper/base_spec.rb
-- spec/database_cleaner/data_mapper/transaction_spec.rb
-- spec/database_cleaner/data_mapper/truncation/sqlite3_spec.rb
-- spec/database_cleaner/data_mapper/truncation_spec.rb
-- spec/database_cleaner/generic/base_spec.rb
-- spec/database_cleaner/generic/truncation_spec.rb
-- spec/database_cleaner/mongo/mongo_examples.rb
-- spec/database_cleaner/mongo/truncation_spec.rb
-- spec/database_cleaner/mongo_mapper/base_spec.rb
-- spec/database_cleaner/mongo_mapper/mongo_examples.rb
-- spec/database_cleaner/mongo_mapper/truncation_spec.rb
-- spec/database_cleaner/moped/moped_examples.rb
-- spec/database_cleaner/moped/truncation_spec.rb
-- spec/database_cleaner/neo4j/base_spec.rb
-- spec/database_cleaner/neo4j/transaction_spec.rb
-- spec/database_cleaner/null_strategy_spec.rb
-- spec/database_cleaner/ohm/truncation_spec.rb
-- spec/database_cleaner/redis/base_spec.rb
-- spec/database_cleaner/redis/truncation_spec.rb
-- spec/database_cleaner/sequel/base_spec.rb
-- spec/database_cleaner/sequel/deletion_spec.rb
-- spec/database_cleaner/sequel/transaction_spec.rb
-- spec/database_cleaner/sequel/truncation/sqlite3_spec.rb
-- spec/database_cleaner/sequel/truncation_spec.rb
-- spec/database_cleaner/shared_strategy.rb
-- spec/rcov.opts
-- spec/spec_helper.rb
-- spec/support/active_record/database_setup.rb
-- spec/support/active_record/migrations/20150101010000_create_users.rb
-- spec/support/active_record/migrations/20150101020000_create_agents.rb
-- spec/support/active_record/mysql2_setup.rb
-- spec/support/active_record/mysql_setup.rb
-- spec/support/active_record/postgresql_setup.rb
-- spec/support/active_record/schema_setup.rb
-- spec/support/active_record/sqlite3_setup.rb
-- spec/support/data_mapper/schema_setup.rb
-- spec/support/data_mapper/sqlite3_setup.rb
 homepage: http://github.com/DatabaseCleaner/database_cleaner
 licenses:
 - MIT
@@ -535,7 +455,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.8
+rubygems_version: 2.7.3
 signing_key: 
 specification_version: 4
 summary: Strategies for cleaning databases.  Can be used to ensure a clean state for

data/examples/Gemfile

@@ -1 +0,0 @@
-examples/../Gemfile

data/examples/Gemfile.lock

@@ -1 +0,0 @@
-examples/../Gemfile.lock

data/examples/config/database.yml.example

@@ -1,8 +0,0 @@
-#This is an example of what database.yml *should* look like (when I wrote it)
-#The real database.yml is generated automatically by the active record model lib (so it can be correct)
-two: 
-  adapter: sqlite3
-  database: /path/to/examples/features/support/../../db/activerecord_two.db
-one: 
-  adapter: sqlite3
-  database: /path/to/examples/features/support/../../db/activerecord_one.db

data/examples/config/redis.yml

@@ -1,8 +0,0 @@
-test:
-  url: 'redis://localhost:6379/0'
-
-one:
-  url: 'redis://localhost:6379/1'
-
-two:
-  url: 'redis://localhost:6379/2'

data/examples/features/example.feature

@@ -1,11 +0,0 @@
-Feature: example
- In order to test DataBase Cleaner
- Here are some scenarios that rely on the DB being clean!
-
-  Scenario: dirty the db
-    When I create a widget
-    Then I should see 1 widget
-
-  Scenario: assume a clean db
-    When I create a widget
-    Then I should see 1 widget

data/examples/features/example_multiple_db.feature

@@ -1,23 +0,0 @@
-Feature: example
- In order to test DataBase Cleaner
- Here are some scenarios that rely on the DB being clean!
-
-  # Background:
-  #   Given I have setup DatabaseCleaner to clean multiple databases
-  #
-  Scenario: dirty the db
-    When I create a widget in one db
-     And I create a widget in another db
-    Then I should see 1 widget in one db
-     And I should see 1 widget in another db
-
-  Scenario: assume a clean db
-    When I create a widget in one db
-    Then I should see 1 widget in one db
-     And I should see 0 widget in another db
-
-  Scenario: assume a clean db
-    When I create a widget in another db
-    Then I should see 0 widget in one db
-     And I should see 1 widget in another db
-