database_cleaner 1.7.0 → 1.8.5

data/lib/database_cleaner/deprecation.rb

@@ -0,0 +1,26 @@
+module DatabaseCleaner
+  def deprecate message
+    method = caller.first[/\d+:in `(.*)'$/, 1].to_sym
+    @@deprecator ||= Deprecator.new
+    @@deprecator.deprecate method, message
+  end
+  module_function :deprecate
+
+  def called_externally?(file, caller)
+    file != caller.first[/^(.+\.rb):\d+/, 1]
+  end
+  module_function :called_externally?
+
+  class Deprecator
+    def initialize
+      @methods_already_warned = {}
+    end
+
+    def deprecate method, message
+      return if @methods_already_warned.key?(method)
+      $stderr.puts message
+      @methods_already_warned[method] = true
+    end
+  end
+end
+

data/lib/database_cleaner/null_strategy.rb

@@ -1,18 +1,18 @@
 module DatabaseCleaner
   class NullStrategy
-    def self.start
+    def start
       # no-op
     end
     
-     def self.db=(connection)
-       # no-op
-     end
+    def db=(connection)
+      # no-op
+    end
      
-    def self.clean
+    def clean
       # no-op
     end
 
-    def self.cleaning(&block)
+    def cleaning(&block)
       # no-op
       yield
     end

data/lib/database_cleaner/orm_autodetector.rb

@@ -0,0 +1,41 @@
+module DatabaseCleaner
+  class ORMAutodetector
+    ORMS = {
+      active_record: "ActiveRecord",
+      data_mapper: "DataMapper",
+      mongo_mapper: "MongoMapper",
+      mongoid: "Mongoid",
+      mongo: "Mongo",
+      couch_potato: "CouchPotato",
+      sequel: "Sequel",
+      moped: "Moped",
+      ohm: "Ohm",
+      redis: "Redis",
+      neo4j: "Neo4j",
+    }
+
+    def orm
+      @autodetected = true
+      autodetected_orm or raise no_orm_detected_error
+      ORMS.key(autodetected_orm.to_s)
+    end
+
+    def autodetected?
+      !!@autodetected
+    end
+
+    private
+
+    def autodetected_orm
+      ORMS.values.find do |orm|
+        Kernel.const_get(orm) rescue next
+      end
+    end
+
+    def no_orm_detected_error
+      orm_list = ORMS.values.join(", ").sub(ORMS.values.last, "or #{ORMS.values.last}")
+      NoORMDetected.new("No known ORM was detected!  Is #{orm_list} loaded?")
+    end
+  end
+  private_constant :ORMAutodetector
+end

data/lib/database_cleaner/safeguard.rb

@@ -12,8 +12,32 @@ module DatabaseCleaner
           super("ENV['#{env}'] is set to production. Please refer to https://github.com/DatabaseCleaner/database_cleaner#safeguards")
         end
       end
+
+      class NotWhitelistedUrl < Error
+        def initialize
+          super("ENV['DATABASE_URL'] is set to a URL that is not on the whitelist. Please refer to https://github.com/DatabaseCleaner/database_cleaner#safeguards")
+        end
+      end
+    end
+
+    class WhitelistedUrl
+      def run
+        return if skip?
+        raise Error::NotWhitelistedUrl if database_url_not_whitelisted?
+      end
+
+      private
+
+        def database_url_not_whitelisted?
+          !DatabaseCleaner.url_whitelist.include?(ENV['DATABASE_URL'])
+        end
+
+        def skip?
+          !DatabaseCleaner.url_whitelist
+        end
     end
 
+
     class RemoteDatabaseUrl
       LOCAL = %w(localhost 127.0.0.1)
 
@@ -28,12 +52,22 @@ module DatabaseCleaner
         end
 
         def remote?(url)
-          url && !LOCAL.any? { |str| url.include?(str) }
+          return false unless url
+
+          parsed = URI.parse(url)
+          return false if parsed.scheme == 'sqlite3:'
+
+          host = parsed.host
+          return false unless host
+          return false if LOCAL.include?(host)
+          return false if host.end_with? '.local'
+          true
         end
 
         def skip?
           ENV['DATABASE_CLEANER_ALLOW_REMOTE_DATABASE_URL'] ||
-            DatabaseCleaner.allow_remote_database_url
+            DatabaseCleaner.allow_remote_database_url ||
+            DatabaseCleaner.url_whitelist
         end
     end
 
@@ -62,7 +96,8 @@ module DatabaseCleaner
 
     CHECKS = [
       RemoteDatabaseUrl,
-      Production
+      Production,
+      WhitelistedUrl
     ]
 
     def run

data/lib/database_cleaner/spec.rb

@@ -0,0 +1,2 @@
+require "database_cleaner/spec/database_helper"
+require "database_cleaner/spec/shared_examples"

data/lib/database_cleaner/spec/database_helper.rb

@@ -0,0 +1,82 @@
+require 'yaml'
+
+module DatabaseCleaner
+  module Spec
+    class DatabaseHelper < Struct.new(:db)
+      def self.with_all_dbs &block
+        %w[mysql mysql2 sqlite3 postgres].map(&:to_sym).each do |db|
+          yield new(db)
+        end
+      end
+
+      def setup
+        create_db
+        establish_connection
+        load_schema
+      end
+
+      attr_reader :connection
+
+      def teardown
+        drop_db
+      end
+
+      private
+
+      def establish_connection(config = default_config)
+        raise NotImplementedError
+      end
+
+      def create_db
+        if db == :sqlite3
+          # NO-OP
+        elsif db == :postgres
+          establish_connection default_config.merge('database' => 'postgres')
+          connection.execute "CREATE DATABASE #{default_config['database']}" rescue nil
+        else
+          establish_connection default_config.merge("database" => nil)
+          connection.execute "CREATE DATABASE IF NOT EXISTS #{default_config['database']}"
+        end
+      end
+
+      def load_schema
+        connection.execute <<-SQL
+          CREATE TABLE IF NOT EXISTS users (
+            id SERIAL PRIMARY KEY,
+            name INTEGER
+          );
+        SQL
+
+        connection.execute <<-SQL
+          CREATE TABLE IF NOT EXISTS agents (
+            name INTEGER
+          );
+        SQL
+      end
+
+      def drop_db
+        if db == :sqlite3
+          begin
+            File.unlink(db_config['sqlite3']['database'])
+          rescue Errno::ENOENT
+          end
+        elsif db == :postgres
+          # FIXME
+          connection.execute "DROP TABLE IF EXISTS users"
+          connection.execute "DROP TABLE IF EXISTS agents"
+        else
+          connection.execute "DROP DATABASE IF EXISTS #{default_config['database']}"
+        end
+      end
+
+      def db_config
+        config_path = 'spec/support/config.yml'
+        @db_config ||= YAML.load(IO.read(config_path))
+      end
+
+      def default_config
+        db_config[db.to_s]
+      end
+    end
+  end
+end

data/lib/database_cleaner/spec/shared_examples.rb

@@ -0,0 +1,15 @@
+RSpec.shared_examples_for "a generic strategy" do
+  it { is_expected.to respond_to(:db)  }
+end
+
+RSpec.shared_examples_for "a generic truncation strategy" do
+  it { is_expected.to respond_to(:start) }
+  it { is_expected.to respond_to(:clean) }
+  it { is_expected.to respond_to(:cleaning) }
+end
+
+RSpec.shared_examples_for "a generic transaction strategy" do
+  it { is_expected.to respond_to(:start) }
+  it { is_expected.to respond_to(:clean) }
+  it { is_expected.to respond_to(:cleaning) }
+end

data/lib/database_cleaner/version.rb

@@ -0,0 +1,3 @@
+module DatabaseCleaner
+  VERSION = "1.8.5"
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: database_cleaner
 version: !ruby/object:Gem::Version
-  version: 1.7.0
+  version: 1.8.5
 platform: ruby
 authors:
 - Ben Mabey
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-04-19 00:00:00.000000000 Z
+date: 2020-05-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -179,6 +179,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: mongo
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.12.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.12.0
 - !ruby/object:Gem::Dependency
   name: moped
   requirement: !ruby/object:Gem::Requirement
@@ -264,19 +278,33 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rspec-rails
+  name: listen
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.14.2
+        version: 3.0.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.14.2
+        version: 3.0.0
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: cucumber
   requirement: !ruby/object:Gem::Requirement
@@ -375,9 +403,10 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: Strategies for cleaning databases. Can be used to ensure a clean state
+description: Strategies for cleaning databases. Can be used to ensure a clean slate
   for testing.
-email: ernesto@ombulabs.com
+email:
+- ernesto@ombulabs.com
 executables: []
 extensions: []
 extra_rdoc_files:
@@ -392,50 +421,89 @@ files:
 - README.markdown
 - Rakefile
 - TODO
-- VERSION.yml
+- adapters/database_cleaner-active_record/lib/database_cleaner-active_record.rb
+- adapters/database_cleaner-active_record/lib/database_cleaner/active_record.rb
+- adapters/database_cleaner-active_record/lib/database_cleaner/active_record/base.rb
+- adapters/database_cleaner-active_record/lib/database_cleaner/active_record/deletion.rb
+- adapters/database_cleaner-active_record/lib/database_cleaner/active_record/transaction.rb
+- adapters/database_cleaner-active_record/lib/database_cleaner/active_record/truncation.rb
+- adapters/database_cleaner-active_record/lib/database_cleaner/active_record/version.rb
+- adapters/database_cleaner-couch_potato/lib/database_cleaner-couch_potato.rb
+- adapters/database_cleaner-couch_potato/lib/database_cleaner/couch_potato.rb
+- adapters/database_cleaner-couch_potato/lib/database_cleaner/couch_potato/base.rb
+- adapters/database_cleaner-couch_potato/lib/database_cleaner/couch_potato/truncation.rb
+- adapters/database_cleaner-couch_potato/lib/database_cleaner/couch_potato/version.rb
+- adapters/database_cleaner-data_mapper/lib/database_cleaner-data_mapper.rb
+- adapters/database_cleaner-data_mapper/lib/database_cleaner/data_mapper.rb
+- adapters/database_cleaner-data_mapper/lib/database_cleaner/data_mapper/base.rb
+- adapters/database_cleaner-data_mapper/lib/database_cleaner/data_mapper/transaction.rb
+- adapters/database_cleaner-data_mapper/lib/database_cleaner/data_mapper/truncation.rb
+- adapters/database_cleaner-data_mapper/lib/database_cleaner/data_mapper/version.rb
+- adapters/database_cleaner-mongo/lib/database_cleaner-mongo.rb
+- adapters/database_cleaner-mongo/lib/database_cleaner/mongo.rb
+- adapters/database_cleaner-mongo/lib/database_cleaner/mongo/base.rb
+- adapters/database_cleaner-mongo/lib/database_cleaner/mongo/truncation.rb
+- adapters/database_cleaner-mongo/lib/database_cleaner/mongo/truncation_mixin.rb
+- adapters/database_cleaner-mongo/lib/database_cleaner/mongo/version.rb
+- adapters/database_cleaner-mongo_mapper/lib/database_cleaner-mongo_mapper.rb
+- adapters/database_cleaner-mongo_mapper/lib/database_cleaner/mongo_mapper.rb
+- adapters/database_cleaner-mongo_mapper/lib/database_cleaner/mongo_mapper/base.rb
+- adapters/database_cleaner-mongo_mapper/lib/database_cleaner/mongo_mapper/truncation.rb
+- adapters/database_cleaner-mongo_mapper/lib/database_cleaner/mongo_mapper/version.rb
+- adapters/database_cleaner-mongoid/lib/database_cleaner-mongoid.rb
+- adapters/database_cleaner-mongoid/lib/database_cleaner/mongoid.rb
+- adapters/database_cleaner-mongoid/lib/database_cleaner/mongoid/base.rb
+- adapters/database_cleaner-mongoid/lib/database_cleaner/mongoid/mongo1_truncation_mixin.rb
+- adapters/database_cleaner-mongoid/lib/database_cleaner/mongoid/mongo2_truncation_mixin.rb
+- adapters/database_cleaner-mongoid/lib/database_cleaner/mongoid/mongoid_truncation_mixin.rb
+- adapters/database_cleaner-mongoid/lib/database_cleaner/mongoid/truncation.rb
+- adapters/database_cleaner-mongoid/lib/database_cleaner/mongoid/version.rb
+- adapters/database_cleaner-moped/lib/database_cleaner-moped.rb
+- adapters/database_cleaner-moped/lib/database_cleaner/moped.rb
+- adapters/database_cleaner-moped/lib/database_cleaner/moped/base.rb
+- adapters/database_cleaner-moped/lib/database_cleaner/moped/truncation.rb
+- adapters/database_cleaner-moped/lib/database_cleaner/moped/truncation_base.rb
+- adapters/database_cleaner-moped/lib/database_cleaner/moped/version.rb
+- adapters/database_cleaner-neo4j/lib/database_cleaner-neo4j.rb
+- adapters/database_cleaner-neo4j/lib/database_cleaner/neo4j.rb
+- adapters/database_cleaner-neo4j/lib/database_cleaner/neo4j/base.rb
+- adapters/database_cleaner-neo4j/lib/database_cleaner/neo4j/deletion.rb
+- adapters/database_cleaner-neo4j/lib/database_cleaner/neo4j/transaction.rb
+- adapters/database_cleaner-neo4j/lib/database_cleaner/neo4j/truncation.rb
+- adapters/database_cleaner-neo4j/lib/database_cleaner/neo4j/version.rb
+- adapters/database_cleaner-ohm/lib/database_cleaner-ohm.rb
+- adapters/database_cleaner-ohm/lib/database_cleaner/ohm.rb
+- adapters/database_cleaner-ohm/lib/database_cleaner/ohm/truncation.rb
+- adapters/database_cleaner-ohm/lib/database_cleaner/ohm/version.rb
+- adapters/database_cleaner-redis/lib/database_cleaner-redis.rb
+- adapters/database_cleaner-redis/lib/database_cleaner/redis.rb
+- adapters/database_cleaner-redis/lib/database_cleaner/redis/base.rb
+- adapters/database_cleaner-redis/lib/database_cleaner/redis/truncation.rb
+- adapters/database_cleaner-redis/lib/database_cleaner/redis/version.rb
+- adapters/database_cleaner-sequel/lib/database_cleaner-sequel.rb
+- adapters/database_cleaner-sequel/lib/database_cleaner/sequel.rb
+- adapters/database_cleaner-sequel/lib/database_cleaner/sequel/base.rb
+- adapters/database_cleaner-sequel/lib/database_cleaner/sequel/deletion.rb
+- adapters/database_cleaner-sequel/lib/database_cleaner/sequel/transaction.rb
+- adapters/database_cleaner-sequel/lib/database_cleaner/sequel/truncation.rb
+- adapters/database_cleaner-sequel/lib/database_cleaner/sequel/version.rb
 - cucumber.yml
 - lib/database_cleaner.rb
-- lib/database_cleaner/active_record/base.rb
-- lib/database_cleaner/active_record/deletion.rb
-- lib/database_cleaner/active_record/transaction.rb
-- lib/database_cleaner/active_record/truncation.rb
 - lib/database_cleaner/base.rb
 - lib/database_cleaner/configuration.rb
-- lib/database_cleaner/couch_potato/base.rb
-- lib/database_cleaner/couch_potato/truncation.rb
 - lib/database_cleaner/cucumber.rb
-- lib/database_cleaner/data_mapper/base.rb
-- lib/database_cleaner/data_mapper/transaction.rb
-- lib/database_cleaner/data_mapper/truncation.rb
+- lib/database_cleaner/deprecation.rb
 - lib/database_cleaner/generic/base.rb
 - lib/database_cleaner/generic/transaction.rb
 - lib/database_cleaner/generic/truncation.rb
-- lib/database_cleaner/mongo/base.rb
-- lib/database_cleaner/mongo/truncation.rb
-- lib/database_cleaner/mongo/truncation_mixin.rb
-- lib/database_cleaner/mongo2/base.rb
-- lib/database_cleaner/mongo2/truncation_mixin.rb
-- lib/database_cleaner/mongo_mapper/base.rb
-- lib/database_cleaner/mongo_mapper/truncation.rb
-- lib/database_cleaner/mongoid/base.rb
-- lib/database_cleaner/mongoid/truncation.rb
-- lib/database_cleaner/moped/base.rb
-- lib/database_cleaner/moped/truncation.rb
-- lib/database_cleaner/moped/truncation_base.rb
-- lib/database_cleaner/neo4j/base.rb
-- lib/database_cleaner/neo4j/deletion.rb
-- lib/database_cleaner/neo4j/transaction.rb
-- lib/database_cleaner/neo4j/truncation.rb
 - lib/database_cleaner/null_strategy.rb
-- lib/database_cleaner/ohm/truncation.rb
-- lib/database_cleaner/redis/base.rb
-- lib/database_cleaner/redis/truncation.rb
+- lib/database_cleaner/orm_autodetector.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
-homepage: http://github.com/DatabaseCleaner/database_cleaner
+- lib/database_cleaner/spec.rb
+- lib/database_cleaner/spec/database_helper.rb
+- lib/database_cleaner/spec/shared_examples.rb
+- lib/database_cleaner/version.rb
+homepage: https://github.com/DatabaseCleaner/database_cleaner
 licenses:
 - MIT
 metadata: {}
@@ -454,10 +522,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.3
+rubygems_version: 3.0.8
 signing_key: 
 specification_version: 4
-summary: Strategies for cleaning databases.  Can be used to ensure a clean state for
+summary: Strategies for cleaning databases. Can be used to ensure a clean slate for
   testing.
 test_files: []