whenever 0.4.1 → 0.5.3

data/.gitignore

@@ -1,3 +1,4 @@
 .DS_Store
 pkg
-doc
+doc
+.*.sw[a-z]

data/CHANGELOG.rdoc

@@ -1,3 +1,41 @@
+== 0.5.3 / September 24th, 2010
+
+* Better regexes for replacing Whenever blocks in the crontab. #45 [Javan Makhmali]
+
+* Preserving backslashes when updating existing crontab. #82 [Javan Makhmali]
+
+
+== 0.5.2 / September 15th, 2010
+
+* Quotes automatically escaped in jobs. [Jay Adkisson]
+
+* Added --cut option to the command line to allow pruning of the crontab. [Peer Allan]
+
+* Switched to aaronh-chronic which is ruby 1.9.2 compatible. [Aaron Hurley, Javan Makhmali]
+
+* Lots of internal reorganizing; tests broken into unit and functional. [Javan Makhmali]
+
+
+== 0.5.0 / June 28th, 2010
+
+* New job_type API for writing custom jobs. Internals use this to define command, runner, and rake. [Javan Makhmali - inspired by idlefingers (Damien)]
+
+* Jobs < 1.hour can specify an :at. [gorenje]
+
+* --clear option to remove crontab entries for a specific [identifier]. [mraidel (Michael Raidel)]
+
+
+== 0.4.2 / April 26th, 2010
+
+* runners now cd into the app's directory and then execute. [Michael Guterl]
+
+* Fix STDERR output redirection to file to append instead of overwrite. [weplay]
+
+* Move require of tempfile lib to file that actually uses it. [Finn Smith]
+
+* bugfix: comparison Time with 0 failed. #32 [Dan Hixon]
+
+
 == 0.4.1 / November 30th, 2009
 
 * exit(0) instead of just exit to make JRuby happy. [Elan Meng]

data/README.rdoc

@@ -7,18 +7,8 @@ Ryan Bates created a great Railscast about Whenever: http://railscasts.com/episo
 Discussion: http://groups.google.com/group/whenever-gem
 
 == Installation
-
-If you haven't already, get set up with http://gemcutter.org
-  
-  $ sudo gem install whenever
-
-In a Rails (2.1 or greater) application:
   
-in your "config/environment.rb" file:
-
-  Rails::Initializer.run do |config|
-    config.gem 'whenever', :lib => false, :source => 'http://gemcutter.org/'
-  end
+$ sudo gem install whenever
 
 == Getting started
 
@@ -49,6 +39,28 @@ This will create an initial "config/schedule.rb" file you.
 
 More examples on the wiki: http://wiki.github.com/javan/whenever/instructions-and-examples
 
+== 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>.
+
+For example:
+
+  job_type :awesome, '/usr/local/bin/awesome :task :fun_level'
+  
+  every 2.hours do
+    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>.
+
+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"
+
+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'.
+
 == Cron output
 
   $ cd /my/rails/app
@@ -91,7 +103,7 @@ If you've found a genuine bug or issue, please use the Issues section on github:
 
 == License
 
-Copyright (c) 2009 Javan Makhmali
+Copyright (c) 2009+ Javan Makhmali
 
 Permission is hereby granted, free of charge, to any person
 obtaining a copy of this software and associated documentation

data/Rakefile

@@ -1,7 +1,7 @@
 require 'rubygems'
 require 'rake'
 
-require 'lib/whenever/version.rb'
+require File.expand_path(File.dirname(__FILE__) + "/lib/whenever/version")
 
 begin
   require 'jeweler'
@@ -13,7 +13,10 @@ begin
     gemspec.email       = "javan@javan.us"
     gemspec.homepage    = "http://github.com/javan/whenever"
     gemspec.authors     = ["Javan Makhmali"]
-    gemspec.add_dependency("chronic", '>= 0.2.3')
+    gemspec.add_dependency 'aaronh-chronic', '>= 0.3.9'
+    gemspec.add_dependency 'activesupport', '>= 2.3.4'
+    gemspec.add_development_dependency 'shoulda', '>= 2.1.1'
+    gemspec.add_development_dependency 'mocha', '>= 0.9.5'
   end
   Jeweler::GemcutterTasks.new
 rescue LoadError
@@ -22,10 +25,10 @@ end
 
 require 'rake/testtask'
 Rake::TestTask.new(:test) do |test|
