taskmaster

Make your Ruby classes cron-aware! Taskmaster is a wrapper around the whenever gem that allows you to define your cron jobs within arbitrary Ruby classes, keeping those declarations next to the logic they rely on.

The base case is simple -- just include the Taskmaster::Henchman module, define a run class method, and use whenever syntax to specify when and how often the method should run:

require 'taskmaster'

class FootSoldier
  include Taskmaster::Henchman

  every 10.minutes, :at => 5

  def self.run
    # do super cool and important stuff
  end
end

puts FootSoldier.cron_output # => "5,15,25,35,45,55 * * * * /bin/bash -l -c 'cd /... && script/runner -e production '\''BulkTask.run'\'''"

For details on the options accepted by every, see the documentation for {Taskmaster::Henchman::ClassMethods#every}.

To actually use this in production, though, you'll want to rely on the taskmaster:write Rake task. Once you've defined your various jobs in the classes:

$ rake taskmaster:write
Your crontab has been written to config/schedule.rb. Please use the whenever script to write it to your system crontab.
$ whenever --write
[write] crontab file written

• Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
• Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
• Fork the project
• Start a feature/bugfix branch
• Commit and push until you are happy with your contribution
• Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
• Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.

Copyright (c) 2011 Ben Scofield. See LICENSE.txt for further details.