whenever 0.5.3 → 0.6.1

data/CHANGELOG.rdoc

@@ -1,3 +1,12 @@
+== 0.6.1 / October 20th, 2010
+
+* Detect script/rails file and change runner to Rails 3 style if found. [Javan Makhmali]
+
+* Created a new :job_template system that can be applied to all commands. Wraps all in bash -l -c 'command..' by default now for better RVM support. Stopped automatically setting the PATH too. [Javan Makhmali]
+
+* Added a built-in Capistrano recipe. [Javan Makhmali]
+
+
 == 0.5.3 / September 24th, 2010
 
 * Better regexes for replacing Whenever blocks in the crontab. #45 [Javan Makhmali]

data/README.rdoc

@@ -1,15 +1,15 @@
 == Introduction
 
-Whenever is a Ruby gem that provides a clear syntax for defining cron jobs. It outputs valid cron syntax and can even write your crontab file for you. It is designed to work well with Rails applications and can be deployed with Capistrano. Whenever works fine independently as well.
-
-Ryan Bates created a great Railscast about Whenever: http://railscasts.com/episodes/164-cron-in-ruby
-
-Discussion: http://groups.google.com/group/whenever-gem
+Whenever is a Ruby gem that provides a clear syntax for writing and deploying cron jobs.
 
 == Installation
   
-$ sudo gem install whenever
+  $ gem install whenever
 
+Or with Bundler in your Gemfile.
+
+  gem 'whenever', :require => false
+ 
 == Getting started
 
   $ cd /my/rails/app
@@ -41,7 +41,7 @@ More examples on the wiki: http://wiki.github.com/javan/whenever/instructions-an
 
 == Define your own job types
 
-Whenever ships with three pre-defined job types: command, runner, and rake. You can define your own with <code>job_type</code>.
+Whenever ships with three pre-defined job types: command, runner, and rake. You can define your own with `job_type`.
 
 For example:
 
@@ -51,43 +51,52 @@ For example:
     awesome "party", :fun_level => "extreme"
   end
   
-Would run <code>/usr/local/bin/awesome party extreme</code> every two hours. <code>:task</code> is always replaced with the first argument, and any additional <code>:whatevers</code> are replaced with the options passed in or by variables that have been defined with <code>set</code>.
+Would run `/usr/local/bin/awesome party extreme` every two hours. `:task` is always replaced with the first argument, and any additional `:whatevers` are replaced with the options passed in or by variables that have been defined with `set`.
 
 The default job types that ship with Whenever are defined like so:
 
-  job_type :command, ":task"
-  job_type :runner,  "cd :path && script/runner -e :environment ':task'"
-  job_type :rake,    "cd :path && RAILS_ENV=:environment /usr/bin/env rake :task"
+  job_type :command, ":task :output"
+  job_type :rake,    "cd :path && RAILS_ENV=:environment rake :task :output"
+  job_type :runner,  "cd :path && script/runner -e :environment ':task' :output"
+  
+If a script/rails file is detected (like in a Rails 3 app), runner will be defined to fit:
 
-If a <code>:path</code> is not set it will default to the directory in which <code>whenever</code> was executed. <code>:environment</code> will default to 'production'.
+  job_type :runner,  "cd :path && script/rails runner -e :environment ':task' :output"
 
-== Cron output
+If a `:path` is not set it will default to the directory in which `whenever` was executed. `:environment` will default to 'production'. `:output` will be replaced with your output redirection settings which you can read more about here: http://github.com/javan/whenever/wiki/Output-redirection-(logging-your-cron-jobs)
 
-  $ cd /my/rails/app
-  $ whenever
+All jobs are by default run with `bash -l -c 'command...'`. Among other things, this allows your cron jobs to play nice with RVM by loading the entire environment instead of cron's somewhat limited environment. Read more: http://blog.scoutapp.com/articles/2010/09/07/rvm-and-cron-in-production
 
-And you'll see your schedule.rb converted to cron sytax. Note: running `whenever' with no options does not display your current crontab file, it simply shows you the output of converting your schedule.rb file.
+You can change this by setting your own job_template.
+
+  set :job_template, "bash -l -c ':job'"
+  
+Or set the job_template to nil to have your jobs execute normally.
+
+  set :job_template, nil
+
+And you'll see your schedule.rb converted to cron sytax. Note: running `whenever` with no options does not display your current crontab file, it simply shows you the output of converting your schedule.rb file.
 
 == Capistrano integration
 
-In your "config/deploy.rb" file do something like:
+Use the built-in Capistrano recipe for easy crontab updates with deploys.
 
-  after "deploy:symlink", "deploy:update_crontab"
+In your "config/deploy.rb" file:
 
-  namespace :deploy do
-    desc "Update the crontab file"
-    task :update_crontab, :roles => :db do
-      run "cd #{release_path} && whenever --update-crontab #{application}"
-    end
-  end
+  require "whenever/capistrano"
 
-This will update your crontab file, leaving any existing entries unharmed. When using the <code>--update-crontab</code> option, Whenever will only update the entries in your crontab file related to the current schedule.rb file. You can replace the <code>#{application}</code> with any identifying string you'd like. You can have any number of apps deploy to the same crontab file peacefully given they each use a different identifier.
+Take a look at the recipe for options you can set. http://github.com/javan/whenever/blob/master/lib/whenever/capistrano.rb
+For example, if you're using bundler do this:
 
