whenever 0.5.0 → 0.6.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
data/.gitignore CHANGED
@@ -1,3 +1,4 @@
1
1
  .DS_Store
2
2
  pkg
3
- doc
3
+ doc
4
+ .*.sw[a-z]
@@ -1,4 +1,40 @@
1
- == 0.5.0 / June 28th, 2010
1
+ ### 0.6.2 / October 26th, 2010
2
+
3
+ * --clear-crontab option completely removes entries. #63 [Javan Makhmali]
4
+
5
+ * Set default :environment and :path earlier in the new setup.rb (formerly job_types/default.rb). [Javan Makhmali]
6
+
7
+ * Converted README and CHANGELOG to markdown. [Javan Makhmali]
8
+
9
+
10
+ ### 0.6.1 / October 20th, 2010
11
+
12
+ * Detect script/rails file and change runner to Rails 3 style if found. [Javan Makhmali]
13
+
14
+ * 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]
15
+
16
+ * Added a built-in Capistrano recipe. [Javan Makhmali]
17
+
18
+
19
+ ### 0.5.3 / September 24th, 2010
20
+
21
+ * Better regexes for replacing Whenever blocks in the crontab. #45 [Javan Makhmali]
22
+
23
+ * Preserving backslashes when updating existing crontab. #82 [Javan Makhmali]
24
+
25
+
26
+ ### 0.5.2 / September 15th, 2010
27
+
28
+ * Quotes automatically escaped in jobs. [Jay Adkisson]
29
+
30
+ * Added --cut option to the command line to allow pruning of the crontab. [Peer Allan]
31
+
32
+ * Switched to aaronh-chronic which is ruby 1.9.2 compatible. [Aaron Hurley, Javan Makhmali]
33
+
34
+ * Lots of internal reorganizing; tests broken into unit and functional. [Javan Makhmali]
35
+
36
+
37
+ ### 0.5.0 / June 28th, 2010
2
38
 
3
39
  * New job_type API for writing custom jobs. Internals use this to define command, runner, and rake. [Javan Makhmali - inspired by idlefingers (Damien)]
4
40
 
@@ -7,7 +43,7 @@
7
43
  * --clear option to remove crontab entries for a specific [identifier]. [mraidel (Michael Raidel)]
8
44
 
9
45
 
10
- == 0.4.2 / April 26th, 2010
46
+ ### 0.4.2 / April 26th, 2010
11
47
 
12
48
  * runners now cd into the app's directory and then execute. [Michael Guterl]
13
49
 
@@ -18,49 +54,49 @@
18
54
  * bugfix: comparison Time with 0 failed. #32 [Dan Hixon]
19
55
 
20
56
 
21
- == 0.4.1 / November 30th, 2009
57
+ ### 0.4.1 / November 30th, 2009
22
58
 
23
59
  * exit(0) instead of just exit to make JRuby happy. [Elan Meng]
24
60
 
25
61
  * Fixed activesupport deprecation warning by requiring active_support. #37 [Andrew Nesbitt]
26
62
 
27
63
 
28
- == 0.4.0 / October 20th, 2009
64
+ ### 0.4.0 / October 20th, 2009
29
65
 
30
66
  * New output option replaces the old cron_log option for output redirection and is much more flexible. #31 [Peer Allan]
31
67
 
