rake-migrations 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 3f287b3ea554d83ddf5ca6e8be12a00a0d51330a
+  data.tar.gz: 5b91b36fa62c01d3b905e048b88c5c60eb4a7263
+SHA512:
+  metadata.gz: 42cd0935e07bdbcf5da9770eb53a6d7cc5fcdf65eeb1a6eaa00d3ef2f82500c3976eac8d1ee5dc27002e2478d943eb6038212dfc0cd0ee9eedb960801c85bac0
+  data.tar.gz: e86e3e8188146d535b0cfd9a49a4d71fd9a52ef8dd44d2a468d49c8e93985195c0b824b8cea620699973fbf51982448e8403d862d1ac1256c6682f1cfd240647

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,94 @@
+<a href="https://codeclimate.com/github/mzaccari/rake-migrations"><img src="https://codeclimate.com/github/mzaccari/rake-migrations/badges/gpa.svg" /></a>
+
+# Rake::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 lets you run configured rake tasks `once` or `every` time the command is run.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'rake-migrations'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rake-migrations
+
+## Usage
+
+Given a set of rake tasks you might need to run on deployment:
+
+```ruby
+namespace :users do
+  # Run this only once
+  task :migrate_names => :environment do
+    User.find_each do |user|
+      user.update_attributes(name: "#{user.first_name} #{user.last_name}")
+    end
+  end
+end
+
+namespace :deployment do
+  # Run this on each deployment
+  task :restart_jboss => :environment do
+    FileUtils.touch(Rails.root.join('tmp', 'restart.txt'))
+  end
+end
+```
+
+Create a file at `config/tasks.yml` with your rake migration configuration:
+
+```yml
+tasks:
+  user_name_migration:
+    command: users:migrate_names
+    frequency: :once # default
+
+  restart_jboss:
+    command: deployment:restart_jboss
+    frequency: :every
+```
+
+Then run the migration for your configured rake tasks:
+
+```
+$ bundle exec rake tasks:migrate
+== user_name_migration: migrating =============================================
+== user_name_migration: migrated (0.0191s) ====================================
+== restart_jboss: migrating ===================================================
+== restart_jboss: migrated (0.0005s) ==========================================
+```
+
+Notice that the user name task should only be run once. If we re-run the rake task migration it will not be included:
+```
+$ bundle exec rake tasks:migrate
+== restart_jboss: migrating ===================================================
+== restart_jboss: migrated (0.0003s) ==========================================
+```
+
+
+
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/mzaccari/rake-migrations.
+
+
+## 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,4 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)

data/lib/rake/migrations.rb

@@ -0,0 +1,13 @@
+require "rake"
+require "rake/migrations/version"
+require "rake/migrations/engine"
+require "yaml"
+
+module Rake
+  module Migrations
+    autoload :Configuration, 'rake/migrations/configuration'
+    autoload :Manifest,      'rake/migrations/manifest'
+    autoload :Migrator,      'rake/migrations/migrator'
+    autoload :Task,          'rake/migrations/task'
+  end
+end

data/lib/rake/migrations/configuration.rb

@@ -0,0 +1,29 @@
+class Rake::Migrations::Configuration
+
+  DEFAULT_FILE_PATH = Rails.root.join('config', 'tasks.yml')
+
+  def self.load(file_path = DEFAULT_FILE_PATH)
+    config = new(file_path)
+    config.load
+    config
+  end
+
+  attr_reader :file_path, :tasks
+
+  def initialize(file_path)
+    @file_path = file_path
+    @tasks = []
+  end
+
+  def load
+    config = YAML.load_file(file_path).with_indifferent_access
+    (config[:tasks] || []).each do |task|
+      add_task Rake::Migrations::Task.new(*task)
+    end
+  end
+
+  def add_task(task)
+    @tasks << task unless @tasks.include?(task)
+  end
+
+end

data/lib/rake/migrations/engine.rb

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

data/lib/rake/migrations/manifest.rb

