exodus 1.0.6 → 1.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+--- 
+SHA1: 
+  metadata.gz: 200e6321b65c9da53640570039104a3431d9b01c
+  data.tar.gz: 3bfc62dbf17cb4e149fb0e05099f6cf90cbd7f40
+SHA512: 
+  metadata.gz: 93a228768b22948e1aa9d0901aafe751d855f807af5c136fc5e198277412e6b7172acd48a009fd066317e4f3a209e08330d26195dd9d19a1b6fbcf56d34dbff2
+  data.tar.gz: 7312deffd0e3ab6347ea390ab0d8374f3be0365eda5043450ea152be159b5d9c9818b01161f43c18857f851d6114a1855a0159d15ef83d5b4a4e60203304b513

data/.gitignore

@@ -17,3 +17,4 @@ spec/reports
 test/tmp
 test/version_tmp
 tmp
+TODO.md

data/CHANGELOG.md

@@ -1,3 +1,10 @@
+## v1.1.0
+
+* Changed the way migration are executed 
+* Cleaner output
+* Ability to see which migration will be executed before rake db:migrate and db:rollback with rake db:migrate:show and db:rollback:show
+* Fixed a text formatter issue
+
 ## v1.0.6
 
 * Text formatter bug fix

data/README.md

@@ -1,7 +1,7 @@
-Exodus - a migration framework for MongoDb
+Exodus - A migration framework for MongoDb
 =============
 
-# A migration Framework for a schemaless database?
+## A migration Framework for a schemaless database?
 
   After working with Mongo for long time now I can tell you working with a schemaless database does not mean you will never need any migrations. Within the same collection Mongo allows to have documents with a complete different structure, however in some case is you might want to keep data consistency; Especially when your code is live in production and used by millions of users. 
 
@@ -11,8 +11,9 @@ Exodus - a migration framework for MongoDb
   * It's Auto runnable on deploy
   * When switching enviromment (dev, pre-prod, prod) you don't need to worry if the script has been ran or not. The framework takes care of it for you
 
+  Exodus has been used in production since March 2013.
 
-# Installation
+## Installation
   
   Add this line to your application's Gemfile:
 
@@ -26,7 +27,7 @@ Exodus - a migration framework for MongoDb
 
     $ gem install exodus
 
-# Configuration
+## Configuration
 
   You need to configure 4 things before using Exodus: the database name, the mongodb connection, the config file location and the path to the directory that will include your migrations:
 
@@ -46,7 +47,7 @@ Exodus - a migration framework for MongoDb
   ... And you're all set!
 
 
-# Basic knowledge
+## Basic knowledge
 
 * All Migrations have to be ruby classes that inherits from Migration class. 
 * Migrations have a direction (UP or DOWN)
@@ -59,7 +60,7 @@ Exodus - a migration framework for MongoDb
 * Migrations will run in order using the migration_number
 * Migrations can be rerunnable safe, rerunnable safe migrations will run on each db:migrate even if the migration has already been run!
 
-## To Do when writting your own
+### To Do when writting your own
 
 * Give it a migration_number
 * Initialize it and define status_complete and description
@@ -68,7 +69,7 @@ Exodus - a migration framework for MongoDb
 * If your migration contains distinct steps that you want to split up I recommand using the "step" DSL
 
 
-## Good example
+### Good example
 
     class RenameNameToFirstName < Exodus::Migration
       self.migration_number = 1
@@ -112,48 +113,60 @@ Exodus - a migration framework for MongoDb
       end
     end
 
-# Commands
+## Commands
 
-## db:migrate
+### db:migrate
   Executes all migrations that haven't run yet. You can the STEP enviroment to run only the first x ones.
 
     rake db:migrate
     rake db:migrate STEP=2
 
-## db:rollback
+### db:rollback
   Rolls back all migrations that haven't run yet. You can set the STEP enviroment variable to rollback only the last x ones.
 
     rake db:rollback
     rake db:rollback STEP=2
 
-## db:migrate:custom
+### db:migrate:show
+  Print in the console all migrations that rake db:migrate will run. Does NOT run any migration. You can the STEP enviroment to run only the first x ones.
+
+    rake db:migrate:show
+    rake db:migrate:show STEP=2
+
+### db:rollback:show
+  Print in the console all migrations that rake db:rollback will run. Does NOT run any migration. You can set the STEP enviroment variable to rollback only the last x ones.
+
+    rake db:rollback:show
+    rake db:rollback:show STEP=2
+
+### 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
 
-## db:rollback:custom
+### 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
 
-## db:migrate:list
+### db:migrate:list
   Lists all the migrations.
 
     rake db:migrate:list
 
