also_migrate 0.1.0

data/MIT-LICENSE

@@ -0,0 +1,18 @@
+Copyright (c) 2009 Winton Welsh
+
+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.markdown

@@ -0,0 +1,32 @@
+AlsoMigrate
+===========
+
+Migrate multiple tables with similar schema.
+
+Requirements
+------------
+
+<pre>
+sudo gem install also_migrate
+</pre>
+
+Define the model
+----------------
+
+<pre>
+class Article < ActiveRecord::Base
+  also_migrate :article_archives, :ignore => 'moved_at', :indexes => 'id'
+end
+</pre>
+
+Options:
+
+* <code>:ignore</code> Ignore migrations that apply to certain columns (defaults to none)
+* <code>:indexes</code> Only index certain columns (defaults to all)
+
+That's it!
+----------
+
+Next time you migrate, <code>article_archives</code> is created if it doesn't exist.
+
+Any new migration applied to <code>articles</code> is automatically applied to <code>article_archives</code>.

data/Rakefile

@@ -0,0 +1,2 @@
+require "#{File.dirname(__FILE__)}/require"
+Require.rakefile!

data/init.rb

@@ -0,0 +1 @@
+require File.dirname(__FILE__) + "/rails/init"

data/lib/also_migrate.rb

@@ -0,0 +1,6 @@
+require File.expand_path("#{File.dirname(__FILE__)}/../require")
+Require.lib!
+
+ActiveRecord::Base.send(:include, AlsoMigrate::Base)
+ActiveRecord::Migrator.send(:include, AlsoMigrate::Migrator)
+ActiveRecord::Migration.send(:include, AlsoMigrate::Migration)

data/lib/also_migrate/base.rb

@@ -0,0 +1,30 @@
+module AlsoMigrate
+  module Base
+    
+    def self.included(base)
+      unless base.respond_to?(:also_migrate)
+        base.extend ClassMethods
+      end
+    end
+    
+    module ClassMethods
+      
+      def also_migrate(*args)
+        options = args.extract_options!
+        @also_migrate_config ||= []
+        @also_migrate_config << {
+          :tables => args.collect(&:to_s),
+          :options => {
+            :ignore => [ options[:ignore] ].flatten.compact,
+            :indexes => options[:indexes] ? [ options[:indexes] ].flatten : nil
+          }
+        }
+        self.class_eval do
+          class <<self
+            attr_accessor :also_migrate_config
+          end
+        end
+      end
+    end
+  end
+end

data/lib/also_migrate/migration.rb

@@ -0,0 +1,65 @@
+module AlsoMigrate
+  module Migration
+    
+    def self.included(base)
+      unless base.respond_to?(:method_missing_with_also_migrate)
+        base.extend ClassMethods
+        base.class_eval do
+          class <<self
+            alias_method :method_missing_without_also_migrate, :method_missing
+            alias_method :method_missing, :method_missing_with_also_migrate
+          end
+        end
+      end
+    end
+
+    module ClassMethods
+
+      def method_missing_with_also_migrate(method, *arguments, &block)
+        args = Marshal.load(Marshal.dump(arguments))
+        method_missing_without_also_migrate(method, *arguments, &block)
+
+        supported = [
+          :add_column, :add_index, :add_timestamps, :change_column,
+          :change_column_default, :change_table, :create_table,
+          :drop_table, :remove_column, :remove_columns,
+          :remove_timestamps, :rename_column, :rename_table
+        ]
+
+        if !args.empty? && supported.include?(method)
+          connection = ActiveRecord::Base.connection
+          table_name = ActiveRecord::Migrator.proper_table_name(args[0])
+          
+          # Find models
+          Object.subclasses_of(ActiveRecord::Base).each do |klass|
+            if klass.respond_to?(:also_migrate_config)
+              next unless klass.table_name == table_name
+              klass.also_migrate_config.each do |config|
+                options = config[:options]
+                tables = config[:tables]
+                
+                # Don't change ignored columns
+                options[:ignore].each do |column|
+                  next if args.include?(column) || args.include?(column.intern)
+                end
+
+                # Run migration
+                config[:tables].each do |table|
+                  if method == :create_table
+                    ActiveRecord::Migrator::AlsoMigrate.create_tables(klass)
+                  elsif method == :add_index && !options[:indexes].nil?
+                    next
+                  elsif connection.table_exists?(table)
+                    args[0] = table
+                    args[1] = table if method == :rename_table
+                    connection.send(method, *args, &block)
+                  end
+                end
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/also_migrate/migrator.rb

