exodus 1.0.3 → 1.0.4

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+## v1.0.4
+
+* Custom migrations now runs in the given order
+
 ## v1.0.3
 
 * Bug fix -- rake needs to be required in exodus.rake

data/README.md

@@ -18,7 +18,7 @@ Exodus - a migration framework for MongoDb
   
   Add this line to your application's Gemfile:
 
-      $ gem 'exodus'
+      gem 'exodus'
 
   And then execute bundle install:
 
@@ -37,7 +37,7 @@ Exodus - a migration framework for MongoDb
     Exodus.configure do |config| 
       config.db = 'migration_db'
       config.connection = Mongo::MongoClient.new("127.0.0.1", 27017, :pool_size => 5, :pool_timeout => 5)
-      config.config_file = File.dirname(__FILE__) + '/config/config.yml'
+      config.config_file = File.dirname(__FILE__) + '/config/migrations.yml'
       config.migrations_directory = File.dirname(__FILE__) + '/models/migrations'
     end
 
@@ -132,17 +132,17 @@ Exodus - a migration framework for MongoDb
     rake db:rollback
     rake db:rollback STEP=2
 
-## db:migrate_custom
-  Executes all custom migrations that haven't run yet. You can pass custom migrations in parameters, otherwise custom migrations will be loaded from config/migration.yml. You can use an extra parameter to run only the last x ones.
+## db:migrate:custom
+  Executes all custom migrations that haven't run yet. Custom migrations will be loaded from your config file. Custom migrations will run in order of appearence. You can set the STEP enviroment variable to rollback only the last x ones.
 
-    rake db:migrate_custom
-    rake db:migrate_custom STEP=2
+    rake db:migrate:custom
+    rake db:migrate:custom STEP=2
 
-## db:rollback_custom
-  Executes all custom migrations that haven't run yet. You can pass custom migrations in parameters, otherwise custom migrations will be loaded from config/migration.yml. You can use an extra parameter to run only the last x ones.
+## db:rollback:custom
+  Executes all custom migrations that haven't run yet. Custom migrations will be loaded from your config file. Custom migrations will run in order of appearence. You can set the STEP enviroment variable to rollback only the last x ones.
 
-    rake db:rollback_custom
-    rake db:rollback_custom STEP=2
+    rake db:rollback:custom
+    rake db:rollback:custom STEP=2
 
 ## db:migrate:list
   Lists all the migrations.

data/lib/exodus.rb

@@ -27,15 +27,24 @@ module Exodus
 			File.dirname(__FILE__) + '/../tasks/exodus.rake'
 		end
 
-		# Executes a number of migrations equal to step (or all of them if step is nil)
-		def run_migrations(direction, migrations, step = nil)			
+		# Sorts and executes a number of migrations equal to step (or all of them if step is nil)
+		def run_sorted_migrations(direction, migrations, step = nil)			
 			if migrations
 				sorted_migrations = order_with_direction(migrations, direction)
-				sorted_migrations = sorted_migrations.shift(step.to_i) if step 
+				run_migrations(direction, sorted_migrations, step)
+			else
+				raise StandardError, "no migrations given in argument!"
+			end
+		end
+
 
-				run_each(direction, sorted_migrations)
+		# Executes a number of migrations equal to step (or all of them if step is nil)
+		def run_migrations(direction, migrations, step = nil)			
+			if migrations
+				migrations = migrations.shift(step.to_i) if step 
+				run_each(direction, migrations)
 			else
-				puts "no migrations given in argument!"
+				puts "Unable to find migrations!"
 			end
 		end
 
@@ -57,16 +66,13 @@ module Exodus
 		  end
 	  end
 
-	  # Looks up in the database if a migration with the same class and same arguments already exists
+	  
 	  # Otherwise instanciate a new one
 	  # Runs the migration if it is runnable
 	  def run_one_migration(migration_class, direction, args)
-	  	# Going throught MRD because MM request returns nil for some reason
-	  	current_migration = migration_class.load(migration_class.collection.find('status.arguments' => args).first)
-	  	current_migration ||= migration_class.new(:status => {:arguments => args})
+	  	current_migration = find_existing_migration(migration_class, args) || migration_class.new(:status => {:arguments => args})
 
 	  	if current_migration.is_runnable?(direction)
-	  		# Make sure we save all info in case of a failure 
 	  		begin
 	  			current_migration.run(direction)
 	  			current_migration.status.error = nil
@@ -82,6 +88,16 @@ module Exodus
 	    end
 	  end
 
+	  # Looks up in the database if a migration with the same class and same arguments already exists
+	  # Returns nil or the migration if one is found
+	  def find_existing_migration(migration_class, args)
+	  	existing_migrations = migration_class.collection.find('status.arguments' => args)
+	  	existing_migrations.detect do |migration|
+	  		existing_migration = migration_class.load(migration)
+				return existing_migration if existing_migration.is_a?(migration_class)
+	  	end
+	  end
+
 	  private
 
 	  # Prints tabulation before execting a given block

data/lib/exodus/version.rb

@@ -1,3 +1,3 @@
 module Exodus
-  VERSION = "1.0.3"
+  VERSION = "1.0.4"
 end

