whenever 0.6.1 → 0.6.8

data/.gitignore

@@ -2,3 +2,4 @@
 pkg
 doc
 .*.sw[a-z]
+Gemfile.lock

data/{CHANGELOG.rdoc → CHANGELOG.md}

@@ -1,4 +1,45 @@
-== 0.6.1 / October 20th, 2010
+### 0.6.8 / May 24th, 2011
+
+* Convert most shortcuts to seconds. every :day -> every 1.day. #129 [Javan Makhmali]
+
+* Allow commas in raw cron syntax. #130 [Marco Bergantin, Javan Makhmali]
+
+* Output no update message as comments. #135 [Javan Makhmali]
+
+* require 'thread' to support Rubygems >= 1.6.0. #132 [Javan Makhmali]
+
+
+### 0.6.7 / March 23rd, 2011
+
+* Fix issue with comment block being corrupted during subsequent insertion of duplicate entries to the crontab. #123 [Jeremy (@lingmann)]
+
+* Removed -i from default job template. #118 [Javan Makhmali]
+
+
+### 0.6.6 / March 8th, 2011
+
+* Fix unclosed identifier bug. #119 [Javan Makhmali]
+
+
+### 0.6.5 / March 8th, 2011
+
+* Preserve whitespace at the end of crontab file. #95 [Rich Meyers]
+
+* Setting nil or blank environment variables now properly formats output. [T.J. VanSlyke]
+
+* Allow raw cron sytax, added -i to bash job template, general cleanup. [Javan Makhmali]
+
+
+### 0.6.2 / October 26th, 2010
+
+* --clear-crontab option completely removes entries. #63 [Javan Makhmali]
+
+* Set default :environment and :path earlier in the new setup.rb (formerly job_types/default.rb). [Javan Makhmali]
+
+* Converted README and CHANGELOG to markdown. [Javan Makhmali]
+
+
+### 0.6.1 / October 20th, 2010
 
 * Detect script/rails file and change runner to Rails 3 style if found. [Javan Makhmali]
 
@@ -7,14 +48,14 @@
 * Added a built-in Capistrano recipe. [Javan Makhmali]
 
 
-== 0.5.3 / September 24th, 2010
+### 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
+### 0.5.2 / September 15th, 2010
 
 * Quotes automatically escaped in jobs. [Jay Adkisson]
 
@@ -25,7 +66,7 @@
 * Lots of internal reorganizing; tests broken into unit and functional. [Javan Makhmali]
 
 
-== 0.5.0 / June 28th, 2010
+### 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)]
 
@@ -34,7 +75,7 @@
 * --clear option to remove crontab entries for a specific [identifier]. [mraidel (Michael Raidel)]
 
 
-== 0.4.2 / April 26th, 2010
+### 0.4.2 / April 26th, 2010
 
 * runners now cd into the app's directory and then execute. [Michael Guterl]
 
@@ -45,49 +86,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]
 
@@ -96,22 +137,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]
 
@@ -124,6 +165,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/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in newever.gemspec
+gemspec

data/{README.rdoc → README.md}

@@ -1,119 +1,130 @@
-== Introduction
+### Introduction
 
 Whenever is a Ruby gem that provides a clear syntax for writing and deploying cron jobs.
 
-== Installation
+### Installation
   
-  $ gem install whenever
+    $ gem install whenever
 
 Or with Bundler in your Gemfile.
 
-  gem 'whenever', :require => false
+    gem 'whenever', :require => false
  
-== Getting started
+### Getting started
 
-  $ cd /my/rails/app
-  $ wheneverize .
+    $ cd /my/rails/app
+    $ wheneverize .
 
 This will create an initial "config/schedule.rb" file you.
 
-== Example schedule.rb file
+### Example schedule.rb file
   
-  every 3.hours do
-    runner "MyModel.some_process"       
-    rake "my:rake:task"                 
-    command "/usr/bin/my_great_command"
-  end
+    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 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 :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
+    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
+    every '0 0 27-31 * *' do
+      command "echo 'you can use raw cron sytax too'"
+    end
 
