moargration 0.0.1

data/.gitignore

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

data/Gemfile

@@ -0,0 +1,7 @@
+source 'https://rubygems.org'
+
+gemspec
+
+group :test do
+  gem "activerecord", "2.3.14"
+end

data/README.md

@@ -0,0 +1,47 @@
+# Moargration
+
+Helping you migrate, MOAR.
+
+This is Ruby gem that takes environment variables to assist the execution of database migrations that would otherwise require two-step deploys.
+
+For more information refer to [Rails migrations with no downtime](http://pedro.herokuapp.com/past/2011/7/13/rails_migrations_with_no_downtime/).
+
+
+## Setup
+
+Add to a initializer in your app, eg `config/initializers/moargration.rb` for Rails apps:
+
+    Moargration.init
+
+Worry not, Moargration won't impact your boot time until you actually need it.
+
+
+## Usage
+
+So it's time to drop some columns.
+
+Knowing that this can bring your app down, and that you normally need to do two deploys to safely dro pcolumns, you can use Moargration to setup the first step for you.
+
+Just set an `ENV` var like:
+
+    MOARGRATION_IGNORE="users:notes,bio companies:another_stupid_column"
+
+And bounce your servers. Moargration will make sure that once the servers are running again your ORM will be ignoring these columns so that you can safely run the migration to drop them.
+
+After the migration finishes you can unset that variable and enjoy your new database schema.
+
+
+## The example above is not completely obvious, I need a [BNF grammar](http://en.wikipedia.org/wiki/Backus%E2%80%93Naur_Form)
+
+Sure thing, bro:
+
+    <ignore>     ::= <definition> { " " <definition> }
+    <definition> ::= <table> ":" <fields>
+    <fields>     ::= <field> { "," <field> }
+
+
+## Notes
+
+Created by Pedro Belo.
+Licensed as MIT.
+Use at your own risk.

data/Rakefile

@@ -0,0 +1,8 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new do |t|
+  t.pattern = 'test/**/*_test.rb'
+end
+
+task :default => :test

data/lib/moargration.rb

@@ -0,0 +1,35 @@
+module Moargration
+  class Exception < StandardError; end
+
+  extend self
+
+  def setup
+    return unless ignore = ENV["MOARGRATION_IGNORE"]
+    spec = parse(ignore)
+    hack_active_record(spec)
+  end
+
+  def columns_to_ignore
+    @@columns_to_ignore
+  end
+
+  def parse(text)
+    text.strip.split(" ").inject({}) do |parsed, definition|
+      table, fields = definition.split(":", 2)
+      parsed[table] = fields.split(",") if fields
+      parsed
+    end
+  end
+
+  def hack_active_record(spec)
+    @@columns_to_ignore = spec
+
+    ActiveRecord::Base.class_eval do
+      def self.columns
+        super.reject do |column|
+          (Moargration.columns_to_ignore[table_name] || []).include?(column.name)
+        end
+      end
+    end
+  end
+end

data/moargration.gemspec

@@ -0,0 +1,18 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |gem|
+  gem.name          = "moargration"
+  gem.version       = "0.0.1"
+  gem.authors       = ["Pedro Belo"]
+  gem.email         = ["pedro@heroku.com"]
+  gem.description   = %q{Helping you migrate, MOAR.}
+  gem.summary       = %q{To assist app developers with tricky database migrations}
+  gem.homepage      = "https://github.com/pedro/moargration"
+
+  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"]
+end

data/test/moargration_test.rb

@@ -0,0 +1,33 @@
+require "./test/test_helper"
+
+describe Moargration do
+  describe "parse_ignore_definition" do
+    it "reads a table with a simple field" do
+      Moargration.parse("table:field").must_equal("table" => %w( field ))
+    end
+
+    it "reads a table with multiple fields" do
+      Moargration.parse("table:f1,f2").must_equal("table" => %w( f1 f2 ))
+    end
+
+    it "reads multiple tables" do
+      Moargration.parse("t1:f1,f2 t2:f1").must_equal("t1" => %w( f1 f2 ), "t2" => %w( f1 ))
+    end
+
+    it "ignores tables without fields" do
+      Moargration.parse("t1:f1 t2 t3:f1").must_equal("t1" => %w( f1 ), "t3" => %w( f1 ))
+    end
+  end
+
+  describe "hack_active_record" do
+    it "hacks the model to ignore the specified columns" do
+      Moargration.hack_active_record("samples" => %w( f1 ))
+      Sample.columns.map(&:name).wont_include("f1")
+    end
+
+    it "doesn't affect other models" do
+      Moargration.hack_active_record("samples" => %w( f1 ))
+      User.columns.map(&:name).must_include("f1")
+    end
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,22 @@
+require "minitest/spec"
+require "minitest/autorun"
+require "active_record"
+require "./lib/moargration"
+require "uri"
+
+ActiveRecord::Base.establish_connection({
+  :adapter  => "postgresql",
+  :host     => "localhost",
+  :database => "moargration_test",
+  :min_messages => "warning"
+})
+ActiveRecord::Base.connection.execute "DROP TABLE IF EXISTS samples"
+ActiveRecord::Base.connection.execute "CREATE TABLE samples ( id integer UNIQUE, f1 text, f2 text, f3 text)"
+ActiveRecord::Base.connection.execute "DROP TABLE IF EXISTS users"
+ActiveRecord::Base.connection.execute "CREATE TABLE users ( id integer UNIQUE, f1 text, f2 text, f3 text)"
+
+class Sample < ActiveRecord::Base
+end
+
+class User < ActiveRecord::Base
+end

metadata

@@ -0,0 +1,55 @@
+--- !ruby/object:Gem::Specification
+name: moargration
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Pedro Belo
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-11-02 00:00:00.000000000 Z
+dependencies: []
+description: Helping you migrate, MOAR.
+email:
+- pedro@heroku.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- README.md
+- Rakefile
+- lib/moargration.rb
+- moargration.gemspec
+- test/moargration_test.rb
+- test/test_helper.rb
+homepage: https://github.com/pedro/moargration
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.22
+signing_key: 
+specification_version: 3
+summary: To assist app developers with tricky database migrations
+test_files:
+- test/moargration_test.rb
+- test/test_helper.rb