capistrano-cron 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 8a87a247ec33d72a9a62f6afe1fb81c1e549c381a979d3d0a05025bc6176813b
+  data.tar.gz: 14e5b4ac459edd04996a2bb4e94dd90bc2190fb727fbbb4b093785dd0f314d6c
+SHA512:
+  metadata.gz: 6515d52f18b6b4342b4deb3249c25ffda09d93b41984e0e852a0c9c02335359781fa1df4d507a0b6f64f07358f6fda742f2fb0a2280f1f9610ac80bd7cd3b3a8
+  data.tar.gz: 6b0b9e542c6697f39fdb43f976ecbec578cc0cd03667ca4b33dc5fd3cf46b170cf07227c454d0e15ebbcd1fc7c72c15b637ffaf84268f422b51ca511ea7dd4d6

data/.standard.yml

@@ -0,0 +1,3 @@
+# For available configuration options, see:
+#   https://github.com/standardrb/standard
+ruby_version: 3.0

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2024-11-05
+
+- Initial release

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,132 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, caste, color, religion, or sexual
+identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall
+  community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or advances of
+  any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email address,
+  without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official email address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+[INSERT CONTACT METHOD].
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of
+actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or permanent
+ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior, harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the
+community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.1, available at
+[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
+
+Community Impact Guidelines were inspired by
+[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
+
+For answers to common questions about this code of conduct, see the FAQ at
+[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
+[https://www.contributor-covenant.org/translations][translations].
+
+[homepage]: https://www.contributor-covenant.org
+[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
+[Mozilla CoC]: https://github.com/mozilla/diversity
+[FAQ]: https://www.contributor-covenant.org/faq
+[translations]: https://www.contributor-covenant.org/translations

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 Brice TEXIER
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND 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.

data/README.md

@@ -0,0 +1,49 @@
+# Capistrano::Cron
+
+The gem is based on [whenever](https://github.com/javan/whenever) code.
+The difference is that crontab file is generated and uploaded to the server during deployment.
+No `bin/whenever` is needed on the server. It handles well `asdf` too.
+
+## Installation
+
+TODO: Replace `capistrano-cron` with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org.
+
+Install the gem and add to the application's Gemfile by executing:
+
+    $ bundle add capistrano-cron
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install capistrano-cron
+
+In your Capfile, require the library:
+
+```ruby
+require 'capistrano/cron'
+install_plugin Capistrano::Cron
+```
+
+## Usage
+
+```sh
+cap <stage> cron:update
+cap <stage> cron:clear
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/codeur/capistrano-cron. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/codeur/capistrano-cron/blob/main/CODE_OF_CONDUCT.md).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Capistrano::Cron project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/codeur/capistrano-cron/blob/main/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "minitest/test_task"
+
+Minitest::TestTask.create
+
+require "standard/rake"
+
+task default: %i[test standard]

data/lib/capistrano/cron/job.rb

@@ -0,0 +1,55 @@
+require "shellwords"
+
+class Capistrano::Cron
+  class Job
+    attr_reader :at, :roles, :mailto
+
+    def initialize(options = {})
+      @options = options
+      @at = options.delete(:at)
+      @template = options.delete(:template)
+      @mailto = options.fetch(:mailto, :default_mailto)
+      @job_template = options.delete(:job_template) || ":job"
+      @roles = Array(options.delete(:roles))
+      @options[:output] = options.has_key?(:output) ? Capistrano::Cron::Output::Redirection.new(options[:output]).to_s : ""
+      @options[:environment_variable] ||= "RAILS_ENV"
+      @options[:environment] ||= :production
+      @options[:path] = Shellwords.shellescape(@options[:path])
+    end
+
+    def output
+      job = process_template(@template, @options)
+      out = process_template(@job_template, @options.merge(job: job))
+      out.gsub("%", '\%')
+    end
+
+    def has_role?(role)
+      roles.empty? || roles.include?(role)
+    end
+
+    protected
+
+    def process_template(template, options)
+      template.gsub(/:\w+/) do |key|
+        before_and_after = [$`[-1..-1], $'[0..0]]
+        option = options[key.sub(":", "").to_sym] || key
+
+        if before_and_after.all? { |c| c == "'" }
+          escape_single_quotes(option)
+        elsif before_and_after.all? { |c| c == '"' }
+          escape_double_quotes(option)
+        else
+          option
+        end
+      end.gsub(/\s+/m, " ").strip
+    end
+
+    def escape_single_quotes(str)
+      str.gsub("'") { "'\\''" }
+    end
+
+    def escape_double_quotes(str)
+      str.gsub('"') { '\"' }
+    end
+  end
+end

data/lib/capistrano/cron/job_list.rb

@@ -0,0 +1,193 @@
+require_relative "job"
+require_relative "output/cron"
+require_relative "output/redirection"
+
+class Capistrano::Cron
+  class JobList
+    attr_reader :roles
+
+    def initialize(options)
+      @jobs, @env, @set_variables, @pre_set_variables = {}, {}, {}, {}
+
+      if options.is_a? String
+        options = {string: options}
+      end
+
+      pre_set(options[:set])
+      set(:bundle_command, options[:bundle_command]) if options[:bundle_command]
+      set(:path, options[:path]) if options[:path]
+      set(:environment, options[:environment]) if options[:environment]
+      set(:environment_variable, "RAILS_ENV")
+
+      @roles = options[:roles] || []
+
+      setup_file = File.expand_path("../setup.rb", __FILE__)
+      setup = File.read(setup_file)
+      schedule = if options[:string]
+        options[:string]
+      elsif options[:file]
+        File.read(options[:file])
+      end
+
+      instance_eval(setup, setup_file)
+      instance_eval(schedule, options[:file] || "<eval>")
+    end
+
+    def set(variable, value)
+      variable = variable.to_sym
+      return if @pre_set_variables[variable]
+
+      instance_variable_set(:"@#{variable}", value)
+      @set_variables[variable] = value
+    end
+
+    def method_missing(name, *args, &block)
+      @set_variables.has_key?(name) ? @set_variables[name] : super
+    end
+
+    def self.respond_to?(name, include_private = false)
+      @set_variables.has_key?(name) || super
+    end
+
+    def env(variable, value)
+      @env[variable.to_s] = value
+    end
+
+    def every(frequency, options = {})
+      @current_time_scope = frequency
+      @options = options
+      yield
+    end
+
+    def job_type(name, template)
+      singleton_class.class_eval do
+        define_method(name) do |task, *args|
+          options = {task: task, template: template}
+          options.merge!(args[0]) if args[0].is_a? Hash
+
+          options[:mailto] ||= @options.fetch(:mailto, :default_mailto)
+
+          # :cron_log was an old option for output redirection, it remains for backwards compatibility
+          options[:output] = (options[:cron_log] || @cron_log) if defined?(@cron_log) || options.has_key?(:cron_log)
+          # :output is the newer, more flexible option.
+          options[:output] = @output if defined?(@output) && !options.has_key?(:output)
+
+          @jobs[options.fetch(:mailto)] ||= {}
+          @jobs[options.fetch(:mailto)][@current_time_scope] ||= []
+          @jobs[options.fetch(:mailto)][@current_time_scope] << Capistrano::Cron::Job.new(@options.merge(@set_variables).merge(options))
+        end
+      end
+    end
+
+    def generate_cron_output
+      [environment_variables, cron_jobs].compact.join
+    end
+
+    private
+
+    #
+    # Takes a string like: "variable1=something&variable2=somethingelse"
+    # and breaks it into variable/value pairs. Used for setting variables at runtime from the command line.
+    # Only works for setting values as strings.
+    #
+    def pre_set(variable_string = nil)
+      return if variable_string.nil? || variable_string == ""
+
+      pairs = variable_string.split("&")
+      pairs.each do |pair|
+        next unless pair.index("=")
+        variable, value = *pair.split("=")
+        unless variable.nil? || variable == "" || value.nil? || value == ""
+          variable = variable.strip.to_sym
+          set(variable, value.strip)
+          @pre_set_variables[variable] = value
+        end
+      end
+    end
+
+    def environment_variables
+      return if @env.empty?
+
+      output = []
+      @env.each do |key, val|
+        output << "#{key}=#{(val.nil? || val == "") ? '""' : val}\n"
+      end
+      output << "\n"
+
+      output.join
+    end
+
+    #
+    # Takes the standard cron output that Capistrano::Cron generates and finds
+    # similar entries that can be combined. For example: If a job should run
+    # at 3:02am and 4:02am, instead of creating two jobs this method combines
+    # them into one that runs on the 2nd minute at the 3rd and 4th hour.
+    #
+    def combine(entries)
+      entries.map! { |entry| entry.split(/ +/, 6) }
+      0.upto(4) do |f|
+        (entries.length - 1).downto(1) do |i|
+          next if entries[i][f] == "*"
+          comparison = entries[i][0...f] + entries[i][f + 1..-1]
+          (i - 1).downto(0) do |j|
+            next if entries[j][f] == "*"
+            if comparison == entries[j][0...f] + entries[j][f + 1..-1]
+              entries[j][f] += "," + entries[i][f]
+              entries.delete_at(i)
+              break
+            end
+          end
+        end
+      end
+
+      entries.map { |entry| entry.join(" ") }
+    end
+
+    def cron_jobs_of_time(time, jobs)
+      shortcut_jobs, regular_jobs = [], []
+
+      jobs.each do |job|
+        next unless roles.empty? || roles.any? do |r|
+          job.has_role?(r)
+        end
+        Capistrano::Cron::Output::Cron.output(time, job, chronic_options: @chronic_options) do |cron|
+          cron << "\n"
+
+          if cron[0, 1] == "@"
+            shortcut_jobs << cron
+          else
+            regular_jobs << cron
+          end
+        end
+      end
+
+      shortcut_jobs.join + combine(regular_jobs).join
+    end
+
+    def cron_jobs
+      return if @jobs.empty?
+
+      output = []
+
+      # jobs with default mailto's must be output before the ones with non-default mailto's.
+      @jobs.delete(:default_mailto) { {} }.each do |time, jobs|
+        output << cron_jobs_of_time(time, jobs)
+      end
+
+      @jobs.each do |mailto, time_and_jobs|
+        output_jobs = []
+
+        time_and_jobs.each do |time, jobs|
+          output_jobs << cron_jobs_of_time(time, jobs)
+        end
+
+        output_jobs.reject! { |output_job| output_job.empty? }
+
+        output << "MAILTO=#{mailto}\n" unless output_jobs.empty?
+        output << output_jobs
+      end
+
+      output.join
+    end
+  end
+end

data/lib/capistrano/cron/numeric_ext.rb

@@ -0,0 +1,62 @@
+class Capistrano::Cron
+  class NumericSeconds
+    attr_reader :number
+
+    def self.seconds(number, units)
+      new(number).send(units)
+    end
+
+    def initialize(number)
+      @number = number.to_i
+    end
+
+    def seconds
+      number
+    end
+    alias_method :second, :seconds
+
+    def minutes
+      number * 60
+    end
+    alias_method :minute, :minutes
+
+    def hours
+      number * 3_600
+    end
+    alias_method :hour, :hours
+
+    def days
+      number * 86_400
+    end
+    alias_method :day, :days
+
+    def weeks
+      number * 604_800
+    end
+    alias_method :week, :weeks
+
+    def months
+      number * 2_592_000
+    end
+    alias_method :month, :months
+
+    def years
+      number * 31_557_600
+    end
+    alias_method :year, :years
+  end
+end
+
+Numeric.class_eval do
+  def respond_to?(method, include_private = false)
+    super || Capistrano::Cron::NumericSeconds.public_method_defined?(method)
+  end
+
+  def method_missing(method, *args, &block)
+    if Capistrano::Cron::NumericSeconds.public_method_defined?(method)
+      Capistrano::Cron::NumericSeconds.new(self).send(method)
+    else
+      super
+    end
+  end
+end

data/lib/capistrano/cron/output/cron.rb

@@ -0,0 +1,186 @@
+require "chronic"
+
+class Capistrano::Cron
+  module Output
+    class Cron
+      DAYS = %w[sun mon tue wed thu fri sat]
+      MONTHS = %w[jan feb mar apr may jun jul aug sep oct nov dec]
+      KEYWORDS = [:reboot, :yearly, :annually, :monthly, :weekly, :daily, :midnight, :hourly]
+      REGEX = /^(@(#{KEYWORDS.join "|"})|((\*?[\d\/,\-]*)\s){3}(\*?([\d\/,\-]|(#{MONTHS.join "|"}))*\s)(\*?([\d\/,\-]|(#{DAYS.join "|"}))*))$/i
+
+      attr_accessor :time, :task
+
+      def initialize(time = nil, task = nil, at = nil, options = {})
+        chronic_options = options[:chronic_options] || {}
+
+        @at_given = at
+        @time = time
+        @task = task
+        @at = at.is_a?(String) ? (Chronic.parse(at, chronic_options) || 0) : (at || 0)
+      end
+
+      def self.enumerate(item, detect_cron = true)
+        if item and item.is_a?(String)
+          items =
+            if detect_cron && item =~ REGEX
+              [item]
+            else
+              item.split(",")
+            end
+        else
+          items = item
+          items = [items] unless items and items.respond_to?(:each)
+        end
+        items
+      end
+
+      def self.output(times, job, options = {})
+        enumerate(times).each do |time|
+          enumerate(job.at, false).each do |at|
+            yield new(time, job.output, at, options).output
+          end
+        end
+      end
+
+      def output
+        [time_in_cron_syntax, task].compact.join(" ").strip
+      end
+
+      def time_in_cron_syntax
+        @time = @time.to_i if @time.is_a?(Numeric) # Compatibility with `1.day` format using ruby 2.3 and activesupport
+        case @time
+        when REGEX then @time # raw cron syntax given
+        when Symbol then parse_symbol
+        when String then parse_as_string
+        else parse_time
+        end
+      end
+
+      protected
+
+      def seconds(number, units)
+        Capistrano::Cron::NumericSeconds.seconds(number, units)
+      end
+
+      def day_given?
+        @at_given.is_a?(String) && (MONTHS.any? { |m| @at_given.downcase.index(m) } || @at_given[/\d\/\d/])
+      end
+
+      def parse_symbol
+        shortcut = case @time
+        when *KEYWORDS then "@#{@time}" # :reboot => '@reboot'
+        when :year then seconds(1, :year)
+        when :day then seconds(1, :day)
+        when :month then seconds(1, :month)
+        when :week then seconds(1, :week)
+        when :hour then seconds(1, :hour)
+        when :minute then seconds(1, :minute)
+        end
+
+        if shortcut.is_a?(Numeric)
+          @time = shortcut
+          parse_time
+        elsif shortcut
+          if @at.is_a?(Time) || (@at.is_a?(Numeric) && @at > 0)
+            raise ArgumentError, "You cannot specify an ':at' when using the shortcuts for times."
+          else
+            shortcut
+          end
+        else
+          parse_as_string
+        end
+      end
+
+      def parse_time
+        timing = Array.new(5, "*")
+        case @time
+        when seconds(0, :seconds)...seconds(1, :minute)
+          raise ArgumentError, "Time must be in minutes or higher"
+        when seconds(1, :minute)...seconds(1, :hour)
+          minute_frequency = @time / 60
+          timing[0] = comma_separated_timing(minute_frequency, 59, @at || 0)
+        when seconds(1, :hour)...seconds(1, :day)
+          hour_frequency = (@time / 60 / 60).round
+          timing[0] = @at.is_a?(Time) ? @at.min : range_or_integer(@at, 0..59, "Minute")
+          timing[1] = comma_separated_timing(hour_frequency, 23)
+        when seconds(1, :day)...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 : range_or_integer(@at, 0..23, "Hour")
+          timing[2] = comma_separated_timing(day_frequency, 31, 1)
+        when seconds(1, :month)...seconds(1, :year)
+          month_frequency = (@time / 30 / 24 / 60 / 60).round
+          timing[0] = @at.is_a?(Time) ? @at.min : 0
+          timing[1] = @at.is_a?(Time) ? @at.hour : 0
+          timing[2] = if @at.is_a?(Time)
+            day_given? ? @at.day : 1
+          else
+            (@at == 0) ? 1 : range_or_integer(@at, 1..31, "Day")
+          end
+          timing[3] = comma_separated_timing(month_frequency, 12, 1)
+        when seconds(1, :year)
+          timing[0] = @at.is_a?(Time) ? @at.min : 0
+          timing[1] = @at.is_a?(Time) ? @at.hour : 0
+          timing[2] = if @at.is_a?(Time)
+            day_given? ? @at.day : 1
+          else
+            1
+          end
+          timing[3] = if @at.is_a?(Time)
+            day_given? ? @at.month : 1
+          else
+            (@at == 0) ? 1 : range_or_integer(@at, 1..12, "Month")
+          end
+        else
+          return parse_as_string
+        end
+        timing.join(" ")
+      end
+
+      def parse_as_string
+        return unless @time
+        string = @time.to_s
+
+        timing = Array.new(4, "*")
+        timing[0] = @at.is_a?(Time) ? @at.min : 0
+        timing[1] = @at.is_a?(Time) ? @at.hour : 0
+
+        return (timing << "1-5") * " " if string.downcase.index("weekday")
+        return (timing << "6,0") * " " if string.downcase.index("weekend")
+
+        DAYS.each_with_index do |day, i|
+          return (timing << i) * " " if string.downcase.index(day)
+        end
+
+        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)
+        return start if frequency.nil? || frequency == "" || frequency.zero?
+        return "*" if frequency == 1
+        return frequency if frequency > (max * 0.5).ceil
+
+        original_start = start
+
+        start += frequency unless (max + 1).modulo(frequency).zero? || start > 0
+        output = (start..max).step(frequency).to_a
+
+        max_occurances = (max.to_f / frequency.to_f).round
+        max_occurances += 1 if original_start.zero?
+
+        output[0, max_occurances].join(",")
+      end
+    end
+  end
+end

data/lib/capistrano/cron/output/redirection.rb

@@ -0,0 +1,56 @@
+class Capistrano::Cron
+  module Output
+    class Redirection
+      def initialize(output)
+        @output = output
+      end
+
+      def to_s
+        return "" unless defined?(@output)
+        case @output
+        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
+
+      protected
+
+      def stdout
+        return unless @output.has_key?(:standard)
+        @output[:standard].nil? ? "/dev/null" : @output[:standard]
+      end
+
+      def stderr
+        return unless @output.has_key?(:error)
+        @output[:error].nil? ? "/dev/null" : @output[:error]
+      end
+
+      def redirect_from_hash
+        if stdout == "/dev/null" && stderr == "/dev/null"
+          "> /dev/null 2>&1"
+        elsif stdout && stderr == "/dev/null"
+          ">> #{stdout} 2> /dev/null"
+        elsif stdout && stderr
+          ">> #{stdout} 2>> #{stderr}"
+        elsif stderr == "/dev/null"
+          "2> /dev/null"
+        elsif stderr
+          "2>> #{stderr}"
+        elsif stdout == "/dev/null"
+          "> /dev/null"
+        elsif stdout
+          ">> #{stdout}"
+        else
+          ""
+        end
+      end
+
+      def redirect_from_string
+        ">> #{@output} 2>&1"
+      end
+    end
+  end
+end

data/lib/capistrano/cron/setup.rb

@@ -0,0 +1,9 @@
+# All jobs are wrapped in this template.
+# http://blog.scoutapp.com/articles/2010/09/07/rvm-and-cron-in-production
+set :job_template, "/bin/bash -l -c ':job'"
+
+set :runner_command, "rails runner"
+
+job_type :command, ":task :output"
+job_type :rake, "cd :path && :environment_variable=:environment :bundle_command exec rake :task --silent :output"
+job_type :runner, "cd :path && :bundle_command exec :runner_command -e :environment ':task' :output"

data/lib/capistrano/cron.rb

@@ -0,0 +1,109 @@
+# frozen_string_literal: true
+
+require "capistrano/plugin"
+
+module Capistrano
+  class Cron < Capistrano::Plugin
+    VERSION = "0.1.0"
+
+    def set_defaults
+      set_if_empty :cron_roles, %w[db]
+      set_if_empty :cron_identifier, -> { "#{fetch(:application)}_#{fetch(:stage)}" }
+      set_if_empty :cron_environment, -> { fetch(:stage) }
+      set_if_empty :cron_schedule_path, "config/schedule.rb"
+    end
+
+    def define_tasks
+      eval_rakefile File.expand_path("../tasks/cron.rake", __FILE__)
+    end
+
+    def register_hooks
+      after "deploy:updated", "cron:update"
+      after "deploy:reverted", "cron:update"
+    end
+
+    def update_crontab
+      install_crontab(schedule_cron)
+    end
+
+    def clear_crontab
+      install_crontab("")
+    end
+
+    def identifier
+      fetch(:cron_identifier)
+    end
+
+    private
+
+    def current_crontab
+      @current_crontab ||= begin
+        contents = backend.capture(:crontab, "-l")
+
+        # 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
+        # the file with all of the original seperators in-tact.
+        stripped_contents = contents.split($/, -1)[0..-1].join($/)
+
+        # Some cron implementations require all non-comment lines to be newline-
+        # terminated. (issue #95) Strip all newlines and replace with the default
+        # platform record seperator ($/)
+        stripped_contents.gsub(/\s+$/, $/)
+      end
+    end
+
+    def install_crontab(content)
+      file = release_path.join("tmp", "#{identifier}.cron")
+      backend.upload! StringIO.new(updated_crontab(content)), file
+      backend.execute :cat, file, "| crontab -"
+    end
+
+    def schedule_cron
+      @schedule_cron ||= [comment_open, job_list.generate_cron_output.strip, comment_close].compact.join("\n") + "\n"
+    end
+
+    def job_list
+      @job_list ||= JobList.new(
+        file: fetch(:cron_schedule_path),
+        identifier: identifier,
+        roles: fetch(:cron_roles),
+        path: current_path,
+        environment: fetch(:cron_environment),
+        bundle_command: expanded_bundle_command
+      )
+    end
+
+    def expanded_bundle_command
+      backend.capture(:echo, SSHKit.config.command_map[:bundle]).strip
+    end
+
+    def updated_crontab(cron)
+      # Check for unopened or unclosed identifier blocks
+      if current_crontab =~ Regexp.new("^#{comment_open}\s*$") && (current_crontab =~ Regexp.new("^#{comment_close}\s*$")).nil?
+        fail "Unclosed indentifier; Your crontab file contains '#{comment_open}', but no '#{comment_close}'"
+      elsif (current_crontab =~ Regexp.new("^#{comment_open}\s*$")).nil? && current_crontab =~ Regexp.new("^#{comment_close}\s*$")
+        fail "Unopened indentifier; Your crontab file contains '#{comment_close}', but no '#{comment_open}'"
+      end
+
+      # If an existing identifier block is found, replace it with the new cron entries
+      if current_crontab =~ Regexp.new("^#{comment_open}\s*$") && current_crontab =~ Regexp.new("^#{comment_close}\s*$")
+        # If the existing crontab file contains backslashes they get lost going through gsub.
+        # .gsub('\\', '\\\\\\') preserves them. Go figure.
+        current_crontab.gsub(Regexp.new("^#{comment_open}\s*$.+^#{comment_close}\s*$", Regexp::MULTILINE), cron.chomp.gsub("\\", "\\\\\\"))
+      else # Otherwise, append the new cron entries after any existing ones
+        [current_crontab, cron].join("\n\n")
+      end.gsub(/\n{3,}/, "\n\n") # More than two newlines becomes just two.
+    end
+
+    def comment_open
+      "# >>> #{identifier} jobs generated by capistrano-cron"
+    end
+
+    def comment_close
+      "# <<< #{identifier} jobs"
+    end
+  end
+end
+
+require_relative "cron/numeric_ext"
+require_relative "cron/job_list"

data/lib/capistrano/tasks/cron.rake

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+plugin = self
+
+namespace :cron do # rubocop:disable Metrics
+  desc "Update cron configuration"
+  task :update do
+    on roles(fetch(:cron_roles)) do
+      plugin.update_crontab
+    end
+  end
+
+  desc "Clear cron configuration"
+  task :clear do
+    on roles(fetch(:cron_roles)) do
+      plugin.clear_crontab
+    end
+  end
+end

metadata

@@ -0,0 +1,89 @@
+--- !ruby/object:Gem::Specification
+name: capistrano-cron
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Codeur SAS
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2024-11-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: capistrano
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: chronic
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+description: Capistrano plugin to manage cron jobs created from the whenever gem
+email:
+- dev@codeur.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".standard.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/capistrano/cron.rb
+- lib/capistrano/cron/job.rb
+- lib/capistrano/cron/job_list.rb
+- lib/capistrano/cron/numeric_ext.rb
+- lib/capistrano/cron/output/cron.rb
+- lib/capistrano/cron/output/redirection.rb
+- lib/capistrano/cron/setup.rb
+- lib/capistrano/tasks/cron.rake
+homepage: https://github.com/codeur/capistrano-cron
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/codeur/capistrano-cron
+  source_code_uri: https://github.com/codeur/capistrano-cron
+  changelog_uri: https://github.com/codeur/capistrano-cron/blob/main/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.26
+signing_key:
+specification_version: 4
+summary: Capistrano plugin to manage cron jobs
+test_files: []