saimonmoore-database_cleaner 0.5.0

data/History.txt

@@ -0,0 +1,81 @@
+0.5.x (In Git)
+
+ === New features
+  * clean and clean_with methods are now aliased to clean! and clean_with!. (Ben Mabey)
+
+== 0.5.0 2010-02-22 - The CouchPotato Release
+
+ === New features
+  * Basic truncation support for CouchPotato / CouchDB. (Martin Rehfeld)
+  * SQLite3 on JRuby will fall back to delete if truncate doesn't work. (Darrin Holst)
+  * JDBC is used for ActiveRecord automaticaly when JRuby is detected. (Darrin Holst)
+
+ === Bufixes
+  * MongoMapper truncation strategy now works with :only and :except options. (Ben Mabey)
+
+== 0.4.3 2010-01-17
+
+ === New features
+  * Truncation for ActiveRecord oracle_enhanced adapter. (Edgars Beigarts)
+
+== 0.4.2 2010-01-12
+
+ === Bufixes
+  * Datamapper truncation now uses 'select' instead of deprecated the 'query' method. (Steve Tooke)
+
+== 0.4.1 2010-01-07
+
+ === Bufixes
+  * Postgres tables with FKs now truncate (added TRUNCADE CASCADE) using Datamapper. (Ben Mabey)
+
+== 0.4.0 2009-12-23 (The MongoMapper Edition)
+
+ === New features
+  * MongoMapper support for the truncation strategy. (Aubrey Holland)
+
+== 0.3.0 2009-12-20
+
+ === New features
+  * DataMapper 0.10.0 Compatible. (Martin Gamsjaeger)
+ === Bufixes
+  * Postgres tables with FKs now truncate (added TRUNCADE CASCADE). (Vika - yozhyk on github)
+
+== 0.2.3 2009-05-30
+
+ === New features
+  * Support for SQL Server truncation (Adam Meehan)
+
+== 0.2.2 2009-05-08
+ === Bufixes
+  * Added proper gemspec description and summary. (Ben Mabey, thanks to Martin Gamsjaeger)
+
+ === New features
+
+== 0.2.1 2009-05-08
+ === Bufixes
+  * Removed extraneous TruncationBase class definition. (Ben Mabey)
+
+== 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)
+ === Bufixes
+  * Added missing quotes around table names in truncation calls. (Michael MacDonald)
+
+== 0.1.2 2009-03-05
+ === New features
+  * JDBC Adapter to enable AR truncation strategy to work. (Kamal Fariz Mahyuddin)
+
+== 0.1.1 2009-03-04 - Initial Release (Ben Mabey)
+  * Basic infrastructure
+  * Features, RSpec code examples
+  * ActiveRecord strategies
+    * Truncation - with MySQL, and SQLite3 adapters.
+    * Transaction - wrap your modifications and roll them back.

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Ben Mabey
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.textile