-If you wish to simply overwrite your crontab file each time you deploy, use the <code>--write-crontab</code> option. This is ideal if you are only working with one app and every crontab entry is contained in a single schedule.rb file.
+  set :whenever_command, "bundle exec whenever"
+  require "whenever/capistrano"
 
-By mixing and matching the <code>--load-file</code> and <code>--user</code> options with your various :roles in Capistrano it is entirely possible to deploy different crontab schedules under different users to all your various servers. Get creative!
+== The `whenever` command
 
-If you want to override a variable (like your environment) at the time of deployment you can do so with the <code>--set</code> option: http://wiki.github.com/javan/whenever/setting-variables-on-the-fly
+  $ cd /my/rails/app
+  $ whenever
+  
+This will simply show you your schedule.rb file converted to cron syntax. It does not read or write your crontab file. Run `whenever --help` for a complete list of options.
 
 == Credit
 
@@ -101,6 +110,9 @@ For general discussion and questions, please use the google group: http://groups
 
 If you've found a genuine bug or issue, please use the Issues section on github: http://github.com/javan/whenever/issues
 
+Ryan Bates created a great Railscast about Whenever: http://railscasts.com/episodes/164-cron-in-ruby
+It's a little bit dated now, but remains a good introduction.
+
 == License
 
 Copyright (c) 2009+ Javan Makhmali

data/Rakefile

@@ -8,8 +8,8 @@ begin
   Jeweler::Tasks.new do |gemspec|
     gemspec.name        = "whenever"
     gemspec.version     = Whenever::VERSION
-    gemspec.summary     = "Clean ruby syntax for defining and deploying messy cron jobs."
-    gemspec.description = "Clean ruby syntax for defining and deploying messy cron jobs."
+    gemspec.summary     = "Clean ruby syntax for writing and deploying cron jobs."
+    gemspec.description = "http://www.allyrics.net/Kid-Cudi/lyrics/Whenever/"
     gemspec.email       = "javan@javan.us"
     gemspec.homepage    = "http://github.com/javan/whenever"
     gemspec.authors     = ["Javan Makhmali"]

data/bin/whenever

@@ -4,32 +4,35 @@ require 'rubygems'
 require 'optparse'
 require 'whenever'
 
-options = Hash.new
+options = {}
 
 OptionParser.new do |opts|
   opts.banner = "Usage: whenever [options]"
-  opts.on('-v', '--version') { puts "Whenever v#{Whenever::VERSION}"; exit(0) }
-  opts.on('-w', '--write-crontab') { options[:write] = true }
-  opts.on('-c', '--cut [lines]', 'Cut lines from the top of the cronfile') do |lines|
-    options[:cut] = lines.to_i if lines
-  end
   opts.on('-i', '--update-crontab [identifier]', 'Default: full path to schedule.rb file') do |identifier|
     options[:update] = true
     options[:identifier] = identifier if identifier
   end
+  opts.on('-w', '--write-crontab [identifier]', 'Default: full path to schedule.rb file') do |identifier|
+     options[:write] = true
+     options[:identifier] = identifier if identifier
+  end
   opts.on('-c', '--clear-crontab [identifier]') do |identifier|
     options[:clear] = true
     options[:identifier] = identifier if identifier
   end
+  opts.on('-s', '--set [variables]', 'Example: --set environment=staging&path=/my/sweet/path') do |set|
+    options[:set] = set if set
+  end
   opts.on('-f', '--load-file [schedule file]', 'Default: config/schedule.rb') do |file|
     options[:file] = file if file
   end
   opts.on('-u', '--user [user]', 'Default: current user') do |user| 
     options[:user] = user if user
   end
-  opts.on('-s', '--set [variables]', 'Example: --set environment=staging&path=/my/sweet/path') do |set|
-    options[:set] = set if set
+  opts.on('-k', '--cut [lines]', 'Cut lines from the top of the cronfile') do |lines|
+    options[:cut] = lines.to_i if lines
   end
+  opts.on('-v', '--version') { puts "Whenever v#{Whenever::VERSION}"; exit(0) }
 end.parse!
 
 Whenever::CommandLine.execute(options)

data/lib/whenever/capistrano.rb

@@ -0,0 +1,31 @@
+Capistrano::Configuration.instance(:must_exist).load do
+  
+  _cset(:whenever_roles)        { :db }
+  _cset(:whenever_command)      { "whenever" }
+  _cset(:whenever_identifier)   { application }
+  _cset(:whenever_update_flags) { "--update-crontab #{whenever_identifier}" }
+  _cset(:whenever_clear_flags)  { "--clear-crontab #{whenever_identifier}" }
+  
+  # Disable cron jobs at the begining of a deploy.
+  after "deploy:update_code", "whenever:clear_crontab"
+  # Write the new cron jobs near the end.
+  after "deploy:symlink", "whenever:update_crontab"
+  # If anything goes wrong, undo.
+  after "deploy:rollback", "whenever:update_crontab"
+  
+  namespace :whenever do
+    desc "Update application's crontab entries using Whenever"
+    task :update_crontab, :roles => whenever_roles do
+      # Hack by Jamis to skip a task if the role has no servers defined. http://tinyurl.com/ckjgnz
+      next if find_servers_for_task(current_task).empty?
+      run "cd #{current_path} && #{whenever_command} #{whenever_update_flags}"
+    end
+
+    desc "Clear application's crontab entries using Whenever"
+    task :clear_crontab, :roles => whenever_roles do
+      next if find_servers_for_task(current_task).empty?
+      run "cd #{release_path} && #{whenever_command} #{whenever_clear_flags}"
+    end
+  end
+  
+end

