whenever 0.5.0 → 0.6.2

data/test/functional/output_default_defined_jobs_test.rb

@@ -0,0 +1,164 @@
+require File.expand_path(File.dirname(__FILE__) + "/../test_helper")
+
+class OutputDefaultDefinedJobsTest < Test::Unit::TestCase
+  
+  # command
+  
+  context "A plain command with the job template set to nil" do
+    setup do
+      @output = Whenever.cron \
+      <<-file
+        set :job_template, nil
+        every 2.hours do
+          command "blahblah"
+        end
+      file
+    end
+    
+    should "output the command" do
+      assert_match /^.+ .+ .+ .+ blahblah$/, @output
+    end
+  end
+  
+  context "A plain command with no job template set" do
+    setup do
+      @output = Whenever.cron \
+      <<-file
+        every 2.hours do
+          command "blahblah"
+        end
+      file
+    end
+    
+    should "output the command with the default job template" do
+      assert_match /^.+ .+ .+ .+ \/bin\/bash -l -c 'blahblah'$/, @output
+    end
+  end
+  
+  context "A plain command that overrides the job_template set" do
+    setup do
+      @output = Whenever.cron \
+      <<-file
+        set :job_template, "/bin/bash -l -c ':job'"
+        every 2.hours do
+          command "blahblah", :job_template => "/bin/sh -l -c ':job'"
+        end
+      file
+    end
+    
+    should "output the command using that job_template" do
+      assert_match /^.+ .+ .+ .+ \/bin\/sh -l -c 'blahblah'$/, @output
+      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
+  
+  context "A runner with path set" do
+    setup do
+      @output = Whenever.cron \
+      <<-file
+        set :job_template, nil
+        set :path, '/my/path'
+        every 2.hours do
+          runner 'blahblah'
+        end
+      file
+    end
+    
+    should "output the runner using that path" do
+      assert_match two_hours + %( cd /my/path && script/runner -e production 'blahblah'), @output
+    end
+  end
+  
+  context "A runner that overrides the path set" do
+    setup do
+      @output = Whenever.cron \
+      <<-file
+        set :job_template, nil
+        set :path, '/my/path'
+        every 2.hours do
+          runner "blahblah", :path => '/some/other/path'
+        end
+      file
+    end
+    
+    should "output the runner using that path" do
+      assert_match two_hours + %( cd /some/other/path && script/runner -e production 'blahblah'), @output
+    end
+  end
+  
+  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)
+      @output = Whenever.cron \
+      <<-file
+        set :job_template, nil
+        every 2.hours do
+          runner 'blahblah'
+        end
+      file
+    end
+    
+    should "use the Rails 3 runner job by default" do
+      assert_match two_hours + %( cd /my/path && script/rails runner -e production 'blahblah'), @output
+    end
+  end
+  
+  # rake
+  
+  context "A rake command with path set" do
+    setup do
+      @output = Whenever.cron \
+      <<-file
+        set :job_template, nil
+        set :path, '/my/path'
+        every 2.hours do
+          rake "blahblah"
+        end
+      file
+    end
+    
+    should "output the rake command using that path" do
+      assert_match two_hours + ' cd /my/path && RAILS_ENV=production rake blahblah --silent', @output
+    end
+  end
+  
+  context "A rake command that overrides the path set" do
+    setup do
+      @output = Whenever.cron \
+      <<-file
+        set :job_template, nil
+        set :path, '/my/path'
+        every 2.hours do
+          rake "blahblah", :path => '/some/other/path'
+        end
+      file
+    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
+    end
+  end
+  
+end

data/test/{output_defined_job_test.rb → functional/output_defined_job_test.rb}

@@ -1,4 +1,4 @@
-require File.expand_path(File.dirname(__FILE__) + "/test_helper")
+require File.expand_path(File.dirname(__FILE__) + "/../test_helper")
 
 class OutputDefinedJobTest < Test::Unit::TestCase
   
@@ -6,6 +6,7 @@ class OutputDefinedJobTest < Test::Unit::TestCase
     setup do
       @output = Whenever.cron \
       <<-file
+        set :job_template, nil
         job_type :some_job, "before :task after"
         every 2.hours do
           some_job "during"
@@ -22,6 +23,7 @@ class OutputDefinedJobTest < Test::Unit::TestCase
     setup do
       @output = Whenever.cron \
       <<-file
+        set :job_template, nil
         job_type :some_job, "before :task after :option1 :option2"
         every 2.hours do
           some_job "during", :option1 => 'happy', :option2 => 'birthday'
