javan-whenever 0.1.7 → 0.2.2

data/CHANGELOG.rdoc

@@ -1,7 +1,17 @@
+== 0.2.2 / April 30th, 2009
+
+* Days of week jobs can now accept an :at directive (ex: every :monday, :at => '5pm'). [David Eisinger]
+
+* Fixed command line test so it runs without a config/schedule.rb present. [Javan Makhmali]
+
+* 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
 
 * 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
 
 * Fixed load path so Whenever's files don't conflict with anything in Rails. Thanks Ryan Koopmans. [Javan Makhmali]

data/Manifest

@@ -0,0 +1,23 @@
+bin/whenever
+bin/wheneverize
+CHANGELOG.rdoc
+lib/base.rb
+lib/command_line.rb
+lib/job_list.rb
+lib/job_types/default.rb
+lib/job_types/rake_task.rb
+lib/job_types/runner.rb
+lib/outputs/cron.rb
+lib/version.rb
+lib/whenever.rb
+Rakefile
+README.rdoc
+test/command_line_test.rb
+test/cron_test.rb
+test/output_command_test.rb
+test/output_env_test.rb
+test/output_rake_test.rb
+test/output_runner_test.rb
+test/test_helper.rb
+whenever.gemspec
+Manifest

data/README.rdoc

@@ -14,7 +14,7 @@ In a Rails (2.1 or greater) application:
 in your "config/environment.rb" file:
 
   Rails::Initializer.run do |config|
-    config.gem 'javan-whenever', :lib => false, :version => '>= 0.1.7' :source => 'http://gems.github.com'
+    config.gem 'javan-whenever', :lib => false, :source => 'http://gems.github.com'
   end
   
 To install this gem (and all other missing gem dependencies), run rake gems:install (use sudo if necessary).
@@ -57,7 +57,7 @@ This will create an initial "config/schedule.rb" file you.
     runner "SomeModel.ladeeda"
   end
 
-  every :sunday do # Use any day of the week or :weekend, :weekday 
+  every :sunday, :at => '12pm' do # Use any day of the week or :weekend, :weekday 
     runner "Task.do_something_great"
   end
 
@@ -79,15 +79,15 @@ In your "config/deploy.rb" file do something like:
   namespace :deploy do
     desc "Update the crontab file"
     task :update_crontab, :roles => :db do
-      run "cd #{release_path} && whenever --update-crontab"
+      run "cd #{release_path} && whenever --update-crontab #{application}"
     end
   end
 
-This will update your crontab file, leaving any existing entries unharmed. When using the "--update-crontab" option, Whenever will only update the entries in your crontab file related to the current schedule.rb file. This means you can use Whenever to deploy any number of apps to the same server and have them share a single crontab file peacefully.
+This will update your crontab file, leaving any existing entries unharmed. When using the <code>--update-crontab</code> option, Whenever will only update the entries in your crontab file related to the current schedule.rb file. You can replace the <code>#{application}</code> with any identifying string you'd like. You can have any number of apps deploy to the same crontab file peacefully given they each use a different identifier.
 
-If you wish to simply overwrite your crontab file each time you deploy, use the "--write-crontab" option. This is ideal if you are only working with one app and every crontab entry is contained in a single schedule.rb file.
+If you wish to simply overwrite your crontab file each time you deploy, use the <code>--write-crontab</code> option. This is ideal if you are only working with one app and every crontab entry is contained in a single schedule.rb file.
 
-By mixing and matching the "--load-file" and "--user" options with your various :roles in Capistrano it is entirely possible to deploy different crontab schedules under different users to all your various servers. Get creative!
+By mixing and matching the <code>--load-file</code> and <code>--user</code> options with your various :roles in Capistrano it is entirely possible to deploy different crontab schedules under different users to all your various servers. Get creative!
 
 == Credit
 
@@ -97,8 +97,6 @@ While building Whenever, I learned a lot by digging through the source code of C
 
 == Feedback
 
-Lighthouse: http://javan.lighthouseapp.com/projects/25781-whenever/overview
-
 Email me: javan [at] javan (dot) us
 
 == License

data/lib/outputs/cron.rb

@@ -1,21 +1,21 @@
 module Whenever
   module Output
-    
+
     class Cron
-      
+
       attr_accessor :time, :task
-      
+
       def initialize(time = nil, task = nil, at = nil)
         @time = time
         @task = task
         @at   = at.is_a?(String) ? (Chronic.parse(at) || 0) : (at || 0)
       end
-      
+
       def self.output(time, job)
         out = new(time, job.output, job.at)
         "#{out.time_in_cron_syntax} #{out.task}"
       end
-      
+
       def time_in_cron_syntax
         case @time
           when Symbol then parse_symbol
@@ -23,11 +23,11 @@ module Whenever
           else parse_time
         end
       end
-      
+
     protected
-    
+
       def parse_symbol
-        case @time
+        shortcut = case @time
           when :reboot          then '@reboot'
           when :year, :yearly   then '@annually'
           when :day, :daily     then '@daily'
@@ -35,10 +35,19 @@ module Whenever
           when :month, :monthly then '@monthly'
           when :week, :weekly   then '@weekly'
           when :hour, :hourly   then '@hourly'
-          else parse_as_string
+        end
+        
+        if shortcut
+          if @at > 0
+            raise ArgumentError, "You cannot specify an ':at' when using the shortcuts for times."
+          else
+            return shortcut
+          end
+        else
+          parse_as_string
         end
       end
-      
+
       def parse_time
         timing = Array.new(5, '*')
         case @time
@@ -49,7 +58,7 @@ module Whenever
             timing[0] = comma_separated_timing(minute_frequency, 59)
           when 1.hour...1.day
             hour_frequency = (@time / 60 / 60).round
-            timing[0] = @at.is_a?(Time) ? @at.min : @at  
+            timing[0] = @at.is_a?(Time) ? @at.min : @at
             timing[1] = comma_separated_timing(hour_frequency, 23)
           when 1.day...1.month
             day_frequency = (@time / 24 / 60 / 60).round
@@ -67,38 +76,42 @@ module Whenever
         end
         timing.join(' ')
       end
-      
+
       def parse_as_string
         return unless @time
         string = @time.to_s
-        
-        return "0 0 * * mon-fri" if string.downcase.index('weekday')
-        return "0 0 * * sat,sun" if string.downcase.index('weekend')
-        
+
+        timing = Array.new(4, '*')
+        timing[0] = @at.is_a?(Time) ? @at.min  : 0
+        timing[1] = @at.is_a?(Time) ? @at.hour : 0
+
+        return (timing << 'mon-fri') * " " if string.downcase.index('weekday')
+        return (timing << 'sat,sun') * " " if string.downcase.index('weekend')
+
         %w(sun mon tue wed thu fri sat).each do |day|
-          return "0 0 * * #{day}" if string.downcase.index(day)
+          return (timing << day) * " " if string.downcase.index(day)
         end
-        
+
         raise ArgumentError, "Couldn't parse: #{@time}"
       end
-      
+
       def comma_separated_timing(frequency, max, start = 0)
         return start     if frequency.blank? || frequency.zero?
         return '*'       if frequency == 1
         return frequency if frequency > (max * 0.5).ceil
-        
+
         original_start = start
-        
+
         start += frequency unless (max + 1).modulo(frequency).zero? || start > 0
         output = (start..max).step(frequency).to_a
-        
+
         max_occurances = (max.to_f  / (frequency.to_f)).round
         max_occurances += 1 if original_start.zero?
-        
+
         output[0, max_occurances].join(',')
       end
 
     end
-    
+
   end
 end

data/lib/version.rb

@@ -1,8 +1,8 @@
 module Whenever
   module VERSION #:nodoc:
     MAJOR = 0
