whenever 0.3.7

data/test/output_command_test.rb

@@ -0,0 +1,104 @@
+require File.expand_path(File.dirname(__FILE__) + "/test_helper")
+
+class OutputCommandTest < Test::Unit::TestCase
+  
+  context "A plain command" do
+    setup do
+      @output = Whenever.cron \
+      <<-file
+        every 2.hours do
+          command "blahblah"
+        end
+      file
+    end
+    
+    should "output the command" do
+      assert_match /^.+ .+ .+ .+ blahblah$/, @output
+    end
+  end
+  
+  context "A command when the cron_log is set" do
+    setup do
+      @output = Whenever.cron \
+      <<-file
+        set :cron_log, 'logfile.log'
+        every 2.hours do
+          command "blahblah"
+        end
+      file
+    end
+    
+    should "output the command with the log syntax appended" do
+      assert_match /^.+ .+ .+ .+ blahblah >> logfile.log 2>&1$/, @output
+    end
+  end
+  
+  context "A command when the cron_log is set and the comand overrides it" do
+    setup do
+      @output = Whenever.cron \
+      <<-file
+        set :cron_log, 'logfile.log'
+        every 2.hours do
+          command "blahblah", :cron_log => 'otherlog.log'
+        end
+      file
+    end
+    
+    should "output the command with the log syntax appended" do
+      assert_no_match /.+ .+ .+ .+ blahblah >> logfile.log 2>&1/, @output
+      assert_match /^.+ .+ .+ .+ blahblah >> otherlog.log 2>&1$/, @output
+    end
+  end
+  
+  context "A command when the cron_log is set and the comand rejects it" do
+    setup do
+      @output = Whenever.cron \
+      <<-file
+        set :cron_log, 'logfile.log'
+        every 2.hours do
+          command "blahblah", :cron_log => false
+        end
+      file
+    end
+
+    should "output the command without the log syntax appended" do
+      assert_no_match /.+ .+ .+ .+ blahblah >> logfile.log 2>&1/, @output
+      assert_match /^.+ .+ .+ .+ blahblah$/, @output
+    end
+  end
+  
+  context "A command when the cron_log is set and is overridden by the :set option" do
+    setup do
+      @output = Whenever.cron :set => 'cron_log=otherlog.log', :string => \
+      <<-file
+        set :cron_log, 'logfile.log'
+        every 2.hours do
+          command "blahblah"
+        end
+      file
+    end
+
+    should "output the otherlog.log as the log file" do
+      assert_no_match /.+ .+ .+ .+ blahblah >> logfile.log 2>&1/, @output
+      assert_match /^.+ .+ .+ .+ blahblah >> otherlog.log 2>&1/, @output
+    end
+  end
+  
+  context "An every statement with two commands in it" do
+    setup do
+      @output = Whenever.cron \
+      <<-file
+        every 1.hour do
+          command "first"
+          command "second"
+        end
+      file
+    end
+
+    should "output both commands" do
+      assert_match "0 * * * * first", @output
+      assert_match "0 * * * * second", @output
+    end
+  end
+  
+end

data/test/output_env_test.rb

@@ -0,0 +1,56 @@
+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
+  
+  context "No PATH environment variable set" do
+    setup do
+      Whenever::JobList.any_instance.expects(:read_path).at_least_once.returns('/usr/local/bin')
+      @output = Whenever.cron ""
+    end
+    
+    should "add a PATH variable based on the user's PATH" do
+      assert_match "PATH=/usr/local/bin", @output
+    end
+  end
+  
+  context "A PATH environment variable set" do
+    setup do
+      Whenever::JobList.stubs(:read_path).returns('/usr/local/bin')
+      @output = Whenever.cron "env :PATH, '/my/path'"
+    end
+    
+    should "use that path and the user's PATH" do
+      assert_match "PATH=/my/path", @output
+      assert_no_match /local/, @output
+    end
+  end
+  
+  context "No PATH set and instructed not to automatically load the user's path" do
+    setup do
+      @output = Whenever.cron "set :set_path_automatically, false"
+    end
+    
+    should "not have a PATH set" do
+      assert_no_match /PATH/, @output
+    end
+  end
+
+end

data/test/output_rake_test.rb

