javan-whenever 0.3.1 → 0.3.7

data/CHANGELOG.rdoc

@@ -1,3 +1,19 @@
+== 0.3.7 / September 4th, 2009
+
+* No longer tries (and fails) to combine @shortcut jobs. #20 [Javan Makhmali]
+
+
+== 0.3.6 / June 15th, 2009
+
+* Setting a PATH in the crontab automatically based on the user's PATH. [Javan Makhmali]
+
+
+== 0.3.5 / June 13th, 2009
+
+* Added ability to accept lists of every's and at's and intelligently group them. (ex: every 'monday, wednesday', :at => ['3pm', '6am']). [Sam Ruby]
+
+* Fixed issue with new lines. #18 [Javan Makhmali]
+
 == 0.3.1 / June 25th, 2009
 
 * Removed activesupport gem dependency. #1 [Javan Makhmali]

data/Manifest

@@ -15,6 +15,7 @@ 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

data/lib/command_line.rb

@@ -40,7 +40,7 @@ module Whenever
     end
   
     def whenever_cron
-      @whenever_cron ||= [comment_open, Whenever.cron(@options), comment_close].join("\n")
+      @whenever_cron ||= [comment_open, Whenever.cron(@options), comment_close].join("\n") + "\n"
     end
     
     def read_crontab
@@ -86,7 +86,7 @@ module Whenever
       
       # If an existing identier block is found, replace it with the new cron entries
       if read_crontab.index(comment_open) && read_crontab.index(comment_close)
-        read_crontab.gsub(Regexp.new("#{comment_open}.+#{comment_close}", Regexp::MULTILINE), whenever_cron)
+        read_crontab.gsub(Regexp.new("#{comment_open}.+#{comment_close}", Regexp::MULTILINE), whenever_cron.chomp)
       else # Otherwise, append the new cron entries after any existing ones
         [read_crontab, whenever_cron].join("\n\n")
       end

data/lib/job_list.rb

@@ -57,14 +57,18 @@ module Whenever
     end
   
     def generate_cron_output
+      set_path_environment_variable
+      
       [environment_variables, cron_jobs].compact.join
     end
     
   private
     
+    #
     # Takes a string like: "variable1=something&variable2=somethingelse"
     # and breaks it into variable/value pairs. Used for setting variables at runtime from the command line.
     # Only works for setting values as strings.
+    #
     def pre_set(variable_string = nil)
       return if variable_string.blank?
       
@@ -75,6 +79,19 @@ module Whenever
         set(variable.strip, value.strip) unless variable.blank? || value.blank?
       end
     end
+    
+    def set_path_environment_variable
+      return if path_should_not_be_set_automatically?
+      @env[:PATH] = read_path unless read_path.blank?
+    end
+    
+    def read_path
+      ENV['PATH'] if ENV
+    end
+    
+    def path_should_not_be_set_automatically?
+      @set_path_automatically === false || @env[:PATH] || @env["PATH"]
+    end
   
     def environment_variables
       return if @env.empty?
@@ -88,21 +105,55 @@ module Whenever
       output.join
     end
     
+    #
+    # Takes the standard cron output that Whenever generates and finds
+    # similar entries that can be combined. For example: If a job should run
+    # at 3:02am and 4:02am, instead of creating two jobs this method combines
+    # them into one that runs on the 2nd minute at the 3rd and 4th hour.
+    #
+    def combine(entries)
+      entries.map! { |entry| entry.split(/ +/, 6) }
+      0.upto(4) do |f|
+        (entries.length-1).downto(1) do |i|
+          next if entries[i][f] == '*'
+          comparison = entries[i][0...f] + entries[i][f+1..-1]
+          (i-1).downto(0) do |j|
+            next if entries[j][f] == '*'
+            if comparison == entries[j][0...f] + entries[j][f+1..-1]
+              entries[j][f] += ',' + entries[i][f]
+              entries.delete_at(i)
+              break
+            end
+          end
+        end
+      end
+
+      entries.map { |entry| entry.join(' ') }
+    end
+
     def cron_jobs
       return if @jobs.empty?
       
-      output = []
+      shortcut_jobs = []
+      regular_jobs = []
+      
       @jobs.each do |time, jobs|
         jobs.each do |job|
-          cron = Whenever::Output::Cron.output(time, job)
-          cron << " >> #{job.cron_log} 2>&1" if job.cron_log 
-          cron << "\n\n"
-          output << cron
+          Whenever::Output::Cron.output(time, job) do |cron|
+            cron << " >> #{job.cron_log} 2>&1" if job.cron_log 
+            cron << "\n\n"
+            
+            if cron.starts_with?("@")
+              shortcut_jobs << cron
+            else
+              regular_jobs << cron
+            end
+          end
         end
       end
-      
-      output.join
+
+      shortcut_jobs.join + combine(regular_jobs).join
     end
     
   end
-end
+end

data/lib/job_types/runner.rb

@@ -4,7 +4,7 @@ module Whenever
 
       def output
         path_required
-        %Q(#{File.join(@path, 'script', 'runner')} -e #{@environment} "#{task}")
+        %Q(#{File.join(@path, 'script', 'runner')} -e #{@environment} #{task.inspect})
       end
       
     end

data/lib/outputs/cron.rb

@@ -11,9 +11,23 @@ module Whenever
         @at   = at.is_a?(String) ? (Chronic.parse(at) || 0) : (at || 0)
       end
 
-      def self.output(time, job)
-        out = new(time, job.output, job.at)
-        "#{out.time_in_cron_syntax} #{out.task}"
+      def self.enumerate(item)
+        if item and item.is_a?(String)
+          items = item.split(',')
+        else
+          items = item
+          items = [items] unless items and items.respond_to?(:each)
+        end
+        items
+      end
+
+      def self.output(times, job)
+        enumerate(times).each do |time|
+          enumerate(job.at).each do |at|
+            out = new(time, job.output, at)
+            yield "#{out.time_in_cron_syntax} #{out.task}"
+          end
+        end
       end
 
       def time_in_cron_syntax
@@ -114,4 +128,4 @@ module Whenever
     end
 
   end
-end
+end

data/lib/version.rb

@@ -2,7 +2,7 @@ module Whenever
   module VERSION #:nodoc:
     MAJOR = 0
     MINOR = 3
-    TINY  = 1
+    TINY  = 7
 
     STRING = [MAJOR, MINOR, TINY].join('.')
   end

data/test/command_line_test.rb

@@ -11,13 +11,13 @@ class CommandLineTest < Test::Unit::TestCase
     end
 
     should "output the cron job with identifier blocks" do
-      output = <<-expected
-      # Begin Whenever generated tasks for: My identifier
-      #{@task}
-      # End Whenever generated tasks for: My identifier
-      expected
+      output = <<-EXPECTED
+# Begin Whenever generated tasks for: My identifier
+#{@task}
+# End Whenever generated tasks for: My identifier
+EXPECTED
       
-      assert_equal unindent(output).chomp, @command.send(:whenever_cron).chomp
+      assert_equal output, @command.send(:whenever_cron)
     end
     
     should "write the crontab when run" do
@@ -38,49 +38,50 @@ class CommandLineTest < Test::Unit::TestCase
       existing = '# Existing crontab'
       @command.expects(:read_crontab).at_least_once.returns(existing)
       
-      new_cron = <<-expected
-      #{existing}
-      
-      # Begin Whenever generated tasks for: My identifier
-      #{@task}
-      # End Whenever generated tasks for: My identifier
-      expected
+      new_cron = <<-EXPECTED
+#{existing}
+
+# Begin Whenever generated tasks for: My identifier
+#{@task}
+# End Whenever generated tasks for: My identifier
+EXPECTED
       
-      assert_equal unindent(new_cron).chomp, @command.send(:updated_crontab).chomp
+      assert_equal new_cron, @command.send(:updated_crontab)
       
-      @command.expects(:write_crontab).with(unindent(new_cron)).returns(true)
+      @command.expects(:write_crontab).with(new_cron).returns(true)
       assert @command.run
     end
     
     should "replace an existing block if the identifier matches" do
-      existing = <<-existing
-      # 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
-      @command.expects(:read_crontab).at_least_once.returns(unindent(existing))
-      
-      new_cron = <<-new_cron
-      # Something
-      
-      # Begin Whenever generated tasks for: My identifier
-      #{@task}
-      # End Whenever generated tasks for: My identifier
+      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)
       
-      # Begin Whenever generated tasks for: Other identifier
-      This shouldn't get replaced
-      # End Whenever generated tasks for: Other identifier
-      new_cron
+      new_cron = <<-NEW_CRON
+# Something
+
+# Begin Whenever generated tasks for: My identifier
+#{@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 unindent(new_cron).chomp, @command.send(:updated_crontab).chomp
+      assert_equal new_cron, @command.send(:updated_crontab)
       
-      @command.expects(:write_crontab).with(unindent(new_cron)).returns(true)
+      @command.expects(:write_crontab).with(new_cron).returns(true)
       assert @command.run
     end
   end
@@ -97,11 +98,4 @@ class CommandLineTest < Test::Unit::TestCase
     end
   end
   
-private
-  
-  def unindent(string)
-    indentation = string[/\A\s*/]
-    string.strip.gsub(/^#{indentation}/, "")
-  end
-  
 end

data/test/output_at_test.rb

@@ -0,0 +1,178 @@
+require File.expand_path(File.dirname(__FILE__) + "/test_helper")
+
+class OutputAtTest < Test::Unit::TestCase
+  
+  context "weekday at a (single) given time" do
+    setup do
+      @output = Whenever.cron \
+      <<-file
+        every "weekday", :at => '5:02am' do
+          command "blahblah"
+        end
+      file
+    end
+    
+    should "output the command using that time" do
+      assert_match '2 5 * * 1-5 blahblah', @output
+    end
+  end
+  
+  context "weekday at a multiple diverse times, via an array" do
+    setup do
+      @output = Whenever.cron \
+      <<-file
+        every "weekday", :at => %w(5:02am 3:52pm) do
+          command "blahblah"
+        end
+      file
+    end
+    
+    should "output the commands for both times given" do
+      assert_match '2 5 * * 1-5 blahblah', @output
+      assert_match '52 15 * * 1-5 blahblah', @output
+    end
+  end
+  
+  context "weekday at a multiple diverse times, comma separated" do
+    setup do
+      @output = Whenever.cron \
+      <<-file
+        every "weekday", :at => '5:02am, 3:52pm' do
+          command "blahblah"
+        end
+      file
+    end
+    
+    should "output the commands for both times given" do
+      assert_match '2 5 * * 1-5 blahblah', @output
+      assert_match '52 15 * * 1-5 blahblah', @output
+    end
+  end
+  
+  context "weekday at a multiple aligned times" do
+    setup do
+      @output = Whenever.cron \
+      <<-file
+        every "weekday", :at => '5:02am, 3:02pm' do
+          command "blahblah"
+        end
+      file
+    end
+    
+    should "output the command using one entry because the times are aligned" do
+      assert_match '2 5,15 * * 1-5 blahblah', @output
+    end
+  end
+  
+  context "various days at a various aligned times" do
+    setup do
+      @output = Whenever.cron \
+      <<-file
+        every "mon,wed,fri", :at => '5:02am, 3:02pm' do
+          command "blahblah"
+        end
+      file
+    end
+    
+    should "output the command using one entry because the times are aligned" do
+      assert_match '2 5,15 * * 1,3,5 blahblah', @output
+    end
+  end
+  
+  context "various days at a various aligned times using a runner" do
+    setup do
+      @output = Whenever.cron \
+      <<-file
+        set :path, '/your/path'
+        every "mon,wed,fri", :at => '5:02am, 3:02pm' do
+          runner "blahblah"
+        end
+      file
+    end
+    
+    should "output the runner using one entry because the times are aligned" do
+      assert_match '2 5,15 * * 1,3,5 /your/path/script/runner -e production "blahblah"', @output
+    end
+  end
+  
+  context "various days at a various aligned times using a rake task" do
+    setup do
+      @output = Whenever.cron \
+      <<-file
+        set :path, '/your/path'
+        every "mon,wed,fri", :at => '5:02am, 3:02pm' do
+          rake "blah:blah"
+        end
+      file
+    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 /usr/bin/env rake blah:blah', @output
+    end
+  end
+  
+  context "A command every 1.month at very diverse times" do
+    setup do
+      @output = Whenever.cron \
+      <<-file
+        every [1.month, 1.day], :at => 'beginning of the month at 5:02am, june 17th at 2:22pm, june 3rd at 3:33am' do
+          command "blahblah"
+        end
+      file
+    end
+    
+    should "output 6 commands since none align" do
+      # The 1.month commands
+      assert_match '2 5 1 * * blahblah', @output
+      assert_match '22 14 17 * * blahblah', @output
+      assert_match '33 3 3 * * blahblah', @output
+      
+      # The 1.day commands
+      assert_match '2 5 * * * blahblah', @output
+      assert_match '22 14 * * * blahblah', @output
+      assert_match '33 3 * * * blahblah', @output
+    end
+  end
+  
+  context "Multiple commands output every :reboot" do
+    setup do
+      @output = Whenever.cron \
+      <<-file
+        every :reboot do
+          command "command_1"
+          command "command_2"
+        end
+      file
+    end
+    
+    should "output both commands @reboot" do
+      assert_match "@reboot command_1", @output
+      assert_match "@reboot command_2", @output
+    end
+  end
+  
+  context "Many different job types output every :day" do
+    setup do
+      @output = Whenever.cron \
+      <<-file
+        set :path, '/your/path'
+        every :day do
+          rake "blah:blah"
+          runner "runner_1"
+          command "command_1"
+          runner "runner_2"
+          command "command_2"
+        end
+      file
+    end
+    
+    should "output all of the commands @daily" do
+      assert_match '@daily cd /your/path && RAILS_ENV=production /usr/bin/env rake blah:blah', @output
+      assert_match '@daily /your/path/script/runner -e production "runner_1"', @output
+      assert_match '@daily command_1', @output
+      assert_match '@daily /your/path/script/runner -e production "runner_2"', @output
+      assert_match '@daily command_2', @output
+    end
+  end
+  
+end

data/test/output_command_test.rb

@@ -84,4 +84,21 @@ class OutputCommandTest < Test::Unit::TestCase
     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

@@ -19,5 +19,38 @@ class OutputEnvTest < Test::Unit::TestCase
       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_runner_test.rb

@@ -190,4 +190,20 @@ class OutputRunnerTest < Test::Unit::TestCase
     end
   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/whenever.gemspec

@@ -2,28 +2,27 @@
 
 Gem::Specification.new do |s|
   s.name = %q{whenever}
-  s.version = "0.3.1"
+  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-06-25}
+  s.date = %q{2009-09-04}
   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_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.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.1}
+  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_command_test.rb", "test/output_env_test.rb", "test/output_rake_test.rb", "test/output_runner_test.rb", "test/test_helper.rb"]
+  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 = 2
+    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"])

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: javan-whenever
 version: !ruby/object:Gem::Version 
-  version: 0.3.1
+  version: 0.3.7
 platform: ruby
 authors: 
 - Javan Makhmali
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-06-25 00:00:00 -07:00
+date: 2009-09-04 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -61,13 +61,14 @@ files:
 - 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
+has_rdoc: false
 homepage: http://github.com/javan/whenever
 post_install_message: 
 rdoc_options: 
@@ -96,11 +97,12 @@ requirements: []
 rubyforge_project: whenever
 rubygems_version: 1.2.0
 signing_key: 
-specification_version: 2
+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