data/lib/whenever/cron.rb

@@ -4,11 +4,10 @@ module Whenever
 
       attr_accessor :time, :task
 
-      def initialize(time = nil, task = nil, at = nil, output_redirection = nil)
+      def initialize(time = nil, task = nil, at = nil)
         @time = time
         @task = task
         @at   = at.is_a?(String) ? (Chronic.parse(at) || 0) : (at || 0)
-        @output_redirection = output_redirection
       end
 
       def self.enumerate(item)
@@ -24,13 +23,13 @@ module Whenever
       def self.output(times, job)
         enumerate(times).each do |time|
           enumerate(job.at).each do |at|
-            yield new(time, job.output, at, job.output_redirection).output
+            yield new(time, job.output, at).output
           end
         end
       end
       
       def output
-        [time_in_cron_syntax, task, output_redirection].compact.join(' ').strip
+        [time_in_cron_syntax, task].compact.join(' ').strip
       end
 
       def time_in_cron_syntax
@@ -40,10 +39,6 @@ module Whenever
           else parse_time
         end
       end
-      
-      def output_redirection
-        Whenever::Output::Cron::OutputRedirection.new(@output_redirection).to_s unless @output_redirection == :not_set
-      end
 
     protected
 

data/lib/whenever/job.rb

@@ -1,21 +1,29 @@
 module Whenever
   class Job
     
-    attr_reader :at, :output_redirection
+    attr_reader :at
   
     def initialize(options = {})
       @options = options
-      
-      @at                      = options[:at]
-      @output_redirection      = options.has_key?(:output) ? options[:output] : :not_set
+      @at                      = options.delete(:at)
+      @template                = options.delete(:template)
+      @job_template            = options.delete(:job_template) || ":job"
+      @options[:output]        = Whenever::Output::Redirection.new(options[:output]).to_s if options.has_key?(:output)
       @options[:environment] ||= :production
       @options[:path]        ||= Whenever.path
     end
   
     def output
