migration_tools 0.1.0

data/Gemfile

@@ -0,0 +1,12 @@
+source "http://rubygems.org"
+# Add dependencies required to use your gem here.
+# Example:
+gem "activerecord", ">= 2.3.5"
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem "bundler", "~> 1.0.0"
+  gem "jeweler", "~> 1.5.1"
+  gem "mocha", "~> 0.9.8"
+end

data/Gemfile.lock

@@ -0,0 +1,23 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    activerecord (2.3.8)
+      activesupport (= 2.3.8)
+    activesupport (2.3.8)
+    git (1.2.5)
+    jeweler (1.5.1)
+      bundler (~> 1.0.0)
+      git (>= 1.2.5)
+      rake
+    mocha (0.9.8)
+      rake
+    rake (0.8.7)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activerecord (>= 2.3.5)
+  bundler (~> 1.0.0)
+  jeweler (~> 1.5.1)
+  mocha (~> 0.9.8)

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2010 Morten Primdahl
+
+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.rdoc

@@ -0,0 +1,53 @@
+= migration_tools
+
+This gem adds a few delicious tasks to your migration tool box. 
+
+== Groups
+
+The migration tools allow you to specify a group in your migrations. This is used to allow you to run your migrations in groups, as opposed to all at once. This is useful if you want to run a certain group of migrations before a deploy, another group during deploy and a third group after deploy. 
+
+We use this technique to be able to QA new production code in an isolated environment that runs against the production database. It also reduces the number of moving parts come deploy time, which is helpful when you're doing zero downtime deploys.
+
+You specify which group a migration belongs to inside the migration, like so:
+
+  class CreateHello < ActiveRecord::Migration
+    group :before
+  
+    def self.up
+      ...
+    end
+  end
+
+The names of the possible groups are predefined to avoid turning this solution in to a generic hammer from hell. You can use the following groups: before, during, after, change. We define these as:
+
+*before* this is for migrations that are safe to run before a deploy of new code, e.g. adding columns/tables
+
+*during* this is for migrations that require the data structure and code to deploy "synchronously"
+
+*after* this is for migrations that should run after the new code has been pushed and is running
+
+*change* this is a special group that you run whenever you want to change DB data which you'd otherwise do in script/console
+
+
+== Commands
+
+  $ rake db:migrate:list - shows pending migrations by group
+  $ GROUP=before rake db:migrate:group - runs the migrations in the "before" group
+
+Note that rake db:migrate is entirely unaffected by this
+
+== Contributing to migration_tools
+ 
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
+* Fork the project
+* Start a feature/bugfix branch
+* Commit and push until you are happy with your contribution
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+== Copyright
+
+Copyright (c) 2010 Morten Primdahl. See LICENSE.txt for
+further details.
+

data/Rakefile

@@ -0,0 +1,46 @@
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "migration_tools"
+  gem.homepage = "http://github.com/morten/migration_tools"
+  gem.license = "MIT"
+  gem.summary = %Q{Helpful Rails 2.3 migration tools}
+  gem.description = %Q{Suite of task extensions for Rails 2.3 that makes managing migrations easier of more nimble}
+  gem.email = "morten@zendesk.com"
+  gem.authors = ["Morten Primdahl"]
+  # Include your dependencies below. Runtime dependencies are required when using your gem,
+  # and development dependencies are only needed for development (ie running rake tasks, tests, etc)
+  #  gem.add_runtime_dependency 'jabber4r', '> 0.1'
+  #  gem.add_development_dependency 'rspec', '> 1.2.3'
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "migration_tools #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

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

data/lib/migration_tools/migration_extension.rb

@@ -0,0 +1,15 @@
+module MigrationTools
+  module MigrationExtension
+    attr_accessor :migration_group
+    def group(arg = nil)
+      unless MigrationTools::MIGRATION_GROUPS.member?(arg.to_s)
+        raise "Invalid group \"#{arg.to_s}\" - valid groups are #{MigrationTools::MIGRATION_GROUPS.inspect}"
+      end
+
+      self.migration_group = arg.to_s
+    end
+  end
+end
+
+ActiveRecord::Migration.class_eval { extend MigrationTools::MigrationExtension }
+ActiveRecord::MigrationProxy.delegate :migration_group, :to => :migration

data/lib/migration_tools/tasks.rb

