mongrations 0.2

data/.gitignore

@@ -0,0 +1,2 @@
+*.swp
+*~

data/Gemfile

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

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010 [name of plugin creator]
+
+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.markdown

@@ -0,0 +1,67 @@
+Mongrations
+===========
+
+Mongrations aims to be similar to ActiveRecord's data migrations, except
+instead of worrying about schema changes, offering a way to change data when
+necessary.
+
+Example: You decide after a few weeks of running an application that you want
+to add timestamps, and want to display the created_at time for an application.
+
+You could put a default timestamp into the model (and in this case that might
+be appropriate), but you might also just want to say, "everything needs to get
+a new timestamp that doesn't already have one, let's say when the US beat
+Canada in hockey in the Olympics."
+
+Installation
+============
+
+If you're using Rails 2:
+
+`gem install mongrations`
+
+In your environment.rb:
+
+`config.gem "mongrations"`
+
+If you're using Rails 3/Bundler, just add:
+
+`gem "mongrations"`
+
+to your Gemfile.
+
+In both cases, open your Rakefile, and add:
+
+`require 'mongrations/tasks'`
+
+Example
+=======
+
+To generate a mongration, just do:
+
+`script/generate mongration whatever_you_want_your_mongration_to_be`
+
+To run it, do
+
+`rake mongo:mongrate`
+
+Other rake tasks added have been `mongo:mongrate:redo`, `mongo:mongrate:up`, `mongo:mongrate:down`, `mongo:mongrate:rollback`.
+
+
+Dependencies
+============
+
+You need Mongo and MongoMapper for this to be of any use. Shoulda and Matchy are required to run the tests.
+
+Credit
+======
+Original code is from Rails 2.3.5 and ActiveRecord 2.3.5, now adapted to work
+with MongoMapper
+
+Original adaptation by terrbear.
+
+Fixed to work with recent versions of MongoMapper and released as a gem by Chris Heald.
+
+License
+=======
+Released under the MIT license

data/Rakefile

@@ -0,0 +1,25 @@
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+desc 'Default: run unit tests.'
+task :default => :test
+
+desc 'Test the mongrations plugin.'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end
+
+desc 'Generate documentation for the mongrations plugin.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Mongrations'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/generators/mongration/mongration_generator.rb

@@ -0,0 +1,15 @@
+Rails::Generator::Commands::Base.class_eval do
+  def next_migration_string(padding = 3)
+    Time.now.utc.strftime("%Y%m%d%H%M%S")
+  end
+end
+
+class MongrationGenerator < Rails::Generator::NamedBase
+
+	def manifest
+		record do |m|
+			m.directory File.join('db/mongrations')
+			m.migration_template 'mongration.rb', 'db/mongrations'
+		end
+	end
+end

data/generators/mongration/templates/mongration.rb

@@ -0,0 +1,7 @@
+class <%= class_name.underscore.camelize %> < MongoMapper::Mongration
+  def self.up
+  end
+
+  def self.down
+  end
+end

data/lib/mongrations.rb

@@ -0,0 +1,6 @@
+require 'mongo_mapper'
+require 'mongrations/exceptions'
+require 'mongrations/mongration'
+require 'mongrations/migration_proxy'
+require 'mongrations/migrator'
+require 'mongrations/schema_migration'

data/lib/mongrations/exceptions.rb

@@ -0,0 +1,31 @@
+module MongoMapper
+  class MongoMapperError < StandardError; end
+
+  class IrreversibleMigration < MongoMapperError#:nodoc:
+  end
+
+  class DuplicateMigrationVersionError < MongoMapperError#:nodoc:
+    def initialize(version)
+      super("Multiple migrations have the version number #{version}")
+    end
+  end
+
+  class DuplicateMigrationNameError < MongoMapperError#:nodoc:
+    def initialize(name)
+      super("Multiple migrations have the name #{name}")
+    end
+  end
+
+  class UnknownMigrationVersionError < MongoMapperError #:nodoc:
+    def initialize(version)
+      super("No migration with version number #{version}")
+    end
+  end
+
+  class IllegalMigrationNameError < MongoMapperError#:nodoc:
+    def initialize(name)
+      super("Illegal name for migration file: #{name}\n\t(only lower case letters, numbers, and '_' allowed)")
+    end
+  end
+end
+

