mongoid_rails_5_migrations 1.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b340ce184447bd9109f4da7f29712499df5305d5
+  data.tar.gz: 1adc0417a8cba633ae84be4b0029726ec65f4fd7
+SHA512:
+  metadata.gz: 31f565040f832b82ea058861d6557d1028c685de3dc726e0438df10a1d2f999ee76d8dfb29bd9fb5b55176f07cfa3dd460fefb9a8e2451f4528fc927d6b0ac55
+  data.tar.gz: d084d79b1b4ef535f2eaf463af076b9409b3c78593b67b1cd95af394ff57040c7fd812540bde6b8aa01604f1bf7c1ca6a40b0340215332dbe7c8a95b657268d0

data/.gitignore

@@ -0,0 +1,6 @@
+.bundle
+.DS_Store
+.rvmrc
+.idea
+log/
+.ruby-version

data/Gemfile

@@ -0,0 +1,7 @@
+source "http://rubygems.org"
+gemspec :name => 'mongoid_rails_migrations'
+
+group :test do
+  gem 'minitest'
+  gem 'pry'
+end

data/Gemfile.lock

@@ -0,0 +1,132 @@
+PATH
+  remote: .
+  specs:
+    mongoid_rails_migrations (1.1.0)
+      activesupport (>= 4.2.0)
+      bundler (>= 1.0.0)
+      mongoid (>= 4.0.0)
+      rails (>= 4.2.0)
+      railties (>= 4.2.0)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    actionmailer (4.2.5.1)
+      actionpack (= 4.2.5.1)
+      actionview (= 4.2.5.1)
+      activejob (= 4.2.5.1)
+      mail (~> 2.5, >= 2.5.4)
+      rails-dom-testing (~> 1.0, >= 1.0.5)
+    actionpack (4.2.5.1)
+      actionview (= 4.2.5.1)
+      activesupport (= 4.2.5.1)
+      rack (~> 1.6)
+      rack-test (~> 0.6.2)
+      rails-dom-testing (~> 1.0, >= 1.0.5)
+      rails-html-sanitizer (~> 1.0, >= 1.0.2)
+    actionview (4.2.5.1)
+      activesupport (= 4.2.5.1)
+      builder (~> 3.1)
+      erubis (~> 2.7.0)
+      rails-dom-testing (~> 1.0, >= 1.0.5)
+      rails-html-sanitizer (~> 1.0, >= 1.0.2)
+    activejob (4.2.5.1)
+      activesupport (= 4.2.5.1)
+      globalid (>= 0.3.0)
+    activemodel (4.2.5.1)
+      activesupport (= 4.2.5.1)
+      builder (~> 3.1)
+    activerecord (4.2.5.1)
+      activemodel (= 4.2.5.1)
+      activesupport (= 4.2.5.1)
+      arel (~> 6.0)
+    activesupport (4.2.5.1)
+      i18n (~> 0.7)
+      json (~> 1.7, >= 1.7.7)
+      minitest (~> 5.1)
+      thread_safe (~> 0.3, >= 0.3.4)
+      tzinfo (~> 1.1)
+    arel (6.0.3)
+    bson (4.0.3)
+    builder (3.2.2)
+    coderay (1.1.1)
+    concurrent-ruby (1.0.1)
+    erubis (2.7.0)
+    globalid (0.3.6)
+      activesupport (>= 4.1.0)
+    i18n (0.7.0)
+    json (1.8.3)
+    loofah (2.0.3)
+      nokogiri (>= 1.5.9)
+    mail (2.6.3)
+      mime-types (>= 1.16, < 3)
+    method_source (0.8.2)
+    mime-types (2.99.1)
+    mini_portile2 (2.0.0)
+    minitest (5.8.4)
+    mongo (2.2.3)
+      bson (~> 4.0)
+    mongoid (5.1.1)
+      activemodel (~> 4.0)
+      mongo (~> 2.1)
+      origin (~> 2.2)
+      tzinfo (>= 0.3.37)
+    nokogiri (1.6.7.2)
+      mini_portile2 (~> 2.0.0.rc2)
+    origin (2.2.0)
+    pry (0.10.3)
+      coderay (~> 1.1.0)
+      method_source (~> 0.8.1)
+      slop (~> 3.4)
+    rack (1.6.4)
+    rack-test (0.6.3)
+      rack (>= 1.0)
+    rails (4.2.5.1)
+      actionmailer (= 4.2.5.1)
+      actionpack (= 4.2.5.1)
+      actionview (= 4.2.5.1)
+      activejob (= 4.2.5.1)
+      activemodel (= 4.2.5.1)
+      activerecord (= 4.2.5.1)
+      activesupport (= 4.2.5.1)
+      bundler (>= 1.3.0, < 2.0)
+      railties (= 4.2.5.1)
+      sprockets-rails
+    rails-deprecated_sanitizer (1.0.3)
+      activesupport (>= 4.2.0.alpha)
+    rails-dom-testing (1.0.7)
+      activesupport (>= 4.2.0.beta, < 5.0)
+      nokogiri (~> 1.6.0)
+      rails-deprecated_sanitizer (>= 1.0.1)
+    rails-html-sanitizer (1.0.3)
+      loofah (~> 2.0)
+    railties (4.2.5.1)
+      actionpack (= 4.2.5.1)
+      activesupport (= 4.2.5.1)
+      rake (>= 0.8.7)
+      thor (>= 0.18.1, < 2.0)
+    rake (10.5.0)
+    slop (3.6.0)
+    sprockets (3.5.2)
+      concurrent-ruby (~> 1.0)
+      rack (> 1, < 3)
+    sprockets-rails (3.0.3)
+      actionpack (>= 4.0)
+      activesupport (>= 4.0)
+      sprockets (>= 3.0.0)
+    thor (0.19.1)
+    thread_safe (0.3.5)
+    tzinfo (1.2.2)
+      thread_safe (~> 0.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  minitest
+  mongoid_rails_migrations!
+  pry
+  rake
+
+BUNDLED WITH
+   1.10.6

data/README.rdoc

@@ -0,0 +1,56 @@
+== RELEASE NOTES
+* The most current release, 1.1.x, targets Mongoid >= 4.0.0 and Rails >= 4.2.0 .
+* For Rails >= 3.2.0 and Mongoid >= 3.0.0, use version 1.0.0 .
+* For Rails >= 3.0.0 (but < 3.2.0) and Mongoid >= 2.0.0, use version 0.0.14 .
+
+== SYNOPSIS
+* Data migrations for Mongoid.
+
+== MIGRATE WHEN ...
+* The migrating is good
+
+== INSTALL
+* gem install mongoid_rails_migrations
+* In your Gemfile, include (after including mongoid):
+  gem "mongoid_rails_migrations", <version>
+
+== FEATURES AND HOW TO USE
+* generator:
+  * rails generate mongoid:migration your_migration_name_here
+
+* migrations:
+  * db:migrate
+  * db:migrate:down
+  * db:migrate:up
+  * db:rollback
+  * db:migrate:redo
+  * db:migrate:reset
+  * db:reseed (handled by mongoid)
+  * db:version
+
+== TESTING
+```rake test:mongoid:migrations```
+
+== CREDITS TO
+  * rails
+  * mongoid
+  * contributions from the community (git log)
+
+Much of this gem simply modifies existing code from both projects.
+With that out of the way, on to the license.
+
+== LICENSE (MIT)
+
+Copyright © 2013: Alan Da Costa
+
+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/Rakefile

@@ -0,0 +1,12 @@
+$:.unshift(File.dirname(__FILE__))
+
+task :default => ['test:mongoid:migrations']
+
+namespace :test do
+  namespace :mongoid do
+    desc "Test mongoid rails migrations"
+    task :migrations do
+      load 'test/migration_test.rb'
+    end
+  end
+end

data/lib/mongoid_rails_migrations.rb

@@ -0,0 +1,9 @@
+# encoding: utf-8
+
+require 'mongoid'
+
+require 'mongoid_rails_migrations/version'
+require 'mongoid_rails_migrations/models/data_migration'
+require 'mongoid_rails_migrations/mongoid_ext/mongoid'
+require 'mongoid_rails_migrations/mongoid_ext/railtie'
+require 'mongoid_rails_migrations/active_record_ext/migrations'

data/lib/mongoid_rails_migrations/active_record_ext/migrations.rb

@@ -0,0 +1,414 @@
+# encoding: utf-8
+
+module Mongoid #:nodoc
+  # Exception that can be raised to stop migrations from going backwards.
+  class IrreversibleMigration < RuntimeError
+  end
+
+  class DuplicateMigrationVersionError < RuntimeError#:nodoc:
+    def initialize(version)
+      super("Multiple migrations have the version number #{version}")
+    end
+  end
+
+  class DuplicateMigrationNameError < RuntimeError#:nodoc:
+    def initialize(name)
+      super("Multiple migrations have the name #{name}")
+    end
+  end
+
+  class UnknownMigrationVersionError < RuntimeError#:nodoc:
+    def initialize(version)
+      super("No migration with version number #{version}")
+    end
+  end
+
+  class IllegalMigrationNameError < RuntimeError#:nodoc:
+    def initialize(name)
+      super("Illegal name for migration file: #{name}\n\t(only lower case letters, numbers, and '_' allowed)")
+    end
+  end
+
+  # Data migrations can manage the modification of data. It's a solution to the common problem of modifying
+  # data between code revisions within a document oriented database.
+  #
+  # Example of simple migration for a system dependency:
+  #
+  #   class AddBaselineSurveySchema < Mongoid::Migration
+  #     def self.up
+  #       SurveySchema.create(:label => 'Baseline Survey')
+  #     end
+  #
+  #     def self.down
+  #       SurveySchema.where(:label => 'Baseline Survey').first.destroy
+  #     end
+  #   end
+  #
+  # == Timestamped Migrations
+  #
+  # By default, Rails generates migrations that look like:
+  #
+  #    20080717013526_your_migration_name.rb
+  #
+  # The prefix is a generation timestamp (in UTC).
+  #
+  # If you'd prefer to use numeric prefixes, you can turn timestamped migrations
+  # off by setting:
+  #
+  #    Mongoid.config.timestamped_migrations = false
+  #
+  # In environment.rb.
+  #
+  class Migration
+    @@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
+              singleton_class.send(:alias_method, "#{sym}_without_benchmarks".to_sym, sym)
+              singleton_class.send(:alias_method, sym, "#{sym}_with_benchmarks".to_sym)
+          end
+        ensure
+          @ignore_new_methods = false
+        end
+      end
+
+      def write(text="")
+        puts(text) if verbose
+      end
+
+      def announce(message)
+        version = defined?(@version) ? @version : nil
+
+        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
+        # ActiveRecord::Base.connection
+        if ::Mongoid.respond_to?(:default_client)
+          ::Mongoid.default_client
+        else
+          ::Mongoid.default_session
+        end
+      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
+
+  # MigrationProxy is used to defer loading of the actual migration classes
+  # until they are needed
+  class MigrationProxy
+
+    attr_accessor :name, :version, :filename
+
+    delegate :migrate, :announce, :write, :to=>:migration
+
+    private
+
+      def migration
+        @migration ||= load_migration
+      end
+
+      def load_migration
+        require(File.expand_path(filename))
+        name.constantize
+      end
+
+  end
+
+  class Migrator#:nodoc:
+    class << self
+      attr_writer :migrations_path
+
+      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)
+        move(:down, migrations_path, steps)
+      end
+
+      def forward(migrations_path, steps=1)
+        move(:up, migrations_path, steps)
+      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 migrations_path
+        @migrations_path ||= ['db/migrate']
+      end
+
+      # def schema_migrations_table_name
+      #   # Base.table_name_prefix + 'schema_migrations' + Base.table_name_suffix
+      #   'data_migrations'
+      # end
+
+      def get_all_versions
+        # table = Arel::Table.new(schema_migrations_table_name)
+        #         Base.connection.select_values(table.project(table['version']).to_sql).map(&:to_i).sort
+        DataMigration.all.map { |datamigration| datamigration.version.to_i }.sort
+      end
+
+      def current_version
+        # sm_table = schema_migrations_table_name
+        # if Base.connection.table_exists?(sm_table)
+        #   get_all_versions.max || 0
+        # else
+        #   0
+        # end
+        get_all_versions.max || 0
+      end
+
+      def proper_table_name(name)
+        # Use the Active Record objects own table_name, or pre/suffix from ActiveRecord::Base if name is a symbol/string
+        # name.table_name rescue "#{ActiveRecord::Base.table_name_prefix}#{name}#{ActiveRecord::Base.table_name_suffix}"
+        name
+      end
+
+      private
+
+      def move(direction, migrations_path, steps)
+        migrator = self.new(direction, migrations_path)
+        start_index = migrator.migrations.index(migrator.current_migration)
+
+        if start_index
+          finish = migrator.migrations[start_index + steps]
+          version = finish ? finish.version : 0
+          send(direction, migrations_path, version)
+        end
+      end
+    end
+
+    def initialize(direction, migrations_path, target_version = nil)
+      # raise StandardError.new("This database does not yet support migrations") unless Base.connection.supports_migrations?
+      # Base.connection.initialize_schema_migrations_table
+      @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|
+        Rails.logger.info "Migrating to #{migration.name} (#{migration.version})" if Rails.logger
+
+        # 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
+
+        # begin
+        #   ddl_transaction do
+        #     migration.migrate(@direction)
+        #     record_version_state_after_migrating(migration.version)
+        #   end
+        # rescue => e
+        #   canceled_msg = Base.connection.supports_ddl_transactions? ? "this and " : ""
+        #   raise StandardError, "An error has occurred, #{canceled_msg}all later migrations canceled:\n\n#{e}", e.backtrace
+        # end
+        begin
+          migration.migrate(@direction)
+          record_version_state_after_migrating(migration.version)
+        rescue => e
+          raise StandardError, "An error has occurred, #{migration.version} and all later migrations canceled:\n\n#{e}", e.backtrace
+        end
+      end
+    end
+
+    def migrations
+      @migrations ||= begin
+        files = Array(@migrations_path).inject([]) do |files, path|
+          files += Dir["#{path}/[0-9]*_*.rb"]
+        end
+
+        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
+
+          migration = MigrationProxy.new
+          migration.name     = name.camelize
+          migration.version  = version
+          migration.filename = file
+          klasses << migration
+        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)
+        # table = Arel::Table.new(self.class.schema_migrations_table_name)
+
+        @migrated_versions ||= []
+        # if down?
+        #   @migrated_versions.delete(version)
+        #   table.where(table["version"].eq(version.to_s)).delete
+        # else
+        #   @migrated_versions.push(version).sort!
+        #   table.insert table["version"] => version.to_s
+        # end
+        if down?
+          @migrated_versions.delete(version)
+          DataMigration.where(:version => version.to_s).first.destroy
+        else
+          @migrated_versions.push(version).sort!
+          DataMigration.create(:version => version.to_s)
+        end
+      end
+
+      def up?
+        @direction == :up
+      end
+
+      def down?
+        @direction == :down
+      end
+
+      # Wrap the migration in a transaction only if supported by the adapter.
+      def ddl_transaction(&block)
+        # if Base.connection.supports_ddl_transactions?
+        #   Base.transaction { block.call }
+        # else
+        #   block.call
+        # end
+        block.call
+      end
+  end
+end