mince_migrator 0.0.1 → 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 41b113ade7cbebb55bd8640f1f1a49739a1ba0c0
+  data.tar.gz: cb22a342cd4f20d89ecf0d0bd99a1b577566bde2
+SHA512:
+  metadata.gz: a02d661a150eb49a28aea7e37ab96f9d69e979e9531bb0072aac2de525e1bb56eda2c31675f16e6285e95f7e46bfad678b13be914cfcb0579b1302feb7458a2f
+  data.tar.gz: 2d58ae4f149108c101ac01e939ddba2f5afc37e224d2fb6133054bdb4588cc559d3b1625563da847447e21fe3c46ca62b20882c87f9be2a835cad077d09bed2a

data/README.md

@@ -1,89 +1,51 @@
 # Mince Migrator
 
-**This is not yet released, this read me is a roadmap for what to do, it is not necessarily what has been done yet.**
+[![Travis CI](https://travis-ci.org/coffeencoke/mince_migrator.png)](https://travis-ci.org/#!/coffeencoke/mince_migrator)
 
-Mince Migrator is a library that provides a way to run database migrations for your application using the [Mince libraries](https://github.com/coffeencoke/mince).
+Mince Migrator is a library that provides a way to run database
+migrations for your ruby applications.
 
 ## Installation
 
-Add this line to your application's Gemfile:
-
-    gem 'mince_migrator'
-
-And then execute:
-
-    $ bundle install
-
-Or install it yourself as:
-
     $ gem install mince_migrator
 
 ## Usage
 
 ### Generate a migration
 
-	$ bundle exec mince_migrator create "Load admin users"
+	$ mince_migrator create "Load admin users"
 
 ### Implement your migration
 
-The template provided to you for a migration looks like this:
-
-```ruby
-module MinceMigrator
-  module Migration
-  	module LoadAdminUsers
-  	  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
-  	  	"2013-02-23 19:03:27 UTC"
-  	  end  	    	  
-  	  
-  	  module Temporary
-  	  	# Migration dependent classes go here
-  	  end
-  	end
-  end
-end
-```
-
-For an evolving explanation for the Temporary module, view [Migrating With Temporary Classes](https://github.com/coffeencoke/mince_migrator/wiki/migrating-with-temporary-classes).
+The output of creating the migration will tell you where the migration was created.
+
+Implement the `run` method with the behavior of your migration.
 
 ### Run your single migration
 
-	$ bundle exec mince_migrator run "Load admin users"
+	$ mince_migrator run "Load admin users"
 	
-*You can use any of the following as the name for the above command:*
-
-* `Load admin users` (in quotes)* 
-* `LoadAdminUsers`
-* `load_admin_users`
-
 ### Revert your single migration
 
-	$ bundle exec mince_migrator revert "Load admin users"
+	$ mince_migrator revert "Load admin users"
 
 ### Run all migrations that have not yet been ran
 
-	$ bundle exec mince_migrator run_all
-	
+	$ mince_migrator run_all
+
+### View all migrations
+
+*My favorite!*
+
+	$ mince_migrator list
+
 ### Check the status of a migration
 
-	$ bundle exec mince_migrator status "Load admin users"
+	$ mince_migrator show "Load admin users"
 
 ### View all available commands
 
-*Run any of the following*
-
-	$ bundle exec mince_migrator
-	$ bundle exec mince_migrator --help
-	$ bundle exec mince_migrator help
+	$ mince_migrator --help
 
 ## Contributing
 
@@ -108,4 +70,4 @@ Copyright (c) 2013 Matt Simpson
 
 MIT License
 
-View the LICENSE.txt file included in the source
+View the LICENSE.txt file included in the source

data/bin/mince_migrator

@@ -0,0 +1,125 @@
+#!/usr/bin/env ruby
+require 'gli'
+require 'mince_migrator/version'
+require 'mince_migrator/list'
+require 'mince_migrator/cli_helper'
+
+include GLI::App
+include MinceMigrator::CliHelper
+
+program_desc 'Manages database migrations for ruby applications'
+version MinceMigrator.version
+
+desc 'Creates a migration'
+arg_name 'Name of migration'
+command :create do |c|
+  c.action do |global_options,options,args|
+    name = args.join(" ")
+    create_migration(name)
+  end
+end
+
+desc 'Lists all migrations and their statuses'
+command :list do |c|
+  c.action do |global_options,options,args|
+    list_migrations(MinceMigrator::List.new)
+  end
+end
+
+desc 'Reverts a migration'
+arg_name 'Name of migration'
+command :revert do |c|
+  c.action do |global_options,options,args|
+    name = args.join(" ")
+    revert_migration(name: name)
+  end
+end
+
+desc 'Deletes all migrations that have already ran'
+command :delete_ran do |c|
+  c.action do |global_options,options,args|
+    list = MinceMigrator::List.new('ran')
+    if list.all.any?
+      list.all.each do |migration|
+        delete_migration(migration: migration)
+      end
+    else
+      puts "No migrations were found."
+    end
+  end
+end
+
+desc 'Deletes a migration'
+arg_name 'Name of migration'
+command :delete do |c|
+  c.action do |global_options,options,args|
+    name = args.join(" ")
+
+    delete_migration(name: name)
+  end
+end
+
+desc 'Runs a migration'
+arg_name 'Name of migration'
+command :run do |c|
+  c.action do |global_options,options,args|
+    name = args.join(" ")
+
+    run_migration(name: name)
+  end
+end
+
+desc 'Runs all migrations that have not yet been ran'
+command :run_all do |c|
+  c.action do
+    list = MinceMigrator::List.new('not ran')
+    if list.all.any?
+      list.all.each do |migration|
+        run_migration(migration: migration)
+      end
+    else
+      puts "There were no migrations to run."
+    end
+  end
+end
+
+desc 'Shows the details of a migration'
+arg_name 'Name of migration'
+command :show do |c|
+  c.action do |global_options,options,args|
+    name = args.join(" ")
+
+    if args.any?
+      show_migration(name)
+    else
+      puts "You must provide a name"
+    end
+  end
+end
+
+pre do |global,command,options,args|
+  # Pre logic here
+  # Return true to proceed; false to abort and not call the
+  # chosen command
+  # Use skips_pre before a command to skip this block
+  # on that command only
+  if File.exists?(MinceMigrator::Config.config_file)
+    require MinceMigrator::Config.config_file
+  end
+
+  true
+end
+
+post do |global,command,options,args|
+  # Post logic here
+  # Use skips_post before a command to skip this
+  # block on that command only
+end
+
+on_error do |exception|
+  # Error logic here
+  # return false to skip default error handling
+  true
+end
+
+exit run(ARGV)

data/lib/mince_migrator/cli_helper.rb

@@ -0,0 +1,72 @@
+module MinceMigrator
+  require_relative 'deleter'
+  require_relative 'creator'
+  require_relative 'reverter'
+  require_relative 'list'
+  require_relative 'migrations/runner'
+  require_relative 'list_report'
+
+  module CliHelper
+    def delete_migration(options)
+      deleter = MinceMigrator::Deleter.new(options)
+      if deleter.can_delete_migration?
+        puts "Deleting #{deleter.name}..."
+        deleter.delete_migration
+        puts "Migration deleted successfully"
+      else
+        help_now!(deleter.reasons_for_failure)
+      end
+    end
+
+    def run_migration(options)
+      runner = MinceMigrator::Migrations::Runner.new(options)
+      if runner.can_run_migration?
+        puts "Running #{runner.name}..."
+        runner.run_migration
+        puts "Migration finished."
+      else
+        help_now!(runner.reasons_for_failure)
+      end
+    end
+
+    def create_migration(name)
+      creator = MinceMigrator::Creator.new(name)
+      if creator.can_create_migration?
+        puts "Creating #{creator.name}..."
+        creator.create_migration
+        puts "Migration created at #{creator.migration_file_relative_path}"
+      else
+        help_now!(creator.reasons_for_failure)
+      end
+    end
+
+    def list_migrations(list)
+      if list.all.any?
+        MinceMigrator::ListReport.new(list).run
+      else
+        puts "\nThere are no migrations in the '#{MinceMigrator::Config.migration_relative_dir}' directory.\n".red
+        puts "run the following for more info to create a migration:\n\n"
+        puts "  mince_migrator create --help\n\n".green
+      end
+    end
+
+    def revert_migration(options)
+      reverter = MinceMigrator::Reverter.new(options)
+      if reverter.can_revert_migration?
+        puts "Reverting #{reverter.name}..."
+        reverter.revert_migration
+        puts "Migration reverted successfully"
+      else
+        help_now!(reverter.reasons_for_failure)
+      end
+    end
+
+    def show_migration(name)
+      if migration = MinceMigrator::Migration.find(name)
+        MinceMigrator::StatusReport.new(migration).run
+      else
+        puts "No migration was found with name: '#{name}'"
+      end
+    end
+  end
+end

data/lib/mince_migrator/config.rb

@@ -0,0 +1,30 @@
+module MinceMigrator
+  require 'singleton'
+
+  class Config
+    include Singleton
+
+    attr_reader :migration_relative_dir, :migration_dir
+
+    def initialize
+      self.migration_relative_dir = ::File.join("db", "migrations")
+    end
+
+    def migration_relative_dir=(val)
+      @migration_relative_dir = val
+      @migration_dir = ::File.join(Dir.pwd, migration_relative_dir)
+    end
+
+    def self.migration_relative_dir
+      instance.migration_relative_dir
+    end
+
+    def self.migration_dir
+      instance.migration_dir
+    end
+
+    def self.config_file
+      ::File.join(Dir.pwd, 'config', 'mince_migrator.rb')
+    end
+  end
+end

data/lib/mince_migrator/creator.rb

@@ -0,0 +1,48 @@
+module MinceMigrator
+  require 'fileutils'
+  require_relative 'migrations/versioned_file'
+  require_relative 'migrations/name'
+  require_relative 'config'
+
+  class Creator
+    attr_reader :name, :migration_name
+
+    def initialize(name=nil)
+      @migration_name = Migrations::Name.new(name)
+      @name = migration_name.value
+    end
+
+    def can_create_migration?
+      migration_name.valid?
+    end
+
+    def reasons_for_failure
+      migration_name.reasons_for_failure
+    end
+
+    def create_migration
+      FileUtils.mkdir_p(Config.migration_dir)
+      file = ::File.open(migration_file.full_path, 'w+')
+      file.write migration_file.body
+      file.close
+    end
+
+    def migration_file
+      @migration_file ||= versioned_file.next_unused_version
+    end
+
+    def versioned_file
+      @versioned_file ||= Migrations::VersionedFile.new(name)
+    end
+
+    def migration_file_relative_path
+      migration_file.full_relative_path
+    end
+
+    def self.create(name)
+      new(name).tap do |creator|
+        creator.create_migration if creator.can_create_migration?
+      end
+    end
+  end
+end

data/lib/mince_migrator/deleter.rb

@@ -0,0 +1,42 @@
+module MinceMigrator
+  require_relative 'config'
+  require 'fileutils'
+  require_relative 'migrations/name'
+  require_relative 'ran_migration'
+
+  class Deleter
+    attr_reader :name, :filename, :migration_name, :migration
+
+    def initialize(options)
+      if options[:migration]
+        @migration = options[:migration]
+        @migration_name = Migrations::Name.new(migration.name)
+      elsif options[:name]
+        @migration_name = Migrations::Name.new(options[:name])
+      end
+      @name = migration_name.value
+      @filename = migration_name.filename
+    end
+
+    def delete_migration
+      ::FileUtils.rm(migration_path)
+      ran_migration.delete if ran_migration
+    end
+
+    def can_delete_migration?
+      ::File.exists?(migration_path)
+    end
+
+    def reasons_for_failure
+      "Migration does not exist with name '#{name}'" unless can_delete_migration?
+    end
+
+    def migration_path
+      ::File.join Config.migration_dir, filename
+    end
+
+    def ran_migration
+      @ran_migration ||= RanMigration.find_by_name(name)
+    end
+  end
+end

data/lib/mince_migrator/list.rb

@@ -0,0 +1,46 @@
+module MinceMigrator
+  require_relative 'config'
+  require_relative 'migration'
+
+  class List
+    attr_reader :status
+
+    def initialize(status=:any)
+      @status = status
+    end
+
+    def all
+      @all ||= all_for_status
+    end
+
+    def number_of_migrations
+      all.size
+    end
+
+    def filelist
+      @filelist ||= Dir.glob(filelist_pattern)
+    end
+
+    def filelist_pattern
+      File.join(Config.migration_dir, '*')
+    end
+
+    private
+
+    def all_for_status
+      filtered_by_status(all_for_any_status).sort_by(&:time_created)
+    end
+
+    def all_for_any_status
+      filelist.map{|a| Migration.load_from_file(a) }
+    end
+
+    def filtered_by_status(migrations)
+      migrations.select { |m| matches_status?(m) }
+    end
+
+    def matches_status?(migration)
+      status == :any || migration.status == status
+    end
+  end
+end

data/lib/mince_migrator/list_report.rb

@@ -0,0 +1,67 @@
+module MinceMigrator
+  require 'command_line_reporter'
+  
+  class ListReport
+    include CommandLineReporter
+
+    attr_reader :sum_ran, :sum_not_ran
+
+    def initialize(list)
+      @list = list
+      @sum_ran = 0
+      @sum_not_ran = 0
+    end
+
+    def run
+      vertical_spacing 2
+      header title: 'List Of All Migrations', bold: true, rule: true, align: 'center', width: 70, timestamp: true
+
+      table border: false do
+        row header: true do
+          column 'Name', width: 40
+          column 'Status', width: 10
+          column 'Age', width: 5
+          column 'Date Created', width: 15
+        end
+        @list.all.each do |migration|
+          row  do
+            column migration.name
+            status_column(migration)
+            column migration.age
+            column migration.time_created.strftime("%m/%d/%Y")
+          end
+        end
+      end
+
+      vertical_spacing 2
+
+      table border: false do
+        row do
+          column "Ran", width: 6
+          column sum_ran, color: 'green', width: 5
+          column "Not ran", width: 8
+          column sum_not_ran, color: 'red', width: 5
+        end
+        row bold: true do
+          column "Total", width: 6
+          column total_number_of_migrations, width: 5
+        end
+      end
+    end
+
+    def total_number_of_migrations
+      sum_ran + sum_not_ran
+    end
+
+    def status_column(migration)
+      if migration.ran?
+        @sum_ran += 1
+        color = 'green'
+      else
+        @sum_not_ran += 1
+        color = 'red'
+      end
+      column migration.status, color: color
+    end
+  end
+end

data/lib/mince_migrator/migration.rb

@@ -0,0 +1,66 @@
+require 'debugger'
+
+module MinceMigrator
+  require_relative 'migrations/file'
+  require_relative 'ran_migration'
+  require_relative 'migrations/name'
+
+  class Migration
+    attr_reader :time_created, :name, :status, :relative_path, :path
+
+    def initialize(options)
+      @klass = options[:klass]
+      @time_created = @klass.time_created
+      self.name = options[:name]
+      @relative_path = options[:relative_path]
+      @path = options[:path]
+    end
+
+    def age
+      @age ||= "#{(Time.now.utc.to_date - time_created.to_date).to_i}d"
+    end
+
+    def name=(val)
+      @name ||= Migrations::Name.new(val).value
+    end
+
+    def run
+      @klass.run
+    end
+
+    def revert
+      @klass.revert
+    end
+
+    def ran?
+      !!ran_migration
+    end
+
+    def status
+      ran? ? 'ran' : 'not ran'
+    end
+
+    def ran_migration
+      @ran_migration ||= RanMigration.find_by_name(name)
+    end
+
+    def self.find(name)
+      if file = Migrations::File.find(name)
+        new_from_file file
+      end
+    end
+
+    def self.load_from_file(path_to_file)
+      new_from_file Migrations::File.load_from_file(path_to_file)
+    end
+
+    def self.new_from_file(file)
+      new(
+        klass: file.klass, 
+        name: file.name, 
+        relative_path: file.full_relative_path, 
+        path: file.full_path
+      )
+    end
+  end
+end

data/lib/mince_migrator/migrations/file.rb

@@ -0,0 +1,74 @@
+module MinceMigrator
+  module Migrations
+    require_relative 'template'
+    require_relative '../config'
+    require_relative 'versioned_file'
+    require_relative 'loader'
+
+    class File
+      attr_reader :name
+
+      def initialize(name)
+        @original_name = name
+        @version = 1
+        self.name = name
+      end
+
+      def full_relative_path
+        ::File.join(Config.migration_relative_dir, filename)
+      end
+
+      def name=(val)
+        @name = val.gsub(" ", "_").downcase
+      end
+
+      def filename
+        "#{name}.rb"
+      end
+
+      def full_path
+        ::File.join Config.migration_dir, filename
+      end
+
+      def klass_name
+        name.split("_").map(&:capitalize).join
+      end
+
+      def klass
+        loader.klass
+      end
+
+      def body
+        @body ||= Template.new(klass_name).render
+      end
+
+      def persisted?
+        ::File.exists?(full_path)
+      end
+
+      def load
+        loader.call
+      end
+
+      def self.load_from_file(path_to_file)
+        name = convert_path_to_name(path_to_file)
+        find(name)
+      end
+
+      def self.find(name)
+        file = new(name)
+        file.tap(&:load) if file.persisted?
+      end
+
+      def self.convert_path_to_name(path)
+        path.split("/")[-1].gsub('.rb', '')
+      end
+
+      private
+
+      def loader
+        @loader ||= Loader.new(full_path: full_path, klass_name: klass_name)
+      end
+    end
+  end
+end