javan-whenever 0.1.5 → 0.1.6

data/CHANGELOG.rdoc

@@ -1,3 +1,7 @@
+== 0.1.6 / March 5th, 2009
+
+* Added ability to update the crontab file non-destuctively instead of only overwriting it. [Javan Makhmali -- Inspired by code submitted individually from: Tien Dung (tiendung), Tom Lea (cwninja), Kyle Maxwell (fizx), and Andrew Timberlake (andrewtimberlake) on github]
+
 == 0.1.5 / February 19th, 2009
 
 * Fixed load path so Whenever's files don't conflict with anything in Rails. Thanks Ryan Koopmans. [Javan Makhmali]

data/README.rdoc

@@ -1,12 +1,12 @@
 == Introduction
 
-Whenever is a ruby gem that provides a ruby syntax for defining cron jobs. It outputs valid cron syntax and can even write your crontab file for you. It is designed to work well with Rails applications and can be deployed with Capistrano. Whenever works fine independently as well.
+Whenever is a Ruby gem that provides a clear syntax for defining cron jobs. It outputs valid cron syntax and can even write your crontab file for you. It is designed to work well with Rails applications and can be deployed with Capistrano. Whenever works fine independently as well.
 
 == Installation
 
 Regular (non-Rails) install:
   
-  $ gem sources -a http://gems.github.com (you only need to run this once)
+  $ gem sources -a http://gems.github.com  #you only need to run this once
   $ sudo gem install javan-whenever
 
 In a Rails (2.1 or greater) application:
@@ -14,14 +14,14 @@ In a Rails (2.1 or greater) application:
 in your "config/environment.rb" file:
 
   Rails::Initializer.run do |config|
-    config.gem 'javan-whenever', :lib => false, :version => '>= 0.1.5' :source => 'http://gems.github.com'
+    config.gem 'javan-whenever', :lib => false, :version => '>= 0.1.6' :source => 'http://gems.github.com'
   end
   
 To install this gem (and all other missing gem dependencies), run rake gems:install (use sudo if necessary).
 
 In older versions of Rails:
 
-  $ gem sources -a http://gems.github.com (you only need to run this once)
+  $ gem sources -a http://gems.github.com  #you only need to run this once
   $ gem install javan-whenever
 
 in your "config/environment.rb" file:
@@ -32,7 +32,7 @@ in your "config/environment.rb" file:
 
   require 'whenever'
   
-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.
+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 way to ensure this.
 
 == Getting started
 
@@ -42,7 +42,7 @@ NOTE: Requiring the whenever gem inside your Rails application is technically op
 This will create an initial "config/schedule.rb" file you.
 
 == Example schedule.rb file
-
+  
   every 3.hours do
     runner "MyModel.some_process"       
     rake "my:rake:task"                 
@@ -50,7 +50,7 @@ This will create an initial "config/schedule.rb" file you.
   end
 
   every 1.day, :at => '4:30 am' do 
-    runner "DB.Backup"
+    runner "MyModel.task_to_run_at_four_thirty_in_the_morning"
   end
 
   every :hour do # Many shortcuts available: :hour, :day, :month, :year, :reboot
@@ -72,24 +72,26 @@ And you'll see your schedule.rb converted to cron sytax
 
 == Capistrano integration
 
-in your "config/deploy.rb" file do something like:
+In your "config/deploy.rb" file do something like:
 
-  after "deploy:symlink", "deploy:write_crontab"
+  after "deploy:symlink", "deploy:update_crontab"
 
   namespace :deploy do
-    desc "write the crontab file"
-    task :write_crontab, :roles => :app do
-      run "cd #{release_path} && whenever --write-crontab"
+    desc "Update the crontab file"
+    task :update_crontab, :roles => :db do
+      run "cd #{release_path} && whenever --update-crontab"
     end
   end
-  
+
+This will update your crontab file, leaving any existing entries unharmed. When using the "--update-crontab" option, Whenever will only update the entries in your crontab file related to the current schedule.rb file. This means you can use Whenever to deploy any number of apps to the same server and have them share a single crontab file peacefully.
+
+If you wish to simply overwrite your crontab file each time you deploy, use the "--write-crontab" option. This is ideal if you are only working with one app and every crontab entry is contained in a single schedule.rb file.
+
 By mixing and matching the "--load-file" and "--user" options with your various :roles in Capistrano it is entirely possible to deploy different crontab schedules under different users to all your various servers. Get creative!
-  
-USING THE "--write-crontab" OPTION WILL COMPLETELY OVERWRITE ANY EXISTING CRONTAB ENTRIES!
 
 == Credit
 
-Whenever was created for use at Inkling (http://inklingmarkets.com) where I work.
+Whenever was created for use at Inkling (http://inklingmarkets.com) where I work. Their take on it: http://blog.inklingmarkets.com/2009/02/whenever-easy-way-to-do-cron-jobs-from.html
 
 While building Whenever, I learned a lot by digging through the source code of Capistrano - http://github.com/jamis/capistrano
 

data/bin/whenever

@@ -14,40 +14,20 @@ OptionParser.new do |opts|
   opts.banner = "Usage: whenever [options]"
   opts.on('-v', '--version') { puts "Whenever v#{Whenever::VERSION::STRING}"; exit }
   opts.on('-w', '--write-crontab') { options[:write] = true }
-  opts.on('-f', '--load-file [schedule file]', 'default: config/schedule.rb') do |file|
+  opts.on('-i', '--update-crontab [identifier]', 'Default: full path to schedule.rb file') do |identifier|
+    options[:update] = 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
-  opts.on('-u', '--user [user]', 'default: current user') do |user| 
+  opts.on('-u', '--user [user]', 'Default: current user') do |user| 
     options[:user] = user if user
   end
 end.parse!
 
-options[:file] ||= 'config/schedule.rb'
-
-unless File.exists?(options[:file])
-  warn("[fail] can't find file: #{options[:file]}")
-  exit(1)
-end
-
-if options[:write]
-  cron_output   = Whenever.cron(:file => options[:file])
-  tmp_cron_file = Tempfile.new('whenever_tmp_cron').path
-  File.open(tmp_cron_file, File::WRONLY | File::APPEND) do |file|
-    file << cron_output
-  end
-  
-  command = ['crontab']
-  command << "-u #{options[:user]}" if options[:user]
-  command << tmp_cron_file
-  
-  if system(command.join(' '))
-    puts "[write] crontab file updated"
-    exit
-  else
-    warn "[fail] couldn't write crontab"
-    exit(1)
-  end
-  
+if options[:update] || options[:write]
+  Whenever::CommandLine.execute(options)
 else
   puts Whenever.cron(:file => options[:file])
   exit

data/lib/command_line.rb

@@ -0,0 +1,105 @@
+module Whenever
+  class CommandLine
+    
+    def self.execute(options={})
+      new(options).run
+    end
+    
+    def initialize(options={})
+      @options = options
+      
+      @options[:file]       ||= 'config/schedule.rb'
+      @options[:identifier] ||= default_identifier
+      
+      unless File.exists?(@options[:file])
+        warn("[fail] Can't find file: #{@options[:file]}")
+        exit(1)
+      end
+
+      if @options[:update] && @options[:write]
+        warn("[fail] Can't update AND write. choose one.")
+        exit(1)
+      end
+    end
+    
+    def run
+      if @options[:update]
+        write_crontab(updated_crontab)
+      elsif @options[:write]
+        write_crontab(whenever_cron)
+      end
+    end
+    
+  protected
+    
+    def default_identifier
+      File.expand_path(@options[:file])
+    end
+  
+    def whenever_cron
+      @whenever_cron ||= [comment_open, Whenever.cron(:file => @options[:file]), comment_close].join("\n")
+    end
+    
+    def read_crontab
+      return @current_crontab if @current_crontab
+      
+      command = ['crontab -l']
+      command << "-u #{@options[:user]}" if @options[:user]
+      
+      command_results  = %x[#{command.join(' ')} 2> /dev/null]
+      @current_crontab = $?.exitstatus.zero? ? command_results : ''
+    end
+    
+    def write_crontab(contents)
+      tmp_cron_file = Tempfile.new('whenever_tmp_cron').path
+      File.open(tmp_cron_file, File::WRONLY | File::APPEND) do |file|
+        file << contents
+      end
+
+      command = ['crontab']
+      command << "-u #{@options[:user]}" if @options[:user]
+      command << tmp_cron_file
+
+      if system(command.join(' '))
+        action = 'written' if @options[:write]
+        action = 'updated' if @options[:update]
+        puts "[write] crontab file #{action}"
+        exit
+      else
+        warn "[fail] Couldn't write crontab; try running `whenever' with no options to ensure your schedule file is valid."
+        exit(1)
+      end
+    end
+    
+    def updated_crontab      
+      # Check for unopened or unclosed identifier blocks
+      if read_crontab.index(comment_open) && !read_crontab.index(comment_close)
+        warn "[fail] Unclosed indentifier; Your crontab file contains '#{comment_open}', but no '#{comment_close}'"
+        exit(1)
+      elsif !read_crontab.index(comment_open) && read_crontab.index(comment_close)
+        warn "[fail] Unopened indentifier; Your crontab file contains '#{comment_close}', but no '#{comment_open}'"
+        exit(1)
+      end
+      
+      # 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)
+      else # Otherwise, append the new cron entries after any existing ones
+        [read_crontab, whenever_cron].join("\n\n")
+      end
+    end
+    
+    def comment_base
+      "Whenever generated tasks for: #{@options[:identifier]}"
+    end
+    
+    def comment_open
+      "# Begin #{comment_base}"
+    end
+    
+    def comment_close
+      "# End #{comment_base}"
+    end
+    
+  end
+end

data/lib/version.rb

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

data/lib/whenever.rb

@@ -14,6 +14,13 @@ require 'activesupport'
 require 'chronic'
 
 # Whenever files
-%w{ base version job_list job_types/default job_types/rake_task job_types/runner outputs/cron }.each do |file|
-  require	File.expand_path(File.dirname(__FILE__) + "/#{file}")
-end
+%w{ 
+base 
+version 
+job_list 
+job_types/default 
+job_types/rake_task 
+job_types/runner 
+outputs/cron
+command_line 
+}.each { |file| require	File.expand_path(File.dirname(__FILE__) + "/#{file}") }

data/test/command_line_test.rb

@@ -0,0 +1,104 @@
+require File.expand_path(File.dirname(__FILE__) + "/test_helper")
+
+class CommandLineTest < Test::Unit::TestCase
+  
+  context "A command line write" do
+    setup do
+      @command = Whenever::CommandLine.new(:write => true, :identifier => 'My identifier')
+      @task = "#{two_hours} /my/command"
+      Whenever.expects(:cron).returns(@task)
+    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
+      
+      assert_equal unindent(output).chomp, @command.send(:whenever_cron).chomp
+    end
+    
+    should "write the crontab when run" do
+      @command.expects(:write_crontab).returns(true)
+      assert @command.run
+    end
+  end
+  
+  context "A command line update" do
+    setup do
+      @command = Whenever::CommandLine.new(:update => true, :identifier => 'My identifier')
+      @task = "#{two_hours} /my/command"
+      Whenever.expects(:cron).returns(@task)
+    end
+
+    should "add the cron to the end of the file if there is no existing identifier block" do
+      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
+      
+      assert_equal unindent(new_cron).chomp, @command.send(:updated_crontab).chomp
+      
+      @command.expects(:write_crontab).with(unindent(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
+      
+      # 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
+      
+      @command.expects(:write_crontab).with(unindent(new_cron)).returns(true)
+      assert @command.run
+    end
+  end
+  
+  context "A command line update with no identifier" do
+    setup do
+      Whenever::CommandLine.any_instance.expects(:default_identifier).returns('DEFAULT')
+      @command = Whenever::CommandLine.new(:update => true, :file => @file)
+    end
+
+    should "use the default identifier" do
+      assert_equal "Whenever generated tasks for: DEFAULT", @command.send(:comment_base)
+    end
+  end
+  
+private
+  
+  def unindent(string)
+    indentation = string[/\A\s*/]
+    string.strip.gsub(/^#{indentation}/, "")
+  end
+  
+end

data/whenever.gemspec

@@ -2,16 +2,16 @@
 
 Gem::Specification.new do |s|
   s.name = %q{whenever}
-  s.version = "0.1.5"
+  s.version = "0.1.6"
 
   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-19}
+  s.date = %q{2009-03-05}
   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/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/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/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.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.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_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_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.5
+  version: 0.1.6
 platform: ruby
 authors: 
 - Javan Makhmali
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-02-19 00:00:00 -08:00
+date: 2009-03-05 00:00:00 -08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -44,6 +44,7 @@ extra_rdoc_files:
 - 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
@@ -57,6 +58,7 @@ files:
 - 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
@@ -67,6 +69,7 @@ files:
 - Manifest
 - Rakefile
 - README.rdoc
+- test/command_line_test.rb
 - test/cron_test.rb
 - test/output_command_test.rb
 - test/output_env_test.rb
@@ -106,6 +109,7 @@ signing_key:
 specification_version: 2
 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_command_test.rb
 - test/output_env_test.rb