whenever 0.3.7

data/CHANGELOG.rdoc

@@ -0,0 +1,68 @@
+== 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]
+
+* Switched to numeric days of the week for Solaris support (and probably others). #8 [Roger Ertesvåg]
+
+
+== 0.3.0 / June 2nd, 2009
+
+* Added ability to set variables on the fly from the command line (ex: whenever --set environment=staging). [Javan Makhmali]
+
+
+== 0.2.2 / April 30th, 2009
+
+* Days of week jobs can now accept an :at directive (ex: every :monday, :at => '5pm'). [David Eisinger]
+
+* Fixed command line test so it runs without a config/schedule.rb present. [Javan Makhmali]
+
+* Raising an exception if someone tries to specify an :at with a cron shortcut (:day, :reboot, etc) so there are no false hopes. [Javan Makhmali]
+
+
+== 0.1.7 / 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]
+
+
+== 0.1.4 / February 17th, 2009
+
+* Added --load-file and --user opts to whenever binary. [Javan Makhmali]
+
+
+== 0.1.3 / 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]
+
+* Improved test load paths so tests can be run individually. [Javan Makhmali]
+
+* Got rid of already initialized constant warning. [Javan Makhmali]
+
+* Requiring specific gem versions: Chronic >=0.2.3 and activesupport >= 1.3.0 [Javan Makhmali]
+
+
+== 0.1.0 / February 15th, 2009
+
+* Initial release [Javan Makhmali]

data/Manifest

@@ -0,0 +1,24 @@
+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

data/README.rdoc

@@ -0,0 +1,133 @@
+== Introduction
+
+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.
+
+Ryan Bates created a great Railscast about Whenever: http://railscasts.com/episodes/164-cron-in-ruby
+
+Discussion: http://groups.google.com/group/whenever-gem
+
+== Installation
+
+Regular (non-Rails) install:
+  
+  $ 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:
+  
+in your "config/environment.rb" file:
+
+  Rails::Initializer.run do |config|
+    config.gem 'javan-whenever', :lib => false, :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 install javan-whenever
+
+in your "config/environment.rb" file:
+
+  Rails::Initializer.run do |config|
+    ...
+  end
+
+  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 way to ensure this.
+
+== Getting started
+
+  $ cd /my/rails/app
+  $ wheneverize .
+
+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"                 
+    command "/usr/bin/my_great_command"
+  end
+
+  every 1.day, :at => '4:30 am' do 
+    runner "MyModel.task_to_run_at_four_thirty_in_the_morning"
+  end
+
+  every :hour do # Many shortcuts available: :hour, :day, :month, :year, :reboot
+    runner "SomeModel.ladeeda"
+  end
+
+  every :sunday, :at => '12pm' do # Use any day of the week or :weekend, :weekday 
+    runner "Task.do_something_great"
+  end
+
+More examples on the wiki: http://wiki.github.com/javan/whenever/instructions-and-examples
+  
+== Cron output
+
+  $ cd /my/rails/app
+  $ whenever
+
+And you'll see your schedule.rb converted to cron sytax
+
+== Capistrano integration
+
+In your "config/deploy.rb" file do something like:
+
+  after "deploy:symlink", "deploy:update_crontab"
+
+  namespace :deploy do
+    desc "Update the crontab file"
+    task :update_crontab, :roles => :db do
+      run "cd #{release_path} && whenever --update-crontab #{application}"
+    end
+  end
+
+This will update your crontab file, leaving any existing entries unharmed. When using the <code>--update-crontab</code> option, Whenever will only update the entries in your crontab file related to the current schedule.rb file. You can replace the <code>#{application}</code> with any identifying string you'd like. You can have any number of apps deploy to the same crontab file peacefully given they each use a different identifier.
+
+If you wish to simply overwrite your crontab file each time you deploy, use the <code>--write-crontab</code> 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 <code>--load-file</code> and <code>--user</code> 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!
+
+If you want to override a variable (like your environment) at the time of deployment you can do so with the <code>--set</code> option: http://wiki.github.com/javan/whenever/setting-variables-on-the-fly
+
+== Credit
+
+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
+
+== Discussion / Feedback / Issues / Bugs
+
+For general discussion and questions, please use the google group: http://groups.google.com/group/whenever-gem
+
+If you've found a genuine bug or issue, please use the Issues section on github: http://github.com/javan/whenever/issues
+
+== License
+
+Copyright (c) 2009 Javan Makhmali
+
+Permission is hereby granted, free of charge, to any person
+obtaining a copy of this software and associated documentation
+files (the "Software"), to deal in the Software without
+restriction, including without limitation the rights to use,
+copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the
+Software is furnished to do so, subject to the following
+conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
+OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
+HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
+OTHER DEALINGS IN THE SOFTWARE.

data/Rakefile

@@ -0,0 +1,13 @@
+require 'rubygems'
+require 'rake'
+require 'echoe'
+
+require File.expand_path(File.dirname(__FILE__) + "/lib/version")
+
+Echoe.new('whenever', Whenever::VERSION::STRING) do |p|
+  p.description    = "Provides clean ruby syntax for defining messy cron jobs and running them Whenever."
+  p.url            = "http://github.com/javan/whenever"
+  p.author         = "Javan Makhmali"
+  p.email          = "javan@javan.us"
+  p.dependencies   = ["chronic >=0.2.3"]
+end