-## db:migrate:status
+### db:migrate:status
   Gives a preview of what as been run on the current database.
 
     rake db:migrate:status
 
-## db:migrate:yml_status
+### db:migrate:yml_status
   Prints on the screen the content of the yml configuration file
 
     rake db:migrate:yml_status
 
-## db:mongo_info
+### db:mongo_info
   Prints on the screen information about the current mongo connection
 
     rake db:mongo_info

data/lib/exodus.rb

@@ -29,64 +29,69 @@ module Exodus
 		end
 
 		# 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)
-				run_migrations(direction, sorted_migrations, step)
+		def sort_and_run_migrations(direction, migrations_info, step = nil, show_characteristic = false)			
+			if migrations_info
+				sorted_migrations_info = order_with_direction(migrations_info, direction)
+				runnable_migrations = find_runable_migrations(direction, sorted_migrations_info, step)
+
+				if show_characteristic 
+					runnable_migrations.map(&:characteristic)
+				else
+					run_migrations(direction, runnable_migrations)
+				end
 			else
 				raise StandardError, "no migrations given in argument!"
 			end
 		end
 
+		# Instanciates all of the migrations and returns the ones that are runnable
+		def find_runable_migrations(direction, migrations_info, step)
+	  	runnable_migrations = migrations_info.map do |migration_class, args| 
+	  		migration = instanciate_migration(migration_class, args)
+	  		migration if migration.is_runnable?(direction)
+	  	end.compact
 
-		# 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 "Unable to find migrations!"
-			end
-		end
+	  	step ? runnable_migrations.shift(step.to_i) : runnable_migrations
+	  end
 
 	  # Migrations order need to be reverted if the direction is down 
 	  # (we want the latest executed migration to be the first reverted)
-	  def order_with_direction(migrations, direction)
-	  	sorted_migrations = sort_migrations(migrations)
+	  def order_with_direction(migrations_info, direction)
+	  	sorted_migrations = sort_migrations(migrations_info)
 	  	direction == Migration::UP ? sorted_migrations : sorted_migrations.reverse 
 	  end
 
-	  def sort_migrations(migrations)
-	    migrations.sort_by {|migration,args| migration.migration_number }
+	  # Sorts migrations using the migration number
+	  def sort_migrations(migrations_info)
+	    migrations_info.sort_by {|migration,args| migration.migration_number }
 	  end
 
 	  # Runs each migration separately, migration's arguments default value is set to an empty hash
-	  def run_each(direction, migrations)
-	  	migrations.each do |migration_class, args|
-		  	print_tabulation { run_one_migration(migration_class, direction, args || {}) }
+	  def run_migrations(direction, migrations)
+	  	migrations.each do |migration|
+		  	print_tabulation { run_one_migration(migration, direction) }
 		  end
 	  end
-
 	  
-	  # Otherwise instanciate a new one
-	  # Runs the migration if it is runnable
-	  def run_one_migration(migration_class, direction, args)
-	  	current_migration = find_existing_migration(migration_class, args) || migration_class.new(:status => {:arguments => args})
-
-	  	if current_migration.is_runnable?(direction)
-	  		begin
-	  			current_migration.run(direction)
-	  			current_migration.status.error = nil
-	  		rescue Exception => e
-	  			current_migration.failure = e
-	  			current_migration.save!
-	  			raise
-	  		end
-
-	    	current_migration.save!
-	    else
-	    	puts "#{current_migration.class}#{current_migration.status.arguments}(#{direction}) as Already been run (or is not runnable)."
-	    end
+	  # Runs the migration and save the current status into mongo
+	  def run_one_migration(migration, direction)
+  		begin
+  			migration.run(direction)
+  			migration.status.error = nil
+  		rescue Exception => e
+  			migration.failure = e
+  			migration.save!
+  			raise
+  		end
+
+	    migration.save!
+	  end
+
+	  # Database lookup to find  a migration given its class and its arguments
+	  # Instanciates it if the migration is not present in the database 
+	  def instanciate_migration(migration_class, args)
+	  	args ||= {}
+	  	find_existing_migration(migration_class, args) || migration_class.new(:status => {:arguments => args})
 	  end
 
 	  # Looks up in the database if a migration with the same class and same arguments already exists
@@ -95,6 +100,7 @@ module Exodus
 	  	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

data/lib/exodus/helpers/text_formatter.rb

@@ -21,6 +21,7 @@ module Exodus
 
       paragraphes.each_with_index do |sentences, paragraph_number|
         sentences.each_with_index do |sentence, column|
+          sentence = sentence.to_s
           words = sentence.gsub('=>', ' => ').split(' ') || ''
           
           if sentence.size > space_number && (words).size > 1

data/lib/exodus/migrations/migration.rb