-    MINOR = 1
-    TINY  = 7
+    MINOR = 2
+    TINY  = 2
 
     STRING = [MAJOR, MINOR, TINY].join('.')
   end

data/test/command_line_test.rb

@@ -4,6 +4,7 @@ class CommandLineTest < Test::Unit::TestCase
   
   context "A command line write" do
     setup do
+      File.expects(:exists?).with('config/schedule.rb').returns(true)
       @command = Whenever::CommandLine.new(:write => true, :identifier => 'My identifier')
       @task = "#{two_hours} /my/command"
       Whenever.expects(:cron).returns(@task)
@@ -27,6 +28,7 @@ class CommandLineTest < Test::Unit::TestCase
   
   context "A command line update" do
     setup do
+      File.expects(:exists?).with('config/schedule.rb').returns(true)
       @command = Whenever::CommandLine.new(:update => true, :identifier => 'My identifier')
       @task = "#{two_hours} /my/command"
       Whenever.expects(:cron).returns(@task)
@@ -85,6 +87,7 @@ class CommandLineTest < Test::Unit::TestCase
   
   context "A command line update with no identifier" do
     setup do
+      File.expects(:exists?).with('config/schedule.rb').returns(true)
       Whenever::CommandLine.any_instance.expects(:default_identifier).returns('DEFAULT')
       @command = Whenever::CommandLine.new(:update => true, :file => @file)
     end

data/test/cron_test.rb

@@ -1,18 +1,18 @@
 require File.expand_path(File.dirname(__FILE__) + "/test_helper")
 
 class CronTest < Test::Unit::TestCase
-  
+
   context "When parsing time in minutes" do
     should "raise if less than 1 minute" do
       assert_raises ArgumentError do
         parse_time(59.seconds)
       end
-      
+
       assert_raises ArgumentError do
         parse_time(0.minutes)
       end
     end
-    
+
     # For santity, do some tests on straight String
     should "parse correctly" do
       assert_equal '* * * * *', parse_time(1.minute)
@@ -22,19 +22,19 @@ class CronTest < Test::Unit::TestCase
       assert_equal '32 * * * *', parse_time(32.minutes)
       assert_not_equal '60 * * * *', parse_time(60.minutes) # 60 minutes bumps up into the hour range
     end
-    
+
     # Test all minutes
     (2..59).each do |num|
       should "parse correctly for #{num} minutes" do
         start = 0
         start += num unless 60.modulo(num).zero?
         minutes = (start..59).step(num).to_a
-        
+
         assert_equal "#{minutes.join(',')} * * * *", parse_time(num.minutes)
       end
     end
   end
-  
+
   context "When parsing time in hours" do
     should "parse correctly" do
       assert_equal '0 * * * *', parse_time(1.hour)
@@ -44,24 +44,24 @@ class CronTest < Test::Unit::TestCase
       assert_equal '0 17 * * *', parse_time(17.hours)
       assert_not_equal '0 24 * * *', parse_time(24.hours) # 24 hours bumps up into the day range
     end
-    
+
     (2..23).each do |num|
       should "parse correctly for #{num} hours" do
         start = 0
         start += num unless 24.modulo(num).zero?
         hours = (start..23).step(num).to_a
-        
+
         assert_equal "0 #{hours.join(',')} * * *", parse_time(num.hours)
       end
     end
-    
+
     should "parse correctly when given an 'at' with minutes as an Integer" do
       assert_minutes_equals "1",  1
       assert_minutes_equals "14", 14
       assert_minutes_equals "27", 27
       assert_minutes_equals "55", 55
     end
-    
+
     should "parse correctly when given an 'at' with minutes as a Time" do
       # Basically just testing that Chronic parses some times and we get the minutes out of it
       assert_minutes_equals "1",  '3:01am'
@@ -70,7 +70,7 @@ class CronTest < Test::Unit::TestCase
       assert_minutes_equals "59", '13:59'
     end
   end
