whenever 0.8.4 → 0.9.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c96bb55bfcc94c54bab65174a8fb046aa4bfcff1
-  data.tar.gz: fbce8b6cd1f6c8558e9281af9f6cbccade7dcd71
+  metadata.gz: 0615f43fa1b0a98f86c01020d35ae339a2767917
+  data.tar.gz: cb5c35a7f4703864be41ef4d5692092a190a8cd2
 SHA512:
-  metadata.gz: a23ed3067c55356fb7f98f18d267d508d410cbe63a9ea2dc1f3aaa491bfa6df03cf856ff315a2adb64290cab7fa9348ed486ac362afec8b35583d4efc251eef6
-  data.tar.gz: 3e79b8eba708dd80fa79fa8ba80a81205a889f196f6a5a00ee3cdfce82c669ef93e96a10c321cfb4c7cd7fe9addc1ca75860aaa5c082da6ed6400def6c42d575
+  metadata.gz: 3aefffaf5046d3501ff117d470281dad9eb079b11a979e2b810adf707f69d5dbdaffc2aac56aaed8b3125637742506e5e29129af5fc0163463e6eab42bacb416
+  data.tar.gz: f1e06eb27177312e775da44615de0fd79a9cb8ba331f7d525cb82c28d158a0731edf5981660339a4651712667dfd9dba4dc16e04bcb2be2b90a5826dc1dbed71

data/.travis.yml

@@ -1,8 +1,10 @@
+language: ruby
 rvm:
   - 1.8.7
   - 1.9.2
   - 1.9.3
   - 2.0.0
+  - 2.1.0
   - ree
   - jruby
   - jruby-18mode

data/CHANGELOG.md

@@ -1,6 +1,17 @@
-### 0.9.0 (unreleased)
+### 0.9.1 / March 2, 2014
 
-* Time zone support
+* 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

data/Gemfile

@@ -1,4 +1,9 @@
 source "http://rubygems.org"
 
-# Specify your gem's dependencies in newever.gemspec
-gemspec
+# Specify your gem's dependencies in whenever.gemspec
+gemspec
+
+if RUBY_VERSION < "1.9.3"
+  gem "activesupport", "< 4.0.0"
+  gem "shoulda-matchers", "<= 2.0.0"
+end

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2013 Javan Makhmali
+Copyright (c) 2014 Javan Makhmali
 
 Permission is hereby granted, free of charge, to any person
 obtaining a copy of this software and associated documentation

data/README.md

@@ -98,7 +98,7 @@ set :job_template, nil
 
 ### 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 +106,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
@@ -131,6 +131,20 @@ 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 (bottom of file) task for options you can set. <http://github.com/javan/whenever/blob/master/lib/whenever/tasks/whenever.rake>. For example, to namespace the crontab entries by application and stage do this.
+
+```ruby
+set :whenever_identifier, ->{ "#{fetch(:application)}_#{fetch(:stage)}" }
+```
+
 ### Capistrano roles
 
 The first thing to know about the new roles support is that it is entirely
@@ -193,7 +207,7 @@ 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
 
