whenever 0.6.1 → 0.7.0

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
@@ -126,7 +142,6 @@ module Whenever
 
         output[0, max_occurances].join(',')
       end
-
     end
   end
 end

data/lib/whenever/job.rb

@@ -1,6 +1,5 @@
 module Whenever
   class Job
-    
     attr_reader :at
   
     def initialize(options = {})
@@ -42,6 +41,5 @@ module Whenever
     def escape_double_quotes(str)
       str.gsub(/"/) { '\"' }
     end
-    
   end
 end

data/lib/whenever/job_list.rb

@@ -1,27 +1,22 @@
 module Whenever
   class JobList
-  
     def initialize(options)
       @jobs, @env, @set_variables, @pre_set_variables = {}, {}, {}, {}
       
-      case options
-        when String
-          config = options
-        when Hash
-          config = if options[:string]
-            options[:string]
-          elsif options[:file]
-            File.read(options[:file])
-          end
-          pre_set(options[:set])
+      if options.is_a? String
+        options = { :string => options }
       end
+
+      pre_set(options[:set])
       
-      # Load all job type files.
-      Dir["#{File.expand_path(File.dirname(__FILE__))}/job_types/*.rb"].each do |file|
-        eval(File.read(file))
+      setup = File.read("#{File.expand_path(File.dirname(__FILE__))}/setup.rb")
+      schedule = if options[:string]
+        options[:string]
+      elsif options[:file]
+        File.read(options[:file])
       end
       
-      eval(config)
+      instance_eval(setup + schedule, options[:file] || '<eval>')
     end
     
     def set(variable, value)
@@ -91,7 +86,7 @@ module Whenever
       
       output = []
       @env.each do |key, val|
-        output << "#{key}=#{val}\n"
+        output << "#{key}=#{val.blank? ? '""' : val}\n"
       end
       output << "\n"
       
@@ -146,6 +141,5 @@ module Whenever
 
       shortcut_jobs.join + combine(regular_jobs).join
     end
-    
   end
 end

data/lib/whenever/output_redirection.rb

@@ -1,7 +1,6 @@
 module Whenever
   module Output
     class Redirection
-      
       def initialize(output)
         @output = output
       end
@@ -52,7 +51,6 @@ module Whenever
       def redirect_from_string
         ">> #{@output} 2>&1"
       end
-      
     end
   end
 end

data/lib/whenever/setup.rb

@@ -0,0 +1,24 @@
+# Environment 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"
+
+# Run rake through bundler if possible
+if Whenever.bundler?
+  job_type :rake, "cd :path && RAILS_ENV=:environment bundle exec rake :task --silent :output"
+else
+  job_type :rake, "cd :path && RAILS_ENV=:environment rake :task --silent :output"
+end
+
+# Create a runner job that's appropriate for the Rails version,
+if Whenever.rails3?
+  job_type :runner, "cd :path && script/rails runner -e :environment ':task' :output"
+else
+  job_type :runner, "cd :path && script/runner -e :environment ':task' :output"
+end

data/lib/whenever/version.rb

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

data/lib/whenever.rb

@@ -1,10 +1,30 @@
 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'
+module Whenever
+  autoload :JobList,     'whenever/job_list'
+  autoload :Job,         'whenever/job'
+  autoload :CommandLine, 'whenever/command_line'
+  
+  module Output
+    autoload :Cron,        'whenever/cron'
+    autoload :Redirection, 'whenever/output_redirection'
+  end
+  
+  def self.cron(options)
+    Whenever::JobList.new(options).generate_cron_output
+  end
+  
+  def self.path
+    Dir.pwd
+  end
+
+  def self.rails3?
+    File.exists?(File.join(path, 'script', 'rails'))
+  end
+
+  def self.bundler?
+    File.exists?(File.join(path, 'Gemfile'))
+  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

@@ -114,7 +114,7 @@ class OutputAtTest < Test::Unit::TestCase
     end
     
     should "output the rake task using one entry because the times are aligned" do
-      assert_match '2 5,15 * * 1,3,5 cd /your/path && RAILS_ENV=production rake blah:blah --silent', @output
+      assert_match '2 5,15 * * 1,3,5 cd /your/path && RAILS_ENV=production bundle exec rake blah:blah --silent', @output
     end
   end
   
@@ -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"
@@ -177,7 +177,7 @@ class OutputAtTest < Test::Unit::TestCase
     end
     
     should "output all of the commands @daily" do
-      assert_match '@daily cd /your/path && RAILS_ENV=production rake blah:blah --silent', @output
+      assert_match '@daily cd /your/path && RAILS_ENV=production bundle exec rake blah:blah --silent', @output
       assert_match %(@daily cd /your/path && script/runner -e production 'runner_1'), @output
       assert_match '@daily command_1', @output
       assert_match %(@daily cd /your/path && script/runner -e production 'runner_2'), @output
@@ -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
   
@@ -91,7 +110,7 @@ class OutputDefaultDefinedJobsTest < Test::Unit::TestCase
   context "A runner for a Rails 3 app" do
     setup do
       Whenever.expects(:path).at_least_once.returns('/my/path')
-      File.expects(:exists?).with('/my/path/script/rails').returns(true)
+      Whenever.expects(:rails3?).returns(true)
       @output = Whenever.cron \
       <<-file
         set :job_template, nil
@@ -121,6 +140,24 @@ class OutputDefaultDefinedJobsTest < Test::Unit::TestCase
     end
     
     should "output the rake command using that path" do
+      assert_match two_hours + ' cd /my/path && RAILS_ENV=production bundle exec rake blahblah --silent', @output
+    end
+  end
+
+  context "A rake for a non-bundler app" do
+    setup do
+      Whenever.expects(:path).at_least_once.returns('/my/path')
+      Whenever.expects(:bundler?).returns(false)
+      @output = Whenever.cron \
+      <<-file
+        set :job_template, nil
+        every 2.hours do
+          rake 'blahblah'
+        end
+      file
+    end
+
+    should "not use invoke through bundler" do
       assert_match two_hours + ' cd /my/path && RAILS_ENV=production rake blahblah --silent', @output
     end
   end
@@ -138,7 +175,7 @@ class OutputDefaultDefinedJobsTest < Test::Unit::TestCase
     end
     
     should "output the rake command using that path" do
-      assert_match two_hours + ' cd /some/other/path && RAILS_ENV=production rake blahblah --silent', @output
+      assert_match two_hours + ' cd /some/other/path && RAILS_ENV=production bundle exec rake blahblah --silent', @output
     end
   end
   

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/test_helper.rb

@@ -1,5 +1,3 @@
-require 'rubygems'
-
 # Want to test the files here, in lib, not in an installed version of the gem.
 $:.unshift File.expand_path(File.dirname(__FILE__) + '/../lib')
 require 'whenever'

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,31 @@
-# 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_dependency "chronic", "~> 0.6.3"
+  s.add_dependency "activesupport", ">= 2.3.4"
+  
+  s.add_development_dependency "shoulda", ">= 2.1.1"
+  s.add_development_dependency "mocha", ">= 0.9.5"
+  s.add_development_dependency "rake"
+  
+  # I'm not sure why this isn't installed along with activesupport,
+  # but for whatever reason running `bundle install` doesn't install
+  # i18n so I'm adding it here for now.
+  # https://github.com/rails/rails/blob/master/activesupport/activesupport.gemspec#L19 ?
+  s.add_development_dependency "i18n"
 end
-