-== Define your own job types
+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'
+    job_type :awesome, '/usr/local/bin/awesome :task :fun_level'
   
-  every 2.hours do
-    awesome "party", :fun_level => "extreme"
-  end
+    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"
+    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"
+    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-(logging-your-cron-jobs)
+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
+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.
+You can change this by setting your own `:job_template`.
 
-  set :job_template, "bash -l -c ':job'"
+    set :job_template, "bash -l -c ':job'"
   
 Or set the job_template to nil to have your jobs execute normally.
 
-  set :job_template, nil
+    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
+### Capistrano integration
 
 Use the built-in Capistrano recipe for easy crontab updates with deploys.
 
 In your "config/deploy.rb" file:
 
-  require "whenever/capistrano"
+    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
+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"
+    set :whenever_command, "bundle exec whenever"
+    require "whenever/capistrano"
+
+If you are using different environments (such as staging, production), then you may want to do this:
+
+    set :whenever_environment, defer { stage }
+    require "whenever/capistrano"
+
+The capistrano variable `:stage` should be the one holding your environment name. This will make the correct `:environment` available in your schedule.rb.
 
-== The `whenever` command
+### The `whenever` command
 
-  $ cd /my/rails/app
-  $ whenever
+    $ 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
+### 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
+Whenever was created for use at Inkling (<http://inklingmarkets.com>). Their take on it: <http://blog.inklingmarkets.com/2009/02/whenever-easy-way-to-do-cron-jobs-from.html>
 
-While building Whenever, I learned a lot by digging through the source code of Capistrano - http://github.com/jamis/capistrano
+Thanks to all the contributors who have made it even better: <http://github.com/javan/whenever/contributors>
 
-== Discussion / Feedback / Issues / Bugs
+### Discussion / Feedback / Issues / Bugs
 
-For general discussion and questions, please use the google group: http://groups.google.com/group/whenever-gem
+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
+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
+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
+### License
 
 Copyright (c) 2009+ Javan Makhmali
 

data/Rakefile

@@ -1,35 +1,11 @@
-require 'rubygems'
-require 'rake'
-
-require File.expand_path(File.dirname(__FILE__) + "/lib/whenever/version")
-
-begin
-  require 'jeweler'
-  Jeweler::Tasks.new do |gemspec|
-    gemspec.name        = "whenever"
-    gemspec.version     = Whenever::VERSION
-    gemspec.summary     = "Clean ruby syntax for writing and deploying cron jobs."
-    gemspec.description = "http://www.allyrics.net/Kid-Cudi/lyrics/Whenever/"
-    gemspec.email       = "javan@javan.us"
-    gemspec.homepage    = "http://github.com/javan/whenever"
-    gemspec.authors     = ["Javan Makhmali"]
-    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
-  puts "Jeweler not available. Install it with: sudo gem install jeweler -s http://gemcutter.org"
-end
+require 'bundler'
+Bundler::GemHelper.install_tasks
 
 require 'rake/testtask'
 Rake::TestTask.new(:test) do |test|
-    test.libs      << 'lib' << 'test'
-    test.pattern   = 'test/{functional,unit}/**/*_test.rb'
-    test.verbose   = true
-  end
-
-task :test => :check_dependencies
+  test.libs      << 'lib' << 'test'
+  test.pattern   = 'test/{functional,unit}/**/*_test.rb'
+  test.verbose   = true
+end
 
 task :default => :test

data/lib/whenever/capistrano.rb

@@ -3,7 +3,8 @@ 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_environment)  { "production" }
+  _cset(:whenever_update_flags) { "--update-crontab #{whenever_identifier} --set environment=#{whenever_environment}" }
   _cset(:whenever_clear_flags)  { "--clear-crontab #{whenever_identifier}" }
   
   # Disable cron jobs at the begining of a deploy.

data/lib/whenever/command_line.rb

@@ -30,7 +30,6 @@ module Whenever
         exit(1)
       end
       @options[:cut] = @options[:cut].to_i