@@ -124,6 +124,10 @@ module Exodus
       (direction == UP && self.status.current_status == self.status_complete) || (direction == DOWN && self.status.current_status == 0)
     end
 
+    def characteristic
+      "#{self.class}: #{self.status.arguments}"
+    end
+
     protected
 
     # Executes a given block if the status has not being processed

data/lib/exodus/version.rb

@@ -1,3 +1,3 @@
 module Exodus
-  VERSION = "1.0.6"
+  VERSION = "1.1.0"
 end

data/spec/exodus/exodus_spec.rb

@@ -88,19 +88,22 @@ describe Exodus do
     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 
+          migration = Exodus.instanciate_migration(Migration_test6, {})
+          lambda{ Exodus.run_one_migration(migration, 'up')}.should 
           change {Exodus::Migration}.by(1)
         end
       end
 
       describe "with a failing migration" do 
+        let(:migration) {Exodus.instanciate_migration(Migration_test7, {})}
+
         it "should raise an error" do 
-          lambda{ Exodus.run_one_migration(Migration_test7, 'up', {})}.should
+          lambda {Exodus.run_one_migration(migration, 'up')}.should 
           raise_error(StandardError) 
         end
 
         it "should create the migration" do 
-          lambda{ Exodus.run_one_migration(Migration_test7, 'up', {})}.should
+          lambda {Exodus.run_one_migration(migration, 'up')}.should 
           change {Exodus::Migration}.by(1)
         end
       end
@@ -109,18 +112,20 @@ describe Exodus do
     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', {})
+          migration = Exodus.instanciate_migration(Migration_test6, {})
+          Exodus.run_one_migration(migration, 'up')
 
-          lambda{ Exodus.run_one_migration(Migration_test6, 'up', {})}.should 
+          lambda {Exodus.run_one_migration(migration, '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
+          migration = Exodus.instanciate_migration(Migration_test7, {})
+          Exodus.run_one_migration(migration, 'up') rescue nil
 
-          lambda{ Exodus.run_one_migration(Migration_test7, 'up', {})}.should 
+          lambda {Exodus.run_one_migration(migration, 'up')}.should 
           change {Exodus::Migration}.by(0)
         end
       end
@@ -153,28 +158,35 @@ describe Exodus do
 
     describe "When a different migration has been ran" do 
       it "should not find any migration" do 
-        Exodus.run_one_migration(Migration_test6, 'up', {})
+        migration = Exodus.instanciate_migration(Migration_test6, {})
+        Exodus.run_one_migration(migration, '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', {})
+        migration = Exodus.instanciate_migration(Migration_test8, {})
+        Exodus.run_one_migration(migration, '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', {})
+        migration6 = Exodus.instanciate_migration(Migration_test6, {})
+        migration8 = Exodus.instanciate_migration(Migration_test8, {})
+        Exodus.run_one_migration(migration6, 'up')
+        Exodus.run_one_migration(migration8, 'up')
+
         Exodus.find_existing_migration(Migration_test8, {}).class.should == Migration_test8
       end
     end
   end
 
-  describe "run_migrations and run_sorted_migrations" do
+  describe "run_migrations and sort_and_run_migrations" do
     before do
       class Migration_test9 < Exodus::Migration
         @migration_number = 9
@@ -197,7 +209,9 @@ describe Exodus do
 
     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, {}]] 
+        migrations_info = [[Migration_test9, {}], [Migration_test10, {}]]
+        migrations = migrations_info.map{|migration_info| Exodus.instanciate_migration(*migration_info)} 
+
         Exodus.run_migrations('up', migrations)
         users = UserSupport.all
 
@@ -214,10 +228,10 @@ describe Exodus do
       end
     end
 
-    describe "running the same migration in a different order with run_sorted_migrations" do 
+    describe "running the same migration in a different order with sort_and_run_migrations" do 
       it "should successfully run them in the same order" do
         migrations = [[Migration_test9, {}], [Migration_test10, {}]] 
-        Exodus.run_sorted_migrations('up', migrations)
+        Exodus.sort_and_run_migrations('up', migrations)
         users = UserSupport.all
 
         users.first.name.should == "Thomas"
@@ -225,12 +239,24 @@ describe Exodus do
 
         UserSupport.collection.drop
         Exodus::Migration.collection.drop
-        Exodus.run_sorted_migrations('up', migrations.reverse)
+        Exodus.sort_and_run_migrations('up', migrations.reverse)
         users = UserSupport.all
 
         users.first.name.should == "Thomas"
         users.last.name.should == "Tester"
       end
     end
