data_tasks 0.0.1

data/.gitignore

@@ -0,0 +1,9 @@
+Gemfile.lock
+.bundle/
+log/*.log
+pkg/
+*.sublime-*
+test/dummy/db/*.sqlite3
+test/dummy/log/*.log
+test/dummy/tmp/
+test/dummy/.sass-cache

data/Gemfile

@@ -0,0 +1,3 @@
+source "http://rubygems.org"
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Jason Wadsworth
+
+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,41 @@
+# DataTasks
+
+Adds a second migration phase to a Rails project for data migrations. Just
+like migrations, these can be run once and only once in each environment
+with a single command during every deployment.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'data_tasks'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install empty_gem
+
+## Usage
+
+To generate a data migration, use the rails generator:
+
+    rails generate data_task MigrateSomeData
+
+This will create:
+
+    db/data_tasks/20120822023011_migrate_some_data.rb
+
+Run all pending data tasks with rake:
+
+    rake data:migrate
+
+## 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

data/Rakefile

@@ -0,0 +1,18 @@
+#!/usr/bin/env rake
+
+begin
+  require 'bundler/gem_tasks'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+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/data_tasks.gemspec

@@ -0,0 +1,28 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'data_tasks/version'
+
+Gem::Specification.new do |s|
+  s.name        = "data_tasks"
+  s.version     = DataTasks::VERSION
+  s.authors     = ["Jason Wadsworth"]
+  s.email       = ["jdwadsworth@gmail.com"]
+  s.homepage    = "https://github.com/subakva/data_tasks"
+  s.summary     = "Adds a second migration phase to a Rails project."
+  s.description = %{
+    Adds a second migration phase to a Rails project for data migrations. Just
+    like migrations, these can be run once and only once in each environment
+    with a single command during every deployment.
+  }
+
+  s.files         = `git ls-files`.split($/)
+  s.executables   = s.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  s.test_files    = s.files.grep(%r{^(test|spec|features)/})
+  s.require_paths = ["lib"]
+
+  s.add_dependency "rails", "~> 3.2.8"
+
+  s.add_development_dependency "sqlite3"
+  s.add_development_dependency "jquery-rails"
+end

data/lib/data_tasks/railtie.rb

@@ -0,0 +1,11 @@
+require 'rails'
+
+module DataTasks
+  class Railtie < Rails::Railtie
+    railtie_name :data_tasks
+
+    rake_tasks do
+      Dir[File.join(File.dirname(__FILE__), '..', 'tasks', '*.rake')].each { |f| load f }
+    end
+  end
+end

data/lib/data_tasks/version.rb

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

data/lib/data_tasks.rb

@@ -0,0 +1 @@
+require 'data_tasks/railtie' if defined?(Rails)

data/lib/generators/data_task/USAGE

@@ -0,0 +1,9 @@
+Description:
+    Generates a migration class to be executed as a data task. This uses the schema_migrations
+    table to ensure that all data tasks are run once and only once.
+
+Example:
+    rails generate data_task MigrateSomeData
+
+    This will create:
+        db/data_tasks/20120822023011_migrate_some_data.rb

data/lib/generators/data_task/data_task_generator.rb

@@ -0,0 +1,14 @@
+class DataTaskGenerator < Rails::Generators::NamedBase
+  include Rails::Generators::Migration
+
+  source_root File.expand_path('../templates', __FILE__)
+
+  def create_migration_file
+    migration_template "data_task.rb", "db/data_tasks/#{file_name}.rb"
+  end
+
+  def self.next_migration_number(dirname) #:nodoc:
+    next_migration_number = current_migration_number(dirname) + 1
+    ActiveRecord::Migration.next_migration_number(next_migration_number)
+  end
+end

data/lib/generators/data_task/templates/data_task.rb

@@ -0,0 +1,6 @@
+class <%= migration_class_name %> < ActiveRecord::Migration
+  def up
+    say_with_time "migrating data" do
+    end
+  end
+end

data/lib/tasks/data_tasks.rake

@@ -0,0 +1,8 @@
+namespace :data do
+
+  desc 'Runs any data tasks that have not yet been executed.'
+  task migrate: :environment do
+    ActiveRecord::Migration.verbose = ENV["VERBOSE"] ? ENV["VERBOSE"] == "true" : true
+    ActiveRecord::Migrator.migrate(['db/data_tasks'], ENV["VERSION"] ? ENV["VERSION"].to_i : nil)
+  end
+end

data/test/data_tasks_test.rb

@@ -0,0 +1,108 @@
+require 'test_helper'
+
+class DataTaskTest < ActiveSupport::TestCase
+
+  def execute(command)
+    Rails.logger.debug "=> Running: \"#{command}\""
+    `#{command}`
+  end
+
+  def in_dummy_app(&block)
+    FileUtils.chdir(@dummy_dir) do
+      yield
+    end
+  end
+
+  def assert_directory(path)
+    assert File.directory?(path), "#{path} was not a directory"
+  end
+
+  def setup
+    @dummy_dir = File.join('test', 'dummy')
+    @dummy_tmp_dir = File.join('tmp')
+    @dummy_task_dir = File.join('db', 'data_tasks')
+    @dummy_migration_dir = File.join('db', 'migrate')
+    @dummy_models_dir = File.join('app', 'models')
+
+    FileUtils.rm_rf File.join(@dummy_dir, @dummy_task_dir)
+    FileUtils.rm_rf File.join(@dummy_dir, @dummy_migration_dir)
+    FileUtils.rm_rf File.join(@dummy_dir, @dummy_models_dir)
+    FileUtils.rm_rf File.join(@dummy_dir, @dummy_tmp_dir)
+  end
+
+  def teardown
+  end
+
+  def insert_in_file(filename, lines_to_insert, options)
+    lines_to_insert = [*lines_to_insert]
+    tmp_filename = File.join(@dummy_tmp_dir, filename)
+    FileUtils.mkdir_p(File.dirname(tmp_filename))
+
+    File.open(tmp_filename, 'w') do |out|
+      File.readlines(filename).each do |line|
+        out.puts(line)
+        if line =~ options[:after]
+          lines_to_insert.each do |line_to_insert|
+            out.puts line_to_insert
+          end
+        end
+      end
+    end
+
+    FileUtils.mv(tmp_filename, filename)
+  end
+
+  test 'runs a data task with a rake task' do
+    in_dummy_app do
+      execute("rails generate model Farmer name:string --fixture false")
+      execute("rake db:drop db:create db:migrate")
+      execute("rails generate data_task add_farmer")
+
+      filename = Dir[File.join(@dummy_task_dir, '*add_farmer*')].first
+      insert_in_file(filename, 'class Farmer < ActiveRecord::Base; end', after: /class AddFarmer/)
+      insert_in_file(filename, [
+        'farmer = Farmer.new',
+        'farmer.name = "Al"',
+        'farmer.save!'
+      ], after: /say_with_time/)
+
+      execute("rake data:migrate")
+      farmer_name = execute(%{rails runner "puts Farmer.find_by_name('Al').try(:name)"}).strip
+      assert_equal 'Al', farmer_name
+    end
+
+  end
+
+  test 'does not interfere with database rollback' do
+    pending 'Implement the test'
+  end
+
+  test 'does not run the same task twice' do
+    in_dummy_app do
+      execute("rails generate model Record --fixture false")
+      execute("rake db:drop db:create db:migrate")
+      execute("rails generate data_task insert_record")
+
+      filename = Dir[File.join(@dummy_task_dir, '*insert_record*')].first
+      insert_in_file(filename, 'class Record < ActiveRecord::Base; end', after: /class InsertRecord/)
+      insert_in_file(filename, 'Record.create!', after: /say_with_time/)
+      execute("rake data:migrate")
+      execute("rake data:migrate")
+
+      record_count = execute(%{rails runner "puts Record.count"}).strip
+      assert_equal '1', record_count
+    end
+  end
+
+  test "generates a new data task" do
+    in_dummy_app do
+      execute("rails generate data_task do_something_awesome")
+
+      assert_directory @dummy_task_dir
+
+      task_files = Dir[File.join(@dummy_task_dir, '**')]
+      assert_equal 1, task_files.size
+      assert_match Regexp.new(File.join(@dummy_task_dir, '[0-9]*_do_something_awesome.rb')), task_files[0]
+    end
+  end
+end

data/test/dummy/README.rdoc

@@ -0,0 +1,261 @@
+== Welcome to Rails
+
+Rails is a web-application framework that includes everything needed to create
+database-backed web applications according to the Model-View-Control pattern.
+
+This pattern splits the view (also called the presentation) into "dumb"
+templates that are primarily responsible for inserting pre-built data in between
+HTML tags. The model contains the "smart" domain objects (such as Account,
+Product, Person, Post) that holds all the business logic and knows how to
+persist themselves to a database. The controller handles the incoming requests
+(such as Save New Account, Update Product, Show Post) by manipulating the model
+and directing data to the view.
+
+In Rails, the model is handled by what's called an object-relational mapping
+layer entitled Active Record. This layer allows you to present the data from
+database rows as objects and embellish these data objects with business logic
+methods. You can read more about Active Record in
+link:files/vendor/rails/activerecord/README.html.
+
+The controller and view are handled by the Action Pack, which handles both
+layers by its two parts: Action View and Action Controller. These two layers
+are bundled in a single package due to their heavy interdependence. This is
+unlike the relationship between the Active Record and Action Pack that is much
+more separate. Each of these packages can be used independently outside of
+Rails. You can read more about Action Pack in
+link:files/vendor/rails/actionpack/README.html.
+
+
+== Getting Started
+
+1. At the command prompt, create a new Rails application:
+       <tt>rails new myapp</tt> (where <tt>myapp</tt> is the application name)
+
+2. Change directory to <tt>myapp</tt> and start the web server:
+       <tt>cd myapp; rails server</tt> (run with --help for options)
+
+3. Go to http://localhost:3000/ and you'll see:
+       "Welcome aboard: You're riding Ruby on Rails!"
+
+4. Follow the guidelines to start developing your application. You can find
+the following resources handy:
+
+* The Getting Started Guide: http://guides.rubyonrails.org/getting_started.html
+* Ruby on Rails Tutorial Book: http://www.railstutorial.org/
+
+
+== Debugging Rails
+
+Sometimes your application goes wrong. Fortunately there are a lot of tools that
+will help you debug it and get it back on the rails.
+
+First area to check is the application log files. Have "tail -f" commands
+running on the server.log and development.log. Rails will automatically display
+debugging and runtime information to these files. Debugging info will also be
+shown in the browser on requests from 127.0.0.1.
+
+You can also log your own messages directly into the log file from your code
+using the Ruby logger class from inside your controllers. Example:
+
+  class WeblogController < ActionController::Base
+    def destroy
+      @weblog = Weblog.find(params[:id])
+      @weblog.destroy
+      logger.info("#{Time.now} Destroyed Weblog ID ##{@weblog.id}!")
+    end
+  end
+
+The result will be a message in your log file along the lines of:
+
+  Mon Oct 08 14:22:29 +1000 2007 Destroyed Weblog ID #1!
+
+More information on how to use the logger is at http://www.ruby-doc.org/core/
+
+Also, Ruby documentation can be found at http://www.ruby-lang.org/. There are
+several books available online as well:
+
+* Programming Ruby: http://www.ruby-doc.org/docs/ProgrammingRuby/ (Pickaxe)
+* Learn to Program: http://pine.fm/LearnToProgram/ (a beginners guide)
+
+These two books will bring you up to speed on the Ruby language and also on
+programming in general.
+
+
+== Debugger
+
+Debugger support is available through the debugger command when you start your
+Mongrel or WEBrick server with --debugger. This means that you can break out of
+execution at any point in the code, investigate and change the model, and then,
+resume execution! You need to install ruby-debug to run the server in debugging
+mode. With gems, use <tt>sudo gem install ruby-debug</tt>. Example:
+
+  class WeblogController < ActionController::Base
+    def index
+      @posts = Post.all
+      debugger
+    end
+  end
+
+So the controller will accept the action, run the first line, then present you
+with a IRB prompt in the server window. Here you can do things like:
+
+  >> @posts.inspect
+  => "[#<Post:0x14a6be8
+          @attributes={"title"=>nil, "body"=>nil, "id"=>"1"}>,
+       #<Post:0x14a6620
+          @attributes={"title"=>"Rails", "body"=>"Only ten..", "id"=>"2"}>]"
+  >> @posts.first.title = "hello from a debugger"
+  => "hello from a debugger"
+
+...and even better, you can examine how your runtime objects actually work:
+
+  >> f = @posts.first
+  => #<Post:0x13630c4 @attributes={"title"=>nil, "body"=>nil, "id"=>"1"}>
+  >> f.
+  Display all 152 possibilities? (y or n)
+
+Finally, when you're ready to resume execution, you can enter "cont".
+
+
+== Console
+
+The console is a Ruby shell, which allows you to interact with your
+application's domain model. Here you'll have all parts of the application
+configured, just like it is when the application is running. You can inspect
+domain models, change values, and save to the database. Starting the script
+without arguments will launch it in the development environment.
+
+To start the console, run <tt>rails console</tt> from the application
+directory.
+
+Options:
+
+* Passing the <tt>-s, --sandbox</tt> argument will rollback any modifications
+  made to the database.
+* Passing an environment name as an argument will load the corresponding
+  environment. Example: <tt>rails console production</tt>.
+
+To reload your controllers and models after launching the console run
+<tt>reload!</tt>
+
+More information about irb can be found at:
+link:http://www.rubycentral.org/pickaxe/irb.html
+
+
+== dbconsole
+
+You can go to the command line of your database directly through <tt>rails
+dbconsole</tt>. You would be connected to the database with the credentials
+defined in database.yml. Starting the script without arguments will connect you
+to the development database. Passing an argument will connect you to a different
+database, like <tt>rails dbconsole production</tt>. Currently works for MySQL,
+PostgreSQL and SQLite 3.
+
+== Description of Contents
+
+The default directory structure of a generated Ruby on Rails application:
+
+  |-- app
+  |   |-- assets
+  |       |-- images
+  |       |-- javascripts
+  |       `-- stylesheets
+  |   |-- controllers
+  |   |-- helpers
+  |   |-- mailers
+  |   |-- models
+  |   `-- views
+  |       `-- layouts
+  |-- config
+  |   |-- environments
+  |   |-- initializers
+  |   `-- locales
+  |-- db
+  |-- doc
+  |-- lib
+  |   `-- tasks
+  |-- log
+  |-- public
+  |-- script
+  |-- test
+  |   |-- fixtures
+  |   |-- functional
+  |   |-- integration
+  |   |-- performance
+  |   `-- unit
+  |-- tmp
+  |   |-- cache
+  |   |-- pids
+  |   |-- sessions
+  |   `-- sockets
+  `-- vendor
+      |-- assets
+          `-- stylesheets
+      `-- plugins
+
+app
+  Holds all the code that's specific to this particular application.
+
+app/assets
+  Contains subdirectories for images, stylesheets, and JavaScript files.
+
+app/controllers
+  Holds controllers that should be named like weblogs_controller.rb for
+  automated URL mapping. All controllers should descend from
+  ApplicationController which itself descends from ActionController::Base.
+
+app/models
+  Holds models that should be named like post.rb. Models descend from
+  ActiveRecord::Base by default.
+
+app/views
+  Holds the template files for the view that should be named like
+  weblogs/index.html.erb for the WeblogsController#index action. All views use
+  eRuby syntax by default.
+
+app/views/layouts
+  Holds the template files for layouts to be used with views. This models the
+  common header/footer method of wrapping views. In your views, define a layout
+  using the <tt>layout :default</tt> and create a file named default.html.erb.
+  Inside default.html.erb, call <% yield %> to render the view using this
+  layout.
+
+app/helpers
+  Holds view helpers that should be named like weblogs_helper.rb. These are
+  generated for you automatically when using generators for controllers.
+  Helpers can be used to wrap functionality for your views into methods.
+
+config
+  Configuration files for the Rails environment, the routing map, the database,
+  and other dependencies.
+
+db
+  Contains the database schema in schema.rb. db/migrate contains all the
+  sequence of Migrations for your schema.
+
+doc
+  This directory is where your application documentation will be stored when
+  generated using <tt>rake doc:app</tt>
+
+lib
+  Application specific libraries. Basically, any kind of custom code that
+  doesn't belong under controllers, models, or helpers. This directory is in
+  the load path.
+
+public
+  The directory available for the web server. Also contains the dispatchers and the
+  default HTML files. This should be set as the DOCUMENT_ROOT of your web
+  server.
+
+script
+  Helper scripts for automation and generation.
+
+test
+  Unit and functional tests along with fixtures. When using the rails generate
+  command, template test files will be generated for you and placed in this
+  directory.
+
+vendor
+  External libraries that the application depends on. Also includes the plugins
+  subdirectory. If the app has frozen rails, those gems also go here, under
+  vendor/rails/. This directory is in the load path.

data/test/dummy/Rakefile

@@ -0,0 +1,7 @@
+#!/usr/bin/env rake
+# 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__)
+
+Dummy::Application.load_tasks

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

@@ -0,0 +1,15 @@
+// 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
+// the compiled file.
+//
+// WARNING: THE FIRST BLANK LINE MARKS THE END OF WHAT'S TO BE PROCESSED, ANY BLANK LINE SHOULD
+// GO AFTER THE REQUIRES BELOW.
+//
+//= require jquery
+//= require jquery_ujs
+//= require_tree .

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

@@ -0,0 +1,13 @@
+/*
+ * 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 top of the
+ * compiled file, but it's generally better to create a new file per style scope.
+ *
+ *= require_self
+ *= require_tree .
+ */

data/test/dummy/app/controllers/application_controller.rb

@@ -0,0 +1,3 @@
+class ApplicationController < ActionController::Base
+  protect_from_forgery
+end

data/test/dummy/app/helpers/application_helper.rb

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

data/test/dummy/app/models/farmer.rb

@@ -0,0 +1,3 @@
+class Farmer < ActiveRecord::Base
+  attr_accessible :name
+end

data/test/dummy/app/views/layouts/application.html.erb

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Dummy</title>
+  <%= stylesheet_link_tag    "application", :media => "all" %>
+  <%= javascript_include_tag "application" %>
+  <%= csrf_meta_tags %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>