@@ -0,0 +1,127 @@
+h1. Database Cleaner
+
+Database Cleaner is a set of strategies for cleaning your database in Ruby.
+The original use case was to ensure a clean state during tests.  Each strategy
+is a small amount of code but is code that is usually needed in any ruby app
+that is testing with a database.
+
+ActiveRecord, DataMapper, MongoMapper, CouchRest and CouchPotato are supported.
+
+h2. How to use
+
+<pre>
+  require 'database_cleaner'
+  DatabaseCleaner.strategy = :truncation
+
+  # then, whenever you need to clean the DB
+  DatabaseCleaner.clean
+</pre>
+
+With the :truncation strategy you can also pass in options, for example:
+<pre>
+  DatabaseCleaner.strategy = :truncation, {:only => %w[widgets dogs some_other_table]}
+</pre>
+
+<pre>
+  DatabaseCleaner.strategy = :truncation, {:except => %w[widgets]}
+</pre>
+
+(I should point out the truncation strategy will never truncate your schema_migrations table.)
+
+
+Some strategies require that you call DatabaseCleaner.start before calling clean
+(for example the :transaction one needs to know to open up a transaction). So
+you would have:
+
+<pre>
+  require 'database_cleaner'
+  DatabaseCleaner.strategy = :transaction
+
+  DatabaseCleaner.start # usually this is called in setup of a test
+  dirty_the_db
+  DatabaseCleaner.clean # cleanup of the test
+</pre>
+
+At times you may want to do a single clean with one strategy.  For example, you may want
+to start the process by truncating all the tables, but then use the faster transaction
+strategy the remaining time.  To accomplish this you can say:
+
+<pre>
+  require 'database_cleaner'
+  DatabaseCleaner.clean_with :truncation
+  DatabaseCleaner.strategy = :transaction
+  # then make the DatabaseCleaner.start and DatabaseCleaner.clean calls appropriately
+</pre>
+
+Example usage with RSpec:
+
+<pre>
+Spec::Runner.configure do |config|
+
+  config.before(:suite) do
+    DatabaseCleaner.strategy = :transaction
+    DatabaseCleaner.clean_with(:truncation)
+  end
+
+  config.before(:each) do
+    DatabaseCleaner.start
+  end
+
+  config.after(:each) do
+    DatabaseCleaner.clean
+  end
+
+end
+</pre>
+
+For use in Cucumber please see the section below.
+
+
+
+h2. Why?
+
+One of my motivations for writing this library was to have an easy way to
+turn on what Rails calls "transactional_fixtures" in my non-rails
+ActiveRecord projects.  For example, Cucumber ships with a Rails world that
+will wrap each scenario in a transaction.  This is great, but what if you are
+using ActiveRecord in a non-rails project?  You used to have to copy-and-paste
+the needed code, but with DatabaseCleaner you can now say:
+
+<pre>
+  #env.rb
+  require 'database_cleaner'
+  require 'database_cleaner/cucumber'
+  DatabaseCleaner.strategy = :transaction
+</pre>
+
+Now lets say you are running your features and it requires that another process be
+involved (i.e. Selenium running against your app's server.)  You can simply change
+your strategy type:
+
+<pre>
+  #env.rb
+  require 'database_cleaner'
+  require 'database_cleaner/cucumber'
+  DatabaseCleaner.strategy = :truncation
+</pre>
+
+You can have the best of both worlds and use the best one for the job:
+<pre>
+  #env.rb
+  require 'database_cleaner'
+  require 'database_cleaner/cucumber'
+  DatabaseCleaner.strategy = (ENV['SELENIUM'] == 'true') ? :truncation : :transaction
+</pre>
+
+h2. CouchRest
+Due to the fact that couchrest does not have the concept of a global attribute for
+storing the default database name when using with database_cleaner you must: 
+<pre>
+  require 'database_cleaner/couchrest/compatibility'
+  ::CouchRest.default_database_name = 'dbname_or_url'
+</pre>
+before actually calling DatabaseCleaner.clean
+
+he. COPYRIGHT
+
+Copyright (c) 2009 Ben Mabey. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,46 @@
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |s|
+    s.name = "database_cleaner"
+    s.summary = %Q{Strategies for cleaning databases.  Can be used to ensure a clean state for testing.}
+    s.email = "ben@benmabey.com"
+    s.homepage = "http://github.com/bmabey/database_cleaner"
+    s.description = "Strategies for cleaning databases.  Can be used to ensure a clean state for testing."
+    s.files = FileList["[A-Z]*.*", "{examples,lib,features,spec}/**/*", "Rakefile", "cucumber.yml"]
+    s.authors = ["Ben Mabey"]
+  end
+rescue LoadError
+  puts "Jeweler not available. Install it with: sudo gem install technicalpickles-jeweler -s http://gems.github.com"
+end
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = 'database_cleaner'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:spec) do |t|
+  t.libs << 'lib' << 'spec'
+  t.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+Spec::Rake::SpecTask.new(:rcov) do |t|
+  t.libs << 'lib' << 'spec'
+  t.spec_files = FileList['spec/**/*_spec.rb']
+  t.rcov = true
+end
+
+begin
+  require 'cucumber/rake/task'
+  Cucumber::Rake::Task.new(:features)
+rescue LoadError
+  puts "Cucumber is not available. In order to run features, you must: sudo gem install cucumber"
+end
+
+task :default => [:spec, :features]