@@ -38,6 +40,7 @@ class OutputDefinedJobTest < Test::Unit::TestCase
     setup do
       @output = Whenever.cron \
       <<-file
+        set :job_template, nil
         job_type :some_job, "before :task after :option1"
         set :option1, 'happy'
         every 2.hours do
@@ -55,6 +58,7 @@ class OutputDefinedJobTest < Test::Unit::TestCase
     setup do
       @output = Whenever.cron \
       <<-file
+        set :job_template, nil
         job_type :some_job, "before :task after :option1"
         set :option1, 'global'
         every 2.hours do
@@ -72,6 +76,7 @@ class OutputDefinedJobTest < Test::Unit::TestCase
     setup do
       @output = Whenever.cron \
       <<-file
+        set :job_template, nil
         job_type :some_job, "before :task after :option1"
         every 2.hours do
           some_job "during", :option2 => 'happy'
@@ -84,4 +89,23 @@ class OutputDefinedJobTest < Test::Unit::TestCase
     end
   end
   
+  context "A defined job that uses a :path where none is explicitly set" do
+    setup do
+      Whenever.stubs(:path).returns('/my/path')
+      
+      @output = Whenever.cron \
+      <<-file
+        set :job_template, nil
+        job_type :some_job, "cd :path && :task"
+        every 2.hours do
+          some_job 'blahblah'
+        end
+      file
+    end
+    
+    should "default to using the Whenever.path" do
+      assert_match two_hours + %( cd /my/path && blahblah), @output
+    end
+  end
+
 end

data/test/functional/output_env_test.rb

@@ -0,0 +1,23 @@
+require File.expand_path(File.dirname(__FILE__) + "/../test_helper")
+
+class OutputEnvTest < Test::Unit::TestCase
+
+  context "The output from Whenever with environment variables set" do
+    setup do
+      @output = Whenever.cron \
+      <<-file
+        env :MYVAR, 'blah'
+        env 'MAILTO', "someone@example.com"
+      file
+    end
+
+    should "output MYVAR environment variable" do
+      assert_match "MYVAR=blah", @output
+    end
+  
+    should "output MAILTO environment variable" do
+      assert_match "MAILTO=someone@example.com", @output
+    end
+  end
+
+end

data/test/{output_redirection_test.rb → functional/output_redirection_test.rb}

@@ -1,4 +1,4 @@
-require File.expand_path(File.dirname(__FILE__) + "/test_helper")
+require File.expand_path(File.dirname(__FILE__) + "/../test_helper")
 
 class OutputRedirectionTest < Test::Unit::TestCase
 
@@ -6,6 +6,7 @@ class OutputRedirectionTest < Test::Unit::TestCase
     setup do
       @output = Whenever.cron \
       <<-file
+        set :job_template, nil
         set :output, nil
         every 2.hours do
           command "blahblah"
@@ -23,6 +24,7 @@ class OutputRedirectionTest < Test::Unit::TestCase
     setup do
       @output = Whenever.cron \
       <<-file
+        set :job_template, nil
         set :output, 'logfile.log'
         every 2.hours do
           command "blahblah"
@@ -39,6 +41,7 @@ class OutputRedirectionTest < Test::Unit::TestCase
     setup do
       @output = Whenever.cron \
       <<-file
+        set :job_template, nil
         every 2.hours do
           command "blahblah", :output => {:standard => 'dev_null', :error => 'dev_err'}
         end
@@ -54,6 +57,7 @@ class OutputRedirectionTest < Test::Unit::TestCase
     setup do
       @output = Whenever.cron \
       <<-file
+        set :job_template, nil
         set :output, 'logfile.log'
         every 2.hours do
           command "blahblah", :output => 'otherlog.log'
@@ -71,6 +75,7 @@ class OutputRedirectionTest < Test::Unit::TestCase
     setup do
       @output = Whenever.cron \
       <<-file
+        set :job_template, nil
         set :output, 'logfile.log'
         every 2.hours do
           command "blahblah", :output => {:error => 'dev_err', :standard => 'dev_null' }
@@ -88,6 +93,7 @@ class OutputRedirectionTest < Test::Unit::TestCase
     setup do
       @output = Whenever.cron \
       <<-file
+        set :job_template, nil
         set :output, 'logfile.log'
         every 2.hours do
           command "blahblah", :output => false
@@ -105,6 +111,7 @@ class OutputRedirectionTest < Test::Unit::TestCase
     setup do
       @output = Whenever.cron :set => 'output=otherlog.log', :string => \
       <<-file
+        set :job_template, nil
         set :output, 'logfile.log'
         every 2.hours do
           command "blahblah"
