whenever 0.8.2 → 0.8.4

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c96bb55bfcc94c54bab65174a8fb046aa4bfcff1
+  data.tar.gz: fbce8b6cd1f6c8558e9281af9f6cbccade7dcd71
+SHA512:
+  metadata.gz: a23ed3067c55356fb7f98f18d267d508d410cbe63a9ea2dc1f3aaa491bfa6df03cf856ff315a2adb64290cab7fa9348ed486ac362afec8b35583d4efc251eef6
+  data.tar.gz: 3e79b8eba708dd80fa79fa8ba80a81205a889f196f6a5a00ee3cdfce82c669ef93e96a10c321cfb4c7cd7fe9addc1ca75860aaa5c082da6ed6400def6c42d575

data/.travis.yml

@@ -2,6 +2,7 @@ rvm:
   - 1.8.7
   - 1.9.2
   - 1.9.3
+  - 2.0.0
   - ree
   - jruby
   - jruby-18mode

data/CHANGELOG.md

@@ -3,6 +3,22 @@
 * Time zone support
 
 
+### 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]
@@ -257,4 +273,4 @@
 
 ### 0.1.0 / February 15th, 2009
 
-* Initial release [Javan Makhmali]
+* Initial release [Javan Makhmali]

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2012 Javan Makhmali
+Copyright (c) 2013 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

@@ -73,14 +73,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 :rake,    "cd :path && :environment_variable=: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 :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>
 

data/lib/whenever/capistrano/recipes.rb

@@ -22,18 +22,11 @@ Capistrano::Configuration.instance(:must_exist).load do
       }
 
       if whenever_servers.any?
+        args = whenever_prepare_for_rollback(args) if task_call_frames[0].task.fully_qualified_name == 'deploy:rollback'
         whenever_run_commands(args)
 
         on_rollback do
-          if fetch(:previous_release)
-            # rollback to the previous release's crontab
-            args[:path] = fetch(:previous_release)
-          else
-            # clear the crontab if no previous release
-            args[:path]  = fetch(:release_path)
-            args[:flags] = fetch(:whenever_clear_flags)
-          end
-
+          args = whenever_prepare_for_rollback(args)
           whenever_run_commands(args)
         end
       end

data/lib/whenever/capistrano/support.rb

@@ -22,6 +22,18 @@ module Whenever
           end
         end
 
+        def whenever_prepare_for_rollback args
+          if fetch(:previous_release)
+            # rollback to the previous release's crontab
+            args[:path] = fetch(:previous_release)
+          else
+            # clear the crontab if no previous release
+            args[:path]  = fetch(:release_path)
+            args[:flags] = fetch(:whenever_clear_flags)
+          end
+          args
+        end
+
         def whenever_run_commands(args)
           unless [:command, :path, :flags].all? { |a| args.include?(a) }
             raise ArgumentError, ":command, :path, & :flags are required"

data/lib/whenever/command_line.rb

@@ -6,15 +6,15 @@ module Whenever
     def self.execute(options={})
       new(options).run
     end
-    
+
     def initialize(options={})
       @options = options
-      
+
       @options[:file]       ||= 'config/schedule.rb'
       @options[:cut]        ||= 0
       @options[:identifier] ||= default_identifier
-      
-      unless File.exists?(@options[:file])
+
+      if !File.exists?(@options[:file]) && @options[:clear].nil?
         warn("[fail] Can't find file: #{@options[:file]}")
         exit(1)
       end
@@ -30,7 +30,7 @@ module Whenever
       end
       @options[:cut] = @options[:cut].to_i
     end
-    
+
     def run
       if @options[:update] || @options[:clear]
         write_crontab(updated_crontab)
@@ -43,28 +43,28 @@ module Whenever
         exit(0)
       end
     end
-    
+
   protected
-    
+
     def default_identifier
       File.expand_path(@options[:file])
     end
-  
+
     def whenever_cron
       return '' if @options[:clear]
       @whenever_cron ||= [comment_open, Whenever.cron(@options), comment_close].compact.join("\n") + "\n"
     end
-    
+
     def read_crontab
       return @current_crontab if @current_crontab
-      
+
       command = ['crontab -l']
       command << "-u #{@options[:user]}" if @options[:user]
