whenever 0.7.0 → 0.7.1

data/CHANGELOG.md

@@ -1,3 +1,18 @@
+### 0.7.1 / December 19th, 2011
+
+* Require thread before active_support for compatibility with Rails < 2.3.11 and RubyGems >= 1.6.0. [Micah Geisel]
+
+* More advanced role filtering in Cap task. [Brad Gessler]
+
+* Added whenever_variables as a configuration variable in Cap task. [Steve Agalloco]
+
+* Escape percent signs and reject newlines in jobs. [Amir Yalon]
+
+* Escape paths so spaces don't trip up cron. [Javan Makhmali]
+
+* Fix ambiguous handling of 1.month with :at. #99 [Javan Makhmali]
+
+
 ### 0.7.0 / September 2nd, 2011
 
 * Use mojombo's chronic, it's active again. [Javan Makhmali]

data/lib/whenever/capistrano.rb

@@ -1,9 +1,11 @@
 Capistrano::Configuration.instance(:must_exist).load do
   _cset(:whenever_roles)        { :db }
+  _cset(:whenever_options)      { {:roles => fetch(:whenever_roles)} }
   _cset(:whenever_command)      { "whenever" }
   _cset(:whenever_identifier)   { fetch :application }
   _cset(:whenever_environment)  { fetch :rails_env, "production" }
-  _cset(:whenever_update_flags) { "--update-crontab #{fetch :whenever_identifier} --set environment=#{fetch :whenever_environment}" }
+  _cset(:whenever_variables)    { "environment=#{fetch :whenever_environment}" }
+  _cset(:whenever_update_flags) { "--update-crontab #{fetch :whenever_identifier} --set #{fetch :whenever_variables}" }
   _cset(:whenever_clear_flags)  { "--clear-crontab #{fetch :whenever_identifier}" }
 
   # Disable cron jobs at the begining of a deploy.
@@ -28,7 +30,7 @@ Capistrano::Configuration.instance(:must_exist).load do
       which servers the crontab is updated on by setting the :whenever_roles variable.
     DESC
     task :update_crontab do
-      options = { :roles => fetch(:whenever_roles) }
+      options = fetch(:whenever_options)
 
       if find_servers(options).any?
         on_rollback do
@@ -55,8 +57,8 @@ Capistrano::Configuration.instance(:must_exist).load do
       the :whenever_roles variable.
     DESC
     task :clear_crontab do
-      options = { :roles => whenever_roles }
-      run "cd #{fetch :release_path} && #{fetch :whenever_command} #{fetch :whenever_clear_flags}", options if find_servers(options).any?
+      options = fetch(:whenever_options)
+      run "cd #{fetch :current_path} && #{fetch :whenever_command} #{fetch :whenever_clear_flags}", options if find_servers(options).any?
     end
   end
 end

data/lib/whenever/cron.rb

@@ -1,3 +1,5 @@
+require 'chronic'
+
 module Whenever
   module Output
     class Cron
@@ -6,6 +8,7 @@ module Whenever
       attr_accessor :time, :task
 
       def initialize(time = nil, task = nil, at = nil)
+        @at_given = at
         @time = time
         @task = task
         @at   = at.is_a?(String) ? (Chronic.parse(at) || 0) : (at || 0)
@@ -13,7 +16,7 @@ module Whenever
 
       def self.enumerate(item, detect_cron = true)
         if item and item.is_a?(String)
-          items = 
+          items =
             if detect_cron && item =~ REGEX
               [item]
             else
@@ -33,7 +36,7 @@ module Whenever
           end
         end
       end
-      
+
       def output
         [time_in_cron_syntax, task].compact.join(' ').strip
       end
@@ -48,12 +51,16 @@ module Whenever
       end
 
     protected
+      def day_given?
+        months = ["jan", "feb", "mar", "apr", "may", "jun", "jul", "aug", "sep", "oct", "nov", "dec"]
+        @at_given.is_a?(String) && months.any? { |m| @at_given.downcase.index(m) }
+      end
 
       def parse_symbol
         shortcut = case @time
           when :reboot   then '@reboot'
           when :year     then 12.months
-          when :yearly, 
+          when :yearly,
                :annually then '@annually'
           when :day      then 1.day
           when :daily    then '@daily'
@@ -65,7 +72,7 @@ module Whenever
           when :hour     then 1.hour
           when :hourly   then '@hourly'
         end
-        
+
         if shortcut.is_a?(Numeric)
           @time = shortcut
           parse_time