32
68
  * Reorganized the lib files (http://weblog.rubyonrails.org/2009/9/1/gem-packaging-best-practices) and switched to Jeweler from Echoe.
33
69
 
34
70
 
35
- == 0.3.7 / September 4th, 2009
71
+ ### 0.3.7 / September 4th, 2009
36
72
 
37
73
  * No longer tries (and fails) to combine @shortcut jobs. #20 [Javan Makhmali]
38
74
 
39
75
 
40
- == 0.3.6 / June 15th, 2009
76
+ ### 0.3.6 / June 15th, 2009
41
77
 
42
78
  * Setting a PATH in the crontab automatically based on the user's PATH. [Javan Makhmali]
43
79
 
44
80
 
45
- == 0.3.5 / June 13th, 2009
81
+ ### 0.3.5 / June 13th, 2009
46
82
 
47
83
  * Added ability to accept lists of every's and at's and intelligently group them. (ex: every 'monday, wednesday', :at => ['3pm', '6am']). [Sam Ruby]
48
84
 
49
85
  * Fixed issue with new lines. #18 [Javan Makhmali]
50
86
 
51
- == 0.3.1 / June 25th, 2009
87
+ ### 0.3.1 / June 25th, 2009
52
88
 
53
89
  * Removed activesupport gem dependency. #1 [Javan Makhmali]
54
90
 
55
91
  * Switched to numeric days of the week for Solaris support (and probably others). #8 [Roger Ertesvåg]
56
92
 
57
93
 
58
- == 0.3.0 / June 2nd, 2009
94
+ ### 0.3.0 / June 2nd, 2009
59
95
 
60
96
  * Added ability to set variables on the fly from the command line (ex: whenever --set environment=staging). [Javan Makhmali]
61
97
 
62
98
 
63
- == 0.2.2 / April 30th, 2009
99
+ ### 0.2.2 / April 30th, 2009
64
100
 
65
101
  * Days of week jobs can now accept an :at directive (ex: every :monday, :at => '5pm'). [David Eisinger]
66
102
 
@@ -69,22 +105,22 @@
69
105
  * 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]
70
106
 
71
107
 
72
- == 0.1.7 / March 5th, 2009
108
+ ### 0.1.7 / March 5th, 2009
73
109
 
74
110
  * 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]
75
111
 
76
112
 
77
- == 0.1.5 / February 19th, 2009
113
+ ### 0.1.5 / February 19th, 2009
78
114
 
79
115
  * Fixed load path so Whenever's files don't conflict with anything in Rails. Thanks Ryan Koopmans. [Javan Makhmali]
80
116
 
81
117
 
82
- == 0.1.4 / February 17th, 2009
118
+ ### 0.1.4 / February 17th, 2009
83
119
 
84
120
  * Added --load-file and --user opts to whenever binary. [Javan Makhmali]
85
121
 
86
122
 
87
- == 0.1.3 / February 16th, 2009
123
+ ### 0.1.3 / February 16th, 2009
88
124
 
89
125
  * Added 'rake' helper for defining scheduled rake tasks. [Javan Makhmali]
90
126
 
@@ -97,6 +133,6 @@
97
133
  * Requiring specific gem versions: Chronic >=0.2.3 and activesupport >= 1.3.0 [Javan Makhmali]
98
134
 
99
135
 
100
- == 0.1.0 / February 15th, 2009
136
+ ### 0.1.0 / February 15th, 2009
101
137
 
102
138
  * Initial release [Javan Makhmali]
