bmabey-database_cleaner 0.1.3 → 0.2.0

data/History.txt

@@ -3,7 +3,14 @@
  === New features 
  === Bufixes
 
-== 0.1.3 2009-04-30 
+== 0.2.0 2009-05-08 - The Datamapper Release
+
+ === New features
+  * DataMapper strategies (Martin Gamsjaeger)
+    * Transaction
+    * Truncation - working SQLite3, MySQL adapters. Experimental Postgres adapter (not tested).
+
+== 0.1.3 2009-04-30
 
  === New features 
   * PostgresSQLAdapter for AR to support the truncation strategy. (Alberto Perdomo)
@@ -14,7 +21,7 @@
  === New features
   * JDBC Adapter to enable AR truncation strategy to work. (Kamal Fariz Mahyuddin)
 
-== 0.1.1 2009-03-04 - Initial Release ( Ben Mabey )
+== 0.1.1 2009-03-04 - Initial Release (Ben Mabey)
   * Basic infrastructure
   * Features, RSpec code examples
   * ActiveRecord strategies

data/Rakefile

@@ -43,4 +43,4 @@ rescue LoadError
   puts "Cucumber is not available. In order to run features, you must: sudo gem install cucumber"
 end
 
-task :default => :spec
+task :default => [:spec, :features]

data/VERSION.yml

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

data/examples/features/support/env.rb

@@ -1,16 +1,23 @@
 require 'rubygems'
 require 'spec/expectations'
 
-begin
-  require "#{File.dirname(__FILE__)}/../../lib/#{ENV['ORM']}"
-rescue LoadError
-  raise "I don't have the setup for the '#{ENV['ORM']}' ORM!"
-end
-
-$:.unshift(File.dirname(__FILE__) + '/../../../lib')
-require 'database_cleaner'
-require 'database_cleaner/cucumber'
+orm      = ENV['ORM']
+strategy = ENV['STRATEGY']
 
-DatabaseCleaner.strategy = ENV['STRATEGY'].to_sym
+if orm && strategy
+  
+  begin
+    require "#{File.dirname(__FILE__)}/../../lib/#{orm}"
+  rescue LoadError
+    raise "You don't have the #{orm} ORM installed"
+  end
 
+  $:.unshift(File.dirname(__FILE__) + '/../../../lib')
+  require 'database_cleaner'
+  require 'database_cleaner/cucumber'
 
+  DatabaseCleaner.strategy = strategy.to_sym
+  
+else
+  raise "Run 'ORM=activerecord|datamapper STRATEGY=transaction|truncation cucumber examples/features'"
+end

data/examples/lib/datamapper.rb

@@ -0,0 +1,16 @@
+require "dm-core"
+
+# only to please activerecord API used in database_cleaner/examples/features/step_definitions
+# yes, i know that's lazy ...
+require "dm-validations"
+require "dm-aggregates"
+
+DataMapper.setup(:default, "sqlite3::memory:")
+
+class Widget
+  include DataMapper::Resource
+  property :id,   Serial
+  property :name, String
+end
+
+Widget.auto_migrate!

data/features/cleaning.feature

@@ -14,3 +14,5 @@ Feature: database cleaning
     | ORM          | Strategy      |
     | ActiveRecord | transaction   |
     | ActiveRecord | truncation    |
+    | DataMapper   | transaction   |
+    | DataMapper   | truncation    |

data/lib/database_cleaner/active_record/truncation.rb

@@ -1,6 +1,8 @@
+require "database_cleaner/truncation_base"
 
 module ActiveRecord
   module ConnectionAdapters
+
     class MysqlAdapter
       def truncate_table(table_name)
         execute("TRUNCATE TABLE #{quote_table_name(table_name)};")
@@ -25,31 +27,12 @@ module ActiveRecord
       end
     end
 
-
   end
-
 end
 
 
 module DatabaseCleaner::ActiveRecord
-  class Truncation
-
-    def initialize(options={})
-      if !options.empty? && !(options.keys - [:only, :except]).empty?
-        raise ArgumentError, "The only valid options are :only and :except. You specified #{options.keys.join(',')}."
-      end
-      if options.has_key?(:only) && options.has_key?(:except)
-        raise ArgumentError, "You may only specify either :only or :either.  Doing both doesn't really make sense does it?" 
-      end
-
-      @only = options[:only]
-      @tables_to_exclude = (options[:except] || []) << 'schema_migrations'
-    end
-
-    def start
-      # no-op
-    end
-
+  class Truncation < ::DatabaseCleaner::TruncationBase
 
     def clean
       connection.disable_referential_integrity do
@@ -57,9 +40,9 @@ module DatabaseCleaner::ActiveRecord
           connection.truncate_table table_name
         end
       end
-  end
+    end
 
-  private
+    private
 
     def tables_to_truncate
       (@only || connection.tables) - @tables_to_exclude
@@ -69,8 +52,12 @@ module DatabaseCleaner::ActiveRecord
       ::ActiveRecord::Base.connection
     end
 
-  end
+    # overwritten
+    def migration_storage_name
+      'schema_migrations'
+    end
 
