whenever 0.5.3 → 0.6.8

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
@@ -16,16 +16,14 @@ module Whenever
           pre_set(options[:set])
       end
       
-      # Load all job type files.
-      Dir["#{File.expand_path(File.dirname(__FILE__))}/job_types/*.rb"].each do |file|
-        eval(File.read(file))
-      end
+      setup = File.read("#{File.expand_path(File.dirname(__FILE__))}/setup.rb")
       
-      eval(config)
+      eval(setup + config)
     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 +57,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,29 +75,20 @@ 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?
       
       output = []
       @env.each do |key, val|
-        output << "#{key}=#{val}\n"
+        output << "#{key}=#{val.blank? ? '""' : val}\n"
       end
       output << "\n"
       

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/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' 
-end unless defined?(Whenever::VERSION)
+  VERSION = '0.6.8' 
+end

data/lib/whenever.rb

@@ -1,10 +1,22 @@
 require 'chronic'
 require 'active_support/all'
+require 'thread'
 
-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
@@ -297,8 +281,7 @@ My whenever job that was already here
 # End Whenever generated tasks for: My identifier
 EXISTING_CRON
 
-      # here-doc adds an extra newline we need removed
-      assert_equal existing.strip, @command.send(:prepare, existing)
+      assert_equal existing, @command.send(:prepare, existing)
     end
     
     should "trim off the top lines of the file" do
@@ -318,8 +301,21 @@ My whenever job that was already here
 # End Whenever generated tasks for: My identifier
 NEW_CRON
 
-      # here-doc adds an extra newline we need removed
-      assert_equal new_cron.strip, @command.send(:prepare, existing)
+      assert_equal new_cron, @command.send(:prepare, existing)
+    end
+    
+    should "preserve terminating newlines in files" do
+      @command = Whenever::CommandLine.new(:update => true, :identifier => 'My identifier')
+      existing = <<-EXISTING_CRON
+# Begin Whenever generated tasks for: My identifier
+My whenever job that was already here
+# End Whenever generated tasks for: My identifier
+
+# A non-Whenever task
+My non-whenever job that was already here
+EXISTING_CRON
+
+      assert_equal existing, @command.send(:prepare, existing)
     end
   end
 

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,8 +164,9 @@ class OutputAtTest < Test::Unit::TestCase
     setup do
       @output = Whenever.cron \
       <<-file
+        set :job_template, nil
         set :path, '/your/path'
-        every :day do
+        every :daily do
           rake "blah:blah"
           runner "runner_1"
           command "command_1"
@@ -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
@@ -234,4 +248,21 @@ class OutputAtTest < Test::Unit::TestCase
       assert_match '27,29,31,33,35,37,39,41,43,45,47,49,51,53,55,57,59 * * * * blahblah', @output
     end
   end
+  
+  context "using raw cron syntax" do
+    setup do
+      @output = Whenever.cron \
+      <<-file
+        set :job_template, nil
+        every '0 0 27,31 * *' do
+          command "blahblah"
+        end
+      file
+    end
+    
+    should "output the command using the same cron syntax" do
+      assert_match '0 0 27,31 * * blahblah', @output
+    end
+  end
+  
 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