database_cleaner 0.6.0 → 0.6.1

data/History.txt

@@ -1,4 +1,17 @@
-== 0.6.x (In Git)
+== 0.6.2 (in git)
+
+== 0.6.1 2011-01-27
+
+ === New Features
+  * Default strategies for all ORM libs are defined. (GH-36, GH-38 Prem Sichanugrist)
+  * Add a NullStrategy. (GH-6 Ben Mabey)
+
+ === Bugfixes
+  * Mongo colletion indexes are dropped for collections being removed. (GH-41 Ben Mabey)
+  * Exclude database views from tables_to_truncate, if the connection adapter
+    supports reading from the ANSI standard information_schema views. (GH-25 Samer Abukhait)
+  * ORM types can be specified in string format and not mysteriously blowup. (GH-26 Ben Mabey)
+  * Do not remove MongoDB reserved system collections. (GH-24 Ches Martin)
 
 == 0.6.0 2010-10-25 - The Multi-ORM/Connection Release
 

data/README.textile

@@ -10,16 +10,21 @@ ActiveRecord, DataMapper, MongoMapper, Mongoid, and CouchPotato are supported.
 Here is an overview of the strategies supported for each library:
 
 |_. ORM        |_.  Truncation  |_.  Transaction  |_.  Deletion    |
-| ActiveRecord | Yes            | Yes             | Yes            |
-| DataMapper   | Yes            | Yes             | No             |
-| CouchPotato  | Yes            | No              | No             |
-| MongoMapper  | Yes            | No              | No             |
-| Mongiod      | Yes            | No              | No             |
+| ActiveRecord | Yes            | **Yes**         | Yes            |
+| DataMapper   | Yes            | **Yes**         | No             |
+| CouchPotato  | **Yes**        | No              | No             |
+| MongoMapper  | **Yes**        | No              | No             |
+| Mongoid      | **Yes**        | No              | No             |
+
+(Default strategy for each library is denoted in bold)
 
 The ActiveRecord @:deletion@ strategy is only useful for when the @:truncation@ strategy causes
 locks (as reported by some Oracle DB users).  The @:truncation@ strategy is the preferred option
 since it is much faster.
 
+Database Cleaner also includes a @null@ strategy (that does no cleaning at all) which can be used 
+with any ORM library. You can also explicitly use it by setting your strategy to @nil@.
+
 h2. How to use
 
 <pre>

data/VERSION.yml

@@ -1,6 +1,6 @@
---- 
+---
 :minor: 6
-:patch: 0
-:build: 
+:patch: 1
+:build:
 :major: 0
 

data/examples/config/database.yml

@@ -0,0 +1,7 @@
+--- 
+two: 
+  adapter: sqlite3
+  database: /Users/bmabey/Programming/ruby/database_cleaner/examples/features/support/../../db/activerecord_two.db
+one: 
+  adapter: sqlite3
+  database: /Users/bmabey/Programming/ruby/database_cleaner/examples/features/support/../../db/activerecord_one.db

data/examples/features/support/env.rb

@@ -54,9 +54,9 @@ if orm && strategy
     DatabaseCleaner[         orm.gsub(/(.)([A-Z]+)/,'\1_\2').downcase.to_sym ].strategy = strategy.to_sym
     DatabaseCleaner[ another_orm.gsub(/(.)([A-Z]+)/,'\1_\2').downcase.to_sym ].strategy = strategy.to_sym
   else
-    DatabaseCleaner.strategy = strategy.to_sym
+    DatabaseCleaner.strategy = strategy.to_sym unless strategy == "default"
   end
 
 else
-  raise "Run 'ORM=ActiveRecord|DataMapper|MongoMapper|CouchPotato [ANOTHER_ORM=...] [MULTIPLE_DBS=true] STRATEGY=transaction|truncation cucumber examples/features'"
+  raise "Run 'ORM=ActiveRecord|DataMapper|MongoMapper|CouchPotato [ANOTHER_ORM=...] [MULTIPLE_DBS=true] STRATEGY=transaction|truncation|default cucumber examples/features'"
 end

data/features/cleaning_default_strategy.feature

@@ -0,0 +1,19 @@
+Feature: database cleaning
+  In order to ease example and feature writing
+  As a developer
+  I want to have my database in a clean state with default strategy
+
+  Scenario Outline: ruby app
+    Given I am using <ORM>
+    And the default cleaning strategy
+
+    When I run my scenarios that rely on a clean database
+    Then I should see all green
+
+  Examples:
+    | ORM          |
+    | ActiveRecord |
+    | DataMapper   |
+    | MongoMapper  |
+    | Mongoid      |
+    | CouchPotato  |

