migrer 0.0.1

data/.gitignore

@@ -0,0 +1,20 @@
+*.gem
+*.rbc
+.bundle
+.config
+.idea/
+.yardoc
+.rvmrc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test_app
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in migrer.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Sathya Sekaran
+
+MIT License
+
+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/README.md

@@ -0,0 +1,103 @@
+# Migrer
+#### The polite data migration valet.
+
+### What's with the name?
+
+Migrer (me-gray) is French for migrate. My wife suggested the name, and it was much
+less obnoxious than `morphin_time` or  `flying_v`, say. - @sfsekaran
+
+## What is it?
+
+Migrer creates migration-like tasks for running application scripts. It is primarily useful for updating database
+records or running one-time tasks against separate environments.
+
+**What is the difference between this and ActiveRecord migrations?**
+
+Migrations should always be stable and are primarily for altering the structure of a database. Migrer is intended for
+data migrations, or manipulating the data within that structure. Such tasks can become error-prone since they depend on
+the state of models in the codebase, and are best not included in ActiveRecord migrations.
+
+**Why not just create a regular rake task or use a script runner?**
+
+Although Migrer data migrations can be run multiple times, they are primarily suited for one-time tasks (and often for
+tasks that are not intended to be run more than once). Migrer not only creates a structure for these one-time tasks,
+but also keeps track of which data migrations have already been processed. This is especially useful when managing
+such tasks among multiple environments.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'migrer'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install migrer
+
+And install database migrations like so:
+
+    $ bundle exec rake railties:install:migrations FROM=migrer
+    $ bundle exec rake db:migrate
+
+## Usage
+
+# 1) Create the data migration
+
+Create a data migration:
+
+    $ bundle exec rails generate MyFirstDataMigration "optional description"
+
+This will create the file:  lib/tasks/data_migrations/<timestamp>_my_first_data_migration.rb
+
+Open this file and replace "TODO" with your data migration code!
+
+# 2) Run a task
+
+Unless you have the RAILS_ENV environment variable already set, prepend this to all of the following commands (replace
+<environment> with the correct Rails environment (development, staging, production, etc.):
+
+    RAILS_ENV=<environment>
+
+All the following commands will ask for confirmation before executing.
+
+**Run all unprocessed data migrations:**
+
+    bundle exec rake data:migrate
+
+**Run a single data migration (&lt;version&gt; is the timestamp at the beginning of the data migration file, just like
+ActiveRecord migrations):**
+
+    bundle exec rake data:migration VERSION=<version>
+
+**Mark all data migrations as already processed:**
+
+    bundle exec rake data:mark_all
+
+**Mark a single data migration as already processed:**
+
+    bundle exec rake data:mark VERSION=<version>
+
+**Mark all data migrations as unprocessed (so they are included again when running data:migrate):**
+
+    bundle exec rake data:unmark_all
+
+**Mark a single data migration as unprocessed:**
+
+    bundle exec rake data:unmark VERSION=<version>
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+## Contributors
+
+* *Sathya Sekaran* ([sfsekaran](https://github.com/sfsekaran))
+* *Michael Durnhofer* ([mdurn](https://github.com/mdurn))

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/db/migrate/20121229002105_create_migrer_table.rb

@@ -0,0 +1,8 @@
+class CreateMigrerTable < ActiveRecord::Migration
+  def change
+    create_table :data_migration_versions do |t|
+      t.string :version
+      t.timestamps
+    end
+  end
+end

data/lib/data_migration.rb

@@ -0,0 +1,26 @@
+class DataMigration
+  def self.all
+    filenames = Dir.entries("#{Rails.root}/lib/tasks/data_migrations").select { |f| /^\d+.*\.rb$/ === f }
+    data_migrations = {}
+
+    filenames.each do |f|
+      match_data = /^(?<version>\d+)_(?<name>.+)\.rb$/.match(f)
+
+      record = ActiveRecord::Base.connection.execute(
+          "SELECT * FROM data_migration_versions WHERE version = #{match_data[:version]}").first
+
+      data_migrations.merge!(
+          match_data[:version] => {
+              basefilename: "#{match_data[:version]}_#{match_data[:name]}",
+              class_name: match_data[:name].classify,
+              filename: "#{match_data[:version]}_#{match_data[:name]}.rb",
+              name: match_data[:name],
+              processed: (record != nil),
+              created_at: record.try(:[], :created_at),
+              updated_at: record.try(:[], :updated_at)
+          })
+    end
+
+    data_migrations
+  end
+end

data/lib/generators/data_migration/USAGE

@@ -0,0 +1,11 @@
+Description:
+    Data migration generator
+
+Optional Arguments:
+    DESCRIPTION  # a commented description in the created data migration file
+
+Example:
+    rails generate data_migration DataMigrationName "Optional description"
+
+    This will create:
+        lib/tasks/data_migrations/<timestamp>_data_migration_name.rb

data/lib/generators/data_migration/data_migration_generator.rb

@@ -0,0 +1,16 @@
+class DataMigrationGenerator < Rails::Generators::NamedBase
+  require "rails/generators/active_record"
+
+  source_root File.expand_path('../templates', __FILE__)
+  argument :description, type: :string, default: nil, required: false
+
+  def generate_data_migration
+    template "data_migration.rb",
+             "lib/tasks/data_migrations/#{file_name}"
+  end
+
+  private
+  def file_name
+    "#{ActiveRecord::Generators::Base.next_migration_number('lib/tasks/data_migrations')}_#{name.underscore}.rb"
+  end
+end

data/lib/generators/data_migration/templates/data_migration.rb

@@ -0,0 +1,8 @@
+class <%= name %> < DataMigration
+
+<%= "# #{description}" %>
+
+    def self.run
+      #TODO: data_migration code
+    end
+end

data/lib/migrer/engine.rb

@@ -0,0 +1,7 @@
+module Migrer
+
+  class Engine < ::Rails::Engine
+    isolate_namespace Migrer
+  end
+
+end

data/lib/migrer/version.rb

@@ -0,0 +1,3 @@
+module Migrer
+  VERSION = "0.0.1"
+end

data/lib/migrer.rb

@@ -0,0 +1,7 @@
+require "migrer/version"
+
+module Migrer
+end
+
+# Require our engine
+require "migrer/engine"

data/lib/tasks/migrer.rake

@@ -0,0 +1,155 @@
+require 'data_migration'
+
+namespace :data do
+  desc "Data migration tasks"
+
+  task migrate: :environment do
+    data_migrations = DataMigration.all
+
+    if (version = ENV['VERSION'])
+      data_migration = data_migrations[version]
+
+      if data_migration.present?
+        if data_migration[:processed]
+          puts "Data migration already processed. Do you want to run it anyway? (responses other than 'yes' will exit)"
+        else
+          puts "Starting data migration #{data_migration[:class_name]}. Do you wish to continue? (responses other than 'yes' will exit)"
+        end
+
+        prompt = $stdin.gets.chomp
+
+        if prompt == "yes"
+          puts "#{data_migration[:class_name]}: migrating"
+          t_start = Time.now
+
+          require "#{Rails.root}/lib/tasks/data_migrations/#{data_migration[:basefilename]}"
+          eval(data_migration[:class_name]).run
+
+          t_end = Time.now
+
+          unless data_migration[:processed]
+            ActiveRecord::Base.connection.execute(
+                "INSERT INTO data_migration_versions
+                 VALUES (NULL, #{version}, CURRENT_TIMESTAMP, CURRENT_TIMESTAMP)" )
+          end
+
+          puts "#{data_migration[:class_name]}: migrated (#{t_end - t_start}s)"
+        end
+      else
+        puts "No data migration found matching version: #{version}"
+      end
+    else
+      data_migrations.each do |k, v|
+        unless v[:processed]
+          puts "Starting data migration #{v[:class_name]}. Do you wish to continue? (responses other than 'yes' will exit)"
+          prompt = $stdin.gets.chomp
+          if prompt == "yes"
+            puts "#{v[:class_name]}: migrating"
+            t_start = Time.now
+
+            require "#{Rails.root}/lib/tasks/data_migrations/#{v[:basefilename]}"
+            eval(v[:class_name]).run
+
+            t_end = Time.now
+
+            ActiveRecord::Base.connection.execute(
+                "INSERT INTO data_migration_versions
+                 VALUES (NULL, #{k}, CURRENT_TIMESTAMP, CURRENT_TIMESTAMP)" )
+
+            puts "#{v[:class_name]}: migrated (#{t_end - t_start}s)"
+          end
+        end
+      end
+    end
+  end
+
+  task mark: :environment do
+    data_migrations = DataMigration.all
+
+    if (version = ENV['VERSION'])
+      data_migration = data_migrations[version]
+
+      if data_migration.present?
+        if data_migration[:processed]
+          puts "Data migration already processed."
+        else
+          puts "Data migration #{data_migration[:class_name]} will be marked as processed. Continue? (responses other than 'yes' will exit)"
+
+          prompt = $stdin.gets.chomp
+
+          if prompt == "yes"
+            ActiveRecord::Base.connection.execute(
+                "INSERT INTO data_migration_versions
+                 VALUES (NULL, #{version}, CURRENT_TIMESTAMP, CURRENT_TIMESTAMP)" )
+
+            puts "#{data_migration[:class_name]}: marked as migrated"
+          end
+        end
+      else
+        puts "No data migration found matching version: #{version}"
+      end
+    else
+      puts "VERSION must be supplied."
+    end
+  end
+
+  task mark_all: :environment do
+    unprocessed_data_migrations = DataMigration.all.select { |k, v| !v[:processed] }
+
+    puts "This will mark all data migrations as already processed. Continue? (responses other than 'yes' will exit)"
+
+    prompt = $stdin.gets.chomp
+    if prompt == "yes"
+      unprocessed_data_migrations.each do |k, v|
+        ActiveRecord::Base.connection.execute(
+            "INSERT INTO data_migration_versions
+             VALUES (NULL, #{k}, CURRENT_TIMESTAMP, CURRENT_TIMESTAMP)" )
+
+        puts "#{v[:class_name]}: marked as migrated"
+      end
+    end
+  end
+
+  task unmark: :environment do
+    data_migrations = DataMigration.all
+
+    if (version = ENV['VERSION'])
+      data_migration = data_migrations[version]
+
+      if data_migration.present?
+        if !data_migration[:processed]
+          puts "Data migration not yet processed."
+        else
+          puts "Data migration #{data_migration[:class_name]} will be unmarked as processed. Continue? (responses other than 'yes' will exit)"
+
+          prompt = $stdin.gets.chomp
+
+          if prompt == "yes"
+            ActiveRecord::Base.connection.execute(
+                "DELETE FROM data_migration_versions
+                 WHERE version = #{version}" )
+
+            puts "#{data_migration[:class_name]}: unmarked as migrated"
+          end
+        end
+      else
+        puts "No data migration found matching version: #{version}"
+      end
+    else
+      puts "VERSION must be supplied."
+    end
+  end
+
+  task unmark_all: :environment do
+    puts "All data migrations will be unmarked as processed. Continue? (responses other than 'yes' will exit)"
+
+    prompt = $stdin.gets.chomp
+
+    if prompt == "yes"
+      ActiveRecord::Base.connection.execute(
+          "DELETE FROM data_migration_versions" )
+
+      puts "Data migration records cleared"
+    end
+  end
+end

data/migrer.gemspec

@@ -0,0 +1,23 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'migrer/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "migrer"
+  gem.version       = Migrer::VERSION
+  gem.authors       = ["Sathya Sekaran", "Michael Durnhofer"]
+  gem.email         = ["sfsekaran@gmail.com"]
+  gem.description   = %q{The polite data migration valet.}
+  gem.summary       = %q{The 'migrer' gem helps generate, execute, and keep track of data migrations.}
+  gem.homepage      = "http://github.com/sfsekaran/migrer"
+
+  gem.rubyforge_project = "migrer"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib", "script", "db"]
+
+  gem.add_runtime_dependency "activerecord", "~> 3.2.2"
+end

data/script/rails

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+# This command will automatically be run when you run "rails" with Rails 3 gems installed from the root of your application.
+
+ENGINE_ROOT = File.expand_path('../..', __FILE__)
+ENGINE_PATH = File.expand_path('../../lib/migrer/engine', __FILE__)
+
+require 'rails/all'
+require 'rails/engine/commands'

metadata

@@ -0,0 +1,80 @@
+--- !ruby/object:Gem::Specification
+name: migrer
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Sathya Sekaran
+- Michael Durnhofer
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-01-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.2.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.2.2
+description: The polite data migration valet.
+email:
+- sfsekaran@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- db/migrate/20121229002105_create_migrer_table.rb
+- lib/data_migration.rb
+- lib/generators/data_migration/USAGE
+- lib/generators/data_migration/data_migration_generator.rb
+- lib/generators/data_migration/templates/data_migration.rb
+- lib/migrer.rb
+- lib/migrer/engine.rb
+- lib/migrer/version.rb
+- lib/tasks/migrer.rake
+- migrer.gemspec
+- script/rails
+homepage: http://github.com/sfsekaran/migrer
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+- script
+- db
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: migrer
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: The 'migrer' gem helps generate, execute, and keep track of data migrations.
+test_files: []