-      
+
       command_results  = %x[#{command.join(' ')} 2> /dev/null]
       @current_crontab = $?.exitstatus.zero? ? prepare(command_results) : ''
     end
-    
+
     def write_crontab(contents)
       tmp_cron_file = Tempfile.open('whenever_tmp_cron')
       tmp_cron_file << contents
@@ -86,8 +86,8 @@ module Whenever
         exit(1)
       end
     end
-    
-    def updated_crontab   
+
+    def updated_crontab
       # Check for unopened or unclosed identifier blocks
       if read_crontab =~ Regexp.new("^#{comment_open}\s*$") && (read_crontab =~ Regexp.new("^#{comment_close}\s*$")).nil?
         warn "[fail] Unclosed indentifier; Your crontab file contains '#{comment_open}', but no '#{comment_close}'"
@@ -96,7 +96,7 @@ module Whenever
         warn "[fail] Unopened indentifier; Your crontab file contains '#{comment_close}', but no '#{comment_open}'"
         exit(1)
       end
-      
+
       # If an existing identier block is found, replace it with the new cron entries
       if read_crontab =~ Regexp.new("^#{comment_open}\s*$") && read_crontab =~ Regexp.new("^#{comment_close}\s*$")
         # If the existing crontab file contains backslashes they get lost going through gsub.
@@ -106,7 +106,7 @@ module Whenever
         [read_crontab, whenever_cron].join("\n\n")
       end.gsub(/\n{3,}/, "\n\n") # More than two newlines becomes just two.
     end
-    
+
     def prepare(contents)
       # Strip n lines from the top of the file as specified by the :cut option.
       # Use split with a -1 limit option to ensure the join is able to rebuild
@@ -114,19 +114,19 @@ module Whenever
       stripped_contents = contents.split($/,-1)[@options[:cut]..-1].join($/)
 
       # Some cron implementations require all non-comment lines to be newline-
-      # terminated. (issue #95) Strip all newlines and replace with the default 
+      # terminated. (issue #95) Strip all newlines and replace with the default
       # platform record seperator ($/)
       stripped_contents.gsub!(/\s+$/, $/)
     end
-    
+
     def comment_base
       "Whenever generated tasks for: #{@options[:identifier]}"
     end
-    
+
     def comment_open
       "# Begin #{comment_base}"
     end
-    
+
     def comment_close
       "# End #{comment_base}"
     end

data/lib/whenever/job.rb

@@ -6,13 +6,14 @@ module Whenever
 
     def initialize(options = {})
       @options = options
-      @at                      = options.delete(:at)
-      @template                = options.delete(:template)
-      @job_template            = options.delete(:job_template) || ":job"
-      @roles                   = Array.wrap(options.delete(:roles))
-      @options[:output]        = options.has_key?(:output) ? Whenever::Output::Redirection.new(options[:output]).to_s : ''
-      @options[:environment] ||= :production
-      @options[:path]          = Shellwords.shellescape(@options[:path] || Whenever.path)
+      @at                               = options.delete(:at)
+      @template                         = options.delete(:template)
+      @job_template                     = options.delete(:job_template) || ":job"
+      @roles                            = Array.wrap(options.delete(:roles))
+      @options[:output]                 = options.has_key?(:output) ? Whenever::Output::Redirection.new(options[:output]).to_s : ''
+      @options[:environment_variable] ||= "RAILS_ENV"
+      @options[:environment]          ||= :production
+      @options[:path]                   = Shellwords.shellescape(@options[:path] || Whenever.path)
     end
 
     def output

data/lib/whenever/output_redirection.rb

@@ -11,6 +11,7 @@ module Whenever
           when String   then redirect_from_string
           when Hash     then redirect_from_hash
           when NilClass then ">> /dev/null 2>&1"
+          when Proc     then @output.call
           else ''
         end 
       end

data/lib/whenever/setup.rb

@@ -1,3 +1,5 @@
+# Environment variable defaults to RAILS_ENV
+set :environment_variable, "RAILS_ENV"
 # Environment defaults to production
 set :environment, "production"
 # Path defaults to the directory `whenever` was run from
@@ -11,16 +13,23 @@ job_type :command, ":task :output"
 
 # Run rake through bundler if possible
 if Whenever.bundler?
-  job_type :rake, "cd :path && RAILS_ENV=:environment bundle exec rake :task --silent :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 :script, "cd :path && :environment_variable=:environment bundle exec script/:task :output"
 else
-  job_type :rake, "cd :path && RAILS_ENV=:environment rake :task --silent :output"
-  job_type :script, "cd :path && RAILS_ENV=:environment script/:task :output"
+  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,
-if Whenever.rails3?
-  job_type :runner, "cd :path && script/rails runner -e :environment ':task' :output"
-else
-  job_type :runner, "cd :path && script/runner -e :environment ':task' :output"
+# Create a runner job that's appropriate for the Rails version
+def runner_for_app
+  case
+  when Whenever.bin_rails?
+    "bin/rails runner"
+  when Whenever.script_rails?
+    "script/rails runner"
+  else
+    "script/runner"
+  end
 end
+
+job_type :runner, "cd :path && #{runner_for_app} -e :environment ':task' :output"

data/lib/whenever/version.rb

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

data/lib/whenever.rb

@@ -19,7 +19,11 @@ module Whenever
     Dir.pwd
   end
 
-  def self.rails3?
+  def self.bin_rails?
+    File.exists?(File.join(path, 'bin', 'rails'))
+  end
+
+  def self.script_rails?
     File.exists?(File.join(path, 'script', 'rails'))
   end
 

data/test/functional/command_line_test.rb

@@ -161,6 +161,18 @@ NEW_CRON
     end
   end
 
+  context "A command line clear with no schedule file" do
+    setup do
+      File.expects(:exists?).with('config/schedule.rb').returns(false)
+      @command = Whenever::CommandLine.new(:clear => true, :identifier => 'My identifier')
+    end
+
+    should "run successfully" do
+      @command.expects(:write_crontab).returns(true)
+      assert @command.run
+    end
+  end
+
   context "A command line update with no identifier" do
     setup do
       File.expects(:exists?).with('config/schedule.rb').returns(true)

data/test/functional/output_default_defined_jobs_test.rb

@@ -107,10 +107,10 @@ class OutputDefaultDefinedJobsTest < Test::Unit::TestCase
     end
   end
 
-  context "A runner for a Rails 3 app" do
+  context "A runner for an app with bin/rails" do
     setup do
       Whenever.expects(:path).at_least_once.returns('/my/path')
-      Whenever.expects(:rails3?).returns(true)
+      Whenever.expects(:bin_rails?).returns(true)
       @output = Whenever.cron \
       <<-file
         set :job_template, nil
@@ -120,7 +120,25 @@ class OutputDefaultDefinedJobsTest < Test::Unit::TestCase
       file
     end
 
-    should "use the Rails 3 runner job by default" do
+    should "use a script/rails runner job by default" do
+      assert_match two_hours + %( cd /my/path && bin/rails runner -e production 'blahblah'), @output
+    end
+  end
+
+  context "A runner for an app with script/rails" do
+    setup do
+      Whenever.expects(:path).at_least_once.returns('/my/path')
+      Whenever.expects(:script_rails?).returns(true)
+      @output = Whenever.cron \
+      <<-file
+        set :job_template, nil
+        every 2.hours do
+          runner 'blahblah'
+        end
+      file
+    end
+
+    should "use a script/rails runner job by default" do
       assert_match two_hours + %( cd /my/path && script/rails runner -e production 'blahblah'), @output
     end
   end
@@ -179,6 +197,41 @@ class OutputDefaultDefinedJobsTest < Test::Unit::TestCase
     end
   end
 
+  context "A rake command that sets the environment variable" do
+    setup do
+      @output = Whenever.cron \
+      <<-file
+        set :job_template, nil
+        set :path, '/my/path'
+        set :environment_variable, 'RAKE_ENV'
+        every 2.hours do
+          rake "blahblah"
+        end
+      file
+    end
+
+    should "output the rake command using that environment variable" do
+      assert_match two_hours + ' cd /my/path && RAKE_ENV=production bundle exec rake blahblah --silent', @output
+    end
+  end
+
+  context "A rake command that overrides the environment variable" do
+    setup do
+      @output = Whenever.cron \
+      <<-file
+        set :job_template, nil
+        set :path, '/my/path'
+        set :environment_variable, 'RAKE_ENV'
+        every 2.hours do
+          rake "blahblah", :environment_variable => 'SOME_ENV'
+        end
+      file
+    end
+
+    should "output the rake command using that environment variable" do
+      assert_match two_hours + ' cd /my/path && SOME_ENV=production bundle exec rake blahblah --silent', @output
+    end
+  end
 
     # script
 
@@ -235,4 +288,22 @@ class OutputDefaultDefinedJobsTest < Test::Unit::TestCase
     end
   end
 
-end
+  context "A script command that uses an environment variable" do
+    setup do
+      @output = Whenever.cron \
+      <<-file
+        set :job_template, nil
+        set :environment_variable, 'RAKE_ENV'
+        set :path, '/my/path'
+        every 2.hours do
+          script "blahblah"
+        end
+      file
+    end
+
+    should "output the script command using that environment variable" do
+      assert_match two_hours + ' cd /my/path && RAKE_ENV=production bundle exec script/blahblah', @output
+    end
+  end
+
+end

data/test/functional/output_jobs_for_roles_test.rb

@@ -78,7 +78,8 @@ class OutputJobsForRolesTest < Test::Unit::TestCase
     end
 
     should "output both jobs" do
-      assert_equal two_hours + " /bin/bash -l -c 'role1_cmd'\n\n0 * * * * /bin/bash -l -c 'role2_cmd'\n\n", @output
+      assert_match two_hours + " /bin/bash -l -c 'role1_cmd'", @output
+      assert_match "0 * * * * /bin/bash -l -c 'role2_cmd'", @output
     end
   end
 end

data/test/functional/output_redirection_test.rb

@@ -304,4 +304,23 @@ class OutputRedirectionTest < Test::Unit::TestCase
       assert_match /^.+ .+ .+ .+ blahblah >> cron.log 2>&1$/, @output
     end
   end
+
+
+  context "A command when the standard output is set to a lambda" do
+    setup do
+      @output = Whenever.cron \
+      <<-file
+        set :job_template, nil
+        set :output, lambda { "2>&1 | logger -t whenever_cron" }
+        every 2.hours do
+          command "blahblah"
+        end
+      file
+    end
+
+    should "output the command by result of the lambda evaluated" do
+      assert_match /^.+ .+ .+ .+ blahblah 2>&1 | logger -t whenever_cron$/, @output
+    end
+  end
+
 end

data/test/unit/capistrano_support_test.rb

@@ -78,6 +78,22 @@ class CapistranoSupportTest < Test::Unit::TestCase
       end
     end
 
+    context "#whenever_prepare_for_rollback" do
+      should "set path to previous_release if there is a previous release" do
+        args = {}
+        @capistrano.stubs(:fetch).with(:previous_release).returns("/some/path/20121221010000")
+        assert_equal({:path => "/some/path/20121221010000"}, @capistrano.whenever_prepare_for_rollback(args))
+      end
+
+      should "set path to release_path and flags to whenever_clear_flags if there is no previous release" do
+        args = {}
+        @capistrano.stubs(:fetch).with(:previous_release).returns(nil)
+        @capistrano.stubs(:fetch).with(:release_path).returns("/some/path/20121221010000")
+        @capistrano.stubs(:fetch).with(:whenever_clear_flags).returns("--clear-crontab whenever_identifier")
+        assert_equal({:path => "/some/path/20121221010000", :flags => "--clear-crontab whenever_identifier"}, @capistrano.whenever_prepare_for_rollback(args))
+      end
+    end
+
     context "#whenever_run_commands" do
       should "require :command arg" do
         assert_raise ArgumentError do

data/whenever.gemspec

@@ -8,6 +8,7 @@ Gem::Specification.new do |s|
   s.platform    = Gem::Platform::RUBY
   s.authors     = ["Javan Makhmali"]
   s.email       = ["javan@javan.us"]
+  s.license     = "MIT"
   s.homepage    = ""
   s.summary     = %q{Cron jobs in ruby.}
   s.description = %q{Clean ruby syntax for writing and deploying cron jobs.}
@@ -17,8 +18,14 @@ 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,94 +1,83 @@
 --- !ruby/object:Gem::Specification
 name: whenever
 version: !ruby/object:Gem::Version
-  version: 0.8.2
-  prerelease: 
+  version: 0.8.4
 platform: ruby
 authors:
 - Javan Makhmali
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-01-10 00:00:00.000000000 Z
+date: 2013-07-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: chronic
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: 0.6.3
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: 0.6.3
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: 2.3.4
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: 2.3.4
 - !ruby/object:Gem::Dependency
   name: shoulda
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: 2.1.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: 2.1.1
 - !ruby/object:Gem::Dependency
   name: mocha
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: 0.9.5
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: 0.9.5
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 description: Clean ruby syntax for writing and deploying cron jobs.
@@ -133,28 +122,28 @@ files:
 - test/unit/job_test.rb
 - whenever.gemspec
 homepage: ''
-licenses: []
+licenses:
+- MIT
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.23
+rubygems_version: 2.0.2
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Cron jobs in ruby.
 test_files:
 - test/functional/command_line_test.rb