whenever 1.1.1 → 1.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 55cafb2edffbfeec94032659d8af2086785d5c864c7e979395197ba02e6612d4
-  data.tar.gz: 88ad009fb54d433ac00fd86f24c8ca0a5cbe05f7cd7774a8b4fac1ebfb90c4b9
+  metadata.gz: e6e3f0d94253d0ac6d5a7f856afeb690b25f83a551e74581ebcc3cb0320855bc
+  data.tar.gz: 8d8ccccb89a2d7e4c5dd8d6744314888c88928a0bf7b6b3ed2bc7e195cae4290
 SHA512:
-  metadata.gz: a81a8c3345588bf311b35bb9b6a6d158dd3fcff181f5a67c423a12db336ccc21c802d1f9498ecd079ebe2006479c971abc7a9129a89c965f63a88a46e1aee78d
-  data.tar.gz: 35622000e04945eab6965f0b5b87a2f2e914753628cf8ccbcf1e9cf99cbf0182125c283ad593f34a1dfa9372c225d208239fd9cec3a1d507a9a34f711f8da99f
+  metadata.gz: f7942baf77e31bb83add51eea178e5ff11d724196a23cc45a47668813acb8ce428f1ab27ca806544ee935e67b8d164a6586e0a6bfda8eb33afb2ef0ea33c88d8
+  data.tar.gz: 30691f3aa03c58df894d3d516c21fedd9a6a3d23563ebaa9d267977b59a822c37071f4fc3663aae115f008865f426a899ce436badbb6883643aaa24b7e2a146c

data/.github/workflows/ci.yml

@@ -10,7 +10,7 @@ jobs:
       fail-fast: false
       matrix:
         os: [ubuntu-latest, macos-latest]
-        ruby-version: [ '2.4', '2.5', '2.6', '2.7', '3.0', '3.0', '3.2', '3.3', '3.4', 'jruby-9', 'jruby-10']
+        ruby-version: [ '2.4', '2.5', '2.6', '2.7', '3.0', '3.0', '3.2', '3.3', '3.4', '4.0', 'jruby-9', 'jruby-10']
         # CRuby < 2.6 does not support macos-arm64, so test those on amd64 instead
         exclude:
           - os: macos-latest
@@ -18,9 +18,9 @@ jobs:
           - os: macos-latest
             ruby-version: '2.5'
         include:
-          - os: macos-13
+          - os: macos-15-intel
             ruby-version: '2.4'
-          - os: macos-13
+          - os: macos-15-intel
             ruby-version: '2.5'
     steps:
       - uses: actions/checkout@v6
@@ -42,7 +42,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        ruby-version: ['2.7', '3.0', '3.0', '3.2', '3.3', '3.4']
+        ruby-version: ['2.7', '3.0', '3.0', '3.2', '3.3', '3.4', '4.0']
         rails-version: ['6.0', '6.1', '7.0', '7.1', '7.2', '8.0', '8.1']
         include:
           - ruby-version: 2.7

data/CHANGELOG.md

@@ -1,6 +1,16 @@
 ### unreleased
 
 
+### 1.1.2 / January 18, 2026
+
+* Add description as comment in crontab https://github.com/javan/whenever/pull/776
+
+* Override global option with group option https://github.com/javan/whenever/pull/822
+
+* CI: Add Ruby 4.0 to CI Matrix https://github.com/javan/whenever/pull/872
+
+* CI: Use macos-15-intel instead of macos-13 for Ruby 2.4 and 2.5 https://github.com/javan/whenever/pull/871
+
 ### 1.1.1 / Dec 8, 2025
 
 * job_list `.respond_to?` updated to an instance method https://github.com/javan/whenever/pull/830

data/README.md

@@ -180,6 +180,26 @@ every 3.hours do
 end
 ```
 
+### Adding comments to crontab
+
+A description can be added to a job that will be included in the crontab as a comment above the cron entry.
+
+Example: A single line description:
+
+```ruby
+every 1.hours, description: "My job description" do
+  command "/usr/bin/my_great_command"
+end
+```
+
+Example: A multi line description:
+
+```ruby
+every 1.hours, description: "My job description\nhas multiple lines" do
+  command "/usr/bin/my_great_command"
+end
+```
+
 ### Capistrano integration
 
 Use the built-in Capistrano recipe for easy crontab updates with deploys. For Capistrano V3, see the next section.

data/lib/whenever/job.rb

@@ -2,7 +2,7 @@ require 'shellwords'
 
 module Whenever
   class Job
-    attr_reader :at, :roles, :mailto
+    attr_reader :at, :roles, :mailto, :description
 
     def initialize(options = {})
       @options = options
@@ -11,6 +11,7 @@ module Whenever
       @mailto                           = options.fetch(:mailto, :default_mailto)
       @job_template                     = options.delete(:job_template) || ":job"
       @roles                            = Array(options.delete(:roles))
+      @description                      = options.delete(:description)
       @options[:output]                 = options.has_key?(:output) ? Whenever::Output::Redirection.new(options[:output]).to_s : ''
       @options[:environment_variable] ||= "RAILS_ENV"
       @options[:environment]          ||= :production

data/lib/whenever/job_list.rb

@@ -66,7 +66,7 @@ module Whenever
 
           @jobs[options.fetch(:mailto)] ||= {}
           @jobs[options.fetch(:mailto)][@current_time_scope] ||= []
-          @jobs[options.fetch(:mailto)][@current_time_scope] << Whenever::Job.new(@options.merge(@set_variables).merge(options))
+          @jobs[options.fetch(:mailto)][@current_time_scope] << Whenever::Job.new(@set_variables.merge(@options).merge(options))
         end
       end
     end
@@ -144,6 +144,7 @@ module Whenever
         end
         Whenever::Output::Cron.output(time, job, :chronic_options => @chronic_options) do |cron|
           cron << "\n\n"
+          cron = (job.description.strip + "\n").gsub(/^(.*)$/, '# \1') + cron unless job.description.to_s.empty?
 
           if cron[0,1] == "@"
             shortcut_jobs << cron

data/lib/whenever/version.rb

@@ -1,3 +1,3 @@
 module Whenever
-  VERSION = '1.1.1'
+  VERSION = '1.1.2'
 end

data/test/functional/output_defined_job_test.rb

@@ -55,6 +55,34 @@ class OutputDefinedJobTest < Whenever::TestCase
     assert_match(/^.+ .+ .+ .+ before during after local$/, output)
   end
 
+  test "defined job with a :task and an option where the option is set globally and on the group" do
+    output = Whenever.cron \
+    <<-file
+      set :job_template, nil
+      job_type :some_job, "before :task after :option1"
+      set :option1, 'global'
+      every 2.hours, :option1 => 'group' do
+        some_job "during"
+      end
+    file
+
+    assert_match(/^.+ .+ .+ .+ before during after group$/, output)
+  end
+
+  test "defined job with a :task and an option where the option is set globally, on the group, and locally" do
+    output = Whenever.cron \
+    <<-file
+      set :job_template, nil
+      job_type :some_job, "before :task after :option1"
+      set :option1, 'global'
+      every 2.hours, :option1 => 'group' do
+        some_job "during", :option1 => 'local'
+      end
+    file
+
+    assert_match(/^.+ .+ .+ .+ before during after local$/, output)
+  end
+
   test "defined job with a :task and an option that is not set" do
     output = Whenever.cron \
     <<-file

data/test/functional/output_description_test.rb

@@ -0,0 +1,25 @@
+require 'test_helper'
+
+class OutputDescriptionTest < Whenever::TestCase
+  test "single line description" do
+    output = Whenever.cron \
+    <<-file
+      every "weekday", :description => "A description" do
+        command "blahblah"
+      end
+    file
+
+    assert_match "# A description\n0 0 * * 1-5 /bin/bash -l -c 'blahblah'\n\n", output
+  end
+
+  test "multi line description" do
+    output = Whenever.cron \
+    <<-file
+      every "weekday", :description => "A description\nhas mulitple lines" do
+        command "blahblah"
+      end
+    file
+
+    assert_match "# A description\n# has mulitple lines\n0 0 * * 1-5 /bin/bash -l -c 'blahblah'\n\n", output
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: whenever
 version: !ruby/object:Gem::Version
-  version: 1.1.1
+  version: 1.1.2
 platform: ruby
 authors:
 - Javan Makhmali
@@ -75,6 +75,7 @@ files:
 - test/functional/output_at_test.rb
 - test/functional/output_default_defined_jobs_test.rb
 - test/functional/output_defined_job_test.rb
+- test/functional/output_description_test.rb
 - test/functional/output_env_test.rb
 - test/functional/output_jobs_for_roles_test.rb
 - test/functional/output_jobs_with_mailto_test.rb
@@ -108,7 +109,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.9
+rubygems_version: 4.0.3
 specification_version: 4
 summary: Cron jobs in ruby.
 test_files:
@@ -116,6 +117,7 @@ test_files:
 - test/functional/output_at_test.rb
 - test/functional/output_default_defined_jobs_test.rb
 - test/functional/output_defined_job_test.rb
+- test/functional/output_description_test.rb
 - test/functional/output_env_test.rb
 - test/functional/output_jobs_for_roles_test.rb
 - test/functional/output_jobs_with_mailto_test.rb