data/lib/mongrations/migration_proxy.rb

@@ -0,0 +1,22 @@
+# MigrationProxy is used to defer loading of the actual migration classes
+# until they are needed
+module MongoMapper
+  class MigrationProxy
+
+    attr_accessor :name, :version, :filename
+
+    delegate :migrate, :announce, :write, :to=>:migration
+
+    private
+
+      def migration
+        @migration ||= load_migration
+      end
+
+      def load_migration
+        load(filename)
+        name.constantize
+      end
+
+  end
+end

data/lib/mongrations/migrator.rb

@@ -0,0 +1,169 @@
+module MongoMapper
+  class Migrator #:nodoc:
+    class << self
+      def migrate(migrations_path, target_version = nil)
+        case
+        when target_version.nil? then
+          up(migrations_path, target_version)
+        when current_version > target_version then
+          down(migrations_path, target_version)
+        else
+          up(migrations_path, target_version)
+        end
+      end
+
+      def rollback(migrations_path, steps=1)
+        migrator    = self.new(:down, migrations_path)
+        start_index = migrator.migrations.index(migrator.current_migration)
+
+        return unless start_index
+
+        finish = migrator.migrations[start_index + steps]
+        down(migrations_path, finish ? finish.version : 0)
+      end
+
+      def up(migrations_path, target_version = nil)
+        self.new(:up, migrations_path, target_version).migrate
+      end
+
+      def down(migrations_path, target_version = nil)
+        self.new(:down, migrations_path, target_version).migrate
+      end
+
+      def run(direction, migrations_path, target_version)
+        self.new(direction, migrations_path, target_version).run
+      end
+
+      def get_all_versions
+        MongoMapper::SchemaMigration.all.map { |sm| sm.version.to_i }.sort
+      end
+
+      def current_version
+        get_all_versions.max || 0
+      end
+
+      def proper_table_name(name)
+        name.table_name rescue name.to_s
+      end
+    end
+
+    def initialize(direction, migrations_path, target_version = nil)
+      target_version = target_version.to_i unless target_version.nil?
+      @direction, @migrations_path, @target_version = direction, migrations_path, target_version
+    end
+
+    def current_version
+      migrated.last || 0
+    end
+
+    def current_migration
+      migrations.detect { |m| m.version == current_version }
+    end
+
+    def run
+      target = migrations.detect { |m| m.version == @target_version }
+      raise UnknownMigrationVersionError.new(@target_version) if target.nil?
+      unless (up? && migrated.include?(target.version.to_i)) || (down? && !migrated.include?(target.version.to_i))
+        target.migrate(@direction)
+        record_version_state_after_migrating(target.version)
+      end
+    end
+
+    def migrate
+      current = migrations.detect { |m| m.version == current_version }
+      target  = migrations.detect { |m| m.version == @target_version }
+
+      if target.nil? && !@target_version.nil? && @target_version > 0
+        raise UnknownMigrationVersionError.new(@target_version)
+      end
+
+      start    = up? ? 0 : (migrations.index(current) || 0)
+      finish   = migrations.index(target) || migrations.size - 1
+      runnable = migrations[start..finish]
+
+      # skip the last migration if we're headed down, but not ALL the way down
+      runnable.pop if down? && !target.nil?
+
+      runnable.each do |migration|
+        # On our way up, we skip migrating the ones we've already migrated
+        next if up? && migrated.include?(migration.version.to_i)
+
+        # On our way down, we skip reverting the ones we've never migrated
+        if down? && !migrated.include?(migration.version.to_i)
+          migration.announce 'never migrated, skipping'; migration.write
+          next
+        end
+
+        migration.migrate(@direction)
+        record_version_state_after_migrating(migration.version)
+      end
+    end
+
+    def migrations
+      @migrations ||= begin
+        files      = Dir["#{@migrations_path}/[0-9]*_*.rb"]
+
+        migrations = files.inject([]) do |klasses, file|
+          version, name = file.scan(/([0-9]+)_([_a-z0-9]*).rb/).first
+
+          raise IllegalMigrationNameError.new(file) unless version
+          version = version.to_i
+
+          if klasses.detect { |m| m.version == version }
+            raise DuplicateMigrationVersionError.new(version)
+          end
+
+          if klasses.detect { |m| m.name == name.camelize }
+            raise DuplicateMigrationNameError.new(name.camelize)
+          end
+
+          klasses << MigrationProxy.new.tap do |migration|
+            migration.name     = name.camelize
+            migration.version  = version
+            migration.filename = file
+          end
+        end
+
+        migrations = migrations.sort_by(&:version)
+        down? ? migrations.reverse : migrations
+      end
+    end
+
+    def pending_migrations
+      already_migrated = migrated
+      migrations.reject { |m| already_migrated.include?(m.version.to_i) }
+    end
+
+    def migrated
+      @migrated_versions ||= self.class.get_all_versions
+    end
+
+    private
+
+    def record_version_state_after_migrating(version)
+      @migrated_versions ||= []
+      if down?
+        @migrated_versions.delete(version.to_i)
+        sm = MongoMapper::SchemaMigration.find_by_version(version.to_s)
+        sm && sm.delete
+      else
+        @migrated_versions.push(version.to_i).sort!
+        MongoMapper::SchemaMigration.create(:version => version)
+      end
+    end
+
+    def up?
+      @direction == :up
+    end
+
+    def down?
+      @direction == :down
+    end
+
+    # Wrap the migration in a transaction only if supported by the adapter.
+    # (It's not.)
+    def ddl_transaction(&block)
+      block.call
+    end
+  end
+end

