mongoid_rails_5_migrations 1.1.1

data/lib/mongoid_rails_migrations/models/data_migration.rb

@@ -0,0 +1,5 @@
+class DataMigration
+  include Mongoid::Document
+
+  field :version
+end

data/lib/mongoid_rails_migrations/mongoid_ext/mongoid.rb

@@ -0,0 +1,21 @@
+# encoding: utf-8
+module Mongoid
+  # Specify whether or not to use timestamps for migration versions
+  # NOTE: newer style is a module
+  # Config.module_eval would work for both but still need to determine the type
+  # that's why we do it the ug way.
+  if Config.is_a? Class
+    # older mongoid style; pre 2.0.0.rc.1
+    Config.module_eval do
+      cattr_accessor :timestamped_migrations
+      class_variable_set(:@@timestamped_migrations, true) unless class_variable_get(:@@timestamped_migrations)
+
+      def self.reset
+        @@timestamped_migrations = true
+      end
+    end
+  else # module
+    # newer mongoid style; >= 2.0.0.rc.1
+    Config.option :timestamped_migrations, :default => true
+  end
+end

data/lib/mongoid_rails_migrations/mongoid_ext/railtie.rb

@@ -0,0 +1,18 @@
+# encoding: utf-8
+
+if defined?(Rails::Railtie)
+  module Rails #:nodoc:
+    module Mongoid #:nodoc:
+      class Railtie < Rails::Railtie
+        if config.respond_to?(:app_generators)
+          config.app_generators.orm :mongoid, :migration => true
+        else
+          config.generators.orm :mongoid, :migration => true
+        end
+        rake_tasks do
+          load "mongoid_rails_migrations/mongoid_ext/railties/database.rake"
+        end
+      end
+    end
+  end
+end

data/lib/mongoid_rails_migrations/mongoid_ext/railties/database.rake

@@ -0,0 +1,93 @@
+namespace :db do
+  unless Rake::Task.task_defined?("db:drop")
+    desc 'Drops all the collections for the database for the current Rails.env'
+    task :drop => :environment do
+      Mongoid.master.collections.each {|col| col.drop_indexes && col.drop unless ['system.indexes', 'system.users'].include?(col.name) }
+    end
+  end
+
+  unless Rake::Task.task_defined?("db:seed")
+    # if another ORM has defined db:seed, don't run it twice.
+    desc 'Load the seed data from db/seeds.rb'
+    task :seed => :environment do
+      seed_file = File.join(Rails.application.root, 'db', 'seeds.rb')
+      load(seed_file) if File.exist?(seed_file)
+    end
+  end
+
+  unless Rake::Task.task_defined?("db:setup")
+    desc 'Create the database, and initialize with the seed data'
+    task :setup => [ 'db:create', 'db:seed' ]
+  end
+
+  unless Rake::Task.task_defined?("db:reseed")
+    desc 'Delete data and seed'
+    task :reseed => [ 'db:drop', 'db:seed' ]
+  end
+
+  unless Rake::Task.task_defined?("db:create")
+    task :create => :environment do
+      # noop
+    end
+  end
+
+  desc 'Current database version'
+  task :version => :environment do
+    puts Mongoid::Migrator.current_version.to_s
+  end
+
+  desc "Migrate the database through scripts in db/migrate. Target specific version with VERSION=x. Turn off output with VERBOSE=false."
+  task :migrate => :environment do
+    Mongoid::Migration.verbose = ENV["VERBOSE"] ? ENV["VERBOSE"] == "true" : true
+    Mongoid::Migrator.migrate(Mongoid::Migrator.migrations_path, ENV["VERSION"] ? ENV["VERSION"].to_i : nil)
+  end
+
+  namespace :migrate do
+    desc  'Rollback the database one migration 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["db:migrate:down"].invoke
+        Rake::Task["db:migrate:up"].invoke
+      else
+        Rake::Task["db:rollback"].invoke
+        Rake::Task["db:migrate"].invoke
+      end
+    end
+
+    desc 'Resets your database using your migrations for the current environment'
+    # should db:create be changed to db:setup? It makes more sense wanting to seed
+    task :reset => ["db:drop", "db:create", "db:migrate"]
+
+    desc 'Runs the "up" for a given migration VERSION.'
+    task :up => :environment do
+      version = ENV["VERSION"] ? ENV["VERSION"].to_i : nil
+      raise "VERSION is required" unless version
+      Mongoid::Migrator.run(:up, Mongoid::Migrator.migrations_path, version)
+    end
+
+    desc 'Runs the "down" for a given migration VERSION.'
+    task :down => :environment do
+      version = ENV["VERSION"] ? ENV["VERSION"].to_i : nil
+      raise "VERSION is required" unless version
+      Mongoid::Migrator.run(:down, Mongoid::Migrator.migrations_path, version)
+    end
+  end
+
+  desc 'Rolls the database back to the previous migration. Specify the number of steps with STEP=n'
+  task :rollback => :environment do
+    step = ENV['STEP'] ? ENV['STEP'].to_i : 1
+    Mongoid::Migrator.rollback(Mongoid::Migrator.migrations_path, step)
+  end
+
+  namespace :schema do
+    task :load do
+      # noop
+    end
+  end
+
+  namespace :test do
+    task :prepare do
+      # Stub out for MongoDB
+    end
+  end
+end