@@ -0,0 +1,74 @@
+require File.expand_path(File.dirname(__FILE__) + "/test_helper")
+
+class OutputRakeTest < Test::Unit::TestCase
+  
+  # Rake are generated in an almost identical way to runners so we
+  # only need some basic tests to ensure they are output correctly
+  
+  context "A rake command with path set" do
+    setup do
+      @output = Whenever.cron \
+      <<-file
+        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 /usr/bin/env rake blahblah', @output
+    end
+  end
+  
+  context "A rake command that overrides the path set" do
+    setup do
+      @output = Whenever.cron \
+      <<-file
+        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 /usr/bin/env rake blahblah', @output
+    end
+  end
+  
+  context "A rake command with environment set" do
+    setup do
+      @output = Whenever.cron \
+      <<-file
+        set :environment, :silly
+        set :path, '/my/path'
+        every 2.hours do
+          rake "blahblah"
+        end
+      file
+    end
+    
+    should "output the rake command using that environment" do
+      assert_match two_hours + ' cd /my/path && RAILS_ENV=silly /usr/bin/env rake blahblah', @output
+    end
+  end
+  
+  context "A rake command that overrides the environment set" do
+    setup do
+      @output = Whenever.cron \
+      <<-file
+        set :environment, :silly
+        set :path, '/my/path'
+        every 2.hours do
+          rake "blahblah", :environment => :serious
+        end
+      file
+    end
+    
+    should "output the rake command using that environment" do
+      assert_match two_hours + ' cd /my/path && RAILS_ENV=serious /usr/bin/env rake blahblah', @output
+    end
+  end
+  
+end

data/test/output_runner_test.rb

@@ -0,0 +1,209 @@
+require File.expand_path(File.dirname(__FILE__) + "/test_helper")
+
+class OutputRunnerTest < Test::Unit::TestCase
+  
+  context "A runner with path set" do
+    setup do
+      @output = Whenever.cron \
+      <<-file
+        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 + ' /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 :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 + ' /some/other/path/script/runner -e production "blahblah"', @output
+    end
+  end
+  
+  context "A runner with no path set and RAILS_ROOT defined" do
+    setup do
+      Whenever.stubs(:path).returns('/my/path')
+      
+      @output = Whenever.cron \
+      <<-file
+        every 2.hours do
+          runner "blahblah"
+        end
+      file
+    end
+    
+    should "output the runner using that path" do
+      assert_match two_hours + ' /my/path/script/runner -e production "blahblah"', @output
+    end
+  end
+  
+  context "A runner with path set AND RAILS_ROOT defined" do
+    setup do
+      Whenever.stubs(:path).returns('/my/rails/path')
+      
+      @output = Whenever.cron \
+      <<-file
+        set :path, '/my/path'
+        every 2.hours do
+          runner "blahblah"
+        end
+      file
+    end
+    
+    should "use the path" do
+      assert_match two_hours + ' /my/path/script/runner -e production "blahblah"', @output
+      assert_no_match /\/rails\/path/, @output
+    end
+  end
+  
+  context "A runner with no path set and no RAILS_ROOT defined" do
+    setup do
+      Whenever.stubs(:path).returns(nil)
+      
+      @input = <<-file
+        every 2.hours do
+          runner "blahblah"
+        end
+      file
+    end
+    
+    should "raise an exception" do
+      assert_raises ArgumentError do
+        Whenever.cron(@input)
+      end
+    end
+  end
+  
+  context "A runner with an environment set" do
+    setup do
+      @output = Whenever.cron \
+      <<-file
+        set :environment, :silly
+        set :path, '/my/path'
+        every 2.hours do
+          runner "blahblah"
+        end
+      file
+    end
+    
+    should "output the runner using that environment" do
+      assert_match two_hours + ' /my/path/script/runner -e silly "blahblah"', @output
+    end
+  end
+  
+  context "A runner that overrides the environment set" do
+    setup do
+      @output = Whenever.cron \
+      <<-file
+        set :environment, :silly
+        set :path, '/my/path'
+        every 2.hours do
+          runner "blahblah", :environment => :serious
+        end
+      file
+    end
+    
+    should "output the runner using that environment" do
+      assert_match two_hours + ' /my/path/script/runner -e serious "blahblah"', @output
+    end
+  end
+  
+  context "A runner where the environment is overridden using the :set option" do
+    setup do
+      @output = Whenever.cron :set => 'environment=serious', :string => \
+      <<-file
+        set :environment, :silly
+        set :path, '/my/path'
+        every 2.hours do
+          runner "blahblah"
+        end
+      file
+    end
+    
+    should "output the runner using the override environment" do
+      assert_match two_hours + ' /my/path/script/runner -e serious "blahblah"', @output
+    end
+  end
+  
+  context "A runner where the environment and path are overridden using the :set option" do
+    setup do
+      @output = Whenever.cron :set => 'environment=serious&path=/serious/path', :string => \
+      <<-file
+        set :environment, :silly
+        set :path, '/silly/path'
+        every 2.hours do
+          runner "blahblah"
+        end
+      file
+    end
+    
+    should "output the runner using the overridden path and environment" do
+      assert_match two_hours + ' /serious/path/script/runner -e serious "blahblah"', @output
+    end
+  end
+  
+  context "A runner where the environment and path are overridden using the :set option with spaces in the string" do
+    setup do
+      @output = Whenever.cron :set => ' environment = serious&  path =/serious/path', :string => \
+      <<-file
+        set :environment, :silly
+        set :path, '/silly/path'
+        every 2.hours do
+          runner "blahblah"
+        end
+      file
+    end
+    
+    should "output the runner using the overridden path and environment" do
+      assert_match two_hours + ' /serious/path/script/runner -e serious "blahblah"', @output
+    end
+  end
+  
+  context "A runner where the environment is overridden using the :set option but no value is given" do
+    setup do
+      @output = Whenever.cron :set => ' environment=', :string => \
+      <<-file
+        set :environment, :silly
+        set :path, '/silly/path'
+        every 2.hours do
+          runner "blahblah"
+        end
+      file
+    end
+    
+    should "output the runner using the original environmnet" do
+      assert_match two_hours + ' /silly/path/script/runner -e silly "blahblah"', @output
+    end
+  end
+  
+  context "A runner which makes use of double quotes" do
+    setup do
+      @output = Whenever.cron \
+      <<-file
+        set :path, '/my/path'
+        every 2.hours do
+          runner 'Product.import("http://example.com/product.xml")'
+        end
+      file
+    end
+    
+    should "output the runner using the original environmnet" do
+      assert_match two_hours + ' /my/path/script/runner -e production "Product.import(\"http://example.com/product.xml\")"', @output
+    end
+  end
+  
+end