@@ -122,6 +129,7 @@ class OutputRedirectionTest < Test::Unit::TestCase
     setup do
       @output = Whenever.cron \
       <<-file
+        set :job_template, nil
         set :output, {:error => 'dev_err', :standard => 'dev_null' }
         every 2.hours do
           command "blahblah"
@@ -138,6 +146,7 @@ class OutputRedirectionTest < Test::Unit::TestCase
     setup do
       @output = Whenever.cron \
       <<-file
+        set :job_template, nil
         set :output, {:error => 'dev_null'}
         every 2.hours do
           command "blahblah"
@@ -154,6 +163,7 @@ class OutputRedirectionTest < Test::Unit::TestCase
     setup do
       @output = Whenever.cron \
       <<-file
+        set :job_template, nil
         set :output, {:standard => 'dev_out'}
         every 2.hours do
           command "blahblah"
@@ -170,6 +180,7 @@ class OutputRedirectionTest < Test::Unit::TestCase
     setup do
       @output = Whenever.cron \
       <<-file
+        set :job_template, nil
         every 2.hours do
           command "blahblah", :output => {:error => 'dev_err'}
         end
@@ -185,6 +196,7 @@ class OutputRedirectionTest < Test::Unit::TestCase
     setup do
       @output = Whenever.cron \
       <<-file
+        set :job_template, nil
         every 2.hours do
           command "blahblah", :output => {:standard => 'dev_out'}
         end
@@ -200,6 +212,7 @@ class OutputRedirectionTest < Test::Unit::TestCase
     setup do
       @output = Whenever.cron \
       <<-file
+        set :job_template, nil
         every 2.hours do
           command "blahblah", :output => {:standard => nil}
         end
@@ -215,6 +228,7 @@ class OutputRedirectionTest < Test::Unit::TestCase
     setup do
       @output = Whenever.cron \
       <<-file
+        set :job_template, nil
         every 2.hours do
           command "blahblah", :output => {:error => nil}
         end
@@ -230,6 +244,7 @@ class OutputRedirectionTest < Test::Unit::TestCase
     setup do
       @output = Whenever.cron \
       <<-file
+        set :job_template, nil
         every 2.hours do
           command "blahblah", :output => {:error => nil, :standard => nil}
         end
@@ -245,6 +260,7 @@ class OutputRedirectionTest < Test::Unit::TestCase
     setup do
       @output = Whenever.cron \
       <<-file
+        set :job_template, nil
         every 2.hours do
           command "blahblah", :output => {:error => nil, :standard => 'my.log'}
         end
@@ -260,6 +276,7 @@ class OutputRedirectionTest < Test::Unit::TestCase
     setup do
       @output = Whenever.cron \
       <<-file
+        set :job_template, nil
         every 2.hours do
           command "blahblah", :output => {:error => 'my_error.log', :standard => nil}
         end
@@ -275,6 +292,7 @@ class OutputRedirectionTest < Test::Unit::TestCase
     setup do
       @output = Whenever.cron \
       <<-file
+        set :job_template, nil
         set :cron_log, "cron.log"
         every 2.hours do
           command "blahblah"

data/test/test_helper.rb

@@ -1,24 +1,11 @@
 require 'rubygems'
-require 'test/unit'
 
-require File.expand_path(File.dirname(__FILE__) + "/../lib/whenever")
-
-begin
-  require 'shoulda'
-rescue LoadError
-  warn 'To test Whenever you need the shoulda gem:'
-  warn '$ sudo gem install thoughtbot-shoulda'
-  exit(1)
-end
-
-begin
-  require 'mocha'
-rescue LoadError
-  warn 'To test Whenever you need the mocha gem:'
-  warn '$ sudo gem install mocha'
-  exit(1)
-end
+# 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'
 
+require 'shoulda'
+require 'mocha'
 
 module TestExtensions
   

data/test/{cron_test.rb → unit/cron_test.rb}

@@ -1,4 +1,4 @@
-require File.expand_path(File.dirname(__FILE__) + "/test_helper")
+require File.expand_path(File.dirname(__FILE__) + "/../test_helper")
 
 class CronTest < Test::Unit::TestCase
 

data/test/unit/job_test.rb

