le1t0-whenever 0.4.2.003 → 0.6.2.001

data/{CHANGELOG.rdoc → CHANGELOG.md}

@@ -1,12 +1,49 @@
-== 0.4.2.003 / Jul 5th, 2010
+### 0.6.2 / October 26th, 2010
 
-* fixed adding per-cronjob environment variables
+* --clear-crontab option completely removes entries. #63 [Javan Makhmali]
 
-== 0.4.2.002 / May 18th, 2010
+* Set default :environment and :path earlier in the new setup.rb (formerly job_types/default.rb). [Javan Makhmali]
 
-* Added setting environment variables per cron job
+* Converted README and CHANGELOG to markdown. [Javan Makhmali]
 
-== 0.4.2 / April 26th, 2010
+
+### 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]
+
+* 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]
 
@@ -17,49 +54,49 @@
 * bugfix: comparison Time with 0 failed. #32 [Dan Hixon]
 
 
-== 0.4.1 / November 30th, 2009
+### 0.4.1 / November 30th, 2009
 
 * exit(0) instead of just exit to make JRuby happy. [Elan Meng]
 
 * Fixed activesupport deprecation warning by requiring active_support. #37 [Andrew Nesbitt]
 
 
-== 0.4.0 / October 20th, 2009
+### 0.4.0 / October 20th, 2009
 
 * New output option replaces the old cron_log option for output redirection and is much more flexible. #31 [Peer Allan]
 
 * Reorganized the lib files (http://weblog.rubyonrails.org/2009/9/1/gem-packaging-best-practices) and switched to Jeweler from Echoe.
 
 
-== 0.3.7 / September 4th, 2009
+### 0.3.7 / September 4th, 2009
 
 * No longer tries (and fails) to combine @shortcut jobs. #20 [Javan Makhmali]
 
 
-== 0.3.6 / June 15th, 2009
+### 0.3.6 / June 15th, 2009
 
 * Setting a PATH in the crontab automatically based on the user's PATH. [Javan Makhmali]
 
 
-== 0.3.5 / June 13th, 2009
+### 0.3.5 / June 13th, 2009
 
 * Added ability to accept lists of every's and at's and intelligently group them. (ex: every 'monday, wednesday', :at => ['3pm', '6am']). [Sam Ruby]
 
 * Fixed issue with new lines. #18 [Javan Makhmali]
 
-== 0.3.1 / June 25th, 2009
+### 0.3.1 / June 25th, 2009
 
 * Removed activesupport gem dependency. #1 [Javan Makhmali]
 
 * Switched to numeric days of the week for Solaris support (and probably others). #8 [Roger Ertesvåg]
 
 
-== 0.3.0 / June 2nd, 2009
+### 0.3.0 / June 2nd, 2009
 
 * Added ability to set variables on the fly from the command line (ex: whenever --set environment=staging). [Javan Makhmali]
 
 
-== 0.2.2 / April 30th, 2009
+### 0.2.2 / April 30th, 2009
 
 * Days of week jobs can now accept an :at directive (ex: every :monday, :at => '5pm'). [David Eisinger]
 
@@ -68,22 +105,22 @@
 * Raising an exception if someone tries to specify an :at with a cron shortcut (:day, :reboot, etc) so there are no false hopes. [Javan Makhmali]
 
 
-== 0.1.7 / March 5th, 2009
+### 0.1.7 / March 5th, 2009
 
 * Added ability to update the crontab file non-destuctively instead of only overwriting it. [Javan Makhmali -- Inspired by code submitted individually from: Tien Dung (tiendung), Tom Lea (cwninja), Kyle Maxwell (fizx), and Andrew Timberlake (andrewtimberlake) on github]
 
 
-== 0.1.5 / February 19th, 2009
+### 0.1.5 / February 19th, 2009
 
 * Fixed load path so Whenever's files don't conflict with anything in Rails. Thanks Ryan Koopmans. [Javan Makhmali]
 
 
-== 0.1.4 / February 17th, 2009
+### 0.1.4 / February 17th, 2009
 
 * Added --load-file and --user opts to whenever binary. [Javan Makhmali]
 
 
-== 0.1.3 / February 16th, 2009
+### 0.1.3 / February 16th, 2009
 
 * Added 'rake' helper for defining scheduled rake tasks. [Javan Makhmali]
 
@@ -96,6 +133,6 @@
 * Requiring specific gem versions: Chronic >=0.2.3 and activesupport >= 1.3.0 [Javan Makhmali]
 
 
-== 0.1.0 / February 15th, 2009
+### 0.1.0 / February 15th, 2009
 
 * Initial release [Javan Makhmali]

data/README.md

@@ -0,0 +1,139 @@
+### Introduction
+
+Whenever is a Ruby gem that provides a clear syntax for writing and deploying cron jobs.
+
+### Installation
+  
+    $ gem install whenever
+
+Or with Bundler in your Gemfile.
+
+    gem 'whenever', :require => false
+ 
+### Getting started
+
+    $ cd /my/rails/app
+    $ wheneverize .
+
+This will create an initial "config/schedule.rb" file you.
+
+### Example schedule.rb file
+  
+    every 3.hours do
+      runner "MyModel.some_process"       
+      rake "my:rake:task"                 
+      command "/usr/bin/my_great_command"
+    end
+
+    every 1.day, :at => '4:30 am' do 
+      runner "MyModel.task_to_run_at_four_thirty_in_the_morning"
+    end
+
+    every :hour do # Many shortcuts available: :hour, :day, :month, :year, :reboot
+      runner "SomeModel.ladeeda"
+    end
+
+    every :sunday, :at => '12pm' do # Use any day of the week or :weekend, :weekday 
+      runner "Task.do_something_great"
+    end
+
+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 `job_type`.
+
+For example:
+
+    job_type :awesome, '/usr/local/bin/awesome :task :fun_level'
+  
+    every 2.hours do
+      awesome "party", :fun_level => "extreme"
+    end
+  
+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 :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:
+
+    job_type :runner,  "cd :path && script/rails runner -e :environment ':task' :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-aka-logging-your-cron-jobs>
+
+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>
+
+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
+
+Use the built-in Capistrano recipe for easy crontab updates with deploys.
+
+In your "config/deploy.rb" file:
+
+    require "whenever/capistrano"
+
+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:
+
+    set :whenever_command, "bundle exec whenever"
+    require "whenever/capistrano"
+
+### The `whenever` command
+
+    $ 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
+
+Whenever was created for use at Inkling (<http://inklingmarkets.com>) where I work. Their take on it: <http://blog.inklingmarkets.com/2009/02/whenever-easy-way-to-do-cron-jobs-from.html>
+
+Thanks to all the contributors who have made it even better: <http://github.com/javan/whenever/contributors>
+
+### Discussion / Feedback / Issues / Bugs
+
+For general discussion and questions, please use the google group: <http://groups.google.com/group/whenever-gem>
+
+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
+
+Permission is hereby granted, free of charge, to any person
+obtaining a copy of this software and associated documentation
+files (the "Software"), to deal in the Software without
+restriction, including without limitation the rights to use,
+copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the
+Software is furnished to do so, subject to the following
+conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
+OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
+HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
+OTHER DEALINGS IN THE SOFTWARE.

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       = "dev@ewout.to"
     gemspec.homepage    = "http://github.com/le1t0/whenever"
     gemspec.authors     = ["Le1t0"]
-    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

@@ -4,25 +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('-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.rb

@@ -1,31 +1,21 @@
 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/all'
-rescue LoadError
-  warn 'To use Whenever you need the active_support gem:'
-  warn '$ gem install activesupport'
-  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'
+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/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/command_line.rb

@@ -12,6 +12,7 @@ module Whenever
       @options = options
       
       @options[:file]       ||= 'config/schedule.rb'
+      @options[:cut]        ||= 0
       @options[:identifier] ||= default_identifier
       
       unless File.exists?(@options[:file])
@@ -19,14 +20,20 @@ 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)
@@ -43,7 +50,8 @@ module Whenever
     end
   
     def whenever_cron
-      @whenever_cron ||= [comment_open, Whenever.cron(@options), comment_close].join("\n") + "\n"
+      return '' if @options[:clear]
+      @whenever_cron ||= [comment_open, Whenever.cron(@options), comment_close].compact.join("\n") + "\n"
     end
     
     def read_crontab
@@ -53,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)
@@ -77,22 +85,28 @@ 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.gsub(/\n{3,}/, "\n\n") # More than two newlines becomes just two.
+    end
+    
+    def prepare(contents)
+      contents.split("\n")[@options[:cut]..-1].join("\n")
     end
     
     def comment_base