whenever 0.8.2 → 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: dc5ff14e6e9d357583f5e20d31fafbcf2dfe3aea8ac756cf9103f51504674e9a
+  data.tar.gz: 446e8398b741a1a9a7ee262b3542efb107d1453259083fef03ea50726227d7dd
+SHA512:
+  metadata.gz: 41f396515f594a4726bd9048783653b0b203e0beb4ea65f6b95faf508061d0fd064bec0a31bbcf6dad6a23f68ec4f3364ae6e8f160eb0539ec6073a6c4960242
+  data.tar.gz: 4fbe2b52fc350ee272d7d03638369b8a6443c1ed6e122be511b9ccf07881c1e559d63587153259343febc89db40aa45bc4ca45cf83af885fd618fd5668ddd1d2

data/.gitignore

@@ -3,3 +3,4 @@ pkg
 doc
 .*.sw[a-z]
 Gemfile.lock
+gemfiles/*.lock

data/.travis.yml

@@ -1,8 +1,21 @@
+language: ruby
+
+before_install:
+  - gem install bundler
+  - unset _JAVA_OPTIONS
 rvm:
-  - 1.8.7
-  - 1.9.2
-  - 1.9.3
-  - ree
-  - jruby
-  - jruby-18mode
-  - jruby-19mode
+  - 2.4.6
+  - 2.5.5
+  - 2.6.3
+  - jruby-9.2.6.0
+
+gemfile:
+  - gemfiles/activesupport4.1.gemfile
+  - gemfiles/activesupport4.2.gemfile
+  - gemfiles/activesupport5.0.gemfile
+  - gemfiles/activesupport5.1.gemfile
+  - gemfiles/activesupport5.2.gemfile
+
+env:
+  global:
+    - JRUBY_OPTS=--debug

data/Appraisals

@@ -0,0 +1,19 @@
+appraise 'activesupport4.1' do
+  gem "activesupport", "~> 4.1.0"
+end
+
+appraise 'activesupport4.2' do
+  gem "activesupport", "~> 4.2.0"
+end
+
+appraise 'activesupport5.0' do
+  gem "activesupport", "~> 5.0.0"
+end
+
+appraise 'activesupport5.1' do
+  gem "activesupport", "~> 5.1.0"
+end
+
+appraise 'activesupport5.2' do
+  gem "activesupport", "~> 5.2.0beta2"
+end

data/CHANGELOG.md

@@ -1,6 +1,119 @@
-### 0.9.0 (unreleased)
+### unreleased
 
-* Time zone support
+### 1.0.0 / Jun 13, 2019
+
+* First stable release per SemVer.
+
+* Removes support for versions of Ruby which are no longer supported by the Ruby project.
+
+### 0.11.0 / April 23, 2019
+
+* Add support for mapping Range objects to cron range syntax [Tim Craft](https://github.com/javan/whenever/pull/725)
+
+* Bugfix: Avoid modifying Capistrano `default_env` when setting the whenever environment. [ta1kt0me](https://github.com/javan/whenever/pull/728)
+
+* Enable to execute whenever's task independently without setting :release_path or :whenever_path [ta1kt0me](https://github.com/javan/whenever/pull/729)
+
+* Make error message clearer when parsing cron syntax fails due to a trailing space [ignisf](https://github.com/javan/whenever/pull/744)
+
+### 0.10.0 / November 19, 2017
+
+* Modify wheneverize to allow for the creating of 'config' directory when not present
+
+* Add --crontab-command to whenever binary for overriding the crontab command. [Martin Grandrath]
+
+* Allow setting the path within which Capistrano will execute whenever. [Samuel Johnson](https://github.com/javan/whenever/pull/619)
+
+* Allow the use of string literals for month and day-of-week in raw cron syntax.. [Potamianos Gregory](https://github.com/javan/whenever/pull/711)
+
+* Include Capistrano default environment variables when executing Whenever. [Karl Li](https://github.com/javan/whenever/pull/719)
+
+* Allow configuring an alternative schedule file in Capistrano. [Shinichi Okamoto](https://github.com/javan/whenever/pull/666)
+
+* Add customizing email recipient option with the MAILTO environment variable. [Chikahiro Tokoro](https://github.com/javan/whenever/pull/678)
+
+### 0.9.7 / June 14, 2016
+
+* Restore compatibility with Capistrano v3; it has a bug which we have to work around [Ben Langfeld, Chris Gunther, Shohei Yamasaki]
+
+### 0.9.6 / June 13, 2016
+
+* Bypass symlinks when loading Capistrano v3 code, since these symlinks don't work in recent gem releases [Justin Ramos]
+
+### 0.9.5 / June 12, 2016
+
+* Improve documentation [Ben Langfeld, Spencer Fry]
+
+* Properly support Solaris / SmartOS [Steven Williamson]
+
+* Drop support for Ruby < 1.9.3. Test newer Ruby versions. [Javan Makhmali, Bartłomiej Kozal]
+
+* Suport Ruby 2.3.0 and Rails 4 [Vincent Boisard]
+
+* Set `RAILS_ENV` correctly in schedule when writing crontab from Capistrano [Ben Langfeld, Lorenzo Manacorda]
+
+* Minor refactoring, avoidance of Ruby warnings, etc [Ben Langfeld, DV Dasari]
+
+* Correctly pass through date expressions (e.g. `1.day`) inside job definitions [Rafael Sales]
+
+* Prevent writing invalid cron strings [Danny Fallon, Ben Langfeld]
+
+* Execute runner with `bundle exec` to ensure presence of app dependencies [Judith Roth]
+
+
+### 0.9.4 / October 24, 2014
+
+* Fix duplicated command line arguments when deploying to multiple servers with Cap 3. [betesh]
+
+* Set `whenever_environment` to the current stage before defaulting to production in Cap 3 tasks. [Karthik T]
+
+
+### 0.9.3 / October 5, 2014
+
+* Drop ActiveSupport dependency [James Healy, Javan Makhmali]
+
+* Drop shoulda for tests
+
+* Fix `whenever:clear_crontab` Cap 3 task [Javan Makhmali]
+
+* Avoid using tempfiles [ahoward]
+
+
+### 0.9.2 / March 4, 2014
+
+* Fix issues generating arguments for `execute` in Capistrano 3 tasks. [Javan Makhmali]
+
+
+### 0.9.1 / March 2, 2014
+
+* Pass `--roles` option to `whenever` in Capistrano 3 tasks. [betesh, Javan Makhmali]
+
+* Allow setting `:whenever_command` for Capistrano 3. [Javan Makhmali]
+
+* Allow `:whenever` command to be mapped in SSHKit. [Javan Makhmali]
+
+
+### 0.9.0 / December 17, 2013
+
+* Capistrano V3 support. [Philip Hallstrom]
+
+* Process params in job templates. [Austin Ziegler]
+
+
+### 0.8.4 / July 22, 2012
+
+* Don't require schedule file when clearing. [Javan Makhmali]
+
+* Use bin/rails when available. [Javan Makhmali]
+
+
+### 0.8.3 / July 11, 2013
+
+* Improve Cap rollback logic. [Jeroen Jacobs]
+
+* Allow configuration of the environment variable. [andfx]
+
+* Output option can be a callable Proc. [Li Xiao]
 
 
 ### 0.8.2 / January 10, 2013
@@ -257,4 +370,4 @@
 
 ### 0.1.0 / February 15th, 2009
 
-* Initial release [Javan Makhmali]
+* Initial release [Javan Makhmali]

data/Gemfile

@@ -1,4 +1,4 @@
-source "http://rubygems.org"
+source "https://rubygems.org"
 
-# Specify your gem's dependencies in newever.gemspec
-gemspec
+# Specify your gem's dependencies in whenever.gemspec
+gemspec

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2012 Javan Makhmali
+Copyright (c) 2017 Javan Makhmali
 
 Permission is hereby granted, free of charge, to any person
 obtaining a copy of this software and associated documentation
@@ -19,4 +19,4 @@ 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.
+OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -9,7 +9,7 @@ $ gem install whenever
 Or with Bundler in your Gemfile.
 
 ```ruby
-gem 'whenever', :require => false
+gem 'whenever', require: false
 ```
 
 ### Getting started
@@ -19,26 +19,54 @@ $ cd /apps/my-great-project
 $ wheneverize .
 ```
 
-This will create an initial `config/schedule.rb` file for you.
+This will create an initial `config/schedule.rb` file for you (as long as the config folder is already present in your project).
+
+### The `whenever` command
+
+```sh
+$ cd /apps/my-great-project
+$ whenever
+```
+
+This will simply show you your `schedule.rb` file converted to cron syntax. It does not read or write your crontab file; you'll need to do this in order for your jobs to execute:
+
+```sh
+$ whenever --update-crontab
+```
+
+Other commonly used options include:
+```sh
+$ whenever --user app # set a user as which to install the crontab
+$ whenever --load-file config/my_schedule.rb # set the schedule file
+$ whenever --crontab-command 'sudo crontab' # override the crontab command
+```
+
+You can list installed cron jobs using `crontab -l`.
+
+Run `whenever --help` for a complete list of options for selecting the schedule to use, setting variables in the schedule, etc.
 
 ### Example schedule.rb file
 
 ```ruby
-every 3.hours do
+every 3.hours do # 1.minute 1.day 1.week 1.month 1.year is also supported
   runner "MyModel.some_process"
   rake "my:rake:task"
   command "/usr/bin/my_great_command"
 end
 
-every 1.day, :at => '4:30 am' do
+every 1.day, at: '4:30 am' do
   runner "MyModel.task_to_run_at_four_thirty_in_the_morning"
 end
 
+every 1.day, at: ['4:30 am', '6:00 pm'] do
+  runner "Mymodel.task_to_run_in_two_times_every_day"
+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
+every :sunday, at: '12pm' do # Use any day of the week or :weekend, :weekday
   runner "Task.do_something_great"
 end
 
@@ -48,7 +76,7 @@ end
 
 # run this task only on servers with the :app role in Capistrano
 # see Capistrano roles section below
-every :day, :at => '12:20am', :roles => [:app] do
+every :day, at: '12:20am', roles: [:app] do
   rake "app_server:task"
 end
 ```
@@ -63,7 +91,7 @@ For example:
 job_type :awesome, '/usr/local/bin/awesome :task :fun_level'
 
 every 2.hours do
-  awesome "party", :fun_level => "extreme"
+  awesome "party", fun_level: "extreme"
 end
 ```
 
@@ -73,14 +101,14 @@ The default job types that ship with Whenever are defined like so:
 
 ```ruby
 job_type :command, ":task :output"
-job_type :rake,    "cd :path && RAILS_ENV=:environment bundle exec rake :task --silent :output"
-job_type :runner,  "cd :path && script/rails runner -e :environment ':task' :output"
-job_type :script,  "cd :path && RAILS_ENV=:environment bundle exec script/:task :output"
+job_type :rake,    "cd :path && :environment_variable=:environment bundle exec rake :task --silent :output"
+job_type :runner,  "cd :path && bin/rails runner -e :environment ':task' :output"
+job_type :script,  "cd :path && :environment_variable=:environment bundle exec script/:task :output"
 ```
 
 Pre-Rails 3 apps and apps that don't use Bundler will redefine the `rake` and `runner` jobs respectively to function correctly.
 
-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>
+If a `:path` is not set it will default to the directory in which `whenever` was executed. `:environment_variable` will default to 'RAILS_ENV'. `: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>
 
@@ -96,9 +124,60 @@ Or set the job_template to nil to have your jobs execute normally.
 set :job_template, nil
 ```
 
+### Parsing dates and times
+
+Whenever uses the [Chronic](https://github.com/mojombo/chronic) gem to parse the specified dates and times.
+
+You can set your custom Chronic configuration if the defaults don't fit you.
+
+For example, to assume a 24 hour clock instead of the default 12 hour clock:
+
+```ruby
+set :chronic_options, hours24: true
+
+# By default this would run the job every day at 3am
+every 1.day, at: '3:00' do
+  runner "MyModel.nightly_archive_job"
+end
+```
+
+You can see a list of all available options here: <https://github.com/mojombo/chronic/blob/master/lib/chronic/parser.rb>
+
+### Customize email recipient with the `MAILTO` environment variable
+
+Output from the jobs is sent to the email address configured in the `MAILTO` environment variable.
+
+There are many ways to further configure the recipient.
+
+Example: A global configuration, overriding the environment's value:
+
+```ruby
+env 'MAILTO', 'output_of_cron@example.com'
+
+every 3.hours do
+  command "/usr/bin/my_great_command"
+end
+```
+
+Example: A `MAILTO` configured for all the jobs in an interval block:
+
+```ruby
+every 3.hours, mailto: 'my_super_command@example.com'  do
+  command "/usr/bin/my_super_command"
+end
+```
+
+Example: A `MAILTO` configured for a single job:
+
+```ruby
+every 3.hours do
+  command "/usr/bin/my_super_command", mailto: 'my_super_command_output@example.com'
+end
+```
+
 ### Capistrano integration
 
-Use the built-in Capistrano recipe for easy crontab updates with deploys.
+Use the built-in Capistrano recipe for easy crontab updates with deploys. For Capistrano V3, see the next section.
 
 In your "config/deploy.rb" file:
 
@@ -106,7 +185,7 @@ 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/recipes.rb>
+Take a look at the recipe for options you can set. <https://github.com/javan/whenever/blob/master/lib/whenever/capistrano/v2/recipes.rb>
 For example, if you're using bundler do this:
 
 ```ruby
@@ -123,7 +202,7 @@ require "whenever/capistrano"
 
 The capistrano variable `:stage` should be the one holding your environment name. This will make the correct `:environment` available in your `schedule.rb`.
 
-If both your environments are on the same server you'll want to namespace them or they'll overwrite each other when you deploy:
+If both your environments are on the same server you'll want to namespace them, or they'll overwrite each other when you deploy:
 
 ```ruby
 set :whenever_environment, defer { stage }
@@ -131,6 +210,29 @@ set :whenever_identifier, defer { "#{application}_#{stage}" }
 require "whenever/capistrano"
 ```
 
+If you use a schedule at an alternative path, you may configure it like so:
+
+```ruby
+set :whenever_load_file, defer { "#{release_path}/somewhere/else/schedule.rb" }
+require "whenever/capistrano"
+```
+
+### Capistrano V3 Integration
+
+In your "Capfile" file:
+
+```ruby
+require "whenever/capistrano"
+```
+
+Take a look at the [load:defaults task](https://github.com/javan/whenever/blob/master/lib/whenever/capistrano/v3/tasks/whenever.rake) (bottom of file) for options you can set. For example, to namespace the crontab entries by application and stage do this in your "config/deploy.rb" file:
+
+```ruby
+set :whenever_identifier, ->{ "#{fetch(:application)}_#{fetch(:stage)}" }
+```
+
+The Capistrano integration by default expects the `:application` variable to be set in order to scope jobs in the crontab.
+
 ### Capistrano roles
 
 The first thing to know about the new roles support is that it is entirely
@@ -139,10 +241,10 @@ different servers in your capistrano deployment, then you can safely stop readin
 now and everything should just work the same way it always has.
 
 When you define a job in your schedule.rb file, by default it will be deployed to
-all servers in the whenever_roles list (which defaults to [:db]).
+all servers in the whenever_roles list (which defaults to `[:db]`).
 
 However, if you want to restrict certain jobs to only run on subset of servers,
-you can add a :roles => [...] argument to their definitions. **Make sure to add
+you can add a `roles: [...]` argument to their definitions. **Make sure to add
 that role to the whenever_roles list in your deploy.rb.**
 
 When you run `cap deploy`, jobs with a :roles list specified will only be added to
@@ -151,28 +253,28 @@ the crontabs on servers with one or more of the roles in that list.
 Jobs with no :roles argument will be deployed to all servers in the whenever_roles
 list. This is to maintain backward compatibility with previous releases of whenever.
 
-So, for example, with the default whenever_roles of [:db], a job like this would be
-deployed to all servers with the :db role:
+So, for example, with the default whenever_roles of `[:db]`, a job like this would be
+deployed to all servers with the `:db` role:
 
 ```ruby
-every :day, :at => '12:20am' do
+every :day, at: '12:20am' do
   rake 'foo:bar'
 end
 ```
 
-If we set whenever_roles to [:db, :app] in deploy.rb, and have the following
+If we set whenever_roles to `[:db, :app]` in deploy.rb, and have the following
 jobs in schedule.rb:
 
 ```ruby
-every :day, :at => '1:37pm', :roles => [:app] do
+every :day, at: '1:37pm', roles: [:app] do
   rake 'app:task' # will only be added to crontabs of :app servers
 end
 
-every :hour, :roles => [:db] do
+every :hour, roles: [:db] do
   rake 'db:task' # will only be added to crontabs of :db servers
 end
 
-every :day, :at => '12:02am' do
+every :day, at: '12:02am' do
   command "run_this_everywhere" # will be deployed to :db and :app servers
 end
 ```
@@ -193,16 +295,15 @@ If your production environment uses RVM (Ruby Version Manager) you will run into
 
 `rvm_trust_rvmrcs_flag=1`
 
-This tells rvm to trust all rvmrc files, which is documented here: http://wayneeseguin.beginrescueend.com/2010/08/22/ruby-environment-version-manager-rvm-1-0-0/
+This tells rvm to trust all rvmrc files.
 
-### The `whenever` command
+### Heroku?
 
-```sh
-$ cd /apps/my-great-project
-$ whenever
-```
+No. Heroku does not support cron, instead providing [Heroku Scheduler](https://devcenter.heroku.com/articles/scheduler). If you deploy to Heroku, you should use that rather than Whenever.
+
+### Testing
 
-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.
+[whenever-test](https://github.com/heartbits/whenever-test) is an extension to Whenever for testing a Whenever schedule.
 
 ### Credit
 
@@ -221,8 +322,8 @@ It's a little bit dated now, but remains a good introduction.
 
 ----
 
-Compatible with Ruby 1.8.7-1.9.3, JRuby, and Rubinius. [![Build Status](https://secure.travis-ci.org/javan/whenever.png)](http://travis-ci.org/javan/whenever)
+[![Build Status](https://secure.travis-ci.org/javan/whenever.svg)](http://travis-ci.org/javan/whenever)
 
 ----
 
-Copyright &copy; 2013 Javan Makhmali
+Copyright &copy; 2017 Javan Makhmali

data/Rakefile

@@ -1,17 +1,10 @@
-begin
-  require 'bundler'
-rescue LoadError => e
-  warn("warning: Could not load bundler: #{e}")
-  warn("         Some rake tasks will not be defined")
-else
-  Bundler::GemHelper.install_tasks
-end
-
+require 'bundler/gem_tasks'
 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 :default => :test
+task :default => :test

data/bin/whenever

@@ -35,6 +35,9 @@ OptionParser.new do |opts|
   opts.on('-r', '--roles [role1,role2]', 'Comma-separated list of server roles to generate cron jobs for') do |roles|
     options[:roles] = roles.split(',').map(&:to_sym) if roles
   end
+  opts.on('-x', '--crontab-command [command]', 'Default: crontab') do |crontab_command|
+    options[:crontab_command] = crontab_command if crontab_command
+  end
   opts.on('-v', '--version') { puts "Whenever v#{Whenever::VERSION}"; exit(0) }
 end.parse!
 

data/bin/wheneverize

@@ -18,7 +18,7 @@ OptionParser.new do |opts|
 end
 
 unless ARGV.empty?
-  if !File.exists?(ARGV.first)
+  if !File.exist?(ARGV.first)
     abort "`#{ARGV.first}' does not exist."
   elsif !File.directory?(ARGV.first)
     abort "`#{ARGV.first}' is not a directory."
@@ -54,13 +54,16 @@ file = 'config/schedule.rb'
 base = ARGV.empty? ? '.' : ARGV.shift
 
 file = File.join(base, file)
-if File.exists?(file)
+if File.exist?(file)
   warn "[skip] `#{file}' already exists"
-elsif File.exists?(file.downcase)
+elsif File.exist?(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
+  dir = File.dirname(file)
+  if !File.exist?(dir)
+    warn "[add] creating `#{dir}'"
+    FileUtils.mkdir_p(dir)
+  end
   puts "[add] writing `#{file}'"
   File.open(file, "w") { |f| f.write(content) }
 end

data/gemfiles/activesupport4.1.gemfile

@@ -0,0 +1,7 @@
+# This file was generated by Appraisal
+
+source "http://rubygems.org"
+
+gem "activesupport", "~> 4.1.0"
+
+gemspec path: "../"

data/gemfiles/activesupport4.2.gemfile

@@ -0,0 +1,7 @@
+# This file was generated by Appraisal
+
+source "http://rubygems.org"
+
+gem "activesupport", "~> 4.2.0"
+
+gemspec path: "../"

data/gemfiles/activesupport5.0.gemfile

@@ -0,0 +1,7 @@
+# This file was generated by Appraisal
+
+source "http://rubygems.org"
+
+gem "activesupport", "~> 5.0.0"
+
+gemspec path: "../"

data/gemfiles/activesupport5.1.gemfile

@@ -0,0 +1,7 @@
+# This file was generated by Appraisal
+
+source "http://rubygems.org"
+
+gem "activesupport", "~> 5.1.0"
+
+gemspec path: "../"

data/gemfiles/activesupport5.2.gemfile

@@ -0,0 +1,7 @@
+# This file was generated by Appraisal
+
+source "http://rubygems.org"
+
+gem "activesupport", "~> 5.2.0beta2"
+
+gemspec path: "../"

data/lib/whenever/capistrano/v2/hooks.rb

@@ -0,0 +1,8 @@
+require "whenever/capistrano/v2/recipes"
+
+Capistrano::Configuration.instance(:must_exist).load do
+  # Write the new cron jobs near the end.
+  before "deploy:finalize_update", "whenever:update_crontab"
+  # If anything goes wrong, undo.
+  after "deploy:rollback", "whenever:update_crontab"
+end