@@ -0,0 +1,108 @@
+module AlsoMigrate
+  module Migrator
+    
+    def self.included(base)
+      unless base.respond_to?(:migrate_with_also_migrate)
+        base.send :include, InstanceMethods
+        base.class_eval do
+          alias_method :migrate_without_also_migrate, :migrate
+          alias_method :migrate, :migrate_with_also_migrate
+        end
+      end
+    end
+    
+    module InstanceMethods
+      
+      def migrate_with_also_migrate
+        Object.subclasses_of(ActiveRecord::Base).each do |klass|
+          if klass.respond_to?(:also_migrate_config)
+            AlsoMigrate.create_tables(klass)
+          end
+        end
+      ensure
+        migrate_without_also_migrate
+      end
+      
+      module AlsoMigrate
+        class <<self
+        
+          def connection
+            ActiveRecord::Base.connection
+          end
+        
+          def create_tables(klass)
+            config = klass.also_migrate_config
+            old_table = klass.table_name
+            config.each do |config|
+              options = config[:options]
+              config[:tables].each do |new_table|
+                if !connection.table_exists?(new_table) && connection.table_exists?(old_table)
+                  columns = connection.columns(old_table).collect(&:name)
+                  columns -= options[:ignore].collect(&:to_s)
+                  columns.collect! { |col| connection.quote_column_name(col) }
+                  engine =
+                    if connection.class.to_s.include?('Mysql')
+                      'ENGINE=' + connection.select_one(<<-SQL)['Engine']
+                        SHOW TABLE STATUS
+                        WHERE Name = '#{old_table}'
+                      SQL
+                    end
+                  connection.execute(<<-SQL)
+                    CREATE TABLE #{new_table} #{engine}
+                    AS SELECT #{columns.join(',')}
+                    FROM #{old_table}
+                    WHERE false;
+                  SQL
+                  indexes = options[:indexes]
+                  indexes ||= indexed_columns(old_table)
+                  indexes.each do |column|
+                    connection.add_index(new_table, column)
+                  end
+                end
+              end
+            end
+          end
+
+          def indexed_columns(table_name)
+            # MySQL
+            if connection.class.to_s.include?('Mysql')
+              index_query = "SHOW INDEX FROM #{table_name}"
+              connection.select_all(index_query).collect do |r|
+                r["Column_name"]
+              end
+            # PostgreSQL
+            # http://stackoverflow.com/questions/2204058/show-which-columns-an-index-is-on-in-postgresql/2213199
+            elsif connection.class.to_s.include?('PostgreSQL')
+              index_query = <<-SQL
+                select
+                  t.relname as table_name,
+                  i.relname as index_name,
+                  a.attname as column_name
+                from
+                  pg_class t,
+                  pg_class i,
+                  pg_index ix,
+                  pg_attribute a
+                where
+                  t.oid = ix.indrelid
+                  and i.oid = ix.indexrelid
+                  and a.attrelid = t.oid
+                  and a.attnum = ANY(ix.indkey)
+                  and t.relkind = 'r'
+                  and t.relname = '#{table_name}'
+                order by
+                  t.relname,
+                  i.relname
+              SQL
+              connection.select_all(index_query).collect do |r|
+                r["column_name"]
+              end
+            else
+              raise 'AlsoMigrate does not support this database adapter'
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/log/development.log

@@ -0,0 +1,6 @@
+  SQL (0.2ms)   SET SQL_AUTO_IS_NULL=0
+  User Load (59.6ms)   SELECT * FROM `users` ORDER BY users.id DESC LIMIT 1
+  User Columns (21.6ms)   SHOW FIELDS FROM `users`
+  SQL (0.3ms)   SET SQL_AUTO_IS_NULL=0
+  SQL (0.3ms)   SHOW TABLES
+  User Columns (13.0ms)   SHOW FIELDS FROM `users`

data/rails/init.rb

@@ -0,0 +1,2 @@
+require File.expand_path("#{File.dirname(__FILE__)}/../require")
+Require.rails_init!

data/require.rb

