javan-whenever 0.1.0 → 0.1.1

data/CHANGELOG.rdoc

@@ -0,0 +1,10 @@
+== 0.1.1 / February 16th, 2009
+
+* Added 'rake' helper for defining scheduled rake tasks. [Javan Makhmali]
+
+* Renamed :cron_environment and :cron_path to :enviroment and :path for better (word) compatibility with rake tasks. [Javan Makhmali]
+
+
+== 0.1.0 / February 15th, 2009
+
+* Initial release [Javan Makhmali]

data/README.rdoc

@@ -1,9 +1,11 @@
-= Whenever
+== Introduction
 
-Whenever is a ruby gem that provides a ruby syntax for defining cron jobs. It was designed to work well with Rails applications, but can be used independently as well.
+Whenever is a ruby gem that provides a ruby syntax for defining cron jobs. It is designed to work well with Rails applications, but can be used independently as well.
 
 == Installation
 
+NOTE: Requiring the whenever gem inside your Rails application is technically optional. However, if you plan to use something like Capistrano to automatically deploy and write your crontab file, you'll need to have the gem installed on your servers, and requiring it in your app is one to ensure this. If you plan to manually install the gem on your servers or you don't care about Rails, deploying, etc., you can skip the next step.
+
 To install Whenever in a Rails (2.1 or greater) application:
   
 in your "config/environment.rb" file:
@@ -16,8 +18,8 @@ To install this gem (and all other missing gem dependencies), run rake gems:inst
 
 In older versions of Rails:
 
-$ gem sources -a http://gems.github.com
-$ gem install whenever
+  $ gem sources -a http://gems.github.com
+  $ gem install javan-whenever
 
 in your "config/environment.rb" file:
 
@@ -29,20 +31,20 @@ in your "config/environment.rb" file:
   
 == 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
 
-  set :runner_path, '/var/www/apps/my_app' # Whenever will try to use your RAILS_ROOT if this isn't set
-  set :runner_environment, :production # Whenever defaults to production so only set this if you want to use a different environment.
-  set :cron_log, '/path/to/my/cronlog.log' # Where to log (this should NOT be your Rails log)
-
+  set :path, '/var/www/apps/my_app' # Whenever will try to use your RAILS_ROOT if this isn't set
+  set :environment, :production     # Whenever defaults to production so you only need to set this for something different
+  set :cron_log, '/my/cronlog.log'  # Where to log (this should NOT be your Rails log)
 
   every 2.hours do
     runner "MyModel.some_process" # runners are the script/runners you know and love
+    rake "my:rake:task" # conveniently run rake tasks
     command "/usr/local/bin/my_great_command" # commands are any unix command
   end
 
@@ -60,18 +62,23 @@ This will create an initial "config/schedule.rb" file you.
   
 == Cron output
 
-$ cd /my/rails/app
-$ whenever
+  $ cd /my/rails/app
+  $ whenever
 
 And you'll see your schedule.rb converted to cron sytax
 
 == Capistrano integration
 
-Use the "whenever:write_cron" task to automatically write your crontab file with each deploy.
-
 in your "config/deploy.rb" file do something like:
 
-  after "deploy:symlink", "whenever:write_cron"
+  after "deploy:symlink", "deploy:write_crontab"
+
+  namespace :deploy do
+    desc "write the crontab file"
+    task :write_crontab, :roles => :app do
+      run "cd #{release_path} && whenever -c"
+    end
+  end
   
 THIS WILL COMPLETELY OVERWRITE ANY EXISTING CRONTAB ENTRIES!
 ------------------------------------------------------------

data/lib/base.rb

@@ -1,12 +1,15 @@
-require 'job_list'
-require 'job_types/default'
-require 'job_types/runner'
-require 'outputs/cron'
-
 module Whenever
-  VERSION = '0.1.0'
+  VERSION = '0.1.1'
   
   def self.cron(options)
     Whenever::JobList.new(options).generate_cron_output
   end
+  
+  def self.path
+    if defined?(RAILS_ROOT)
+      RAILS_ROOT 
+    elsif defined?(::RAILS_ROOT)
+      ::RAILS_ROOT
+    end
+  end
 end

data/lib/job_list.rb

@@ -41,10 +41,16 @@ module Whenever
     end
     
     def runner(task, options = {})
-      options.reverse_merge!(:environment => @runner_environment, :path => @runner_path)
+      options.reverse_merge!(:environment => @environment, :path => @path)
       options[:class] = Whenever::Job::Runner
       command(task, options)
     end
+    
+    def rake(task, options = {})
+      options.reverse_merge!(:environment => @environment, :path => @path)
+      options[:class] = Whenever::Job::RakeTask
+      command(task, options)
+    end
   
     def generate_cron_output
       [environment_variables, cron_jobs].compact.join

data/lib/job_types/default.rb

@@ -1,17 +1,27 @@
 module Whenever
   module Job
     class Default
+      
       attr_accessor :task, :at, :cron_log
     
       def initialize(options = {})
-        @task     = options[:task]
-        @at       = options[:at]
-        @cron_log = options[:cron_log]
+        @task        = options[:task]
+        @at          = options[:at]
+        @cron_log    = options[:cron_log]
+        @environment = options[:environment] || :production
+        @path        = options[:path] || Whenever.path
       end
     
       def output
         task
       end
+      
+    protected
+      
+      def path_required
+        raise ArgumentError, "No path available; set :path, '/your/path' in your schedule file" if @path.blank?
+      end
+      
     end
   end
 end

data/lib/job_types/rake_task.rb

@@ -0,0 +1,12 @@
+module Whenever
+  module Job
+    class RakeTask < Whenever::Job::Default
+      
+      def output
+        path_required
+        "cd #{@path} && RAILS_ENV=#{@environment} /usr/bin/env rake #{task}"
+      end
+      
+    end
+  end
+end

data/lib/job_types/runner.rb

@@ -1,30 +1,12 @@
 module Whenever
   module Job
     class Runner < Whenever::Job::Default
-      
-      def initialize(options = {})
-        super(options)
-        
-        @environment = options[:environment] || :production
-        
-        if [Whenever::Job::Runner.rails_root, options[:path]].all?(&:blank?)
-          raise ArgumentError, "no cron_path available for runner to use"
-        else
-          @path = options[:path] || Whenever::Job::Runner.rails_root
-        end
-      end
-      
-      def self.rails_root
-        if defined?(RAILS_ROOT)
-          RAILS_ROOT 
-        elsif defined?(::RAILS_ROOT)
-          ::RAILS_ROOT
-        end
-      end
 
       def output
