mince_migrator 0.0.1 → 1.0.0

data/spec/integration/running_a_migration_spec.rb

@@ -0,0 +1,66 @@
+require_relative '../integration_helper'
+
+describe 'Running a migration' do
+  subject { MinceMigrator::Migrations::Runner.new(name: name) }
+
+  context 'when the migration could not be found' do
+    let(:name) { 'migration that does not exist' }
+
+    before do
+      subject.can_run_migration?
+    end
+
+    its(:reasons_for_failure) { should == "Migration does not exist" }
+    its(:can_run_migration?) { should be_false }
+  end
+
+  context 'when the migration exists' do
+    let(:name) { "test migration" }
+    let(:spec_migration) { File.expand_path('../../support/test_migration.rb', __FILE__) }
+    let(:db_dir) { MinceMigrator::Config.migration_dir }
+    let(:data_model) { MinceMigrator::Migrations::TestMigration::Temporary::UserDataModel }
+
+    its(:reasons_for_failure) { should be_empty }
+    its(:can_run_migration?) { should be_true }
+
+    before do
+      FileUtils.mkdir_p(db_dir)
+      FileUtils.cp(spec_migration, db_dir)
+      subject.can_run_migration?
+    end
+
+    it 'can run the migration' do
+      subject.run_migration.should be_true
+
+      users = data_model.all
+      users.size.should == 1
+      users.first[:username].should == 'matt'
+    end
+
+    context 'and the migration has already been ran' do
+      before do
+        subject.run_migration
+        subject.can_run_migration?
+      end
+  
+      its(:reasons_for_failure) { should == "Migration has already ran" }
+      its(:can_run_migration?) { should be_false }
+    end
+  end
+
+  context 'when Mince interface has not been set' do
+    let(:name) { 'name' }
+
+    before do
+      Mince::Config.interface = nil
+      subject.can_run_migration?
+    end
+
+    after do
+      Mince::Config.interface = Mince::HashyDb::Interface
+    end
+
+    its(:reasons_for_failure) { should == "Mince interface is not set" }
+    its(:can_run_migration?) { should be_false }
+  end
+end

data/spec/integration_helper.rb

@@ -0,0 +1,17 @@
+require_relative '../lib/mince_migrator'
+require_relative '../lib/mince_migrator/config'
+require 'mince'
+require 'hashy_db'
+
+Mince::Config.interface = Mince::HashyDb::Interface
+MinceMigrator::Config.instance.migration_relative_dir = "tmp/db_for_integration_specs"
+
+RSpec.configure do |config|
+  config.after(:each) do
+    if File.exists?(MinceMigrator::Config.migration_dir)
+      FileUtils.rm_r MinceMigrator::Config.migration_dir
+    end
+
+    Mince::Config.interface.clear
+  end
+end

data/spec/support/db/a_second_migration.rb

@@ -0,0 +1,24 @@
+module MinceMigrator
+  module Migrations
+    require 'time'
+
+    module ASecondMigration
+      def self.run
+        # Actual migration goes here
+      end
+
+      def self.revert
+        # In case you need to revert this one migration
+      end
+
+      # So you can change the order to run more easily
+      def self.time_created
+        Time.parse "2013-03-28 05:03:26 UTC"
+      end
+
+      module Temporary
+        # Migration dependent classes go here
+      end
+    end
+  end
+end

data/spec/support/db/a_second_migration_2.rb

@@ -0,0 +1,24 @@
+module MinceMigrator
+  module Migrations
+    require 'time'
+
+    module ASecondMigration2
+      def self.run
+        # Actual migration goes here
+      end
+
+      def self.revert
+        # In case you need to revert this one migration
+      end
+
+      # So you can change the order to run more easily
+      def self.time_created
+        Time.parse "2013-03-28 05:03:26 UTC"
+      end
+
+      module Temporary
+        # Migration dependent classes go here
+      end
+    end
+  end
+end

data/spec/support/db/create_seeded_admin_users.rb

@@ -0,0 +1,24 @@
+module MinceMigrator
+  module Migrations
+    require 'time'
+
+    module CreateSeededAdminUsers
+      def self.run
+        # Actual migration goes here
+      end
+
+      def self.revert
+        # In case you need to revert this one migration
+      end
+
+      # So you can change the order to run more easily
+      def self.time_created
+        Time.parse "2013-03-28 05:03:26 UTC"
+      end
+
+      module Temporary
+        # Migration dependent classes go here
+      end
+    end
+  end
+end

data/spec/support/db/first_migration.rb