@@ -0,0 +1,52 @@
+require 'rubygems'
+gem 'require'
+require 'require'
+
+Require do
+  gem(:active_wrapper, '=0.2.3') { require 'active_wrapper' }
+  gem :require, '=0.2.6'
+  gem(:rake, '=0.8.7') { require 'rake' }
+  gem :rspec, '=1.3.0'
+  
+  gemspec do
+    author 'Winton Welsh'
+    dependencies do
+      gem :require
+    end
+    email 'mail@wintoni.us'
+    name 'also_migrate'
+    homepage "http://github.com/winton/#{name}"
+    summary "Migrate multiple tables with similar schema"
+    version '0.1.0'
+  end
+  
+  bin { require 'lib/also_migrate' }
+  
+  lib do
+    require 'lib/also_migrate/base'
+    require 'lib/also_migrate/migration'
+    require 'lib/also_migrate/migrator'
+  end
+  
+  rails_init { require 'lib/also_migrate' }
+  
+  rakefile do
+    gem(:active_wrapper)
+    gem(:rake) { require 'rake/gempackagetask' }
+    gem(:rspec) { require 'spec/rake/spectask' }
+    require 'require/tasks'
+  end
+  
+  spec_helper do
+    gem(:active_wrapper)
+    require 'require/spec_helper'
+    require 'rails/init'
+    require 'pp'
+    require 'spec/fixtures/article'
+  end
+  
+  spec_rakefile do
+    gem(:rake)
+    gem(:active_wrapper) { require 'active_wrapper/tasks' }
+  end
+end

data/spec/Rakefile

@@ -0,0 +1,10 @@
+require File.expand_path("#{File.dirname(__FILE__)}/../require")
+Require.spec_rakefile!
+
+begin
+  ActiveWrapper::Tasks.setup(
+    :base => File.dirname(__FILE__),
+    :env => 'test'
+  )
+rescue Exception
+end

data/spec/also_migrate_spec.rb

@@ -0,0 +1,53 @@
+require "spec_helper"
+
+describe AlsoMigrate do
+  
+  describe 'fixture config' do
+    
+    before(:each) do
+      $db.migrate(1)
+      $db.migrate(0)
+      $db.migrate(1)
+    end
+    
+    it 'should migrate both tables up' do
+      migrate_with_state(2)
+      (@new_article_columns - @old_article_columns).should == [ 'permalink' ]
+      (@new_archive_columns - @old_archive_columns).should == [ 'permalink' ]
+    end
+    
+    it 'should migrate both tables down' do
+      $db.migrate(2)
+      migrate_with_state(1)
+      (@old_article_columns - @new_article_columns).should == [ 'permalink' ]
+      (@old_archive_columns - @new_archive_columns).should == [ 'permalink' ]
+    end
+    
+    it "should ignore the body column column" do
+      (columns('articles') - columns('article_archives')).should == [ 'body' ]
+      connection.remove_column(:articles, :body)
+      (columns('articles') - columns('article_archives')).should == []
+    end
+    
+    it "should only add an index for id" do
+      ActiveRecord::Migrator::AlsoMigrate.indexed_columns('articles').should == [ 'id', 'read' ]
+      ActiveRecord::Migrator::AlsoMigrate.indexed_columns('article_archives').should == [ 'id' ]
+    end
+  end
+  
+  describe 'no index config' do
+    
+    before(:each) do
+      Article.also_migrate_config = nil
+      Article.also_migrate :article_archives
+      $db.migrate(1)
+      $db.migrate(0)
+      $db.migrate(1)
+    end
+  
+    it "should add all indexes" do
+      ActiveRecord::Migrator::AlsoMigrate.indexed_columns('articles').should == [ 'id', 'read' ]
+      ActiveRecord::Migrator::AlsoMigrate.indexed_columns('article_archives').should == [ 'id', 'read' ]
+    end
+  end
+end

data/spec/config/database.yml.example

@@ -0,0 +1,6 @@
+test:
+  adapter: mysql
+  database: also_migrate
+  username: root
+  password: 
+  host: localhost

data/spec/db/migrate/001_create_articles.rb

@@ -0,0 +1,14 @@
+class CreateArticles < ActiveRecord::Migration
+  def self.up
+    create_table :articles do |t|
+      t.string :title
+      t.string :body
+      t.boolean :read
+    end
+    add_index :articles, :read
+  end
+
+  def self.down
+    drop_table :articles
+  end
+end

data/spec/db/migrate/002_add_permalink.rb

@@ -0,0 +1,9 @@
+class AddPermalink < ActiveRecord::Migration
+  def self.up
+    add_column :articles, :permalink, :string
+  end
+
+  def self.down
+    remove_column :articles, :permalink
+  end
+end

data/spec/db/migrate/003_remove_ignored.rb

@@ -0,0 +1,9 @@
+class RemoveMagicColumns < ActiveRecord::Migration
+  def self.up
+    remove_column :articles, :move_id
+    remove_column :articles, :moved_at
+  end
+
+  def self.down
+  end
+end