data/lib/database_cleaner/active_record/base.rb

@@ -7,9 +7,13 @@ module DatabaseCleaner
     def self.available_strategies
       %w[truncation transaction deletion]
     end
+    
+    def self.config_file_location=(path)
+      @config_file_location = path
+    end
 
     def self.config_file_location
-      "#{DatabaseCleaner.app_root}/config/database.yml"
+      @config_file_location ||= "#{DatabaseCleaner.app_root}/config/database.yml"
     end
 
     module Base
@@ -27,8 +31,10 @@ module DatabaseCleaner
       end
 
       def load_config
-        connection_details = YAML::load(ERB.new(IO.read(ActiveRecord.config_file_location)).result)
-        self.connection_hash = connection_details[self.db.to_s]
+        if File.file?(ActiveRecord.config_file_location)
+          connection_details   = YAML::load(ERB.new(IO.read(ActiveRecord.config_file_location)).result)
+          self.connection_hash = connection_details[self.db.to_s]
+        end
       end
 
       def create_connection_klass

data/lib/database_cleaner/active_record/truncation.rb

@@ -9,6 +9,9 @@ module ActiveRecord
     USE_ARJDBC_WORKAROUND = defined?(ArJdbc)
 
     class AbstractAdapter
+      def views
+        @views ||= select_values("select table_name from information_schema.views where table_schema = '#{current_database}'") rescue []
+      end
     end
 
     unless USE_ARJDBC_WORKAROUND
@@ -99,7 +102,7 @@ module DatabaseCleaner::ActiveRecord
     private
 
     def tables_to_truncate
-       (@only || connection.tables) - @tables_to_exclude
+       (@only || connection.tables) - @tables_to_exclude - connection.views
     end
 
     def connection

data/lib/database_cleaner/base.rb

@@ -1,13 +1,15 @@
+require 'database_cleaner/null_strategy'
 module DatabaseCleaner
   class Base
 
     def initialize(desired_orm = nil,opts = {})
-      if desired_orm == :autodetect || desired_orm.nil?
+      if [:autodetect, nil, "autodetect"].include?(desired_orm)
         autodetect
       else
         self.orm = desired_orm
       end
       self.db = opts[:connection] if opts.has_key? :connection
+      set_default_orm_strategy
     end
 
     def db=(desired_db)
@@ -21,9 +23,6 @@ module DatabaseCleaner
       elsif desired_db!= :default
         raise ArgumentError, "You must provide a strategy object that supports non default databases when you specify a database"
       end
-    rescue NoStrategySetError
-      #handle NoStrategySetError by doing nothing at all
-      desired_db
     end
 
     def db
@@ -59,12 +58,11 @@ module DatabaseCleaner
     end
 
     def strategy
-      return @strategy if @strategy
-      raise NoStrategySetError, "Please set a strategy with DatabaseCleaner.strategy=."
+      @strategy || NullStrategy
     end
 
     def orm=(desired_orm)
-      @orm = desired_orm
+      @orm = desired_orm.to_sym
     end
 
     def orm
@@ -125,5 +123,14 @@ module DatabaseCleaner
         end
       end
     end
+
+    def set_default_orm_strategy
+      case orm
+      when :active_record, :data_mapper
+        self.strategy = :transaction
+      when :mongo_mapper, :mongoid, :couch_potato
+        self.strategy = :truncation
+      end
+    end
   end
 end

data/lib/database_cleaner/configuration.rb

@@ -2,7 +2,6 @@ require 'database_cleaner/base'
 
 module DatabaseCleaner
 
-  class NoStrategySetError < StandardError;   end
   class NoORMDetected < StandardError;   end
   class UnknownStrategySpecified < ArgumentError;   end
 

data/lib/database_cleaner/mongo/truncation.rb

@@ -0,0 +1,27 @@
+module DatabaseCleaner
+  module Mongo
+    module Truncation
+      
+      def clean
+        if @only
+          collections.each { |c| remove(c) if @only.include?(c.name) }
+        else
+          collections.each { |c| remove(c) unless @tables_to_exclude.include?(c.name) }
+        end
+        true
+      end
+
+      private
+      
+      def remove(collection)
+        collection.drop_indexes
+        collection.remove
+      end
+
+      def collections
+        database.collections.select { |c| c.name !~ /^system/ }
+      end
+
+    end
+  end
+end