@@ -0,0 +1,24 @@
+module MinceMigrator
+  module Migrations
+    require 'time'
+
+    module FirstMigration
+      def self.run
+        # Actual migration goes here
+      end
+
+      def self.revert
+        # In case you need to revert this one migration
+      end
+
+      # So you can change the order to run more easily
+      def self.time_created
+        Time.parse "2013-03-28 05:03:26 UTC"
+      end
+
+      module Temporary
+        # Migration dependent classes go here
+      end
+    end
+  end
+end

data/spec/support/db/first_migration_2.rb

@@ -0,0 +1,24 @@
+module MinceMigrator
+  module Migrations
+    require 'time'
+
+    module FirstMigration2
+      def self.run
+        # Actual migration goes here
+      end
+
+      def self.revert
+        # In case you need to revert this one migration
+      end
+
+      # So you can change the order to run more easily
+      def self.time_created
+        Time.parse "2013-03-28 05:03:26 UTC"
+      end
+
+      module Temporary
+        # Migration dependent classes go here
+      end
+    end
+  end
+end

data/spec/support/db/first_migration_3.rb

@@ -0,0 +1,24 @@
+module MinceMigrator
+  module Migrations
+    require 'time'
+
+    module FirstMigration3
+      def self.run
+        # Actual migration goes here
+      end
+
+      def self.revert
+        # In case you need to revert this one migration
+      end
+
+      # So you can change the order to run more easily
+      def self.time_created
+        Time.parse "2013-03-28 05:03:26 UTC"
+      end
+
+      module Temporary
+        # Migration dependent classes go here
+      end
+    end
+  end
+end

data/spec/support/db/first_migration_4.rb

@@ -0,0 +1,24 @@
+module MinceMigrator
+  module Migrations
+    require 'time'
+
+    module FirstMigration4
+      def self.run
+        # Actual migration goes here
+      end
+
+      def self.revert
+        # In case you need to revert this one migration
+      end
+
+      # So you can change the order to run more easily
+      def self.time_created
+        Time.parse "2013-03-28 05:03:26 UTC"
+      end
+
+      module Temporary
+        # Migration dependent classes go here
+      end
+    end
+  end
+end

data/spec/support/db/name_of_migration.rb

@@ -0,0 +1,24 @@
+module MinceMigrator
+  module Migrations
+    require 'time'
+
+    module NameOfMigration
+      def self.run
+        # Actual migration goes here
+      end
+
+      def self.revert
+        # In case you need to revert this one migration
+      end
+
+      # So you can change the order to run more easily
+      def self.time_created
+        Time.parse "2013-03-28 05:03:26 UTC"
+      end
+
+      module Temporary
+        # Migration dependent classes go here
+      end
+    end
+  end
+end

data/spec/support/invalid_interface_migration.rb

@@ -0,0 +1,7 @@
+module MinceMigrator
+  module Migrations
+    module InvalidInterfaceMigration
+    end
+  end
+end
+

data/spec/support/not_a_migration.rb

@@ -0,0 +1,2 @@
+"What is this?  It is definitely not a mince migrator migration.
+But that's the point, because we are using this file as a test for a bad migration file."

data/spec/support/test_migration.rb

@@ -0,0 +1,30 @@
+module MinceMigrator
+  module Migrations
+    require 'time'
+
+    module TestMigration
+      def self.run
+        Temporary::UserDataModel.add(username: 'matt')
+      end
+
+      def self.revert
+        Temporary::UserDataModel.delete_by_params(username: 'matt')
+      end
+
+      # So you can change the order to run more easily
+      def self.time_created
+        Time.parse '2013-03-04 09:31:28 UTC'
+      end
+
+      module Temporary
+        class UserDataModel
+          include Mince::DataModel
+
+          data_collection :users
+          data_fields :username, :email, :first_name, :last_name
+        end
+      end
+    end
+  end
+end
+

data/spec/units/mince_migrator/cli_helper_spec.rb