data/README.md ADDED
@@ -0,0 +1,139 @@
1
+ ### Introduction
2
+
3
+ Whenever is a Ruby gem that provides a clear syntax for writing and deploying cron jobs.
4
+
5
+ ### Installation
6
+
7
+ $ gem install whenever
8
+
9
+ Or with Bundler in your Gemfile.
10
+
11
+ gem 'whenever', :require => false
12
+
13
+ ### Getting started
14
+
15
+ $ cd /my/rails/app
16
+ $ wheneverize .
17
+
18
+ This will create an initial "config/schedule.rb" file you.
19
+
20
+ ### Example schedule.rb file
21
+
22
+ every 3.hours do
23
+ runner "MyModel.some_process"
24
+ rake "my:rake:task"
25
+ command "/usr/bin/my_great_command"
26
+ end
27
+
28
+ every 1.day, :at => '4:30 am' do
29
+ runner "MyModel.task_to_run_at_four_thirty_in_the_morning"
30
+ end
31
+
32
+ every :hour do # Many shortcuts available: :hour, :day, :month, :year, :reboot
33
+ runner "SomeModel.ladeeda"
34
+ end
35
+
36
+ every :sunday, :at => '12pm' do # Use any day of the week or :weekend, :weekday
37
+ runner "Task.do_something_great"
38
+ end
39
+
40
+ More examples on the wiki: <http://wiki.github.com/javan/whenever/instructions-and-examples>
41
+
42
+ ### Define your own job types
43
+
44
+ Whenever ships with three pre-defined job types: command, runner, and rake. You can define your own with `job_type`.
45
+
46
+ For example:
47
+
48
+ job_type :awesome, '/usr/local/bin/awesome :task :fun_level'
49
+
50
+ every 2.hours do
51
+ awesome "party", :fun_level => "extreme"
52
+ end
53
+
54
+ 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`.
55
+
56
+ The default job types that ship with Whenever are defined like so:
57
+
58
+ job_type :command, ":task :output"
59
+ job_type :rake, "cd :path && RAILS_ENV=:environment rake :task :output"
60
+ job_type :runner, "cd :path && script/runner -e :environment ':task' :output"
61
+
62
+ If a script/rails file is detected (like in a Rails 3 app), runner will be defined to fit:
63
+
64
+ job_type :runner, "cd :path && script/rails runner -e :environment ':task' :output"
65
+
66
+ 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>
67
+
68
+ 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>
69
+
70
+ You can change this by setting your own `:job_template`.
71
+
72
+ set :job_template, "bash -l -c ':job'"
73
+
74
+ Or set the job_template to nil to have your jobs execute normally.
75
+
76
+ set :job_template, nil
77
+
78
+ 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.
79
+
80
+ ### Capistrano integration
81
+
82
+ Use the built-in Capistrano recipe for easy crontab updates with deploys.
83
+
84
+ In your "config/deploy.rb" file:
85
+
86
+ require "whenever/capistrano"
87
+
88
+ Take a look at the recipe for options you can set. <http://github.com/javan/whenever/blob/master/lib/whenever/capistrano.rb>
89
+ For example, if you're using bundler do this:
90
+
91
+ set :whenever_command, "bundle exec whenever"
92
+ require "whenever/capistrano"
93
+
94
+ ### The `whenever` command
95
+
96
+ $ cd /my/rails/app
97
+ $ whenever
98
+
99
+ 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.
100
+
101
+ ### Credit
102
+
103
+ 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>
104
+
105
+ Thanks to all the contributors who have made it even better: <http://github.com/javan/whenever/contributors>
106
+
107
+ ### Discussion / Feedback / Issues / Bugs
108
+
109
+ For general discussion and questions, please use the google group: <http://groups.google.com/group/whenever-gem>
110
+
111
+ If you've found a genuine bug or issue, please use the Issues section on github: <http://github.com/javan/whenever/issues>
112
+
113
+ Ryan Bates created a great Railscast about Whenever: <http://railscasts.com/episodes/164-cron-in-ruby>
114
+ It's a little bit dated now, but remains a good introduction.
115
+
116
+ ### License
117
+
118
+ Copyright (c) 2009+ Javan Makhmali
119
+
120
+ Permission is hereby granted, free of charge, to any person
121
+ obtaining a copy of this software and associated documentation
122
+ files (the "Software"), to deal in the Software without
123
+ restriction, including without limitation the rights to use,
124
+ copy, modify, merge, publish, distribute, sublicense, and/or sell
125
+ copies of the Software, and to permit persons to whom the
126
+ Software is furnished to do so, subject to the following
127
+ conditions:
128
+
129
+ The above copyright notice and this permission notice shall be
130
+ included in all copies or substantial portions of the Software.
131
+
132
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
133
+ EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
134
+ OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
135
+ NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
136
+ HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
137
+ WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
138
+ FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
139
+ OTHER DEALINGS IN THE SOFTWARE.
data/Rakefile CHANGED
@@ -1,19 +1,22 @@
1
1
  require 'rubygems'
2
2
  require 'rake'
3
3
 
4
- require 'lib/whenever/version.rb'
4
+ require File.expand_path(File.dirname(__FILE__) + "/lib/whenever/version")
5
5
 
6
6
  begin
7
7
  require 'jeweler'
8
8
  Jeweler::Tasks.new do |gemspec|
9
9
  gemspec.name = "whenever"
10
10
  gemspec.version = Whenever::VERSION
11
- gemspec.summary = "Clean ruby syntax for defining and deploying messy cron jobs."
12
- gemspec.description = "Clean ruby syntax for defining and deploying messy cron jobs."
11
+ gemspec.summary = "Write your cron jobs in ruby."
12
+ gemspec.description = "Clean ruby syntax for writing and deploying cron jobs."
13
13
  gemspec.email = "javan@javan.us"
14
14
  gemspec.homepage = "http://github.com/javan/whenever"
15
15
  gemspec.authors = ["Javan Makhmali"]
16
- gemspec.add_dependency("chronic", '>= 0.2.3')
16
+ gemspec.add_dependency 'aaronh-chronic', '>= 0.3.9'
17
+ gemspec.add_dependency 'activesupport', '>= 2.3.4'
18
+ gemspec.add_development_dependency 'shoulda', '>= 2.1.1'
19
+ gemspec.add_development_dependency 'mocha', '>= 0.9.5'
17
20
  end
18
21
  Jeweler::GemcutterTasks.new
19
22
  rescue LoadError
@@ -22,10 +25,10 @@ end
22
25
 
23
26
  require 'rake/testtask'
24
27
  Rake::TestTask.new(:test) do |test|
25
- test.libs << 'lib' << 'test'
26
- test.pattern = 'test/*.rb'
27
- test.verbose = true
28
- end
28
+ test.libs << 'lib' << 'test'
29
+ test.pattern = 'test/{functional,unit}/**/*_test.rb'
30
+ test.verbose = true
31
+ end
29
32
 
30
33
  task :test => :check_dependencies
31
34
 
data/bin/whenever CHANGED
@@ -4,29 +4,35 @@ require 'rubygems'
4
4
  require 'optparse'
5
5
  require 'whenever'
6
6
 
7
- options = Hash.new
7
+ options = {}
8
8
 
9
9
  OptionParser.new do |opts|
10
10
  opts.banner = "Usage: whenever [options]"
11
- opts.on('-v', '--version') { puts "Whenever v#{Whenever::VERSION}"; exit(0) }
12
- opts.on('-w', '--write-crontab') { options[:write] = true }
13
11
  opts.on('-i', '--update-crontab [identifier]', 'Default: full path to schedule.rb file') do |identifier|
14
12
  options[:update] = true
15
13
  options[:identifier] = identifier if identifier
16
14
  end
15
+ opts.on('-w', '--write-crontab [identifier]', 'Default: full path to schedule.rb file') do |identifier|
16
+ options[:write] = true
17
+ options[:identifier] = identifier if identifier
18
+ end
17
19
  opts.on('-c', '--clear-crontab [identifier]') do |identifier|
18
20
  options[:clear] = true
19
21
  options[:identifier] = identifier if identifier
20
22
  end
23
+ opts.on('-s', '--set [variables]', 'Example: --set environment=staging&path=/my/sweet/path') do |set|
24
+ options[:set] = set if set
25
+ end
21
26
  opts.on('-f', '--load-file [schedule file]', 'Default: config/schedule.rb') do |file|
22
27
  options[:file] = file if file
23
28
  end
24
29
  opts.on('-u', '--user [user]', 'Default: current user') do |user|
25
30
  options[:user] = user if user
26
31
  end
27
- opts.on('-s', '--set [variables]', 'Example: --set environment=staging&path=/my/sweet/path') do |set|
28
- options[:set] = set if set
32
+ opts.on('-k', '--cut [lines]', 'Cut lines from the top of the cronfile') do |lines|
33
+ options[:cut] = lines.to_i if lines
29
34
  end
35
+ opts.on('-v', '--version') { puts "Whenever v#{Whenever::VERSION}"; exit(0) }
30
36
  end.parse!
31
37
 
32
38
  Whenever::CommandLine.execute(options)
@@ -0,0 +1,31 @@
1
+ Capistrano::Configuration.instance(:must_exist).load do
2
+
3
+ _cset(:whenever_roles) { :db }
4
+ _cset(:whenever_command) { "whenever" }
5
+ _cset(:whenever_identifier) { application }
6
+ _cset(:whenever_update_flags) { "--update-crontab #{whenever_identifier}" }
7
+ _cset(:whenever_clear_flags) { "--clear-crontab #{whenever_identifier}" }
8
+
9
+ # Disable cron jobs at the begining of a deploy.
10
+ after "deploy:update_code", "whenever:clear_crontab"
11
+ # Write the new cron jobs near the end.
12
+ after "deploy:symlink", "whenever:update_crontab"
13
+ # If anything goes wrong, undo.
14
+ after "deploy:rollback", "whenever:update_crontab"
15
+
16
+ namespace :whenever do
17
+ desc "Update application's crontab entries using Whenever"
18
+ task :update_crontab, :roles => whenever_roles do
19
+ # Hack by Jamis to skip a task if the role has no servers defined. http://tinyurl.com/ckjgnz
20
+ next if find_servers_for_task(current_task).empty?
21
+ run "cd #{current_path} && #{whenever_command} #{whenever_update_flags}"
22
+ end
23
+
24
+ desc "Clear application's crontab entries using Whenever"
25
+ task :clear_crontab, :roles => whenever_roles do
26
+ next if find_servers_for_task(current_task).empty?
27
+ run "cd #{release_path} && #{whenever_command} #{whenever_clear_flags}"
28
+ end
29
+ end
30
+
31
+ end
@@ -12,6 +12,7 @@ module Whenever
12
12
  @options = options
13
13
 
14
14
  @options[:file] ||= 'config/schedule.rb'
15
+ @options[:cut] ||= 0
15
16
  @options[:identifier] ||= default_identifier
16
17
 
17
18
  unless File.exists?(@options[:file])
@@ -23,6 +24,12 @@ module Whenever
23
24
  warn("[fail] Can only update, write or clear. Choose one.")
24
25
  exit(1)
25
26
  end
27
+
28
+ unless @options[:cut].to_s =~ /[0-9]*/
29
+ warn("[fail] Can't cut negative lines from the crontab #{options[:cut]}")
30
+ exit(1)
31
+ end
32
+ @options[:cut] = @options[:cut].to_i
26
33
  end
27
34
 
28
35
  def run
@@ -43,7 +50,8 @@ module Whenever
43
50
  end
44
51
 
45
52
  def whenever_cron
46
- @whenever_cron ||= [comment_open, (Whenever.cron(@options) unless @options[:clear]), comment_close].compact.join("\n") + "\n"
53
+ return '' if @options[:clear]
54
+ @whenever_cron ||= [comment_open, Whenever.cron(@options), comment_close].compact.join("\n") + "\n"
47
55
  end
48
56
 
49
57
  def read_crontab
@@ -53,7 +61,7 @@ module Whenever
53
61
  command << "-u #{@options[:user]}" if @options[:user]
54
62
 
55
63
  command_results = %x[#{command.join(' ')} 2> /dev/null]
56
- @current_crontab = $?.exitstatus.zero? ? command_results : ''
64
+ @current_crontab = $?.exitstatus.zero? ? prepare(command_results) : ''
57
65
  end
58
66
 
59
67
  def write_crontab(contents)
@@ -77,22 +85,28 @@ module Whenever
77
85
  end
78
86
  end
79
87
 
80
- def updated_crontab
88
+ def updated_crontab
81
89
  # Check for unopened or unclosed identifier blocks
82
- if read_crontab.index(comment_open) && !read_crontab.index(comment_close)
90
+ if read_crontab =~ Regexp.new("^#{comment_open}$") && (read_crontab =~ Regexp.new("^#{comment_close}$")).nil?
83
91
  warn "[fail] Unclosed indentifier; Your crontab file contains '#{comment_open}', but no '#{comment_close}'"
84
92
  exit(1)
85
- elsif !read_crontab.index(comment_open) && read_crontab.index(comment_close)
93
+ elsif (read_crontab =~ Regexp.new("^#{comment_open}$")).nil? && read_crontab =~ Regexp.new("^#{comment_close}$")
86
94
  warn "[fail] Unopened indentifier; Your crontab file contains '#{comment_close}', but no '#{comment_open}'"
87
95
  exit(1)
88
96
  end
89
97
 
90
98
  # If an existing identier block is found, replace it with the new cron entries
91
- if read_crontab.index(comment_open) && read_crontab.index(comment_close)
92
- read_crontab.gsub(Regexp.new("#{comment_open}.+#{comment_close}", Regexp::MULTILINE), whenever_cron.chomp)
99
+ if read_crontab =~ Regexp.new("^#{comment_open}$") && read_crontab =~ Regexp.new("^#{comment_close}$")
100
+ # If the existing crontab file contains backslashes they get lost going through gsub.
101
+ # .gsub('\\', '\\\\\\') preserves them. Go figure.
102
+ read_crontab.gsub(Regexp.new("^#{comment_open}$.+^#{comment_close}$", Regexp::MULTILINE), whenever_cron.chomp.gsub('\\', '\\\\\\'))
93
103
  else # Otherwise, append the new cron entries after any existing ones
94
104
  [read_crontab, whenever_cron].join("\n\n")
95
- end
105
+ end.gsub(/\n{3,}/, "\n\n") # More than two newlines becomes just two.
106
+ end
107
+
108
+ def prepare(contents)
109
+ contents.split("\n")[@options[:cut]..-1].join("\n")
96
110
  end
97
111
 
98
112
  def comment_base
@@ -1,15 +1,13 @@
1
1
  module Whenever
2
2
  module Output
3
-
4
3
  class Cron
5
4
 
6
5
  attr_accessor :time, :task
7
6
 
8
- def initialize(time = nil, task = nil, at = nil, output_redirection = nil)
7
+ def initialize(time = nil, task = nil, at = nil)
9
8
  @time = time
10
9
  @task = task
11
10
  @at = at.is_a?(String) ? (Chronic.parse(at) || 0) : (at || 0)
12
- @output_redirection = output_redirection
13
11
  end
14
12
 
15
13
  def self.enumerate(item)
@@ -25,13 +23,13 @@ module Whenever
25
23
  def self.output(times, job)
26
24
  enumerate(times).each do |time|
27
25
  enumerate(job.at).each do |at|
28
- yield new(time, job.output, at, job.output_redirection).output
26
+ yield new(time, job.output, at).output
29
27
  end
30
28
  end
31
29
  end
32
30
 
33
31
  def output
34
- [time_in_cron_syntax, task, output_redirection].compact.join(' ').strip
32
+ [time_in_cron_syntax, task].compact.join(' ').strip
35
33
  end
36
34
 
37
35
  def time_in_cron_syntax
@@ -41,10 +39,6 @@ module Whenever
41
39
  else parse_time
42
40
  end
43
41
  end
44
-
45
- def output_redirection
46
- OutputRedirection.new(@output_redirection).to_s unless @output_redirection == :not_set
47
- end
48
42
 
49
43
  protected
50
44
 
@@ -60,7 +54,7 @@ module Whenever
60
54
  end
61
55
 
62
56
  if shortcut
63
- if @at.is_a?(Time) || (@at.is_a?(Numeric) && @at>0)
57
+ if @at.is_a?(Time) || (@at.is_a?(Numeric) && @at > 0)
64
58
  raise ArgumentError, "You cannot specify an ':at' when using the shortcuts for times."
65
59
  else
66
60
  return shortcut
@@ -134,6 +128,5 @@ module Whenever
134
128
  end
135
129
 
136
130
  end
137
-
138
131
  end
139
132
  end
data/lib/whenever/job.rb CHANGED
@@ -1,22 +1,47 @@
1
1
  module Whenever
2
2
  class Job
3
3
 
4
- attr_accessor :at, :output_redirection
4
+ attr_reader :at
5
5
 
6
6
  def initialize(options = {})
7
7
  @options = options
8
-
9
- @at = options[:at]
10
- @output_redirection = options.has_key?(:output) ? options[:output] : :not_set
8
+ @at = options.delete(:at)
9
+ @template = options.delete(:template)
10
+ @job_template = options.delete(:job_template) || ":job"
11
+ @options[:output] = Whenever::Output::Redirection.new(options[:output]).to_s if options.has_key?(:output)
11
12
  @options[:environment] ||= :production
12
13
  @options[:path] ||= Whenever.path
13
14
  end
14
15
 
15
16
  def output
16
- @options[:template].gsub(/:\w+/) do |key|
17
- @options[key.sub(':', '').to_sym]
17
+ job = process_template(@template, @options).strip
18
+ process_template(@job_template, { :job => job }).strip
19
+ end
20
+
21
+ protected
22
+
23
+ def process_template(template, options)
24
+ template.gsub(/:\w+/) do |key|
25
+ before_and_after = [$`[-1..-1], $'[0..0]]
26
+ option = options[key.sub(':', '').to_sym]
27
+
28
+ if before_and_after.all? { |c| c == "'" }
29
+ escape_single_quotes(option)
30
+ elsif before_and_after.all? { |c| c == '"' }
31
+ escape_double_quotes(option)
32
+ else
33
+ option
34
+ end
18
35
  end