-      
     end
     
     def run
@@ -40,6 +39,8 @@ module Whenever
         write_crontab(whenever_cron)
       else
         puts Whenever.cron(@options)
+        puts "## [message] Above is your schedule file converted to cron syntax; your crontab file was not updated."
+        puts "## [message] Run `whenever --help' for more options."
         exit(0)
       end
     end
@@ -51,7 +52,8 @@ module Whenever
     end
   
     def whenever_cron
-      @whenever_cron ||= [comment_open, (Whenever.cron(@options) unless @options[:clear]), comment_close].compact.join("\n") + "\n"
+      return '' if @options[:clear]
+      @whenever_cron ||= [comment_open, Whenever.cron(@options), comment_close].compact.join("\n") + "\n"
     end
     
     def read_crontab
@@ -87,26 +89,34 @@ module Whenever
     
     def updated_crontab   
       # Check for unopened or unclosed identifier blocks
-      if read_crontab =~ Regexp.new("^#{comment_open}$") && (read_crontab =~ Regexp.new("^#{comment_close}$")).nil?
+      if read_crontab =~ Regexp.new("^#{comment_open}\s*$") && (read_crontab =~ Regexp.new("^#{comment_close}\s*$")).nil?
         warn "[fail] Unclosed indentifier; Your crontab file contains '#{comment_open}', but no '#{comment_close}'"
         exit(1)
-      elsif (read_crontab =~ Regexp.new("^#{comment_open}$")).nil? && read_crontab =~ Regexp.new("^#{comment_close}$")
+      elsif (read_crontab =~ Regexp.new("^#{comment_open}\s*$")).nil? && read_crontab =~ Regexp.new("^#{comment_close}\s*$")
         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 =~ Regexp.new("^#{comment_open}$") && read_crontab =~ Regexp.new("^#{comment_close}$")
+      if read_crontab =~ Regexp.new("^#{comment_open}\s*$") && read_crontab =~ Regexp.new("^#{comment_close}\s*$")
         # 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('\\', '\\\\\\'))
