standalone_migrations 0.2.5 → 0.3.0

data/README.markdown

@@ -8,6 +8,15 @@ Install Ruby, RubyGems and a ruby-database driver (e.g. `gem install mysql`) the
 Add to `Rakefile` in your projects base directory:
     begin
       require 'tasks/standalone_migrations'
+      MigratorTasks.new do |t|
+        # t.migrations = "db/migrations"
+        # t.config = "db/config.yml"
+        # t.schema = "db/schema.rb"
+        # t.env = "DB"
+        # t.default_env = "development"
+        # t.verbose = true
+        # t.log_level = Logger::ERROR
+      end
     rescue LoadError => e
       puts "gem install standalone_migrations to get db:migrate:* tasks! (Error: #{e})"
     end

data/VERSION

@@ -1 +1 @@
-0.2.5
+0.3.0

data/lib/tasks/standalone_migrations.rb

@@ -1,137 +1,169 @@
-# Every important options should be overwriteable with MIGRATION_OPTIONS
-base = File.expand_path('.')
-here = File.expand_path(File.dirname(File.dirname(File.dirname((__FILE__)))))
+require 'rake'
+require 'rake/tasklib'
+require 'logger'
 
-options = {
-  :base => base,
-  :vendor => "#{here}/vendor",
-  :migrations => "#{base}/db/migrations",
-  :config => "#{base}/db/config.yml",
-  :schema => "#{base}/db/schema.rb",
-  :env => 'DB',
-  :default_env => 'development'
-}
-options = options.merge(MIGRATION_OPTIONS) if defined?(MIGRATION_OPTIONS)
-
-# Add to load_path every "lib/" directory in vendor
-Dir["#{options[:vendor]}/**/lib"].each{|p| $LOAD_PATH << p }
-
-namespace :db do
-  task :ar_init do
-    require 'logger'
-    require 'active_record'
-    ENV[options[:env]] ||= options[:default_env]
-
-    require 'erb'
-    ActiveRecord::Base.configurations = YAML::load(ERB.new(IO.read(options[:config])).result)
-    ActiveRecord::Base.establish_connection(ENV[options[:env]])
-    logger = Logger.new $stderr
-    logger.level = Logger::INFO
-    ActiveRecord::Base.logger = logger
+class MigratorTasks < ::Rake::TaskLib
+  attr_accessor :name, :base, :vendor, :config, :schema, :env, :default_env, :verbose, :log_level
+  attr_reader :migrations
+  
+  def initialize(name = :migrator)
+    @name = name
+    base = File.expand_path('.')
+    here = File.expand_path(File.dirname(File.dirname(File.dirname((__FILE__)))))
+    @base = base
+    @vendor = "#{here}/vendor"
+    @migrations = ["#{base}/db/migrations"]
+    @config = "#{base}/db/config.yml"
+    @schema = "#{base}/db/schema.rb"
+    @env = 'DB'
+    @default_env = 'development'
+    @verbose = true
+    @log_level = Logger::ERROR
+    yield self if block_given?
+    # Add to load_path every "lib/" directory in vendor
+    Dir["#{vendor}/**/lib"].each{|p| $LOAD_PATH << p }
+    define
   end
-
-  desc "Migrate the database using the scripts in the migrations directory. Target specific version with VERSION=x. Turn off output with VERBOSE=false."
-  task :migrate => :ar_init  do
-    require "#{options[:vendor]}/migration_helpers/init"
-    ActiveRecord::Migration.verbose = (ENV["VERBOSE"] == "true")
-    ActiveRecord::Migrator.migrate(options[:migrations], ENV["VERSION"] ? ENV["VERSION"].to_i : nil)
-    Rake::Task["db:schema:dump"].execute
+  
+  def migrations=(*value)
+    @migrations = value.flatten
   end
+  
+  def define
+    namespace :db do
+      task :ar_init do
+        require 'active_record'
+        ENV[@env] ||= @default_env
+
+        require 'erb'
+        ActiveRecord::Base.configurations = YAML::load(ERB.new(IO.read(@config)).result)
+        ActiveRecord::Base.establish_connection(ENV[@env])
+        logger = Logger.new $stderr
+        logger.level = @log_level
+        ActiveRecord::Base.logger = logger
+      end
 
