data_tasks 0.1.0 → 0.2.0

data/.gitignore

@@ -4,6 +4,8 @@ log/*.log
 pkg/
 *.sublime-*
 test/dummy/db/*.sqlite3
+test/dummy/db/migrate/*
+test/dummy/db/data_tasks/*
 test/dummy/log/*.log
 test/dummy/tmp/
 test/dummy/.sass-cache

data/README.md

@@ -32,6 +32,35 @@ Run all pending data tasks with rake:
 
     rake data:migrate
 
+## Common Problems
+
+If you're running your Rails processes in threadsafe mode, you'll get errors about undefined
+constants when trying to access model classes. You'll need to disable while running
+rake tasks. In your environment file (ex. `config/environments/production.rb`), change:
+
+    config.threadsafe!
+
+to:
+
+    config.threadsafe! unless $rails_rake_task
+
+If you don't want to make that change, you can explicitly load the required model classes
+inside the migration class, or define stub model classes. For example, if you wanted to
+add a new SideHatch record in the migration, you could define:
+
+    class SideHatch < ActiveRecord::Base; end
+
+    class CreateSideHatch < ActiveRecord::Migration
+      def up
+        SideHatch.create!(size: 49)
+      end
+    end
+
+## Future
+
+ * Add a capistrano hook to run data migrations after schema migrations
+ * Add a heroku-san deployment strategy
+
 ## Contributing
 
 1. Fork it

data/data_tasks.gemspec

@@ -21,7 +21,7 @@ Gem::Specification.new do |s|
   s.test_files    = s.files.grep(%r{^(test|spec|features)/})
   s.require_paths = ["lib"]
 
-  s.add_dependency "rails", "~> 3.2.8"
+  s.add_dependency "rails", "~> 3.2.11"
 
   s.add_development_dependency "sqlite3"
   s.add_development_dependency "jquery-rails"

data/lib/data_tasks/version.rb

@@ -1,3 +1,3 @@
 module DataTasks
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

data/lib/tasks/data_tasks.rake

@@ -1,8 +1,27 @@
 namespace :data do
 
+  DATA_MIGRATIONS_PATHS = ['db/data_tasks']
+
+  desc 'Prevents existing data tasks from being run'
+  task assume_migrated: :environment  do
+    migrations_paths = DATA_MIGRATIONS_PATHS
+    paths = migrations_paths.map {|p| "#{p}/[0-9]*_*.rb" }
+    versions = Dir[*paths].map do |filename|
+      filename.split('/').last.split('_').first.to_i
+    end
+
+    sm_table = ActiveRecord::Schema.quote_table_name(ActiveRecord::Migrator.schema_migrations_table_name)
+    migrated = ActiveRecord::Schema.select_values("SELECT version FROM #{sm_table}").map { |v| v.to_i }
+    versions_to_insert = (versions - migrated).uniq
+
+    versions_to_insert.each do |version|
+      ActiveRecord::Schema.execute "INSERT INTO #{sm_table} (version) VALUES ('#{version}')"
+    end
+  end
+
   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)
+    ActiveRecord::Migrator.migrate(DATA_MIGRATIONS_PATHS, ENV["VERSION"] ? ENV["VERSION"].to_i : nil)
   end
 end

data/test/data_tasks_test.rb

@@ -52,6 +52,18 @@ class DataTaskTest < ActiveSupport::TestCase
     FileUtils.mv(tmp_filename, filename)
   end
 
+  def prepare_app_for_record_migration
+    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/)
+    end
+  end
+
   test 'runs a data task with a rake task' do
     in_dummy_app do
       execute("rails generate model Farmer name:string --fixture false")
@@ -73,19 +85,32 @@ class DataTaskTest < ActiveSupport::TestCase
 
   end
 
-  test 'does not interfere with database rollback' do
+  test 'provides ability to assume migrations have already run' do
+    prepare_app_for_record_migration
+
+    in_dummy_app do
+      execute("rake data:assume_migrated")
+      execute("rake data:migrate")
+
+      record_count = execute(%{rails runner "puts Record.count"}).strip
+      assert_equal '0', record_count
+    end
+  end
+
+  test 'does not interfere with schema rollback' do
     pending 'Implement the test'
   end
 
   test 'does not run the same task twice' do
+    prepare_app_for_record_migration
     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")
+      # 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/)
+      # 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")
 

metadata

@@ -1,64 +1,64 @@
 --- !ruby/object:Gem::Specification
 name: data_tasks
 version: !ruby/object:Gem::Version
-  version: 0.1.0
   prerelease: 
+  version: 0.2.0
 platform: ruby
 authors:
 - Jason Wadsworth
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-11-28 00:00:00.000000000 Z
+date: 2013-01-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: rails
-  requirement: !ruby/object:Gem::Requirement
-    none: false
+  version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 3.2.8
+        version: 3.2.11
+    none: false
+  name: rails
   type: :runtime
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 3.2.8
-- !ruby/object:Gem::Dependency
-  name: sqlite3
-  requirement: !ruby/object:Gem::Requirement
+        version: 3.2.11
     none: false
+- !ruby/object:Gem::Dependency
+  version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+    none: false
+  name: sqlite3
   type: :development
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: jquery-rails
-  requirement: !ruby/object:Gem::Requirement
     none: false
+- !ruby/object:Gem::Dependency
+  version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+    none: false
+  name: jquery-rails
   type: :development
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+    none: false
 description: ! "\n    Adds a second migration phase to a Rails project for data migrations.
   Just\n    like migrations, these can be run once and only once in each environment\n
   \   with a single command during every deployment.\n  "
@@ -107,8 +107,6 @@ files:
 - test/dummy/config/initializers/wrap_parameters.rb
 - test/dummy/config/locales/en.yml
 - test/dummy/config/routes.rb
-- test/dummy/db/data_tasks/20121128182853_add_farmer.rb
-- test/dummy/db/migrate/20121128182851_create_farmers.rb
 - test/dummy/db/schema.rb
 - test/dummy/lib/assets/.gitkeep
 - test/dummy/log/.gitkeep
@@ -125,17 +123,17 @@ rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
-required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
+required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+  none: false
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23
@@ -169,8 +167,6 @@ test_files:
 - test/dummy/config/initializers/wrap_parameters.rb
 - test/dummy/config/locales/en.yml
 - test/dummy/config/routes.rb
-- test/dummy/db/data_tasks/20121128182853_add_farmer.rb
-- test/dummy/db/migrate/20121128182851_create_farmers.rb
 - test/dummy/db/schema.rb
 - test/dummy/lib/assets/.gitkeep
 - test/dummy/log/.gitkeep

data/test/dummy/db/data_tasks/20121128182853_add_farmer.rb

@@ -1,10 +0,0 @@
-class AddFarmer < ActiveRecord::Migration
-class Farmer < ActiveRecord::Base; end
-  def up
-    say_with_time "migrating data" do
-farmer = Farmer.new
-farmer.name = "Al"
-farmer.save!
-    end
-  end
-end

data/test/dummy/db/migrate/20121128182851_create_farmers.rb

@@ -1,9 +0,0 @@
-class CreateFarmers < ActiveRecord::Migration
-  def change
-    create_table :farmers do |t|
-      t.string :name
-
-      t.timestamps
-    end
-  end
-end