safe-migrations 0.0.1

data/.gitignore

@@ -0,0 +1,19 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.swp
+*.swo

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in safe-migrations.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Bob Remeika
+
+MIT License
+
+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.md

@@ -0,0 +1,33 @@
+safe-migrations
+===============
+
+Assert rails migration safety at dev time.
+
+blah blah blah
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'safe-migrations'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install safe-migrations
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/banner.txt

@@ -0,0 +1,32 @@
+
+ __          __     _____ _______ _ 
+ \ \        / /\   |_   _|__   __| |
+  \ \  /\  / /  \    | |    | |  | |
+   \ \/  \/ / /\ \   | |    | |  | |
+    \  /\  / ____ \ _| |_   | |  |_|
+     \/  \/_/    \_\_____|  |_|  (_)
+                                    
+    YOUR MIGRATION DID NOT FINISH!
+
+You are running a migration that can be problematic
+unless you have taken the proper steps to ensure that
+it is successful.
+
+ActiveRecord caches attributes which can cause problems
+when removing columns, adding columns or changing column
+names.
+
+Read this article for more information:
+
+http://pedro.herokuapp.com/past/2011/7/13/rails_migrations_with_no_downtime/
+
+Once you are confident that your migration is safe, wrap
+your migration in a safety_assured block.  See below:
+
+  class MySafeMigration < ActiveRecord::Migration
+    def self.up
+      safety_assured { remove_column :foo_table, :foo_column }
+    end
+  end
+
+Have a nice day!

data/lib/safe_migrations.rb

@@ -0,0 +1,8 @@
+require "active_record"
+require "benchmark"
+
+require "safe_migrations/version"
+require "safe_migrations/errors"
+require "safe_migrations/migration_ext"
+
+ActiveRecord::Migration.extend(SafeMigrations::MigrationExt::ClassMethods)

data/lib/safe_migrations/errors.rb

@@ -0,0 +1,13 @@
+module SafeMigrations
+  class UnsafeMigration < StandardError
+    GENERIC_BANNER = File.read(File.join(File.dirname(__FILE__), "..", "..", "banner.txt"))
+
+    def initialize(message = "")
+      super(GENERIC_BANNER + "\n#{message}\n")
+    end
+  end
+
+  class UnsafeAddColumn    < UnsafeMigration; end
+  class UnsafeRemoveColumn < UnsafeMigration; end
+  class UnsafeDropTable    < UnsafeMigration; end
+end

data/lib/safe_migrations/migration_ext.rb

@@ -0,0 +1,38 @@
+module SafeMigrations
+  module MigrationExt
+    module ClassMethods
+      UNSAFE_METHODS = [:drop_table, :remove_column]
+
+      def self.extended(base)
+        class << base
+          alias_method_chain :method_missing, :safety
+        end
+      end
+
+      def safety_assured(&block)
+        @safety = true
+        yield
+      ensure
+        @safety = false
+      end
+
+      def safe?
+        !!@safety
+      end
+
+      def method_missing_with_safety(method, *args, &block)
+        if safe? || !UNSAFE_METHODS.include?(method)
+          return method_missing_without_safety(method, *args, &block)
+        end
+
+        case method
+        when :remove_column
+          raise UnsafeRemoveColumn
+        when :drop_table
+          raise UnsafeDropTable
+        end
+      end
+    end
+
+  end
+end

data/lib/safe_migrations/version.rb

@@ -0,0 +1,3 @@
+module SafeMigrations
+  VERSION = "0.0.1"
+end

data/safe-migrations.gemspec

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'safe_migrations/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "safe-migrations"
+  gem.version       = SafeMigrations::VERSION
+  gem.authors       = ["Bob Remeika"]
+  gem.email         = ["bob.remeika@gmail.com"]
+  gem.description   = %q{Assert rails migration safety at dev time}
+  gem.summary       = %q{Protect yourself from migrations that are unsafe to run without downtime}
+  gem.homepage      = "http://github.com/foobarfighter/safe-migrations"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  gem.add_development_dependency "rr"
+  gem.add_development_dependency "rspec"
+  gem.add_development_dependency "rake"
+  gem.add_runtime_dependency     "activerecord", "3.0.20"
+end

data/spec/migrations.rb

@@ -0,0 +1,23 @@
+class TestUnsafeDropTable < ActiveRecord::Migration
+  def self.up
+    drop_table :some_table
+  end
+end
+
+class TestUnsafeRemoveColumn < ActiveRecord::Migration
+  def self.up
+    remove_column :some_table, :some_column
+  end
+end
+
+class TestSafeDropTable < ActiveRecord::Migration
+  def self.up
+    safety_assured { drop_table :some_table }
+  end
+end
+
+class TestSafeRemoveColumn < ActiveRecord::Migration
+  def self.up
+    safety_assured { remove_column :some_table, :some_column }
+  end
+end

data/spec/safe_migrations_spec.rb

@@ -0,0 +1,39 @@
+require File.dirname(__FILE__) + "/spec_helper"
+require File.dirname(__FILE__) + "/migrations"
+
+describe "SafeMigrations::MigrationExtTest" do
+  describe "when there is no safety assurance" do
+    it "should not let you run remove_column" do
+      lambda {
+        TestUnsafeRemoveColumn.up
+      }.should raise_error(SafeMigrations::UnsafeRemoveColumn)
+    end
+
+    it "should not let you run drop table" do
+      lambda {
+        TestUnsafeDropTable.up
+      }.should raise_error(SafeMigrations::UnsafeDropTable)
+    end
+  end
+
+  describe "when there is safety assurance" do
+    it "should let you run remove_column" do
+      mock(TestSafeRemoveColumn).method_missing_without_safety(
+          :remove_column,
+          anything,
+          anything
+        )
+
+      TestSafeRemoveColumn.up
+    end
+
+    it "should let you run drop_table" do
+      mock(TestSafeDropTable).method_missing_without_safety(
+          :drop_table,
+          anything
+        )
+
+      TestSafeDropTable.up
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,7 @@
+require "safe_migrations"
+
+RSpec.configure do |config|
+  config.color_enabled = true
+  config.backtrace_clean_patterns = [ ]
+  config.mock_framework = :rr
+end

metadata

@@ -0,0 +1,138 @@
+--- !ruby/object:Gem::Specification 
+name: safe-migrations
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: 
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Bob Remeika
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2013-05-14 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  prerelease: false
+  type: :development
+  name: rr
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  prerelease: false
+  type: :development
+  name: rspec
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  prerelease: false
+  type: :development
+  name: rake
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        hash: 47
+        segments: 
+        - 3
+        - 0
+        - 20
+        version: 3.0.20
+  prerelease: false
+  type: :runtime
+  name: activerecord
+  version_requirements: *id004
+description: Assert rails migration safety at dev time
+email: 
+- bob.remeika@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- banner.txt
+- lib/safe_migrations.rb
+- lib/safe_migrations/errors.rb
+- lib/safe_migrations/migration_ext.rb
+- lib/safe_migrations/version.rb
+- safe-migrations.gemspec
+- spec/migrations.rb
+- spec/safe_migrations_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/foobarfighter/safe-migrations
+licenses: []
+
+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.8.24
+signing_key: 
+specification_version: 3
+summary: Protect yourself from migrations that are unsafe to run without downtime
+test_files: 
+- spec/migrations.rb
+- spec/safe_migrations_spec.rb
+- spec/spec_helper.rb