migration_test_helper 0.1.0

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2007 Micah Alles, Patrick Bacon, David Crosby
+
+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

@@ -0,0 +1,108 @@
+= MigrationTestHelper
+
+MigrationTestHelper provides methods which let you assert the current state of the schema and run your migrations against the _test_ database.
+
+== Install
+
+  ./script/plugin install svn://rubyforge.org/var/svn/migrationtest/tags/migration_test_helper
+
+OR
+
+  gem install migration_test_helper
+
+
+If you're using it outside of a Rails environment (for whatever reason) include the MigrationTestHelper module in your tests:
+
+  require 'test/unit'
+  require 'migration_test_helper'
+
+  class MyTest < Test::Unit::TestCase
+    include MigrationTestHelper
+    
+    def test_something
+      ...
+    end
+  end
+
+== Use
+
+*assert_schema*: verifies the schema of the database exactly matches the one specified.
+
+  def test_the_schema
+    assert_schema do |s|
+      s.table :books do |t|
+        t.column :id,     :integer
+        t.column :title,  :string
+        t.column :author, :string
+      end
+
+      s.table :reviews do |t|
+        t.column :id,      :integer
+        t.column :book_id, :integer
+        t.column :body,    :text
+        t.column :rating,  :integer
+      end
+    end
+  end
+
+This would verify there are only two tables defined in the test database: _books_ and _reviews_ (schema_info is ignored).  It will also verify that the _book_ table has the three columns, _id_, _title_ and _author_, each with their respective types.
+
+
+*drop_all_tables*: does just what it says to your _test_ database.
+
+*migrate*: executes the migrations against the test database using the same mechanism as rake db:migrate.
+
+  def test_the_migrations
+    migrate
+    migrate :version => 0
+    migrate :version => 10
+    migrate
+  end
+  
+
+This would do the same thing as running the following rake commands, but within a test case:
+
+  rake db:migrate
+  rake db:migrate VERSION=0
+  rake db:migrate VERSION=10
+  rake db:migrate
+  
+
+By combining the two helpers you can write a test that shows you can run all your migrations and get the final schema:
+
+  def test_should_be_able_to_migrate_from_an_empty_schema
+    drop_all_tables
+
+    # we shouldn't have any tables
+    assert_schema do |s|
+    end
+
+    migrate  
+
+    assert_schema do |s|
+      s.table :books do |t|
+        t.column :id,     :integer
+        t.column :title,  :string
+        t.column :author, :string
+      end
+
+      s.table :reviews do |t|
+        t.column :id,      :integer
+        t.column :book_id, :integer
+        t.column :body,    :text
+        t.column :rating,  :integer
+      end
+    end
+  end
+
+
+The *migrate* helper can also be useful for testing data tranformation migrations:
+
+  def test_should_get_rid_of_bad_data
+    drop_all_tables
+    migrate :version => 7
+    book = Book.create! :title => "bad title\nwith\todd    spacing"
+    migrate :version => 8 # should cleanse spacing in book titles
+    book.reload
+    assert_equal "bad title with odd spacing", book.title
+  end 

data/Rakefile

@@ -0,0 +1,58 @@
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+require 'hoe'
+
+desc 'Default: run unit tests.'
+task :default => :test
+
+desc 'Generate documentation for the migration_test_helper plugin.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'MigrationTestHelper'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README')
+  rdoc.rdoc_files.include('LICENSE')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+GEM_VERSION = '0.1.0'
+
+Hoe.new('migration_test_helper',GEM_VERSION) do |p|
+  p.author = "Micah Alles" 
+  p.email = "micah@atomicobject.com" 
+  p.url = "http://migrationtest.rubyforge.org" 
+  p.summary = "A Rails plugin for testing migrations" 
+  p.description = <<-EOS
+migration_test_helper makes testing your migrations easier by 
+adding helper methods to Test::Unit::TestCase for asserting the 
+current state of the schema and executing migrations against the 
+test database.
+  EOS
+
+  p.gem_files = FileList["{test,lib,tasks}/**/*"] + %w|LICENSE README Rakefile init.rb install.rb uninstall.rb|
+
+  p.changes = <<-EOS
+  EOS
+  p.rubyforge_name = 'migrationtest'
+end
+
+desc "Release from current trunk"
+task :plugin_release do
+	require 'fileutils'
+	include FileUtils::Verbose
+  cd File.expand_path(File.dirname(__FILE__)) do
+    sh 'svn up'
+    status = `svn status` 
+    raise "Please clean up before releasing.\n#{status}" unless status == ""
+
+    if `svn ls svn+ssh://alles@rubyforge.org/var/svn/migrationtest/tags/rel-#{GEM_VERSION} -m` =~ /migration_test_helper/
+      sh "svn del svn+ssh://alles@rubyforge.org/var/svn/migrationtest/tags/rel-#{GEM_VERSION} -m 'Preparing to update stable release tag'"
+    end
+    sh "svn cp . svn+ssh://alles@rubyforge.org/var/svn/migrationtest/tags/rel-#{GEM_VERSION} -m 'Releasing version #{GEM_VERSION}'"
+    if `svn ls svn+ssh://alles@rubyforge.org/var/svn/migrationtest/tags/migration_test_helper` =~ /migration_test_helper/
+      sh "svn del svn+ssh://alles@rubyforge.org/var/svn/migrationtest/tags/migration_test_helper -m 'Preparing to update stable release tag'"
+    end
+    sh "svn cp . svn+ssh://alles@rubyforge.org/var/svn/migrationtest/tags/migration_test_helper -m 'Updating stable tag to version #{GEM_VERSION}'"
+  end
+end

