whenever 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dc5ff14e6e9d357583f5e20d31fafbcf2dfe3aea8ac756cf9103f51504674e9a
-  data.tar.gz: 446e8398b741a1a9a7ee262b3542efb107d1453259083fef03ea50726227d7dd
+  metadata.gz: 7c3ac580addd44968bf92b9696fe79224f927baed4486fb25fe3dc818a1a38b1
+  data.tar.gz: 7bb85c3237b714796ec684f1986f45d7ccff17b4ac70f16e80bd7f4dd6322771
 SHA512:
-  metadata.gz: 41f396515f594a4726bd9048783653b0b203e0beb4ea65f6b95faf508061d0fd064bec0a31bbcf6dad6a23f68ec4f3364ae6e8f160eb0539ec6073a6c4960242
-  data.tar.gz: 4fbe2b52fc350ee272d7d03638369b8a6443c1ed6e122be511b9ccf07881c1e559d63587153259343febc89db40aa45bc4ca45cf83af885fd618fd5668ddd1d2
+  metadata.gz: 48e513b22609227c225613cd130a420aef870d2bf28b0ebe62ce87f4df0ea85b93163a017293e5578d0047ae0978bfd3cf67ae355d41613454ed895313f64e15
+  data.tar.gz: ce751f6670ef054ba52e30c6edc928a8df7a4b55e172cbbb913f9d012e81dc726bb8d28dfbbea01a988bdb0e8f5395dff326807dd935f419fa66136cbf06752d

data/.github/dependabot.yml

@@ -0,0 +1,10 @@
+version: 2
+updates:
+  - package-ecosystem: "bundler"
+    directory: "/"
+    schedule:
+      interval: "monthly"
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "monthly"

data/.github/workflows/ci.yml

@@ -0,0 +1,36 @@
+name: Ruby CI
+on:
+  pull_request:
+  push:
+    branches: [ main ]
+jobs:
+  test:
+    runs-on: ${{ matrix.os }}
+    strategy:
+      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']
+        # CRuby < 2.6 does not support macos-arm64, so test those on amd64 instead
+        exclude:
+          - os: macos-latest
+            ruby-version: '2.4'
+          - os: macos-latest
+            ruby-version: '2.5'
+        include:
+          - os: macos-13
+            ruby-version: '2.4'
+          - os: macos-13
+            ruby-version: '2.5'
+    steps:
+      - uses: actions/checkout@v5
+        name: Set up Ruby ${{ matrix.ruby-version }}
+      - uses: ruby/setup-ruby@v1
+        env:
+          JRUBY_OPTS: "--debug"
+        with:
+          ruby-version: ${{ matrix.ruby-version }}
+          bundler-cache: true # runs 'bundle install' and caches installed gems automatically
+      - name: Run tests
+        run: bundle exec rake test
+        env:
+          JRUBY_OPTS: "--debug"

data/.gitignore