@@ -0,0 +1,72 @@
+require 'rake'
+require 'rake/tasklib'
+
+module MigrationTools
+  class Tasks < ::Rake::TaskLib
+    def initialize
+      define_migrate_list
+      define_migrate_group
+    end
+
+    def group
+      return @group if @group
+  
+      @group = ENV['GROUP'].to_s
+      raise "Invalid group \"#{@group}\"" if !@group.empty? && !MIGRATION_GROUPS.member?(@group)
+      @group
+    end
+
+    def pending_migrations
+      return @pending_migrations if @pending_migrations
+      @pending_migrations = ActiveRecord::Migrator.new(:up, 'db/migrate').pending_migrations
+      @pending_migrations = @pending_migrations.select { |proxy| group.empty? || proxy.migration_group == group }
+
+      @pending_migrations
+    end
+
+    def define_migrate_list
+      namespace :db do
+        namespace :migrate do
+          desc 'Lists pending migrations'
+          task :list => :environment do
+            if pending_migrations.empty?
+              notify "Your database schema is up to date", group
+            else
+              notify "You have #{pending_migrations.size} pending migrations", group
+              pending_migrations.each do |migration|
+                notify '  %4d %s %s' % [ migration.version, migration.migration_group.to_s[0..5].center(6), migration.name ]
+              end
+            end
+          end
+        end
+      end
+    end
+
+    def define_migrate_group
+      namespace :db do
+        namespace :migrate do
+          desc 'Runs pending migrations for a given group'
+          task :group do
+            if group.empty?
+              notify "Please specify a migration group"
+            elsif pending_migrations.empty?
+              notify "Your database schema is up to date"
+            else
+              pending_migrations.each do |migration|
+                migration.migrate
+              end
+            end
+          end
+        end
+      end
+    end
+
+    def notify(string, group = "")
+      if group.empty?
+        puts string
+      else
+        puts string + " for group \""+group+"\""
+      end
+    end
+  end
+end

data/lib/migration_tools.rb

@@ -0,0 +1,9 @@
+require 'active_record'
+require 'active_record/migration'
+
+require 'migration_tools/migration_extension'
+require 'migration_tools/tasks'
+
+module MigrationTools
+  MIGRATION_GROUPS = [ 'before', 'during', 'after', 'change' ]
+end

data/migration_tools.gemspec