data/init.rb

@@ -0,0 +1,7 @@
+if RAILS_ENV == 'test'
+  require 'migration_test_helper'
+  require 'test/unit'
+  Test::Unit::TestCase.class_eval do
+    include MigrationTestHelper
+  end
+end

data/install.rb

@@ -0,0 +1 @@
+# Install hook code here

data/lib/migration_test_helper.rb

@@ -0,0 +1,127 @@
+#--
+# Copyright (c) 2007 Micah Alles, Patrick Bacon, David Crosby
+# 
+# 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.
+#++
+
+require 'test/unit/assertions'
+
+module MigrationTestHelper 
+  def self.migration_dir
+    @migration_dir || File.expand_path(RAILS_ROOT + '/db/migrate')
+  end
+
+  #
+  # sets the directory in which the migrations reside to be run with migrate
+  #
+  def self.migration_dir=(new_dir)
+    @migration_dir = new_dir
+  end
+
+  #
+  # verifies the schema exactly matches the one specified (schema_info does not have to be specified)
+  # 
+  #   assert_schema do |s|
+  #     s.table :dogs do |t|
+  #       t.column :id,   :integer
+  #       t.column :name, :string
+  #     end
+  #   end
+  #
+  def assert_schema
+    schema = Schema.new
+    yield schema
+    schema.verify
+  end
+
+  #
+  # drops all tables in the database
+  # 
+  def drop_all_tables
+    ActiveRecord::Base.connection.tables.each do |table|
+      ActiveRecord::Base.connection.drop_table(table)
+    end
+  end
+
+  #
+  # executes your migrations
+  #
+  #   migrate                # same as rake db:migrate
+  #
+  #   migrate :version => 10 # same as rake db:migrate VERSION=10
+  # 
+  def migrate(opts={})
+    version = opts[:version] ? opts[:version].to_i : nil
+    ActiveRecord::Migrator.migrate(MigrationTestHelper.migration_dir, version)
+  end
+
+  module Connection #:nodoc:
+    def conn
+      ActiveRecord::Base.connection
+    end
+  end
+
+  class Schema
+    include Connection
+    include Test::Unit::Assertions
+
+    def initialize #:nodoc:
+      @tables = []
+    end
+
+    def table(name)
+      table = Table.new(name)
+      yield table
+      table.verify
+      @tables << table
+    end
+
+    def verify #:nodoc:
+      actual_tables = conn.tables.reject {|t| t == 'schema_info' }
+      expected_tables = @tables.map {|t| t.name }
+      assert_equal expected_tables.sort, actual_tables.sort, 'wrong tables in schema'
+    end
+  end
+
+  class Table
+    include Connection
+    include Test::Unit::Assertions
+    attr_reader :name
+
+    def initialize(name) #:nodoc:
+      @name = name.to_s
+      @columns = []
+      assert conn.tables.include?(@name), "table <#{@name}> not found in schema"
+    end
+
+    def column(colname,type)
+      colname = colname.to_s
+      @columns << colname
+      col = conn.columns(name).find {|c| c.name == colname }
+      assert_not_nil col, "column <#{colname}> not found in table <#{self.name}>"
+      assert_equal type, col.type, "wrong type for column <#{colname}> in table <#{name}>"
+    end
+
+    def verify #:nodoc:
+      actual_columns = conn.columns(name).map {|c| c.name }
+      assert_equal @columns.sort, actual_columns.sort, "wrong columns for table: <#{name}>"
+    end
+  end
+end