-  namespace :migrate do
-    [:up, :down].each do |direction|
-      desc "Runs the '#{direction}' for a given migration VERSION."
-      task direction => :ar_init do
-        version = ENV["VERSION"].to_i
-        raise "VERSION is required (must be a number)" if version == 0
-        ActiveRecord::Migrator.run(direction, options[:migrations], version)
+      desc "Migrate the database using the scripts in the migrations directory. Target specific version with VERSION=x. Turn off output with VERBOSE=false."
+      task :migrate => :ar_init  do
+        require "#{@vendor}/migration_helpers/init"
+        ActiveRecord::Migration.verbose = ENV['VERBOSE'] || @verbose
+        @migrations.each do |path|
+          ActiveRecord::Migrator.migrate(path, ENV["VERSION"] ? ENV["VERSION"].to_i : nil)
+        end
         Rake::Task["db:schema:dump"].execute
       end
-    end
-  end
-  
-  desc "Raises an error if there are pending migrations"
-  task :abort_if_pending_migrations => :ar_init do
-    pending_migrations = ActiveRecord::Migrator.new(:up, options[:migrations]).pending_migrations
 
-    if pending_migrations.any?
-      puts "You have #{pending_migrations.size} pending migrations:"
-      pending_migrations.each do |pending_migration|
-        puts '  %4d %s' % [pending_migration.version, pending_migration.name]
+      namespace :migrate do
+        [:up, :down].each do |direction|
+          desc "Runs the '#{direction}' for a given migration VERSION."
+          task direction => :ar_init do
+            ActiveRecord::Migration.verbose = @verbose
+            version = ENV["VERSION"].to_i
+            raise "VERSION is required (must be a number)" if version == 0
+            migration_path = nil
+            if @migrations.length == 1
+              migration_path = @migrations.first
+            else
+              @migrations.each do |path|
+                Dir[File.join(path, '*.rb')].each do |file|
+                  if File.basename(file).match(/^\d+/)[0] == version.to_s
+                    migration_path = path
+                    break
+                  end
+                end
+              end
+              raise "Migration #{version} wasn't found on paths #{@migrations.join(', ')}" if migration_path.nil?
+            end
+            ActiveRecord::Migrator.run(direction, migration_path, version)
+            Rake::Task["db:schema:dump"].execute
+          end
+        end
       end
-      abort %{Run "rake db:migrate" to update your database then try again.}
-    end
-  end
-
-  namespace :schema do
-    desc "Create schema.rb file that can be portably used against any DB supported by AR"
-    task :dump => :ar_init do
-      require 'active_record/schema_dumper'
-      File.open(ENV['SCHEMA'] || options[:schema], "w") do |file|
-        ActiveRecord::SchemaDumper.dump(ActiveRecord::Base.connection, file)
+  
+      desc "Raises an error if there are pending migrations"
+      task :abort_if_pending_migrations => :ar_init do
+        @migrations.each do |path|
+          pending_migrations = ActiveRecord::Migrator.new(:up, path).pending_migrations
+          
+          if pending_migrations.any?
+            puts "You have #{pending_migrations.size} pending migrations:"
+            pending_migrations.each do |pending_migration|
+              puts '  %4d %s' % [pending_migration.version, pending_migration.name]
+            end
+            abort %{Run "rake db:migrate" to update your database then try again.}
+          end
+        end
       end
-    end
 
-    desc "Load a ar_schema.rb file into the database"
-    task :load => :ar_init do
-      file = ENV['SCHEMA'] || options[:schema]
-      load(file)
-    end
-  end
-
-  namespace :test do
-    desc "Recreate the test database from the current schema.rb"
-    task :load => ['db:ar_init', 'db:test:purge'] do
-      ActiveRecord::Base.establish_connection(:test)
-      ActiveRecord::Schema.verbose = false
-      Rake::Task["db:schema:load"].invoke
-    end
+      namespace :schema do
+        desc "Create schema.rb file that can be portably used against any DB supported by AR"
+        task :dump => :ar_init do
+          require 'active_record/schema_dumper'
+          File.open(ENV['SCHEMA'] || @schema, "w") do |file|
+            ActiveRecord::SchemaDumper.dump(ActiveRecord::Base.connection, file)
+          end
+        end
 