@@ -0,0 +1,49 @@
+class Rake::Migrations::Manifest
+
+  DEFAULT_FILE_PATH = Rails.root.join('.rake.migrations.yml')
+
+  def self.load(file_path = DEFAULT_FILE_PATH)
+    manifest = new(file_path)
+    manifest.load
+    manifest
+  end
+
+  attr_reader :file_path, :tasks
+
+  def initialize(file_path)
+    @file_path = file_path
+    @tasks     = []
+  end
+
+  def add_task(task)
+    @tasks << task unless @tasks.include?(task)
+  end
+
+  def update(task)
+    add_task(task) && save
+  end
+
+  def load
+    manifest = YAML.load_file(file_path).with_indifferent_access
+    (manifest[:tasks] || []).each do |task|
+      add_task Rake::Migrations::Task.new(*task)
+    end
+  rescue Errno::ENOENT
+  end
+
+  def save
+    File.open(file_path, 'w') { |f| f.write to_yaml  }
+  end
+
+  def to_h
+    {
+      tasks: tasks.map(&:name)
+    }
+  end
+  alias_method :to_hash, :to_h
+
+  def to_yaml
+    to_hash.to_yaml
+  end
+
+end

data/lib/rake/migrations/migrator.rb

@@ -0,0 +1,72 @@
+class Rake::Migrations::Migrator
+
+  def self.run_task_migrations
+    get_task_migrations.each do |task|
+      invoke task
+    end
+  end
+
+  # tasks to run every time + tasks that haven't been run yet
+  def self.get_task_migrations
+    config.tasks.select do |task|
+      task.run_every_time? || manifest.tasks.exclude?(task)
+    end
+  end
+
+  def self.manifest
+    @manifest ||= Rake::Migrations::Manifest.load
+  end
+
+  def self.config
+    @config ||= Rake::Migrations::Configuration.load
+  end
+
+  def self.invoke(task)
+    new(task).invoke
+  end
+
+  attr_reader :task
+
+  def initialize(task)
+    @task = task
+  end
+
+  def invoke
+    with_handler do
+      Rake::Task[task.command].invoke
+    end
+  end
+
+  def manifest
+    self.class.manifest
+  end
+
+  private
+
+  def with_handler(&block)
+    announce "migrating"
+
+    time = Benchmark.measure do
+      block.call
+    end
+
+    announce "migrated (%.4fs)" % time.real;
+
+    manifest.update(task)
+  end
+
+  def write(text)
+    puts(text)
+  end
+
+  def say(message, subitem=false)
+    write "#{subitem ? "   ->" : "--"} #{message}"
+  end
+
+  def announce(message)
+    text = "#{task.name}: #{message}"
+    length = [0, 75 - text.length].max
+    write "== %s %s" % [text, "=" * length]
+  end
+
+end

data/lib/rake/migrations/task.rb

@@ -0,0 +1,36 @@
+class Rake::Migrations::Task
+
+  RUN_ONCE       = :once
+  RUN_EVERY_TIME = :every
+
+  attr_reader :name, :command, :frequency
+
+  def initialize(name, attrs = {})
+    @name      = name
+    @command   = attrs[:command]
+    @frequency = attrs[:frequency] || RUN_ONCE
+  end
+
+  def run_every_time?
+    frequency == RUN_EVERY_TIME
+  end
+
+  def run_once?
+    frequency == RUN_ONCE
+  end
+
+  def to_h
+    {
+      name => {
+        command: command,
+        frequency: frequency
+      }
+    }
+  end
+
+  def ==(other)
+    name == other.name
+  end
+  alias_method :equal?, :==
+
+end

data/lib/rake/migrations/version.rb

@@ -0,0 +1,5 @@
+module Rake
+  module Migrations
+    VERSION = '0.2.0'
+  end
+end

data/lib/rake_migrations.rb

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

data/lib/tasks/rake_migrations.rake

@@ -0,0 +1,7 @@
+namespace :tasks do
+
+  task :migrate => :environment do
+    Rake::Migrations::Migrator.run_task_migrations
+  end
+
+end

metadata

@@ -0,0 +1,71 @@
+--- !ruby/object:Gem::Specification
+name: rake-migrations
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- Michael Zaccari
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-01-22 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'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.2'
+description: Rails gem for rake task migrations
+email:
+- michael.zaccari@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/rake/migrations.rb
+- lib/rake/migrations/configuration.rb
+- lib/rake/migrations/engine.rb
+- lib/rake/migrations/manifest.rb
+- lib/rake/migrations/migrator.rb
+- lib/rake/migrations/task.rb
+- lib/rake/migrations/version.rb
+- lib/rake_migrations.rb
+- lib/tasks/rake_migrations.rake
+homepage: https://github.com/mzaccari/rake-migrations
+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: