whenever-benlangfeld 0.9.5

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 66a0e3268620d29c398978993a97da442409fb3e
+  data.tar.gz: 333e726d5ebc84bc6d1d8eb995698428b60df301
+SHA512:
+  metadata.gz: c048fe6258fb797dd108f0cb81e3c2bedf9ea9393b775c7446e9eeecb8d9b84c41fdd8f5756392c9333f0f6b589cf059adb9ec79182029fb0200cdd11430c5bf
+  data.tar.gz: 6c64d46e05f4755b36f6ad0da8d2e23d17182a5011280101caa323639072ba1092c6c442243734adb4944d62453262864104fa65e8979c3910e85a4d1101124a

data/.gitignore

@@ -0,0 +1,6 @@
+.DS_Store
+pkg
+doc
+.*.sw[a-z]
+Gemfile.lock
+gemfiles/*.lock

data/.travis.yml

@@ -0,0 +1,18 @@
+language: ruby
+script: bundle exec rake
+
+before_install:
+  - gem install bundler
+
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - 2.1.0
+  - 2.2.0
+  - 2.3.0
+  - jruby
+
+gemfile:
+  - Gemfile
+  - gemfiles/activesupport4.1.gemfile
+  - gemfiles/activesupport4.2.gemfile

data/CHANGELOG.md

@@ -0,0 +1,333 @@
+### develop
+
+### 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
+
+* Fix Capistrano host options. [Igor Yamolov, Wes Morgan]
+
+* Improve JRuby test support. [Igor Yamolov]
+
+* Use correct release path in Cap task. [Wes Morgan]
+
+
+### 0.8.1 / December 22nd, 2012
+
+* Fix multiserver roles bug. [Wes Morgan]
+
+* Refactor Cap recipes and add tests for them. [Wes Morgan]
+
+* Fix file not found error when running under JRuby. [Wes Morgan]
+
+* Stop interpolating template attributes with no corresponding value. [Vincent Boisard]
+
+* Support for raw cron separated by tabs. [Étienne Barrié]
+
+
+### 0.8.0 / November 8th, 2012
+
+* Separate Capistrano recipes to allow custom execution. [Bogdan Gusiev]
+
+* Execute `whenever:update_crontab` before `deploy:finalize_update`, not `deploy:restart`. [Michal Wrobel]
+
+* Added a new `script` job type. [Ján Suchal]
+
+* Use correct path in Cap task. [Alex Dean]
+
+* Fix that setup.rb and schedule.rb were eval'd together. [Niklas H]
+
+* New Capistrano roles feature. [Wes Morgan]
+
+* Stop clearing the crontab during a deploy. [Javan Makhmali]
+
+* Bump Chronic gem dependency. [rainchen]
+
+
+### 0.7.3 / February 23rd, 2012
+
+* Make included Capistrano task compatible with both new and old versions of Cap. [Giacomo Macrì]
+
+
+### 0.7.2 / December 23rd, 2011
+
+* Accept @reboot and friends as raw cron syntax. [Felix Buenemann]
+
+* Fix clear_crontab task so it will work both standalone and during deploy. [Justin Giancola]
+
+
+### 0.7.1 / December 19th, 2011
+
+* Require thread before active_support for compatibility with Rails < 2.3.11 and RubyGems >= 1.6.0. [Micah Geisel]
+
+* More advanced role filtering in Cap task. [Brad Gessler]
+
+* Added whenever_variables as a configuration variable in Cap task. [Steve Agalloco]
+
+* Escape percent signs and reject newlines in jobs. [Amir Yalon]
+
+* Escape paths so spaces don't trip up cron. [Javan Makhmali]
+
+* Fix ambiguous handling of 1.month with :at. #99 [Javan Makhmali]
+
+
+### 0.7.0 / September 2nd, 2011
+
+* Use mojombo's chronic, it's active again. [Javan Makhmali]
+
+* Capistrano task enhancements. [Chris Griego]
+
+* wheneverize command defaults to '.' directory. [Andrew Nesbitt]
+
+* rake job_type uses bundler if detected. [Michał Szajbe]
+
+* Indicate filename in exceptions stemming from schedule file. [Javan Makhmali]
+
+* Don't require rubygems, bundler where possible. [Oleg Pudeyev]
+
+* Documentation and code cleanup. [many nice people]
+
+
+### 0.6.8 / May 24th, 2011
+
+* Convert most shortcuts to seconds. every :day -> every 1.day. #129 [Javan Makhmali]
+
+* Allow commas in raw cron syntax. #130 [Marco Bergantin, Javan Makhmali]
+
+* Output no update message as comments. #135 [Javan Makhmali]
+
+* require 'thread' to support Rubygems >= 1.6.0. #132 [Javan Makhmali]
+
+
+### 0.6.7 / March 23rd, 2011
+
+* Fix issue with comment block being corrupted during subsequent insertion of duplicate entries to the crontab. #123 [Jeremy (@lingmann)]
+
+* Removed -i from default job template. #118 [Javan Makhmali]
+
+
+### 0.6.6 / March 8th, 2011
+
+* Fix unclosed identifier bug. #119 [Javan Makhmali]
+
+
+### 0.6.5 / March 8th, 2011
+
+* Preserve whitespace at the end of crontab file. #95 [Rich Meyers]
+
+* Setting nil or blank environment variables now properly formats output. [T.J. VanSlyke]
+
+* Allow raw cron sytax, added -i to bash job template, general cleanup. [Javan Makhmali]
+
+
+### 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/Gemfile

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

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2016 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/README.md

@@ -0,0 +1,260 @@
+Whenever is a Ruby gem that provides a clear syntax for writing and deploying cron jobs.
+
+### Installation
+
+```sh
+$ gem install whenever
+```
+
+Or with Bundler in your Gemfile.
+
+```ruby
+gem 'whenever', :require => false
+```
+
+### Getting started
+
+```sh
+$ cd /apps/my-great-project
+$ wheneverize .
+```
+
+This will create an initial `config/schedule.rb` file for you.
+
+### 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
+```
+
+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, selecting a user as which to install the crontab, etc.
+
+### Example schedule.rb file
+
+```ruby
+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
+
+every '0 0 27-31 * *' do
+  command "echo 'you can use raw cron syntax too'"
+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
+  rake "app_server:task"
+end
+```
+
+### 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:
+
+```ruby
+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:
+
+```ruby
+job_type :command, ":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_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>
+
+You can change this by setting your own `:job_template`.
+
+```ruby
+set :job_template, "bash -l -c ':job'"
+```
+
+Or set the job_template to nil to have your jobs execute normally.
+
+```ruby
+set :job_template, nil
+```
+
+### Capistrano integration
+
+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:
+
+```ruby
+require "whenever/capistrano"
+```
+
+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
+set :whenever_command, "bundle exec whenever"
+require "whenever/capistrano"
+```
+
+If you are using different environments (such as staging, production), then you may want to do this:
+
+```ruby
+set :whenever_environment, defer { stage }
+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:
+
+```ruby
+set :whenever_environment, defer { stage }
+set :whenever_identifier, defer { "#{application}_#{stage}" }
+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
+optional and backwards-compatible. If you don't need different jobs running on
+different servers in your capistrano deployment, then you can safely stop reading
+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]).
+
+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
+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
+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:
+
+```ruby
+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
+jobs in schedule.rb:
+
+```ruby
+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
+  rake 'db:task' # will only be added to crontabs of :db servers
+end
+
+every :day, :at => '12:02am' do
+  command "run_this_everywhere" # will be deployed to :db and :app servers
+end
+```
+
+Here are the basic rules:
+
+  1. If a server's role isn't listed in whenever_roles, it will *never* have jobs
+     added to its crontab.
+  1. If a server's role is listed in the whenever_roles, then it will have all
+     jobs added to its crontab that either list that role in their :roles arg or
+     that don't have a :roles arg.
+  1. If a job has a :roles arg but that role isn't in the whenever_roles list,
+     that job *will not* be deployed to any server.
+
+### RVM Integration
+
+If your production environment uses RVM (Ruby Version Manager) you will run into a gotcha that causes your cron jobs to hang.  This is not directly related to Whenever, and can be tricky to debug.  Your .rvmrc files must be trusted or else the cron jobs will hang waiting for the file to be trusted.  A solution is to disable the prompt by adding this line to your user rvm file in `~/.rvmrc`
+
+`rvm_trust_rvmrcs_flag=1`
+
+This tells rvm to trust all rvmrc files.
+
+### Heroku?
+
+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
+
+[whenever-test](https://github.com/heartbits/whenever-test) is an extension to Whenever for testing a Whenever schedule.
+
+### Credit
+
+Whenever was created for use at Inkling (<http://inklingmarkets.com>). 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.
+
+----
+
+[![Build Status](https://secure.travis-ci.org/javan/whenever.png)](http://travis-ci.org/javan/whenever)
+
+----
+
+Copyright &copy; 2016 Javan Makhmali