whenever 0.10.0 → 0.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 9c8fe56b21ffa57026a2b944ae208bea62a9d7e9
-  data.tar.gz: 543d704698ab03d944679daa1e85bee1b3936286
+SHA256:
+  metadata.gz: be14a26bff8c588b4e5828582a552f4a10e056b08581f4d28b2f44ae6726c694
+  data.tar.gz: 6e8db042c4c070b52f85bf958b73673b2445663ca102ecb306ac4aa654e8cb37
 SHA512:
-  metadata.gz: 3d0bd440a4beab5ecde93ccb91fad7cf5b2bf2ffe14a376ad24392fe5b4a3d53ba1d7ce15a53d2debc3b639a35f609436d21ab78de16b99a857fe1e16ed8bed1
-  data.tar.gz: 4bb8692d2f7130e45d80fc05a6a54609fd160155014eae330da8f0fc9ed97e9338d523282cd4f8ec197531231493bd04d2409a3d7a6bbc57761ff6ad0ff7f422
+  metadata.gz: 30fc22be58c8cccdf2da369fd9103aedd5c4da0ac7abb6736abf166958c5d79f67029634a0ceb36aa0babcf66c41e092ae4a965b17b1459c2f22cc4c655e9abf
+  data.tar.gz: ebfb02153d52c3df836e50f3ef286ebdaefad889fded4d35664afbe70a46e6910842d96a83f8df6006adadc1b30c2b96f2d17deb3c7c8cf01cfab8999a991cc3

data/.travis.yml

@@ -2,20 +2,47 @@ language: ruby
 
 before_install:
   - gem install bundler
-
+  - unset _JAVA_OPTIONS
 rvm:
   - 1.9.3
   - 2.0.0
   - 2.1.10
-  - 2.2.6
-  - 2.3.3
-  - 2.4.0
+  - 2.2.10
+  - 2.3.8
+  - 2.4.5
+  - 2.5.3
   - jruby-9.1.9.0
+matrix:
+  exclude:
+    # activesupport 5 only supports ruby 2.2.2 and later
+    - gemfile: gemfiles/activesupport5.0.gemfile
+      rvm: 1.9.3
+    - gemfile: gemfiles/activesupport5.1.gemfile
+      rvm: 1.9.3
+    - gemfile: gemfiles/activesupport5.2.gemfile
+      rvm: 1.9.3
+
+    - gemfile: gemfiles/activesupport5.0.gemfile
+      rvm: 2.0.0
+    - gemfile: gemfiles/activesupport5.1.gemfile
+      rvm: 2.0.0
+    - gemfile: gemfiles/activesupport5.2.gemfile
+      rvm: 2.0.0
+
+    - gemfile: gemfiles/activesupport5.0.gemfile
+      rvm: 2.1.10
+    - gemfile: gemfiles/activesupport5.1.gemfile
+      rvm: 2.1.10
+    - gemfile: gemfiles/activesupport5.2.gemfile
+      rvm: 2.1.10
 
 gemfile:
-  - 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,5 +1,15 @@
 ### develop
 
+### 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
@@ -14,6 +24,8 @@
 
 * 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]

data/Gemfile

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

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
@@ -54,15 +54,19 @@ every 3.hours do # 1.minute 1.day 1.week 1.month 1.year is also supported
   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
 
@@ -72,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
 ```
@@ -87,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
 ```
 
@@ -129,10 +133,10 @@ 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
+set :chronic_options, hours24: true
 
 # By default this would run the job every day at 3am
-every 1.day, :at => '3:00' do
+every 1.day, at: '3:00' do
   runner "MyModel.nightly_archive_job"
 end
 ```
@@ -240,7 +244,7 @@ When you define a job in your schedule.rb file, by default it will be deployed t
 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
@@ -253,7 +257,7 @@ So, for example, with the default whenever_roles of `[:db]`, a job like this wou
 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
 ```