@@ -101,7 +108,11 @@ module Whenever
             month_frequency = (@time / 30  / 24 / 60 / 60).round
             timing[0] = @at.is_a?(Time) ? @at.min  : 0
             timing[1] = @at.is_a?(Time) ? @at.hour : 0
-            timing[2] = @at.is_a?(Time) ? @at.day  : (@at.zero? ? 1 : @at)
+            timing[2] = if @at.is_a?(Time)
+              day_given? ? @at.day : 1
+            else
+              @at.zero? ? 1 : @at
+            end
             timing[3] = comma_separated_timing(month_frequency, 12, 1)
           else
             return parse_as_string

data/lib/whenever/job.rb

@@ -1,7 +1,9 @@
+require 'shellwords'
+
 module Whenever
   class Job
     attr_reader :at
-  
+
     def initialize(options = {})
       @options = options
       @at                      = options.delete(:at)
@@ -9,16 +11,20 @@ module Whenever
       @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
+      @options[:path]          = Shellwords.shellescape(@options[:path] || Whenever.path)
     end
-  
+
     def output
       job = process_template(@template, @options).strip
-      process_template(@job_template, { :job => job }).strip
+      out = process_template(@job_template, { :job => job }).strip
+      if out =~ /\n/
+        raise ArgumentError, "Task contains newline"
+      end
+      out.gsub(/%/, '\%')
     end
-    
+
   protected