data/bin/whenever

@@ -0,0 +1,32 @@
+#!/usr/bin/env ruby
+
+require 'rubygems'
+require 'optparse'
+require 'fileutils'
+require 'tempfile'
+require 'whenever'
+
+require File.expand_path(File.dirname(__FILE__) + "/../lib/version")
+
+options = Hash.new
+
+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('-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| 
+    options[:user] = user if user
+  end
+  opts.on('-s', '--set [variables]', 'Example: --set environment=staging&path=/my/sweet/path') do |set|
+    options[:set] = set if set
+  end
+end.parse!
+
+Whenever::CommandLine.execute(options)

data/bin/wheneverize

@@ -0,0 +1,69 @@
+#!/usr/bin/env ruby
+
+# This file is based heavily on Capistrano's `capify` command
+
+require 'optparse'
+require 'fileutils'
+
+OptionParser.new do |opts|
+  opts.banner = "Usage: #{File.basename($0)} [path]"
+
+  begin
+    opts.parse!(ARGV)
+  rescue OptionParser::ParseError => e
+    warn e.message
+    puts opts
+    exit 1
+  end
+end
+
+if ARGV.empty?
+  abort "Please specify the directory to wheneverize, e.g. `#{File.basename($0)} .'"
+elsif !File.exists?(ARGV.first)
+  abort "`#{ARGV.first}' does not exist."
+elsif !File.directory?(ARGV.first)
+  abort "`#{ARGV.first}' is not a directory."
+elsif ARGV.length > 1
+  abort "Too many arguments; please specify only the directory to wheneverize."
+end
+
+
+content = <<-FILE
+# Use this file to easily define all of your cron jobs.
+#
+# It's helpful, but not entirely necessary to understand cron before proceeding.
+# http://en.wikipedia.org/wiki/Cron
+
+# Example:
+#
+# set :cron_log, "/path/to/my/cron_log.log"
+#
+# every 2.hours do
+#   command "/usr/bin/some_great_command"
+#   runner "MyModel.some_method"
+#   rake "some:great:rake:task"
+# end
+#
+# every 4.days do
+#   runner "AnotherModel.prune_old_records"
+# end
+
+# Learn more: http://github.com/javan/whenever
+FILE
+
+file = 'config/schedule.rb'
+base = ARGV.shift
+
+file = File.join(base, file)
+if File.exists?(file)
+  warn "[skip] `#{file}' already exists"
+elsif File.exists?(file.downcase)
+  warn "[skip] `#{file.downcase}' exists, which could conflict with `#{file}'"
+elsif !File.exists?(File.dirname(file))
+  warn "[skip] directory `#{File.dirname(file)}' does not exist"
+else
+  puts "[add] writing `#{file}'"
+  File.open(file, "w") { |f| f.write(content) }
+end
+
+puts "[done] wheneverized!"

data/lib/base.rb

@@ -0,0 +1,15 @@
+module Whenever
+  
+  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/command_line.rb

@@ -0,0 +1,108 @@
+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)
+      else
+        puts Whenever.cron(@options)
+        exit
+      end
+    end
+    
+  protected
+    
+    def default_identifier
+      File.expand_path(@options[:file])
+    end
+  
+    def whenever_cron
+      @whenever_cron ||= [comment_open, Whenever.cron(@options), comment_close].join("\n") + "\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.chomp)
+      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/job_list.rb

@@ -0,0 +1,159 @@
+module Whenever
+  class JobList
+  
+    def initialize(options)
+      @jobs = Hash.new
+      @env  = Hash.new
+      
+      case options
+        when String
+          config = options
+        when Hash
+          config = if options[:string]
+            options[:string]
+          elsif options[:file]
+            File.read(options[:file])
+          end
+          pre_set(options[:set])
+      end
+
+      eval(config)
+    end
+    
+    def set(variable, value)
+      return if instance_variable_defined?("@#{variable}".to_sym)
+      
+      instance_variable_set("@#{variable}".to_sym, value)
+      self.class.send(:attr_reader, variable.to_sym)
+    end
+    
+    def env(variable, value)
+      @env[variable.to_s] = value
+    end
+  
+    def every(frequency, options = {})
+      @current_time_scope = frequency
+      @options = options
+      yield
+    end
+    
+    def command(task, options = {})
+      options[:cron_log] ||= @cron_log unless options[:cron_log] === false
+      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)
+    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?
+      
+      pairs = variable_string.split('&')
+      pairs.each do |pair|
+        next unless pair.index('=')
+        variable, value = *pair.split('=')
+        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?
+      
+      output = []
+      @env.each do |key, val|
+        output << "#{key}=#{val}\n"
+      end
+      output << "\n"
+      
+      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?
+      
+      shortcut_jobs = []
+      regular_jobs = []
+      
+      @jobs.each do |time, jobs|
+        jobs.each do |job|
+          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
+
+      shortcut_jobs.join + combine(regular_jobs).join
+    end
+    
+  end
+end

data/lib/job_types/default.rb

@@ -0,0 +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]
+        @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

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