+        read_crontab.gsub(Regexp.new("^#{comment_open}\s*$.+^#{comment_close}\s*$", 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")
+      # Strip n lines from the top of the file as specified by the :cut option.
+      # Use split with a -1 limit option to ensure the join is able to rebuild
+      # the file with all of the original seperators in-tact.
+      stripped_contents = contents.split($/,-1)[@options[:cut]..-1].join($/)
+
+      # Some cron implementations require all non-comment lines to be newline-
+      # terminated. (issue #95) Strip all newlines and replace with the default 
+      # platform record seperator ($/)
+      stripped_contents.gsub!(/\s+$/, $/)
     end
     
     def comment_base

data/lib/whenever/cron.rb

@@ -1,6 +1,7 @@
 module Whenever
   module Output
     class Cron
+      REGEX = /^.+ .+ .+ .+ .+.?$/
 
       attr_accessor :time, :task
 
@@ -10,9 +11,14 @@ module Whenever
         @at   = at.is_a?(String) ? (Chronic.parse(at) || 0) : (at || 0)
       end
 
-      def self.enumerate(item)
+      def self.enumerate(item, detect_cron = true)
         if item and item.is_a?(String)
-          items = item.split(',')
+          items = 
+            if detect_cron && item =~ REGEX
+              [item]
+            else
+              item.split(',')
+            end
         else
           items = item
           items = [items] unless items and items.respond_to?(:each)
@@ -22,7 +28,7 @@ module Whenever
 
       def self.output(times, job)
         enumerate(times).each do |time|
-          enumerate(job.at).each do |at|
+          enumerate(job.at, false).each do |at|
             yield new(time, job.output, at).output
           end
         end
@@ -34,6 +40,7 @@ module Whenever
 
       def time_in_cron_syntax
         case @time
+          when REGEX  then @time # raw cron sytax given
           when Symbol then parse_symbol
           when String then parse_as_string
           else parse_time
@@ -44,16 +51,25 @@ module Whenever
 
       def parse_symbol
         shortcut = case @time
-          when :reboot          then '@reboot'
-          when :year, :yearly   then '@annually'
-          when :day, :daily     then '@daily'
-          when :midnight        then '@midnight'
-          when :month, :monthly then '@monthly'
-          when :week, :weekly   then '@weekly'
-          when :hour, :hourly   then '@hourly'
+          when :reboot   then '@reboot'
+          when :year     then 12.months
+          when :yearly, 
+               :annually then '@annually'
+          when :day      then 1.day
+          when :daily    then '@daily'
+          when :midnight then '@midnight'
+          when :month    then 1.month
+          when :monthly  then '@monthly'
+          when :week     then 1.week
+          when :weekly   then '@weekly'
+          when :hour     then 1.hour
+          when :hourly   then '@hourly'
         end
         
-        if shortcut
+        if shortcut.is_a?(Numeric)
+          @time = shortcut
+          parse_time
+        elsif shortcut
           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

data/lib/whenever/job_list.rb

@@ -16,12 +16,9 @@ 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)
@@ -91,7 +88,7 @@ module Whenever
       
       output = []
       @env.each do |key, val|
-        output << "#{key}=#{val}\n"
+        output << "#{key}=#{val.blank? ? '""' : val}\n"
       end
       output << "\n"
       

data/lib/whenever/{job_types/default.rb → setup.rb}

@@ -1,10 +1,17 @@
+# 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"
 
-if File.exists?(File.join(Whenever.path, 'script', 'rails'))
+# 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"

data/lib/whenever/version.rb

@@ -1,3 +1,3 @@
 module Whenever
-  VERSION = '0.6.1' 
-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
@@ -301,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
@@ -322,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

@@ -166,7 +166,7 @@ class OutputAtTest < Test::Unit::TestCase
       <<-file
         set :job_template, nil
         set :path, '/your/path'
-        every :day do
+        every :daily do
           rake "blah:blah"
           runner "runner_1"
           command "command_1"
@@ -248,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

@@ -51,6 +51,25 @@ class OutputDefaultDefinedJobsTest < Test::Unit::TestCase
       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
   

data/test/functional/output_env_test.rb

@@ -8,6 +8,8 @@ class OutputEnvTest < Test::Unit::TestCase
       <<-file
         env :MYVAR, 'blah'
         env 'MAILTO', "someone@example.com"
+        env :BLANKVAR, ''
+        env :NILVAR, nil
       file
     end
 
@@ -18,6 +20,14 @@ class OutputEnvTest < Test::Unit::TestCase
     should "output MAILTO environment variable" do
       assert_match "MAILTO=someone@example.com", @output
     end
+
+    should "output BLANKVAR environment variable" do
+      assert_match "BLANKVAR=\"\"", @output
+    end
+
+    should "output NILVAR environment variable" do
+      assert_match "NILVAR=\"\"", @output
+    end
   end
 
-end
+end

data/test/unit/cron_test.rb

@@ -174,20 +174,26 @@ class CronTest < Test::Unit::TestCase
   context "When parsing time using the cron shortcuts" do
     should "parse a :symbol into the correct shortcut" do
       assert_equal '@reboot',   parse_time(:reboot)
-      assert_equal '@annually', parse_time(:year)
+      assert_equal '@annually', parse_time(:annually)
       assert_equal '@annually', parse_time(:yearly)
-      assert_equal '@daily',    parse_time(:day)
       assert_equal '@daily',    parse_time(:daily)
       assert_equal '@midnight', parse_time(:midnight)
-      assert_equal '@monthly',  parse_time(:month)
       assert_equal '@monthly',  parse_time(:monthly)
-      assert_equal '@hourly',   parse_time(:hour)
+      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)
+      assert_equal '0 * * * *',  parse_time(:hour)
+      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(:hour, nil, "1:00 am")
+        parse_time(:hourly, nil, "1:00 am")
       end
       
       assert_raises ArgumentError do