data/tasks/migration_test_helper_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :migration_test_helper do
+#   # Task goes here
+# end

data/test/config/database.yml

@@ -0,0 +1,3 @@
+test:
+  adapter: sqlite3
+  database: vendor/plugins/migration_test_helper/test/db/test.sqlite3.db

data/test/db/migrate_good/001_create_top_dogs.rb

@@ -0,0 +1,11 @@
+class CreateTopDogs < ActiveRecord::Migration
+  def self.up
+    create_table :top_dogs do |t|
+      t.column :name, :string
+    end
+  end
+
+  def self.down
+    drop_table :top_dogs
+  end
+end

data/test/db/migrate_good/002_create_bottom_dogs.rb

@@ -0,0 +1,12 @@
+class CreateBottomDogs < ActiveRecord::Migration
+  def self.up
+    create_table :bottom_dogs do |t|
+      t.column :name, :string
+      t.column :sick, :boolean
+    end
+  end
+
+  def self.down
+    drop_table :bottom_dogs
+  end
+end

data/test/db/migrate_good/003_create_cats.rb

@@ -0,0 +1,11 @@
+class CreateCats < ActiveRecord::Migration
+  def self.up
+    create_table :cats do |t|
+      t.column :lives, :integer
+    end
+  end
+
+  def self.down
+    drop_table :cats
+  end
+end

data/test/db/schema.rb

@@ -0,0 +1,5 @@
+ActiveRecord::Schema.define(:version => 1) do
+  create_table "dogs", :force => true do |t|
+    t.column "tail", :string
+  end
+end

data/test/helper.rb

@@ -0,0 +1,29 @@
+ENV["RAILS_ENV"] = "test"
+require File.expand_path(File.dirname(__FILE__) + '/../../../../config/environment')
+require 'logger'
+require 'test_help'
+
+plugin_path = RAILS_ROOT + "/vendor/plugins/migration_test_helper"
+
+config_location = File.expand_path(plugin_path + "/test/config/database.yml")
+
+config = YAML::load(ERB.new(IO.read(config_location)).result)
+ActiveRecord::Base.logger = Logger.new(plugin_path + "/test/log/test.log")
+ActiveRecord::Base.establish_connection(config['test'])
+
+Test::Unit::TestCase.fixture_path = plugin_path + "/test/fixtures/"
+
+$LOAD_PATH.unshift(Test::Unit::TestCase.fixture_path)
+
+class Test::Unit::TestCase
+  def plugin_path(path)
+    File.expand_path(File.dirname(__FILE__) + '/../' + path)  
+  end
+
+  def load_default_schema
+    ActiveRecord::Migration.suppress_messages do
+      schema_file = plugin_path("/test/db/schema.rb")
+      load(schema_file) if File.exist?(schema_file)
+    end
+  end
+end

data/test/migration_test_helper_test.rb