data/spec/exodus/exodus_spec.rb

@@ -0,0 +1,236 @@
+require "spec_helper"
+
+describe Exodus do 
+  describe "sort_migrations" do 
+  	before do
+      class Migration_test4 < Exodus::Migration; end
+      class Migration_test3 < Exodus::Migration; end
+
+      Migration_test3.migration_number = 3
+      Migration_test4.migration_number = 4
+    end
+
+    it "migrations should not be sorted by default" do 
+      unsorted_migrations = Exodus::Migration.load_all([])
+      migrations_numbers = unsorted_migrations.map {|migration, args| migration.migration_number }
+
+      migrations_numbers.should_not == migrations_numbers.sort          
+    end
+
+    it "should return the migrations sorted by migration number" do 
+      unsorted_migrations = Exodus::Migration.load_all([])
+      migrations_numbers = unsorted_migrations.map {|migration, args| migration.migration_number }
+
+      sorted_migrations = Exodus::sort_migrations(unsorted_migrations)
+      sorted_migrations_numbers = sorted_migrations.map {|migration, args| migration.migration_number }
+      sorted_migrations_numbers.should == migrations_numbers.sort          
+    end
+  end
+
+  describe "order_with_direction" do 
+  	before do
+      class Migration_test4 < Exodus::Migration; end
+      class Migration_test3 < Exodus::Migration; end
+      class Migration_test5 < Exodus::Migration; end
+
+      Migration_test3.migration_number = 3
+      Migration_test4.migration_number = 4
+      Migration_test5.migration_number = 5
+
+      unsorted_migrations = Exodus::Migration.load_all([])
+	    @migrations_numbers = unsorted_migrations.map {|migration, args| migration.migration_number }
+
+	    sorted_migrations = Exodus.order_with_direction(unsorted_migrations, 'up')
+	    @ordered_up = sorted_migrations.map {|migration, args| migration.migration_number }
+
+			sorted_migrations = Exodus.order_with_direction(unsorted_migrations, 'down')
+	    @ordered_down = sorted_migrations.map {|migration, args| migration.migration_number }
+    end
+
+    describe "when direction is UP" do
+	    it "should be sorted ascendingly" do 
+	      @ordered_up.should == @migrations_numbers.sort    
+	    end
+	  end
+
+    describe "when direction is UP" do
+	    it "should be sorted ascendingly" do 
+	      @ordered_down.should == @migrations_numbers.sort.reverse    
+	    end
+	  end
+  end
+
+  describe "tasks" do 
+  	it "should return the current path of exodus.rake" do
+  		rake_file = Pathname.new(File.dirname(__FILE__) + '/../../tasks/exodus.rake')
+  		Pathname.new(Exodus.tasks).realpath.to_s.should == rake_file.realpath.to_s
+  	end 
+  end
+
+  describe "run_one_migration" do
+    before do
+      class Migration_test6 < Exodus::Migration
+        def up 
+          'valid'
+        end
+      end
+      class Migration_test7 < Exodus::Migration
+        def up 
+          raise StandardError, "the current migration failed"
+        end
+      end
+    end
+
+    before :each do
+      Exodus::Migration.collection.drop
+    end
+
+    describe "When the migration has not been ran" do 
+      describe "with a valid migration" do 
+        it "should successfully create the migration" do 
+          lambda{ Exodus.run_one_migration(Migration_test6, 'up', {})}.should 
+          change {Exodus::Migration}.by(1)
+        end
+      end
+
+      describe "with a failing migration" do 
+        it "should raise an error" do 
+          lambda{ Exodus.run_one_migration(Migration_test7, 'up', {})}.should
+          raise_error(StandardError) 
+        end
+
+        it "should create the migration" do 
+          lambda{ Exodus.run_one_migration(Migration_test7, 'up', {})}.should
+          change {Exodus::Migration}.by(1)
+        end
+      end
+    end
+
+    describe "When the migration has been ran" do 
+      describe "with a valid migration" do 
+        it "should not create a new migration" do 
+          Exodus.run_one_migration(Migration_test6, 'up', {})
+
+          lambda{ Exodus.run_one_migration(Migration_test6, 'up', {})}.should 
+          change {Exodus::Migration}.by(0)
+        end
+      end
+
+      describe "with a failing migration" do 
+        it "should not create a new migration" do 
+          Exodus.run_one_migration(Migration_test7, 'up', {}) rescue nil
+
+          lambda{ Exodus.run_one_migration(Migration_test7, 'up', {})}.should 
+          change {Exodus::Migration}.by(0)
+        end
+      end
+    end
+  end
+
+  describe "find_existing_migration" do
+    before do
+      class Migration_test6 < Exodus::Migration
+        def up 
+          'valid'
+        end
+      end
+      class Migration_test8 < Exodus::Migration
+        def up 
+          'valid'
+        end
+      end
+    end
+
+    before :each do
+      Exodus::Migration.collection.drop
+    end
+
+    describe "When no migrations have been ran" do 
+      it "should not find any migration" do 
+        Exodus.find_existing_migration(Migration_test8, {}).should be_nil
+      end
+    end
+
+    describe "When a different migration has been ran" do 
+      it "should not find any migration" do 
+        Exodus.run_one_migration(Migration_test6, 'up', {})
+        Exodus.find_existing_migration(Migration_test8, {}).should be_nil
+      end
+    end
+
+    describe "When the migration has been ran" do 
+      it "should find the migration" do 
+        Exodus.run_one_migration(Migration_test8, 'up', {})
+        Exodus.find_existing_migration(Migration_test8, {}).class.should == Migration_test8
+      end
+    end
+
+    describe "When all migrations have been ran" do 
+      it "should find the migration" do 
+        Exodus.run_one_migration(Migration_test6, 'up', {})
+        Exodus.run_one_migration(Migration_test8, 'up', {})
+        Exodus.find_existing_migration(Migration_test8, {}).class.should == Migration_test8
+      end
+    end
+  end
+
+  describe "run_migrations and run_sorted_migrations" do
+    before do
+      class Migration_test9 < Exodus::Migration
+        @migration_number = 9
+        def up 
+          UserSupport.create!({:name => "Thomas"})
+        end
+      end
+      class Migration_test10 < Exodus::Migration
+        @migration_number = 10
+        def up 
+          UserSupport.create!({:name => "Tester"})
+        end
+      end
+    end
+
+    before :each do 
+      UserSupport.collection.drop
+      Exodus::Migration.collection.drop
+    end
+
+    describe "running the same migration in a different order with run_migrations" do 
+      it "should successfully run them in different order" do
+        migrations = [[Migration_test9, {}], [Migration_test10, {}]] 
+        Exodus.run_migrations('up', migrations)
+        users = UserSupport.all
+
+        users.first.name.should == "Thomas"
+        users.last.name.should == "Tester"
+
+        UserSupport.collection.drop
+        Exodus::Migration.collection.drop
+        Exodus.run_migrations('up', migrations.reverse)
+        users = UserSupport.all
+
+        users.first.name.should == "Tester"
+        users.last.name.should == "Thomas"
+      end
+    end
+
+    describe "running the same migration in a different order with run_sorted_migrations" do 
+      it "should successfully run them in the same order" do
+        migrations = [[Migration_test9, {}], [Migration_test10, {}]] 
+        Exodus.run_sorted_migrations('up', migrations)
+        users = UserSupport.all
+
+        users.first.name.should == "Thomas"
+        users.last.name.should == "Tester"
+
+        UserSupport.collection.drop
+        Exodus::Migration.collection.drop
+        Exodus.run_sorted_migrations('up', migrations.reverse)
+        users = UserSupport.all
+
+        users.first.name.should == "Thomas"
+        users.last.name.should == "Tester"
+      end
+    end
+  end
+end