@@ -0,0 +1,77 @@
+require File.expand_path(File.dirname(__FILE__) + "/../test_helper")
+
+class JobTest < Test::Unit::TestCase
+  
+  context "A Job" do
+    should "return the :at set when #at is called" do
+      assert_equal 'foo', new_job(:at => 'foo').at
+    end
+    
+    should "substitute the :task when #output is called" do
+      job = new_job(:template => ":task", :task => 'abc123')
+      assert_equal 'abc123', job.output
+    end
+    
+    should "substitute the :path when #output is called" do
+      assert_equal 'foo', new_job(:template => ':path', :path => 'foo').output
+    end
+    
+    should "substitute the :path with the default Whenever.path if none is provided when #output is called" do
+      Whenever.expects(:path).returns('/my/path')
+      assert_equal '/my/path', new_job(:template => ':path').output
+    end
+  end
+
+  
+  context "A Job with quotes" do
+    should "output the :task if it's in single quotes" do
+      job = new_job(:template => "':task'", :task => 'abc123')
+      assert_equal %q('abc123'), job.output
+    end
+    
+    should "output the :task if it's in double quotes" do
+      job = new_job(:template => '":task"', :task => 'abc123')
+      assert_equal %q("abc123"), job.output
+    end
+    
+    should "output escaped single quotes in when it's wrapped in them" do
+      job = new_job(
+        :template => "before ':foo' after",
+        :foo => "quote -> ' <- quote"
+      )
+      assert_equal %q(before 'quote -> '\'' <- quote' after), job.output
+    end
+    
+    should "output escaped double quotes when it's wrapped in them" do
+      job = new_job(
+        :template => 'before ":foo" after',
+        :foo => 'quote -> " <- quote'
+      )
+      assert_equal %q(before "quote -> \" <- quote" after), job.output
+    end
+  end
+  
+  context "A Job with a job_template" do
+    should "use the job template" do
+      job = new_job(:template => ':task', :task => 'abc123', :job_template => 'left :job right')
+      assert_equal 'left abc123 right', job.output
+    end
+    
+    should "escape single quotes" do
+      job = new_job(:template => "before ':task' after", :task => "quote -> ' <- quote", :job_template => "left ':job' right")
+      assert_equal %q(left 'before '\''quote -> '\\''\\'\\'''\\'' <- quote'\'' after' right), job.output
+    end
+    
+    should "escape double quotes" do
+      job = new_job(:template => 'before ":task" after', :task => 'quote -> " <- quote', :job_template => 'left ":job" right')
+      assert_equal %q(left "before \"quote -> \\\" <- quote\" after" right), job.output
+    end
+  end
+
+private
+
+  def new_job(options={})
+    Whenever::Job.new(options)
+  end
+  
+end

data/whenever.gemspec

@@ -5,74 +5,81 @@
 
 Gem::Specification.new do |s|
   s.name = %q{whenever}
-  s.version = "0.5.0"
+  s.version = "0.6.2"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Javan Makhmali"]
-  s.date = %q{2010-06-28}
-  s.description = %q{Clean ruby syntax for defining and deploying messy cron jobs.}
+  s.date = %q{2010-10-26}
+  s.description = %q{Clean ruby syntax for writing and deploying cron jobs.}
   s.email = %q{javan@javan.us}
   s.executables = ["whenever", "wheneverize"]
   s.extra_rdoc_files = [
-    "README.rdoc"
+    "README.md"
   ]
   s.files = [
     ".gitignore",
-     "CHANGELOG.rdoc",
-     "README.rdoc",
+     "CHANGELOG.md",
+     "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/outputs/cron.rb",
-     "lib/whenever/outputs/cron/output_redirection.rb",
+     "lib/whenever/output_redirection.rb",
+     "lib/whenever/setup.rb",
      "lib/whenever/version.rb",
-     "test/command_line_test.rb",
-     "test/cron_test.rb",
-     "test/output_at_test.rb",
-     "test/output_command_test.rb",
-     "test/output_defined_job_test.rb",
-     "test/output_env_test.rb",
-     "test/output_rake_test.rb",
-     "test/output_redirection_test.rb",
-     "test/output_runner_test.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.require_paths = ["lib"]
-  s.rubygems_version = %q{1.3.6}
-  s.summary = %q{Clean ruby syntax for defining and deploying messy cron jobs.}
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{Write your cron jobs in ruby.}
   s.test_files = [
-    "test/command_line_test.rb",
-     "test/cron_test.rb",
-     "test/output_at_test.rb",
-     "test/output_command_test.rb",
-     "test/output_defined_job_test.rb",
-     "test/output_env_test.rb",
-     "test/output_rake_test.rb",
-     "test/output_redirection_test.rb",
-     "test/output_runner_test.rb",
-     "test/test_helper.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"
   ]
 
   if s.respond_to? :specification_version then
     current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
     s.specification_version = 3
 
-    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
-      s.add_runtime_dependency(%q<chronic>, [">= 0.2.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<chronic>, [">= 0.2.3"])
+      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<chronic>, [">= 0.2.3"])
+    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
 end