imigrate 0.9.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d379610f46ae849894f48c9f025e87d5f4868895
+  data.tar.gz: becab09bfc09e91b4190ace6b85f752c30ea1153
+SHA512:
+  metadata.gz: 1a71515b63577eeb473251cd465d045f9f236dbf6b85cd4707c9025e70fd67802268af166271a0a6b7b6f8712a4d383ca26437bfe1c7245888490b9717f55679
+  data.tar.gz: 3a4ce18ebc1e9886fda72121b787533dc06e8dd81a7acabf5e4c8bfbda191d8a5ace271b02674ea4929076651abaf6db63d651707c76fd3484794a9b44b7a3e7

data/.gitignore

@@ -0,0 +1,24 @@
+
+.bundle
+bundler/
+db/*.sqlite3*
+log/*.log
+*.log
+tmp/**/*
+tmp/*
+doc/*
+*.swp
+*~
+.DS_Store
+#*#
+.autotest
+rspec.html
+public/uploads/*
+.sass-cache/*
+.project
+.idea/*
+.rvmrc
+spec/report/*
+sauce_connect.log*
+.vagrant/
+

data/.rspec

@@ -0,0 +1,2 @@
+--colour
+--format doc

data/.travis.yml

@@ -0,0 +1,9 @@
+language: ruby
+cache: bundler
+rvm:
+  - 2.1
+
+script:
+  - bundle exec rspec spec/
+
+sudo: false

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License
+
+Copyright (c) 2011 Andrew J Vargo
+
+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,104 @@
+I migrate
+====
+
+Run Rails data migrations.
+
+Data migrations are stored in db/data. They act like schema
+migrations, except they should be reserved for data migrations.
+
+Problems this gem is solving :
+----------------------
+
+### Migrating data using model which has attribute not created in database
+
+Example:
+
+* Migration adding a new attribute to the model User.
+* Migration migrating data to populate User models.
+* Migration adding a new attribute to the model User.
+
+The second migration will break because the model User now use a new attribute
+which will not be created in the database at this time.
+
+Using this gem, you can now run data migrations after executing all schema migrations.
+
+### Using a staging environment using the production database
+
+In this case when we deploy to production, we need to run again migration
+of the data because models in production was still not using the last schema.
+
+Example:
+ When adding a new attribute to the model user, while begin in staging,
+ the production will not create the user as it does not know about it.
+
+Using this gem, you can specify a prefix (`env_prefix`) for the version registered in
+the data versioning table. (example: 'staging' or 'production')
+
+### Ensure migration are runnable multiple times
+
+As run migration on staging and in production, this mean migration should
+runnable multiple times agains the same database. You can simplify call multiple
+times `rake db:data:migrate` to verify migrations are correct.
+
+
+What's it do?
+-------------
+
+Data migrations are stored in db/data. They act like schema
+migrations, except they should be reserved for data migrations.
+Running any of the provided rake tasks also
+creates a data schema table to mirror the usual schema migrations
+table to track all the goodness.
+
+Data migrations can be created at the same time as schema migrations,
+or independently.
+
+Rails 4.1 and Ruby 2.0
+--------------------
+
+Imigrate is Rails 4.1 and Ruby > 2.0 compatible.
+
+Installation
+------------
+Add the gem to your project
+
+    # Gemfile
+    gem 'imigrate'
+
+Then `bundle install` and you are ready to go.
+
+So you know, when you use one of the provide rake tasks, a table
+called 'data_migrations' will be created in your database. This
+is to mirror the way the standard 'db' rake tasks work.
+
+Usage
+-----
+
+### Generating Migrations
+
+You can generate a data migration as you would a schema migration:
+
+    rails g data_migration add_this_to_that
+
+### Specify the a prefix to the data versioning table
+
+    Imigrate.env_prefix = 'staging'
+
+### Rake Tasks
+
+    $> rake -T data
+    rake db:data:forward                 # Pushes the schema to the next version (specify steps w/ STEP=n)
+    rake db:data:migrate                 # Migrate data migrations (options: VERSION=x, VERBOSE=false)
+    rake db:data:migrate:down            # Runs the "down" for a given migration VERSION
+    rake db:data:migrate:redo            # Rollbacks the database one migration and re migrate up (options: STEP=x, VERSIO...
+    rake db:data:migrate:status          # Display status of data migrations
+    rake db:data:migrate:up              # Runs the "up" for a given migration VERSION
+    rake db:data:rollback                # Rolls the schema back to the previous version (specify steps w/ STEP=n)
+    rake db:data:version                 # Retrieves the current schema version number for data migrations
+
+
+Credits
+-------
+
+Inspired from https://github.com/ajvargo/data-migrate
+

data/Rakefile

@@ -0,0 +1,2 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks

data/imigrate.gemspec

@@ -0,0 +1,25 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "imigrate/version"
+
+Gem::Specification.new do |s|
+  s.name        = "imigrate"
+  s.version     = Imigrate::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Matthieu Paret"]
+  s.email       = ["matthieu@ifeelgoods.com"]
+  s.homepage    = "https://github.com/ifeelgoods/imigrate"
+  s.summary     = %q{Rake tasks to migrate data for Rails application.}
+  s.description = %q{Rake tasks to migrate data for Rails application.}
+
+  s.add_development_dependency "rails", "~> 4.1.0"
+  s.add_development_dependency "rspec-rails", "~> 3.1.0"
+  s.add_development_dependency "sqlite3"
+  s.add_development_dependency "generator_spec"
+  s.add_development_dependency "database_cleaner"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+end

data/lib/generators/imigrate.rb

@@ -0,0 +1,30 @@
+require 'rails/generators'
+require 'rails/generators/named_base'
+require 'rails/generators/migration'
+
+module Imigrate
+  module Generators
+    class DataMigrationGenerator < Rails::Generators::NamedBase #:nodoc:
+      namespace "data_migration"
+      include Rails::Generators::Migration
+
+      def self.source_root
+        @_data_migrator_source_root ||= File.expand_path(File.join(File.dirname(__FILE__), 'templates'))
+      end
+
+      def create_data_migration
+        migration_template "data_migration.rb", "db/data/#{file_name}.rb"
+      end
+
+      protected
+
+      def self.next_migration_number(dirname)
+        if ActiveRecord::Base.timestamped_migrations
+          Time.new.utc.strftime("%Y%m%d%H%M%S")
+        else
+          "%.3d" % (current_migration_number(dirname) + 1)
+        end
+      end
+    end
+  end
+end

data/lib/generators/templates/data_migration.rb

@@ -0,0 +1,8 @@
+class <%= migration_class_name %> < ActiveRecord::Migration
+  def self.up
+  end
+
+  def self.down
+    raise ActiveRecord::IrreversibleMigration
+  end
+end

data/lib/imigrate.rb

@@ -0,0 +1,9 @@
+require_relative 'imigrate/railtie'
+require_relative 'generators/imigrate'
+
+module Imigrate
+  mattr_accessor :env_prefix
+  mattr_accessor :activated
+  SCHEMA_MIGRATIONS_TABLE_NAME = 'data_migrations'
+  MIGRATION_PATH = 'db/data'
+end

data/lib/imigrate/activerecord_ext.rb

@@ -0,0 +1,19 @@
+#require it, only when needed!
+
+if Imigrate.activated == true
+  class ActiveRecord::MigrationProxy
+    def initialize(name, version, filename, scope)
+      if Imigrate.env_prefix.present?
+        version = "#{Imigrate.env_prefix}_#{version}"
+      end
+
+      super(name, version, filename, scope)
+    end
+  end
+  class ActiveRecord::Migrator
+    private
+    def ran?(migration)
+      migrated.include?(migration.version)
+    end
+  end
+end

data/lib/imigrate/railtie.rb

@@ -0,0 +1,10 @@
+require 'active_record'
+require 'active_record/migration'
+
+module Imigrate
+  class Railtie < Rails::Railtie
+    rake_tasks do
+      load File.join(File.dirname(__FILE__), '..', 'tasks/databases.rake')
+    end
+  end
+end

data/lib/imigrate/version.rb

@@ -0,0 +1,3 @@
+module Imigrate
+  VERSION = "0.9.0"
+end

data/lib/tasks/capistrano.rake

@@ -0,0 +1,17 @@
+namespace :deploy do
+  namespace :migrate do
+    desc 'Runs rake db:data:migrate if migrations are set'
+    task :data => [:set_rails_env] do
+      on primary fetch(:migration_role) do
+        within release_path do
+          with rails_env: fetch(:rails_env) do
+            migrate_env = fetch(:migrate_env, "")
+            execute :rake, "db:data:migrate #{migrate_env} "
+          end
+        end
+      end
+    end
+  end
+
+  after 'deploy:migrate', 'deploy:migrate:data'
+end

data/lib/tasks/databases.rake

@@ -0,0 +1,60 @@
+namespace :db do
+  namespace :migrate do
+    desc 'Migrate schema and data migrations (options: VERSION=x, VERBOSE=false)'
+    task :all do
+      system('rake db:migrate')
+      system('rake db:data:migrate')
+    end
+  end
+
+  namespace :data do
+    task :load_config do
+      Imigrate.activated = true
+      require_relative '../imigrate/activerecord_ext'
+      ActiveRecord::Tasks::DatabaseTasks.migrations_paths = Imigrate::MIGRATION_PATH
+      ActiveRecord::Base.schema_migrations_table_name = Imigrate::SCHEMA_MIGRATIONS_TABLE_NAME
+    end
+
+    desc 'Migrate data migrations (options: VERSION=x, VERBOSE=false)'
+    task :migrate => [:environment, :load_config] do
+      Rake::Task["db:migrate"].invoke
+    end
+
+    namespace :migrate do
+      desc 'Rollbacks the database one migration and re migrate up (options: STEP=x, VERSION=x).'
+      task :redo => [:environment, :load_config] do
+        Rake::Task["db:migrate:redo"].invoke
+      end
+
+      desc 'Runs the "up" for a given migration VERSION.'
+      task :up => [:environment, :load_config] do
+        Rake::Task["db:migrate:up"].invoke
+      end
+
+      desc 'Runs the "down" for a given migration VERSION.'
+      task :down => [:environment, :load_config] do
+        Rake::Task["db:migrate:down"].invoke
+      end
+
+      desc "Retrieves the current schema version number for data migrations"
+      task :status => [:environment, :load_config] do
+        Rake::Task["db:migrate:status"].invoke
+      end
+    end
+
+    desc "Display status of data migrations"
+    task :version => [:environment, :load_config] do
+      Rake::Task["db:version"].invoke
+    end
+
+    desc 'Rolls the schema back to the previous version (specify steps w/ STEP=n).'
+    task :rollback => [:environment, :load_config] do
+      Rake::Task["db:rollback"].invoke
+    end
+
+    desc 'Pushes the schema to the next version (specify steps w/ STEP=n).'
+    task :forward => [:environment, :load_config] do
+      Rake::Task["db:forward"].invoke
+    end
+  end
+end

data/spec/dummy/README.rdoc

@@ -0,0 +1,28 @@
+== README
+
+This README would normally document whatever steps are necessary to get the
+application up and running.
+
+Things you may want to cover:
+
+* Ruby version
+
+* System dependencies
+
+* Configuration
+
+* Database creation
+
+* Database initialization
+
+* How to run the test suite
+
+* Services (job queues, cache servers, search engines, etc.)
+
+* Deployment instructions
+
+* ...
+
+
+Please feel free to use a different markup language if you do not plan to run
+<tt>rake doc:app</tt>.

data/spec/dummy/Rakefile

@@ -0,0 +1,6 @@
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require File.expand_path('../config/application', __FILE__)
+
+Rails.application.load_tasks

data/spec/dummy/app/assets/javascripts/application.js

@@ -0,0 +1,13 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or vendor/assets/javascripts of plugins, if any, can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// compiled file.
+//
+// Read Sprockets README (https://github.com/sstephenson/sprockets#sprockets-directives) for details
+// about supported directives.
+//
+//= require_tree .

data/spec/dummy/app/assets/stylesheets/application.css

@@ -0,0 +1,15 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or vendor/assets/stylesheets of plugins, if any, can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the bottom of the
+ * compiled file so the styles you add here take precedence over styles defined in any styles
+ * defined in the other CSS/SCSS files in this directory. It is generally better to create a new
+ * file per style scope.
+ *
+ *= require_tree .
+ *= require_self
+ */