@@ -195,7 +201,16 @@ class CronTest < Test::Unit::TestCase
       end
       
       assert_raises ArgumentError do
-        parse_time(:day, nil, '4:20pm')
+        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 *']
+      crons.each do |cron|
+        assert_equal cron, parse_time(cron)
       end
     end
   end

data/whenever.gemspec

@@ -1,86 +1,22 @@
-# Generated by jeweler
-# DO NOT EDIT THIS FILE DIRECTLY
-# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
 # -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "whenever/version"
 
 Gem::Specification.new do |s|
-  s.name = %q{whenever}
-  s.version = "0.6.1"
-
-  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
-  s.authors = ["Javan Makhmali"]
-  s.date = %q{2010-10-20}
-  s.description = %q{http://www.allyrics.net/Kid-Cudi/lyrics/Whenever/}
-  s.email = %q{javan@javan.us}
-  s.executables = ["whenever", "wheneverize"]
-  s.extra_rdoc_files = [
-    "README.rdoc"
-  ]
-  s.files = [
-    ".gitignore",
-     "CHANGELOG.rdoc",
-     "README.rdoc",
-     "Rakefile",
-     "bin/whenever",
-     "bin/wheneverize",
-     "lib/whenever.rb",
-     "lib/whenever/base.rb",
-     "lib/whenever/capistrano.rb",
-     "lib/whenever/command_line.rb",
-     "lib/whenever/cron.rb",
-     "lib/whenever/job.rb",
-     "lib/whenever/job_list.rb",
-     "lib/whenever/job_types/default.rb",
-     "lib/whenever/output_redirection.rb",
-     "lib/whenever/version.rb",
-     "test/functional/command_line_test.rb",
-     "test/functional/output_at_test.rb",
-     "test/functional/output_default_defined_jobs_test.rb",
-     "test/functional/output_defined_job_test.rb",
-     "test/functional/output_env_test.rb",
-     "test/functional/output_redirection_test.rb",
-     "test/test_helper.rb",
-     "test/unit/cron_test.rb",
-     "test/unit/job_test.rb",
-     "whenever.gemspec"
-  ]
-  s.homepage = %q{http://github.com/javan/whenever}
-  s.rdoc_options = ["--charset=UTF-8"]
+  s.name        = "whenever"
+  s.version     = Whenever::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Javan Makhmali"]
+  s.email       = ["javan@javan.us"]
+  s.homepage    = ""
+  s.summary     = %q{Cron jobs in ruby.}
+  s.description = %q{Clean ruby syntax for writing and deploying cron jobs.}
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- test/{functional,unit}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   s.require_paths = ["lib"]
-  s.rubygems_version = %q{1.3.7}
-  s.summary = %q{Clean ruby syntax for writing and deploying cron jobs.}
-  s.test_files = [
-    "test/functional/command_line_test.rb",
-     "test/functional/output_at_test.rb",
-     "test/functional/output_default_defined_jobs_test.rb",
-     "test/functional/output_defined_job_test.rb",
-     "test/functional/output_env_test.rb",
-     "test/functional/output_redirection_test.rb",
-     "test/test_helper.rb",
-     "test/unit/cron_test.rb",
-     "test/unit/job_test.rb"
-  ]
-
-  if s.respond_to? :specification_version then
-    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
-    s.specification_version = 3
-
-    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
-      s.add_runtime_dependency(%q<aaronh-chronic>, [">= 0.3.9"])
-      s.add_runtime_dependency(%q<activesupport>, [">= 2.3.4"])
-      s.add_development_dependency(%q<shoulda>, [">= 2.1.1"])
-      s.add_development_dependency(%q<mocha>, [">= 0.9.5"])
-    else
-      s.add_dependency(%q<aaronh-chronic>, [">= 0.3.9"])
-      s.add_dependency(%q<activesupport>, [">= 2.3.4"])
-      s.add_dependency(%q<shoulda>, [">= 2.1.1"])
-      s.add_dependency(%q<mocha>, [">= 0.9.5"])
-    end
-  else
-    s.add_dependency(%q<aaronh-chronic>, [">= 0.3.9"])
-    s.add_dependency(%q<activesupport>, [">= 2.3.4"])
-    s.add_dependency(%q<shoulda>, [">= 2.1.1"])
-    s.add_dependency(%q<mocha>, [">= 0.9.5"])
-  end
+  s.add_runtime_dependency(%q<aaronh-chronic>, [">= 0.3.9"])
+  s.add_runtime_dependency(%q<activesupport>, [">= 2.3.4"])
+  s.add_development_dependency(%q<shoulda>, [">= 2.1.1"])
+  s.add_development_dependency(%q<mocha>, [">= 0.9.5"])
 end
-

metadata

@@ -1,12 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: whenever
 version: !ruby/object:Gem::Version 
-  prerelease: false
+  hash: 23
+  prerelease: 
   segments: 
   - 0
   - 6
-  - 1
-  version: 0.6.1
+  - 8
+  version: 0.6.8
 platform: ruby
 authors: 
 - Javan Makhmali
@@ -14,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-10-20 00:00:00 -04:00
+date: 2011-05-24 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -25,6 +26,7 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 1
         segments: 
         - 0
         - 3
@@ -40,6 +42,7 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 11
         segments: 
         - 2
         - 3
@@ -55,6 +58,7 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 9
         segments: 
         - 2
         - 1
@@ -70,6 +74,7 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 49
         segments: 
         - 0
         - 9
@@ -77,31 +82,32 @@ dependencies:
         version: 0.9.5
   type: :development
   version_requirements: *id004
-description: http://www.allyrics.net/Kid-Cudi/lyrics/Whenever/
-email: javan@javan.us
+description: Clean ruby syntax for writing and deploying cron jobs.
+email: 
+- javan@javan.us
 executables: 
 - whenever
 - wheneverize
 extensions: []
 
-extra_rdoc_files: 
-- README.rdoc
+extra_rdoc_files: []
+
 files: 
 - .gitignore
-- CHANGELOG.rdoc
-- README.rdoc
+- CHANGELOG.md
+- Gemfile
+- README.md
 - Rakefile
 - bin/whenever
 - bin/wheneverize
 - lib/whenever.rb
-- lib/whenever/base.rb
 - lib/whenever/capistrano.rb
 - lib/whenever/command_line.rb
 - lib/whenever/cron.rb
 - lib/whenever/job.rb
 - lib/whenever/job_list.rb
-- lib/whenever/job_types/default.rb
 - lib/whenever/output_redirection.rb
+- lib/whenever/setup.rb
 - lib/whenever/version.rb
 - test/functional/command_line_test.rb
 - test/functional/output_at_test.rb
@@ -114,12 +120,12 @@ files:
 - test/unit/job_test.rb
 - whenever.gemspec
 has_rdoc: true
-homepage: http://github.com/javan/whenever
+homepage: ""
 licenses: []
 
 post_install_message: 
-rdoc_options: 
-- --charset=UTF-8
+rdoc_options: []
+
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
@@ -127,6 +133,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
       segments: 
       - 0
       version: "0"
@@ -135,16 +142,17 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
       segments: 
       - 0
       version: "0"
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.7
+rubygems_version: 1.4.2
 signing_key: 
 specification_version: 3
-summary: Clean ruby syntax for writing and deploying cron jobs.
+summary: Cron jobs in ruby.
 test_files: 
 - test/functional/command_line_test.rb
 - test/functional/output_at_test.rb
@@ -152,6 +160,5 @@ test_files:
 - test/functional/output_defined_job_test.rb
 - test/functional/output_env_test.rb
 - test/functional/output_redirection_test.rb
-- test/test_helper.rb
 - test/unit/cron_test.rb
 - test/unit/job_test.rb

data/lib/whenever/base.rb

@@ -1,11 +0,0 @@
-module Whenever
-  
-  def self.cron(options)
-    Whenever::JobList.new(options).generate_cron_output
-  end
-  
-  def self.path
-    Dir.pwd
-  end
-
-end