data/lib/mongrations/mongration.rb

@@ -0,0 +1,100 @@
+module MongoMapper
+  class Mongration
+    @@verbose = true
+    cattr_accessor :verbose
+
+    class << self
+      def up_with_benchmarks #:nodoc:
+        migrate(:up)
+      end
+
+      def down_with_benchmarks #:nodoc:
+        migrate(:down)
+      end
+
+      # Execute this migration in the named direction
+      def migrate(direction)
+        return unless respond_to?(direction)
+
+        case direction
+          when :up   then announce "migrating"
+          when :down then announce "reverting"
+        end
+
+        result = nil
+        time = Benchmark.measure { result = send("#{direction}_without_benchmarks") }
+
+        case direction
+          when :up   then announce "migrated (%.4fs)" % time.real; write
+          when :down then announce "reverted (%.4fs)" % time.real; write
+        end
+
+        result
+      end
+
+      # Because the method added may do an alias_method, it can be invoked
+      # recursively. We use @ignore_new_methods as a guard to indicate whether
+      # it is safe for the call to proceed.
+      def singleton_method_added(sym) #:nodoc:
+        return if defined?(@ignore_new_methods) && @ignore_new_methods
+
+        begin
+          @ignore_new_methods = true
+
+          case sym
+            when :up, :down
+              klass = (class << self; self; end)
+              klass.send(:alias_method_chain, sym, "benchmarks")
+          end
+        ensure
+          @ignore_new_methods = false
+        end
+      end
+
+      def write(text="")
+        puts(text) if verbose
+      end
+
+      def announce(message)
+        text = "#{@version} #{name}: #{message}"
+        length = [0, 75 - text.length].max
+        write "== %s %s" % [text, "=" * length]
+      end
+
+      def say(message, subitem=false)
+        write "#{subitem ? "   ->" : "--"} #{message}"
+      end
+
+      def say_with_time(message)
+        say(message)
+        result = nil
+        time = Benchmark.measure { result = yield }
+        say "%.4fs" % time.real, :subitem
+        say("#{result} rows", :subitem) if result.is_a?(Integer)
+        result
+      end
+
+      def suppress_messages
+        save, self.verbose = verbose, false
+        yield
+      ensure
+        self.verbose = save
+      end
+
+      def connection
+        MongoMapper.connection
+      end
+
+      def method_missing(method, *arguments, &block)
+        arg_list = arguments.map(&:inspect) * ', '
+
+        say_with_time "#{method}(#{arg_list})" do
+          unless arguments.empty? || method == :execute
+            arguments[0] = Migrator.proper_table_name(arguments.first)
+          end
+          connection.send(method, *arguments, &block)
+        end
+      end
+    end
+  end
+end