data/lib/database_cleaner/mongo_mapper/truncation.rb

@@ -1,35 +1,18 @@
 require 'database_cleaner/mongo_mapper/base'
 require 'database_cleaner/generic/truncation'
+require 'database_cleaner/mongo/truncation'
 
 module DatabaseCleaner
   module MongoMapper
     class Truncation
       include ::DatabaseCleaner::MongoMapper::Base
       include ::DatabaseCleaner::Generic::Truncation
-
-      def clean
-        if @only
-          collections.each { |c| c.remove if @only.include?(c.name) }
-        elsif @tables_to_exclude
-          collections.each { |c| c.remove unless @tables_to_exclude.include?(c.name) }
-        else
-          collections.each { |c| c.remove }
-        end
-        true
-      end
-
+      include ::DatabaseCleaner::Mongo::Truncation
+      
       private
 
-      def connection
-        ::MongoMapper.connection
-      end
-
-      def collections
-        connection.db(database).collections
-      end
-
       def database
-        ::MongoMapper.database.name
+        ::MongoMapper.database
       end
     end
   end

data/lib/database_cleaner/mongoid/truncation.rb

@@ -1,25 +1,18 @@
 require 'database_cleaner/mongoid/base'
 require 'database_cleaner/generic/truncation'
+require 'database_cleaner/mongo/truncation'
 
 module DatabaseCleaner
   module Mongoid
     class Truncation
       include ::DatabaseCleaner::Mongoid::Base
       include ::DatabaseCleaner::Generic::Truncation
-
-      def clean
-        if @only
-          collections.each { |c| c.remove if @only.include?(c.name) }
-        else
-          collections.each { |c| c.remove unless @tables_to_exclude.include?(c.name) }
-        end
-        true
-      end
+      include ::DatabaseCleaner::Mongo::Truncation
 
       private
 
-      def collections
-        ::Mongoid.database.collections
+      def database
+        ::Mongoid.database
       end
 
   end

data/lib/database_cleaner/null_strategy.rb

@@ -0,0 +1,15 @@
+module DatabaseCleaner
+  class NullStrategy
+    def self.start
+      # no-op
+    end
+    
+     def self.db=(connection)
+       # no-op
+     end
+     
+    def self.clean
+      # no-op
+    end
+  end
+end

data/spec/database_cleaner/active_record/base_spec.rb

@@ -11,6 +11,7 @@ module DatabaseCleaner
       subject { ActiveRecord.config_file_location }
 
       it "should default to DatabaseCleaner.root / config / database.yml" do
+        ActiveRecord.config_file_location=nil
         DatabaseCleaner.should_receive(:app_root).and_return("/path/to")
         subject.should == '/path/to/config/database.yml'
       end
@@ -24,8 +25,11 @@ module DatabaseCleaner
     end
 
     describe ExampleStrategy do
+      let :config_location do
+        '/path/to/config/database.yml'
+      end
 
-      before { ::DatabaseCleaner::ActiveRecord.stub(:config_file_location).and_return('/path/to/config/database.yml') }
+      before { ::DatabaseCleaner::ActiveRecord.stub(:config_file_location).and_return(config_location) }
 
       it_should_behave_like "a generic strategy"
 
@@ -58,7 +62,8 @@ module DatabaseCleaner
 my_db:
   database: <%= "ONE".downcase %>
           Y
-          IO.stub(:read).with('/path/to/config/database.yml').and_return(yaml)
+          File.stub(:file?).with(config_location).and_return(true)
+          IO.stub(:read).with(config_location).and_return(yaml)
         end
 
         it "should parse the config" do
@@ -80,6 +85,12 @@ my_db:
           subject.load_config
           subject.connection_hash.should == {"database" => "one"}
         end
+
+        it "should skip config if config file is not available" do
+          File.should_receive(:file?).with(config_location).and_return(false)
+          subject.load_config
+          subject.connection_hash.should be_blank
+        end
       end
 
       describe "connection_hash" do

data/spec/database_cleaner/active_record/truncation_spec.rb

@@ -22,6 +22,7 @@ module DatabaseCleaner
 
       before(:each) do
         connection.stub!(:disable_referential_integrity).and_yield
+        connection.stub!(:views).and_return([])
         ::ActiveRecord::Base.stub!(:connection).and_return(connection)
       end
 
@@ -62,6 +63,17 @@ module DatabaseCleaner
       it "should raise an error when invalid options are provided" do
         running { Truncation.new(:foo => 'bar') }.should raise_error(ArgumentError)
       end
+
+      it "should not truncate views" do
+        connection.stub!(:tables).and_return(%w[widgets dogs])
+        connection.stub!(:views).and_return(["widgets"])
+
+        connection.should_receive(:truncate_table).with('dogs')
+        connection.should_not_receive(:truncate_table).with('widgets')
+
+        Truncation.new.clean
+      end
+
     end
   end
 end

data/spec/database_cleaner/base_spec.rb

@@ -1,6 +1,9 @@
 require File.dirname(__FILE__) + '/../spec_helper'
 require 'database_cleaner/active_record/transaction'
 require 'database_cleaner/data_mapper/transaction'
+require 'database_cleaner/mongo_mapper/truncation'
+require 'database_cleaner/mongoid/truncation'
+require 'database_cleaner/couch_potato/truncation'
 
 module DatabaseCleaner
   describe Base do
@@ -138,13 +141,18 @@ module DatabaseCleaner
           cleaner.orm.should == :a_orm
         end
 
-        it "should be autodetected if orm is nil" do
+        it "converts string to symbols" do
+          cleaner = ::DatabaseCleaner::Base.new "mongoid"
+          cleaner.orm.should == :mongoid
+        end
+        
+        it "is autodetected if orm is not provided" do
           cleaner = ::DatabaseCleaner::Base.new
           cleaner.should be_auto_detected
         end
 
-        it "should autodetect if you specify :autodetect" do
-          cleaner = ::DatabaseCleaner::Base.new :autodetect
+        it "is autodetected if you specify :autodetect" do
+          cleaner = ::DatabaseCleaner::Base.new "autodetect"
           cleaner.should be_auto_detected
         end
 
@@ -305,12 +313,14 @@ module DatabaseCleaner
     end
 
     describe "strategy" do
-      it "should raise NoStrategySetError if strategy is nil" do
+      subject { ::DatabaseCleaner::Base.new :a_orm }
+
+      it "returns a null strategy when strategy no set and undetectable" do
         subject.instance_values["@strategy"] = nil
-        expect{ subject.strategy }.to raise_error NoStrategySetError
+        subject.strategy.should == DatabaseCleaner::NullStrategy
       end
 
-      it "should return @strategy if @strategy is present" do
+      it "returns the set strategy" do
         strategum = mock("strategy")
         subject.strategy = strategum
         subject.strategy.should == strategum
@@ -437,5 +447,32 @@ module DatabaseCleaner
 
     end
 
+    describe 'set_default_orm_strategy' do
+      it 'sets strategy to :transaction for ActiveRecord' do
+        cleaner = DatabaseCleaner::Base.new(:active_record)
+        cleaner.strategy.should be_instance_of DatabaseCleaner::ActiveRecord::Transaction
+      end
+
+      it 'sets strategy to :transaction for DataMapper' do
+        cleaner = DatabaseCleaner::Base.new(:data_mapper)
+        cleaner.strategy.should be_instance_of DatabaseCleaner::DataMapper::Transaction
+      end
+
+      it 'sets strategy to :truncation for MongoMapper' do
+        cleaner = DatabaseCleaner::Base.new(:mongo_mapper)
+        cleaner.strategy.should be_instance_of DatabaseCleaner::MongoMapper::Truncation
+      end
+
+      it 'sets strategy to :truncation for Mongoid' do
+        cleaner = DatabaseCleaner::Base.new(:mongoid)
+        cleaner.strategy.should be_instance_of DatabaseCleaner::Mongoid::Truncation
+      end
+
+      it 'sets strategy to :truncation for CouchPotato' do
+        cleaner = DatabaseCleaner::Base.new(:couch_potato)
+        cleaner.strategy.should be_instance_of DatabaseCleaner::CouchPotato::Truncation
+      end
+    end
+
   end
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: database_cleaner
 version: !ruby/object:Gem::Version 
-  hash: 7
+  hash: 5
   prerelease: false
   segments: 
   - 0
   - 6
-  - 0
-  version: 0.6.0
+  - 1
+  version: 0.6.1
 platform: ruby
 authors: 
 - Ben Mabey
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-10-25 00:00:00 -06:00
+date: 2011-01-27 00:00:00 -07:00
 default_executable: 
 dependencies: []
 
@@ -38,7 +38,13 @@ files:
 - cucumber.yml
 - examples/Gemfile
 - examples/Gemfile.lock
+- examples/config/database.yml
 - examples/config/database.yml.example