data/lib/mongoid_rails_migrations/version.rb

@@ -0,0 +1,3 @@
+module MongoidRailsMigrations #:nodoc:
+  VERSION = '1.1.1'
+end

data/lib/rails/generators/mongoid/migration/migration_generator.rb

@@ -0,0 +1,16 @@
+require 'rails/generators/mongoid/mongoid_generator'
+
+module Mongoid
+  module Generators
+    class MigrationGenerator < Base
+
+      def create_migration_file
+        migration_template "migration.rb", "db/migrate/#{file_name}.rb"
+      end
+
+      protected
+        attr_reader :migration_action
+
+    end
+  end
+end

data/lib/rails/generators/mongoid/migration/templates/migration.rb

@@ -0,0 +1,7 @@
+class <%= migration_class_name %> < Mongoid::Migration
+  def self.up
+  end
+
+  def self.down
+  end
+end

data/lib/rails/generators/mongoid/mongoid_generator.rb

@@ -0,0 +1,26 @@
+require 'rails/generators'
+
+module Mongoid #:nodoc:
+  module Generators #:nodoc:
+    class Base < ::Rails::Generators::NamedBase #:nodoc:
+      include Rails::Generators::Migration
+
+      # A simple redef is fine because rails caches this path on class.inherited
+      # mongoid uses @_mongoid_source_root ||=, but that's not necessary
+      def self.source_root
+        File.expand_path("../../#{base_name}/#{generator_name}/templates", __FILE__)
+      end
+
+      # Implement the required interface for Rails::Generators::Migration.
+      def self.next_migration_number(dirname) #:nodoc:
+        next_migration_number = current_migration_number(dirname) + 1
+        if Mongoid.configure.timestamped_migrations
+          [Time.now.utc.strftime("%Y%m%d%H%M%S"), "%.14d" % next_migration_number].max
+        else
+          "%.3d" % next_migration_number
+        end
+      end
+
+    end
+  end
+end

data/mongoid_rails_migrations.gemspec

@@ -0,0 +1,32 @@
+require File.join(File.dirname(__FILE__), 'lib', 'mongoid_rails_migrations', 'version')
+
+Gem::Specification.new do |s|
+  s.platform    = Gem::Platform::RUBY
+  s.name        = 'mongoid_rails_5_migrations'
+  s.version     = MongoidRailsMigrations::VERSION
+  s.summary     = 'TEMPORARY RAILS 5 SPECIFIC GEM. Data migrations for Mongoid in Active Record style, minus column input.'
+  s.license     = 'MIT'
+  s.description = 'TEMPORARY RAILS 5 SPECIFIC GEM. Migrations for the migrator.'
+
+  s.required_ruby_version     = '>= 1.8.6'
+  s.required_rubygems_version = '>= 1.3.6'
+
+  s.author            = 'Alan Da Costa'
+  s.email             = 'alandacosta@gmail.com'
+  s.date              = %q{2018-05-30}
+  s.homepage          = 'http://github.com/adacosta/mongoid_rails_migrations'
+
+  s.require_paths = ['lib']
+  s.files         = Dir['.gitignore', 'Gemfile', 'Gemfile.lock', 'Rakefile', 'README.rdoc', 'mongoid_rails_migrations.gemspec', 'lib/**/*']
+  s.test_files    = Dir['test/**/*']
+  s.has_rdoc      = false
+
+  rails_version = '>= 4.2.0'
+
+  s.add_runtime_dependency('bundler', '>= 1.0.0')
+  s.add_runtime_dependency('mongoid', '>= 4.0.0')
+  s.add_runtime_dependency('rails',  rails_version)
+  s.add_runtime_dependency('railties',  rails_version)
+  s.add_runtime_dependency('activesupport',  rails_version)
+  s.add_development_dependency 'rake'
+end