-    desc "Empty the test database"
-    task :purge => 'db:ar_init' do
-      config = ActiveRecord::Base.configurations['test']
-      case config["adapter"]
-      when "mysql"
-        ActiveRecord::Base.establish_connection(:test)
-        ActiveRecord::Base.connection.recreate_database(config["database"], config)
-      when "postgresql" #TODO i doubt this will work <-> methods are not defined
-        ActiveRecord::Base.clear_active_connections!
-        drop_database(config)
-        create_database(config)
-      when "sqlite", "sqlite3"
-        db_file = config["database"] || config["dbfile"]
-        File.delete(db_file) if File.exist?(db_file)
-      when "sqlserver"
-        drop_script = "#{config["host"]}.#{config["database"]}.DP1".gsub(/\\/,'-')
-        `osql -E -S #{config["host"]} -d #{config["database"]} -i db\\#{drop_script}`
-        `osql -E -S #{config["host"]} -d #{config["database"]} -i db\\test_structure.sql`
-      when "oci", "oracle"
-        ActiveRecord::Base.establish_connection(:test)
-        ActiveRecord::Base.connection.structure_drop.split(";\n\n").each do |ddl|
-          ActiveRecord::Base.connection.execute(ddl)
+        desc "Load a ar_schema.rb file into the database"
+        task :load => :ar_init do
+          file = ENV['SCHEMA'] || @schema
+          load(file)
         end
-      when "firebird"
-        ActiveRecord::Base.establish_connection(:test)
-        ActiveRecord::Base.connection.recreate_database!
-      else
-        raise "Task not supported by #{config["adapter"].inspect}"
       end
-    end
+
+      namespace :test do
+        desc "Recreate the test database from the current schema.rb"
+        task :load => ['db:ar_init', 'db:test:purge'] do
+          ActiveRecord::Base.establish_connection(:test)
+          ActiveRecord::Schema.verbose = false
+          Rake::Task["db:schema:load"].invoke
+        end
+
+        desc "Empty the test database"
+        task :purge => 'db:ar_init' do
+          config = ActiveRecord::Base.configurations['test']
+          case config["adapter"]
+          when "mysql"
+            ActiveRecord::Base.establish_connection(:test)
+            ActiveRecord::Base.connection.recreate_database(config["database"], config)
+          when "postgresql" #TODO i doubt this will work <-> methods are not defined
+            ActiveRecord::Base.clear_active_connections!
+            drop_database(config)
+            create_database(config)
+          when "sqlite", "sqlite3"
+            db_file = config["database"] || config["dbfile"]
+            File.delete(db_file) if File.exist?(db_file)
+          when "sqlserver"
+            drop_script = "#{config["host"]}.#{config["database"]}.DP1".gsub(/\\/,'-')
+            `osql -E -S #{config["host"]} -d #{config["database"]} -i db\\#{drop_script}`
+            `osql -E -S #{config["host"]} -d #{config["database"]} -i db\\test_structure.sql`
+          when "oci", "oracle"
+            ActiveRecord::Base.establish_connection(:test)
+            ActiveRecord::Base.connection.structure_drop.split(";\n\n").each do |ddl|
+              ActiveRecord::Base.connection.execute(ddl)
+            end
+          when "firebird"
+            ActiveRecord::Base.establish_connection(:test)
+            ActiveRecord::Base.connection.recreate_database!
+          else
+            raise "Task not supported by #{config["adapter"].inspect}"
+          end
+        end
     
-    desc 'Check for pending migrations and load the test schema'
-    task :prepare => ['db:abort_if_pending_migrations', 'db:test:load']
-  end
+        desc 'Check for pending migrations and load the test schema'
+        task :prepare => ['db:abort_if_pending_migrations', 'db:test:load']
+      end
 
-  desc "Create a new migration"
-  task :new_migration do |t|
-    unless migration = ENV['name']
-      puts "Error: must provide name of migration to generate."
-      puts "For example: rake #{t.name} name=add_field_to_form"
-      abort
-    end
+      desc "Create a new migration"
+      task :new_migration do |t|
+        unless migration = ENV['name']
+          puts "Error: must provide name of migration to generate."
+          puts "For example: rake #{t.name} name=add_field_to_form"
+          abort
+        end
 
-    class_name = migration.split('_').map{|s| s.capitalize }.join
-    file_contents = <<eof
+        class_name = migration.split('_').map{|s| s.capitalize }.join
+        file_contents = <<eof
 class #{class_name} < ActiveRecord::Migration
   def self.up
   end
@@ -141,12 +173,14 @@ class #{class_name} < ActiveRecord::Migration
   end
 end
 eof
+        migration_path = @migrations.first
+        FileUtils.mkdir_p(migration_path) unless File.exist?(migration_path)
+        file_name  = "#{migration_path}/#{Time.now.utc.strftime('%Y%m%d%H%M%S')}_#{migration}.rb"
 
-    FileUtils.mkdir_p(options[:migrations]) unless File.exist?(options[:migrations])
-    file_name  = "#{options[:migrations]}/#{Time.now.utc.strftime('%Y%m%d%H%M%S')}_#{migration}.rb"
+        File.open(file_name, 'w'){|f| f.write file_contents }
 
