database_resetter 0.1.0

data/Gemfile

@@ -0,0 +1,11 @@
+source :rubygems
+
+gem "jeweler"
+gem "rake"
+gem "gemedit"
+
+group :test do
+  gem "cucumber"
+  gem "aruba"
+  gem "rspec"
+end

data/HISTORY.markdown

@@ -0,0 +1,5 @@
+# database\_resetter history
+
+## 0.1.0 (2010-07-04)
+
+Initial public release.  It's been in private beta for almost two years...

data/LICENCE.markdown

@@ -0,0 +1,31 @@
+# Licence
+
+This software is released under the Simplified BSD Licence.
+
+## database\_resetter licence
+
+Copyright 2010 PatchSpace Ltd. All rights reserved.
+
+Redistribution and use in source and binary forms, with or without modification, are
+permitted provided that the following conditions are met:
+
+   1. Redistributions of source code must retain the above copyright notice, this list of
+      conditions and the following disclaimer.
+
+   2. Redistributions in binary form must reproduce the above copyright notice, this list
+      of conditions and the following disclaimer in the documentation and/or other materials
+      provided with the distribution.
+
+THIS SOFTWARE IS PROVIDED BY PATCHSPACE LTD ``AS IS'' AND ANY EXPRESS OR IMPLIED
+WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
+FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL PATCHSPACE LTD OR
+CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
+ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
+NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
+ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
+The views and conclusions contained in the software and documentation are those of the
+authors and should not be interpreted as representing official policies, either expressed
+or implied, of PatchSpace Ltd.

data/README.markdown

@@ -0,0 +1,177 @@
+# database\_resetter
+
+## Introduction
+
+### What does it do?
+
+database\_resetter is a small gem to handle automatically resetting
+your test databases when developing a Ruby web app.
+
+### Why do I want it?
+
+Because you're sick of seeing "No column XXX in table YYY" or some such,
+because your test database is out of sync with your migrations.  If you're
+making a lot of database changes, this can save you a fair bit of time.
+
+I've used this code almost unmodified in all of my clients' projects over
+the last year or two.  Pretty much everyone that's seen it has said
+it looked pretty handy, so I've bundled it up as a gem.
+
+### How does it work?
+
+database\_resetter writes timestamp files into _log/database\_resetter_
+that track when the database was last reset.  It tracks them:
+
+* per environment (eg test, cucumber)
+* per hostname
+
+Per-hostname tracking is done in case you use Dropbox/JungleDisk etc to sync
+code between machines.  (Note: there are no features/specs to prove this works.)
+
+What _isn't_ tracked is what directory / SCM branch you're in.  So if you switch
+to a different working copy folder, or change eg Git branch, database\_resetter
+may not run the migrations.  If you'd like this feature please contact me.
+
+_The easiest way to make database\_resetter run is to touch a migration file._
+
+### How is database\_resetter different from database\_cleaner?
+
+Ben Mabey wrote [database\_cleaner](http://github.com/bmabey/database_cleaner) to
+help with emptying a database between individual test cases.  database\_resetter is
+designed to get the initial schema of a database in place before any test cases run.
+
+Basically, you want both :-)
+
+
+## Instructions
+
+If you're working on a Rails app, and your tests are good to go after a
+`rake db:reset`, then place the following code somewhere that
+will get executed once per test run:
+
+    DatabaseResetter.new.reset_if_required
+    
+Note: there are no features to prove this default call actually works :)  I've
+always specified the options explicitly myself.  But the defaults should work with
+Rails.  If not, let me know.
+
+For instructions on specifying the options, see below.
+
+### Changing the Rake task
+
+If (like me), you don't use _schema.rb_ to regenerate databases,
+you'll need your own Rake task.  I use one called `rake db:rebuild`,
+which is currently:
+
+    desc "Reset and re-migrate the database"
+    task :rebuild do
+      Rake::Task["db:drop"].invoke
+      Rake::Task["db:create"].invoke
+      Rake::Task["db:migrate"].invoke
+    end
+
+To override the default command, specify the `:command_pattern` option:
+
+    DatabaseResetter.new(
+      :command_pattern => "rake db:rebuild RAILS_ENV=%ENV%"
+    ).reset_if_required
+    
+See below for a description of `%ENV%`.
+    
+### Using a different framework
+
+If you use a different web framework, you may have to specify a different
+environment variable to switch the framework environment (eg `MERB_ENV`
+or `RACK_ENV`).  To override this, specify both `:command_pattern` and
+`:environment`, eg:
+
+    DatabaseResetter.new(
+      :environment => ENV["MERB_ENV"],
+      :command_pattern => "rake db:reset MERB_ENV=%ENV%"
+    ).reset_if_required
+
+You may also need to specify a different migration file directory to watch, eg:
+
+    DatabaseResetter.new(
+      :migration_directory => "schema/migrations"
+    ).reset_if_required
+
+(You can, of course, combine all three.)
+
+### RSpec 
+
+Put the call to `DatabaseResetter#reset_if_required` in _spec/spec\_helper.rb_.
+
+### Cucumber
+
+Put the call to `DatabaseResetter#reset_if_required` in
+_features/support/env.rb_.
+
+### Spork
+
+If you use Spork, you want to call `DatabaseResetter#reset_if_required` in the
+`each_run` block, eg:
+
+    Spork.each_run do
+      # ...
+      DatabaseResetter.new.reset_if_required
+      # ...
+    end
+
+### PostgreSQL
+
+If you use PostgreSQL, and your Rake task attempts to drop the database,
+Postgres will stop you if there is a connection in place.  You need to work
+around this somehow.  If you're using Spork, you need to divert Postgres's
+eyes, eg in Rails:
+
+    Spork.each_run do
+      # ...
+      
+      ActiveRecord::Base.establish_connection(config.merge('database' => 'postgres', 'schema_search_path' => 'public'))
+      DatabaseResetter.new.reset_if_required
+      ActiveRecord::Base.establish_connection(config)
+      
+      # ...
+    end
+    
+If you're not using Spork, you still need to make sure you call
+`DatabaseResetter#reset_if_required` before connecting to the database.
+One way of doing this with Bundler is to define a Bundler group just
+for database\_resetter in your Gemfile:
+
+    group :database_resetter do
+      gem "database_resetter"
+    end
+
+And then use this to load and run database\_resetter before anything connects 
+to the database.  eg with Rails and Cucumber, in _env.rb_:
+
+    # ...
+    
+    require 'bundler'
+    Bundler.setup(:database_resetter)
+    require 'database_resetter'
+    DatabaseResetter.new.reset_if_required
+
+    require File.expand_path(File.dirname(__FILE__) + '/../../config/environment')
+    
+    # ...
+
+
+## Bugs / Feedback
+
+There is currently no project page for database\_resetter.  If you want to report
+bugs in the code or documentation, or request features, please contact me:
+
+[ashley.moran@patchspace.co.uk](mailto:ashley.moran@patchspace.co.uk)
+
+[PatchSpace Ltd](http://www.patchspace.co.uk/)
+
+
+## Source code
+
+database\_resetter is maintained in a darcs repository, and is currently hosted
+on Patch-Tag:
+
+[Official darcs repository](https://patch-tag.com/r/ashleymoran/database_resetter/)

data/Rakefile

@@ -0,0 +1,27 @@
+require "bundler"
+Bundler.setup(:default)
+
+require "jeweler"
+
+Jeweler::Tasks.new do |gemspec|
+  gemspec.name = "database_resetter"
+  gemspec.summary = "Automatically resets your database when migrations change"
+  gemspec.email = "ashley.moran@patchspace.co.uk"
+  gemspec.homepage = "https://patch-tag.com/repo/ashleymoran/database_resetter/"
+  gemspec.authors = ["Ashley Moran"]
+  
+  gemspec.files.include %w[
+    config/**/*
+    lib/**/*
+    *.markdown
+    Gemfile
+    Rakefile
+    VERSION
+  ]
+  gemspec.test_files.include %w[
+    features/**/*
+    spec/**/*
+  ]
+end
+
+Jeweler::GemcutterTasks.new

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/config/cucumber.yml

@@ -0,0 +1,9 @@
+<%
+rerun = File.file?('rerun.txt') ? IO.read('rerun.txt') : ""
+rerun_opts = rerun.to_s.strip.empty? ? "--format #{ENV['CUCUMBER_FORMAT'] || 'progress'} features" : "--format #{ENV['CUCUMBER_FORMAT'] || 'pretty'} #{rerun}"
+requires = "--require features/support --require features/step_definitions"
+std_opts = "--format #{ENV['CUCUMBER_FORMAT'] || 'progress'} --strict --tags ~@wip #{requires}"
+%>
+default: <%= std_opts %> features
+wip: --tags @wip:3 --wip <%= requires %> features
+rerun: <%= rerun_opts %> --format rerun --out rerun.txt --strict --tags ~@wip

data/config/darcs.boring

@@ -0,0 +1,118 @@
+# Boring file regexps:
+
+### compiler and interpreter intermediate files
+# haskell (ghc) interfaces
+\.hi$
+\.hi-boot$
+\.o-boot$
+# object files
+\.o$
+\.o\.cmd$
+# profiling haskell
+\.p_hi$
+\.p_o$
+# haskell program coverage resp. profiling info
+\.tix$
+\.prof$
+# fortran module files
+\.mod$
+# linux kernel
+\.ko\.cmd$
+\.mod\.c$
+(^|/)\.tmp_versions($|/)
+# *.ko files aren't boring by default because they might
+# be Korean translations rather than kernel modules
+# \.ko$
+# python, emacs, java byte code
+\.py[co]$
+\.elc$
+\.class$
+# objects and libraries; lo and la are libtool things
+\.(obj|a|exe|so|lo|la)$
+# compiled zsh configuration files
+\.zwc$
+# Common LISP output files for CLISP and CMUCL
+\.(fas|fasl|sparcf|x86f)$
+
+### build and packaging systems
+# cabal intermediates
+\.installed-pkg-config
+\.setup-config
+# standard cabal build dir, might not be boring for everybody
+# ^dist(/|$)
+# autotools
+(^|/)autom4te\.cache($|/)
+(^|/)config\.(log|status)$
+# microsoft web expression, visual studio metadata directories
+\_vti_cnf$
+\_vti_pvt$
+# gentoo tools
+\.revdep-rebuild.*
+# generated dependencies
+^\.depend$
+
+### version control systems
+# cvs
+(^|/)CVS($|/)
+\.cvsignore$
+# cvs, emacs locks
+^\.#
+# rcs
+(^|/)RCS($|/)
+,v$
+# subversion
+(^|/)\.svn($|/)
+# mercurial
+(^|/)\.hg($|/)
+# git
+(^|/)\.git($|/)
+# bzr
+\.bzr$
+# sccs
+(^|/)SCCS($|/)
+# darcs
+(^|/)_darcs($|/)
+(^|/)\.darcsrepo($|/)
+^\.darcs-temp-mail$
+-darcs-backup[[:digit:]]+$
+# gnu arch
+(^|/)(\+|,)
+(^|/)vssver\.scc$
+\.swp$
+(^|/)MT($|/)
+(^|/)\{arch\}($|/)
+(^|/).arch-ids($|/)
+# bitkeeper
+(^|/)BitKeeper($|/)
+(^|/)ChangeSet($|/)
+
+### miscellaneous
+# backup files
+~$
+\.bak$
+\.BAK$
+# patch originals and rejects
+\.orig$
+\.rej$
+# X server
+\..serverauth.*
+# image spam
+\#
+(^|/)Thumbs\.db$
+# vi, emacs tags
+(^|/)(tags|TAGS)$
+#(^|/)\.[^/]
+# core dumps
+(^|/|\.)core$
+# partial broken files (KIO copy operations)
+\.part$
+# waf files, see http://code.google.com/p/waf/
+(^|/)\.waf-[[:digit:].]+-[[:digit:]]+($|/)
+(^|/)\.lock-wscript$
+# mac os finder
+(^|/)\.DS_Store$
+
+### database_resetter
+(^|/)tmp($|/)
+(^|/).bundle($|/)
+(^|/)pkg($|/)

data/features/descriptions/change_environment.feature

@@ -0,0 +1,17 @@
+Feature: Change environment
+  So that I don't obliterate my Cucumber database when running RSpec
+  As a wise developer who maintains separate testing environments
+  I want to specify the environment that gets reset
+  
+  Scenario: Using environment "test"
+    Given a Rails-type project
+    And a fake test case for the "test" environment
+    When I run a test case
+    Then the database should be reset for the "test" environment
+  
+  Scenario: Using environment "cucumber"
+    Given a Rails-type project
+    And a fake test case for the "cucumber" environment
+    When I run a test case
+    Then the database should be reset for the "cucumber" environment
+  

data/features/descriptions/database_resetter.feature

@@ -0,0 +1,24 @@
+Feature: Reset a database
+  In order to reduce time wasted manually running migrations
+  As a database-backed app developer
+  I want my databases rebuilt when I change the migrations
+
+  Scenario: Initial run
+    Given a Rails-type project
+    When I run a test case
+    Then the database should be reset
+  
+  Scenario: Clean re-run
+    Given a Rails-type project
+    When I run a test case
+    And I run a test case again
+    Then the database should not be reset
+  
+  Scenario: Dirty re-run
+    Given a Rails-type project
+    When I run a test case
+    And I touch a migration
+    And I run a test case again
+    Then the database should be reset
+  
+  

data/features/descriptions/different_web_frameworks.feature

@@ -0,0 +1,24 @@
+Feature: Different web frameworks
+  In order to enjoy the magic of an automatically-reset database on all my projects
+  As a promiscuous web framework fly-by-night
+  I want to reset databases in Rails, Merb, Sinatra and all that crazy shit
+
+  Scenario: Rails-type project
+    Given a Rails-type project
+
+    When I run a test case
+    Then the database should be reset
+
+    When I touch a migration
+    And I run a test case again
+    Then the database should be reset
+  
+  Scenario: Merb-type project
+    Given a Merb-type project
+
+    When I run a test case
+    Then the database should be reset for the current Merb environment
+
+    When I touch a migration
+    And I run a test case again
+    Then the database should be reset for the current Merb environment

data/features/descriptions/no_migrations.feature

@@ -0,0 +1,19 @@
+Feature: No migrations
+  So that I don't have to decipher an incomprehensible backtrace
+  As a bone idle and/or forgetful database-backed app developer
+  I want database_resetter to tell me when I forgot to make any migrations
+
+  # TODO Rails-specific issues need highlighting
+
+  Scenario: No migrations directory
+    Given an empty project called "empty-project"
+    When I run a test case
+    Then I should see "No migrations"
+  
+  Scenario: No migrations in migration directory
+    Given an empty project called "empty-project"
+    And an empty Rails migration directory
+    When I run a test case
+    Then I should see "No migrations"
+
+  

data/features/step_definitions/database_resetter_steps.rb

@@ -0,0 +1,125 @@
+module DatabaseResetterHelpers
+  def create_project
+    create_dir(@project_name)
+    cd(@project_name)
+    create_fake_test_case
+  end
+  
+  def create_fake_test_case(options = {})
+    options = {
+      :environment => "unimportant_env",
+      :migration_directory => "db/migrate",
+      :command_pattern => "rake db:reset RAILS_ENV=%ENV%"
+    }.merge(options)
+              
+    create_file(
+      "fake_test_case.rb", <<-RUBY
+        require "rubygems"
+        require "database_resetter"
+        DatabaseResetter.new(
+          :environment => "#{options[:environment]}",
+          :migration_directory => "#{options[:migration_directory]}",
+          :command_pattern => "#{options[:command_pattern]}"
+        ).reset_if_required
+      RUBY
+    )
+  end
+end
+World(DatabaseResetterHelpers)
+
+Given /^an empty project called "([^"]*)"$/ do |project_name|
+  @project_name = project_name
+  create_project
+end
+
+Given /^an empty Rails migration directory$/ do
+  create_dir("db/migrate")
+end
+
+Given /^a Rails-type project$/ do
+  @project_name = "rails-project"
+  create_project
+
+  @migration_dir = "db/migrate"
+  create_dir(@migration_dir)
+  create_file(
+    "#{@migration_dir}/001_first_migration.rb", <<-RUBY
+      # This is just a dummy migration file
+    RUBY
+  )    
+
+  create_file(
+    "Rakefile", <<-RUBY
+      namespace :db do
+        task :reset do
+          puts "Invoked: rake db:reset RAILS_ENV=\#{ENV['RAILS_ENV']}"
+        end
+      end
+    RUBY
+  )
+  
+  create_fake_test_case
+end
+
+Given /^a Merb-type project$/ do
+  @project_name = "merb-project"
+  create_project
+  
+  @migration_dir = "schema/migrations"
+  create_dir(@migration_dir)
+
+  create_file(
+    "#{@migration_dir}/001_first_migration.rb", <<-RUBY
+      # This is just a dummy migration file
+    RUBY
+  )
+  
+  create_file(
+    "Rakefile", <<-RUBY
+      namespace :db do
+        task :imaginary_merb_reset_task do
+          puts "Invoked: rake db:imaginary_merb_reset_task MERB_ENV=\#{ENV['MERB_ENV']}"
+        end
+      end
+    RUBY
+  )
+  
+  create_fake_test_case(
+    :migration_directory => @migration_dir,
+    :command_pattern => "rake db:imaginary_merb_reset_task MERB_ENV=%ENV%",
+    :environment => "my_merb_env"
+  )
+end
+
+Given /^a fake test case for the "([^"]*)" environment$/ do |environment|
+  create_fake_test_case(:environment => environment)
+end
+
+Then /^the database should be reset$/ do
+  Then %'I should see "Invoked: rake db:reset"'
+end
+
+Then /^the database should not be reset$/ do
+  Then %'I should see "Skipping database reset"'
+end
+
+Then /^the database should be reset for the "([^"]*)" environment$/ do |environment|
+  Then %'I should see "Invoked: rake db:reset RAILS_ENV=#{environment}"'
+end
+
+Then /^the database should be reset for the current Merb environment$/ do
+  Then %'I should see "Invoked: rake db:imaginary_merb_reset_task MERB_ENV=my_merb_env"'
+end
+
+When /^I run a test case(?: again)?$/ do
+  run("ruby fake_test_case.rb")
+end
+
+When /^I touch a migration$/ do
+  sleep 1
+  create_file(
+    "#{@migration_dir}/001_first_migration.rb", <<-RUBY
+      # Modified migration file
+    RUBY
+  )
+end

