whenever 0.4.2 → 0.5.0

data/CHANGELOG.rdoc

@@ -1,3 +1,12 @@
+== 0.5.0 / June 28th, 2010
+
+* New job_type API for writing custom jobs. Internals use this to define command, runner, and rake. [Javan Makhmali - inspired by idlefingers (Damien)]
+
+* Jobs < 1.hour can specify an :at. [gorenje]
+
+* --clear option to remove crontab entries for a specific [identifier]. [mraidel (Michael Raidel)]
+
+
 == 0.4.2 / April 26th, 2010
 
 * runners now cd into the app's directory and then execute. [Michael Guterl]

data/README.rdoc

@@ -39,6 +39,28 @@ This will create an initial "config/schedule.rb" file you.
 
 More examples on the wiki: http://wiki.github.com/javan/whenever/instructions-and-examples
 
+== Define your own job types
+
+Whenever ships with three pre-defined job types: command, runner, and rake. You can define your own with <code>job_type</code>.
+
+For example:
+
+  job_type :awesome, '/usr/local/bin/awesome :task :fun_level'
+  
+  every 2.hours do
+    awesome "party", :fun_level => "extreme"
+  end
+  
+Would run <code>/usr/local/bin/awesome party extreme</code> every two hours. <code>:task</code> is always replaced with the first argument, and any additional <code>:whatevers</code> are replaced with the options passed in or by variables that have been defined with <code>set</code>.
+
+The default job types that ship with Whenever are defined like so:
+
+  job_type :command, ':task'
+  job_type :runner,  'cd :path && script/runner -e :environment ":task"'
+  job_type :rake,    'cd :path && RAILS_ENV=:environment /usr/bin/env rake :task'
+
+If a <code>:path</code> is not set it will default to the directory in which <code>whenever</code> was executed. <code>:environment</code> will default to 'production'.
+
 == Cron output
 
   $ cd /my/rails/app

data/bin/whenever

@@ -14,6 +14,10 @@ OptionParser.new do |opts|
     options[:update] = true
     options[:identifier] = identifier if identifier
   end
+  opts.on('-c', '--clear-crontab [identifier]') do |identifier|
+    options[:clear] = true
+    options[:identifier] = identifier if identifier
+  end
   opts.on('-f', '--load-file [schedule file]', 'Default: config/schedule.rb') do |file|
     options[:file] = file if file
   end

data/lib/whenever.rb

@@ -1,14 +1,5 @@
 require 'chronic'
 
-# Hoping to load Rails' Rakefile
-begin
-  load 'Rakefile'
-rescue LoadError
-  nil
-end
-
-# If Rails' rakefile was loaded than so was active_support, but
-# if this is being used in a non-rails enviroment we need to require it.
 # It was previously defined as a dependency of this gem, but that became
 # problematic. See: http://github.com/javan/whenever/issues#issue/1
 begin
@@ -22,9 +13,7 @@ end
 # Whenever files
 require 'whenever/base'
 require 'whenever/job_list'
-require 'whenever/job_types/default'
-require 'whenever/job_types/rake_task'
-require 'whenever/job_types/runner'
+require 'whenever/job'
 require 'whenever/outputs/cron'
 require 'whenever/outputs/cron/output_redirection'
 require 'whenever/command_line'

data/lib/whenever/base.rb

@@ -5,11 +5,7 @@ module Whenever
   end
   
   def self.path
-    if defined?(RAILS_ROOT)
-      RAILS_ROOT 
-    elsif defined?(::RAILS_ROOT)
-      ::RAILS_ROOT
-    end
+    Dir.pwd
   end
 
 end

data/lib/whenever/command_line.rb

@@ -19,14 +19,14 @@ module Whenever
         exit(1)
       end
 
-      if @options[:update] && @options[:write]
-        warn("[fail] Can't update AND write. choose one.")
+      if [@options[:update], @options[:write], @options[:clear]].compact.length > 1
+        warn("[fail] Can only update, write or clear. Choose one.")
         exit(1)
       end
     end
     
     def run
-      if @options[:update]
+      if @options[:update] || @options[:clear]
         write_crontab(updated_crontab)
       elsif @options[:write]
         write_crontab(whenever_cron)
@@ -43,7 +43,7 @@ module Whenever
     end
   
     def whenever_cron
-      @whenever_cron ||= [comment_open, Whenever.cron(@options), comment_close].join("\n") + "\n"
+      @whenever_cron ||= [comment_open, (Whenever.cron(@options) unless @options[:clear]), comment_close].compact.join("\n") + "\n"
     end
     
     def read_crontab

data/lib/whenever/job.rb

@@ -0,0 +1,22 @@
+module Whenever
+  class Job
+    
+    attr_accessor :at, :output_redirection
+  
+    def initialize(options = {})
+      @options = options
+      
+      @at                      = options[:at]
+      @output_redirection      = options.has_key?(:output) ? options[:output] : :not_set
+      @options[:environment] ||= :production
+      @options[:path]        ||= Whenever.path
+    end
+  
+    def output
+      @options[:template].gsub(/:\w+/) do |key|
+        @options[key.sub(':', '').to_sym]
+      end
+    end
+    
+  end
+end

data/lib/whenever/job_list.rb

@@ -2,8 +2,7 @@ module Whenever
   class JobList
   
     def initialize(options)
-      @jobs = Hash.new
-      @env  = Hash.new
+      @jobs, @env, @set_variables = {}, {}, {}
       
       case options
         when String
@@ -16,7 +15,12 @@ module Whenever
           end
           pre_set(options[:set])
       end
-
+      
+      # Load all job type files.
+      Dir["#{File.expand_path(File.dirname(__FILE__))}/job_types/*.rb"].each do |file|
+        eval(File.read(file))
+      end
+      
       eval(config)
     end
     
@@ -25,6 +29,7 @@ module Whenever
       
       instance_variable_set("@#{variable}".to_sym, value)
       self.class.send(:attr_reader, variable.to_sym)
+      @set_variables[variable] = value
     end
     
     def env(variable, value)
@@ -37,26 +42,21 @@ module Whenever
       yield
     end
     
-    def command(task, options = {})
-      # :cron_log was an old option for output redirection, it remains for backwards compatibility
-      options[:output] = (options[:cron_log] || @cron_log) if defined?(@cron_log) || options.has_key?(:cron_log)
-      # :output is the newer, more flexible option.
-      options[:output] = @output if defined?(@output) && !options.has_key?(:output)
-      options[:class] ||= Whenever::Job::Default
-      @jobs[@current_time_scope] ||= []
-      @jobs[@current_time_scope] << options[:class].new(@options.merge(:task => task).merge(options))
-    end
-    
-    def runner(task, options = {})
-      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)
+    def job_type(name, template)
+      class_eval do
+        define_method(name) do |task, *args|
+          options = { :task => task, :template => template }
+          options.merge!(args[0]) if args[0].is_a? Hash
+          
+          # :cron_log was an old option for output redirection, it remains for backwards compatibility
+          options[:output] = (options[:cron_log] || @cron_log) if defined?(@cron_log) || options.has_key?(:cron_log)
+          # :output is the newer, more flexible option.
+          options[:output] = @output if defined?(@output) && !options.has_key?(:output)
+          
+          @jobs[@current_time_scope] ||= []
+          @jobs[@current_time_scope] << Whenever::Job.new(@options.merge(@set_variables).merge(options))
+        end
+      end
     end
   
     def generate_cron_output
@@ -79,7 +79,7 @@ module Whenever
       pairs.each do |pair|
         next unless pair.index('=')
         variable, value = *pair.split('=')
-        set(variable.strip, value.strip) unless variable.blank? || value.blank?
+        set(variable.strip.to_sym, value.strip) unless variable.blank? || value.blank?
       end
     end
     

data/lib/whenever/job_types/default.rb

@@ -1,27 +1,3 @@
-module Whenever
-  module Job
-    class Default
-      
-      attr_accessor :task, :at, :output, :output_redirection
-    
-      def initialize(options = {})
-        @task               = options[:task]
-        @at                 = options[:at]
-        @output_redirection = options.has_key?(:output) ? options[:output] : :not_set
-        @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
+job_type :command, ':task'
+job_type :runner,  'cd :path && script/runner -e :environment ":task"'
+job_type :rake,    'cd :path && RAILS_ENV=:environment /usr/bin/env rake :task'

data/lib/whenever/outputs/cron.rb

@@ -77,7 +77,7 @@ module Whenever
             raise ArgumentError, "Time must be in minutes or higher"
           when 1.minute...1.hour
             minute_frequency = @time / 60
-            timing[0] = comma_separated_timing(minute_frequency, 59)
+            timing[0] = comma_separated_timing(minute_frequency, 59, @at || 0)
           when 1.hour...1.day
             hour_frequency = (@time / 60 / 60).round
             timing[0] = @at.is_a?(Time) ? @at.min : @at

data/lib/whenever/version.rb

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

data/test/command_line_test.rb

@@ -74,6 +74,63 @@ EXISTING_CRON
 #{@task}
 # 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
+  end
+
+  context "A command line delete" 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
+      existing = <<-EXISTING_CRON
+# Something
+
+# Begin Whenever generated tasks for: My identifier
+My whenever job that was already here
+# 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
+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
@@ -97,5 +154,24 @@ NEW_CRON
       assert_equal "Whenever generated tasks for: DEFAULT", @command.send(:comment_base)
     end
   end
-  
-end
+
+  context "combined params" do
+    setup do
+      Whenever::CommandLine.any_instance.expects(:exit)
+      Whenever::CommandLine.any_instance.expects(:warn)
+      File.expects(:exists?).with('config/schedule.rb').returns(true)
+    end
+
+    should "exit with write and clear" do
+      @command = Whenever::CommandLine.new(:write => true, :clear => true)
+    end
+    
+    should "exit with write and update" do
+      @command = Whenever::CommandLine.new(:write => true, :update => true)
+    end
+
+    should "exit with update and clear" do
+      @command = Whenever::CommandLine.new(:update => true, :clear => true)
+    end
+  end
+end

data/test/output_at_test.rb

@@ -175,4 +175,63 @@ class OutputAtTest < Test::Unit::TestCase
     end
   end
   
+  context "every 5 minutes but but starting at 1" do
+    setup do
+      @output = Whenever.cron \
+      <<-file
+        every 5.minutes, :at => 1 do
+          command "blahblah"
+        end
+      file
+    end
+    
+    should "output the command using that time" do
+      assert_match '1,6,11,16,21,26,31,36,41,46,51,56 * * * * blahblah', @output
+    end
+  end
+
+  context "every 4 minutes but starting at 2" do
+    setup do
+      @output = Whenever.cron \
+      <<-file
+        every 4.minutes, :at => 2 do
+          command "blahblah"
+        end
+      file
+    end
+    
+    should "output the command using that time" do
+      assert_match '2,6,10,14,18,22,26,30,34,38,42,46,50,54,58 * * * * blahblah', @output
+    end
+  end
+
+  context "every 3 minutes but starting at 7" do
+    setup do
+      @output = Whenever.cron \
+      <<-file
+        every 3.minutes, :at => 7 do
+          command "blahblah"
+        end
+      file
+    end
+    
+    should "output the command using that time" do
+      assert_match '7,10,13,16,19,22,25,28,31,34,37,40,43,46,49,52,55,58 * * * * blahblah', @output
+    end
+  end
+
+  context "every 2 minutes but starting at 27" do
+    setup do
+      @output = Whenever.cron \
+      <<-file
+        every 2.minutes, :at => 27 do
+          command "blahblah"
+        end
+      file
+    end
+    
+    should "output the command using that time" do
+      assert_match '27,29,31,33,35,37,39,41,43,45,47,49,51,53,55,57,59 * * * * blahblah', @output
+    end
+  end
 end

data/test/output_defined_job_test.rb

@@ -0,0 +1,87 @@
+require File.expand_path(File.dirname(__FILE__) + "/test_helper")
+
+class OutputDefinedJobTest < Test::Unit::TestCase
+  
+  context "A defined job with a :task" do
+    setup do
+      @output = Whenever.cron \
+      <<-file
+        job_type :some_job, "before :task after"
+        every 2.hours do
+          some_job "during"
+        end
+      file
+    end
+    
+    should "output the defined job with the task" do
+      assert_match /^.+ .+ .+ .+ before during after$/, @output
+    end
+  end
+  
+  context "A defined job with a :task and some options" do
+    setup do
+      @output = Whenever.cron \
+      <<-file
+        job_type :some_job, "before :task after :option1 :option2"
+        every 2.hours do
+          some_job "during", :option1 => 'happy', :option2 => 'birthday'
+        end
+      file
+    end
+    
+    should "output the defined job with the task and options" do
+      assert_match /^.+ .+ .+ .+ before during after happy birthday$/, @output
+    end
+  end
+  
+  context "A defined job with a :task and an option where the option is set globally" do
+    setup do
+      @output = Whenever.cron \
+      <<-file
+        job_type :some_job, "before :task after :option1"
+        set :option1, 'happy'
+        every 2.hours do
+          some_job "during"
+        end
+      file
+    end
+    
+    should "output the defined job with the task and options" do
+      assert_match /^.+ .+ .+ .+ before during after happy$/, @output
+    end
+  end
+  
+  context "A defined job with a :task and an option where the option is set globally and locally" do
+    setup do
+      @output = Whenever.cron \
+      <<-file
+        job_type :some_job, "before :task after :option1"
+        set :option1, 'global'
+        every 2.hours do
+          some_job "during", :option1 => 'local'
+        end
+      file
+    end
+    
+    should "output the defined job using the local option" do
+      assert_match /^.+ .+ .+ .+ before during after local$/, @output
+    end
+  end
+  
+  context "A defined job with a :task and an option that is not set" do
+    setup do
+      @output = Whenever.cron \
+      <<-file
+        job_type :some_job, "before :task after :option1"
+        every 2.hours do
+          some_job "during", :option2 => 'happy'
+        end
+      file
+    end
+    
+    should "output the defined job with that option removed" do
+      assert_match /^.+ .+ .+ .+ before during after$/, @output
+    end
+  end
+  
+end

data/test/output_runner_test.rb

@@ -70,24 +70,6 @@ class OutputRunnerTest < Test::Unit::TestCase
     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 \
@@ -190,20 +172,4 @@ class OutputRunnerTest < Test::Unit::TestCase
     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 + ' cd /my/path && script/runner -e production "Product.import(\"http://example.com/product.xml\")"', @output
-    end
-  end
-  
 end

data/whenever.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{whenever}
-  s.version = "0.4.2"
+  s.version = "0.5.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Javan Makhmali"]
-  s.date = %q{2010-04-26}
+  s.date = %q{2010-06-28}
   s.description = %q{Clean ruby syntax for defining and deploying messy cron jobs.}
   s.email = %q{javan@javan.us}
   s.executables = ["whenever", "wheneverize"]
@@ -26,10 +26,9 @@ Gem::Specification.new do |s|
      "lib/whenever.rb",
      "lib/whenever/base.rb",
      "lib/whenever/command_line.rb",
+     "lib/whenever/job.rb",
      "lib/whenever/job_list.rb",
      "lib/whenever/job_types/default.rb",
-     "lib/whenever/job_types/rake_task.rb",
-     "lib/whenever/job_types/runner.rb",
      "lib/whenever/outputs/cron.rb",
      "lib/whenever/outputs/cron/output_redirection.rb",
      "lib/whenever/version.rb",
@@ -37,6 +36,7 @@ Gem::Specification.new do |s|
      "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",
@@ -54,6 +54,7 @@ Gem::Specification.new do |s|
      "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",

metadata

@@ -4,9 +4,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 0
-  - 4
-  - 2
-  version: 0.4.2
+  - 5
+  - 0
+  version: 0.5.0
 platform: ruby
 authors: 
 - Javan Makhmali
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-04-26 00:00:00 -04:00
+date: 2010-06-28 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -50,10 +50,9 @@ files:
 - lib/whenever.rb
 - lib/whenever/base.rb
 - lib/whenever/command_line.rb
+- lib/whenever/job.rb
 - lib/whenever/job_list.rb
 - lib/whenever/job_types/default.rb
-- lib/whenever/job_types/rake_task.rb
-- lib/whenever/job_types/runner.rb
 - lib/whenever/outputs/cron.rb
 - lib/whenever/outputs/cron/output_redirection.rb
 - lib/whenever/version.rb
@@ -61,6 +60,7 @@ files:
 - 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
@@ -102,6 +102,7 @@ test_files:
 - 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

data/lib/whenever/job_types/rake_task.rb

@@ -1,12 +0,0 @@
-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/whenever/job_types/runner.rb

@@ -1,12 +0,0 @@
-module Whenever
-  module Job
-    class Runner < Whenever::Job::Default
-
-      def output
-        path_required
-        %Q(cd #{File.join(@path)} && script/runner -e #{@environment} #{task.inspect})
-      end
-      
-    end
-  end
-end