-  test.libs << 'lib' << 'test'
-  test.pattern = 'test/*.rb'
-  test.verbose = true
-end
+    test.libs      << 'lib' << 'test'
+    test.pattern   = 'test/{functional,unit}/**/*_test.rb'
+    test.verbose   = true
+  end
 
 task :test => :check_dependencies
 

data/bin/whenever

@@ -2,8 +2,6 @@
 
 require 'rubygems'
 require 'optparse'
-require 'fileutils'
-require 'tempfile'
 require 'whenever'
 
 options = Hash.new
@@ -12,10 +10,17 @@ 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('-c', '--clear-crontab [identifier]') do |identifier|
+    options[:clear] = true
+    options[:identifier] = identifier if identifier
+  end
   opts.on('-f', '--load-file [schedule file]', 'Default: config/schedule.rb') do |file|
     options[:file] = file if file
   end
@@ -27,4 +32,4 @@ OptionParser.new do |opts|
   end
 end.parse!
 
-Whenever::CommandLine.execute(options)
+Whenever::CommandLine.execute(options)

data/lib/whenever/base.rb

@@ -5,11 +5,7 @@ module Whenever
   end
   
   def self.path
-    if defined?(RAILS_ROOT)
-      RAILS_ROOT 
-    elsif defined?(::RAILS_ROOT)
-      ::RAILS_ROOT
-    end
+    Dir.pwd
   end
 
 end

data/lib/whenever/command_line.rb

@@ -1,3 +1,6 @@
+require 'fileutils'
+require 'tempfile'
+
 module Whenever
   class CommandLine
     
@@ -9,6 +12,7 @@ module Whenever
       @options = options
       
       @options[:file]       ||= 'config/schedule.rb'
+      @options[:cut]        ||= 0
       @options[:identifier] ||= default_identifier
       
       unless File.exists?(@options[:file])
@@ -16,14 +20,21 @@ module Whenever
         exit(1)
       end
 
-      if @options[:update] && @options[:write]
-        warn("[fail] Can't update AND write. choose one.")
+      if [@options[:update], @options[:write], @options[:clear]].compact.length > 1
+        warn("[fail] Can only update, write or clear. Choose one.")
+        exit(1)
+      end
+
+      unless @options[:cut].to_s =~ /[0-9]*/
+        warn("[fail] Can't cut negative lines from the crontab #{options[:cut]}")
         exit(1)
       end
+      @options[:cut] = @options[:cut].to_i
+      
     end
     
     def run
-      if @options[:update]
+      if @options[:update] || @options[:clear]
         write_crontab(updated_crontab)
       elsif @options[:write]
         write_crontab(whenever_cron)
@@ -40,7 +51,7 @@ module Whenever
     end
   
     def whenever_cron
-      @whenever_cron ||= [comment_open, Whenever.cron(@options), comment_close].join("\n") + "\n"
+      @whenever_cron ||= [comment_open, (Whenever.cron(@options) unless @options[:clear]), comment_close].compact.join("\n") + "\n"
     end
     
     def read_crontab