data/test/config.rb

@@ -0,0 +1,9 @@
+require File.join(File.dirname(__FILE__), '..', 'lib', 'mongoid_rails_migrations')
+require File.join(File.dirname(__FILE__), '..', 'lib', 'rails', 'generators', 'mongoid', 'mongoid_generator')
+
+Mongoid.configure.connect_to('mongoid_test')
+
+# require all models
+Dir[File.join(File.dirname(__FILE__), 'models', '*.rb')].each { |file| require file }
+
+MIGRATIONS_ROOT = File.join(File.dirname(__FILE__), 'migrations')

data/test/helper.rb

@@ -0,0 +1,34 @@
+$:.unshift(File.dirname(__FILE__))
+
+require 'bundler/setup'
+Bundler.require(:test)
+
+require 'mongoid'
+require 'config'
+require 'minitest/autorun'
+require 'rake'
+require 'rake/testtask'
+require 'rdoc/task'
+
+# leave out active_record, in favor of a monogo adapter
+%w(
+  action_controller
+  action_mailer
+  active_resource
+  rails/test_unit
+  mongoid
+).each do |framework|
+  begin
+    require "#{framework}/railtie"
+  rescue LoadError
+  end
+end
+
+
+ActiveSupport.test_order = :sorted if ActiveSupport.respond_to?(:test_order)
+
+module TestMongoidRailsMigrations
+  class Application < Rails::Application; end
+end
+
+TestMongoidRailsMigrations::Application.load_tasks

data/test/migration_test.rb