+- examples/db/activerecord_one.db
+- examples/db/activerecord_two.db
+- examples/db/datamapper_default.db
+- examples/db/datamapper_one.db
+- examples/db/datamapper_two.db
 - examples/db/sqlite_databases_go_here
 - examples/features/example.feature
 - examples/features/example_multiple_db.feature
@@ -56,6 +62,7 @@ files:
 - examples/lib/mongoid_models.rb
 - examples/lib/mongomapper_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
@@ -76,10 +83,12 @@ files:
 - lib/database_cleaner/data_mapper/truncation.rb
 - lib/database_cleaner/generic/base.rb
 - lib/database_cleaner/generic/truncation.rb
+- lib/database_cleaner/mongo/truncation.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/null_strategy.rb
 - spec/database_cleaner/active_record/base_spec.rb
 - spec/database_cleaner/active_record/transaction_spec.rb
 - spec/database_cleaner/active_record/truncation_spec.rb
@@ -94,7 +103,6 @@ files:
 - 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/mongoid/truncation_spec.rb
 - spec/database_cleaner/shared_strategy_spec.rb
 - spec/rcov.opts
 - spec/spec.opts
@@ -150,7 +158,6 @@ test_files:
 - 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/mongoid/truncation_spec.rb
 - spec/database_cleaner/shared_strategy_spec.rb
 - spec/spec_helper.rb
 - examples/features/step_definitions/activerecord_steps.rb

data/spec/database_cleaner/mongoid/truncation_spec.rb

@@ -1,84 +0,0 @@
-require File.dirname(__FILE__) + '/../../spec_helper'
-require 'mongoid'
-require 'database_cleaner/mongoid/truncation'
-
-TEST_DATABASE = 'database_cleaner_specs'
-Mongoid.configure do |config|
-  name = TEST_DATABASE
-  config.master = Mongo::Connection.new.db(name)
-end
-
-class TestClassA
-  include Mongoid::Document
-  field :name
-end
-
-class TestClassB
-  include Mongoid::Document
-  field :name
-end
-
-
-module DatabaseCleaner
-  module Mongoid
-
-    describe Truncation do
-      before(:each) do
-        ::Mongoid.database.connection.drop_database(TEST_DATABASE)
-        #::MongoMapper.connection.db(TEST_DATABASE).collections.each {|c| c.remove }
-        #::MongoMapper.database = TEST_DATABASE
-      end
-
-      def ensure_counts(expected_counts)
-        # I had to add this sanity_check garbage because I was getting non-determinisc results from mongomapper at times..
-        # very odd and disconcerting...
-        sanity_check = expected_counts.delete(:sanity_check)
-        begin
-          expected_counts.each do |model_class, expected_count|
-            model_class.count.should equal(expected_count), "#{model_class} expected to have a count of #{expected_count} but was #{model_class.count}"
-          end
-        rescue Spec::Expectations::ExpectationNotMetError => e
-          raise !sanity_check ? e : Spec::ExpectationNotMetError::ExpectationNotMetError.new("SANITY CHECK FAILURE! This should never happen here: #{e.message}")
-        end
-      end
-
-      def create_testclassa(attrs={})
-        TestClassA.new({:name => 'some testclassa'}.merge(attrs)).save!
-      end
-
-      def create_testclassb(attrs={})
-        TestClassB.new({:name => 'some testclassb'}.merge(attrs)).save!
-      end
-
-      it "truncates all collections by default" do
-        create_testclassa
-        create_testclassb
-        ensure_counts(TestClassA => 1, TestClassB => 1, :sanity_check => true)
-        Truncation.new.clean
-        ensure_counts(TestClassA => 0, TestClassB => 0)
-      end
-
-      context "when collections are provided to the :only option" do
-        it "only truncates the specified collections" do
-          create_testclassa
-          create_testclassb
-          ensure_counts(TestClassA => 1, TestClassB => 1, :sanity_check => true)
-          Truncation.new(:only => ['test_class_as']).clean
-          ensure_counts(TestClassA => 0, TestClassB => 1)
-        end
-      end
-
-      context "when collections are provided to the :except option" do
-        it "truncates all but the specified collections" do
-          create_testclassa
-          create_testclassb
-          ensure_counts(TestClassA => 1, TestClassB => 1, :sanity_check => true)
-          Truncation.new(:except => ['test_class_as']).clean
-          ensure_counts(TestClassA => 1, TestClassB => 0)
-        end
-      end
-
-    end
-
-  end
-end