19
36
  end
37
+
38
+ def escape_single_quotes(str)
39
+ str.gsub(/'/) { "'\\''" }
40
+ end
41
+
42
+ def escape_double_quotes(str)
43
+ str.gsub(/"/) { '\"' }
44
+ end
20
45
 
21
46
  end
22
- end
47
+ end
@@ -2,7 +2,7 @@ module Whenever
2
2
  class JobList
3
3
 
4
4
  def initialize(options)
5
- @jobs, @env, @set_variables = {}, {}, {}
5
+ @jobs, @env, @set_variables, @pre_set_variables = {}, {}, {}, {}
6
6
 
7
7
  case options
8
8
  when String
@@ -16,16 +16,14 @@ module Whenever
16
16
  pre_set(options[:set])
17
17
  end
18
18
 
19
- # Load all job type files.
20
- Dir["#{File.expand_path(File.dirname(__FILE__))}/job_types/*.rb"].each do |file|
21
- eval(File.read(file))
22
- end
19
+ setup = File.read("#{File.expand_path(File.dirname(__FILE__))}/setup.rb")
23
20
 
24
- eval(config)
21
+ eval(setup + config)
25
22
  end
26
23
 
27
24
  def set(variable, value)
28
- return if instance_variable_defined?("@#{variable}".to_sym)
25
+ variable = variable.to_sym
26
+ return if @pre_set_variables[variable]
29
27
 
30
28
  instance_variable_set("@#{variable}".to_sym, value)
31
29
  self.class.send(:attr_reader, variable.to_sym)
@@ -59,9 +57,7 @@ module Whenever
59
57
  end
60
58
  end
61
59
 
62
- def generate_cron_output
63
- set_path_environment_variable
64
-
60
+ def generate_cron_output
65
61
  [environment_variables, cron_jobs].compact.join
66
62
  end
67
63
 
@@ -79,22 +75,13 @@ module Whenever
79
75
  pairs.each do |pair|
80
76
  next unless pair.index('=')
81
77
  variable, value = *pair.split('=')
82
- set(variable.strip.to_sym, value.strip) unless variable.blank? || value.blank?
78
+ unless variable.blank? || value.blank?
79
+ variable = variable.strip.to_sym
80
+ set(variable, value.strip)
81
+ @pre_set_variables[variable] = value
82
+ end
83
83
  end
84
84
  end
85
-
86
- def set_path_environment_variable
87
- return if path_should_not_be_set_automatically?
88
- @env[:PATH] = read_path unless read_path.blank?
89
- end
90
-
91
- def read_path
92
- ENV['PATH'] if ENV
93
- end
94
-
95
- def path_should_not_be_set_automatically?
96
- @set_path_automatically === false || @env[:PATH] || @env["PATH"]
97
- end
98
85
 
99
86
  def environment_variables
100
87
  return if @env.empty?