@@ -1,6 +1,15 @@
+.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+/Gemfile.lock
+gemfiles/*.lock
+.ruby-version
+
 .DS_Store
-pkg
-doc
 .*.sw[a-z]
-Gemfile.lock
-gemfiles/*.lock

data/CHANGELOG.md

@@ -1,11 +1,50 @@
 ### unreleased
 
+
+### 1.1.0 / Nov 21, 2025
+
+* Splat whenever_roles when passing to roles https://github.com/javan/whenever/pull/777
+
+* Update README.md https://github.com/javan/whenever/pull/785
+
+* Clarify in README that tasks are run in parallel https://github.com/javan/whenever/pull/787
+
+* Add note in README that cron is generated with the current user. [Raquel Queiroz] https://github.com/javan/whenever/pull/788
+
+* Clarify options and warn about overwriting https://github.com/javan/whenever/pull/791
+
+* Set the environment for cron jobs based off the currently set RAILS_ENV env variable. If RAILS_ENV is not set it defaults to production https://github.com/javan/whenever/pull/832
+
+* [CHORE] DX: easify getting started contributing https://github.com/javan/whenever/pull/846
+
+* CI: Replace travis-ci by Github-Actions https://github.com/javan/whenever/pull/847
+
+* Added capability for updating cron without cmd https://github.com/javan/whenever/pull/515
+
+* CI: Add Ruby 2.7-3.4 to the CI matrix https://github.com/javan/whenever/pull/858
+
+* CI: Add dependabot config for bundler / github-actions https://github.com/javan/whenever/pull/862
+
+* Handle crontab output to prevent SIGPIPE when running on CentOS Stream 10 https://github.com/javan/whenever/pull/861
+
+* CI: Bump actions/checkout from 4 to 5 https://github.com/javan/whenever/pull/863
+
+* Fix typo In test https://github.com/javan/whenever/pull/851
+
+* Add changelog_uri to metadata to easily link from rubygems.org https://github.com/javan/whenever/pull/786
+
+* Update gemspec format to match Bundler v3.x gemspec template https://github.com/javan/whenever/pull/864
+
+* Add to require `whenever/version` https://github.com/javan/whenever/pull/865
+
 ### 1.0.0 / Jun 13, 2019
 
 * First stable release per SemVer.
 
 * Removes support for versions of Ruby which are no longer supported by the Ruby project.
 
+* Bugfix: Splat `whenever_roles` when passing to `roles` to allow definition of multiple whenever roles [samuelokrent](https://github.com/javan/whenever/pull/777)
+
 ### 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)

data/CONTRIBUTING.md

@@ -0,0 +1,38 @@
+## How to contribute to Whenever
+
+#### **Did you find a bug?**
+
+* **Ensure the bug was not already reported** by searching on GitHub under [Issues](https://github.com/your/whenever/issues).
+
+* If you're unable to find an open issue addressing the problem, [open a new one](https://github.com/your/whenever/issues/new). Be sure to include a **title and clear description**, as much relevant information as possible, and a **code sample** or an **executable test case** demonstrating the expected behavior that is not occurring.
+
+#### **Did you write a patch that fixes a bug?**
+
+* Open a new GitHub pull request with the patch.
+
+* Ensure the PR description clearly describes the problem and solution. Include the relevant issue number if applicable.
+
+
+#### **Do you have questions about the source code?**
+
+* Ask any question about how to use Whenever in the [whenever issues](https://github.com/javan/whenever/issues).
+
+#### **Do you want to contribute to the Whenever documentation?**
+
+Whenever is a volunteer effort. We encourage you to pitch in! 
+
+Thanks! :heart: :heart: :heart:
+
+Whenever Team
+
+---
+## Setup
+
+```bash
+$ bundle install
+```
+## Run tests
+
+```bash
+$ make test
+```

data/Gemfile

@@ -1,4 +1,11 @@
+# frozen_string_literal: true
+
 source "https://rubygems.org"
 
 # Specify your gem's dependencies in whenever.gemspec
 gemspec
+
+gem "rake"
+gem "mocha"
+gem "minitest"
+gem "appraisal"

data/Makefile

@@ -0,0 +1,5 @@
+.DEFAULT_GOAL := test
+
+test:
+	bundle exec rake test
+.PHONY: test

data/README.md

@@ -16,19 +16,21 @@ gem 'whenever', require: false
 
 ```sh
 $ cd /apps/my-great-project
-$ wheneverize .
+$ bundle exec wheneverize .
 ```
 
 This will create an initial `config/schedule.rb` file for you (as long as the config folder is already present in your project).
 
 ### The `whenever` command
 
+The `whenever` command will simply show you your `schedule.rb` file converted to cron syntax. It does not read or write your crontab file.
+
 ```sh
 $ cd /apps/my-great-project
-$ whenever
+$ bundle exec 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:
+To write your crontab file for your jobs, execute this command:
 
 ```sh
 $ whenever --update-crontab
@@ -41,6 +43,8 @@ $ whenever --load-file config/my_schedule.rb # set the schedule file
 $ whenever --crontab-command 'sudo crontab' # override the crontab command
 ```
 
+> Note: If you run the whenever --update-crontab without passing the --user attribute, cron will be generated by the current user. This mean tasks that needs other user permission will fail.
+
 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, etc.
@@ -49,6 +53,7 @@ Run `whenever --help` for a complete list of options for selecting the schedule
 
 ```ruby
 every 3.hours do # 1.minute 1.day 1.week 1.month 1.year is also supported
+  # the following tasks are run in parallel (not in sequence)
   runner "MyModel.some_process"
   rake "my:rake:task"
   command "/usr/bin/my_great_command"

data/bin/whenever

@@ -2,21 +2,26 @@
 
 require 'optparse'
 require 'whenever'
-require 'whenever/version'
 
 options = {}
 
 OptionParser.new do |opts|
   opts.banner = "Usage: whenever [options]"
-  opts.on('-i', '--update-crontab [identifier]', 'Default: full path to schedule.rb file') do |identifier|
+  opts.on('-i', '--update-crontab [schedule]',
+          'Install the schedule to crontab.',
+          '  Default: full path to schedule.rb file') do |identifier|
     options[:update] = true
     options[:identifier] = identifier if identifier
   end
-  opts.on('-w', '--write-crontab [identifier]', 'Default: full path to schedule.rb file') do |identifier|
+  opts.on('-w', '--write-crontab [schedule]',
+          'Clear current crontab, and overwrite it with only the given schedule.',
+          '  Default: full path to schedule.rb file') do |identifier|
      options[:write] = true
      options[:identifier] = identifier if identifier
   end
-  opts.on('-c', '--clear-crontab [identifier]') do |identifier|
+  opts.on('-c', '--clear-crontab [schedule]',
+          'Uninstall the schedule from crontab.',
+          '  Default: full path to schedule.rb file') do |identifier|    
     options[:clear] = true
     options[:identifier] = identifier if identifier
   end

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

@@ -2,7 +2,7 @@ namespace :whenever do
   def setup_whenever_task(*args, &block)
     args = Array(fetch(:whenever_command)) + args
 
-    on roles fetch(:whenever_roles) do |host|
+    on roles *fetch(:whenever_roles) do |host|
       args_for_host = block_given? ? args + Array(yield(host)) : args
       within fetch(:whenever_path) do
         with fetch(:whenever_command_environment_variables) do

data/lib/whenever/command_line.rb

@@ -13,20 +13,21 @@ module Whenever
       @options[:file]            ||= 'config/schedule.rb'
       @options[:cut]             ||= 0
       @options[:identifier]      ||= default_identifier
+      @options[:console]    = true if @options[:console].nil?
 
       if !File.exist?(@options[:file]) && @options[:clear].nil?
         warn("[fail] Can't find file: #{@options[:file]}")
-        exit(1)
+        return_or_exit(false)
       end
 
       if [@options[:update], @options[:write], @options[:clear]].compact.length > 1
         warn("[fail] Can only update, write or clear. Choose one.")
-        exit(1)
+        return_or_exit(false)
       end
 
       unless @options[:cut].to_s =~ /[0-9]*/
         warn("[fail] Can't cut negative lines from the crontab #{options[:cut]}")