+        path_required
         %Q(#{File.join(@path, 'script', 'runner')} -e #{@environment} "#{task}")
       end
+      
     end
   end
 end

data/lib/whenever.rb

@@ -22,3 +22,8 @@ require 'activesupport'
 require 'chronic'
 
 require 'base'
+require 'job_list'
+require 'job_types/default'
+require 'job_types/rake_task'
+require 'job_types/runner'
+require 'outputs/cron'

data/test/output_command_test.rb

@@ -4,7 +4,7 @@ class OutputCommandTest < Test::Unit::TestCase
   
   context "A plain command" do
     setup do
-      @output = load_whenever_output \
+      @output = Whenever.cron \
       <<-file
         every 2.hours do
           command "blahblah"
@@ -19,7 +19,7 @@ class OutputCommandTest < Test::Unit::TestCase
   
   context "A command when the cron_log is set" do
     setup do
-      @output = load_whenever_output \
+      @output = Whenever.cron \
       <<-file
         set :cron_log, 'logfile.log'
         every 2.hours do
@@ -35,7 +35,7 @@ class OutputCommandTest < Test::Unit::TestCase
   
   context "A command when the cron_log is set and the comand overrides it" do
     setup do
-      @output = load_whenever_output \
+      @output = Whenever.cron \
       <<-file
         set :cron_log, 'logfile.log'
         every 2.hours do
@@ -52,7 +52,7 @@ class OutputCommandTest < Test::Unit::TestCase
   
   context "A command when the cron_log is set and the comand rejects it" do
     setup do
-      @output = load_whenever_output \
+      @output = Whenever.cron \
       <<-file
         set :cron_log, 'logfile.log'
         every 2.hours do

data/test/output_env_test.rb

@@ -4,7 +4,7 @@ class OutputEnvTest < Test::Unit::TestCase
 
   context "The output from Whenever with environment variables set" do
     setup do
-      @output = load_whenever_output \
+      @output = Whenever.cron \
       <<-file
         env :MYVAR, 'blah'
         env 'MAILTO', "someone@example.com"

data/test/output_rake_test.rb

@@ -0,0 +1,74 @@
+require '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

@@ -2,11 +2,11 @@ require 'test_helper'
 
 class OutputRunnerTest < Test::Unit::TestCase
   
-  context "A runner with runner_path set" do
+  context "A runner with path set" do
     setup do
-      @output = load_whenever_output \
+      @output = Whenever.cron \
       <<-file
-        set :runner_path, '/my/path'
+        set :path, '/my/path'
         every 2.hours do
           runner "blahblah"
         end
@@ -18,11 +18,27 @@ class OutputRunnerTest < Test::Unit::TestCase
     end
   end
   
-  context "A runner with no runner_path set and RAILS_ROOT defined" do
+  context "A runner that overrides the path set" do
     setup do
-      Whenever::Job::Runner.stubs(:rails_root).returns('/my/path')
+      @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 = load_whenever_output \
+      @output = Whenever.cron \
       <<-file
         every 2.hours do
           runner "blahblah"
@@ -35,28 +51,28 @@ class OutputRunnerTest < Test::Unit::TestCase
     end
   end
   
-  context "A runner with runner_path set AND RAILS_ROOT defined" do
+  context "A runner with path set AND RAILS_ROOT defined" do
     setup do
-      Whenever::Job::Runner.stubs(:rails_root).returns('/my/path')
+      Whenever.stubs(:path).returns('/my/rails/path')
       
-      @output = load_whenever_output \
+      @output = Whenever.cron \
       <<-file
-        set :runner_path, '/my/path'
+        set :path, '/my/path'
         every 2.hours do
           runner "blahblah"
         end
       file
     end
     
-    should "use the runner_path" do
+    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 runner_path set and no RAILS_ROOT defined" do
+  context "A runner with no path set and no RAILS_ROOT defined" do
     setup do
-      Whenever::Job::Runner.stubs(:rails_root).returns(nil)
+      Whenever.stubs(:path).returns(nil)
       
       @input = <<-file
         every 2.hours do
@@ -67,9 +83,43 @@ class OutputRunnerTest < Test::Unit::TestCase
     
     should "raise an exception" do
       assert_raises ArgumentError do
-        load_whenever_output(@input)
+        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
+  
 end

data/test/test_helper.rb

@@ -21,13 +21,10 @@ require 'whenever'
 
 module TestExtensions
   
-  def load_whenever_output(input) 
-    Whenever.cron(input)
-  end
-  
   def two_hours
     "0 0,2,4,6,8,10,12,14,16,18,20,22 * * *"
   end
+  
 end
 
 class Test::Unit::TestCase

data/whenever.gemspec

@@ -2,16 +2,16 @@
 
 Gem::Specification.new do |s|
   s.name = %q{whenever}
-  s.version = "0.1.0"
+  s.version = "0.1.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
   s.authors = ["Javan Makhmali"]
-  s.date = %q{2009-02-15}
+  s.date = %q{2009-02-16}
   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", "lib/base.rb", "lib/job_list.rb", "lib/job_types/default.rb", "lib/job_types/runner.rb", "lib/outputs/cron.rb", "lib/tasks/whenever.rake", "lib/whenever.rb", "README.rdoc"]
-  s.files = ["bin/whenever", "bin/wheneverize", "lib/base.rb", "lib/job_list.rb", "lib/job_types/default.rb", "lib/job_types/runner.rb", "lib/outputs/cron.rb", "lib/tasks/whenever.rake", "lib/whenever.rb", "Manifest", "Rakefile", "README.rdoc", "test/cron_test.rb", "test/output_command_test.rb", "test/output_env_test.rb", "test/output_runner_test.rb", "test/test_helper.rb", "whenever.gemspec"]
+  s.extra_rdoc_files = ["bin/whenever", "bin/wheneverize", "CHANGELOG.rdoc", "lib/base.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/tasks/whenever.rake", "lib/whenever.rb", "README.rdoc"]
+  s.files = ["bin/whenever", "bin/wheneverize", "CHANGELOG.rdoc", "lib/base.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/tasks/whenever.rake", "lib/whenever.rb", "Manifest", "Rakefile", "README.rdoc", "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.has_rdoc = true
   s.homepage = %q{http://github.com/javan/whenever}
   s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Whenever", "--main", "README.rdoc"]
@@ -19,7 +19,7 @@ Gem::Specification.new do |s|
   s.rubyforge_project = %q{whenever}
   s.rubygems_version = %q{1.3.1}
   s.summary = %q{Provides (clean) ruby syntax for defining (messy) cron jobs and running them Whenever.}
-  s.test_files = ["test/cron_test.rb", "test/output_command_test.rb", "test/output_env_test.rb", "test/output_runner_test.rb", "test/test_helper.rb"]
+  s.test_files = ["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"]
 
   if s.respond_to? :specification_version then
     current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: javan-whenever
 version: !ruby/object:Gem::Version 
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors: 
 - Javan Makhmali
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-02-15 00:00:00 -08:00
+date: 2009-02-16 00:00:00 -08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -42,9 +42,11 @@ extensions: []
 extra_rdoc_files: 
 - bin/whenever
 - bin/wheneverize
+- CHANGELOG.rdoc
 - lib/base.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/tasks/whenever.rake
@@ -53,9 +55,11 @@ extra_rdoc_files:
 files: 
 - bin/whenever
 - bin/wheneverize
+- CHANGELOG.rdoc
 - lib/base.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/tasks/whenever.rake
@@ -66,6 +70,7 @@ files:
 - 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
@@ -104,5 +109,6 @@ test_files:
 - 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