data/test/test_helper.rb

@@ -0,0 +1,33 @@
+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
+
+
+module TestExtensions
+  
+  def two_hours
+    "0 0,2,4,6,8,10,12,14,16,18,20,22 * * *"
+  end
+  
+end
+
+class Test::Unit::TestCase
+  include TestExtensions
+end

data/whenever.gemspec

@@ -0,0 +1,35 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{whenever}
+  s.version = "0.3.7"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Javan Makhmali"]
+  s.date = %q{2009-10-07}
+  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_at_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.homepage = %q{http://github.com/javan/whenever}
+  s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Whenever", "--main", "README.rdoc"]
+  s.require_paths = ["lib"]
+  s.rubyforge_project = %q{whenever}
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{Provides clean ruby syntax for defining messy cron jobs and running them Whenever.}
+  s.test_files = ["test/command_line_test.rb", "test/cron_test.rb", "test/output_at_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"]
+
+  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"])
+    else
+      s.add_dependency(%q<chronic>, [">= 0.2.3"])
+    end
+  else
+    s.add_dependency(%q<chronic>, [">= 0.2.3"])
+  end
+end

metadata

@@ -0,0 +1,112 @@
+--- !ruby/object:Gem::Specification 
+name: whenever
+version: !ruby/object:Gem::Version 
+  version: 0.3.7
+platform: ruby
+authors: 
+- Javan Makhmali
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-10-07 00:00:00 -04:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: chronic
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.2.3
+    version: 
+description: Provides clean ruby syntax for defining messy cron jobs and running them Whenever.
+email: javan@javan.us
+executables: 
+- whenever
+- wheneverize
+extensions: []
+
+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
+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_at_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
+has_rdoc: true
+homepage: http://github.com/javan/whenever
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --line-numbers
+- --inline-source
+- --title
+- Whenever
+- --main
+- README.rdoc
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "1.2"
+  version: 
+requirements: []
+
+rubyforge_project: whenever
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Provides clean ruby syntax for defining messy cron jobs and running them Whenever.
+test_files: 
+- test/command_line_test.rb
+- test/cron_test.rb
+- test/output_at_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