-  
+
   context "When parsing time in days (of month)" do
     should "parse correctly" do
       assert_equal '0 0 * * *', parse_time(1.days)
@@ -82,7 +82,7 @@ class CronTest < Test::Unit::TestCase
       assert_equal '0 0 29 * *', parse_time(29.days)
       assert_not_equal '0 0 30 * *', parse_time(30.days) # 30 days bumps into the month range
     end
-    
+
     should "parse correctly when given an 'at' with hours, minutes as a Time" do
       # first param is an array with [hours, minutes]
       assert_hours_and_minutes_equals %w(3 45),  '3:45am'
@@ -91,7 +91,7 @@ class CronTest < Test::Unit::TestCase
       assert_hours_and_minutes_equals %w(1 23),  '1:23 AM'
       assert_hours_and_minutes_equals %w(23 59), 'March 21 11:59 pM'
     end
-    
+
     should "parse correctly when given an 'at' with hours as an Integer" do
       # first param is an array with [hours, minutes]
       assert_hours_and_minutes_equals %w(1 0),  1
@@ -101,7 +101,7 @@ class CronTest < Test::Unit::TestCase
       assert_hours_and_minutes_equals %w(23 0), 23
     end
   end
-  
+
   context "When parsing time in months" do
     should "parse correctly" do
       assert_equal '0 0 1 * *', parse_time(1.month)
@@ -116,7 +116,7 @@ class CronTest < Test::Unit::TestCase
       assert_equal '0 0 1 11 *', parse_time(11.months)
       assert_equal '0 0 1 12 *', parse_time(12.months)
     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'
@@ -124,7 +124,7 @@ class CronTest < Test::Unit::TestCase
       assert_days_and_hours_and_minutes_equals %w(22 1 1), 'march 22nd at 1:01 am'
       assert_days_and_hours_and_minutes_equals %w(23 0 0), 'march 22nd at midnight' # looks like midnight means the next day
     end
-    
+
     should "parse correctly when given an 'at' with days as an Integer" do
       # first param is an array with [days, hours, minutes]
       assert_days_and_hours_and_minutes_equals %w(1 0 0),  1
@@ -132,7 +132,7 @@ class CronTest < Test::Unit::TestCase
       assert_days_and_hours_and_minutes_equals %w(29 0 0), 29
     end
   end
-  
+
   context "When parsing time in days (of week)" do
     should "parse days of the week correctly" do
       {
@@ -142,25 +142,64 @@ class CronTest < Test::Unit::TestCase
         'wed' => %w(wed Wednesday WEDNESDAY WED),
         'thu' => %w(thu thurs thur Thursday THURSDAY THU),
         'fri' => %w(fri Friday FRIDAY FRI),
-        'sat' => %w(sat Saturday SATURDAY SAT) 
+        'sat' => %w(sat Saturday SATURDAY SAT)
       }.each do |day, day_tests|
         day_tests.each do |day_test|
           assert_equal "0 0 * * #{day}", parse_time(day_test)
         end
       end
     end
-    
+
+    should "allow additional directives" do
+      assert_equal '30 13 * * fri', parse_time('friday', nil, "1:30 pm")
+      assert_equal '22 2 * * mon', parse_time('Monday', nil, "2:22am")
+      assert_equal '55 17 * * thu', parse_time('THU', nil, "5:55PM")
+    end
+
     should "parse weekday correctly" do
       assert_equal '0 0 * * mon-fri', parse_time('weekday')
       assert_equal '0 0 * * mon-fri', parse_time('Weekdays')
+      assert_equal '0 1 * * mon-fri', parse_time('Weekdays', nil, "1:00 am")
+      assert_equal '59 5 * * mon-fri', parse_time('Weekdays', nil, "5:59 am")
     end
-    
+
     should "parse weekend correctly" do
       assert_equal '0 0 * * sat,sun', parse_time('weekend')
       assert_equal '0 0 * * sat,sun', parse_time('Weekends')