+  end
 end
 
 

data/lib/database_cleaner/configuration.rb

@@ -1,5 +1,5 @@
 module DatabaseCleaner
- 
+
   class NoStrategySetError < StandardError;   end
   class NoORMDetected < StandardError;   end
   class UnknownStrategySpecified < ArgumentError;   end
@@ -12,7 +12,7 @@ module DatabaseCleaner
 
   module DataMapper
     def self.available_strategies
-      %w[]
+      %w[truncation transaction]
     end
   end
 
@@ -69,14 +69,14 @@ module DatabaseCleaner
 
     def orm
       @orm ||=begin
-                 if defined? ::ActiveRecord
-                  'active_record'
-                elsif defined? ::DataMapper
-                  'data_mapper'
-                else
-                  raise NoORMDetected, "No known ORM was detected!  Is ActiveRecord or DataMapper loaded?"
-                end
-              end
+        if defined? ::ActiveRecord
+          'active_record'
+        elsif defined? ::DataMapper
+          'data_mapper'
+        else
+          raise NoORMDetected, "No known ORM was detected!  Is ActiveRecord or DataMapper loaded?"
+        end
+      end
     end
 
 
@@ -91,4 +91,45 @@ module DatabaseCleaner
 
   end
 
+
+  class TruncationBase
+
+    def initialize(options = {})
+      if !options.empty? && !(options.keys - [:only, :except]).empty?
+        raise ArgumentError, "The only valid options are :only and :except. You specified #{options.keys.join(',')}."
+      end
+      if options.has_key?(:only) && options.has_key?(:except)
+        raise ArgumentError, "You may only specify either :only or :either.  Doing both doesn't really make sense does it?"
+      end
+
+      @only = options[:only]
+      @tables_to_exclude = (options[:except] || [])
+      if migration_storage = migration_storage_name
+        @tables_to_exclude << migration_storage
+      end
+    end
+
+    def start
+      # no-op
+    end
+
+    def clean
+      raise NotImplementedError
+    end
+
+
+    private
+
+    def tables_to_truncate
+      raise NotImplementedError
+    end
+
+    # overwrite in subclasses
+    # default implementation given because migration storage need not be present
+    def migration_storage_name
+      nil
+    end
+
+  end
+
 end

data/lib/database_cleaner/data_mapper/transaction.rb

@@ -1,6 +1,23 @@
 module DatabaseCleaner::DataMapper
   class Transaction
 
-  end
+    def start(repo = :default)
+      DataMapper.repository(repo) do |r|
+        transaction = DataMapper::Transaction.new(r)
+        transaction.begin
+        r.adapter.push_transaction(transaction)
+      end
+    end
+
+    def clean(repo = :default)
+      DataMapper.repository(repo) do |r|
+        adapter = r.adapter
+        while adapter.current_transaction
+          adapter.current_transaction.rollback
+          adapter.pop_transaction
+        end
+      end
+    end
 
+  end
 end

data/lib/database_cleaner/data_mapper/truncation.rb

