mguymon-whenever 0.6.2

data/CHANGELOG.md

@@ -0,0 +1,138 @@
+### 0.6.2 / October 26th, 2010
+
+* --clear-crontab option completely removes entries. #63 [Javan Makhmali]
+
+* Set default :environment and :path earlier in the new setup.rb (formerly job_types/default.rb). [Javan Makhmali]
+
+* Converted README and CHANGELOG to markdown. [Javan Makhmali]
+
+
+### 0.6.1 / October 20th, 2010
+
+* Detect script/rails file and change runner to Rails 3 style if found. [Javan Makhmali]
+
+* Created a new :job_template system that can be applied to all commands. Wraps all in bash -l -c 'command..' by default now for better RVM support. Stopped automatically setting the PATH too. [Javan Makhmali]
+
+* Added a built-in Capistrano recipe. [Javan Makhmali]
+
+
+### 0.5.3 / September 24th, 2010
+
+* Better regexes for replacing Whenever blocks in the crontab. #45 [Javan Makhmali]
+
+* Preserving backslashes when updating existing crontab. #82 [Javan Makhmali]
+
+
+### 0.5.2 / September 15th, 2010
+
+* Quotes automatically escaped in jobs. [Jay Adkisson]
+
+* Added --cut option to the command line to allow pruning of the crontab. [Peer Allan]
+
+* Switched to aaronh-chronic which is ruby 1.9.2 compatible. [Aaron Hurley, Javan Makhmali]
+
+* Lots of internal reorganizing; tests broken into unit and functional. [Javan Makhmali]
+
+
+### 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]
+
+* Fix STDERR output redirection to file to append instead of overwrite. [weplay]
+
+* Move require of tempfile lib to file that actually uses it. [Finn Smith]
+
+* bugfix: comparison Time with 0 failed. #32 [Dan Hixon]
+
+
+### 0.4.1 / November 30th, 2009
+
+* exit(0) instead of just exit to make JRuby happy. [Elan Meng]
+
+* Fixed activesupport deprecation warning by requiring active_support. #37 [Andrew Nesbitt]
+
+
+### 0.4.0 / October 20th, 2009
+
+* New output option replaces the old cron_log option for output redirection and is much more flexible. #31 [Peer Allan]
+
+* Reorganized the lib files (http://weblog.rubyonrails.org/2009/9/1/gem-packaging-best-practices) and switched to Jeweler from Echoe.
+
+
+### 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/README.md

@@ -0,0 +1,163 @@
+### Introduction
+
+Whenever is a Ruby gem that provides a clear syntax for writing and deploying cron jobs.
+
+### Installation
+  
+    $ gem install whenever
+
+Or with Bundler in your Gemfile.
+
+    gem 'whenever', :require => false
+ 
+### 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>
+
+### Define your own job types
+
+Whenever ships with three pre-defined job types: command, runner, and rake. You can define your own with `job_type`.
+
+For example:
+
+    job_type :awesome, '/usr/local/bin/awesome :task :fun_level'
+  
+    every 2.hours do
+      awesome "party", :fun_level => "extreme"
+    end
+  
+Would run `/usr/local/bin/awesome party extreme` every two hours. `:task` is always replaced with the first argument, and any additional `:whatevers` are replaced with the options passed in or by variables that have been defined with `set`.
+
+The default job types that ship with Whenever are defined like so:
+
+    job_type :command, ":task :output"
+    job_type :rake,    "cd :path && RAILS_ENV=:environment rake :task :output"
+    job_type :runner,  "cd :path && script/runner -e :environment ':task' :output"
+  
+If a script/rails file is detected (like in a Rails 3 app), runner will be defined to fit:
+
+    job_type :runner,  "cd :path && script/rails runner -e :environment ':task' :output"
+
+If a `:path` is not set it will default to the directory in which `whenever` was executed. `:environment` will default to 'production'. `:output` will be replaced with your output redirection settings which you can read more about here: <http://github.com/javan/whenever/wiki/Output-redirection-aka-logging-your-cron-jobs>
+
+All jobs are by default run with `bash -l -c 'command...'`. Among other things, this allows your cron jobs to play nice with RVM by loading the entire environment instead of cron's somewhat limited environment. Read more: <http://blog.scoutapp.com/articles/2010/09/07/rvm-and-cron-in-production>
+
+You can change this by setting your own `:job_template`.
+
+    set :job_template, "bash -l -c ':job'"
+  
+Or set the job_template to nil to have your jobs execute normally.
+
+    set :job_template, nil
+
+And you'll see your schedule.rb converted to cron sytax. Note: running `whenever` with no options does not display your current crontab file, it simply shows you the output of converting your schedule.rb file.
+
+### Capistrano integration
+
+Use the built-in Capistrano recipe for easy crontab updates with deploys.
+
+In your "config/deploy.rb" file:
+
+    require "whenever/capistrano"
+
+Take a look at the recipe for options you can set. <http://github.com/javan/whenever/blob/master/lib/whenever/capistrano.rb>
+For example, if you're using bundler do this:
+
+    set :whenever_command, "bundle exec whenever"
+    require "whenever/capistrano"
+
+By default, whenever runs jobs in the production environment.  You can specify an environment to use in your deploy.rb file using:
+
+  set :whenever_environment, "dev"
+
+If you are using capistrano multi-stage, and you have a rails environment for each stage, you might consider using:
+
+  set :whenever_environment do
+    stage
+  end
+
+To configure jobs that should only run in one of your environments, you can add them in your schedule.rb like so:
+
+  case environment
+  when "production"
+    every 15.minutes do
+      runner "Session.expire"
+    end
+  when "staging"
+    every 30.minutes do
+      runner "Session.expire"
+    end
+  when "qa"
+  end
+
+### The `whenever` command
+
+    $ cd /my/rails/app
+    $ whenever
+  
+This will simply show you your schedule.rb file converted to cron syntax. It does not read or write your crontab file. Run `whenever --help` for a complete list of options.
+
+### 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>
+
+Thanks to all the contributors who have made it even better: <http://github.com/javan/whenever/contributors>
+
+### 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>
+
+Ryan Bates created a great Railscast about Whenever: <http://railscasts.com/episodes/164-cron-in-ruby>
+It's a little bit dated now, but remains a good introduction.
+
+### 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,35 @@
+require 'rubygems'
+require 'rake'
+
+require File.expand_path(File.dirname(__FILE__) + "/lib/whenever/version")
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gemspec|
+    gemspec.name        = "mguymon-whenever"
+    gemspec.version     = Whenever::VERSION
+    gemspec.summary     = "Write your cron jobs in ruby."
+    gemspec.description = "Clean ruby syntax for writing and deploying cron jobs."
+    gemspec.email       = "javan@javan.us"
+    gemspec.homepage    = "http://github.com/mguymon/whenever"
+    gemspec.authors     = ["Javan Makhmali"]
+    gemspec.add_dependency 'aaronh-chronic', '>= 0.3.9'
+    gemspec.add_dependency 'activesupport', '>= 2.3.4'
+    gemspec.add_development_dependency 'shoulda', '>= 2.1.1'
+    gemspec.add_development_dependency 'mocha', '>= 0.9.5'
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler not available. Install it with: sudo gem install jeweler -s http://gemcutter.org"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+    test.libs      << 'lib' << 'test'
+    test.pattern   = 'test/{functional,unit}/**/*_test.rb'
+    test.verbose   = true
+  end
+
+task :test => :check_dependencies
+
+task :default => :test

data/bin/whenever

@@ -0,0 +1,38 @@
+#!/usr/bin/env ruby
+
+require 'rubygems'
+require 'optparse'
+require 'whenever'
+
+options = {}
+
+OptionParser.new do |opts|
+  opts.banner = "Usage: whenever [options]"
+  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('-w', '--write-crontab [identifier]', 'Default: full path to schedule.rb file') do |identifier|
+     options[:write] = 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('-s', '--set [variables]', 'Example: --set environment=staging&path=/my/sweet/path') do |set|
+    options[:set] = set if set
+  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('-k', '--cut [lines]', 'Cut lines from the top of the cronfile') do |lines|
+    options[:cut] = lines.to_i if lines
+  end
+  opts.on('-v', '--version') { puts "Whenever v#{Whenever::VERSION}"; exit(0) }
+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 :output, "/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!"