@@ -0,0 +1,147 @@
+require_relative '../../../lib/mince_migrator/cli_helper'
+
+module MinceMigrator
+  describe CliHelper do
+    subject { klass.new }
+
+    let(:klass) do
+      Class.new do
+        include CliHelper
+      end
+    end
+    let(:options) { mock }
+    let(:reasons_for_failure) { mock }
+
+    before do
+      subject.stub(:puts)
+    end
+
+    describe 'deleting a migration' do
+      let(:deleter) { mock }
+
+      before do
+        Deleter.stub(:new).with(options).and_return(deleter)
+      end
+
+      context 'when the migration can be deleted' do
+        before do
+          deleter.stub(can_delete_migration?: true, name: mock)
+        end
+
+        it 'deletes it' do
+          deleter.should_receive(:delete_migration)
+
+          subject.delete_migration(options)
+        end
+      end
+
+      context 'when the migration cannot be deleted' do
+        before do
+          deleter.stub(can_delete_migration?: false, reasons_for_failure: reasons_for_failure)
+        end
+
+        it 'fails with an error message' do
+          subject.should_receive(:help_now!).with(reasons_for_failure)
+
+          subject.delete_migration(options)
+        end
+      end
+    end
+
+    describe 'running a migration' do
+      let(:runner) { mock }
+
+      before do
+        Migrations::Runner.stub(:new).with(options).and_return(runner)
+      end
+
+      context 'when the migration can be ran' do
+        before do
+          runner.stub(can_run_migration?: true, name: mock)
+        end
+
+        it 'runs it' do
+          runner.should_receive(:run_migration)
+
+          subject.run_migration(options)
+        end
+      end
+
+      context 'when the migration cannot be ran' do
+        before do
+          runner.stub(can_run_migration?: false, reasons_for_failure: reasons_for_failure)
+        end
+
+        it 'fails with an error message' do
+          subject.should_receive(:help_now!).with(reasons_for_failure)
+
+          subject.run_migration(options)
+        end
+      end
+    end
+
+    describe 'creating a migration' do
+      let(:creator) { mock migration_file_relative_path: mock }
+
+      before do
+        Creator.stub(:new).with(options).and_return(creator)
+      end
+
+      context 'when the migration can be created' do
+        before do
+          creator.stub(can_create_migration?: true, name: mock)
+        end
+
+        it 'creates it' do
+          creator.should_receive(:create_migration)
+
+          subject.create_migration(options)
+        end
+      end
+
+      context 'when the migration cannot be created' do
+        before do
+          creator.stub(can_create_migration?: false, reasons_for_failure: reasons_for_failure)
+        end
+
+        it 'fails with an error message' do
+          subject.should_receive(:help_now!).with(reasons_for_failure)
+
+          subject.create_migration(options)
+        end
+      end
+    end
+
+    describe 'reverting a migration' do
+      let(:reverter) { mock }
+
+      before do
+        Reverter.stub(:new).with(options).and_return(reverter)
+      end
+
+      context 'when the migration can be reverted' do
+        before do
+          reverter.stub(can_revert_migration?: true, name: mock)
+        end
+
+        it 'reverts it' do
+          reverter.should_receive(:revert_migration)
+
+          subject.revert_migration(options)
+        end
+      end
+
+      context 'when the migration cannot be reverted' do
+        before do
+          reverter.stub(can_revert_migration?: false, reasons_for_failure: reasons_for_failure)
+        end
+
+        it 'fails with an error message' do
+          subject.should_receive(:help_now!).with(reasons_for_failure)
+
+          subject.revert_migration(options)
+        end
+      end
+    end
+  end
+end

data/spec/units/mince_migrator/creator_spec.rb

@@ -0,0 +1,80 @@
+require_relative '../../../lib/mince_migrator/creator'
+
+describe MinceMigrator::Creator do
+  context 'when a name is not provided' do
+    let(:migration_name) { mock valid?: false, reasons_for_failure: mock, value: mock }
+
+    before do
+      MinceMigrator::Migrations::Name.stub(:new).with(nil).and_return(migration_name)
+    end
+
+    its(:can_create_migration?) { should be_false }
+    its(:reasons_for_failure) { should == migration_name.reasons_for_failure }
+  end
+
+  context 'when a name is provided' do
+    subject { described_class.new(name) }
+
+    let(:name) { mock }
+    let(:migration_name) { mock value: mock}
+
+    before do
+      MinceMigrator::Migrations::Name.stub(:new).with(name).and_return(migration_name)
+    end
+
+    context 'when the name is invalid' do
+      let(:reasons_for_failure) { mock }
+
+      before do
+        migration_name.stub(valid?: false, reasons_for_failure: reasons_for_failure)
+      end
+
+      its(:can_create_migration?) { should be_false }
+      its(:reasons_for_failure) { should == reasons_for_failure }
+    end
+
+    context 'when the name is valid' do
+      let(:opened_file) { mock write: nil, close: nil }
+      let(:migration_file) { mock path: mock, full_path: mock, body: mock, full_relative_path: mock }
+      let(:versioned_file) { mock next_unused_version: migration_file }
+
+      before do
+        migration_name.stub(valid?: true, value: mock)
+        FileUtils.stub(:mkdir_p).with(MinceMigrator::Config.migration_dir)
+        MinceMigrator::Migrations::VersionedFile.stub(:new).with(migration_name.value).and_return(versioned_file)
+        ::File.stub(:open).with(migration_file.full_path, 'w+').and_return(opened_file)
+        ::File.stub(:exists?).with(migration_file.full_path).and_return(false)
+      end
+
+      its(:migration_file_relative_path){ should == migration_file.full_relative_path }
+
+      it 'insures the path to the migraiton file exists' do
+        FileUtils.should_receive(:mkdir_p).with(MinceMigrator::Config.migration_dir)
+
+        subject.create_migration
+      end
+
+      it 'can create the migration' do
+        subject.can_create_migration?.should be_true
+      end
+
+      it 'creates a migration file' do
+        opened_file.should_receive(:write).with(migration_file.body)
+        opened_file.should_receive(:close)
+
+        subject.create_migration
+      end
+    end
+  end
+end
+
+describe MinceMigrator::Creator, 'Class level methods' do
+  it 'can create a migration' do
+    name = mock
+    creator = mock can_create_migration?: true
+    described_class.should_receive(:new).with(name).and_return(creator)
+    creator.should_receive(:create_migration)
+
+    described_class.create(name)
+  end
+end