-      @options[:template].dup.gsub(/:\w+/) do |key|
+      job = process_template(@template, @options).strip
+      process_template(@job_template, { :job => job }).strip
+    end
+    
+  protected
+  
+    def process_template(template, options)
+      template.gsub(/:\w+/) do |key|
         before_and_after = [$`[-1..-1], $'[0..0]]
-        option = @options[key.sub(':', '').to_sym]
+        option = options[key.sub(':', '').to_sym]
 
         if before_and_after.all? { |c| c == "'" }
           escape_single_quotes(option)
@@ -26,8 +34,6 @@ module Whenever
         end
       end
     end
-    
-  protected
 
     def escape_single_quotes(str)
       str.gsub(/'/) { "'\\''" }

data/lib/whenever/job_list.rb

@@ -2,7 +2,7 @@ module Whenever
   class JobList
   
     def initialize(options)
-      @jobs, @env, @set_variables = {}, {}, {}
+      @jobs, @env, @set_variables, @pre_set_variables = {}, {}, {}, {}
       
       case options
         when String
@@ -25,7 +25,8 @@ module Whenever
     end
     
     def set(variable, value)
-      return if instance_variable_defined?("@#{variable}".to_sym)
+      variable = variable.to_sym
+      return if @pre_set_variables[variable]
       
       instance_variable_set("@#{variable}".to_sym, value)
       self.class.send(:attr_reader, variable.to_sym)
@@ -59,9 +60,7 @@ module Whenever
       end
     end
   
-    def generate_cron_output
-      set_path_environment_variable
-      
+    def generate_cron_output      
       [environment_variables, cron_jobs].compact.join
     end
     
@@ -79,22 +78,13 @@ module Whenever
       pairs.each do |pair|
         next unless pair.index('=')
         variable, value = *pair.split('=')
-        set(variable.strip.to_sym, value.strip) unless variable.blank? || value.blank?
+        unless variable.blank? || value.blank?
+          variable = variable.strip.to_sym
+          set(variable, value.strip)
+          @pre_set_variables[variable] = value
+        end
       end
     end
-    
-    def set_path_environment_variable
-      return if path_should_not_be_set_automatically?
-      @env[:PATH] = read_path unless read_path.blank?
-    end
-    
-    def read_path
-      ENV['PATH'] if ENV
-    end
-    
-    def path_should_not_be_set_automatically?
-      @set_path_automatically === false || @env[:PATH] || @env["PATH"]
-    end
   
     def environment_variables
       return if @env.empty?

data/lib/whenever/job_types/default.rb

@@ -1,3 +1,11 @@
-job_type :command, ":task"
-job_type :runner,  "cd :path && script/runner -e :environment ':task'"
-job_type :rake,    "cd :path && RAILS_ENV=:environment /usr/bin/env rake :task"
+# http://blog.scoutapp.com/articles/2010/09/07/rvm-and-cron-in-production
+set :job_template, "/bin/bash -l -c ':job'"
+
+job_type :command, ":task :output"
+job_type :rake,    "cd :path && RAILS_ENV=:environment rake :task --silent :output"
+
+if File.exists?(File.join(Whenever.path, 'script', 'rails'))
+  job_type :runner, "cd :path && script/rails runner -e :environment ':task' :output"
+else
+  job_type :runner, "cd :path && script/runner -e :environment ':task' :output"
+end

data/lib/whenever/output_redirection.rb

@@ -1,60 +1,58 @@
 module Whenever
   module Output
-    class Cron
-      class OutputRedirection
-        
-        def initialize(output)
-          @output = output
-        end
-        
-        def to_s
-          return '' unless defined?(@output)
-          case @output
-            when String   then redirect_from_string
-            when Hash     then redirect_from_hash
-            when NilClass then ">> /dev/null 2>&1"
-            else ''
-          end 
-        end
-        
-      protected
-        
-        def stdout
-          return unless @output.has_key?(:standard)
-          @output[:standard].nil? ? '/dev/null' : @output[:standard]
-        end
+    class Redirection
+      
+      def initialize(output)
+        @output = output
+      end
+      
+      def to_s
+        return '' unless defined?(@output)
+        case @output
+          when String   then redirect_from_string
+          when Hash     then redirect_from_hash
+          when NilClass then ">> /dev/null 2>&1"
+          else ''
+        end 
+      end
+      
+    protected
+      
+      def stdout
+        return unless @output.has_key?(:standard)
+        @output[:standard].nil? ? '/dev/null' : @output[:standard]
+      end
 
-        def stderr
-          return unless @output.has_key?(:error)
-          @output[:error].nil? ? '/dev/null' : @output[:error]
-        end
+      def stderr
+        return unless @output.has_key?(:error)
+        @output[:error].nil? ? '/dev/null' : @output[:error]
+      end
 
-        def redirect_from_hash
-          case
-            when stdout == '/dev/null' && stderr == '/dev/null'
-              "> /dev/null 2>&1"
-            when stdout && stderr == '/dev/null'
-              ">> #{stdout} 2> /dev/null"
-            when stdout && stderr
-              ">> #{stdout} 2>> #{stderr}"
-            when stderr == '/dev/null'
-              "2> /dev/null"
-            when stderr
-              "2>> #{stderr}"
-            when stdout == '/dev/null'
-              "> /dev/null"
-            when stdout
-              ">> #{stdout}"
-            else
-              ''
-          end
+      def redirect_from_hash
+        case
+          when stdout == '/dev/null' && stderr == '/dev/null'
+            "> /dev/null 2>&1"
+          when stdout && stderr == '/dev/null'
+            ">> #{stdout} 2> /dev/null"
+          when stdout && stderr
+            ">> #{stdout} 2>> #{stderr}"
+          when stderr == '/dev/null'
+            "2> /dev/null"
+          when stderr
+            "2>> #{stderr}"
+          when stdout == '/dev/null'
+            "> /dev/null"
+          when stdout
+            ">> #{stdout}"
+          else
+            ''
         end
+      end
 
-        def redirect_from_string
-          ">> #{@output} 2>&1"
-        end
-        
+      def redirect_from_string
+        ">> #{@output} 2>&1"
       end
+      
     end
   end
 end

data/lib/whenever/version.rb

@@ -1,3 +1,3 @@
 module Whenever
-  VERSION = '0.5.3' 
+  VERSION = '0.6.1' 
 end unless defined?(Whenever::VERSION)

data/test/functional/command_line_test.rb

@@ -217,6 +217,7 @@ NEW_CRON
     setup do
       @output = Whenever.cron :set => 'environment=serious', :string => \
       <<-file
+        set :job_template, nil
         set :environment, :silly
         set :path, '/my/path'
         every 2.hours do
@@ -234,6 +235,7 @@ NEW_CRON
     setup do
       @output = Whenever.cron :set => 'environment=serious&path=/serious/path', :string => \
       <<-file
+        set :job_template, nil
         set :environment, :silly
         set :path, '/silly/path'
         every 2.hours do
@@ -251,6 +253,7 @@ NEW_CRON
     setup do
       @output = Whenever.cron :set => ' environment = serious&  path =/serious/path', :string => \
       <<-file
+        set :job_template, nil
         set :environment, :silly
         set :path, '/silly/path'
         every 2.hours do
@@ -268,6 +271,7 @@ NEW_CRON
     setup do
       @output = Whenever.cron :set => ' environment=', :string => \
       <<-file
+        set :job_template, nil
         set :environment, :silly
         set :path, '/silly/path'
         every 2.hours do

data/test/functional/output_at_test.rb

@@ -6,6 +6,7 @@ class OutputAtTest < Test::Unit::TestCase
     setup do
       @output = Whenever.cron \
       <<-file
+        set :job_template, nil
         every "weekday", :at => '5:02am' do
           command "blahblah"
         end
@@ -21,6 +22,7 @@ class OutputAtTest < Test::Unit::TestCase
     setup do
       @output = Whenever.cron \
       <<-file
+        set :job_template, nil
         every "weekday", :at => %w(5:02am 3:52pm) do
           command "blahblah"
         end
@@ -37,6 +39,7 @@ class OutputAtTest < Test::Unit::TestCase
     setup do
       @output = Whenever.cron \
       <<-file
+        set :job_template, nil
         every "weekday", :at => '5:02am, 3:52pm' do
           command "blahblah"
         end
@@ -53,6 +56,7 @@ class OutputAtTest < Test::Unit::TestCase
     setup do
       @output = Whenever.cron \
       <<-file
+        set :job_template, nil
         every "weekday", :at => '5:02am, 3:02pm' do
           command "blahblah"
         end
@@ -68,6 +72,7 @@ class OutputAtTest < Test::Unit::TestCase
     setup do
       @output = Whenever.cron \
       <<-file
+        set :job_template, nil
         every "mon,wed,fri", :at => '5:02am, 3:02pm' do
           command "blahblah"
         end
@@ -83,6 +88,7 @@ class OutputAtTest < Test::Unit::TestCase
     setup do
       @output = Whenever.cron \
       <<-file
+        set :job_template, nil
         set :path, '/your/path'
         every "mon,wed,fri", :at => '5:02am, 3:02pm' do
           runner "blahblah"
@@ -99,6 +105,7 @@ class OutputAtTest < Test::Unit::TestCase
     setup do
       @output = Whenever.cron \
       <<-file
+        set :job_template, nil
         set :path, '/your/path'
         every "mon,wed,fri", :at => '5:02am, 3:02pm' do
           rake "blah:blah"
@@ -107,7 +114,7 @@ class OutputAtTest < Test::Unit::TestCase
     end
     
     should "output the rake task using one entry because the times are aligned" do
-      assert_match '2 5,15 * * 1,3,5 cd /your/path && RAILS_ENV=production /usr/bin/env rake blah:blah', @output
+      assert_match '2 5,15 * * 1,3,5 cd /your/path && RAILS_ENV=production rake blah:blah --silent', @output
     end
   end
   
@@ -115,6 +122,7 @@ class OutputAtTest < Test::Unit::TestCase
     setup do
       @output = Whenever.cron \
       <<-file
+        set :job_template, nil
         every [1.month, 1.day], :at => 'january 5:02am, june 17th at 2:22pm, june 3rd at 3:33am' do
           command "blahblah"
         end
@@ -138,6 +146,7 @@ class OutputAtTest < Test::Unit::TestCase
     setup do
       @output = Whenever.cron \
       <<-file
+        set :job_template, nil
         every :reboot do
           command "command_1"
           command "command_2"
@@ -155,6 +164,7 @@ class OutputAtTest < Test::Unit::TestCase
     setup do
       @output = Whenever.cron \
       <<-file
+        set :job_template, nil
         set :path, '/your/path'
         every :day do
           rake "blah:blah"
@@ -167,7 +177,7 @@ class OutputAtTest < Test::Unit::TestCase
     end
     
     should "output all of the commands @daily" do
-      assert_match '@daily cd /your/path && RAILS_ENV=production /usr/bin/env rake blah:blah', @output
+      assert_match '@daily cd /your/path && RAILS_ENV=production rake blah:blah --silent', @output
       assert_match %(@daily cd /your/path && script/runner -e production 'runner_1'), @output
       assert_match '@daily command_1', @output
       assert_match %(@daily cd /your/path && script/runner -e production 'runner_2'), @output
@@ -179,6 +189,7 @@ class OutputAtTest < Test::Unit::TestCase
     setup do
       @output = Whenever.cron \
       <<-file
+        set :job_template, nil
         every 5.minutes, :at => 1 do
           command "blahblah"
         end
@@ -194,6 +205,7 @@ class OutputAtTest < Test::Unit::TestCase
     setup do
       @output = Whenever.cron \
       <<-file
+        set :job_template, nil
         every 4.minutes, :at => 2 do
           command "blahblah"
         end
@@ -209,6 +221,7 @@ class OutputAtTest < Test::Unit::TestCase
     setup do
       @output = Whenever.cron \
       <<-file
+        set :job_template, nil
         every 3.minutes, :at => 7 do
           command "blahblah"
         end
@@ -224,6 +237,7 @@ class OutputAtTest < Test::Unit::TestCase
     setup do
       @output = Whenever.cron \
       <<-file
+        set :job_template, nil
         every 2.minutes, :at => 27 do
           command "blahblah"
         end

data/test/functional/output_default_defined_jobs_test.rb

@@ -4,10 +4,11 @@ class OutputDefaultDefinedJobsTest < Test::Unit::TestCase
   
   # command
   
-  context "A plain command" do
+  context "A plain command with the job template set to nil" do
     setup do
       @output = Whenever.cron \
       <<-file
+        set :job_template, nil
         every 2.hours do
           command "blahblah"
         end
@@ -19,12 +20,45 @@ class OutputDefaultDefinedJobsTest < Test::Unit::TestCase
     end
   end
   
+  context "A plain command with no job template set" do
+    setup do
+      @output = Whenever.cron \
+      <<-file
+        every 2.hours do
+          command "blahblah"
+        end
+      file
+    end
+    
+    should "output the command with the default job template" do
+      assert_match /^.+ .+ .+ .+ \/bin\/bash -l -c 'blahblah'$/, @output
+    end
+  end
+  
+  context "A plain command that overrides the job_template set" do
+    setup do
+      @output = Whenever.cron \
+      <<-file
+        set :job_template, "/bin/bash -l -c ':job'"
+        every 2.hours do
+          command "blahblah", :job_template => "/bin/sh -l -c ':job'"
+        end
+      file
+    end
+    
+    should "output the command using that job_template" do
+      assert_match /^.+ .+ .+ .+ \/bin\/sh -l -c 'blahblah'$/, @output
+      assert_no_match /bash/, @output
+    end
+  end
+
   # runner
   
   context "A runner with path set" do
     setup do
       @output = Whenever.cron \
       <<-file
+        set :job_template, nil
         set :path, '/my/path'
         every 2.hours do
           runner 'blahblah'
@@ -41,6 +75,7 @@ class OutputDefaultDefinedJobsTest < Test::Unit::TestCase
     setup do
       @output = Whenever.cron \
       <<-file
+        set :job_template, nil
         set :path, '/my/path'
         every 2.hours do
           runner "blahblah", :path => '/some/other/path'
@@ -53,12 +88,31 @@ class OutputDefaultDefinedJobsTest < Test::Unit::TestCase
     end
   end
   
+  context "A runner for a Rails 3 app" do
+    setup do
+      Whenever.expects(:path).at_least_once.returns('/my/path')
+      File.expects(:exists?).with('/my/path/script/rails').returns(true)
+      @output = Whenever.cron \
+      <<-file
+        set :job_template, nil
+        every 2.hours do
+          runner 'blahblah'
+        end
+      file
+    end
+    
+    should "use the Rails 3 runner job by default" do
+      assert_match two_hours + %( cd /my/path && script/rails runner -e production 'blahblah'), @output
+    end
+  end
+  
   # rake
   
   context "A rake command with path set" do
     setup do
       @output = Whenever.cron \
       <<-file
+        set :job_template, nil
         set :path, '/my/path'
         every 2.hours do
           rake "blahblah"
@@ -67,7 +121,7 @@ class OutputDefaultDefinedJobsTest < Test::Unit::TestCase
     end
     
     should "output the rake command using that path" do
-      assert_match two_hours + ' cd /my/path && RAILS_ENV=production /usr/bin/env rake blahblah', @output
+      assert_match two_hours + ' cd /my/path && RAILS_ENV=production rake blahblah --silent', @output
     end
   end
   
@@ -75,6 +129,7 @@ class OutputDefaultDefinedJobsTest < Test::Unit::TestCase
     setup do
       @output = Whenever.cron \
       <<-file
+        set :job_template, nil
         set :path, '/my/path'
         every 2.hours do
           rake "blahblah", :path => '/some/other/path'
@@ -83,7 +138,7 @@ class OutputDefaultDefinedJobsTest < Test::Unit::TestCase
     end
     
     should "output the rake command using that path" do
-      assert_match two_hours + ' cd /some/other/path && RAILS_ENV=production /usr/bin/env rake blahblah', @output
+      assert_match two_hours + ' cd /some/other/path && RAILS_ENV=production rake blahblah --silent', @output
     end
   end
   

data/test/functional/output_defined_job_test.rb

@@ -6,6 +6,7 @@ class OutputDefinedJobTest < Test::Unit::TestCase
     setup do
       @output = Whenever.cron \
       <<-file
+        set :job_template, nil
         job_type :some_job, "before :task after"
         every 2.hours do
           some_job "during"
@@ -22,6 +23,7 @@ class OutputDefinedJobTest < Test::Unit::TestCase
     setup do
       @output = Whenever.cron \
       <<-file
+        set :job_template, nil
         job_type :some_job, "before :task after :option1 :option2"
         every 2.hours do
           some_job "during", :option1 => 'happy', :option2 => 'birthday'
@@ -38,6 +40,7 @@ class OutputDefinedJobTest < Test::Unit::TestCase
     setup do
       @output = Whenever.cron \
       <<-file
+        set :job_template, nil
         job_type :some_job, "before :task after :option1"
         set :option1, 'happy'
         every 2.hours do
@@ -55,6 +58,7 @@ class OutputDefinedJobTest < Test::Unit::TestCase
     setup do
       @output = Whenever.cron \
       <<-file
+        set :job_template, nil
         job_type :some_job, "before :task after :option1"
         set :option1, 'global'
         every 2.hours do
@@ -72,6 +76,7 @@ class OutputDefinedJobTest < Test::Unit::TestCase
     setup do
       @output = Whenever.cron \
       <<-file
+        set :job_template, nil
         job_type :some_job, "before :task after :option1"
         every 2.hours do
           some_job "during", :option2 => 'happy'
@@ -86,10 +91,11 @@ class OutputDefinedJobTest < Test::Unit::TestCase
   
   context "A defined job that uses a :path where none is explicitly set" do
     setup do
-      Whenever.expects(:path).returns('/my/path')
+      Whenever.stubs(:path).returns('/my/path')
       
       @output = Whenever.cron \
       <<-file
+        set :job_template, nil
         job_type :some_job, "cd :path && :task"
         every 2.hours do
           some_job 'blahblah'

data/test/functional/output_env_test.rb

@@ -19,38 +19,5 @@ class OutputEnvTest < Test::Unit::TestCase
       assert_match "MAILTO=someone@example.com", @output
     end
   end
-  
-  context "No PATH environment variable set" do
-    setup do
-      Whenever::JobList.any_instance.expects(:read_path).at_least_once.returns('/usr/local/bin')
-      @output = Whenever.cron ""
-    end
-    
-    should "add a PATH variable based on the user's PATH" do
-      assert_match "PATH=/usr/local/bin", @output
-    end
-  end
-  
-  context "A PATH environment variable set" do
-    setup do
-      Whenever::JobList.stubs(:read_path).returns('/usr/local/bin')
-      @output = Whenever.cron "env :PATH, '/my/path'"
-    end
-    
-    should "use that path and the user's PATH" do
-      assert_match "PATH=/my/path", @output
-      assert_no_match /local/, @output
-    end
-  end
-  
-  context "No PATH set and instructed not to automatically load the user's path" do
-    setup do
-      @output = Whenever.cron "set :set_path_automatically, false"
-    end
-    
-    should "not have a PATH set" do
-      assert_no_match /PATH/, @output
-    end
-  end
 
 end

data/test/functional/output_redirection_test.rb

@@ -6,6 +6,7 @@ class OutputRedirectionTest < Test::Unit::TestCase
     setup do
       @output = Whenever.cron \
       <<-file
+        set :job_template, nil
         set :output, nil
         every 2.hours do
           command "blahblah"
@@ -23,6 +24,7 @@ class OutputRedirectionTest < Test::Unit::TestCase
     setup do
       @output = Whenever.cron \
       <<-file
+        set :job_template, nil
         set :output, 'logfile.log'
         every 2.hours do
           command "blahblah"
@@ -39,6 +41,7 @@ class OutputRedirectionTest < Test::Unit::TestCase
     setup do
       @output = Whenever.cron \
       <<-file
+        set :job_template, nil
         every 2.hours do
           command "blahblah", :output => {:standard => 'dev_null', :error => 'dev_err'}
         end
@@ -54,6 +57,7 @@ class OutputRedirectionTest < Test::Unit::TestCase
     setup do
       @output = Whenever.cron \
       <<-file
+        set :job_template, nil
         set :output, 'logfile.log'
         every 2.hours do
           command "blahblah", :output => 'otherlog.log'
@@ -71,6 +75,7 @@ class OutputRedirectionTest < Test::Unit::TestCase
     setup do
       @output = Whenever.cron \
       <<-file
+        set :job_template, nil
         set :output, 'logfile.log'
         every 2.hours do
           command "blahblah", :output => {:error => 'dev_err', :standard => 'dev_null' }
@@ -88,6 +93,7 @@ class OutputRedirectionTest < Test::Unit::TestCase
     setup do
       @output = Whenever.cron \
       <<-file
+        set :job_template, nil
         set :output, 'logfile.log'
         every 2.hours do
           command "blahblah", :output => false
@@ -105,6 +111,7 @@ class OutputRedirectionTest < Test::Unit::TestCase
     setup do
       @output = Whenever.cron :set => 'output=otherlog.log', :string => \
       <<-file
+        set :job_template, nil
         set :output, 'logfile.log'
         every 2.hours do
           command "blahblah"
@@ -122,6 +129,7 @@ class OutputRedirectionTest < Test::Unit::TestCase
     setup do
       @output = Whenever.cron \
       <<-file
+        set :job_template, nil
         set :output, {:error => 'dev_err', :standard => 'dev_null' }
         every 2.hours do
           command "blahblah"
@@ -138,6 +146,7 @@ class OutputRedirectionTest < Test::Unit::TestCase
     setup do
       @output = Whenever.cron \
       <<-file
+        set :job_template, nil
         set :output, {:error => 'dev_null'}
         every 2.hours do
           command "blahblah"
@@ -154,6 +163,7 @@ class OutputRedirectionTest < Test::Unit::TestCase
     setup do
       @output = Whenever.cron \
       <<-file
+        set :job_template, nil
         set :output, {:standard => 'dev_out'}
         every 2.hours do
           command "blahblah"
@@ -170,6 +180,7 @@ class OutputRedirectionTest < Test::Unit::TestCase
     setup do
       @output = Whenever.cron \
       <<-file
+        set :job_template, nil
         every 2.hours do
           command "blahblah", :output => {:error => 'dev_err'}
         end
@@ -185,6 +196,7 @@ class OutputRedirectionTest < Test::Unit::TestCase
     setup do
       @output = Whenever.cron \
       <<-file
+        set :job_template, nil
         every 2.hours do
           command "blahblah", :output => {:standard => 'dev_out'}
         end
@@ -200,6 +212,7 @@ class OutputRedirectionTest < Test::Unit::TestCase
     setup do
       @output = Whenever.cron \
       <<-file
+        set :job_template, nil
         every 2.hours do
           command "blahblah", :output => {:standard => nil}
         end
@@ -215,6 +228,7 @@ class OutputRedirectionTest < Test::Unit::TestCase
     setup do
       @output = Whenever.cron \
       <<-file
+        set :job_template, nil
         every 2.hours do
           command "blahblah", :output => {:error => nil}
         end
@@ -230,6 +244,7 @@ class OutputRedirectionTest < Test::Unit::TestCase
     setup do
       @output = Whenever.cron \
       <<-file
+        set :job_template, nil
         every 2.hours do
           command "blahblah", :output => {:error => nil, :standard => nil}
         end
@@ -245,6 +260,7 @@ class OutputRedirectionTest < Test::Unit::TestCase
     setup do
       @output = Whenever.cron \
       <<-file
+        set :job_template, nil
         every 2.hours do
           command "blahblah", :output => {:error => nil, :standard => 'my.log'}
         end
@@ -260,6 +276,7 @@ class OutputRedirectionTest < Test::Unit::TestCase
     setup do
       @output = Whenever.cron \
       <<-file
+        set :job_template, nil
         every 2.hours do
           command "blahblah", :output => {:error => 'my_error.log', :standard => nil}
         end
@@ -275,6 +292,7 @@ class OutputRedirectionTest < Test::Unit::TestCase
     setup do
       @output = Whenever.cron \
       <<-file
+        set :job_template, nil
         set :cron_log, "cron.log"
         every 2.hours do
           command "blahblah"

data/test/unit/job_test.rb

@@ -7,14 +7,6 @@ class JobTest < Test::Unit::TestCase
       assert_equal 'foo', new_job(:at => 'foo').at
     end
     
-    should "return :output when #output_redirection is called" do
-      assert_equal 'foo', new_job(:output => 'foo').output_redirection
-    end
-    
-    should "return :not_set when #output_redirection is called and no :output is set" do
-      assert_equal :not_set, new_job.output_redirection
-    end
-    
     should "substitute the :task when #output is called" do
       job = new_job(:template => ":task", :task => 'abc123')
       assert_equal 'abc123', job.output
@@ -32,7 +24,6 @@ class JobTest < Test::Unit::TestCase
 
   
   context "A Job with quotes" do
-    
     should "output the :task if it's in single quotes" do
       job = new_job(:template => "':task'", :task => 'abc123')
       assert_equal %q('abc123'), job.output
@@ -59,6 +50,23 @@ class JobTest < Test::Unit::TestCase
       assert_equal %q(before "quote -> \" <- quote" after), job.output
     end
   end
+  
+  context "A Job with a job_template" do
+    should "use the job template" do
+      job = new_job(:template => ':task', :task => 'abc123', :job_template => 'left :job right')
+      assert_equal 'left abc123 right', job.output
+    end
+    
+    should "escape single quotes" do
+      job = new_job(:template => "before ':task' after", :task => "quote -> ' <- quote", :job_template => "left ':job' right")
+      assert_equal %q(left 'before '\''quote -> '\\''\\'\\'''\\'' <- quote'\'' after' right), job.output
+    end
+    
+    should "escape double quotes" do
+      job = new_job(:template => 'before ":task" after', :task => 'quote -> " <- quote', :job_template => 'left ":job" right')
+      assert_equal %q(left "before \"quote -> \\\" <- quote\" after" right), job.output
+    end
+  end
 
 private
 

data/whenever.gemspec

@@ -5,12 +5,12 @@
 
 Gem::Specification.new do |s|
   s.name = %q{whenever}
-  s.version = "0.5.3"
+  s.version = "0.6.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Javan Makhmali"]
-  s.date = %q{2010-09-24}
-  s.description = %q{Clean ruby syntax for defining and deploying messy cron jobs.}
+  s.date = %q{2010-10-20}
+  s.description = %q{http://www.allyrics.net/Kid-Cudi/lyrics/Whenever/}
   s.email = %q{javan@javan.us}
   s.executables = ["whenever", "wheneverize"]
   s.extra_rdoc_files = [
@@ -25,6 +25,7 @@ Gem::Specification.new do |s|
      "bin/wheneverize",
      "lib/whenever.rb",
      "lib/whenever/base.rb",
+     "lib/whenever/capistrano.rb",
      "lib/whenever/command_line.rb",
      "lib/whenever/cron.rb",
      "lib/whenever/job.rb",
@@ -47,7 +48,7 @@ Gem::Specification.new do |s|
   s.rdoc_options = ["--charset=UTF-8"]
   s.require_paths = ["lib"]
   s.rubygems_version = %q{1.3.7}
-  s.summary = %q{Clean ruby syntax for defining and deploying messy cron jobs.}
+  s.summary = %q{Clean ruby syntax for writing and deploying cron jobs.}
   s.test_files = [
     "test/functional/command_line_test.rb",
      "test/functional/output_at_test.rb",

metadata

@@ -1,13 +1,12 @@
 --- !ruby/object:Gem::Specification 
 name: whenever
 version: !ruby/object:Gem::Version 
-  hash: 13
   prerelease: false
   segments: 
   - 0
-  - 5
-  - 3
-  version: 0.5.3
+  - 6
+  - 1
+  version: 0.6.1
 platform: ruby
 authors: 
 - Javan Makhmali
@@ -15,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-09-24 00:00:00 -04:00
+date: 2010-10-20 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -26,7 +25,6 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 1
         segments: 
         - 0
         - 3
@@ -42,7 +40,6 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 11
         segments: 
         - 2
         - 3
@@ -58,7 +55,6 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 9
         segments: 
         - 2
         - 1
@@ -74,7 +70,6 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 49
         segments: 
         - 0
         - 9
@@ -82,7 +77,7 @@ dependencies:
         version: 0.9.5
   type: :development
   version_requirements: *id004
-description: Clean ruby syntax for defining and deploying messy cron jobs.
+description: http://www.allyrics.net/Kid-Cudi/lyrics/Whenever/
 email: javan@javan.us
 executables: 
 - whenever
@@ -100,6 +95,7 @@ files:
 - bin/wheneverize
 - lib/whenever.rb
 - lib/whenever/base.rb
+- lib/whenever/capistrano.rb
 - lib/whenever/command_line.rb
 - lib/whenever/cron.rb
 - lib/whenever/job.rb
@@ -131,7 +127,6 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 3
       segments: 
       - 0
       version: "0"
@@ -140,7 +135,6 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 3
       segments: 
       - 0
       version: "0"
@@ -150,7 +144,7 @@ rubyforge_project:
 rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
-summary: Clean ruby syntax for defining and deploying messy cron jobs.
+summary: Clean ruby syntax for writing and deploying cron jobs.
 test_files: 
 - test/functional/command_line_test.rb
 - test/functional/output_at_test.rb