-    File.open(file_name, 'w'){|f| f.write file_contents }
-
-    puts "Created migration #{file_name}"
+        puts "Created migration #{file_name}"
+      end
+    end
   end
-end
+end

data/spec/standalone_migrations_spec.rb

@@ -32,18 +32,52 @@ describe 'Standalone migrations' do
     write(migration, content)
     migration.match(/\d{14}/)[0]
   end
-
-  before do
-    `rm -rf spec/tmp` if File.exist?('spec/tmp')
-    `mkdir spec/tmp`
+  
+  def write_rakefile(config=nil)
     write 'Rakefile', <<-TXT
       $LOAD_PATH.unshift '#{File.expand_path('lib')}'
       begin
         require 'tasks/standalone_migrations'
+        MigratorTasks.new do |t|
+          t.log_level = Logger::INFO
+          #{config}
+        end
       rescue LoadError => e
         puts "gem install standalone_migrations to get db:migrate:* tasks! (Error: \#{e})"
       end
     TXT
+  end
+  
+  def write_multiple_migrations
+    write_rakefile %{t.migrations = "db/migrations", "db/migrations2"}
+    write "db/migrations/20100509095815_create_tests.rb", <<-TXT
+class CreateTests < ActiveRecord::Migration
+def self.up
+  puts "UP-CreateTests"
+end
+
+def self.down
+  puts "DOWN-CreateTests"
+end
+end
+TXT
+    write "db/migrations2/20100509095816_create_tests2.rb", <<-TXT
+class CreateTests2 < ActiveRecord::Migration
+def self.up
+  puts "UP-CreateTests2"
+end
+
+def self.down
+  puts "DOWN-CreateTests2"
+end
+end
+TXT
+  end
+
+  before do
+    `rm -rf spec/tmp` if File.exist?('spec/tmp')
+    `mkdir spec/tmp`
+    write_rakefile
     write 'db/config.yml', <<-TXT
       development:
         adapter: sqlite3
@@ -55,65 +89,131 @@ describe 'Standalone migrations' do
   end
 
   describe 'db:new_migration' do
-    it "fails if i do not add a name" do
-      run("rake db:new_migration").should_not =~ /SUCCESS/
-    end
+    context "single migration path" do
+      it "fails if i do not add a name" do
+        run("rake db:new_migration").should_not =~ /SUCCESS/
+      end
 
-    it "generates a new migration with this name and timestamp" do
-      run("rake db:new_migration name=test_abc").should =~ %r{Created migration .*spec/tmp/db/migrations/\d+_test_abc\.rb}
-      run("ls db/migrations").should =~ /^\d+_test_abc.rb$/
+      it "generates a new migration with this name and timestamp" do
+        run("rake db:new_migration name=test_abc").should =~ %r{Created migration .*spec/tmp/db/migrations/\d+_test_abc\.rb}
+        run("ls db/migrations").should =~ /^\d+_test_abc.rb$/
+      end
+    end
+    
+    context "multiple migration paths" do
+      before do
+        write_rakefile %{t.migrations = "db/migrations", "db/migrations2"}
+      end
+      it "chooses the first path" do
+        run("rake db:new_migration name=test_abc").should =~ %r{Created migration .*db/migrations/\d+_test_abc\.rb}
+      end
     end
   end
 
   describe 'db:migrate' do
-    it "does nothing when no migrations are present" do
-      run("rake db:migrate").should =~ /SUCCESS/
-    end
+    context "single migration path" do
+      it "does nothing when no migrations are present" do
+        run("rake db:migrate").should =~ /SUCCESS/
+      end
 