+      assert_equal '0 7 * * sat,sun', parse_time('Weekends', nil, "7am")
+      assert_equal '2 18 * * sat,sun', 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)
+      assert_equal '@annually', parse_time(:year)
+      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 '@hourly',   parse_time(:hourly)
+    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")
+      end
+      
+      assert_raises ArgumentError do
+        parse_time(:reboot, nil, 5)
+      end
+      
+      assert_raises ArgumentError do
+        parse_time(:day, nil, '4:20pm')
+      end
+    end
+  end
+
 private
 
   def assert_days_and_hours_and_minutes_equals(expected, time)
@@ -183,5 +222,5 @@ private
   def parse_time(time = nil, task = nil, at = nil)
     Whenever::Output::Cron.new(time, task, at).time_in_cron_syntax
   end
-  
+
 end

data/whenever.gemspec

@@ -2,16 +2,16 @@
 
 Gem::Specification.new do |s|
   s.name = %q{whenever}
-  s.version = "0.1.7"
+  s.version = "0.2.2"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
   s.authors = ["Javan Makhmali"]
-  s.date = %q{2009-03-05}
+  s.date = %q{2009-04-30}
   s.description = %q{Provides clean ruby syntax for defining messy cron jobs and running them Whenever.}
   s.email = %q{javan@javan.us}
   s.executables = ["whenever", "wheneverize"]
   s.extra_rdoc_files = ["bin/whenever", "bin/wheneverize", "CHANGELOG.rdoc", "lib/base.rb", "lib/command_line.rb", "lib/job_list.rb", "lib/job_types/default.rb", "lib/job_types/rake_task.rb", "lib/job_types/runner.rb", "lib/outputs/cron.rb", "lib/version.rb", "lib/whenever.rb", "README.rdoc"]
-  s.files = ["bin/whenever", "bin/wheneverize", "CHANGELOG.rdoc", "lib/base.rb", "lib/command_line.rb", "lib/job_list.rb", "lib/job_types/default.rb", "lib/job_types/rake_task.rb", "lib/job_types/runner.rb", "lib/outputs/cron.rb", "lib/version.rb", "lib/whenever.rb", "Manifest", "Rakefile", "README.rdoc", "test/command_line_test.rb", "test/cron_test.rb", "test/output_command_test.rb", "test/output_env_test.rb", "test/output_rake_test.rb", "test/output_runner_test.rb", "test/test_helper.rb", "whenever.gemspec"]
+  s.files = ["bin/whenever", "bin/wheneverize", "CHANGELOG.rdoc", "lib/base.rb", "lib/command_line.rb", "lib/job_list.rb", "lib/job_types/default.rb", "lib/job_types/rake_task.rb", "lib/job_types/runner.rb", "lib/outputs/cron.rb", "lib/version.rb", "lib/whenever.rb", "Rakefile", "README.rdoc", "test/command_line_test.rb", "test/cron_test.rb", "test/output_command_test.rb", "test/output_env_test.rb", "test/output_rake_test.rb", "test/output_runner_test.rb", "test/test_helper.rb", "whenever.gemspec", "Manifest"]
   s.has_rdoc = true
   s.homepage = %q{http://github.com/javan/whenever}
   s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Whenever", "--main", "README.rdoc"]

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: javan-whenever
 version: !ruby/object:Gem::Version 
-  version: 0.1.7
+  version: 0.2.2
 platform: ruby
 authors: 
 - Javan Makhmali
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-03-05 00:00:00 -08:00
+date: 2009-04-30 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -66,7 +66,6 @@ files:
 - lib/outputs/cron.rb
 - lib/version.rb
 - lib/whenever.rb
-- Manifest
 - Rakefile
 - README.rdoc
 - test/command_line_test.rb
@@ -77,6 +76,7 @@ files:
 - test/output_runner_test.rb
 - test/test_helper.rb
 - whenever.gemspec
+- Manifest
 has_rdoc: true
 homepage: http://github.com/javan/whenever
 post_install_message: