rake-task-migration 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5f9eb0afb17227ac6a80a7692db5a2a688c5c78f
+  data.tar.gz: b80fe4c75a32824bc7d4b8176a4af77568ae3edf
+SHA512:
+  metadata.gz: e9834db6eddde4d669271d8d5e42526d7bcd3ce629f0ad39cc327eb2b27c1c1294e289070da69d7aa2e0160ceb1fcc757d5c9d7c3046574a54f5c36874ba9cce
+  data.tar.gz: c0752318635b5eafdf61615d19afc457af2eab1946c32ffc175c0369995a5be83f756e123c6cc44cb7e7033ea00dd8e48e2de94b760dc7c2a4253085ee8efc19

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Michael Zaccari
+
+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,99 @@
+[![Build Status](https://travis-ci.org/mzaccari/rake-task-migrations.svg?branch=master)](https://travis-ci.org/mzaccari/rake-task-migrations)
+[![Code Climate](https://codeclimate.com/github/mzaccari/rake-task-migrations/badges/gpa.svg)](https://codeclimate.com/github/mzaccari/rake-task-migrations)
+[![Test Coverage](https://codeclimate.com/github/mzaccari/rake-task-migrations/badges/coverage.svg)](https://codeclimate.com/github/mzaccari/rake-task-migrations/coverage)
+
+# Rake Task Migrations
+
+Heavily based on the `seed_migration` gem [found here](https://github.com/harrystech/seed_migration).
+
+For rails projects that need to run tasks on deployment that don't quite fit in the `db:migrate` and `seed:migrate` categories, this gem migrates specified rake tasks and ensures they only run once.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'rake-task-migration'
+```
+
+And then execute:
+
+    $ bundle
+
+Install and run the internal migrations
+
+    $ bundle exec rake task_migration:install:migrations
+    $ bundle exec rake db:migrate
+
+That will create the table to keep track of rake task migrations.
+
+## Usage
+
+Create the `lib/tasks/migrations.rake` file and add your tasks:
+
+```ruby
+namespace :migrations do
+  task :migrate_user_names => :environment do
+    User.find_each do |user|
+      user.update_attributes(name: "#{user.first_name} #{user.last_name}")
+    end
+  end
+end
+```
+
+Then run the migration for your rake tasks:
+
+```
+$ bundle exec rake tasks:migrate
+== migrate_user_names: migrating =============================================
+== migrate_user_names: migrated (0.0191s) ====================================
+```
+
+Each rake task is run only once.
+
+## Configuration
+
+Use an initializer file for configuration.
+
+### List of available configurations :
+
+- `migration_table_name (default = 'rake_task_migrations')`
+- `migration_namespace (default = :migrations)`
+
+#### Example:
+
+```ruby
+# config/initializers/rake_task_migration.rb
+
+Rake::TaskMigration.config do |config|
+  config.migration_table_name = 'table_name'
+  config.migration_namespace  = 'namespace'
+end
+```
+
+## Runnings tests
+
+```bash
+export RAILS_ENV=test
+bundle exec rake app:db:create app:db:migrate
+bundle exec rspec spec
+```
+
+* Rubies: 1.9.3, 2.0, 2.1, 2.2, JRuby 1.7.x, JRuby 9.x
+* Rails: 3.2, 4.0, 4.1, 4.2
+* Databases: MySQL, SQLite, PostgreSQL
+
+For more information see the [travic-ci config](https://github.com/mzaccari/rake-task-migrations/blob/master/.travis.yml).
+
+## 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
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,26 @@
+Dir['lib/tasks/*.rake'].each { |rake| load rake }
+
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)
+
+task test: :spec
+
+begin
+  require 'rubocop/rake_task'
+  RuboCop::RakeTask.new
+rescue LoadError
+  desc 'Run RuboCop'
+  task :rubocop do
+    $stderr.puts 'Rubocop is disabled'
+  end
+end
+
+task default: [:spec, :rubocop]
+
+APP_RAKEFILE = File.expand_path('../spec/dummy/Rakefile', __FILE__)
+load 'rails/tasks/engine.rake'
+
+Bundler::GemHelper.install_tasks

data/app/models/rake_task_migration.rb

@@ -0,0 +1,5 @@
+class RakeTaskMigration < ActiveRecord::Base
+  self.table_name = Rake::TaskMigration.migration_table_name
+
+  validates :version, :runtime, :migrated_on, presence: true
+end

data/db/migrate/20160210030451_create_rake_task_migrations.rb

@@ -0,0 +1,9 @@
+class CreateRakeTaskMigrations < ActiveRecord::Migration
+  def change
+    create_table Rake::TaskMigration.migration_table_name do |t|
+      t.string :version
+      t.integer :runtime
+      t.datetime :migrated_on
+    end
+  end
+end

data/lib/rake-task-migration.rb

@@ -0,0 +1 @@
+require 'rake/task_migration'

data/lib/rake/task/migration.rb

@@ -0,0 +1 @@
+require 'rake/task_migration'

data/lib/rake/task_migration.rb

@@ -0,0 +1,39 @@
+require 'rake'
+require 'rake/task_migration/version'
+require 'rake/task_migration/engine'
+require 'benchmark'
+
+module Rake
+  module TaskMigration
+    autoload :Migrator, 'rake/task_migration/migrator'
+
+    DEFAULT_TABLE_NAME = 'rake_task_migrations'
+    DEFAULT_NAMESPACE  = :migrations
+
+    class << self
+      mattr_accessor :migration_table_name
+      mattr_accessor :migration_namespace
+
+      self.migration_table_name = DEFAULT_TABLE_NAME
+      self.migration_namespace  = DEFAULT_NAMESPACE
+
+      def config
+        yield self
+      end
+
+      def migrate
+        Migrator.migrate(tasks)
+      end
+
+      def tasks
+        with_namespace { |namespace| return namespace.tasks }
+      end
+
+      def with_namespace
+        Rake.application.in_namespace(migration_namespace) do |namespace|
+          yield namespace if block_given?
+        end
+      end
+    end
+  end
+end

data/lib/rake/task_migration/engine.rb

@@ -0,0 +1,9 @@
+require 'rails'
+
+module Rake
+  module TaskMigration
+    class Engine < ::Rails::Engine
+      isolate_namespace Rake::TaskMigration
+    end
+  end
+end

data/lib/rake/task_migration/migrator.rb

@@ -0,0 +1,88 @@
+module Rake
+  module TaskMigration
+    class Migrator
+      class << self
+        def migrate(tasks)
+          new(tasks).migrate
+        end
+
+        def rake_task_migrations_table_name
+          Rake::TaskMigration.migration_table_name
+        end
+
+        def get_all_tasks(connection = ActiveRecord::Base.connection)
+          ActiveSupport::Deprecation.silence do
+            if connection.table_exists?(rake_task_migrations_table_name)
+              RakeTaskMigration.all.map { |x| x.version.to_s }.sort
+            else
+              []
+            end
+          end
+        end
+      end
+
+      attr_reader :tasks
+
+      def initialize(tasks)
+        @tasks = Array(tasks)
+      end
+
+      def migrate
+        pending_tasks.each { |task| migrate_task(task.name.to_s) }
+      end
+
+    private
+
+      def migrate_task(task)
+        fail "#{task} has already been migrated." if RakeTaskMigration.where(version: task).first
+
+        announce "#{task}: migrating"
+
+        ActiveRecord::Base.transaction do
+          time = Benchmark.measure do
+            invoke(task)
+          end
+
+          # Create record
+          migration = RakeTaskMigration.new
+          migration.version = task
+          migration.runtime = time.real.to_i
+          migration.migrated_on = DateTime.now
+          begin
+            migration.save!
+          rescue StandardError => e
+            puts e
+          end
+
+          announce "#{task}: migrated (#{format('%.4fs', time.real)})"
+        end
+      end
+
+      def invoke(task)
+        Rake::Task[task].invoke
+      end
+
+      def pending_tasks
+        already_migrated = migrated
+        tasks.reject { |task| already_migrated.include?(task.name) }
+      end
+
+      def migrated
+        @migrated_tasks || load_migrated
+      end
+
+      def load_migrated
+        @migrated_tasks = Set.new(self.class.get_all_tasks)
+      end
+
+      def write(text)
+        puts text
+      end
+
+      def announce(text)
+        length = [0, 75 - text.length].max
+        write format('== %s %s', text, '=' * length)
+      end
+    end
+  end
+end

data/lib/rake/task_migration/version.rb

@@ -0,0 +1,5 @@
+module Rake
+  module TaskMigration
+    VERSION = '1.0.0'
+  end
+end

data/lib/tasks/task_migration.rake

@@ -0,0 +1,13 @@
+namespace :tasks do
+  task migrate: :environment do
+    Rake::TaskMigration.migrate
+  end
+end
+
+namespace :task_migration do
+  namespace :install do
+    task :migrations do
+      Rake::Task['rake_task_migration:install:migrations'].invoke
+    end
+  end
+end

metadata

@@ -0,0 +1,91 @@
+--- !ruby/object:Gem::Specification
+name: rake-task-migration
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Michael Zaccari
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-02-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6'
+- !ruby/object:Gem::Dependency
+  name: test-unit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: Rails gem for rake task migrations
+email:
+- michael.zaccari@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- README.md
+- Rakefile
+- app/models/rake_task_migration.rb
+- db/migrate/20160210030451_create_rake_task_migrations.rb
+- lib/rake-task-migration.rb
+- lib/rake/task/migration.rb
+- lib/rake/task_migration.rb
+- lib/rake/task_migration/engine.rb
+- lib/rake/task_migration/migrator.rb
+- lib/rake/task_migration/version.rb
+- lib/tasks/task_migration.rake
+homepage: https://github.com/mzaccari/rake-task-migration
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5.1
+signing_key: 
+specification_version: 4
+summary: Rake Task Migrations
+test_files: []
+has_rdoc: