cron_expression_generator 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 4107dbe960196e694d0268b66f9074c81d292f2c28243540913d089e232906c4
+  data.tar.gz: d377c8047c9a4e3644e7cf3079f363a96f08d5ed65c0481d2be2937db2b91118
+SHA512:
+  metadata.gz: 1e9213e9ed1f81ccec078f3495d4453d109d670ad41b453ac3d7e2c6caeb43056f1483b430d09fea28e019053768ed33161ff9df8dd733705f6a7c066eb2f0cc
+  data.tar.gz: 5925c84fd7199ea20500dcca73a0b20c10b909e4d6d9b99cd3a641cca46ec8e78d0869d5ff5340ee7c905d76dc73a98f7a37d765e825259cf9fa5e39fa09011f

data/bin/cron_expression_generator

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+
+require "cron_expression_generator"
+puts CronExpressionGenerator.generate(start_time: ARGV[0], end_time: ARGV[1], interval_minutes: ARGV[2])

data/lib/cron_expression_generator.rb

@@ -0,0 +1,191 @@
+require 'date'
+require 'active_support'
+require 'active_support/core_ext'
+
+class CronExpressionGenerator
+  def self.generate(start_time:, end_time:, interval_minutes:)
+    @start_time = start_time
+    @end_time = end_time
+    @interval_minutes = interval_minutes
+
+    self.validate_parameters
+    self.initialize
+
+    cron_expressions = []
+    if @count_up_time == @terminate_time
+      return cron_expressions # return empty if no time difference
+    end
+    @datetime_unit_to_match = self.get_largest_datetime_unit_diff
+    cron_expressions = self.match_largest_datetime_unit
+    cron_expressions += self.match_remaining_datetime
+    cron_expressions
+  end
+
+  private # --------------------------------------------------------
+
+  def self.initialize
+    if @start_time > @end_time
+      message = "start_time is larger than end_time.\n"
+      message += "given, start_time: #{@start_time}, end_time: #{@end_time}"
+      raise ArgumentError, message
+    end
+
+    @min     = 'min'
+    @hour    = 'hour'
+    @day     = 'day'
+    @month   = 'month'
+    @year    = 'year'
+
+    @count_up_time = @start_time
+    @terminate_time = @end_time
+    @interval_minutes = @interval_minutes
+  end
+
+  def self.validate_parameters
+    begin
+      @start_time = DateTime.parse(@start_time) if @start_time.is_a?(String)
+      @end_time = DateTime.parse(@end_time) if @end_time.is_a?(String)
+    rescue
+      raise "Invalid given date format in String. Please pass the string in this format: YYYY-MM-DD HH:MM"
+    end
+  end
+
+  def self.carry_up_minutes_cron
+    "#{@count_up_time.min}-59/#{@interval_minutes} #{@count_up_time.hour} #{@count_up_time.day} #{@count_up_time.month} *"
+  end
+
+  def self.carry_up_hour_cron
+    "*/#{@interval_minutes} #{@count_up_time.hour}-23 #{@count_up_time.day} #{@count_up_time.month} *"
+  end
+
+  def self.carry_up_day_cron(last_day_of_month)
+    "*/#{@interval_minutes} * #{@count_up_time.day}-#{last_day_of_month} #{@count_up_time.month} *"
+  end
+
+  def self.carry_up_months_cron
+    "*/#{@interval_minutes} * * #{@count_up_time.month}-12 *"
+  end
+
+  def self.match_minutes_cron
+    "#{@count_up_time.min}-#{@terminate_time.min}/#{@interval_minutes} #{@terminate_time.hour} #{@terminate_time.day} #{@terminate_time.month} *"
+  end
+
+  def self.match_hour_cron
+    "*/#{@interval_minutes} #{@count_up_time.hour}-#{@terminate_time.hour.to_i - 1} #{@terminate_time.day} #{@terminate_time.month} *"
+  end
+
+  def self.match_day_cron
+    "*/#{@interval_minutes} * #{@count_up_time.day}-#{@terminate_time.day.to_i - 1} #{@terminate_time.month.to_i} *"
+  end
+
+  def self.match_months_cron
+    "*/#{@interval_minutes} * * #{@count_up_time.month}-#{@terminate_time.month.to_i - 1} *"
+  end
+
+  def self.get_largest_datetime_unit_diff
+    if @count_up_time.year != @terminate_time.year
+      @year
+    elsif @count_up_time.month != @terminate_time.month
+      @month
+    elsif @count_up_time.day != @terminate_time.day
+      @day
+    elsif @count_up_time.hour != @terminate_time.hour
+      @hour
+    elsif @count_up_time.min != @terminate_time.min
+      @min
+    else
+      message = "Unexpected value received to time_at & terminate_time_at.\n"
+      message += "given, count_up_time: #{@count_up_time}, terminate_time: #{@terminate_time}"
+      raise ArgumentError, message
+    end
+  end
+
+  def self.minutes_is_carried_up?
+    @datetime_unit_to_match != @min && @count_up_time.min != 0
+  end
+
+  def self.hour_is_carried_up?
+    @datetime_unit_to_match != @min && @datetime_unit_to_match != @hour && @count_up_time.hour != 0
+  end
+
+  def self.day_is_carried_up?
+    @datetime_unit_to_match != @min && @datetime_unit_to_match != @hour && @datetime_unit_to_match != @day && @count_up_time.day != 1
+  end
+
+  def self.months_is_carried_up?
+    @datetime_unit_to_match != @min && @datetime_unit_to_match != @hour && @datetime_unit_to_match != @day && @datetime_unit_to_match != @month && @count_up_time.month != 1
+  end
+
+  def self.minutes_is_matched?
+    @count_up_time.min == @terminate_time.min
+  end
+
+  def self.hour_is_matched?
+    @count_up_time.hour == @terminate_time.hour
+  end
+
+  def self.day_is_matched?
+    @count_up_time.day == @terminate_time.day
+  end
+
+  def self.months_is_matched?
+    @count_up_time.month == @terminate_time.month
+  end
+
+  def self.carry_up_time(time:, unit:)
+    if unit == @min
+      @count_up_time += time.minute
+    elsif unit == @hour
+      @count_up_time += time.hour
+    elsif unit == @day
+      @count_up_time += time.day
+    elsif unit == @month
+      @count_up_time += time.month
+    else
+      message = "Unexpected value passed to received to unit.\n"
+      message += "given, unit: #{unit}"
+      raise ArgumentError, message
+    end
+  end
+
+  def self.match_largest_datetime_unit
+    cron_expressions = []
+
+    # minutes
+    if self.minutes_is_carried_up?
+      cron_expressions.append(self.carry_up_minutes_cron)
+      remaining_minutes = 60 - @count_up_time.min.to_i
+      self.carry_up_time(time: remaining_minutes, unit: @min)
+    end
+    # hour
+    if self.hour_is_carried_up?
+      cron_expressions.append(self.carry_up_hour_cron)
+      remaining_hours = 24 - @count_up_time.hour.to_i
+      self.carry_up_time(time: remaining_hours, unit: @hour)
+    end
+    # day
+    if self.day_is_carried_up?
+      last_day_of_month = @count_up_time.end_of_month.strftime('%d').to_i
+      cron_expressions.append(self.carry_up_day_cron(last_day_of_month))
+      remaining_days = last_day_of_month - @count_up_time.day.to_i + 1
+      self.carry_up_time(time: remaining_days, unit: @day)
+    end
+    # months
+    if self.months_is_carried_up?
+      cron_expressions.append(self.carry_up_months_cron)
+      remaining_months = 12 - @count_up_time.month.to_i + 1
+      self.carry_up_time(time: remaining_months, unit: @month)
+    end
+
+    cron_expressions
+  end
+
+  def self.match_remaining_datetime
+    cron_expressions = []
+    cron_expressions.append(self.match_months_cron)  unless self.months_is_matched?
+    cron_expressions.append(self.match_day_cron)     unless self.day_is_matched?
+    cron_expressions.append(self.match_hour_cron)    unless self.hour_is_matched?
+    cron_expressions.append(self.match_minutes_cron) unless self.minutes_is_matched?
+    cron_expressions
+  end
+end

metadata

@@ -0,0 +1,46 @@
+--- !ruby/object:Gem::Specification
+name: cron_expression_generator
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Itaru Kishikawa
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2022-12-31 00:00:00.000000000 Z
+dependencies: []
+description: This generates a set of cron expression(s) based on the given date and
+  interval minutes.
+email: itaru.kishikawa@gmail.com
+executables:
+- cron_expression_generator
+extensions: []
+extra_rdoc_files: []
+files:
+- bin/cron_expression_generator
+- lib/cron_expression_generator.rb
+homepage: https://rubygems.org/gems/cron_expression_generator
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.7
+signing_key:
+specification_version: 4
+summary: Cron Expression Generator
+test_files: []