@@ -0,0 +1,142 @@
+require "database_cleaner/truncation_base"
+
+module DataMapper
+  module Adapters
+
+    class DataObjectsAdapter
+
+      def storage_names(repository = :default)
+        raise NotImplementedError
+      end
+
+    end
+
+    class MysqlAdapter < DataObjectsAdapter
+
+      # taken from http://github.com/godfat/dm-mapping/tree/master
+      def storage_names(repository = :default)
+        query 'SHOW TABLES'
+      end
+
+      def truncate_table(table_name)
+        execute("TRUNCATE TABLE #{quote_table_name(table_name)};")
+      end
+
+      # copied from activerecord
+      def disable_referential_integrity
+        old = query("SELECT @@FOREIGN_KEY_CHECKS;")
+        begin
+          execute("SET FOREIGN_KEY_CHECKS = 0;")
+          yield
+        ensure
+          execute("SET FOREIGN_KEY_CHECKS = #{old};")
+        end
+      end
+
+    end
+
+    class Sqlite3Adapter < DataObjectsAdapter
+
+      # taken from http://github.com/godfat/dm-mapping/tree/master
+      def storage_names(repository = :default)
+        # activerecord-2.1.0/lib/active_record/connection_adapters/sqlite_adapter.rb: 177
+        sql = <<-SQL.compress_lines
+          SELECT name
+          FROM sqlite_master
+          WHERE type = 'table' AND NOT name = 'sqlite_sequence'
+        SQL
+        # activerecord-2.1.0/lib/active_record/connection_adapters/sqlite_adapter.rb: 181
+        query sql
+      end
+
+      def truncate_table(table_name)
+        execute("DELETE FROM #{quote_table_name(table_name)};")
+      end
+
+      # this is a no-op copied from activerecord
+      # i didn't find out if/how this is possible
+      # activerecord also doesn't do more here
+      def disable_referential_integrity
+        yield
+      end
+
+    end
+
+
+    # FIXME
+    # i don't know if this works
+    # i basically just copied activerecord code to get a rough idea what they do.
+    # i don't have postgres available, so i won't be the one to write this.
+    # maybe codes below gets some postgres/datamapper user going, though.
+    class PostgresAdapter < DataObjectsAdapter
+
+      # taken from http://github.com/godfat/dm-mapping/tree/master
+      def storage_names(repository = :default)
+        sql = <<-SQL.compress_lines
+          SELECT table_name FROM "information_schema"."tables"
+          WHERE table_schema = current_schema()
+        SQL
+        query(sql)
+      end
+
+      def truncate_table(table_name)
+        execute("TRUNCATE TABLE #{quote_table_name(table_name)};")
+      end
+
+      # FIXME
+      # copied from activerecord
+      def supports_disable_referential_integrity?
+        version = query("SHOW server_version")[0][0].split('.')
+        (version[0].to_i >= 8 && version[1].to_i >= 1) ? true : false
+      rescue
+        return false
+      end
+
+      # FIXME
+      # copied unchanged from activerecord
+      def disable_referential_integrity(repository = :default)
+        if supports_disable_referential_integrity? then
+          execute(storage_names(repository).collect do |name|
+            "ALTER TABLE #{quote_table_name(name)} DISABLE TRIGGER ALL"
+          end.join(";"))
+        end
+        yield
+      ensure
+        if supports_disable_referential_integrity? then
+          execute(storage_names(repository).collect do |name|
+            "ALTER TABLE #{quote_table_name(name)} ENABLE TRIGGER ALL"
+          end.join(";"))
+        end
+      end
+
+    end
+
+  end
+end
+
+
+module DatabaseCleaner::DataMapper
+  class Truncation < ::DatabaseCleaner::TruncationBase
+
+    def clean(repository = :default)
+      adapter = DataMapper.repository(repository).adapter
+      adapter.disable_referential_integrity do
+        tables_to_truncate.each do |table_name|
+          adapter.truncate_table table_name
+        end
+      end
+    end
+
+    private
+
+    def tables_to_truncate(repository = :default)
+      (@only || DataMapper.repository(repository).adapter.storage_names(repository)) - @tables_to_exclude
+    end
+
+    # overwritten
+    def migration_storage_name
+      'migration_info'
+    end
+
+  end
+end

data/lib/database_cleaner/truncation_base.rb

@@ -0,0 +1,40 @@
+class TruncationBase
+
+  def initialize(options = {})
+    if !options.empty? && !(options.keys - [:only, :except]).empty?
+      raise ArgumentError, "The only valid options are :only and :except. You specified #{options.keys.join(',')}."
+    end
+    if options.has_key?(:only) && options.has_key?(:except)
+      raise ArgumentError, "You may only specify either :only or :either.  Doing both doesn't really make sense does it?"
+    end
+
+    @only = options[:only]
+    @tables_to_exclude = (options[:except] || [])
+    if migration_storage = migration_storage_name
+      @tables_to_exclude << migration_storage
+    end
+  end
+
+  def start
+    # no-op
+  end
+
+  def clean
+    raise NotImplementedError
+  end
+
+
+  private
+
+  def tables_to_truncate
+    raise NotImplementedError
+  end
+
+  # overwrite in subclasses
+  # default implementation given because migration storage need not be present
+  def migration_storage_name
+    nil
+  end
+
+end
+

data/spec/database_cleaner/active_record/truncation_spec.rb

@@ -13,7 +13,7 @@ end
 
 module DatabaseCleaner
   module ActiveRecord
-    
+
     describe Truncation do
       before(:each) do
         @connection = mock('connection')
@@ -50,7 +50,7 @@ module DatabaseCleaner
       end
 
       it "should raise an error when :only and :except options are used" do
-        running { 
+        running {
           Truncation.new(:except => ['widgets'], :only => ['widgets'])
         }.should raise_error(ArgumentError)
       end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: bmabey-database_cleaner
 version: !ruby/object:Gem::Version 
-  version: 0.1.3
+  version: 0.2.0
 platform: ruby
 authors: 
 - Ben Mabey
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-04-30 00:00:00 -07:00
+date: 2009-05-08 00:00:00 -07:00
 default_executable: 
 dependencies: []
 
@@ -32,6 +32,7 @@ files:
 - examples/features/step_definitions/example_steps.rb
 - examples/features/support/env.rb
 - examples/lib/activerecord.rb
+- examples/lib/datamapper.rb
 - features/cleaning.feature
 - features/step_definitions/database_cleaner_steps.rb
 - features/support/env.rb
@@ -41,6 +42,8 @@ files:
 - lib/database_cleaner/configuration.rb
 - lib/database_cleaner/cucumber.rb
 - lib/database_cleaner/data_mapper/transaction.rb
+- lib/database_cleaner/data_mapper/truncation.rb
+- lib/database_cleaner/truncation_base.rb
 - spec/database_cleaner/active_record/truncation_spec.rb
 - spec/database_cleaner/configuration_spec.rb
 - spec/spec.opts
@@ -79,3 +82,4 @@ test_files:
 - examples/features/step_definitions/example_steps.rb
 - examples/features/support/env.rb
 - examples/lib/activerecord.rb
+- examples/lib/datamapper.rb