Overriding rails' default rake tasks

Ruby on-RailsRake

Ruby on-Rails Problem Overview


I have a Rails 2.2 project in which I want to override the functionality of the rake db:test:prepare task. I thought this would work, but it doesn't:

#lib/tasks/db.rake
namespace :db do
  namespace :test do
    desc "Overridden version of rails' standard db:test:prepare task since the schema dump used in that can't handle DB enums"  
    task :prepare => [:environment] do
      puts "doing db:structure:dump"
      Rake::Task['db:structure:dump'].invoke
      puts "doing db:test:clone_structure"
      Rake::Task['db:test:clone_structure'].invoke
    end   
  end
end

I get the standard task's behaviour. If I change the name of the task to :prepare2 and then do rake db:test:prepare2, then it works fine. The natural conclusion I draw from this is that my rake tasks are being defined before the built-in Rails ones, so mine is overridden by the standard :prepare task.

Can anyone see how I can fix this? I'd rather override it than have to use a new task. Thanks, max

Ruby on-Rails Solutions


Solution 1 - Ruby on-Rails

If you define a rake task that already exists, its execution gets appended to the original task's execution; both tasks will be executed.

If you want to redefine a task you need to clear the original task first:

Rake::Task["db:test:prepare"].clear

It's also useful to note that once a task has been executed in rake, it won't execute again even if you call it again. This is by design but you can call .reset on a task to allow it to be run again.

Solution 2 - Ruby on-Rails

You have to remove the default task before adding your own:

Rake.application.instance_variable_get('@tasks').delete('db:test:prepare')
namespace 'db' do
  namespace 'test' do
    task 'prepare' do
      # ...
    end
  end
end

A fairly popular idiom is to create a convenience method called remove_task like so:

Rake::TaskManager.class_eval do
  def remove_task(task_name)
    @tasks.delete(task_name.to_s)
  end
end

def remove_task(task_name)
  Rake.application.remove_task(task_name)
end

(Source: drnic/newgem)

Solution 3 - Ruby on-Rails

Create a new project.rake file at lib/tasks/, and paster below code into it.

namespace :mv do
desc "Display hint and info for your rails 4 project"
task info: :environment do
	puts 'Run rake test to test'
end
end

task(:default).clear.enhance ['mv:info']

inspired by [Krasimir Angelov's blog][1] [1]: http://blog.codingspree.net/2012/04/26/overwriting_rake_spec_task.html "Krasimir Angelov 's blog"

Attributions

All content for this solution is sourced from the original question on Stackoverflow.

The content on this page is licensed under the Attribution-ShareAlike 4.0 International (CC BY-SA 4.0) license.

Content TypeOriginal AuthorOriginal Content on Stackoverflow
QuestionMax WilliamsView Question on Stackoverflow
Solution 1 - Ruby on-RailsBrendon MuirView Answer on Stackoverflow
Solution 2 - Ruby on-RailsAlex PeattieView Answer on Stackoverflow
Solution 3 - Ruby on-RailsEric GuoView Answer on Stackoverflow