rake_migrations 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b96467d0ed517f140a47e2d1c054ce721d3b7681
+  data.tar.gz: feb3922147c3656d8cb035dbb26dd6e5df9563fb
+SHA512:
+  metadata.gz: ee2ee75676afbbe6d790bee69b728f281fd76011035611ff2351aeef245f8f339dc4dbc26ed53b28e21b58adfebd466c94c0382742689afc39ff2753be44d3c6
+  data.tar.gz: 6a973b74670610498e87a95bcfce942571b04c4db49da31a940626b0eebaf26912cd771936d2f078b0f7be1034b060dd142447d25fe25c87a65c4630bc1692c5

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2014 YOURNAME
+
+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,78 @@
+Rake Migrations
+===============
+[![Build Status](https://travis-ci.org/eyaleizenberg/rake-migrations.svg?branch=master)](https://travis-ci.org/eyaleizenberg/rake-migrations)
+
+This gem helps you and your team members keep track of 'run once' rake tasks.
+
+## Requirements
+At the moment I have only tested this on Rails 3.2.X running mysql2 on Mac OS X.
+If you can help by testing this on different versions, databases and platforms, let me know.
+
+## Installation
+First, add this this to your gemfile:
+```ruby
+gem 'rake_migrations'
+```
+
+Then, run:
+```ruby
+bundle install
+rails g rake_migrations:install
+rake db:migrate
+```
+
+## Use
+Whenever somebody from your team wants to create a new run once task, simply generate it by running:
+
+```ruby
+rails g task <namespace> <task>
+```
+
+For example:
+
+```ruby
+rails g task users:update_some_field
+```
+
+This will generate a file under 'lib/tasks/rake_migrations' with a timestamp and the following content:
+
+```ruby
+# Checklist:
+# 1. Re-runnable on production?
+# 2. Is there a chance emails will be sent?
+# 3. puts ids & logs (progress log)
+# 4. Can you update the records with an update all instead of instantizing?
+# 5. Are there any callbacks?
+# 6. Performance issues?
+# 7. Scoping to account
+
+namespace :users do
+  desc "update run_at field to get value as in start_time"
+  task update_some_field: [:environment] do
+
+    # DO NOT REMOVE THIS PART
+    RakeMigration.find_or_create_by_version(__FILE__[/\d+/])
+  end
+end
+```
+
+Simply insert your code above the "DO NOT REMOVE THIS PART" line. The checklist is there to help you and the person who is code-reviewing your code to think of problems that might occur from your rake task. Afterwards you can run the rake task normally:
+
+```ruby
+rake users:update_some_field
+```
+
+Commit your new file into your repository.
+
+Afterwards, through the magic of git-hooks, whenever someone pulls this branch (or a branch that has this file in it), he will see a message in the terminal telling him which rakes need to be run:
+
+```ruby
+You need to run the following rakes:
+------------------------------------
+rake users:update_some_field
+```
+
+## Issues, suggestions and forks.
+Feel free to open issues, send suggestions and fork this repository.
+
+Thanks and Enjoy! :)

data/Rakefile

@@ -0,0 +1,38 @@
+#!/usr/bin/env rake
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+begin
+  require 'rdoc/task'
+rescue LoadError
+  require 'rdoc/rdoc'
+  require 'rake/rdoctask'
+  RDoc::Task = Rake::RDocTask
+end
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'RakeMigrations'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+
+
+
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task :default => :test

data/lib/rails/generators/rake_migrations/install_generator.rb

@@ -0,0 +1,30 @@
+require 'rails/generators'
+require 'rails/generators/migration'
+require 'rails/generators/active_record'
+
+module RakeMigrations
+  class InstallGenerator < Rails::Generators::Base
+    include Rails::Generators::Migration
+    extend ActiveRecord::Generators::Migration
+    source_root File.expand_path('../templates', __FILE__)
+
+    def create_migration_file
+      migration_template "migration.rb", "db/migrate/create_rake_migrations_table.rb"
+      template("rake_migrations_check.rb", "config/rake_migrations_check.rb")
+      write_to_post_merge_hook
+    end
+
+    def write_to_post_merge_hook
+      post_merge_file = ".git/hooks/post-merge"
+      what_to_write = <<-TEXT
+#{!File.exists?(post_merge_file) ? '#!/bin/sh' : ''}
+ruby ./config/rake_migrations_check.rb
+TEXT
+
+      File.open(post_merge_file, 'a+') do |file|
+        file.write(what_to_write) unless file.read.match(/rake_migrations_check/)
+      end
+      `chmod 777 #{post_merge_file}`
+    end
+  end
+end

data/lib/rails/generators/rake_migrations/templates/migration.rb

@@ -0,0 +1,11 @@
+class CreateRakeMigrationsTable < ActiveRecord::Migration
+  def self.up
+    create_table :rake_migrations do |t|
+      t.string :version
+    end
+  end
+
+  def self.down
+    drop_table :rake_migrations
+  end
+end

data/lib/rails/generators/rake_migrations/templates/rake_migrations_check.rb

@@ -0,0 +1,28 @@
+require 'mysql2'
+
+module RakeMigrationsCheck
+  def self.check
+    client = Mysql2::Client.new(host: "localhost", username: "root", database: "samanage_development")
+    results = client.query("select * from rake_migrations").map {|res| res["version"] }
+    rake_migrations_lib = "#{`pwd`.strip}/lib/tasks/rake_migrations/*"
+
+    rake_files = Dir[rake_migrations_lib].map do |file|
+      if !results.include?(file[/\d+/])
+        file = File.read(file)
+        namespace = file[/namespace :(.*?)do/m, 1].strip
+        task = file[/task (.*?):/m, 1]
+        "rake #{namespace}:#{task}"
+      end
+    end.compact
+
+    if !rake_files.empty?
+      puts "\n"
+      puts "You need to run the following rakes:"
+      puts "------------------------------------"
+      rake_files.each { |file| puts "\e[31m#{file}\e[0m" }
+      puts "\n"
+    end
+  end
+end
+
+RakeMigrationsCheck.check

data/lib/rails/generators/task/USAGE

@@ -0,0 +1,8 @@
+Description:
+    This generator will create rake tasks with a time stamp and default messages.
+
+Example:
+    rails generate task incidents convert_x_to_y
+
+    This will create:
+        lib/tasks/rake_migrations/[time_stamp]incidents.rake

data/lib/rails/generators/task/task_generator.rb

@@ -0,0 +1,9 @@
+class TaskGenerator < Rails::Generators::NamedBase
+  source_root File.expand_path('../templates', __FILE__)
+  argument :actions, type: :array, default: [], banner: "action action"
+
+  def create_task_files
+    time_stamp = Time.now.strftime("%Y%m%d%H%M")
+    template 'task.rb', File.join('lib/tasks/rake_migrations', "#{time_stamp}_#{file_name}.rake")
+  end
+end

data/lib/rails/generators/task/templates/task.rb

@@ -0,0 +1,21 @@
+# Checklist:
+# 1. Re-runnable on production?
+# 2. Is there a chance emails will be sent?
+# 3. puts ids & logs (progress log)
+# 4. Can you update the records with an update all instead of instantizing?
+# 5. Are there any callbacks?
+# 6. Performance issues?
+# 7. Scoping to account
+
+namespace :<%= file_name %> do
+<% actions.each do |action| -%>
+  desc "TODO"
+  task <%= action %>: [:environment] do
+
+
+    # DO NOT REMOVE THIS PART
+    RakeMigration.find_or_create_by_version(__FILE__[/\d+/])
+  end
+
+<% end -%>
+end

data/lib/rake_migrations.rb

@@ -0,0 +1,2 @@
+module RakeMigrations
+end

data/lib/rake_migrations/version.rb

@@ -0,0 +1,3 @@
+module RakeMigrations
+  VERSION = "1.0.0"
+end

metadata

@@ -0,0 +1,83 @@
+--- !ruby/object:Gem::Specification
+name: rake_migrations
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Eyal Eizenberg
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-08-06 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: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: mysql2
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: This gem creates a rake_migrations table and keeps track of rake tasks
+  similar to migrations.
+email:
+- iz.eyal@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- lib/rails/generators/rake_migrations/install_generator.rb
+- lib/rails/generators/rake_migrations/templates/migration.rb
+- lib/rails/generators/rake_migrations/templates/rake_migrations_check.rb
+- lib/rails/generators/task/USAGE
+- lib/rails/generators/task/task_generator.rb
+- lib/rails/generators/task/templates/task.rb
+- lib/rake_migrations.rb
+- lib/rake_migrations/version.rb
+homepage: http://eyaleizenberg.blogspot.com/
+licenses: []
+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.2.2
+signing_key: 
+specification_version: 4
+summary: A gem to easily keep track of rake tasks
+test_files: []