data/lib/mongrations/schema_migration.rb

@@ -0,0 +1,8 @@
+module MongoMapper
+  class SchemaMigration
+    include MongoMapper::Document
+
+    key :version, String
+
+  end
+end

data/lib/mongrations/tasks.rb

@@ -0,0 +1,41 @@
+namespace :mongo do
+  @path = File.join(Rails.root, "db", "mongrations")
+
+  desc "Migrate the database through scripts in db/mongrations. Target specific version with VERSION=x."
+  task :mongrate => :environment do
+    MongoMapper::Migrator.migrate(@path, ENV["VERSION"] ? ENV["VERSION"].to_i : nil)
+  end
+
+  namespace :mongrate do
+    desc  'Rollbacks the database one mongration and re migrate up. If you want to rollback more than one step, define STEP=x. Target specific version with VERSION=x.'
+    task :redo => :environment do
+      if ENV["VERSION"]
+        Rake::Task["mongo:mongrate:down"].invoke
+        Rake::Task["mongo:mongrate:up"].invoke
+      else
+        Rake::Task["mongo:mongo_rollback"].invoke
+        Rake::Task["mongo:mongrate"].invoke
+      end
+    end
+
+    desc 'Runs the "up" for a given mongration VERSION.'
+    task :up => :environment do
+      version = ENV["VERSION"] ? ENV["VERSION"].to_i : nil
+      raise "VERSION is required" unless version
+      MongoMapper::Migrator.run(:up, @path, version)
+    end
+
+    desc 'Runs the "down" for a given mongration VERSION.'
+    task :down => :environment do
+      version = ENV["VERSION"] ? ENV["VERSION"].to_i : nil
+      raise "VERSION is required" unless version
+      MongoMapper::Migrator.run(:down, @path, version)
+    end
+
+    desc 'Rolls the schema back to the previous version. Specify the number of steps with STEP=n'
+    task :rollback => :environment do
+      step = ENV['STEP'] ? ENV['STEP'].to_i : 1
+      MongoMapper::Migrator.rollback(@path, step)
+    end    
+  end
+end

data/lib/mongrations/version.rb

@@ -0,0 +1,3 @@
+module Mongrations
+  VERSION = "0.2"
+end

data/mongrations.gemspec

@@ -0,0 +1,26 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "mongrations/version"
+
+Gem::Specification.new do |s|
+  s.name        = "mongrations"
+  s.version     = Mongrations::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Chris Heald", "terrbear"]
+  s.email       = ["cheald@gmail.com"]
+  s.homepage    = "https://github.com/cheald/mongrations"
+  s.summary     = %q{Rails-style migrations for MongoMapper}
+  s.description = %q{Rails-style migrations for MongoMapper}
+
+  s.rubyforge_project = "mongrations"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_development_dependency "shoulda"
+  s.add_development_dependency "matchy"
+
+  s.add_dependency "mongo_mapper"
+end

data/test/models/widget.rb

@@ -0,0 +1,6 @@
+class Widget
+  include MongoMapper::Document
+
+  key :price, Integer, :default => 0
+  key :name, String
+end

data/test/mongrations/20101125020919_fix_groupable_keys.rb

@@ -0,0 +1,15 @@
+class FixGroupableKeys < MongoMapper::Mongration
+  def self.up
+    Widget.find_each do |w|
+      w.price += 100
+      w.save
+    end
+  end
+
+  def self.down
+    Widget.find_each do |w|
+      w.price -= 100
+      w.save
+    end
+  end
+end

data/test/mongrations_test.rb

@@ -0,0 +1,63 @@
+require 'test_helper'
+
+class MongrationsTest < ActiveSupport::TestCase
+  context "A valid MongoMapper connection" do
+    setup do
+      MongoMapper.connection = Mongo::Connection.new
+      MongoMapper.database = "mongrations_test"
+      @path = File.join("test", "mongrations")
+      @version = "20101125020919"
+    end
+
+    context "with a valid database" do
+      context "with a pending migration" do
+        should "migrate up to a given version" do
+          Widget.create(:name => "Sparkling Wizzles", :price => 100)
+          Widget.first.price.should == 100
+          MongoMapper::Migrator.run(:up, @path, @version)
+          Widget.first.price.should == 200
+        end
+
+        should "run all pending migrations" do
+
+          Widget.create(:name => "Sparkling Wizzles", :price => 100)
+          Widget.first.price.should == 100
+          MongoMapper::Migrator.migrate(@path, nil)
+          Widget.first.price.should == 200
+        end
+      end
+
+      should "run a migration:down" do
+        Widget.create(:name => "Sparkling Wizzles", :price => 100)
+        Widget.first.price.should == 100
+        MongoMapper::Migrator.migrate(@path, nil)
+        Widget.first.price.should == 200
+        MongoMapper::Migrator.run(:down, @path, @version)
+        Widget.first.price.should == 100
+      end
+
+      should "run a migration rollback" do
+        Widget.create(:name => "Sparkling Wizzles", :price => 100)
+        Widget.first.price.should == 100
+        MongoMapper::Migrator.migrate(@path, nil)
+        Widget.first.price.should == 200
+        MongoMapper::Migrator.rollback(@path, 1)
+        Widget.first.price.should == 100
+      end
+
+      should "not run a migration more than once" do
+        Widget.create(:name => "Sparkling Wizzles", :price => 100)
+        Widget.first.price.should == 100
+        MongoMapper::Migrator.migrate(@path, nil)
+        Widget.first.price.should == 200
+        MongoMapper::Migrator.migrate(@path, nil)
+        Widget.first.price.should == 200
+      end
+    end
+
+    teardown do
+      # Not gonna remove it. For now.
+      # MongoMapper.connection.drop_database "mongrations_test"
+    end
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,22 @@
+require 'rubygems'
+require 'active_support'
+require 'active_support/test_case'
+require 'shoulda'
+require 'matchy'
+require 'mongo_mapper'
+require 'models/widget'
+require 'lib/mongrations'
+
+class ActiveSupport::TestCase
+  def teardown
+    MongoMapper.database.collections.each do |coll|
+      coll.remove
+    end
+  end
+
+  def inherited(base)
+    base.define_method teardown do
+      super
+    end
+  end
+end

metadata

@@ -0,0 +1,131 @@
+--- !ruby/object:Gem::Specification 
+name: mongrations
+version: !ruby/object:Gem::Version 
+  hash: 15
+  prerelease: false
+  segments: 
+  - 0
+  - 2
+  version: "0.2"
+platform: ruby
+authors: 
+- Chris Heald
+- terrbear
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-01-31 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: shoulda
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: matchy
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: mongo_mapper
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id003
+description: Rails-style migrations for MongoMapper
+email: 
+- cheald@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- MIT-LICENSE
+- README.markdown
+- Rakefile
+- generators/mongration/mongration_generator.rb
+- generators/mongration/templates/mongration.rb
+- lib/mongrations.rb
+- lib/mongrations/exceptions.rb
+- lib/mongrations/migration_proxy.rb
+- lib/mongrations/migrator.rb
+- lib/mongrations/mongration.rb
+- lib/mongrations/schema_migration.rb
+- lib/mongrations/tasks.rb
+- lib/mongrations/version.rb
+- mongrations.gemspec
+- test/models/widget.rb
+- test/mongrations/20101125020919_fix_groupable_keys.rb
+- test/mongrations_test.rb
+- test/test_helper.rb
+has_rdoc: true
+homepage: https://github.com/cheald/mongrations
+licenses: []
+
+post_install_message: 
+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: mongrations
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Rails-style migrations for MongoMapper
+test_files: 
+- test/models/widget.rb
+- test/mongrations/20101125020919_fix_groupable_keys.rb
+- test/mongrations_test.rb
+- test/test_helper.rb