cron_calc 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 65bbd980a990785461ad8513755d5ef1effc8d14f4dac4205bf0381f4489bbcd
-  data.tar.gz: 116ac513ff00017a519997d1399748faa95284b2171e6f11c5097a25b10525ee
+  metadata.gz: 29ac47b06a1dc188f3fb9ed5c10f9fa1a6ef748e8d15a6783eb7b8f99de85b38
+  data.tar.gz: 8f136ff6c1010357acd75942e80bc7d4a2f4b0d1b8555041486f1cc9bdd97f00
 SHA512:
-  metadata.gz: 70d5d114af61a0430a52b8ef0fc06caecc693fe8f632472814f4335543b038ba6c94565069f831ee7486a8633e015e8833c65b6f1ba2814832a7bb5e4352c9fb
-  data.tar.gz: cb5b23e742052e1b76035721214c28c2a9ce162b70d7c1d60bb308e378db36318c3e4ceac9e65b4a7dc779c1cc710109880f8b921f00580df77bf5f1cc8d3539
+  metadata.gz: 38f8b7a5a0f80d10f6c4867a8a2e687b9ebb508c5e79031856cbb9bc81a9a97b6f399e0b37f332f5ec5aeb7d2839e29d11b6e76b0fdc5601b675a6a5ed82e806
+  data.tar.gz: d1545c32cd0559370fc1778c3517567ee0be5f4fecf41ad32af0a2a3fd3202d52f0b9d5014f202ab736c8174675d2c7692610fa72968f247022082aa7a2b5567

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+## [0.4.0] - 2023-12-22
+
+- Added support for named months and wdays
+- Keyword arguments: before:, after:
+
 ## [0.3.0] - 2023-12-22
 
 - Added support for DOWs

data/README.md

@@ -22,8 +22,9 @@ Now, you can use one of three methods `#in`, `#next`, `#last` to determine cron
 ### Using `#in`
 
 Calculates cron job occurrences within a given time period.\
-@param period [Range] The time period for which to calculate cron job occurrences.\
-@return [Array<Time>] An array of Time instances representing each occurrence.
+**Parameters:**
+- `period` - a Range object defining the start and end times for the calculation.\
+
 
 ```ruby
     period = Time.new(2024, 1, 1, 0, 0)..Time.new(2024, 1, 4, 0, 0)
@@ -35,10 +36,10 @@ Calculates cron job occurrences within a given time period.\
 ### Using `#next`
 
 Calculates the next 'n' occurrences of the cron job from a given start time.\
-@param count [Integer] The number of occurrences to calculate. Defaults to `1`.\
-@param period_start [Time] The start time from which to calculate occurrences. Defaults to `Time.now`.\
-@param max_years [Integer] The maximum number of years to consider for the period. Defaults to `5`.\
-@return [Array<Time>] An array of the next 'n' occurrences.
+**Parameters:**
+- `count` - (optional, Integer) The number of occurrences to calculate. Defaults to 1.
+- `after:` - (optional, Time, keyword argument) The start time from which to calculate occurrences. If not provided, defaults to the current time (Time.now).
+- `max_years` - (optional, Integer, keyword argument) The maximum number of years to search for future occurrences. Defaults to 5.
 
 ```ruby
     cron_calc.next
@@ -47,29 +48,28 @@ Calculates the next 'n' occurrences of the cron job from a given start time.\
     cron_calc.next(3)
     # => [2023-12-20 05:05:00 +0100, 2023-12-21 05:05:00 +0100, 2023-12-22 05:05:00 +0100]
 
-    cron_calc.next(2, Time.new(2024, 1, 1, 0, 0))
+    cron_calc.next(2, after: Time.new(2024, 1, 1, 0, 0))
     # => [2024-01-01 05:05:00 +0100, 2024-01-02 05:05:00 +0100]
 ```
 
 ### Using `#last`
 
 Calculates the last 'n' occurrences of the cron job until a given end time.\
-@param count [Integer] The number of past occurrences to calculate.\
-@param period_end [Time] The end time until which to calculate occurrences.\
-@param max_years [Integer] The maximum number of years to consider for the period.\
-@return [Array<Time>] An array of the last 'n' occurrences.
+**Parameters:**
+- `count` - (optional, Integer) The number of occurrences to calculate. Defaults to 1.
+- `before:` - (optional, Time, keyword argument) The end time from which to calculate past occurrences. If not provided, defaults to the current time (Time.now).
+- `max_years` - (optional, Integer, keyword argument) The maximum number of years to search backward for past occurrences. Defaults to 5.
 
 ```ruby
     cron_calc.last
     # => [2023-12-19 05:05:00 +0100]
 
-    cron_calc.last(4, Time.new(2024, 1, 1, 0, 0))
+    cron_calc.last(4, before: Time.new(2024, 1, 1, 0, 0))
     # => [2023-12-31 05:05:00 +0100, 2023-12-30 05:05:00 +0100, 2023-12-29 05:05:00 +0100, 2023-12-28 05:05:00 +0100]
 ```
 
 ## Unsupported features
 
-- Named DOW and months (SUN-SAT, JAN-DEC)
 - Joining characters , - /
 - Predefined definitions (@yearly, @monthly, @weekly, @daily, @midnight, @hourly)
 

data/lib/cron_calc/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module CronCalc
-  VERSION = '0.3.0'
+  VERSION = '0.4.0'
 end

data/lib/cron_calc.rb

@@ -22,7 +22,18 @@ module CronCalc
       hours: 0..23,
       days: 1..31,
       months: 1..12,
-      dows: 0..7
+      wdays: 0..6
+    }.freeze
+
+    WDAYS = {
+      'SUN' => '0', 'MON' => '1', 'TUE' => '2', 'WED' => '3',
+      'THU' => '4', 'FRI' => '5', 'SAT' => '6'
+    }.freeze
+
+    MONTHS = {
+      'JAN' => '1', 'FEB' => '2', 'MAR' => '3', 'APR' => '4',
+      'MAY' => '5', 'JUN' => '6', 'JUL' => '7', 'AUG' => '8',
+      'SEP' => '9', 'OCT' => '10', 'NOV' => '11', 'DEC' => '12'
     }.freeze
 
     def initialize(cron_string)
@@ -42,24 +53,24 @@ module CronCalc
 
     # Calculates the next 'n' occurrences of the cron job from a given start time.
     # @param count [Integer] The number of occurrences to calculate.
-    # @param period_start [Time] The start time from which to calculate occurrences.
+    # @param after [Time] The start time from which to calculate occurrences.
     # @param max_years [Integer] The maximum number of years to consider for the period.
     # @return [Array<Time>] An array of the next 'n' occurrences.
-    def next(count = 1, period_start = Time.now, max_years = 5)
+    def next(count = 1, after: Time.now, max_years: 5)
       occurrences(
-        period_start..(period_start + (60 * 60 * 24 * 365 * max_years)),
+        after..(after + (60 * 60 * 24 * 365 * max_years)),
         count
       )
     end
 
     # Calculates the last 'n' occurrences of the cron job until a given end time.
     # @param count [Integer] The number of past occurrences to calculate.
-    # @param period_end [Time] The end time until which to calculate occurrences.
+    # @param before [Time] The end time until which to calculate occurrences.
     # @param max_years [Integer] The maximum number of years to consider for the period.
     # @return [Array<Time>] An array of the last 'n' occurrences.
-    def last(count = 1, period_end = Time.now, max_years = 5)
+    def last(count = 1, before: Time.now, max_years: 5)
       occurrences(
-        (period_end - (60 * 60 * 24 * 365 * max_years))..period_end,
+        (before - (60 * 60 * 24 * 365 * max_years))..before,
         count,
         reverse: true
       )
@@ -69,7 +80,7 @@ module CronCalc
 
     def occurrences(period, count = nil, reverse: false)
       time_combinations = generate_time_combinations(period, reverse).lazy
-      wdays = parse_cron_part(:dows)
+      wdays = parse_cron_part(:wdays)
 
       time_combinations.each_with_object([]) do |(year, month, day, hour, minute), occ|
         break occ if count && occ.length == count
@@ -94,8 +105,8 @@ module CronCalc
         minutes: splitted[0],
         hours: splitted[1],
         days: splitted[2],
-        months: splitted[3],
-        dows: splitted[4]
+        months: normalize_with(splitted[3], MONTHS),
+        wdays: normalize_with(splitted[4], WDAYS)
       }
     end
 
@@ -123,9 +134,13 @@ module CronCalc
     end
     # rubocop:enable Metrics
 
+    def normalize_with(string, mapping)
+      mapping.inject(string) { |str, (k, v)| str.gsub(k, v) }
+    end
+
     def cron_string_valid?
       # rubocop:disable Layout/LineLength
-      regex = %r{\A(\*|([0-5]?\d)(,([0-5]?\d))*|(\*/\d+)|(\d+-\d+)) (\*|([01]?\d|2[0-3])(,([01]?\d|2[0-3]))*|(\*/\d+)|(\d+-\d+)) (\*|([12]?\d|3[01])(,([12]?\d|3[01]))*|(\*/\d+)|(\d+-\d+)) (\*|([1-9]|1[0-2])(,([1-9]|1[0-2]))*|(\*/\d+)|(\d+-\d+)) (\*|([0-6])(,([0-6]))*|(\*/[0-6]+)|([0-6]-[0-6]))\z}
+      regex = %r{\A(\*|([0-5]?\d)(,([0-5]?\d))*|(\*/\d+)|(\d+-\d+)) (\*|([01]?\d|2[0-3])(,([01]?\d|2[0-3]))*|(\*/\d+)|(\d+-\d+)) (\*|([12]?\d|3[01])(,([12]?\d|3[01]))*|(\*/\d+)|(\d+-\d+)) (\*|(JAN|FEB|MAR|APR|MAY|JUN|JUL|AUG|SEP|OCT|NOV|DEC|[1-9]|1[0-2])(,(JAN|FEB|MAR|APR|MAY|JUN|JUL|AUG|SEP|OCT|NOV|DEC|[1-9]|1[0-2])|-(JAN|FEB|MAR|APR|MAY|JUN|JUL|AUG|SEP|OCT|NOV|DEC))*|(\*/\d+)|(\d+-\d+)) (\*|(SUN|MON|TUE|WED|THU|FRI|SAT|[0-6])(,(SUN|MON|TUE|WED|THU|FRI|SAT|[0-6])|-(SUN|MON|TUE|WED|THU|FRI|SAT))*|(\*/[0-6]+)|([0-6]-[0-6]))\z}
       # rubocop:enable Layout/LineLength
       cron_string.match?(regex)
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cron_calc
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Jakub Miziński