data/spec/exodus/migration_spec.rb

@@ -1,5 +1,4 @@
 require "spec_helper"
-require File.dirname(__FILE__) + "/../../lib/exodus"
 
 describe Exodus::Migration do
 
@@ -173,15 +172,4 @@ describe Exodus::Migration do
       end
     end
   end
-
-  describe "MigrationFramework" do 
-    describe "sort_migrations" do 
-      it "should return the migrations sorted by migration number" do 
-        CompleteNewMigration.migration_number = 10
-        sorted_migrations = Exodus::sort_migrations(Exodus::Migration.load_all([]))
-        migrations_number = sorted_migrations.map {|migration, args| migration.migration_number }
-        migrations_number.should == migrations_number.sort          
-      end
-    end
-  end
 end

data/tasks/exodus.rake

@@ -22,7 +22,7 @@ namespace :db do
   task :migrate => :require_env do 
     time_it "db:migrate#{" step #{step}" if step}" do 
       migrations = Exodus::Migration.load_all(Exodus.migrations_info.migrate)
-      Exodus::run_migrations('up', migrations, step)
+      Exodus::run_sorted_migrations('up', migrations, step)
     end
   end
 
@@ -30,7 +30,7 @@ namespace :db do
   task :rollback => :require_env do 
     time_it "db:rollback#{" step #{step}" if step}" do 
       migrations = Exodus::Migration.load_all(Exodus.migrations_info.rollback)
-      Exodus::run_migrations('down', migrations, step)
+      Exodus::run_sorted_migrations('down', migrations, step)
     end
   end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: exodus
 version: !ruby/object:Gem::Version
-  version: 1.0.3
+  version: 1.0.4
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-05-29 00:00:00.000000000 Z
+date: 2013-06-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mongo_mapper
@@ -99,6 +99,7 @@ files:
 - lib/exodus/migrations/migration_error.rb
 - lib/exodus/migrations/migration_status.rb
 - lib/exodus/version.rb
+- spec/exodus/exodus_spec.rb
 - spec/exodus/migration_spec.rb
 - spec/spec_helper.rb
 - spec/support/config.yml
@@ -130,6 +131,7 @@ signing_key:
 specification_version: 3
 summary: Exodus uses mongomapper to provide a complete migration framework
 test_files:
+- spec/exodus/exodus_spec.rb
 - spec/exodus/migration_spec.rb
 - spec/spec_helper.rb
 - spec/support/config.yml