-        exit(1)
+        return_or_exit(false)
       end
       @options[:cut] = @options[:cut].to_i
 
@@ -42,7 +43,7 @@ module Whenever
         puts Whenever.cron(@options)
         puts "## [message] Above is your schedule file converted to cron syntax; your crontab file was not updated."
         puts "## [message] Run `whenever --help' for more options."
-        exit(0)
+        return_or_exit(true)
       end
     end
 
@@ -77,6 +78,8 @@ module Whenever
       IO.popen(command.join(' '), 'r+') do |crontab|
         crontab.write(contents)
         crontab.close_write
+        stdout = crontab.read
+        puts stdout unless stdout == ''
       end
 
       success = $?.exitstatus.zero?
@@ -85,10 +88,10 @@ module Whenever
         action = 'written' if @options[:write]
         action = 'updated' if @options[:update]
         puts "[write] crontab file #{action}"
-        exit(0)
+        return_or_exit(true)
       else
         warn "[fail] Couldn't write crontab; try running `whenever' with no options to ensure your schedule file is valid."
-        exit(1)
+        return_or_exit(false)
       end
     end
 
@@ -96,10 +99,10 @@ module Whenever
       # Check for unopened or unclosed identifier blocks
       if read_crontab =~ Regexp.new("^#{comment_open_regex}\s*$") && (read_crontab =~ Regexp.new("^#{comment_close_regex}\s*$")).nil?
         warn "[fail] Unclosed indentifier; Your crontab file contains '#{comment_open(false)}', but no '#{comment_close(false)}'"