@@ -0,0 +1,65 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{migration_tools}
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Morten Primdahl"]
+  s.date = %q{2010-12-06}
+  s.description = %q{Suite of task extensions for Rails 2.3 that makes managing migrations easier of more nimble}
+  s.email = %q{morten@zendesk.com}
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.rdoc"
+  ]
+  s.files = [
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE.txt",
+    "README.rdoc",
+    "Rakefile",
+    "VERSION",
+    "lib/migration_tools.rb",
+    "lib/migration_tools/migration_extension.rb",
+    "lib/migration_tools/tasks.rb",
+    "migration_tools.gemspec",
+    "test/helper.rb",
+    "test/test_migration_tools.rb"
+  ]
+  s.homepage = %q{http://github.com/morten/migration_tools}
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{Helpful Rails 2.3 migration tools}
+  s.test_files = [
+    "test/helper.rb",
+    "test/test_migration_tools.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<activerecord>, [">= 2.3.5"])
+      s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.5.1"])
+      s.add_development_dependency(%q<mocha>, ["~> 0.9.8"])
+    else
+      s.add_dependency(%q<activerecord>, [">= 2.3.5"])
+      s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_dependency(%q<jeweler>, ["~> 1.5.1"])
+      s.add_dependency(%q<mocha>, ["~> 0.9.8"])
+    end
+  else
+    s.add_dependency(%q<activerecord>, [">= 2.3.5"])
+    s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+    s.add_dependency(%q<jeweler>, ["~> 1.5.1"])
+    s.add_dependency(%q<mocha>, ["~> 0.9.8"])
+  end
+end
+

data/test/helper.rb

@@ -0,0 +1,20 @@
+require 'rubygems'
+require 'bundler'
+
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+
+require 'test/unit'
+require 'mocha'
+
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'migration_tools'
+
+class Test::Unit::TestCase
+end

data/test/test_migration_tools.rb

@@ -0,0 +1,134 @@
+require 'helper'
+
+class Alpha < ActiveRecord::Migration
+  group :before
+  def self.up
+  end
+end
+
+class Beta < ActiveRecord::Migration
+  group :before
+  def self.up
+    puts "Beaver"
+  end
+end
+
+class Delta < ActiveRecord::Migration
+  group :change
+  def self.up
+  end
+end
+
+class Kappa < ActiveRecord::Migration
+  def self.up
+  end
+end
+
+class TestMigrationTools < Test::Unit::TestCase
+
+  def setup
+    ENV['GROUP'] = nil
+    Rake::Task.clear
+    Rake::Task.define_task(:environment)
+    @task = MigrationTools::Tasks.new
+  end
+
+  def migrations
+    [ Alpha, Beta, Delta, Kappa ]
+  end
+
+  def proxies
+    @proxies ||= migrations.map { |m| stub(:migration => m, :version => migrations.index(m), :name => m.name, :migration_group => m.migration_group) }
+  end
+
+  def test_grouping
+    assert_equal [ Alpha, Beta ], migrations.select { |m| m.migration_group == 'before' }
+    assert_equal [ Delta ], migrations.select { |m| m.migration_group == 'change' }
+    assert_equal [ Kappa ], migrations.select { |m| m.migration_group.nil? }
+  end
+
+  def test_runtime_checking
+    begin
+      eval("class Kappa < ActiveRecord::Migration; group 'drunk'; end")
+      fail "You should not be able to specify custom groups"
+    rescue RuntimeError => e
+      assert e.message.index('Invalid group "drunk" - valid groups are ["before", "during", "after", "change"]')
+    end
+  end
+
+  def test_migration_proxy_delegation
+    proxy = ActiveRecord::MigrationProxy.new
+    proxy.expects(:migration).returns(Delta)
+    assert_equal "change", proxy.migration_group
+  end
+
+  def test_task_presence
+    assert Rake::Task["db:migrate:list"]
+    assert Rake::Task["db:migrate:group"]
+  end
+
+  def test_migrate_list_without_pending_without_group
+    ActiveRecord::Migrator.expects(:new).returns(stub(:pending_migrations => []))
+    MigrationTools::Tasks.any_instance.expects(:notify).with("Your database schema is up to date", "").once
+
+    Rake::Task["db:migrate:list"].invoke
+  end
+
+  def test_migrate_list_without_pending_with_group
+    ENV['GROUP'] = 'before'
+    ActiveRecord::Migrator.expects(:new).returns(stub(:pending_migrations => []))
+    MigrationTools::Tasks.any_instance.expects(:notify).with("Your database schema is up to date", "before").once
+
+    Rake::Task["db:migrate:list"].invoke
+  end
+
+  def test_migrate_list_with_pending_without_group
+    ActiveRecord::Migrator.expects(:new).returns(stub(:pending_migrations => proxies))
+    MigrationTools::Tasks.any_instance.expects(:notify).with("You have #{proxies.size} pending migrations", "").once
+    MigrationTools::Tasks.any_instance.expects(:notify).with("     0 before Alpha").once
+    MigrationTools::Tasks.any_instance.expects(:notify).with("     1 before Beta").once
+    MigrationTools::Tasks.any_instance.expects(:notify).with("     2 change Delta").once
+    MigrationTools::Tasks.any_instance.expects(:notify).with("     3        Kappa").once
+
+    Rake::Task["db:migrate:list"].invoke
+  end
+
+  def test_migrate_list_with_pending_with_group
+    ENV['GROUP'] = 'before'
+    ActiveRecord::Migrator.expects(:new).returns(stub(:pending_migrations => proxies))
+    MigrationTools::Tasks.any_instance.expects(:notify).with("You have 2 pending migrations", "before").once
+    MigrationTools::Tasks.any_instance.expects(:notify).with("     0 before Alpha").once
+    MigrationTools::Tasks.any_instance.expects(:notify).with("     1 before Beta").once
+
+    Rake::Task["db:migrate:list"].invoke
+  end
+
+  def test_migrate_group_with_group_without_pending
+    ENV['GROUP'] = 'before'
+    ActiveRecord::Migrator.expects(:new).returns(stub(:pending_migrations => []))
+    MigrationTools::Tasks.any_instance.expects(:notify).with("Your database schema is up to date").once
+
+    Rake::Task["db:migrate:group"].invoke
+  end
+
+  def test_migrate_group_with_pending
+    ENV['GROUP'] = 'before'
+    ActiveRecord::Migrator.expects(:new).returns(stub(:pending_migrations => proxies))
+    proxies.select { |p| p.migration_group == 'before' }.each do |p|
+      p.expects(:migrate).once
+    end
+
+    Rake::Task["db:migrate:group"].invoke
+  end
+  
+  def test_migrate_with_invalid_group
+    ENV['GROUP'] = 'drunk'
+    begin
+      Rake::Task["db:migrate:group"].invoke
+      fail "Should throw an error"
+    rescue RuntimeError => e
+      assert e.message =~ /Invalid group/
+    end
+  end
+
+end

metadata

@@ -0,0 +1,143 @@
+--- !ruby/object:Gem::Specification 
+name: migration_tools
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Morten Primdahl
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-12-06 00:00:00 -08:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  type: :runtime
+  name: activerecord
+  version_requirements: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 9
+        segments: 
+        - 2
+        - 3
+        - 5
+        version: 2.3.5
+  requirement: *id001
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  type: :development
+  name: bundler
+  version_requirements: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 23
+        segments: 
+        - 1
+        - 0
+        - 0
+        version: 1.0.0
+  requirement: *id002
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  type: :development
+  name: jeweler
+  version_requirements: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 1
+        segments: 
+        - 1
+        - 5
+        - 1
+        version: 1.5.1
+  requirement: *id003
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  type: :development
+  name: mocha
+  version_requirements: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 43
+        segments: 
+        - 0
+        - 9
+        - 8
+        version: 0.9.8
+  requirement: *id004
+description: Suite of task extensions for Rails 2.3 that makes managing migrations easier of more nimble
+email: morten@zendesk.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE.txt
+- README.rdoc
+files: 
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/migration_tools.rb
+- lib/migration_tools/migration_extension.rb
+- lib/migration_tools/tasks.rb
+- migration_tools.gemspec
+- test/helper.rb
+- test/test_migration_tools.rb
+has_rdoc: true
+homepage: http://github.com/morten/migration_tools
+licenses: 
+- MIT
+post_install_message: 
+rdoc_options: []
+
+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: Helpful Rails 2.3 migration tools
+test_files: 
+- test/helper.rb
+- test/test_migration_tools.rb