exodus 1.0.0

data/.gitignore

@@ -0,0 +1,19 @@
+.DS_Store
+*/.DS_Store
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in exodus.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Thomas Dmytryk
+
+MIT License
+
+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.md

@@ -0,0 +1,145 @@
+Exodus - a migration framework for MongoDb
+=============
+
+# Intro 
+
+## A migration Framework for a schemaless database ???
+
+  After working with Mongo for long time now I can tell you it doesn't 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 in your collections; Especially when your code is live in production and used by millions of users. 
+
+  There is a plenty of way to modify documents data structure and after a deep reflexion I realized it makes more sens to use migration framework. A migration framework provides a lot of advantages, such as: 
+
+  * It allows you to know at any time which migration has been ran on any given system  
+  * 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
+
+
+# Installation
+
+    gem install exodus
+
+# Configuration
+
+  You need to configure 3 things before using Exodus: the database name, the mongodb connection and the config file location
+
+    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'
+    end
+
+  ... And you're all set!
+
+
+# Basic knowledge
+
+* All Migrations have to be ruby classes that inherits from Migration class. 
+* Migrations have a direction (UP or DOWN)
+* UP means the migration has been migrated
+* DOWN means the migration has not been run or has been rollbacked
+* All migrations have a current_status and status_complete
+* When current_status is equal to 0 it means the migration has not been run or has been succesfully rollbacked
+* When current_status is equal to status_complete it means the migration has been succefully migrated
+* We decided to keep track of migration by enumerating them.
+* 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
+
+* Give it a migration_number
+    class MyMigration < Exodus::Migration
+      self.migration_number = 1
+    end
+
+* Initialize it and define status_complete and description
+* Write the UP method that will be call when migrating the migration
+* Write the DOWN method that will be call when rolling back the migration
+* If your migration contains distinct steps that you want to split up I recommand using the "step" DSL
+
+
+## Good example
+
+    class RenameNameToFirstName < Exodus::Migration
+      self.migration_number = 1
+
+      def initialize(args = {})
+        super(args)
+        self.status_complete = 3
+        self.description = 'Change name to first_name'
+      end
+
+      def up
+        step("Creating first_name index", 1) do
+          puts Account.collection.ensure_index({:first_name => 1}, {:unique => true, :sparse => true})
+        end
+
+        step("Renaming", 2) do
+          puts Account.collection.update({'name' => {'$exists' => true}}, {'$rename' => {'name' => 'first_name'}},{:multi => true})
+        end
+
+        step("Dropping name index", 3) do
+          puts Account.collection.drop_index([[:name,1]])
+        end
+
+        self.status.message = "Migration Executed!"
+      end
+
+      def down
+        step("Creating name index", 2) do 
+          puts Account.collection.ensure_index({:name => 1}, {:unique => true, :sparse => true})
+        end
+
+        step("Renaming", 1) do 
+          puts Account.collection.update({'first_name' => {'$exists' => true}}, {'$rename' => {'first_name' => 'name'}},{:multi => true})
+        end
+
+        step("Dropping first_name index", 0) do 
+          puts Account.collection.drop_index([[:first_name,1]])
+        end
+
+        self.status.message = "Rollback Executed!"
+      end
+    end
+
+# Commands
+
+## 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
+  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
+  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.
+
+    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.
+
+    rake db:rollback_custom
+    rake db:rollback_custom STEP=2
+
+## db:migrate:list
+  Lists all the migrations.
+
+    rake db:migrate:list
+
+## db:migrate:status
+  Gives a preview of what as been run on the current database.
+
+    rake db:migrate:status
+
+## db:migrate:yml_status
+  Prints on the screen the content of the yml configuration file
+
+    rake db:migrate:status
+
+

data/Rakefile

@@ -0,0 +1,14 @@
+#!/usr/bin/env rake
+require 'rubygems'
+require 'rake'
+
+require 'rspec/core/rake_task'
+
+FileList.new(File.dirname(__FILE__) + '/tasks/*.rake').each { |file| import file }
+
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.rspec_opts = ["-c", "-f progress"]
+  spec.pattern = 'spec/**/*_spec.rb'
+end
+
+task :default => :spec

data/exodus.gemspec

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/exodus/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ['Thomas Dmytryk']
+  gem.email         = ['thomas@fanhattan.com', 'thomas.dmytryk@supinfo.com']
+  gem.description   = %q{Exodus is a migration framework for Mongo}
+  gem.summary       = %q{Exodus uses mongomapper to provide a complete migration framework}
+  gem.homepage      = ''
+  gem.license       = 'MIT'
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = 'exodus'
+  gem.require_paths = ['lib']
+  gem.version       = Exodus::VERSION
+
+  gem.add_dependency 'mongo_mapper'
+  gem.add_dependency 'bson_ext'
+  
+  gem.add_development_dependency 'rspec'
+  gem.add_development_dependency 'rake'
+end

data/lib/exodus.rb

@@ -0,0 +1,68 @@
+require 'mongo_mapper'
+Dir[File.dirname(__FILE__) + "/exodus/**/*.rb"].sort.each { |file| require file}
+
+module Exodus
+	class << self
+		attr_reader :migrations_info
+
+		def configuration
+		  @migrations_info ||= MigrationInfo.new
+		end
+
+		def configure
+		  yield(configuration) if block_given?
+		end
+
+		# Loads and runs a number of migrations equal to step (or all of them if step is nil)
+		def run_migrations(direction, migrations, step = nil)			
+			if migrations
+				sorted_migrations = sort_migrations(migrations)
+				sorted_migrations = order_with_direction(sorted_migrations, direction)
+				sorted_migrations = sorted_migrations.shift(step.to_i) if step 
+
+				sorted_migrations.each {|migration_class, args| run_each(migration_class, direction, args)} 
+			else
+				puts "no migrations given in argument!"
+			end
+		end
+
+	  def sort_migrations(migrations)
+	    migrations.sort_by {|migration,args| migration.migration_number }
+	  end
+
+	  def order_with_direction(migrations, direction)
+	  	direction == Migration::UP ? migrations : migrations.reverse 
+	  end
+
+	  def run_each(migration_class, direction, args = {})
+	  	puts "\n"
+	  	args ||= {}
+	  	
+	  	run_one_migration(migration_class, direction, args)
+	  	puts "\n"
+	  end
+
+	  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})
+
+	  	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
+	  		rescue Exception => e
+	  			current_migration.failure = e
+	  			current_migration.save!
+	  			raise
+	  		end
+
+	  		# save the migration
+	    	current_migration.save!
+	    else
+	    	puts "#{current_migration.class}#{current_migration.status.arguments}(#{direction}) as Already been run (or is not runnable)."
+	    end
+	  end
+	end
+end

data/lib/exodus/version.rb

@@ -0,0 +1,3 @@
+module Exodus
+  VERSION = "1.0.0"
+end

metadata

@@ -0,0 +1,119 @@
+--- !ruby/object:Gem::Specification
+name: exodus
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+  prerelease: 
+platform: ruby
+authors:
+- Thomas Dmytryk
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-05-27 00:00:00.000000000 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'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !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'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Exodus is a migration framework for Mongo
+email:
+- thomas@fanhattan.com
+- thomas.dmytryk@supinfo.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- exodus.gemspec
+- lib/exodus.rb
+- lib/exodus/version.rb
+homepage: ''
+licenses:
+- MIT
+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.8.23
+signing_key: 
+specification_version: 3
+summary: Exodus uses mongomapper to provide a complete migration framework
+test_files: []