-        exit(1)
+        return_or_exit(false)
       elsif (read_crontab =~ Regexp.new("^#{comment_open_regex}\s*$")).nil? && read_crontab =~ Regexp.new("^#{comment_close_regex}\s*$")
         warn "[fail] Unopened indentifier; Your crontab file contains '#{comment_close(false)}', but no '#{comment_open(false)}'"
-        exit(1)
+        return_or_exit(false)
       end
 
       # If an existing identifier block is found, replace it with the new cron entries
@@ -151,5 +154,18 @@ module Whenever
     def timestamp_regex
       " at: \\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2} ([+-]\\d{4}|UTC)"
     end
+
+  private
+
+    def return_or_exit success
+      result = 1
+      result = 0 if success
+      if @options[:console]
+        exit(result)
+      else
+        result
+      end
+    end
+
   end
 end

data/lib/whenever/setup.rb

@@ -1,7 +1,8 @@
 # Environment variable defaults to RAILS_ENV
 set :environment_variable, "RAILS_ENV"
-# Environment defaults to production
-set :environment, "production"
+# Environment defaults to the value of RAILS_ENV in the current environment if
+# it's set or production otherwise
+set :environment, ENV.fetch("RAILS_ENV", "production")
 # Path defaults to the directory `whenever` was run from
 set :path, Whenever.path
 

data/lib/whenever/version.rb

@@ -1,3 +1,3 @@
 module Whenever
-  VERSION = '1.0.0'
+  VERSION = '1.1.0'
 end

data/lib/whenever.rb

@@ -1,3 +1,4 @@
+require "whenever/version"
 require 'whenever/numeric'
 require 'whenever/numeric_seconds'
 require 'whenever/job_list'
@@ -31,4 +32,11 @@ module Whenever
   def self.bundler?
     File.exist?(File.join(path, 'Gemfile'))
   end
+
+  def self.update_cron options
+    o = { 'update' => true, 'console' => false}
+    o.merge! options if options
+    Whenever::CommandLine.execute o
+  end
+
 end

data/test/functional/command_line_test.rb

@@ -398,7 +398,7 @@ class EnvironmentOverwrittenWithoutValueTest < Whenever::TestCase
     file
   end
 
-  should "output the runner using the original environmnet" do
+  should "output the runner using the original environment" do
     assert_match two_hours + %( cd /silly/path && bundle exec script/runner -e silly 'blahblah'), @output
   end
 end

data/test/functional/output_default_defined_jobs_test.rb

@@ -209,6 +209,20 @@ class OutputDefaultDefinedJobsTest < Whenever::TestCase
     assert_match two_hours + ' cd /some/other/path && RAILS_ENV=production bundle exec rake blahblah --silent', output
   end
 
+  test "A rake command that uses the default environment variable when RAILS_ENV is set" do
+    ENV.expects(:fetch).with("RAILS_ENV", "production").returns("development")
+    output = Whenever.cron \
+    <<-file
+      set :job_template, nil
+      set :path, '/my/path'
+      every 2.hours do
+        rake "blahblah"
+      end
+    file
+
+    assert_match two_hours + ' cd /my/path && RAILS_ENV=development bundle exec rake blahblah --silent', output
+  end
+
   test "A rake command that sets the environment variable" do
     output = Whenever.cron \
     <<-file

data/test/test_case.rb

@@ -2,10 +2,10 @@ module Whenever
   require 'minitest/autorun'
   begin
     # 2.0.0
-    class TestCase < MiniTest::Test; end
+    class TestCase < Minitest::Test; end
   rescue NameError
     # 1.9.3
-    class TestCase < MiniTest::Unit::TestCase; end
+    class TestCase < Minitest::Unit::TestCase; end
   end
 
 

data/test/test_helper.rb

@@ -1,6 +1,6 @@
 require 'whenever'
 require 'test_case'