@@ -0,0 +1,164 @@
+require File.dirname(__FILE__) + '/helper'
+
+class Mongoid::Migration
+  class <<self
+    attr_accessor :message_count
+
+    def puts(text="")
+      self.message_count ||= 0
+      self.message_count += 1
+    end
+  end
+end
+
+module Mongoid
+  class TestCase < ActiveSupport::TestCase #:nodoc:
+
+    def setup
+      Mongoid::Migration.verbose = true
+      # same as db:drop command in lib/mongoid_rails_migrations/mongoid_ext/railties/database.rake
+      if Mongoid.respond_to?(:default_client)
+        Mongoid.default_client.database.drop
+      else
+        Mongoid.default_session.drop
+      end
+    end
+
+    def teardown; end
+
+    def test_drop_works
+      assert_equal 0, Mongoid::Migrator.current_version, "db:drop should take us down to version 0"
+    end
+
+    def test_migrations_path
+      assert_equal ["db/migrate"], Mongoid::Migrator.migrations_path
+
+      Mongoid::Migrator.migrations_path += ["engines/my_engine/db/migrate"]
+
+      assert_equal ["db/migrate", "engines/my_engine/db/migrate"], Mongoid::Migrator.migrations_path
+    end
+
+    def test_finds_migrations
+      assert Mongoid::Migrator.new(:up, MIGRATIONS_ROOT + "/valid").migrations.size == 2
+      assert_equal 2, Mongoid::Migrator.new(:up, MIGRATIONS_ROOT + "/valid").pending_migrations.size
+    end
+
+    def test_finds_migrations_in_multiple_paths
+      migration_paths = [MIGRATIONS_ROOT + "/valid", MIGRATIONS_ROOT + "/other_valid"]
+
+      assert Mongoid::Migrator.new(:up, migration_paths).migrations.size == 3
+      assert_equal 3, Mongoid::Migrator.new(:up, migration_paths).pending_migrations.size
+    end
+
+    def test_migrator_current_version
+      Mongoid::Migrator.migrate(MIGRATIONS_ROOT + "/valid", 20100513054656)
+      assert_equal(20100513054656, Mongoid::Migrator.current_version)
+    end
+
+    def test_migrator
+      assert SurveySchema.first.nil?, "All SurveySchemas should be clear before migration run"
+
+      Mongoid::Migrator.up(MIGRATIONS_ROOT + "/valid")
+
+      assert_equal 20100513063902, Mongoid::Migrator.current_version
+      assert !SurveySchema.first.nil?
+
+      Mongoid::Migrator.down(MIGRATIONS_ROOT + "/valid")
+      assert_equal 0, Mongoid::Migrator.current_version
+
+      assert SurveySchema.create(:label => 'Questionable Survey')
+      assert_equal 1, SurveySchema.all.size
+    end
+
+    def test_migrator_two_up_and_one_down
+      assert SurveySchema.where(:label => 'Baseline Survey').first.nil?
+      assert_equal 0, SurveySchema.all.size
+
+      Mongoid::Migrator.up(MIGRATIONS_ROOT + "/valid", 20100513054656)
+
+      assert !SurveySchema.where(:label => 'Baseline Survey').first.nil?
+      assert_equal 1, SurveySchema.all.size
+
+      assert SurveySchema.where(:label => 'Improvement Plan Survey').first.nil?
+
+      Mongoid::Migrator.up(MIGRATIONS_ROOT + "/valid", 20100513063902)
+      assert_equal 20100513063902, Mongoid::Migrator.current_version
+
+      assert !SurveySchema.where(:label => 'Improvement Plan Survey').first.nil?
+      assert_equal 2, SurveySchema.all.size
+
+      Mongoid::Migrator.down(MIGRATIONS_ROOT + "/valid", 20100513054656)
+      assert_equal 20100513054656, Mongoid::Migrator.current_version
+
+      assert SurveySchema.where(:label => 'Improvement Plan Survey').first.nil?
+      assert !SurveySchema.where(:label => 'Baseline Survey').first.nil?
+      assert_equal 1, SurveySchema.all.size
+    end
+
+    def test_finds_pending_migrations
+      Mongoid::Migrator.up(MIGRATIONS_ROOT + "/valid", 20100513054656)
+      pending_migrations = Mongoid::Migrator.new(:up, MIGRATIONS_ROOT + "/valid").pending_migrations
+
+      assert_equal 1, pending_migrations.size
+      assert_equal pending_migrations[0].version, 20100513063902
+      assert_equal pending_migrations[0].name, 'AddImprovementPlanSurveySchema'
+    end
+
+    def test_migrator_rollback
+      Mongoid::Migrator.migrate(MIGRATIONS_ROOT + "/valid")
+      assert_equal(20100513063902, Mongoid::Migrator.current_version)
+
+      Mongoid::Migrator.rollback(MIGRATIONS_ROOT + "/valid")
+      assert_equal(20100513054656, Mongoid::Migrator.current_version)
+
+      Mongoid::Migrator.rollback(MIGRATIONS_ROOT + "/valid")
+      assert_equal(0, Mongoid::Migrator.current_version)
+    end
+
+    def test_migrator_forward
+      Mongoid::Migrator.migrate(MIGRATIONS_ROOT + "/valid", 20100513054656)
+      assert_equal(20100513054656, Mongoid::Migrator.current_version)
+
+      Mongoid::Migrator.forward(MIGRATIONS_ROOT + "/valid", 20100513063902)
+      assert_equal(20100513063902, Mongoid::Migrator.current_version)
+    end
+
+    def test_migrator_with_duplicate_names
+      assert_raise(Mongoid::DuplicateMigrationNameError) do
+        Mongoid::Migrator.migrate(MIGRATIONS_ROOT + "/duplicate/names", nil)
+      end
+    end
+
+    def test_migrator_with_duplicate_versions
+      assert_raise(Mongoid::DuplicateMigrationVersionError) do
+        Mongoid::Migrator.migrate(MIGRATIONS_ROOT + "/duplicate/versions", nil)
+      end
+    end
+
+    def test_migrator_with_missing_version_numbers
+      assert_raise(Mongoid::UnknownMigrationVersionError) do
+        Mongoid::Migrator.migrate(MIGRATIONS_ROOT + "/valid", 500)
+      end
+    end
+
+    def test_default_state_of_timestamped_migrations
+      assert Mongoid.configure.timestamped_migrations, "Mongoid.configure.timestamped_migrations should default to true"
+    end
+
+    def test_timestamped_migrations_generates_non_sequential_next_number
+      next_number = Mongoid::Generators::Base.next_migration_number(MIGRATIONS_ROOT + "/valid")
+      assert_not_equal "20100513063903", next_number
+    end
+
+    def test_turning_off_timestamped_migrations
+      Mongoid.configure.timestamped_migrations = false
+      next_number = Mongoid::Generators::Base.next_migration_number(MIGRATIONS_ROOT + "/valid")
+      assert_equal "20100513063903", next_number
+    end
+
+    def test_migration_returns_connection_without_error
+      Mongoid::Migration.connection
+    end
+
+  end
+end