@@ -262,15 +266,15 @@ 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
 ```

data/gemfiles/activesupport4.1.gemfile

@@ -1,4 +1,6 @@
-source "https://rubygems.org"
+# This file was generated by Appraisal
+
+source "http://rubygems.org"
 
 gem "activesupport", "~> 4.1.0"
 

data/gemfiles/activesupport4.2.gemfile

@@ -1,4 +1,6 @@
-source "https://rubygems.org"
+# This file was generated by Appraisal
+
+source "http://rubygems.org"
 
 gem "activesupport", "~> 4.2.0"
 

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/v3/tasks/whenever.rake

@@ -44,13 +44,13 @@ namespace :load do
   task :defaults do
     set :whenever_roles,        ->{ :db }
     set :whenever_command,      ->{ [:bundle, :exec, :whenever] }
-    set :whenever_command_environment_variables, ->{ fetch(:default_env).merge!(rails_env: fetch(:whenever_environment)) }
+    set :whenever_command_environment_variables, ->{ fetch(:default_env).merge(rails_env: fetch(:whenever_environment)) }
     set :whenever_identifier,   ->{ fetch :application }
     set :whenever_environment,  ->{ fetch :rails_env, fetch(:stage, "production") }
     set :whenever_variables,    ->{ "environment=#{fetch :whenever_environment}" }
     set :whenever_load_file,    ->{ nil }
     set :whenever_update_flags, ->{ "--update-crontab #{fetch :whenever_identifier} --set #{fetch :whenever_variables}" }
     set :whenever_clear_flags,  ->{ "--clear-crontab #{fetch :whenever_identifier}" }
-    set :whenever_path,         ->{ fetch :release_path }
+    set :whenever_path,         ->{ release_path }
   end
 end

data/lib/whenever/command_line.rb

@@ -102,7 +102,7 @@ module Whenever
         exit(1)
       end
 
-      # If an existing identier block is found, replace it with the new cron entries
+      # If an existing identifier block is found, replace it with the new cron entries
       if read_crontab =~ Regexp.new("^#{comment_open_regex}\s*$") && read_crontab =~ Regexp.new("^#{comment_close_regex}\s*$")
         # If the existing crontab file contains backslashes they get lost going through gsub.
         # .gsub('\\', '\\\\\\') preserves them. Go figure.

data/lib/whenever/cron.rb

@@ -96,15 +96,13 @@ module Whenever
             timing[0] = comma_separated_timing(minute_frequency, 59, @at || 0)
           when Whenever.seconds(1, :hour)...Whenever.seconds(1, :day)
             hour_frequency = (@time / 60 / 60).round
-            timing[0] = @at.is_a?(Time) ? @at.min : @at
+            timing[0] = @at.is_a?(Time) ? @at.min : range_or_integer(@at, 0..59, 'Minute')
             timing[1] = comma_separated_timing(hour_frequency, 23)
-            raise ArgumentError, "Minute must be between 0-59, #{timing[0]} given" unless (0..59).include?(timing[0])
           when Whenever.seconds(1, :day)...Whenever.seconds(1, :month)
             day_frequency = (@time / 24 / 60 / 60).round
             timing[0] = @at.is_a?(Time) ? @at.min  : 0
-            timing[1] = @at.is_a?(Time) ? @at.hour : @at
+            timing[1] = @at.is_a?(Time) ? @at.hour : range_or_integer(@at, 0..23, 'Hour')
             timing[2] = comma_separated_timing(day_frequency, 31, 1)
-            raise ArgumentError, "Hour must be between 0-23, #{timing[1]} given" unless (0..23).include?(timing[1])
           when Whenever.seconds(1, :month)...Whenever.seconds(1, :year)
             month_frequency = (@time / 30 / 24 / 60 / 60).round
             timing[0] = @at.is_a?(Time) ? @at.min  : 0
@@ -112,10 +110,9 @@ module Whenever
             timing[2] = if @at.is_a?(Time)
               day_given? ? @at.day : 1
             else
-              @at.zero? ? 1 : @at
+              @at == 0 ? 1 : range_or_integer(@at, 1..31, 'Day')
             end
             timing[3] = comma_separated_timing(month_frequency, 12, 1)
-            raise ArgumentError, "Day must be between 1-31, #{timing[2]} given" unless (1..31).include?(timing[2])
           when Whenever.seconds(1, :year)
             timing[0] = @at.is_a?(Time) ? @at.min  : 0
             timing[1] = @at.is_a?(Time) ? @at.hour : 0
@@ -127,9 +124,8 @@ module Whenever
             timing[3] = if @at.is_a?(Time)
               day_given? ? @at.month : 1
             else
-              @at.zero? ? 1 : @at
+              @at == 0 ? 1 : range_or_integer(@at, 1..12, 'Month')
             end
-            raise ArgumentError, "Month must be between 1-12, #{timing[3]} given" unless (1..12).include?(timing[3])
           else
             return parse_as_string
         end
@@ -151,7 +147,18 @@ module Whenever
           return (timing << i) * " " if string.downcase.index(day)
         end
 
-        raise ArgumentError, "Couldn't parse: #{@time}"
+        raise ArgumentError, "Couldn't parse: #{@time.inspect}"
+      end
+
+      def range_or_integer(at, valid_range, name)
+        must_be_between = "#{name} must be between #{valid_range.min}-#{valid_range.max}"
+        if at.is_a?(Range)
+          raise ArgumentError, "#{must_be_between}, #{at.min} given" unless valid_range.include?(at.min)
+          raise ArgumentError, "#{must_be_between}, #{at.max} given" unless valid_range.include?(at.max)
+          return "#{at.min}-#{at.max}"
+        end
+        raise ArgumentError, "#{must_be_between}, #{at} given" unless valid_range.include?(at)
+        at
       end
 
       def comma_separated_timing(frequency, max, start = 0)

data/lib/whenever/numeric.rb

@@ -1,4 +1,4 @@
-class Numeric
+Numeric.class_eval do
   def respond_to?(method, include_private = false)
     super || Whenever::NumericSeconds.public_method_defined?(method)
   end

data/lib/whenever/version.rb

@@ -1,3 +1,3 @@
 module Whenever
-  VERSION = '0.10.0'
+  VERSION = '0.11.0'
 end

data/test/unit/cron_test.rb

@@ -78,6 +78,10 @@ class CronParseHoursTest < Whenever::TestCase
     assert_minutes_equals "30", '6:30', :chronic_options => { :hours24 => false }
   end
 
+  should "parse correctly when given an 'at' with minutes as a Range" do
+    assert_minutes_equals "15-30", 15..30
+  end
+
   should "raise an exception when given an 'at' with an invalid minute value" do
     assert_raises ArgumentError do
       parse_time(Whenever.seconds(1, :hour), nil, 60)
@@ -86,6 +90,14 @@ class CronParseHoursTest < Whenever::TestCase
     assert_raises ArgumentError do
       parse_time(Whenever.seconds(1, :hour), nil, -1)
     end
+
+    assert_raises ArgumentError do
+      parse_time(Whenever.seconds(1, :hour), nil, 0..60)
+    end
+
+    assert_raises ArgumentError do
+      parse_time(Whenever.seconds(1, :hour), nil, -1..59)
+    end
   end
 end
 
@@ -130,6 +142,10 @@ class CronParseDaysTest < Whenever::TestCase
     assert_hours_and_minutes_equals %w(23 0), 23
   end
 
+  should "parse correctly when given an 'at' with hours as a Range" do
+    assert_hours_and_minutes_equals %w(3-23 0), 3..23
+  end
+
   should "raise an exception when given an 'at' with an invalid hour value" do
     assert_raises ArgumentError do
       parse_time(Whenever.seconds(1, :day), nil, 24)
@@ -138,6 +154,14 @@ class CronParseDaysTest < Whenever::TestCase
     assert_raises ArgumentError do
       parse_time(Whenever.seconds(1, :day), nil, -1)
     end
+
+    assert_raises ArgumentError do
+      parse_time(Whenever.seconds(1, :day), nil, 0..24)
+    end
+
+    assert_raises ArgumentError do
+      parse_time(Whenever.seconds(1, :day), nil, -1..23)
+    end
   end
 end
 
@@ -197,6 +221,10 @@ class CronParseMonthsTest < Whenever::TestCase
     assert_days_and_hours_and_minutes_equals %w(29 0 0), 29
   end
 
+  should "parse correctly when given an 'at' with days as a Range" do
+    assert_days_and_hours_and_minutes_equals %w(1-7 0 0), 1..7
+  end
+
   should "raise an exception when given an 'at' with an invalid day value" do
     assert_raises ArgumentError do
       parse_time(Whenever.seconds(1, :month), nil, 32)
@@ -205,6 +233,14 @@ class CronParseMonthsTest < Whenever::TestCase
     assert_raises ArgumentError do
       parse_time(Whenever.seconds(1, :month), nil, -1)
     end
+
+    assert_raises ArgumentError do
+      parse_time(Whenever.seconds(1, :month), nil, 0..30)
+    end
+
+    assert_raises ArgumentError do
+      parse_time(Whenever.seconds(1, :month), nil, 1..32)
+    end
   end
 end
 
@@ -254,6 +290,10 @@ class CronParseYearTest < Whenever::TestCase
     assert_months_and_days_and_hours_and_minutes_equals %w(12 1 0 0), 12
   end
 
+  should "parse correctly when given an 'at' with month as a Range" do
+    assert_months_and_days_and_hours_and_minutes_equals %w(1-3 1 0 0), 1..3
+  end
+
   should "raise an exception when given an 'at' with an invalid month value" do
     assert_raises ArgumentError do
       parse_time(Whenever.seconds(1, :year), nil, 13)
@@ -262,6 +302,14 @@ class CronParseYearTest < Whenever::TestCase
     assert_raises ArgumentError do
       parse_time(Whenever.seconds(1, :year), nil, -1)
     end
+
+    assert_raises ArgumentError do
+      parse_time(Whenever.seconds(1, :year), nil, 0..12)
+    end
+
+    assert_raises ArgumentError do
+      parse_time(Whenever.seconds(1, :year), nil, 1..13)
+    end
   end
 end
 

data/whenever.gemspec

@@ -24,4 +24,5 @@ Gem::Specification.new do |s|
   s.add_development_dependency "rake"
   s.add_development_dependency "mocha", ">= 0.9.5"
   s.add_development_dependency "minitest"
+  s.add_development_dependency "appraisal"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: whenever
 version: !ruby/object:Gem::Version
-  version: 0.10.0
+  version: 0.11.0
 platform: ruby
 authors:
 - Javan Makhmali
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-11-20 00:00:00.000000000 Z
+date: 2019-04-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: chronic
@@ -80,6 +80,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: appraisal
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Clean ruby syntax for writing and deploying cron jobs.
 email:
 - javan@javan.us
@@ -91,6 +105,7 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".travis.yml"
+- Appraisals
 - CHANGELOG.md
 - Gemfile
 - LICENSE
@@ -100,6 +115,9 @@ files:
 - bin/wheneverize
 - gemfiles/activesupport4.1.gemfile
 - gemfiles/activesupport4.2.gemfile
+- gemfiles/activesupport5.0.gemfile
+- gemfiles/activesupport5.1.gemfile
+- gemfiles/activesupport5.2.gemfile
 - lib/whenever.rb
 - lib/whenever/capistrano.rb
 - lib/whenever/capistrano/v2/hooks.rb
@@ -151,7 +169,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.7.3
 signing_key: 
 specification_version: 4
 summary: Cron jobs in ruby.