@@ -0,0 +1,164 @@
+require File.expand_path(File.dirname(__FILE__) + '/helper') 
+
+class MigrationTestHelperTest < Test::Unit::TestCase
+
+  def setup
+    load_default_schema
+    MigrationTestHelper.migration_dir = plugin_path('test/db/migrate_good')
+  end
+
+  #
+  # HELPERS
+  #
+  def see_failure(pattern='')
+    err = assert_raise(Test::Unit::AssertionFailedError) do
+      yield
+    end
+    assert_match(/#{pattern}/mi, err.message) 
+  end
+
+  def see_no_failure
+    assert_nothing_raised do
+      yield
+    end
+  end
+  
+  #
+  # TESTS
+  #
+  def test_assert_schema_should_not_fail_if_schema_is_matched
+    see_no_failure do
+      assert_schema do |s|
+        s.table :dogs do |t|
+          t.column :id,   :integer
+          t.column :tail, :string
+        end
+      end
+    end
+  end
+
+  def test_should_fail_if_a_table_is_not_specified
+    see_failure 'wrong tables in schema.*dogs' do
+      assert_schema do |s|
+      end
+    end
+  end
+
+  def test_should_fail_if_a_table_is_not_found
+    see_failure 'table <things> not found in schema' do
+      assert_schema do |s|
+        s.table :things do |t|
+          t.column :id, :integer
+        end
+      end
+    end
+  end
+
+  def test_should_fail_if_a_column_is_not_specified
+    see_failure 'wrong columns for table.*dogs.*tail' do
+      assert_schema do |s|
+        s.table :dogs do |t|
+          t.column :id,   :integer
+        end
+      end
+    end
+  end
+
+  def test_should_fail_if_a_column_is_not_found
+    see_failure 'column <legs> not found in table <dogs>' do
+      assert_schema do |s|
+        s.table :dogs do |t|
+          t.column :id,   :integer
+          t.column :tail, :string
+          t.column :legs, :integer
+        end
+      end
+    end
+  end
+
+  def test_should_drop_all_tables
+    assert_equal ['dogs','schema_info'].sort, ActiveRecord::Base.connection.tables.sort
+    drop_all_tables
+    assert_equal [], ActiveRecord::Base.connection.tables
+    drop_all_tables
+    assert_equal [], ActiveRecord::Base.connection.tables
+  end
+
+  def test_should_migrate_to_highest_version
+    drop_all_tables
+    assert_schema do |s|
+    end
+
+    migrate :version => 1
+
+    assert_schema do |s|
+      s.table :top_dogs do |t|
+        t.column :id,      :integer
+        t.column :name,    :string
+      end
+    end
+
+    migrate :version => 2
+
+    assert_schema do |s|
+      s.table :top_dogs do |t|
+        t.column :id,      :integer
+        t.column :name,    :string
+      end
+      s.table :bottom_dogs do |t|
+        t.column :id,      :integer
+        t.column :name,    :string
+        t.column :sick,    :boolean
+      end
+    end
+
+    migrate :version => 3
+
+    assert_schema do |s|
+      s.table :top_dogs do |t|
+        t.column :id,      :integer
+        t.column :name,    :string
+      end
+      s.table :bottom_dogs do |t|
+        t.column :id,      :integer
+        t.column :name,    :string
+        t.column :sick,    :boolean
+      end
+      s.table :cats do |t|
+        t.column :id,      :integer
+        t.column :lives,   :integer
+      end
+    end
+
+    migrate :version => 0
+
+    assert_schema do |s|
+    end
+
+    migrate
+
+    assert_schema do |s|
+      s.table :top_dogs do |t|
+        t.column :id,      :integer
+        t.column :name,    :string
+      end
+      s.table :bottom_dogs do |t|
+        t.column :id,      :integer
+        t.column :name,    :string
+        t.column :sick,    :boolean
+      end
+      s.table :cats do |t|
+        t.column :id,      :integer
+        t.column :lives,   :integer
+      end
+    end
+  end
+
+  def test_should_have_default_migration_dir_set
+    MigrationTestHelper.migration_dir = nil
+    assert_equal File.expand_path(RAILS_ROOT + '/db/migrate'), MigrationTestHelper.migration_dir, 
+      "wrong default migration dir"
+    
+  end
+end
+

data/uninstall.rb

@@ -0,0 +1 @@
+# Uninstall hook code here

metadata

@@ -0,0 +1,71 @@
+--- !ruby/object:Gem::Specification 
+rubygems_version: 0.8.11
+specification_version: 1
+name: migration_test_helper
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+date: 2007-01-30 00:00:00 -05:00
+summary: A Rails plugin for testing migrations
+require_paths: 
+- lib
+email: micah@atomicobject.com
+homepage: http://migrationtest.rubyforge.org
+rubyforge_project: migrationtest
+description: migration_test_helper makes testing your migrations easier by  adding helper methods to Test::Unit::TestCase for asserting the  current state of the schema and executing migrations against the  test database.
+autorequire: 
+default_executable: 
+bindir: bin
+has_rdoc: true
+required_ruby_version: !ruby/object:Gem::Version::Requirement 
+  requirements: 
+  - - ">"
+    - !ruby/object:Gem::Version 
+      version: 0.0.0
+  version: 
+platform: ruby
+signing_key: 
+cert_chain: 
+authors: 
+- Micah Alles
+files: 
+- test/config
+- test/db
+- test/helper.rb
+- test/log
+- test/migration_test_helper_test.rb
+- test/config/database.yml
+- test/db/migrate_good
+- test/db/schema.rb
+- test/db/migrate_good/001_create_top_dogs.rb
+- test/db/migrate_good/002_create_bottom_dogs.rb
+- test/db/migrate_good/003_create_cats.rb
+- lib/migration_test_helper.rb
+- tasks/migration_test_helper_tasks.rake
+- LICENSE
+- README
+- Rakefile
+- init.rb
+- install.rb
+- uninstall.rb
+test_files: []
+
+rdoc_options: []
+
+extra_rdoc_files: []
+
+executables: []
+
+extensions: []
+
+requirements: []
+
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: hoe
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Version::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.1.7
+    version: