database_cleaner 0.5.0 → 0.5.1

data/History.txt

@@ -1,5 +1,19 @@
 0.5.x (In Git)
 
+== 0.5.1 - The Mongoid Release
+
+This release also attempts to fix AR for Rails 3 support.  I have seen mixed reviews on this.  Some people
+claim the fixes allow for use in Rails3 while others have not had good luck with it.  I plan on reworking
+the way AR support is added so that it is more friendly with how Rails 3 uses autoload.
+
+ === New features
+  * Clean and clean_with methods are now aliased to clean! and clean_with!. (Ben Mabey)
+  * Mongoid Support! (Sidney Burks)
+
+=== Bugfixes
+  * Check PostgreSQL version >= 8.2 before using TRUNCATE CASCADE (James B. Byrne)
+  * Correct superclass is used in ActiveRecord connection adapters. (johnathan, Aslak Hellesoy, Ben Mabey)
+
 == 0.5.0 2010-02-22 - The CouchPotato Release
 
  === New features

data/VERSION.yml

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

data/examples/lib/mongoid_models.rb

@@ -0,0 +1,23 @@
+require 'mongoid'
+
+Mongoid.configure do |config|
+  name = 'database_cleaner_test'
+  config.master = Mongo::Connection.new.db(name)
+end
+
+
+#::MongoMapper.connection = Mongo::Connection.new('127.0.0.1')
+#::MongoMapper.database = 'database_cleaner_test'
+
+class Widget
+  include Mongoid::Document
+  field :id, :type => Integer
+  field :name
+
+  class << self
+    #mongomapper doesn't seem to provide this...
+    def create!(*args)
+      new(*args).save!
+    end
+  end
+end

data/examples/lib/mongomapper_models.rb

@@ -1,4 +1,4 @@
-require 'mongomapper'
+require 'mongo_mapper'
 
 ::MongoMapper.connection = Mongo::Connection.new('127.0.0.1')
 ::MongoMapper.database = 'database_cleaner_test'

data/features/cleaning.feature

@@ -17,4 +17,5 @@ Feature: database cleaning
     | DataMapper   | transaction   |
     | DataMapper   | truncation    |
     | MongoMapper  | truncation    |
+    | Mongoid      | truncation    |
     | CouchPotato  | truncation    |

data/features/step_definitions/database_cleaner_steps.rb

@@ -1,4 +1,4 @@
-Given /^I am using (ActiveRecord|DataMapper|MongoMapper|CouchPotato)$/ do |orm|
+Given /^I am using (ActiveRecord|DataMapper|MongoMapper|Mongoid|CouchPotato)$/ do |orm|
   @orm = orm
 end
 

data/lib/database_cleaner/active_record/truncation.rb

@@ -1,21 +1,29 @@
+require 'active_record/base'
+require 'active_record/connection_adapters/abstract_adapter'
 require "database_cleaner/truncation_base"
 
 module ActiveRecord
   module ConnectionAdapters
 
-    class MysqlAdapter
+    class AbstractAdapter
+    end
+
+    class SQLiteAdapter < AbstractAdapter
+    end
+
+    class MysqlAdapter < AbstractAdapter
       def truncate_table(table_name)
         execute("TRUNCATE TABLE #{quote_table_name(table_name)};")
       end
     end
 
-    class SQLite3Adapter
+    class SQLite3Adapter < SQLiteAdapter
       def truncate_table(table_name)
         execute("DELETE FROM #{quote_table_name(table_name)};")
       end
     end
 
-    class JdbcAdapter
+    class JdbcAdapter < AbstractAdapter
       def truncate_table(table_name)
         begin
           execute("TRUNCATE TABLE #{quote_table_name(table_name)};")
@@ -25,19 +33,32 @@ module ActiveRecord
       end
     end
 
-    class PostgreSQLAdapter
+    class PostgreSQLAdapter < AbstractAdapter
+
+      def self.db_version
+        @db_version ||= ActiveRecord::Base.connection.select_values(
+          "SELECT CHARACTER_VALUE 
+            FROM INFORMATION_SCHEMA.SQL_IMPLEMENTATION_INFO 
+            WHERE IMPLEMENTATION_INFO_NAME = 'DBMS VERSION' ").to_s
+      end
+
+      def self.cascade
+        @cascade ||= db_version >=  "08.02" ? "CASCADE" : ""
+      end
+
       def truncate_table(table_name)
-        execute("TRUNCATE TABLE #{quote_table_name(table_name)} CASCADE;")
+        execute("TRUNCATE TABLE #{quote_table_name(table_name)} #{self.class.cascade};")
       end
+
     end
 
-    class SQLServerAdapter
+    class SQLServerAdapter < AbstractAdapter
       def truncate_table(table_name)
         execute("TRUNCATE TABLE #{quote_table_name(table_name)};")
       end
     end
 
-    class OracleEnhancedAdapter
+    class OracleEnhancedAdapter < AbstractAdapter
       def truncate_table(table_name)
         execute("TRUNCATE TABLE #{quote_table_name(table_name)}")
       end

data/lib/database_cleaner/configuration.rb

@@ -16,12 +16,19 @@ module DatabaseCleaner
     end
   end
   
+
   module MongoMapper
     def self.available_strategies
       %w[truncation]
     end
   end
 
+  module Mongoid
+    def self.available_strategies
+      %w[truncation]
+    end
+  end
+
   module CouchPotato
     def self.available_strategies
       %w[truncation]
@@ -41,6 +48,8 @@ module DatabaseCleaner
       strategy
     end
 
+    alias clean_with! clean_with
+
     def strategy=(args)
       strategy, *strategy_args = args
        if strategy.is_a?(Symbol)
@@ -64,6 +73,8 @@ module DatabaseCleaner
       strategy.clean
     end
 
+    alias clean! clean
+
     private
 
     def strategy
@@ -72,7 +83,8 @@ module DatabaseCleaner
     end
 
     def orm_strategy(strategy)
-      require "database_cleaner/#{orm}/#{strategy}"
+		puts "Strategy is : #{strategy} and ORM is #{orm}"
+  		require "database_cleaner/#{orm}/#{strategy}"
       orm_module.const_get(strategy.to_s.capitalize)
     rescue LoadError => e
       raise UnknownStrategySpecified, "The '#{strategy}' strategy does not exist for the #{orm} ORM!  Available strategies: #{orm_module.available_strategies.join(', ')}"
@@ -87,10 +99,12 @@ module DatabaseCleaner
           'data_mapper'
         elsif defined? ::MongoMapper
           'mongo_mapper'
+        elsif defined? ::Mongoid
+          'mongoid'
         elsif defined? ::CouchPotato
           'couch_potato'
         else
-          raise NoORMDetected, "No known ORM was detected!  Is ActiveRecord, DataMapper, MongoMapper or CouchPotato loaded?"
+          raise NoORMDetected, "No known ORM was detected!  Is ActiveRecord, DataMapper, MongoMapper, Mongoid, or CouchPotato loaded?"
         end
       end
     end
@@ -104,6 +118,8 @@ module DatabaseCleaner
         DatabaseCleaner::DataMapper
       when 'mongo_mapper'
         DatabaseCleaner::MongoMapper
+      when 'mongoid'
+        DatabaseCleaner::Mongoid
       when 'couch_potato'
         DatabaseCleaner::CouchPotato
       end

data/lib/database_cleaner/mongoid/truncation.rb

@@ -0,0 +1,23 @@
+require 'database_cleaner/truncation_base'
+
+module DatabaseCleaner
+  module Mongoid
+    class Truncation < DatabaseCleaner::TruncationBase
+      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
+
+      private
+
+      def collections
+        ::Mongoid.database.collections
+      end	
+	
+	end
+  end
+end

data/spec/database_cleaner/active_record/transaction_spec.rb

@@ -0,0 +1,65 @@
+require File.dirname(__FILE__) + '/../../spec_helper'
+require 'database_cleaner/active_record/transaction'
+require 'active_record'
+
+module DatabaseCleaner
+  module ActiveRecord
+
+    describe Transaction do
+      let (:connection) { mock("connection") }
+      before(:each) do
+        ::ActiveRecord::Base.stub!(:connection).and_return(connection)
+      end
+
+      describe "#start" do
+        it "should increment open transactions if possible" do
+          connection.stub!(:respond_to?).with(:increment_open_transactions).and_return(true)
+          connection.stub!(:begin_db_transaction)
+
+          connection.should_receive(:increment_open_transactions)
+          Transaction.new.start
+        end
+
+        it "should tell ActiveRecord to increment connection if its not possible to increment current connection" do
+          connection.stub!(:respond_to?).with(:increment_open_transactions).and_return(false)
+          connection.stub!(:begin_db_transaction)
+
+          ::ActiveRecord::Base.should_receive(:increment_open_transactions)
+          Transaction.new.start
+        end
+
+        it "should start a transaction" do
+            connection.stub!(:increment_open_transactions)
+
+            connection.should_receive(:begin_db_transaction)
+            Transaction.new.start
+        end
+      end
+
+      describe "#clean" do
+        it "should start a transaction" do
+            connection.stub!(:decrement_open_transactions)
+
+            connection.should_receive(:rollback_db_transaction)
+            Transaction.new.clean
+        end
+        it "should decrement open transactions if possible" do
+          connection.stub!(:respond_to?).with(:decrement_open_transactions).and_return(true)
+          connection.stub!(:rollback_db_transaction)
+
+          connection.should_receive(:decrement_open_transactions)
+          Transaction.new.clean
+        end
+
+        it "should decrement connection via ActiveRecord::Base if connection won't" do
+          connection.stub!(:respond_to?).with(:decrement_open_transactions).and_return(false)
+          connection.stub!(:rollback_db_transaction)
+
+          ::ActiveRecord::Base.should_receive(:decrement_open_transactions)
+          Transaction.new.clean
+        end
+      end
+    end
+
+  end
+end

data/spec/database_cleaner/configuration_spec.rb

@@ -9,13 +9,16 @@ describe DatabaseCleaner do
   before(:all) do
     TempAR = ActiveRecord unless defined?(TempAR)
     TempMM = MongoMapper unless defined?(TempMM)
+    TempMI = Mongoid unless defined?(TempMI)
     Object.send(:remove_const, 'MongoMapper') if defined?(::MongoMapper)
+    Object.send(:remove_const, 'Mongoid') if defined?(::Mongoid)
     # need to add one for each ORM that we load in the spec helper...
   end
   after(:all) do
     Object.send(:remove_const, 'ActiveRecord') if defined?(::ActiveRecord) #want to make sure we have the real one...
     ActiveRecord = TempAR
     MongoMapper = TempMM
+	Mongoid = TempMI
   end
 
   before(:each) do

data/spec/database_cleaner/mongo_mapper/truncation_spec.rb

@@ -1,5 +1,5 @@
 require File.dirname(__FILE__) + '/../../spec_helper'
-require 'mongomapper'
+require 'mongo_mapper'
 require 'database_cleaner/mongo_mapper/truncation'
 
 MongoMapper.connection = Mongo::Connection.new('127.0.0.1')

data/spec/database_cleaner/mongoid/truncation_spec.rb

@@ -0,0 +1,84 @@
+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

data/spec/spec_helper.rb

@@ -1,6 +1,6 @@
 require 'rubygems'
 require 'spec'
-require 'activerecord'
+require 'active_record'
 
 $:.unshift(File.dirname(__FILE__) + '/../lib')
 require 'database_cleaner'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: database_cleaner
 version: !ruby/object:Gem::Version 
-  version: 0.5.0
+  version: 0.5.1
 platform: ruby
 authors: 
 - Ben Mabey
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-02-22 00:00:00 -07:00
+date: 2010-04-13 00:00:00 -06:00
 default_executable: 
 dependencies: []
 
@@ -35,6 +35,7 @@ files:
 - 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
 - features/cleaning.feature
 - features/step_definitions/database_cleaner_steps.rb
@@ -48,11 +49,14 @@ files:
 - lib/database_cleaner/data_mapper/transaction.rb
 - lib/database_cleaner/data_mapper/truncation.rb
 - lib/database_cleaner/mongo_mapper/truncation.rb
+- lib/database_cleaner/mongoid/truncation.rb
 - lib/database_cleaner/truncation_base.rb
+- spec/database_cleaner/active_record/transaction_spec.rb
 - spec/database_cleaner/active_record/truncation_spec.rb
 - spec/database_cleaner/configuration_spec.rb
 - spec/database_cleaner/couch_potato/truncation_spec.rb
 - spec/database_cleaner/mongo_mapper/truncation_spec.rb
+- spec/database_cleaner/mongoid/truncation_spec.rb
 - spec/spec.opts
 - spec/spec_helper.rb
 - LICENSE
@@ -86,14 +90,17 @@ signing_key:
 specification_version: 3
 summary: Strategies for cleaning databases.  Can be used to ensure a clean state for testing.
 test_files: 
+- spec/database_cleaner/active_record/transaction_spec.rb
 - spec/database_cleaner/active_record/truncation_spec.rb
 - spec/database_cleaner/configuration_spec.rb
 - spec/database_cleaner/couch_potato/truncation_spec.rb
 - spec/database_cleaner/mongo_mapper/truncation_spec.rb
+- spec/database_cleaner/mongoid/truncation_spec.rb
 - spec/spec_helper.rb
 - examples/features/step_definitions/example_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