data/features/support/env.rb

@@ -0,0 +1,8 @@
+require "bundler"
+Bundler.require(:default, :test)
+
+puts
+puts "*** Installing database_resetter gem"
+system "rake install"
+puts "*** Gem installed"
+puts

data/lib/database_resetter.rb

@@ -0,0 +1,86 @@
+require 'time'
+
+class DatabaseResetter
+  def initialize(options)
+    # NOTE There are no features/specs to prove the defaults are present
+    @environment = options[:environment] || ENV["RAILS_ENV"]
+    @command_pattern = options[:command_pattern] || "rake db:reset RAILS_ENV=%ENV%"
+    @files_to_watch = "#{options[:migration_directory] || "db/migrate"}/**/*.rb"
+  end
+
+  def reset_if_required
+    if migration_dir.empty?
+      puts "*** No migrations"
+      return
+    end
+
+    if migrations_changed_since_last_database_reset?
+      reset
+    else
+      puts "*** Skipping database reset (migrations not changed since last run)"
+      puts "*** Run `#{reset_command}` if necessary, or touch a migration"
+    end
+  end
+
+  private
+
+  def database_reset_time_file
+    "#{database_reset_dir}/#{@environment}"
+  end
+
+  def database_reset_dir
+    "log/database_resetter/#{`hostname`}"
+  end
+
+  def ensure_database_reset_dir
+    system "mkdir -p '#{database_reset_dir}'"
+  end
+
+  def reset
+    puts "*** Resetting #{@environment} database"
+    run_reset_command_or_raise
+    log_database_reset_time
+    puts "*** #{@environment.capitalize} database reset"
+  end
+
+  def migrations_changed_since_last_database_reset?
+    most_recent_migration_file_change_timestamp > last_database_reset_timestamp
+  end
+
+  def most_recent_migration_file_change_timestamp
+    migration_dir.map { |filename|
+      File.mtime(filename)
+    }.max
+  end
+
+  def last_database_reset_timestamp
+    File.open(database_reset_time_file) do |file|
+      Time.parse(file.readline)
+    end
+  rescue Errno::ENOENT
+    Time.at(0)
+  end
+
+  def log_database_reset_time
+    ensure_database_reset_dir
+    File.open(database_reset_time_file, "w") do |file|
+      file.puts(Time.new)
+    end
+  end
+
+  def run_reset_command_or_raise
+    raise "Command failed: #{reset_command}" unless run_reset_command
+  end
+
+  def run_reset_command
+    system(reset_command)
+  end
+
+  def reset_command
+    @command_pattern.gsub("%ENV%", @environment)
+  end
+
+  def migration_dir
+    Dir[@files_to_watch]
+  end
+end

metadata

@@ -0,0 +1,86 @@
+--- !ruby/object:Gem::Specification 
+name: database_resetter
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Ashley Moran
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-07-04 00:00:00 +01:00
+default_executable: 
+dependencies: []
+
+description: 
+email: ashley.moran@patchspace.co.uk
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.markdown
+files: 
+- Gemfile
+- HISTORY.markdown
+- LICENCE.markdown
+- README.markdown
+- Rakefile
+- VERSION
+- config/cucumber.yml
+- config/darcs.boring
+- lib/database_resetter.rb
+- features/descriptions/change_environment.feature
+- features/descriptions/database_resetter.feature
+- features/descriptions/different_web_frameworks.feature
+- features/descriptions/no_migrations.feature
+- features/step_definitions/database_resetter_steps.rb
+- features/support/env.rb
+has_rdoc: true
+homepage: https://patch-tag.com/repo/ashleymoran/database_resetter/
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Automatically resets your database when migrations change
+test_files: 
+- features/descriptions/change_environment.feature
+- features/descriptions/database_resetter.feature
+- features/descriptions/different_web_frameworks.feature
+- features/descriptions/no_migrations.feature
+- features/step_definitions/database_resetter_steps.rb
+- features/support/env.rb