mongration 0.0.3.pre.beta → 0.0.4.pre.beta

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 884560384ec483986492aefbb946cda15136075b
-  data.tar.gz: c40a5ede37782728919819f17c133935e728e637
+  metadata.gz: 20730b095053fceae0d065822f9492a8e70eb89b
+  data.tar.gz: 4a57e71108a1453971fc04145a31b6ba1c2bf4eb
 SHA512:
-  metadata.gz: b2d0b356f35a8109db96d91ec16a55a2679d054fff3447436957572fcccc19576cae9b4a0cb304240c3a2592e1c81291716c2658127f5dee4426773f060698b7
-  data.tar.gz: ff3da3716f89e2676c5351c05bc3eaece5049ea2ac17f52a22b3c9e75a2999b5ca78fac7e1565703a6848be1f92b963dd525bcad42af05f383e2667acf628d2b
+  metadata.gz: 7ed9c54e2a8c160eb8ca9089e83c07310dd6b916e1e8b86f460e6f753892d6f0e43a7e5ab0b340b67ec3a6cd14a6a9b53c22e878e401dd695a81bdb538a995a3
+  data.tar.gz: 7708282338c9c5740a675c65f1f6ee836280f59c0e03cb95d030430353500c5bed606e6cf2c3bea99dc34c46ab6b616691f90832ad3aade93831275d96b09eb6

data/.ruby-version

@@ -1 +1 @@
-2.0.0-p353
+2.1.2

data/Gemfile

@@ -1,12 +1,19 @@
 source 'https://rubygems.org'
 
+gem 'rantly',      github: 'hayeah/rantly'
+
 group :test do
   gem 'guard-rspec', '4.3.1', require: false
-  gem 'rantly',      github: 'hayeah/rantly'
 end
 
-#gem 'rspec-legacy_formatters'
-#gem 'rspec-nc'
+# debuggers
+gem 'ruby-debug', platforms: :jruby
+gem 'debugger',   platforms: :mri_19
+gem 'byebug',     platforms: [:mri_20, :mri_21]
+
+require './lib/os_check.rb'
+if OsCheck.mac_osx?
+  gem 'rspec-nc'
+end
 
-# Specify your gem's dependencies in mongration.gemspec
 gemspec

data/README.md

@@ -4,7 +4,14 @@
 
 Mongration is a tool for migrating data. It is designed to have the same interface as [ActiveRecord](https://github.com/rails/rails/tree/master/activerecord)'s migrations but be used with [Mongoid](https://github.com/mongoid/mongoid) instead of an SQL database.
 
-Currently, there are only two supported Rake tasks, `db:migrate` and `db:migrate:rollback`. There is a third rake task, `db:migrate:create` which takes the place of the `rails generate migration` generator.
+Mongration supports the following rake tasks:
+* `db:migrate` - migrates all pending migrations
+* `db:migrate VERSION=123` - moves to the specified version. If the version is greater than the current version, it will move up. If the version is lesser than the current version, it will move down.
+* `db:rollback` - rolls back the most recent migration
+* `db:rollback STEP=N` - rolls back the N most recent migrations
+* `db:version` - outputs the numeric identifier for the most recent migration
+* `db:migrate:create` - takes the place of the `rails generate migration` generator
+* `db:migrate:status` - outputs a table of all files and their migration status
 
 ## Support
 
@@ -31,7 +38,7 @@ Or install it yourself as:
 
 ## Usage
 
-The primary usage will be through the Rake tasks `db:migrate` and `db:migrate:rollback`. Migrate will run all migrations that have not been run before. Rollback will rollback the previous migration.
+The primary usage will be through the Rake tasks `db:migrate` and `db:rollback`. Migrate will run all migrations that have not been run before. Rollback will rollback the previous migration.
 
 Migration files have the following structure:
 

data/Rakefile

@@ -3,6 +3,11 @@ require 'bundler/gem_tasks'
 require 'rspec/core/rake_task'
 RSpec::Core::RakeTask.new(:spec) do |t|
   t.verbose = false
+
+  require 'os_check'
+  if OsCheck.mac_osx?
+    t.rspec_opts = '--format Nc'
+  end
 end
 
 require 'tailor/rake_task'

data/lib/mongration.rb

@@ -1,34 +1,67 @@
-require 'mongration/version'
+require 'mongoid'
+require 'rake'
 
+require 'mongration/version'
 require 'mongration/errors'
 
-require 'mongration/configuration'
-require 'mongration/create_migration'
 require 'mongration/file'
-require 'mongration/migrate'
-require 'mongration/migration_file_writer'
-require 'mongration/null_migration'
-require 'mongration/rake_task'
-require 'mongration/rollback'
+require 'mongration/migration'
 
-require 'mongration/data_store/mongoid/store'
-require 'mongration/data_store/in_memory/store'
+require 'mongration/rake_tasks'
+require 'mongration/configuration'
 
 module Mongration
   extend self
 
-  def migrate
-    Migrate.perform(
-      latest_migration.version + 1
-    )
+  autoload :CreateMigration, 'mongration/create_migration'
+  autoload :MigrateAllUp,    'mongration/migrate_all_up'
+  autoload :MigrateUp,       'mongration/migrate_up'
+  autoload :MigrateDown,     'mongration/migrate_down'
+  autoload :NullOutput,      'mongration/null_output'
+  autoload :Rollback,        'mongration/rollback'
+  autoload :Status,          'mongration/status'
+
+  # Performs the migrations. If no version is provided, all pending migrations will be run. If a version is provided, migrations will be run to that version (either up or down).
+  #
+  # @param [String, nil] version
+  #
+  # @return [Boolean] true if migration was successful, false otherwise
+  #
+  def migrate(version = nil)
+    pending = ->(_) { File.pending.map(&:version).include?(_) }
+    migrated = ->(_) { File.migrated.map(&:version).include?(_) }
+
+    case version
+    when nil
+      MigrateAllUp.perform
+
+    when pending
+      MigrateUp.new(version).perform
+
+    when migrated
+      MigrateDown.new(version).perform
+
+    else
+      out.puts("Invalid Version: #{version} does not exist.")
+    end
   end
 
-  def rollback
-    Rollback.perform(
-      latest_migration
-    )
+  # Rolls back (calls `down`) on the most recent migration(s).
+  #
+  # @param [Integer] number of migrations to rollback
+  #
+  # @return [void]
+  #
+  def rollback(step = 1)
+    step.times do
+      Rollback.perform
+    end
   end
 
+  # Creates a migration with the given name
+  #
+  # @return [String] name of the file created
+  #
   def create_migration(name, options = {})
     CreateMigration.perform(
       name,
@@ -36,6 +69,34 @@ module Mongration
     )
   end
 
+  # Returns the version of most recently run migration. If there are no migrations that have run (all migrations are pending), it returns '0'.
+  #
+  # @return [String] version
+  #
+  def version
+    if File.migrated.any?
+      File.migrated.last.version
+    else
+      '0'
+    end
+  end
+
+  # Returns the direction (up if it has been run, down otherwise), migration ID (version), and description of the migration.
+  #
+  # @return [Array] migration statuses
+  #
+  def status
+    Status.migrations
+  end
+
+  def out
+    if configuration.silent?
+      @null_output ||= NullOutput.new
+    else
+      $stdout
+    end
+  end
+
   def configure
     yield configuration if block_given?
   end
@@ -43,12 +104,6 @@ module Mongration
   def configuration
     @configuration ||= Configuration.new
   end
-
-  private
-
-  def latest_migration
-    configuration.data_store.migrations.max_by(&:version) || NullMigration.new
-  end
 end
 
 Mongration.configure do |config|
@@ -56,7 +111,7 @@ Mongration.configure do |config|
   config.timestamps = true
 
   begin
-    config.data_store = Mongration::DataStore::Mongoid::Store.new
-  rescue Mongration::DataStore::Mongoid::ConfigNotFound
+    config.config_path = ::File.join('config', 'mongoid.yml')
+  rescue Mongration::Configuration::ConfigNotFound
   end
 end

data/lib/mongration/configuration.rb

@@ -2,22 +2,45 @@ module Mongration
 
   # @private
   class Configuration
-    attr_reader :dir
-    attr_writer :err_out
-    attr_accessor :data_store, :timestamps
+
+    class ConfigNotFound < Errors
+      def initialize(path)
+        super("#{path} cannot be found.")
+      end
+    end
+
+    attr_reader :dir, :config_path
+    attr_writer :err_out, :timestamps, :silent
 
     def dir=(dir)
       unless ::File.exists?(dir)
-        print_warning("Migration Directory #{dir} does not exists.")
+        print_warning("Migration Directory #{dir} does not exist.")
       end
 
       @dir = dir
     end
 
+    def config_path=(config_path)
+      unless ::File.exists?(config_path)
+        raise ConfigNotFound.new(config_path)
+      end
+
+      env = if defined?(Rails)
+              Rails.env
+            else
+              :test
+            end
+      Mongoid.load!(config_path, env)
+    end
+
     def timestamps?
       @timestamps
     end
 
+    def silent?
+      @silent
+    end
+
     private
 
     def print_warning(message)

data/lib/mongration/create_migration.rb

@@ -1,36 +1,35 @@
+require 'mongration/create_migration/migration_file_writer'
+
 module Mongration
 
   # @private
   class CreateMigration
 
     def self.perform(name, options = {})
-      new(name, options, Mongration.configuration).perform
+      new(name, options).perform
     end
 
-    def initialize(name, options, configuration)
-      @name = name
+    def initialize(name, options)
       @options = options
-      @configuration = configuration
+
+      snakecase = name.gsub(/([a-z])([A-Z0-9])/, '\1_\2').downcase
+      @file_name = "#{next_migration_number}_#{snakecase}.rb"
     end
 
     def perform
       MigrationFileWriter.write(
-        file_name,
-        { dir: @configuration.dir }.merge(@options)
+        @file_name,
+        @options
       )
     end
 
     private
 
-    def file_name
-      "#{next_migration_number}_#{snakecase}.rb"
-    end
-
     def next_migration_number
-      if @configuration.timestamps?
+      if Mongration.configuration.timestamps?
         Time.now.utc.strftime('%Y%m%d%H%M%S').to_i
       else
-        latest_file = Mongration::File.latest
+        latest_file = File.last
 
         number = if latest_file
                    latest_file.number + 1
@@ -40,9 +39,5 @@ module Mongration
         '%.3d' % number
       end
     end
-
-    def snakecase
-      @name.gsub(/([a-z])([A-Z0-9])/, '\1_\2').downcase
-    end
   end
 end

data/lib/mongration/create_migration/migration_file_writer.rb

@@ -0,0 +1,43 @@
+module Mongration
+  class CreateMigration
+
+    # @private
+    class MigrationFileWriter
+
+      def self.write(file_name, options = {})
+        new(file_name, options).write
+      end
+
+      def initialize(file_name, options = {})
+        @file_name = file_name
+        @up = options[:up]
+        @down = options[:down]
+      end
+
+      def write
+        path = ::File.join(Mongration.configuration.dir, @file_name)
+        ::File.open(path, 'w') do |file|
+          file.write(<<EOS
+class #{class_name}
+  def self.up
+    #{@up}
+  end
+
+  def self.down
+    #{@down}
+  end
+end
+EOS
+          )
+        end
+        path
+      end
+
+      private
+
+      def class_name
+        File.new(@file_name).class_name
+      end
+    end
+  end
+end

data/lib/mongration/file.rb

@@ -4,16 +4,36 @@ module Mongration
   class File
     include Comparable
 
-    def self.all
+    def self.all_file_names
       Dir[::File.join(Mongration.configuration.dir, '*.rb')].map do |path|
         path.pathmap('%f')
-      end.map { |file_name| new(file_name) }
+      end
+    end
+
+    def self.pending
+      wrap(all_file_names - migrated_file_names).sort
+    end
+
+    def self.migrated
+      wrap(migrated_file_names).sort
+    end
+
+    def self.migrated_file_names
+      Migration.file_names
     end
 
-    def self.latest
+    def self.all
+      pending + migrated
+    end
+
+    def self.last
       all.max
     end
 
+    def self.wrap(file_names)
+      file_names.map { |file_name| new(file_name) }
+    end
+
     attr_reader :file_name
 
     def initialize(file_name)
@@ -21,35 +41,58 @@ module Mongration
     end
 
     def up
+      Mongration.out.puts("#{version} #{class_name}: migrating")
+
       load_file
       klass.up
+
+      Migration.create_by_file_name(file_name)
+      Mongration.out.puts("#{version} #{class_name}: migrated")
+      true
+
+    rescue => e
+      Mongration.out.puts("#{e.class}: An error has occured, this and all later migrations cancelled")
+      false
     end
 
     def down
       load_file
       klass.down
+      Migration.destroy_by_file_name(file_name)
+    end
+
+    def name
+      underscored_name.gsub('_', ' ')
+    end
+
+    def class_name
+      underscored_name.camelize
+    end
+
+    def version
+      file_name.split('_').first
     end
 
     def number
-      @file_name.split('_').first.to_i
+      version.to_i
     end
 
     def <=>(other)
       number <=> other.number
     end
 
-    def class_name
-      @file_name.chomp('.rb').gsub(/^\d+_/, '').camelize
-    end
-
     private
 
     def load_file
-      load(::File.join(Dir.pwd, Mongration.configuration.dir, @file_name))
+      load(::File.join(Mongration.configuration.dir, @file_name))
     end
 
     def klass
       class_name.constantize
     end
+
+    def underscored_name
+      @file_name.chomp('.rb').gsub(/^\d+_/, '')
+    end
   end
 end