plugin_migrations 0.1.2

data/CHANGELOG

@@ -0,0 +1,57 @@
+*SVN*
+
+*0.1.2* (September 28th, 2007)
+
+* Fix Plugin#current_version failing if the plugin_schema_info table doesn't exist
+
+* Add functional tests for plugin_migration generator
+
+* Don't loop over plugins for self.down in generated plugin_migration
+
+*0.1.1* (September 26th, 2007)
+
+* Fix copyright to include proper credits
+
+* Add plugin_migration generator
+
+* Move SchemaStatements/Plugin extensions into separate modules rather than modifying the modules/classes directly
+
+* Adopt Engines-style plugin migrations
+
+* Use plugin_test_helper for testing
+
+* Remove gem dependency on activerecord
+
+* Convert dos newlines to unix newlines
+
+* Fix README typo: db/migrations -> db/migrate
+
+* Add proper terminator character at the end of statements produced when dumping schema information.  Fixes #16
+
+*0.1.0* (March 31st, 2007)
+
+* Refactor plugin_migrations.rb into files specific to each class being extended
+
+* Support running tests with plugins loaded via edge pluginaweek.  Fixes #10 [Brian Takita]
+
+* Updated to use the new Plugin interface
+
+* Added empty files so that test directories get added to the gem
+
+*0.0.2* (February 3rd, 2007)
+
+* Released as a gem
+
+* Added tests
+
+* Refactored tasks so that they could be tested
+
+* You can now specify PLUGINS and VERSION at the same time in the migration task
+
+* You can now specify PLUGINS and FIXTURES at the same time in the fixtures task
+
+* The plugin_migrations plugin doesn't access the LOADED_PLUGINS variable correctly (Peter Marklund). 
+
+*0.0.1* (November 5th, 2006)
+
+* Initial release

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2006 James Adam, 2006-2007 Aaron Pfeifer & Neil Abraham
+
+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,98 @@
+= plugin_migrations
+
++plugin_migrations+ adds support for plugin-based migrations.
+
+== Resources
+
+Announcement
+
+* http://www.pluginaweek.org/2006/11/05/3-plugin_migrations-where-have-all-the-migrations-gone
+
+Wiki
+
+* http://wiki.pluginaweek.org/Plugin_migrations
+
+API
+
+* http://api.pluginaweek.org/plugin_migrations
+
+Development
+
+* http://dev.pluginaweek.org/browser/trunk/plugins/active_record/migrations/plugin_migrations
+
+Source
+
+* http://svn.pluginaweek.org/trunk/plugins/active_record/migrations/plugin_migrations
+
+== Description
+
+In addition to the normal schema_info table that Rails created in your database
+to keep track of the current migration version, this plugin adds a new table
+called plugin_schema_info:
+
+  plugin_schema_info
+  ------------------
+  plugin_name (string)
+  version (integer)
+
+Plugin migrations expects the migrations to be located in a similar directory
+structure as that of your Rails application. That is, it would look in
+/db/migrate in your plugin's folder.
+
+== Usage
+
+The plugin can be used via the new rake tasks that have been added.  The plugins
+which are migrated are based on what is stored in +Rails.plugins+.  For more
+information on this attributes, see the loaded_plugins[http://wiki.pluginaweek.org/Loaded_plugins] plugin.
+
+=== db:migrate:plugins
+
+Running <tt>db:migrate:plugins</tt> will run the migrations for every plugin that is
+loaded.  You can also specify exactly which plugin you want to migrate.
+
+Examples:
+
+Assuming the following directory structure:
+
+  vendor/
+  vendor/plugins/
+  vendor/plugins/acts_as_bunny/
+  vendor/plugins/acts_as_as_chicken/
+
+  rake db:migrate:plugins # Migrates both acts_as_bunny and acts_as_chicken
+  rake db:migrate:plugins PLUGIN=acts_as_bunny
+  rake db:migrate:plugins PLUGIN=acts_as_bunny VERSION=2
+
+=== db:fixtures:load:plugins
+
+Running <tt>db:fixtures:load:plugins</tt> will load the fixtures for every plugin that is
+loaded.  You can also specify exactly which plugin you want to load fixtures for.
+
+Examples:
+
+Assuming the following directory structure:
+
+  vendor/
+  vendor/plugins/
+  vendor/plugins/acts_as_bunny/
+  vendor/plugins/acts_as_as_chicken/
+
+  rake db:fixtures:load:plugins # Loads fixtures for both acts_as_bunny and acts_as_chicken
+  rake db:fixtures:load:plugins PLUGIN=acts_as_bunny
+  rake db:fixtures:load:plugins PLUGIN=acts_as_bunny FIXTURES=bunnies
+  rake db:fixtures:load:plugins PLUGIN=acts_as_bunny FIXTURES=bunnies,rabbits
+
+== Testing
+
+Before you can run any tests, the following gems must be installed:
+* plugin_test_helper[http://wiki.pluginaweek.org/Plugin_test_helper]
+
+== Dependencies
+
+This plugin dependencies on the presence of the following plugins:
+* loaded_plugins[http://wiki.pluginaweek.org/Loaded_plugins]
+* plugin_dependencies[http://wiki.pluginaweek.org/Plugin_dependencies]
+
+== References
+
+* James Adam - Engines[http://www.rails-engines.org]

data/Rakefile

@@ -0,0 +1,80 @@
+require 'rake/testtask'
+require 'rake/rdoctask'
+require 'rake/gempackagetask'
+require 'rake/contrib/sshpublisher'
+
+PKG_NAME           = 'plugin_migrations'
+PKG_VERSION        = '0.1.2'
+PKG_FILE_NAME      = "#{PKG_NAME}-#{PKG_VERSION}"
+RUBY_FORGE_PROJECT = 'pluginaweek'
+
+desc 'Default: run unit tests.'
+task :default => :test
+
+desc 'Test the plugin_migrations plugin.'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end
+
+desc 'Generate documentation for the plugin_migrations plugin.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'PluginMigrations'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+spec = Gem::Specification.new do |s|
+  s.name            = PKG_NAME
+  s.version         = PKG_VERSION
+  s.platform        = Gem::Platform::RUBY
+  s.summary         = 'Adds support for plugin-based migrations'
+  
+  s.files           = FileList['{lib,tasks,test}/**/*'].to_a + %w(CHANGELOG init.rb MIT-LICENSE Rakefile README)
+  s.require_path    = 'lib'
+  s.autorequire     = 'plugin_migrations'
+  s.has_rdoc        = true
+  s.test_files      = Dir['test/**/*_test.rb']
+  s.add_dependency  'loaded_plugins', '>= 0.1.0'
+  
+  s.author          = 'Aaron Pfeifer, Neil Abraham'
+  s.email           = 'info@pluginaweek.org'
+  s.homepage        = 'http://www.pluginaweek.org'
+end
+  
+Rake::GemPackageTask.new(spec) do |p|
+  p.gem_spec = spec
+  p.need_tar = true
+  p.need_zip = true
+end
+
+desc 'Publish the beta gem'
+task :pgem => [:package] do
+  Rake::SshFilePublisher.new('pluginaweek@pluginaweek.org', '/home/pluginaweek/gems.pluginaweek.org/gems', 'pkg', "#{PKG_FILE_NAME}.gem").upload
+end
+
+desc 'Publish the API documentation'
+task :pdoc => [:rdoc] do
+  Rake::SshDirPublisher.new('pluginaweek@pluginaweek.org', "/home/pluginaweek/api.pluginaweek.org/#{PKG_NAME}", 'rdoc').upload
+end
+
+desc 'Publish the API docs and gem'
+task :publish => [:pdoc, :release]
+
+desc 'Publish the release files to RubyForge.'
+task :release => [:gem, :package] do
+  require 'rubyforge'
+  
+  ruby_forge = RubyForge.new
+  ruby_forge.login
+  
+  %w( gem tgz zip ).each do |ext|
+    file = "pkg/#{PKG_FILE_NAME}.#{ext}"
+    puts "Releasing #{File.basename(file)}..."
+    
+    ruby_forge.add_release(RUBY_FORGE_PROJECT, PKG_NAME, PKG_VERSION, file)
+  end
+end

data/init.rb

@@ -0,0 +1 @@
+require 'plugin_migrations'

data/lib/plugin_migrations.rb

@@ -0,0 +1,27 @@
+require 'loaded_plugins'
+require 'plugin_migrations/extensions/plugin'
+require 'plugin_migrations/extensions/schema_statements'
+require 'plugin_migrations/migrator'
+
+module PluginAWeek #:nodoc:
+  # Adds support for running migrations and loading fixtures from plugins
+  module PluginMigrations
+    class << self
+      # Migrate the database through scripts in plugin_xyz/db/migrate. Specify
+      # target plugins through plugin_names.  The version can only be used when
+      # targeting specific plugins.
+      def migrate(plugin_names = nil, version = nil)
+        version = version.to_i if version
+        Rails.plugins.find_by_names(plugin_names).each {|plugin| plugin.migrate(version)}
+      end
+      
+      # Load plugin fixtures into the current environment's database.  Load
+      # fixtures for a specific plugin using +plugin_names+, specific fixtures
+      # using +fixtures+
+      def load_fixtures(plugin_names = nil, fixtures = nil)
+        require 'active_record/fixtures'
+        Rails.plugins.find_by_names(plugin_names).each {|plugin| plugin.load_fixtures(fixtures)}
+      end
+    end
+  end
+end

data/lib/plugin_migrations/extensions/plugin.rb

@@ -0,0 +1,61 @@
+module PluginAWeek #:nodoc:
+  module PluginMigrations
+    module Extensions #:nodoc:
+      # Adds migration/fixture support
+      module Plugin
+        # The location of the plugin's migrations
+        def migration_path
+          "#{root}/db/migrate"
+        end
+
+        # The current version of the plugin migrated in the database
+        def current_version
+          begin
+            if result = ActiveRecord::Base.connection.select_one("SELECT version FROM #{PluginAWeek::PluginMigrations::Migrator.schema_info_table_name} WHERE plugin_name = '#{name}'")
+              result['version'].to_i
+            else
+              # There probably isn't an entry for this plugin in the migration info table.
+              0
+            end
+          rescue ActiveRecord::StatementInvalid
+            # No migraiton info table, so never migrated
+            0
+          end
+        end
+
+        # The latest version of the plugin according to the current migrations
+        def latest_version
+          migrations = Dir["#{migration_path}/[0-9]*_[_a-z0-9]*.rb"]
+          migrations.map {|migration| File.basename(migration).match(/^([0-9]+)/)[1].to_i}.max || 0
+        end
+
+        # Migrate this plugin to the given version
+        def migrate(version = nil)
+          PluginAWeek::PluginMigrations::Migrator.migrate_plugin(self, version)
+        end
+
+        # The location of the plugin's fixtures
+        def fixtures_path
+          "#{root}/test/fixtures"
+        end
+
+        # The paths of all of the plugin's fixtures
+        def fixtures(names = nil)
+          names ||= '*'
+          Dir["#{fixtures_path}/{#{names}}.{yml,csv}"].sort
+        end
+
+        # Loads the fixtures for the plugin
+        def load_fixtures(*args)
+          fixtures(*args).each do |fixture|
+            Fixtures.create_fixtures(File.dirname(fixture), File.basename(fixture, '.*'))
+          end
+        end
+      end
+    end
+  end
+end
+
+Plugin.class_eval do
+  include PluginAWeek::PluginMigrations::Extensions::Plugin
+end

data/lib/plugin_migrations/extensions/schema_statements.rb

@@ -0,0 +1,53 @@
+module PluginAWeek #:nodoc:
+  module PluginMigrations
+    module Extensions #:nodoc:
+      # Adds support for the plugin schema info table
+      module SchemaStatements
+        def self.included(base) #:nodoc:
+          base.class_eval do
+            alias_method_chain :initialize_schema_information, :plugins
+            alias_method_chain :dump_schema_information, :plugins
+          end
+        end
+        
+        # Creates the plugin schema info table
+        def initialize_schema_information_with_plugins
+          initialize_schema_information_without_plugins
+          
+          begin
+            execute "CREATE TABLE #{PluginAWeek::PluginMigrations::Migrator.schema_info_table_name} (plugin_name #{type_to_sql(:string)}, version #{type_to_sql(:integer)})"
+          rescue ActiveRecord::StatementInvalid
+            # Schema has been initialized
+          end
+        end
+        
+        # Dumps the plugin schema info table as well as information about the
+        # current plugin migrations
+        def dump_schema_information_with_plugins
+          schema_information = []
+          
+          dump = dump_schema_information_without_plugins
+          schema_information << dump if dump
+          
+          begin
+            plugins = ActiveRecord::Base.connection.select_all("SELECT * FROM #{PluginAWeek::PluginMigrations::Migrator.schema_info_table_name}")
+            plugins.each do |plugin|
+              if (version = plugin['version'].to_i) > 0
+                plugin_name = ActiveRecord::Base.quote_value(plugin['plugin_name'])
+                schema_information << "INSERT INTO #{PluginAWeek::PluginMigrations::Migrator.schema_info_table_name} (plugin_name, version) VALUES (#{plugin_name}, #{version})"
+              end
+            end
+          rescue ActiveRecord::StatementInvalid 
+            # No Schema Info
+          end
+          
+          schema_information.join(";\n")
+        end
+      end
+    end
+  end
+end
+
+ActiveRecord::ConnectionAdapters::SchemaStatements.class_eval do
+  include PluginAWeek::PluginMigrations::Extensions::SchemaStatements
+end

data/lib/plugin_migrations/migrator.rb

@@ -0,0 +1,38 @@
+module PluginAWeek #:nodoc:
+  module PluginMigrations
+    # Responsible for migrating plugins.  +current_plugin+ indicates which plugin
+    # is currently being migrated.
+    class Migrator < ActiveRecord::Migrator
+      # We need to be able to set the current plugin being migrated
+      cattr_accessor :current_plugin
+      
+      class << self
+        # Runs the migrations from a plugin, up (or down) to the version given
+        def migrate_plugin(plugin, version = nil)
+          self.current_plugin = plugin
+          migrate(plugin.migration_path, version)
+        end
+        
+        def schema_info_table_name #:nodoc:
+          ActiveRecord::Base.table_name_prefix + 'plugin_schema_info' + ActiveRecord::Base.table_name_suffix
+        end
+        
+        def current_version #:nodoc:
+          current_plugin.current_version
+        end
+      end
+      
+      # Sets the version of the current plugin
+      def set_schema_version(version)
+        version = down? ? version.to_i - 1 : version.to_i
+        
+        if ActiveRecord::Base.connection.select_one("SELECT version FROM #{self.class.schema_info_table_name} WHERE plugin_name = '#{current_plugin.name}'")
+          ActiveRecord::Base.connection.update("UPDATE #{self.class.schema_info_table_name} SET version = #{version} WHERE plugin_name = '#{current_plugin.name}'")
+        else
+          # We need to create the entry since it doesn't exist
+          ActiveRecord::Base.connection.execute("INSERT INTO #{self.class.schema_info_table_name} (version, plugin_name) VALUES (#{version},'#{current_plugin.name}')")
+        end
+      end
+    end
+  end
+end

data/tasks/plugin_migrations_tasks.rake

@@ -0,0 +1,18 @@
+namespace :db do
+  namespace :migrate do
+    desc 'Migrate the database through scripts in plugin_xyz/db/migrate. Target specific plugin with PLUGIN=x, specific version with VERSION=y'
+    task :plugins => :environment do
+      PluginAWeek::PluginMigrations.migrate(ENV['PLUGIN'], ENV['VERSION'])
+      Rake::Task['db:schema:dump'].invoke if ActiveRecord::Base.schema_format == :ruby
+    end
+  end
+  
+  namespace :fixtures do
+    namespace :load do
+      desc "Load plugin fixtures into the current environment's database.  Load fixtures for a specific plugin using PLUGIN=x, specific fixtures using FIXTURES=y,z"
+      task :plugins => :environment do
+        PluginAWeek::PluginMigrations.load_fixtures(ENV['PLUGIN'], ENV['FIXTURES'])
+      end
+    end
+  end
+end

data/test/app_root/app/models/article.rb

@@ -0,0 +1,4 @@
+class Article < ActiveRecord::Base
+  belongs_to :author
+  has_many :comments
+end

data/test/app_root/app/models/author.rb

@@ -0,0 +1,3 @@
+class Author < ActiveRecord::Base
+  has_many :articles
+end

data/test/app_root/app/models/comment.rb

@@ -0,0 +1,3 @@
+class Comment < ActiveRecord::Base
+  belongs_to :article
+end

data/test/app_root/app/models/company.rb

@@ -0,0 +1,3 @@
+class Company < ActiveRecord::Base
+  has_many :employees
+end

data/test/app_root/app/models/employee.rb

@@ -0,0 +1,3 @@
+class Employee < ActiveRecord::Base
+  belongs_to :company
+end

data/test/app_root/app/models/plugin_schema_info.rb

@@ -0,0 +1,3 @@
+class PluginSchemaInfo < ActiveRecord::Base
+  set_table_name 'plugin_schema_info'
+end

data/test/app_root/app/models/schema_info.rb

@@ -0,0 +1,3 @@
+class SchemaInfo < ActiveRecord::Base
+  set_table_name ActiveRecord::Migrator.schema_info_table_name
+end

data/test/app_root/config/environment.rb

@@ -0,0 +1,25 @@
+require 'config/boot'
+
+$:.unshift("#{RAILS_ROOT}/../../../../../rails/plugin_dependencies/lib")
+begin
+  require 'plugin_dependencies'
+rescue Exception => e
+end
+
+Rails::Initializer.run do |config|
+  config.plugin_paths.concat([
+    "#{RAILS_ROOT}/../../..",
+    "#{RAILS_ROOT}/../../../../../rails"
+  ])
+  config.plugins = [
+    'loaded_plugins',
+    File.basename(File.expand_path("#{RAILS_ROOT}/../..")),
+    'plugin_with_migrations',
+    'plugin_with_no_db',
+    'plugin_with_no_migrations',
+    'second_plugin_with_migrations'
+  ]
+  config.cache_classes = false
+  config.frameworks -= [:action_web_service]
+  config.whiny_nils = true
+end

data/test/app_root/db_bak/migrate/001_migrate_plugin_with_migrations_to_version_2.rb

@@ -0,0 +1,9 @@
+class MigratePluginWithMigrationsToVersion2 < ActiveRecord::Migration
+  def self.up
+    Rails.plugins[:plugin_with_migrations].migrate(2)
+  end
+  
+  def self.down
+    Rails.plugins[:plugin_with_migrations].migrate(0)
+  end
+end

data/test/app_root/db_bak/migrate/002_migrate_second_plugin_with_migrations_to_version_1.rb

@@ -0,0 +1,9 @@
+class MigrateSecondPluginWithMigrationsToVersion1 < ActiveRecord::Migration
+  def self.up
+    Rails.plugins[:second_plugin_with_migrations].migrate(1)
+  end
+  
+  def self.down
+    Rails.plugins[:second_plugin_with_migrations].migrate(0)
+  end
+end

data/test/app_root/vendor/plugins/plugin_with_migrations/db/migrate/001_create_companies.rb

@@ -0,0 +1,11 @@
+class CreateCompanies < ActiveRecord::Migration
+  def self.up
+    create_table :companies do |t|
+      t.column :name, :string, :null => false
+    end
+  end
+  
+  def self.down
+    drop_table :companies
+  end
+end

data/test/app_root/vendor/plugins/plugin_with_migrations/db/migrate/002_create_employees.rb

@@ -0,0 +1,13 @@
+class CreateEmployees < ActiveRecord::Migration
+  def self.up
+    create_table :employees do |t|
+      t.column :company_id, :integer, :null => false
+      t.column :first_name, :string, :null => false
+      t.column :last_name, :string, :null => false
+    end
+  end
+  
+  def self.down
+    drop_table :employees
+  end
+end

data/test/app_root/vendor/plugins/plugin_with_migrations/test/fixtures/companies.yml

@@ -0,0 +1,3 @@
+pluginaweek:
+  id: 1
+  name: PluginAWeek

data/test/app_root/vendor/plugins/plugin_with_migrations/test/fixtures/employees.yml

@@ -0,0 +1,11 @@
+aaron:
+  id: 1
+  first_name: Aaron
+  last_name: Pfeifer
+  company_id: 1
+  
+neil:
+  id: 2
+  first_name: Neil
+  last_name: Abraham
+  company_id: 2

data/test/app_root/vendor/plugins/second_plugin_with_migrations/db/migrate/001_create_authors.rb

@@ -0,0 +1,11 @@
+class CreateAuthors < ActiveRecord::Migration
+  def self.up
+    create_table :authors do |t|
+      t.column :name, :string, :null => false
+    end
+  end
+  
+  def self.down
+    drop_table :authors
+  end
+end

data/test/app_root/vendor/plugins/second_plugin_with_migrations/db/migrate/002_create_articles.rb

@@ -0,0 +1,13 @@
+class CreateArticles < ActiveRecord::Migration
+  def self.up
+    create_table :articles do |t|
+      t.column :title, :string, :null => false
+      t.column :content, :text, :null => false
+      t.column :author_id, :integer, :null => false
+    end
+  end
+  
+  def self.down
+    drop_table :articles
+  end
+end

data/test/app_root/vendor/plugins/second_plugin_with_migrations/db/migrate/003_create_comments.rb

@@ -0,0 +1,12 @@
+class CreateComments < ActiveRecord::Migration
+  def self.up
+    create_table :comments do |t|
+      t.column :content, :string, :null => false
+      t.column :article_id, :integer, :null => false
+    end
+  end
+  
+  def self.down
+    drop_table :comments
+  end
+end

data/test/app_root/vendor/plugins/second_plugin_with_migrations/test/fixtures/articles.yml

@@ -0,0 +1,5 @@
+aaron_welcome:
+  id: 1
+  title: Welcome to PluginAWeek!
+  content: Hey, thanks for dropping by!
+  author_id: 1

data/test/app_root/vendor/plugins/second_plugin_with_migrations/test/fixtures/authors.yml

@@ -0,0 +1,7 @@
+aaron:
+  id: 1
+  name: Aaron Pfeifer
+  
+neil:
+  id: 2
+  name: Neil Abraham

data/test/functional/plugin_migration_generator_test.rb

@@ -0,0 +1,82 @@
+require File.expand_path("#{File.dirname(__FILE__)}/../test_helper")
+
+require 'rails_generator'
+require 'rails_generator/scripts/generate'
+
+# Add the plugin_migrations generators since it's not in the normal vendor/plugins path
+Rails::Generator::Base.sources << Rails::Generator::PathSource.new(:plugin_migrations, "#{::RAILS_ROOT}/../../generators")
+
+Rails::Generator::Commands::Base.class_eval do
+  def migration_directory(relative_path)
+    directory(relative_path)
+    @migration_directory = "#{RAILS_ROOT}/#{relative_path}"
+  end
+end
+
+class PluginMigrationGeneratorTest < Test::Unit::TestCase
+  def setup
+    @db_root = "#{RAILS_ROOT}/db"
+    FileUtils.cp_r("#{RAILS_ROOT}/db_bak", @db_root)
+  end
+  
+  def test_should_throw_exception_if_plugin_doesnt_exist
+    assert_raise(SystemExit) {generate('invalid')}
+  end
+  
+  def test_should_throw_exception_if_plugin_migration_already_created_for_latest_version
+    assert_raise(SystemExit) {generate('plugin_with_migrations')}
+  end
+  
+  def test_should_create_migration_for_plugin_never_migrated_before
+    FileUtils.rm("#{@db_root}/migrate/002_migrate_second_plugin_with_migrations_to_version_1.rb")
+    
+    generate('second_plugin_with_migrations')
+    migration_path = "#{@db_root}/migrate/002_migrate_second_plugin_with_migrations_to_version_3.rb"
+    assert File.exists?(migration_path)
+    
+    expected = <<-EOS
+class MigrateSecondPluginWithMigrationsToVersion3 < ActiveRecord::Migration
+  def self.up
+    Rails.plugins[:second_plugin_with_migrations].migrate(3)
+  end
+
+  def self.down
+    Rails.plugins[:second_plugin_with_migrations].migrate(0)
+  end
+end
+
+EOS
+    assert_equal expected, File.open(migration_path).readlines.join
+  end
+  
+  def test_should_create_migration_for_plugin_previously_migrated
+    PluginAWeek::PluginMigrations.migrate('second_plugin_with_migrations', 1)
+    
+    generate('second_plugin_with_migrations')
+    migration_path = "#{@db_root}/migrate/003_migrate_second_plugin_with_migrations_to_version_3.rb"
+    assert File.exists?(migration_path)
+    
+    expected = <<-EOS
+class MigrateSecondPluginWithMigrationsToVersion3 < ActiveRecord::Migration
+  def self.up
+    Rails.plugins[:second_plugin_with_migrations].migrate(3)
+  end
+
+  def self.down
+    Rails.plugins[:second_plugin_with_migrations].migrate(1)
+  end
+end
+
+EOS
+    assert_equal expected, File.open(migration_path).readlines.join
+  end
+  
+  def teardown
+    FileUtils.rmtree(@db_root)
+  end
+  
+  private
+  def generate(plugin)
+    Rails::Generator::Scripts::Generate.new.run(['plugin_migration', plugin])
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,10 @@
+# Load the plugin testing framework
+$:.unshift("#{File.dirname(__FILE__)}/../../../../test/plugin_test_helper/lib")
+require 'rubygems'
+require 'plugin_test_helper'
+
+class Test::Unit::TestCase
+  def initialize_schema_information
+    ActiveRecord::Base.connection.initialize_schema_information
+  end
+end

data/test/unit/migrator_test.rb

@@ -0,0 +1,59 @@
+require File.expand_path("#{File.dirname(__FILE__)}/../test_helper")
+
+class MigratorTest < Test::Unit::TestCase
+  def setup
+    ActiveRecord::Migration.verbose = true
+    initialize_schema_information
+  end
+  
+  def test_schema_info_table_name_should_not_have_prefix_or_suffix
+    assert_equal 'plugin_schema_info', PluginAWeek::PluginMigrations::Migrator.schema_info_table_name
+  end
+  
+  def test_schema_info_table_name_should_have_prefix_if_prefix_exists
+    ActiveRecord::Base.table_name_prefix = 'prefix_'
+    assert_equal 'prefix_plugin_schema_info', PluginAWeek::PluginMigrations::Migrator.schema_info_table_name
+  end
+  
+  def test_schema_info_table_name_should_have_suffix_if_suffix_exists
+    ActiveRecord::Base.table_name_suffix = '_suffix'
+    assert_equal 'plugin_schema_info_suffix', PluginAWeek::PluginMigrations::Migrator.schema_info_table_name
+  end
+  
+  def test_schema_info_table_name_should_have_prefix_and_suffix_if_both_exist
+    ActiveRecord::Base.table_name_prefix = 'prefix_'
+    ActiveRecord::Base.table_name_suffix = '_suffix'
+    assert_equal 'prefix_plugin_schema_info_suffix', PluginAWeek::PluginMigrations::Migrator.schema_info_table_name
+  end
+  
+  def test_current_plugin_version_should_be_zero_if_never_migrated
+    PluginAWeek::PluginMigrations::Migrator.current_plugin = Plugin.new('/path/to/test_plugin')
+    assert_equal 0, PluginAWeek::PluginMigrations::Migrator.current_version
+    assert_equal 0, PluginSchemaInfo.count
+  end
+  
+  def test_should_add_plugin_schema_info_after_setting_schema_version
+    PluginAWeek::PluginMigrations::Migrator.allocate.set_schema_version(0)
+    assert_equal 0, PluginAWeek::PluginMigrations::Migrator.current_version
+    assert_equal 1, PluginSchemaInfo.count
+  end
+  
+  def test_should_update_plugin_schema_info_if_plugin_version_previously_set
+    PluginAWeek::PluginMigrations::Migrator.allocate.set_schema_version(0)
+    assert_equal 0, PluginAWeek::PluginMigrations::Migrator.current_version
+    assert_equal 1, PluginSchemaInfo.count
+    
+    PluginAWeek::PluginMigrations::Migrator.allocate.set_schema_version(1)
+    assert_equal 1, PluginAWeek::PluginMigrations::Migrator.current_version
+    assert_equal 1, PluginSchemaInfo.count
+  end
+  
+  def teardown
+    ActiveRecord::Base.table_name_prefix = ''
+    ActiveRecord::Base.table_name_suffix = ''
+    ActiveRecord::Base.connection.drop_table(ActiveRecord::Migrator.schema_info_table_name)
+    [PluginSchemaInfo].each do |model|
+      ActiveRecord::Base.connection.drop_table(model.table_name) if model.table_exists?
+    end
+  end
+end

data/test/unit/plugin_migrations_test.rb

@@ -0,0 +1,158 @@
+require File.expand_path("#{File.dirname(__FILE__)}/../test_helper")
+
+class PluginMigrationsTest < Test::Unit::TestCase
+  def setup
+    ActiveRecord::Migration.verbose = true
+    initialize_schema_information
+  end
+  
+  def test_should_migrate_all_plugins_up_to_latest_version_by_default
+    PluginAWeek::PluginMigrations.migrate
+    
+    assert Company.table_exists?
+    assert Employee.table_exists?
+    assert Author.table_exists?
+    assert Article.table_exists?
+    assert Comment.table_exists?
+    
+    assert_equal 2, PluginSchemaInfo.count
+    expected = [
+      PluginSchemaInfo.new(:plugin_name => 'plugin_with_migrations', :version => 2),
+      PluginSchemaInfo.new(:plugin_name => 'second_plugin_with_migrations', :version => 3)
+    ]
+    assert_equal expected, PluginSchemaInfo.find(:all)
+  end
+  
+  def test_should_migrate_all_plugins_up_to_specific_version_if_specified
+    PluginAWeek::PluginMigrations.migrate(nil, 3)
+    
+    assert Company.table_exists?
+    assert Employee.table_exists?
+    assert Author.table_exists?
+    assert Article.table_exists?
+    assert Comment.table_exists?
+    
+    assert_equal 2, PluginSchemaInfo.count
+    expected = [
+      PluginSchemaInfo.new(:plugin_name => 'plugin_with_migrations', :version => 2),
+      PluginSchemaInfo.new(:plugin_name => 'second_plugin_with_migrations', :version => 3)
+    ]
+    assert_equal expected, PluginSchemaInfo.find(:all)
+  end
+  
+  def test_should_migrate_all_plugins_down_to_specific_version_if_specified
+    PluginAWeek::PluginMigrations.migrate(nil, 3)
+    PluginAWeek::PluginMigrations.migrate(nil, 1)
+    
+    assert Company.table_exists?
+    assert !Employee.table_exists?
+    assert Author.table_exists?
+    assert !Article.table_exists?
+    assert !Comment.table_exists?
+    
+    assert_equal 2, PluginSchemaInfo.count
+    expected = [
+      PluginSchemaInfo.new(:plugin_name => 'plugin_with_migrations', :version => 1),
+      PluginSchemaInfo.new(:plugin_name => 'second_plugin_with_migrations', :version => 1)
+    ]
+    assert_equal expected, PluginSchemaInfo.find(:all)
+  end
+  
+  def test_should_migrate_specific_plugins_to_latest_version_if_specified
+    PluginAWeek::PluginMigrations.migrate('plugin_with_migrations')
+    
+    assert Company.table_exists?
+    assert Employee.table_exists?
+    assert !Author.table_exists?
+    assert !Article.table_exists?
+    assert !Comment.table_exists?
+    
+    assert_equal 1, PluginSchemaInfo.count
+    expected = [
+      PluginSchemaInfo.new(:plugin_name => 'plugin_with_migrations', :version => 2)
+    ]
+    assert_equal expected, PluginSchemaInfo.find(:all)
+  end
+  
+  def test_should_migrate_specific_plugins_up_to_specific_version_if_both_specified
+    PluginAWeek::PluginMigrations.migrate('plugin_with_migrations', 1)
+    
+    assert Company.table_exists?
+    assert !Employee.table_exists?
+    assert !Author.table_exists?
+    assert !Article.table_exists?
+    assert !Comment.table_exists?
+    
+    assert_equal 1, PluginSchemaInfo.count
+    expected = [
+      PluginSchemaInfo.new(:plugin_name => 'plugin_with_migrations', :version => 2)
+    ]
+    assert_equal expected, PluginSchemaInfo.find(:all)
+  end
+  
+  def test_should_migrate_specific_plugins_down_to_specific_version_if_both_specified
+    PluginAWeek::PluginMigrations.migrate('plugin_with_migrations', 1)
+    PluginAWeek::PluginMigrations.migrate('plugin_with_migrations', 0)
+    
+    assert !Company.table_exists?
+    assert !Employee.table_exists?
+    assert !Author.table_exists?
+    assert !Article.table_exists?
+    assert !Comment.table_exists?
+    
+    assert_equal 1, PluginSchemaInfo.count
+    expected = [
+      PluginSchemaInfo.new(:plugin_name => 'plugin_with_migrations', :version => 0)
+    ]
+    assert_equal expected, PluginSchemaInfo.find(:all)
+  end
+  
+  def test_should_load_fixtures_for_all_plugins_by_default
+    PluginAWeek::PluginMigrations.migrate
+    PluginAWeek::PluginMigrations.load_fixtures
+    
+    assert_equal 1, Company.count
+    assert_equal 2, Employee.count
+    assert_equal 2, Author.count
+    assert_equal 1, Article.count
+  end
+  
+  def test_should_load_specific_fixtures_for_all_plugins_if_specified
+    PluginAWeek::PluginMigrations.migrate
+    PluginAWeek::PluginMigrations.load_fixtures(nil, 'companies,authors')
+    
+    assert_equal 1, Company.count
+    assert_equal 0, Employee.count
+    assert_equal 2, Author.count
+    assert_equal 0, Article.count
+  end
+  
+  def test_should_load_all_fixtures_for_specific_plugins_if_specified
+    PluginAWeek::PluginMigrations.migrate
+    PluginAWeek::PluginMigrations.load_fixtures('plugin_with_migrations')
+    
+    assert_equal 1, Company.count
+    assert_equal 2, Employee.count
+    assert_equal 0, Author.count
+    assert_equal 0, Article.count
+  end
+  
+  def test_should_load_specific_fixtures_specific_plugins_if_both_specified
+    PluginAWeek::PluginMigrations.migrate
+    PluginAWeek::PluginMigrations.load_fixtures('plugin_with_migrations', 'companies')
+    
+    assert_equal 1, Company.count
+    assert_equal 0, Employee.count
+    assert_equal 0, Author.count
+    assert_equal 0, Article.count
+  end
+  
+  def teardown
+    ActiveRecord::Base.table_name_prefix = ''
+    ActiveRecord::Base.table_name_suffix = ''
+    ActiveRecord::Base.connection.drop_table(ActiveRecord::Migrator.schema_info_table_name)
+    [Article, Author, Comment, Company, Employee, PluginSchemaInfo].each do |model|
+      ActiveRecord::Base.connection.drop_table(model.table_name) if model.table_exists?
+    end
+  end
+end

data/test/unit/plugin_test.rb

@@ -0,0 +1,113 @@
+require File.expand_path("#{File.dirname(__FILE__)}/../test_helper")
+
+class PluginTest < Test::Unit::TestCase
+  def setup
+    @plugin = Plugin.new("#{RAILS_ROOT}/vendor/plugins/plugin_with_migrations")
+    ActiveRecord::Migration.verbose = true
+    initialize_schema_information
+  end
+  
+  def test_should_have_migration_path
+    assert_equal "#{RAILS_ROOT}/vendor/plugins/plugin_with_migrations/db/migrate", @plugin.migration_path
+  end
+  
+  def test_current_version_should_be_zero_if_no_version_found
+    assert_equal 0, @plugin.current_version
+  end
+  
+  def test_current_version_should_be_latest_migrated_in_the_database
+    PluginSchemaInfo.create(:plugin_name => 'plugin_with_migrations', :version => 2)
+    assert_equal 2, @plugin.current_version
+  end
+  
+  def test_latest_version_should_be_zero_if_no_migrations_found
+    plugin = Plugin.new("#{RAILS_ROOT}/vendor/plugins/plugin_with_no_migrations")
+    assert_equal 0, plugin.latest_version
+  end
+  
+  def test_latest_version_should_be_latest_migration_available_if_migrations_exist
+    assert_equal 2, @plugin.latest_version
+  end
+  
+  def test_should_migrate_to_latest_version_by_default
+    @plugin.migrate
+    
+    assert Company.table_exists?
+    assert Employee.table_exists?
+    
+    assert_equal 1, PluginSchemaInfo.count
+    expected = [
+      PluginSchemaInfo.new(:plugin_name => 'plugin_with_migrations', :version => 2)
+    ]
+    assert_equal expected, PluginSchemaInfo.find(:all)
+  end
+  
+  def test_should_migrate_to_specific_version_if_version_specified
+    @plugin.migrate(1)
+    
+    assert Company.table_exists?
+    assert !Employee.table_exists?
+    
+    assert_equal 1, PluginSchemaInfo.count
+    expected = [
+      PluginSchemaInfo.new(:plugin_name => 'plugin_with_migrations', :version => 1)
+    ]
+    assert_equal expected, PluginSchemaInfo.find(:all)
+    
+    @plugin.migrate(0)
+    
+    assert !Company.table_exists?
+    assert !Employee.table_exists?
+    
+    assert_equal 1, PluginSchemaInfo.count
+    expected = [
+      PluginSchemaInfo.new(:plugin_name => 'plugin_with_migrations', :version => 0)
+    ]
+    assert_equal expected, PluginSchemaInfo.find(:all)
+  end
+  
+  def test_should_have_fixtures_path
+    assert_equal "#{RAILS_ROOT}/vendor/plugins/plugin_with_migrations/test/fixtures", @plugin.fixtures_path
+  end
+  
+  def test_fixtures_should_include_all_by_default
+    expected = [
+      "#{@plugin.fixtures_path}/companies.yml",
+      "#{@plugin.fixtures_path}/employees.yml"
+    ]
+    assert_equal expected, @plugin.fixtures
+  end
+  
+  def test_fixtures_should_only_include_specific_fixtures_if_specified
+    assert_equal ["#{@plugin.fixtures_path}/companies.yml"], @plugin.fixtures('companies')
+    
+    expected = [
+      "#{@plugin.fixtures_path}/companies.yml",
+      "#{@plugin.fixtures_path}/employees.yml"
+    ]
+    assert_equal expected, @plugin.fixtures('companies,employees')
+  end
+  
+  def test_load_should_create_all_fixtures_by_default
+    @plugin.migrate
+    @plugin.load_fixtures
+    
+    assert_equal 1, Company.count
+    assert_equal 2, Employee.count
+  end
+  
+  def test_load_should_only_create_specific_fixtures_if_specified
+    @plugin.migrate
+    @plugin.load_fixtures('companies')
+    
+    assert_equal 1, Company.count
+    assert_equal 0, Employee.count
+  end
+  
+  def teardown
+    ActiveRecord::Base.connection.drop_table(ActiveRecord::Migrator.schema_info_table_name)
+    [Company, Employee, PluginSchemaInfo].each do |model|
+      ActiveRecord::Base.connection.drop_table(model.table_name) if model.table_exists?
+    end
+  end
+end

data/test/unit/schema_statements_test.rb

@@ -0,0 +1,63 @@
+require File.expand_path("#{File.dirname(__FILE__)}/../test_helper")
+
+class SchemaStatementsTest < Test::Unit::TestCase
+  def test_plugin_schema_info_table_should_not_exist_by_default
+    assert !PluginSchemaInfo.table_exists?
+  end
+  
+  def test_should_create_plugin_schema_info_table_when_initialized
+    initialize_schema_information
+    assert PluginSchemaInfo.table_exists?
+  end
+  
+  def test_should_not_dump_anything_if_no_main_or_plugin_schema_info
+    assert_equal '', ActiveRecord::Base.connection.dump_schema_information
+  end
+  
+  def test_should_not_dump_anything_if_schema_or_plugin_is_at_version_zero
+    initialize_schema_information
+    PluginSchemaInfo.create(:plugin_name => 'test_plugin', :version => 0)
+    assert_equal '', ActiveRecord::Base.connection.dump_schema_information
+  end
+  
+  def test_should_dump_schema_info_for_one_plugin
+    initialize_schema_information
+    PluginSchemaInfo.create(:plugin_name => 'test_plugin', :version => 1)
+    assert_equal "INSERT INTO plugin_schema_info (plugin_name, version) VALUES ('test_plugin', 1)", ActiveRecord::Base.connection.dump_schema_information
+  end
+  
+  def test_should_dump_schema_info_for_multiple_plugins
+    initialize_schema_information
+    PluginSchemaInfo.create(:plugin_name => 'test_plugin', :version => 1)
+    PluginSchemaInfo.create(:plugin_name => 'another_plugin', :version => 2)
+    
+    expected = [
+      "INSERT INTO plugin_schema_info (plugin_name, version) VALUES ('test_plugin', 1);",
+      "INSERT INTO plugin_schema_info (plugin_name, version) VALUES ('another_plugin', 2)"
+    ].join("\n")
+    assert_equal expected, ActiveRecord::Base.connection.dump_schema_information
+  end
+  
+  def test_should_dump_both_main_schema_info_and_plugin_schema_info
+    initialize_schema_information
+    ActiveRecord::Base.connection.update("UPDATE #{ActiveRecord::Migrator.schema_info_table_name} SET version = 1")
+    PluginSchemaInfo.create(:plugin_name => 'test_plugin', :version => 1)
+    
+    expected = [
+      'INSERT INTO schema_info (version) VALUES (1);',
+      "INSERT INTO plugin_schema_info (plugin_name, version) VALUES ('test_plugin', 1)"
+    ].join("\n")
+    assert_equal expected, ActiveRecord::Base.connection.dump_schema_information
+  end
+  
+  def test_should_dump_only_main_schema_info_if_no_plugins_migrated
+    initialize_schema_information
+    ActiveRecord::Base.connection.update("UPDATE #{ActiveRecord::Migrator.schema_info_table_name} SET version = 1")
+    assert_equal 'INSERT INTO schema_info (version) VALUES (1)', ActiveRecord::Base.connection.dump_schema_information
+  end
+  
+  def teardown
+    ActiveRecord::Base.connection.drop_table(SchemaInfo.table_name) if SchemaInfo.table_exists?
+    ActiveRecord::Base.connection.drop_table(PluginSchemaInfo.table_name) if PluginSchemaInfo.table_exists?
+  end
+end

metadata

@@ -0,0 +1,84 @@
+--- !ruby/object:Gem::Specification
+name: plugin_migrations
+version: !ruby/object:Gem::Version
+  version: 0.1.2
+  prerelease: 
+platform: ruby
+authors:
+- Aaron Pfeifer, Neil Abraham
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-11-09 00:00:00.000000000 Z
+dependencies: []
+description: 
+email: info@pluginaweek.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/plugin_migrations.rb
+- lib/plugin_migrations/migrator.rb
+- lib/plugin_migrations/extensions/plugin.rb
+- lib/plugin_migrations/extensions/schema_statements.rb
+- tasks/plugin_migrations_tasks.rake
+- test/test_helper.rb
+- test/app_root/vendor/plugins/plugin_with_no_migrations/init.rb
+- test/app_root/vendor/plugins/plugin_with_no_migrations/db/empty
+- test/app_root/vendor/plugins/plugin_with_migrations/init.rb
+- test/app_root/vendor/plugins/plugin_with_migrations/test/fixtures/employees.yml
+- test/app_root/vendor/plugins/plugin_with_migrations/test/fixtures/companies.yml
+- test/app_root/vendor/plugins/plugin_with_migrations/db/migrate/002_create_employees.rb
+- test/app_root/vendor/plugins/plugin_with_migrations/db/migrate/001_create_companies.rb
+- test/app_root/vendor/plugins/plugin_with_no_db/init.rb
+- test/app_root/vendor/plugins/second_plugin_with_migrations/init.rb
+- test/app_root/vendor/plugins/second_plugin_with_migrations/test/fixtures/authors.yml
+- test/app_root/vendor/plugins/second_plugin_with_migrations/test/fixtures/articles.yml
+- test/app_root/vendor/plugins/second_plugin_with_migrations/db/migrate/002_create_articles.rb
+- test/app_root/vendor/plugins/second_plugin_with_migrations/db/migrate/001_create_authors.rb
+- test/app_root/vendor/plugins/second_plugin_with_migrations/db/migrate/003_create_comments.rb
+- test/app_root/config/environment.rb
+- test/app_root/app/models/employee.rb
+- test/app_root/app/models/plugin_schema_info.rb
+- test/app_root/app/models/author.rb
+- test/app_root/app/models/company.rb
+- test/app_root/app/models/article.rb
+- test/app_root/app/models/comment.rb
+- test/app_root/app/models/schema_info.rb
+- test/app_root/db_bak/migrate/001_migrate_plugin_with_migrations_to_version_2.rb
+- test/app_root/db_bak/migrate/002_migrate_second_plugin_with_migrations_to_version_1.rb
+- test/unit/plugin_test.rb
+- test/unit/migrator_test.rb
+- test/unit/plugin_migrations_test.rb
+- test/unit/schema_statements_test.rb
+- test/functional/plugin_migration_generator_test.rb
+- CHANGELOG
+- init.rb
+- MIT-LICENSE
+- Rakefile
+- README
+homepage: 
+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.7.2
+signing_key: 
+specification_version: 3
+summary: Adds support for plugin-based migrations
+test_files: []