-  
+
     def process_template(template, options)
       template.gsub(/:\w+/) do |key|
         before_and_after = [$`[-1..-1], $'[0..0]]
@@ -37,7 +43,7 @@ module Whenever
     def escape_single_quotes(str)
       str.gsub(/'/) { "'\\''" }
     end
-    
+
     def escape_double_quotes(str)
       str.gsub(/"/) { '\"' }
     end

data/lib/whenever/version.rb

@@ -1,3 +1,3 @@
 module Whenever
-  VERSION = '0.7.0' 
+  VERSION = '0.7.1'
 end

data/lib/whenever.rb

@@ -1,6 +1,5 @@
-require 'chronic'
-require 'active_support/all'
 require 'thread'
+require 'active_support/all'
 
 module Whenever
   autoload :JobList,     'whenever/job_list'

data/test/unit/cron_test.rb

@@ -117,6 +117,15 @@ class CronTest < Test::Unit::TestCase
       assert_equal '0 0 1 12 *', parse_time(12.months)
     end
 
+    should "parse months with a date and/or time" do
+      # should set the day to 1 if no date is given
+      assert_equal '0 17 1 * *', parse_time(1.month, nil, "5pm")
+      # should use the date if one is given
+      assert_equal '0 2 23 * *', parse_time(1.month, nil, "February 23rd at 2am")
+      # should use an iteger as the day
+      assert_equal '0 0 5 * *', parse_time(1.month, nil, 5)
+    end
+
     should "parse correctly when given an 'at' with days, hours, minutes as a Time" do
       # first param is an array with [days, hours, minutes]
       assert_days_and_hours_and_minutes_equals %w(1 3 45),  'January 1st 3:45am'
@@ -170,7 +179,7 @@ class CronTest < Test::Unit::TestCase
       assert_equal '2 18 * * 6,0', parse_time('Weekends', nil, "6:02PM")
     end
   end
-  
+
   context "When parsing time using the cron shortcuts" do
     should "parse a :symbol into the correct shortcut" do
       assert_equal '@reboot',   parse_time(:reboot)
@@ -182,7 +191,7 @@ class CronTest < Test::Unit::TestCase
       assert_equal '@weekly',   parse_time(:weekly)
       assert_equal '@hourly',   parse_time(:hourly)
     end
-    
+
     should "convert time-based shortcuts to times" do
       assert_equal '0 0 1 * *',  parse_time(:month)
       assert_equal '0 0 * * *',  parse_time(:day)
@@ -190,22 +199,22 @@ class CronTest < Test::Unit::TestCase
       assert_equal '0 0 1 12 *', parse_time(:year)
       assert_equal '0 0 1,8,15,22 * *', parse_time(:week)
     end
-    
+
     should "raise an exception if a valid shortcut is given but also an :at" do
       assert_raises ArgumentError do
         parse_time(:hourly, nil, "1:00 am")
       end
-      
+
       assert_raises ArgumentError do
         parse_time(:reboot, nil, 5)
       end
-      
+
       assert_raises ArgumentError do
         parse_time(:daily, nil, '4:20pm')
       end
     end
   end
-  
+
   context "When given raw cron sytax" do
     should "return the same cron sytax" do
       crons = ['0 0 27-31 * *', '* * * * *', '2/3 1,9,22 11-26 1-6 *']

data/test/unit/job_test.rb

@@ -1,39 +1,69 @@
 require File.expand_path(File.dirname(__FILE__) + "/../test_helper")
 
 class JobTest < Test::Unit::TestCase
-  
+
   context "A Job" do
     should "return the :at set when #at is called" do
       assert_equal 'foo', new_job(:at => 'foo').at
     end
-    
+
     should "substitute the :task when #output is called" do
       job = new_job(:template => ":task", :task => 'abc123')
       assert_equal 'abc123', job.output
     end
-    
+
     should "substitute the :path when #output is called" do
       assert_equal 'foo', new_job(:template => ':path', :path => 'foo').output
     end
-    
+
     should "substitute the :path with the default Whenever.path if none is provided when #output is called" do
       Whenever.expects(:path).returns('/my/path')
       assert_equal '/my/path', new_job(:template => ':path').output
     end
+
+    should "escape the :path" do
+      assert_equal '/my/spacey\ path', new_job(:template => ':path', :path => '/my/spacey path').output
+    end
+
+    should "escape percent signs" do
+      job = new_job(
+        :template => "before :foo after",
+        :foo => "percent -> % <- percent"
+      )
+      assert_equal %q(before percent -> \% <- percent after), job.output
+    end
+
+    should "assume percent signs are not already escaped" do
+      job = new_job(
+        :template => "before :foo after",
+        :foo => %q(percent preceded by a backslash -> \% <-)
+      )
+      assert_equal %q(before percent preceded by a backslash -> \\\% <- after), job.output
+    end
+
+    should "reject newlines" do
+      job = new_job(
+        :template => "before :foo after",
+        :foo => "newline -> \n <- newline"
+      )
+      assert_raise ArgumentError do
+        job.output
+      end
+    end
   end
 
-  
+
   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
     end
-    
+
     should "output the :task if it's in double quotes" do
       job = new_job(:template => '":task"', :task => 'abc123')
       assert_equal %q("abc123"), job.output
     end
-    
+
     should "output escaped single quotes in when it's wrapped in them" do
       job = new_job(
         :template => "before ':foo' after",
@@ -41,7 +71,7 @@ class JobTest < Test::Unit::TestCase
       )
       assert_equal %q(before 'quote -> '\'' <- quote' after), job.output
     end
-    
+
     should "output escaped double quotes when it's wrapped in them" do
       job = new_job(
         :template => 'before ":foo" after',
@@ -50,18 +80,18 @@ 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
@@ -73,5 +103,5 @@ private
   def new_job(options={})
     Whenever::Job.new(options)
   end
-  
+
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: whenever
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 0.7.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-09-02 00:00:00.000000000Z
+date: 2011-12-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: chronic
-  requirement: &70222728174660 !ruby/object:Gem::Requirement
+  requirement: &70096166103200 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +21,10 @@ dependencies:
         version: 0.6.3
   type: :runtime
   prerelease: false
-  version_requirements: *70222728174660
+  version_requirements: *70096166103200
 - !ruby/object:Gem::Dependency
   name: activesupport
-  requirement: &70222728174020 !ruby/object:Gem::Requirement
+  requirement: &70096166102060 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: 2.3.4
   type: :runtime
   prerelease: false
-  version_requirements: *70222728174020
+  version_requirements: *70096166102060
 - !ruby/object:Gem::Dependency
   name: shoulda
-  requirement: &70222728173280 !ruby/object:Gem::Requirement
+  requirement: &70096166100840 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: 2.1.1
   type: :development
   prerelease: false
-  version_requirements: *70222728173280
+  version_requirements: *70096166100840
 - !ruby/object:Gem::Dependency
   name: mocha
-  requirement: &70222728172720 !ruby/object:Gem::Requirement
+  requirement: &70096166076460 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +54,10 @@ dependencies:
         version: 0.9.5
   type: :development
   prerelease: false
-  version_requirements: *70222728172720
+  version_requirements: *70096166076460
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &70222728172280 !ruby/object:Gem::Requirement
+  requirement: &70096166074280 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,10 +65,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70222728172280
+  version_requirements: *70096166074280
 - !ruby/object:Gem::Dependency
   name: i18n
-  requirement: &70222728171580 !ruby/object:Gem::Requirement
+  requirement: &70096166071760 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -76,7 +76,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70222728171580
+  version_requirements: *70096166071760
 description: Clean ruby syntax for writing and deploying cron jobs.
 email:
 - javan@javan.us
@@ -134,7 +134,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.6
+rubygems_version: 1.8.10
 signing_key: 
 specification_version: 3
 summary: Cron jobs in ruby.