@@ -221,8 +235,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)
+Compatible with Ruby 1.8.7-2.1.0, JRuby, and Rubinius. [![Build Status](https://secure.travis-ci.org/javan/whenever.png)](http://travis-ci.org/javan/whenever)
 
 ----
 
-Copyright &copy; 2013 Javan Makhmali
+Copyright &copy; 2014 Javan Makhmali

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

data/lib/whenever/capistrano/{recipes.rb → v2/recipes.rb}

@@ -1,4 +1,4 @@
-require 'whenever/capistrano/support'
+require 'whenever/capistrano/v2/support'
 
 Capistrano::Configuration.instance(:must_exist).load do
   Whenever::CapistranoSupport.load_into(self)

data/lib/whenever/capistrano/v3/tasks/whenever.rake

@@ -0,0 +1,43 @@
+namespace :whenever do
+  def setup_whenever_task(*args, &block)
+    SSHKit.config.command_map[:whenever] = fetch(:whenever_command)
+
+    on roles fetch(:whenever_roles) do |host|
+      args = args + Array(yield(host)) if block_given?
+      within release_path do
+        with fetch(:whenever_command_environment_variables) do
+          execute :whenever, *args
+        end
+      end
+    end
+  end
+
+  desc "Update application's crontab entries using Whenever"
+  task :update_crontab do
+    setup_whenever_task do |host|
+      roles = host.roles_array.join(",")
+      [fetch(:whenever_update_flags),  "--roles=#{roles}"]
+    end
+  end
+
+  desc "Clear application's crontab entries using Whenever"
+  task :clear_crontab do
+    setup_whenever_task(fetch(:whenever_clear_flags))
+  end
+
+  after "deploy:updated",  "whenever:update_crontab"
+  after "deploy:reverted", "whenever:update_crontab"
+end
+
+namespace :load do
+  task :defaults do
+    set :whenever_roles,        ->{ :db }
+    set :whenever_command,      ->{ "bundle exec whenever" }
+    set :whenever_command_environment_variables, ->{ {} }
+    set :whenever_identifier,   ->{ fetch :application }
+    set :whenever_environment,  ->{ fetch :rails_env, "production" }
+    set :whenever_variables,    ->{ "environment=#{fetch :whenever_environment}" }
+    set :whenever_update_flags, ->{ "--update-crontab #{fetch :whenever_identifier} --set #{fetch :whenever_variables}" }
+    set :whenever_clear_flags,  ->{ "--clear-crontab #{fetch :whenever_identifier}" }
+  end
+end

data/lib/whenever/capistrano.rb

@@ -1,8 +1,7 @@
-require "whenever/capistrano/recipes"
+require 'capistrano/version'
 
-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"
+if defined?(Capistrano::VERSION) && Gem::Version.new(Capistrano::VERSION).release >= Gem::Version.new('3.0.0')
+  load File.expand_path("../tasks/whenever.rake", __FILE__)
+else
+  require 'whenever/capistrano/v2/hooks'
 end

data/lib/whenever/job.rb

@@ -17,11 +17,8 @@ module Whenever
     end
 
     def output
-      job = process_template(@template, @options).strip
-      out = process_template(@job_template, { :job => job }).strip
-      if out =~ /\n/
-        raise ArgumentError, "Task contains newline"
-      end
+      job = process_template(@template, @options)
+      out = process_template(@job_template, @options.merge(:job => job))
       out.gsub(/%/, '\%')
     end
 
@@ -43,7 +40,7 @@ module Whenever
         else
           option
         end
-      end
+      end.squish
     end
 
     def escape_single_quotes(str)

data/lib/whenever/setup.rb

@@ -9,20 +9,7 @@ set :path, Whenever.path
 # http://blog.scoutapp.com/articles/2010/09/07/rvm-and-cron-in-production
 set :job_template, "/bin/bash -l -c ':job'"
 
-job_type :command, ":task :output"
-
-# Run rake through bundler if possible
-if Whenever.bundler?
-  job_type :rake, "cd :path && :environment_variable=:environment bundle exec rake :task --silent :output"
-  job_type :script, "cd :path && :environment_variable=:environment bundle exec script/:task :output"
-else
-  job_type :rake, "cd :path && :environment_variable=:environment rake :task --silent :output"
-  job_type :script, "cd :path && :environment_variable=:environment script/:task :output"
-end
-
-# Create a runner job that's appropriate for the Rails version
-def runner_for_app
-  case
+set :runner_command, case
   when Whenever.bin_rails?
     "bin/rails runner"
   when Whenever.script_rails?
@@ -30,6 +17,10 @@ def runner_for_app
   else
     "script/runner"
   end
-end
 
-job_type :runner, "cd :path && #{runner_for_app} -e :environment ':task' :output"
+set :bundle_command, Whenever.bundler? ? "bundle exec" : ""
+
+job_type :command, ":task :output"
+job_type :rake,    "cd :path && :environment_variable=:environment :bundle_command rake :task --silent :output"
+job_type :script,  "cd :path && :environment_variable=:environment :bundle_command script/:task :output"
+job_type :runner,  "cd :path && :runner_command -e :environment ':task' :output"

data/lib/whenever/tasks/whenever.rake

@@ -0,0 +1,43 @@
+namespace :whenever do
+  def setup_whenever_task(*args, &block)
+    SSHKit.config.command_map[:whenever] = fetch(:whenever_command)
+
+    on roles fetch(:whenever_roles) do |host|
+      args = args + Array(yield(host)) if block_given?
+      within release_path do
+        with fetch(:whenever_command_environment_variables) do
+          execute :whenever, *args
+        end
+      end
+    end
+  end
+
+  desc "Update application's crontab entries using Whenever"
+  task :update_crontab do
+    setup_whenever_task do |host|
+      roles = host.roles_array.join(",")
+      [fetch(:whenever_update_flags),  "--roles=#{roles}"]
+    end
+  end
+
+  desc "Clear application's crontab entries using Whenever"
+  task :clear_crontab do
+    setup_whenever_task(fetch(:whenever_clear_flags))
+  end
+
+  after "deploy:updated",  "whenever:update_crontab"
+  after "deploy:reverted", "whenever:update_crontab"
+end
+
+namespace :load do
+  task :defaults do
+    set :whenever_roles,        ->{ :db }
+    set :whenever_command,      ->{ "bundle exec whenever" }
+    set :whenever_command_environment_variables, ->{ {} }
+    set :whenever_identifier,   ->{ fetch :application }
+    set :whenever_environment,  ->{ fetch :rails_env, "production" }
+    set :whenever_variables,    ->{ "environment=#{fetch :whenever_environment}" }
+    set :whenever_update_flags, ->{ "--update-crontab #{fetch :whenever_identifier} --set #{fetch :whenever_variables}" }
+    set :whenever_clear_flags,  ->{ "--clear-crontab #{fetch :whenever_identifier}" }
+  end
+end

data/lib/whenever/version.rb

@@ -1,3 +1,3 @@
 module Whenever
-  VERSION = '0.8.4'
+  VERSION = '0.9.1'
 end

data/test/functional/output_default_defined_jobs_test.rb

@@ -35,6 +35,24 @@ class OutputDefaultDefinedJobsTest < Test::Unit::TestCase
     end
   end
 
+  context "A plain command with a job_template using a normal parameter" do
+    setup do
+      @output = Whenever.cron \
+      <<-file
+        set :job_template, "/bin/bash -l -c 'cd :path && :job'"
+        every 2.hours do
+          set :path, "/tmp"
+          command "blahblah"
+        end
+      file
+    end
+
+    should "output the command using that job_template" do
+      assert_match /^.+ .+ .+ .+ \/bin\/bash -l -c 'cd \/tmp \&\& blahblah'$/, @output
+    end
+  end
+
+
   context "A plain command that overrides the job_template set" do
     setup do
       @output = Whenever.cron \
@@ -52,6 +70,24 @@ class OutputDefaultDefinedJobsTest < Test::Unit::TestCase
     end
   end
 
+  context "A plain command that overrides the job_template set using a parameter" do
+    setup do
+      @output = Whenever.cron \
+      <<-file
+        set :job_template, "/bin/bash -l -c 'cd :path && :job'"
+        every 2.hours do
+          set :path, "/tmp"
+          command "blahblah", :job_template => "/bin/sh -l -c 'cd :path && :job'"
+        end
+      file
+    end
+
+    should "output the command using that job_template" do
+      assert_match /^.+ .+ .+ .+ \/bin\/sh -l -c 'cd \/tmp && blahblah'$/, @output
+      assert_no_match /bash/, @output
+    end
+  end
+
   context "A plain command that is conditional on default environent and path" do
     setup do
       Whenever.expects(:path).at_least_once.returns('/what/you/want')

data/test/unit/capistrano_support_test.rb

@@ -1,5 +1,5 @@
 require File.expand_path(File.dirname(__FILE__) + "/../test_helper")
-require File.expand_path(File.dirname(__FILE__) + "/../../lib/whenever/capistrano/support")
+require File.expand_path(File.dirname(__FILE__) + "/../../lib/whenever/capistrano/v2/support")
 
 class CapistranoSupportTestSubject
   include Whenever::CapistranoSupport

data/test/unit/job_test.rb

@@ -54,14 +54,13 @@ class JobTest < Test::Unit::TestCase
       assert_equal %q(before percent preceded by a backslash -> \\\% <- after), job.output
     end
 
-    should "reject newlines" do
+    should "squish spaces and newlines" do
       job = new_job(
         :template => "before :foo after",
-        :foo => "newline -> \n <- newline"
+        :foo => "newline -> \n <- newline space ->     <- space"
       )
-      assert_raise ArgumentError do
-        job.output
-      end
+
+      assert_equal "before newline -> <- newline space -> <- space after", job.output
     end
   end
 
@@ -100,6 +99,11 @@ class JobTest < Test::Unit::TestCase
       assert_equal 'left abc123 right', job.output
     end
 
+    should "reuse parameter in the job template" do
+      job = new_job(:template => ':path :task', :path => 'path', :task => "abc123", :job_template => ':path left :job right')
+      assert_equal 'path left path abc123 right', job.output
+    end
+
     should "escape single quotes" do
       job = new_job(:template => "before ':task' after", :task => "quote -> ' <- quote", :job_template => "left ':job' right")
       assert_equal %q(left 'before '\''quote -> '\\''\\'\\'''\\'' <- quote'\'' after' right), job.output

data/whenever.gemspec

@@ -18,14 +18,8 @@ Gem::Specification.new do |s|
   s.require_paths = ["lib"]
 
   s.add_dependency "chronic", ">= 0.6.3"
+  s.add_dependency "activesupport", ">= 2.3.4"
 
-  if RUBY_VERSION < "1.9"
-    s.add_dependency "activesupport", ">= 2.3.4", "< 4.0"
-  else
-    s.add_dependency "activesupport", ">= 2.3.4"
-  end
-
-  s.add_development_dependency "shoulda-matchers", "<= 2.0.0" if RUBY_VERSION < "1.9"
   s.add_development_dependency "shoulda", ">= 2.1.1"
   s.add_development_dependency "mocha", ">= 0.9.5"
   s.add_development_dependency "rake"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: whenever
 version: !ruby/object:Gem::Version
-  version: 0.8.4
+  version: 0.9.1
 platform: ruby
 authors:
 - Javan Makhmali
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-07-23 00:00:00.000000000 Z
+date: 2014-03-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: chronic
@@ -100,14 +100,17 @@ files:
 - bin/wheneverize
 - lib/whenever.rb
 - lib/whenever/capistrano.rb
-- lib/whenever/capistrano/recipes.rb
-- lib/whenever/capistrano/support.rb
+- lib/whenever/capistrano/v2/hooks.rb
+- lib/whenever/capistrano/v2/recipes.rb
+- lib/whenever/capistrano/v2/support.rb
+- lib/whenever/capistrano/v3/tasks/whenever.rake
 - lib/whenever/command_line.rb
 - lib/whenever/cron.rb
 - lib/whenever/job.rb
 - lib/whenever/job_list.rb
 - lib/whenever/output_redirection.rb
 - lib/whenever/setup.rb
+- lib/whenever/tasks/whenever.rake
 - lib/whenever/version.rb
 - test/functional/command_line_test.rb
 - test/functional/output_at_test.rb
@@ -141,7 +144,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.2
+rubygems_version: 2.0.14
 signing_key: 
 specification_version: 4
 summary: Cron jobs in ruby.