data/VERSION.yml

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

data/cucumber.yml

@@ -0,0 +1 @@
+default: features

data/examples/features/example.feature

@@ -0,0 +1,11 @@
+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/step_definitions/example_steps.rb

@@ -0,0 +1,8 @@
+When /^I create a widget$/ do
+  Widget.create!
+end
+
+Then /^I should see 1 widget$/ do
+  Widget.count.should == 1
+end
+

data/examples/features/support/env.rb

@@ -0,0 +1,23 @@
+require 'rubygems'
+require 'spec/expectations'
+
+orm      = ENV['ORM']
+strategy = ENV['STRATEGY']
+
+if orm && strategy
+
+  $:.unshift(File.dirname(__FILE__) + '/../../../lib')
+  require 'database_cleaner'
+  require 'database_cleaner/cucumber'
+
+  begin
+    require "#{File.dirname(__FILE__)}/../../lib/#{orm}_models"
+  rescue LoadError => error
+    raise "You don't have the #{orm} ORM installed error: #{error.message} #{error.backtrace.join("\n")}"
+  end
+
+  DatabaseCleaner.strategy = strategy.to_sym
+  
+else
+  raise "Run 'ORM=activerecord|datamapper|mongomapper|couchpotato|couchrest STRATEGY=transaction|truncation cucumber examples/features'"
+end

data/examples/lib/activerecord_models.rb

@@ -0,0 +1,12 @@
+require 'active_record'
+
+ActiveRecord::Base.establish_connection(:adapter => "#{"jdbc" if defined?(JRUBY_VERSION)}sqlite3", :database => ":memory:")
+
+ActiveRecord::Schema.define(:version => 1) do
+  create_table :widgets do |t|
+    t.string :name
+  end
+end
+
+class Widget < ActiveRecord::Base
+end

data/examples/lib/couchpotato_models.rb

@@ -0,0 +1,21 @@
+require 'couch_potato'
+
+::CouchPotato::Config.database_name = 'couch_potato_test'
+
+class Widget
+  include CouchPotato::Persistence
+  
+  property :name
+  view :by_name, :key => :name
+  
+
+  # mimic the AR interface used in example_steps
+
+  def self.create!(attrs = {})
+    CouchPotato.database.save(self.new)
+  end
+  
+  def self.count
+    CouchPotato.database.view(::Widget.by_name).size
+  end
+end

data/examples/lib/couchrest_models.rb

@@ -0,0 +1,23 @@
+require 'couchrest'
+require 'database_cleaner/couchrest/compatibility' #opens CouchRest module to add default_database_name accessor
+
+DEFAULT_COUCHREST_DBNAME = 'couch_rest_test'
+::CouchRest.default_database_name= DEFAULT_COUCHREST_DBNAME
+
+class Widget < CouchRest::ExtendedDocument
+  use_database ::CouchRest.database!(DEFAULT_COUCHREST_DBNAME)
+
+  property :name
+  view_by :name
+
+  def self.create!(options = {})
+    instance = new(options)
+    instance.create!
+    instance
+  end
+  
+  # def self.count
+  #   CouchPotato.database.view(::Widget.by_name).size
+  # end
+
+end

data/examples/lib/datamapper_models.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/examples/lib/mongomapper_models.rb

@@ -0,0 +1,17 @@
+require 'mongomapper'
+
+::MongoMapper.connection = Mongo::Connection.new('127.0.0.1')
+::MongoMapper.database = 'database_cleaner_test'
+
+class Widget
+  include MongoMapper::Document
+  key :id, Integer
+  key :name, String
+
+  class << self
+    #mongomapper doesn't seem to provide this...
+    def create!(*args)
+      new(*args).save!
+    end
+  end
+end

data/features/cleaning.feature

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