data/spec/units/mince_migrator/deleter_spec.rb

@@ -0,0 +1,52 @@
+require_relative '../../../lib/mince_migrator/deleter'
+
+describe MinceMigrator::Deleter do
+  let(:name) { mock }
+  let(:migration_name) { mock filename: mock, value: mock }
+  let(:migration_path) { ::File.join(path, migration_name.filename) }
+  let(:path) { mock }
+  
+  subject { described_class.new(name: name) }
+
+  before do
+    MinceMigrator::Config.stub(migration_dir: path)
+    MinceMigrator::Migrations::Name.stub(:new).with(name).and_return(migration_name)
+  end
+
+  context 'when the migration does not exist' do
+    before do
+      ::File.stub(:exists?).with(migration_path).and_return(false)
+    end
+
+    its(:can_delete_migration?) { should be_false }
+    its(:reasons_for_failure) { should == "Migration does not exist with name '#{migration_name.value}'" }
+  end
+
+  context 'when the migration exists' do
+    let(:ran_migration) { nil }
+
+    before do
+      ::File.stub(:exists?).with(migration_path).and_return(true)
+      MinceMigrator::RanMigration.stub(:find_by_name).with(migration_name.value).and_return(ran_migration)
+      FileUtils.stub(:rm)
+    end
+
+    its(:can_delete_migration?) { should be_true }
+
+    it 'deletes the migration' do
+      FileUtils.should_receive(:rm).with(migration_path)
+
+      subject.delete_migration
+    end
+
+    context 'when it has been ran' do
+      let(:ran_migration) { mock }
+
+      it 'deletes the migration for the database' do
+        ran_migration.should_receive(:delete)
+
+        subject.delete_migration
+      end
+    end
+  end
+end

data/spec/units/mince_migrator/list_spec.rb

@@ -0,0 +1,53 @@
+require_relative '../../../lib/mince_migrator/list'
+
+describe MinceMigrator::List do
+  let(:migration_dir) { mock }
+
+  before do
+    MinceMigrator::Config.stub(migration_dir: migration_dir)
+  end
+
+  context 'getting all migrations' do
+    context 'when there are no migrations' do
+      before do
+        Dir.stub(:glob).with("#{migration_dir}/*").and_return([])
+      end
+
+      it 'is empty' do
+        subject.all.should be_empty
+      end
+
+      its(:number_of_migrations) { should == 0 }
+    end
+
+    context 'when some migrations exist' do
+      let(:migration_paths) { [migration_path1, migration_path2] }
+      let(:migration_path1) { mock }
+      let(:migration_path2) { mock }
+      let(:migration1) { mock time_created: Time.now.utc, status: 'ran' }
+      let(:migration2) { mock time_created: Time.now.utc - 500000, status: 'not ran' }
+
+      before do
+        Dir.stub(:glob).with("#{migration_dir}/*").and_return(migration_paths)
+        MinceMigrator::Migration.stub(:load_from_file).with(migration_path1).and_return(migration1)
+        MinceMigrator::Migration.stub(:load_from_file).with(migration_path2).and_return(migration2)
+      end
+
+      its(:number_of_migrations) { should == 2 }
+
+      it 'can load all migrations' do
+        subject.all.should == [migration2, migration1]
+      end
+
+      context 'when only wanting a list of migrations that have not yet ran' do
+        subject { described_class.new 'not ran' }
+
+        its(:number_of_migrations) { should == 1 }
+
+        it 'can load those migrations' do
+          subject.all.should == [migration2]
+        end
+      end
+    end
+  end
+end