-    it "migrates if i add a migration" do
-      run("rake db:new_migration name=xxx")
-      result = run("rake db:migrate")
-      result.should =~ /SUCCESS/
-      result.should =~ /Migrating to Xxx \(#{Time.now.year}/
+      it "migrates if i add a migration" do
+        run("rake db:new_migration name=xxx")
+        result = run("rake db:migrate")
+        result.should =~ /SUCCESS/
+        result.should =~ /Migrating to Xxx \(#{Time.now.year}/
+      end
+    end
+    
+    context "multiple migration paths" do
+      before do
+        write_multiple_migrations
+      end
+      it "runs the migrator on each migration path" do
+        result = run("rake db:migrate")
+        result.should =~ /Migrating to CreateTests \(#{Time.now.year}/
+        result.should =~ /Migrating to CreateTests2 \(#{Time.now.year}/
+      end
     end
   end
 
   describe 'db:migrate:down' do
-    it "migrates down" do
-      make_migration('xxx')
-      sleep 1
-      version = make_migration('yyy')
-      run 'rake db:migrate'
+    context "single migration path" do
+      it "migrates down" do
+        make_migration('xxx')
+        sleep 1
+        version = make_migration('yyy')
+        run 'rake db:migrate'
 
-      result = run("rake db:migrate:down VERSION=#{version}")
-      result.should =~ /SUCCESS/
-      result.should_not =~ /DOWN-xxx/
-      result.should =~ /DOWN-yyy/
-    end
+        result = run("rake db:migrate:down VERSION=#{version}")
+        result.should =~ /SUCCESS/
+        result.should_not =~ /DOWN-xxx/
+        result.should =~ /DOWN-yyy/
+      end
 
-    it "fails without version" do
-      make_migration('yyy')
-      result = run("rake db:migrate:down")
-      result.should_not =~ /SUCCESS/
+      it "fails without version" do
+        make_migration('yyy')
+        result = run("rake db:migrate:down")
+        result.should_not =~ /SUCCESS/
+      end
+    end
+    
+    context "multiple migration paths" do
+      before do
+        write_multiple_migrations
+      end
+      
+      it "runs down on the correct path" do
+        run 'rake db:migrate'
+        result = run 'rake db:migrate:down VERSION=20100509095815'
+        result.should =~ /DOWN-CreateTests/
+        result.should_not =~ /DOWN-CreateTests2/
+      end
+      
+      it "fails if migration number isn't found" do
+        run 'rake db:migrate'
+        result = run 'rake db:migrate:down VERSION=20100509095820'
+        result.should_not =~ /SUCCESS/
+        result.should =~ /wasn't found on path/
+      end
     end
   end
 
   describe 'db:migrate:up' do
-    it "migrates up" do
-      make_migration('xxx')
-      run 'rake db:migrate'
-      sleep 1
-      version = make_migration('yyy')
-      result = run("rake db:migrate:up VERSION=#{version}")
-      result.should =~ /SUCCESS/
-      result.should_not =~ /UP-xxx/
-      result.should =~ /UP-yyy/
-    end
+    context "single migration path" do
+      it "migrates up" do
+        make_migration('xxx')
+        run 'rake db:migrate'
+        sleep 1
+        version = make_migration('yyy')
+        result = run("rake db:migrate:up VERSION=#{version}")
+        result.should =~ /SUCCESS/
+        result.should_not =~ /UP-xxx/
+        result.should =~ /UP-yyy/
+      end
 
-    it "fails without version" do
-      make_migration('yyy')
-      result = run("rake db:migrate:up")
-      result.should_not =~ /SUCCESS/
+      it "fails without version" do
+        make_migration('yyy')
+        result = run("rake db:migrate:up")
+        result.should_not =~ /SUCCESS/
+      end
+    end
+  
+    context "multiple migration paths" do
+      before do
+        write_multiple_migrations
+      end
+      
+      it "runs down on the correct path" do
+        result = run 'rake db:migrate:up VERSION=20100509095815'
+        result.should =~ /UP-CreateTests/
+        result.should_not =~ /UP-CreateTests2/
+      end
+      
+      it "fails if migration number isn't found" do
+        result = run 'rake db:migrate:up VERSION=20100509095820'
+        result.should_not =~ /SUCCESS/
+        result.should =~ /wasn't found on path/
+      end
     end
   end
 

data/standalone_migrations.gemspec

@@ -5,7 +5,7 @@
 
 Gem::Specification.new do |s|
   s.name = %q{standalone_migrations}
-  s.version = "0.2.5"
+  s.version = "0.3.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Todd Huss", "Michael Grosser"]

metadata

@@ -1,12 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: standalone_migrations
 version: !ruby/object:Gem::Version 
+  hash: 19
   prerelease: false
   segments: 
   - 0
-  - 2
-  - 5
-  version: 0.2.5
+  - 3
+  - 0
+  version: 0.3.0
 platform: ruby
 authors: 
 - Todd Huss
@@ -15,16 +16,18 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-04-12 00:00:00 +02:00
+date: 2010-04-12 00:00:00 -10:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: rake
   prerelease: false
   requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 3
         segments: 
         - 0
         version: "0"
@@ -34,9 +37,11 @@ dependencies:
   name: activerecord
   prerelease: false
   requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 3
         segments: 
         - 0
         version: "0"
@@ -72,23 +77,27 @@ 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.6
+rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
 summary: A thin wrapper to use Rails Migrations in non Rails projects