whenever 0.5.3 → 0.6.2

data/lib/whenever/setup.rb

@@ -0,0 +1,18 @@
+# Environemnt defaults to production
+set :environment, "production"
+# Path defaults to the directory `whenever` was run from
+set :path, Whenever.path
+
+# All jobs are wrapped in this template.
+# 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"
+
+# Create a runner job that's appropriate for the Rails version,
+if File.exists?(File.join(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/version.rb

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

data/lib/whenever.rb

@@ -1,10 +1,21 @@
 require 'chronic'
 require 'active_support/all'
 
-require 'whenever/base'
 require 'whenever/job_list'
 require 'whenever/job'
 require 'whenever/cron'
 require 'whenever/output_redirection'
 require 'whenever/command_line'
-require 'whenever/version'
+require 'whenever/version'
+
+module Whenever
+  
+  def self.cron(options)
+    Whenever::JobList.new(options).generate_cron_output
+  end
+  
+  def self.path
+    Dir.pwd
+  end
+
+end

data/test/functional/command_line_test.rb

@@ -120,35 +120,18 @@ NEW_CRON
     end
     
     should "append the similarly named command" do
-      assert_equal @existing + "\n\n" + @new, @command.send(:updated_crontab)
+      assert_equal @existing + "\n" + @new, @command.send(:updated_crontab)
     end
   end
 
-  context "A command line delete" do
+  context "A command line clear" do
     setup do
       File.expects(:exists?).with('config/schedule.rb').returns(true)
       @command = Whenever::CommandLine.new(:clear => true, :identifier => 'My identifier')
       @task = "#{two_hours} /my/command"
     end
 
-    should "add an empty identifier block if there is no existing one" do
-      existing = '# Existing crontab'
-      @command.expects(:read_crontab).at_least_once.returns(existing)
-      
-      new_cron = <<-EXPECTED
-#{existing}
-
-# Begin Whenever generated tasks for: My identifier
-# End Whenever generated tasks for: My identifier
-EXPECTED
-      
-      assert_equal new_cron, @command.send(:updated_crontab)
-      
-      @command.expects(:write_crontab).with(new_cron).returns(true)
-      assert @command.run
-    end
-    
-    should "delete an existing block if the identifier matches" do
+    should "clear an existing block if the identifier matches" do
       existing = <<-EXISTING_CRON
 # Something
 
@@ -162,20 +145,17 @@ This shouldn't get replaced
 EXISTING_CRON
 
       @command.expects(:read_crontab).at_least_once.returns(existing)
-      
+
       new_cron = <<-NEW_CRON
 # Something
 
-# Begin Whenever generated tasks for: My identifier
-# End Whenever generated tasks for: My identifier
-
 # Begin Whenever generated tasks for: Other identifier
 This shouldn't get replaced
 # End Whenever generated tasks for: Other identifier
 NEW_CRON
-      
+
       assert_equal new_cron, @command.send(:updated_crontab)
-      
+
       @command.expects(:write_crontab).with(new_cron).returns(true)
       assert @command.run
     end
@@ -217,6 +197,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 +215,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 +233,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 +251,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,64 @@ 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
+  
+  context "A plain command that is conditional on default environent and path" do
+    setup do
+      Whenever.expects(:path).at_least_once.returns('/what/you/want')
+      @output = Whenever.cron \
+      <<-file
+        set :job_template, nil
+        if environment == 'production' && path == '/what/you/want'
+          every 2.hours do
+            command "blahblah"
+          end
+        end
+      file
+    end
+    
+    should "output the command" do
+      assert_match /blahblah/, @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 +94,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 +107,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 +140,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 +148,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 +157,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