@@ -50,7 +61,7 @@ module Whenever
       command << "-u #{@options[:user]}" if @options[:user]
       
       command_results  = %x[#{command.join(' ')} 2> /dev/null]
-      @current_crontab = $?.exitstatus.zero? ? command_results : ''
+      @current_crontab = $?.exitstatus.zero? ? prepare(command_results) : ''
     end
     
     def write_crontab(contents)
@@ -74,24 +85,30 @@ module Whenever
       end
     end
     
-    def updated_crontab      
+    def updated_crontab   
       # Check for unopened or unclosed identifier blocks
-      if read_crontab.index(comment_open) && !read_crontab.index(comment_close)
+      if read_crontab =~ Regexp.new("^#{comment_open}$") && (read_crontab =~ Regexp.new("^#{comment_close}$")).nil?
         warn "[fail] Unclosed indentifier; Your crontab file contains '#{comment_open}', but no '#{comment_close}'"
         exit(1)
-      elsif !read_crontab.index(comment_open) && read_crontab.index(comment_close)
+      elsif (read_crontab =~ Regexp.new("^#{comment_open}$")).nil? && read_crontab =~ Regexp.new("^#{comment_close}$")
         warn "[fail] Unopened indentifier; Your crontab file contains '#{comment_close}', but no '#{comment_open}'"
         exit(1)
       end
       
       # If an existing identier block is found, replace it with the new cron entries
-      if read_crontab.index(comment_open) && read_crontab.index(comment_close)
-        read_crontab.gsub(Regexp.new("#{comment_open}.+#{comment_close}", Regexp::MULTILINE), whenever_cron.chomp)
+      if read_crontab =~ Regexp.new("^#{comment_open}$") && read_crontab =~ Regexp.new("^#{comment_close}$")
+        # If the existing crontab file contains backslashes they get lost going through gsub.
+        # .gsub('\\', '\\\\\\') preserves them. Go figure.
+        read_crontab.gsub(Regexp.new("^#{comment_open}$.+^#{comment_close}$", Regexp::MULTILINE), whenever_cron.chomp.gsub('\\', '\\\\\\'))
       else # Otherwise, append the new cron entries after any existing ones
         [read_crontab, whenever_cron].join("\n\n")
       end
     end
     
+    def prepare(contents)
+      contents.split("\n")[@options[:cut]..-1].join("\n")
+    end
+    
     def comment_base
       "Whenever generated tasks for: #{@options[:identifier]}"
     end
@@ -105,4 +122,4 @@ module Whenever
     end
     
   end
-end
+end

data/lib/whenever/{outputs/cron.rb → cron.rb}

@@ -1,6 +1,5 @@
 module Whenever
   module Output
-
     class Cron
 
       attr_accessor :time, :task
@@ -43,7 +42,7 @@ module Whenever
       end
       
       def output_redirection
-        OutputRedirection.new(@output_redirection).to_s unless @output_redirection == :not_set
+        Whenever::Output::Cron::OutputRedirection.new(@output_redirection).to_s unless @output_redirection == :not_set
       end
 
     protected
@@ -60,7 +59,7 @@ module Whenever
         end
         
         if shortcut
-          if @at > 0
+          if @at.is_a?(Time) || (@at.is_a?(Numeric) && @at > 0)
             raise ArgumentError, "You cannot specify an ':at' when using the shortcuts for times."
           else
             return shortcut
@@ -77,7 +76,7 @@ module Whenever
             raise ArgumentError, "Time must be in minutes or higher"
           when 1.minute...1.hour
             minute_frequency = @time / 60
-            timing[0] = comma_separated_timing(minute_frequency, 59)
+            timing[0] = comma_separated_timing(minute_frequency, 59, @at || 0)
           when 1.hour...1.day
             hour_frequency = (@time / 60 / 60).round
             timing[0] = @at.is_a?(Time) ? @at.min : @at
@@ -134,6 +133,5 @@ module Whenever
       end
 
     end
-
   end
 end

data/lib/whenever/job.rb

@@ -0,0 +1,41 @@
+module Whenever
+  class Job
+    
+    attr_reader :at, :output_redirection
+  
+    def initialize(options = {})
+      @options = options
+      
+      @at                      = options[:at]
+      @output_redirection      = options.has_key?(:output) ? options[:output] : :not_set
+      @options[:environment] ||= :production
+      @options[:path]        ||= Whenever.path
+    end
+  
+    def output
+      @options[:template].dup.gsub(/:\w+/) do |key|
+        before_and_after = [$`[-1..-1], $'[0..0]]
+        option = @options[key.sub(':', '').to_sym]
+
+        if before_and_after.all? { |c| c == "'" }
+          escape_single_quotes(option)
+        elsif before_and_after.all? { |c| c == '"' }
+          escape_double_quotes(option)
+        else
+          option
+        end
+      end
+    end
+    
+  protected
+
+    def escape_single_quotes(str)
+      str.gsub(/'/) { "'\\''" }
+    end
+    
+    def escape_double_quotes(str)
+      str.gsub(/"/) { '\"' }
+    end
+    
+  end
+end

data/lib/whenever/job_list.rb

@@ -2,8 +2,7 @@ module Whenever
   class JobList
   
     def initialize(options)
-      @jobs = Hash.new
-      @env  = Hash.new
+      @jobs, @env, @set_variables = {}, {}, {}
       
       case options
         when String
@@ -16,7 +15,12 @@ module Whenever
           end
           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
+      
       eval(config)
     end
     
@@ -25,6 +29,7 @@ module Whenever
       
       instance_variable_set("@#{variable}".to_sym, value)
       self.class.send(:attr_reader, variable.to_sym)
+      @set_variables[variable] = value
     end
     
     def env(variable, value)
@@ -37,26 +42,21 @@ module Whenever
       yield
     end
     
-    def command(task, options = {})
-      # :cron_log was an old option for output redirection, it remains for backwards compatibility
-      options[:output] = (options[:cron_log] || @cron_log) if defined?(@cron_log) || options.has_key?(:cron_log)
-      # :output is the newer, more flexible option.
-      options[:output] = @output if defined?(@output) && !options.has_key?(:output)
-      options[:class] ||= Whenever::Job::Default
-      @jobs[@current_time_scope] ||= []
-      @jobs[@current_time_scope] << options[:class].new(@options.merge(:task => task).merge(options))
-    end
-    
-    def runner(task, options = {})
-      options.reverse_merge!(:environment => @environment, :path => @path)
-      options[:class] = Whenever::Job::Runner
-      command(task, options)
-    end
-    
-    def rake(task, options = {})
-      options.reverse_merge!(:environment => @environment, :path => @path)
-      options[:class] = Whenever::Job::RakeTask
-      command(task, options)
+    def job_type(name, template)
+      class_eval do
+        define_method(name) do |task, *args|
+          options = { :task => task, :template => template }
+          options.merge!(args[0]) if args[0].is_a? Hash
+          
+          # :cron_log was an old option for output redirection, it remains for backwards compatibility
+          options[:output] = (options[:cron_log] || @cron_log) if defined?(@cron_log) || options.has_key?(:cron_log)
+          # :output is the newer, more flexible option.
+          options[:output] = @output if defined?(@output) && !options.has_key?(:output)
+          
+          @jobs[@current_time_scope] ||= []
+          @jobs[@current_time_scope] << Whenever::Job.new(@options.merge(@set_variables).merge(options))
+        end
+      end
     end
   
     def generate_cron_output
@@ -79,7 +79,7 @@ module Whenever
       pairs.each do |pair|
         next unless pair.index('=')
         variable, value = *pair.split('=')
-        set(variable.strip, value.strip) unless variable.blank? || value.blank?
+        set(variable.strip.to_sym, value.strip) unless variable.blank? || value.blank?
       end
     end
     

data/lib/whenever/job_types/default.rb

@@ -1,27 +1,3 @@
-module Whenever
-  module Job
-    class Default
-      
-      attr_accessor :task, :at, :output, :output_redirection
-    
-      def initialize(options = {})
-        @task               = options[:task]
-        @at                 = options[:at]
-        @output_redirection = options.has_key?(:output) ? options[:output] : :not_set
-        @environment        = options[:environment] || :production
-        @path               = options[:path] || Whenever.path
-      end
-    
-      def output
-        task
-      end
-      
-    protected
-      
-      def path_required
-        raise ArgumentError, "No path available; set :path, '/your/path' in your schedule file" if @path.blank?
-      end
-      
-    end
-  end
-end
+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"

data/lib/whenever/{outputs/cron/output_redirection.rb → output_redirection.rb}

@@ -32,11 +32,17 @@ module Whenever
         def redirect_from_hash
           case
             when stdout == '/dev/null' && stderr == '/dev/null'
-              ">> /dev/null 2>&1"
+              "> /dev/null 2>&1"
+            when stdout && stderr == '/dev/null'
+              ">> #{stdout} 2> /dev/null"
             when stdout && stderr
-              ">> #{stdout} 2> #{stderr}"
+              ">> #{stdout} 2>> #{stderr}"
+            when stderr == '/dev/null'
+              "2> /dev/null"
             when stderr
-              "2> #{stderr}"
+              "2>> #{stderr}"
+            when stdout == '/dev/null'
+              "> /dev/null"
             when stdout
               ">> #{stdout}"
             else

data/lib/whenever/version.rb

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

data/lib/whenever.rb

@@ -1,31 +1,10 @@
 require 'chronic'
+require 'active_support/all'
 
-# Hoping to load Rails' Rakefile
-begin
-  load 'Rakefile'
-rescue LoadError
-  nil
-end
-
-# If Rails' rakefile was loaded than so was active_support, but
-# if this is being used in a non-rails enviroment we need to require it.
-# It was previously defined as a dependency of this gem, but that became
-# problematic. See: http://github.com/javan/whenever/issues#issue/1
-begin
-  require 'active_support'
-rescue LoadError
-  warn 'To user Whenever you need the active_support gem:'
-  warn '$ sudo gem install active_support'
-  exit(1)
-end
-
-# Whenever files
 require 'whenever/base'
 require 'whenever/job_list'
-require 'whenever/job_types/default'
-require 'whenever/job_types/rake_task'
-require 'whenever/job_types/runner'
-require 'whenever/outputs/cron'
-require 'whenever/outputs/cron/output_redirection'
+require 'whenever/job'
+require 'whenever/cron'
+require 'whenever/output_redirection'
 require 'whenever/command_line'
 require 'whenever/version'