+
+    describe "Getting migration information" do 
+      it "should successfully print the migrations information" do
+        migrations = [[Migration_test9, {}], [Migration_test10, {}]] 
+        Exodus.sort_and_run_migrations('up', migrations, nil, true).should == ["Migration_test9: #{{}}", "Migration_test10: #{{}}"]
+      end
+
+      it "should successfully print the first migration information" do
+        migrations = [[Migration_test9, {}], [Migration_test10, {}]] 
+        Exodus.sort_and_run_migrations('up', migrations, 1, true).should == ["Migration_test9: #{{}}"]
+      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_sorted_migrations('up', migrations, step)
+      Exodus::sort_and_run_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_sorted_migrations('down', migrations, step)
+      Exodus::sort_and_run_migrations('down', migrations, step)
     end
   end
 
@@ -40,6 +40,13 @@ namespace :db do
   end
 
   namespace :migrate do
+    desc "Show which migrations will be run when calling 'rake db:migrate'"
+    task :show => :require_env do 
+      migrations = Exodus::Migration.load_all(Exodus.migrations_info.migrate)
+      puts "List of all the migrations that will be executed by running 'rake db:rollback#{" STEP=#{step}" if step}': \n\n"
+      puts Exodus::sort_and_run_migrations('up', migrations, step, true)
+    end
+
     desc "Manually migrates specified migrations (specify migrations or use config/migration.yml)"
     task :custom, [:migrations_info] => :require_env do |t, args|
       time_it "db:migrate_custom#{" step #{step}" if step}" do 
@@ -49,7 +56,8 @@ namespace :db do
           Exodus::Migration.load_custom(Exodus.migrations_info.migrate_custom)
         end
 
-        Exodus::run_migrations('up', migrations, step)
+        migrations = migrations.shift(step.to_i) if step
+        Exodus::run_migrations('up', migrations)
       end
     end
 
@@ -70,6 +78,13 @@ namespace :db do
   end
 
   namespace :rollback do
+    desc "Show which migrations will be run when calling 'rake db:rollback'"
+    task :show => :require_env do 
+      migrations = Exodus::Migration.load_all(Exodus.migrations_info.migrate)
+      puts "List of all the migrations that will be executed by running 'rake db:rollback#{" STEP=#{step}" if step}': \n\n"
+      puts Exodus::sort_and_run_migrations('down', migrations, step, true)
+    end
+
     desc "Manually rolls the database back using specified migrations (specify migrations or use config/migration.yml)"
     task :custom, [:migrations_info] => :require_env do |t, args|
       time_it "db:rollback_custom#{" step #{step}" if step}" do 
@@ -79,7 +94,8 @@ namespace :db do
           Exodus::Migration.load_custom(Exodus.migrations_info.rollback_custom)
         end
 
-        Exodus::run_migrations('down', migrations, step)
+        migrations = migrations.shift(step.to_i) if step
+        Exodus::run_migrations('down', migrations)
       end
     end
   end

metadata

@@ -1,88 +1,62 @@
---- !ruby/object:Gem::Specification
+--- !ruby/object:Gem::Specification 
 name: exodus
-version: !ruby/object:Gem::Version
-  version: 1.0.6
-  prerelease: 
+version: !ruby/object:Gem::Version 
+  version: 1.1.0
 platform: ruby
-authors:
+authors: 
 - Thomas Dmytryk
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-08-04 00:00:00.000000000 Z
-dependencies:
-- !ruby/object:Gem::Dependency
+
+date: 2013-10-28 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
   name: mongo_mapper
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: bson_ext
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - &id002 
+      - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
   type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: bson_ext
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    requirements: 
+    - *id002
+  type: :runtime
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
   name: rspec
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    requirements: 
+    - *id002
   type: :development
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: rake
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    requirements: 
+    - *id002
+  type: :development
+  version_requirements: *id005
 description: Exodus is a migration framework for MongoDb
-email:
+email: 
 - thomas@fanhattan.com
 - thomas.dmytryk@supinfo.com
 executables: []
+
 extensions: []
+
 extra_rdoc_files: []
-files:
+
+files: 
 - .gitignore
 - .rspec
 - .rvmrc
@@ -107,31 +81,29 @@ files:
 - spec/support/user_support.rb
 - tasks/exodus.rake
 homepage: https://github.com/ThomasAlxDmy/Exodus
-licenses:
+licenses: 
 - MIT
+metadata: {}
+
 post_install_message: 
 rdoc_options: []
-require_paths:
+
+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'
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - *id002
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - *id002
 requirements: []
+
 rubyforge_project: 
-rubygems_version: 1.8.23
+rubygems_version: 2.0.13
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Exodus uses mongomapper to provide a complete migration framework
-test_files:
+test_files: 
 - spec/exodus/exodus_spec.rb
 - spec/exodus/migration_spec.rb
 - spec/spec_helper.rb