-require 'mocha/setup'
+require 'mocha/minitest'
 
 module Whenever::TestHelpers
   protected

data/whenever.gemspec

@@ -1,28 +1,28 @@
-# -*- encoding: utf-8 -*-
-$:.push File.expand_path("../lib", __FILE__)
-require "whenever/version"
+# frozen_string_literal: true
 
-Gem::Specification.new do |s|
-  s.name        = "whenever"
-  s.version     = Whenever::VERSION
-  s.platform    = Gem::Platform::RUBY
-  s.authors     = ["Javan Makhmali"]
-  s.email       = ["javan@javan.us"]
-  s.license     = "MIT"
-  s.homepage    = "https://github.com/javan/whenever"
-  s.summary     = %q{Cron jobs in ruby.}
-  s.description = %q{Clean ruby syntax for writing and deploying cron jobs.}
-  s.files         = `git ls-files`.split("\n")
-  s.test_files    = `git ls-files -- test/{functional,unit}/*`.split("\n")
-  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
-  s.require_paths = ["lib"]
-  s.required_ruby_version = ">= 1.9.3"
+require_relative "lib/whenever/version"
 
-  s.add_dependency "chronic", ">= 0.6.3"
+Gem::Specification.new do |spec|
+  spec.name        = "whenever"
+  spec.version     = Whenever::VERSION
+  spec.platform    = Gem::Platform::RUBY
+  spec.authors     = ["Javan Makhmali"]
+  spec.email       = ["javan@javan.us"]
 
-  s.add_development_dependency "bundler"
-  s.add_development_dependency "rake"
-  s.add_development_dependency "mocha", ">= 0.9.5"
-  s.add_development_dependency "minitest"
-  s.add_development_dependency "appraisal"
+  spec.summary     = %q{Cron jobs in ruby.}
+  spec.description = %q{Clean ruby syntax for writing and deploying cron jobs.}
+  spec.homepage    = "https://github.com/javan/whenever"
+  spec.license     = "MIT"
+  spec.required_ruby_version = ">= 1.9.3"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/javan/whenever"
+  spec.metadata["changelog_uri"] = "https://github.com/javan/whenever/blob/main/CHANGELOG.md"
+
+  spec.files         = `git ls-files`.split("\n")
+  spec.test_files    = `git ls-files -- test/{functional,unit}/*`.split("\n")
+  spec.executables   = spec.files.grep(%r{\Abin/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "chronic", ">= 0.6.3"
 end

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: whenever
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Javan Makhmali
-autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-06-13 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: chronic
@@ -24,76 +23,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 0.6.3
-- !ruby/object:Gem::Dependency
-  name: bundler
-  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'
-- !ruby/object:Gem::Dependency
-  name: rake
-  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'
-- !ruby/object:Gem::Dependency
-  name: mocha
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.9.5
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.9.5
-- !ruby/object:Gem::Dependency
-  name: minitest
-  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'
-- !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
@@ -103,12 +32,15 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/dependabot.yml"
+- ".github/workflows/ci.yml"
 - ".gitignore"
-- ".travis.yml"
 - Appraisals
 - CHANGELOG.md
+- CONTRIBUTING.md
 - Gemfile
 - LICENSE
+- Makefile
 - README.md
 - Rakefile
 - bin/whenever
@@ -152,8 +84,10 @@ files:
 homepage: https://github.com/javan/whenever
 licenses:
 - MIT
-metadata: {}
-post_install_message: 
+metadata:
+  homepage_uri: https://github.com/javan/whenever
+  source_code_uri: https://github.com/javan/whenever
+  changelog_uri: https://github.com/javan/whenever/blob/main/CHANGELOG.md
 rdoc_options: []
 require_paths:
 - lib
@@ -168,9 +102,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.3
-signing_key: 
+rubygems_version: 3.6.9
 specification_version: 4
 summary: Cron jobs in ruby.
 test_files:

data/.travis.yml

@@ -1,21 +0,0 @@
-language: ruby
-
-before_install:
-  - gem install bundler
-  - unset _JAVA_OPTIONS
-rvm:
-  - 2.4.6
-  - 2.5.5
-  - 2.6.3
-  - jruby-9.2.6.0
-
-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