cron_calc 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 5757a8135782488cf246c22cd72ccc0aa04e00d06a726203df41205c0df79ef8
+  data.tar.gz: d33394dd5136e58f41a4ea7d8e6759d5e51326e61bb9bc4303d9778d6f85de60
+SHA512:
+  metadata.gz: 708988f704dee9a33f9331c3508485c2bcc45d7184fac956c590dad69e468e8eabb282a863d391f13f655c1816ef2aae62e77b8d66db755cec4122530ddde178
+  data.tar.gz: 4dfc4c4c89ea7e983d95837dfb014992c2916b0cb54d731cb2f95441687cddf94bfeb90133cc180fddd4e3a96d23254819c8ec416db1498200270a67c291af5b

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,7 @@
+AllCops:
+  TargetRubyVersion: 2.6
+  NewCops: enable
+
+Metrics/BlockLength:
+  Exclude:
+    - spec/cron_calc_spec.rb

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2023-11-27
+
+- Initial release

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2023 Jakub Miziński
+
+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,33 @@
+# CronCalc
+
+CronCalc: A Ruby gem for calculating and analyzing scheduled CRON job occurrences and timings within specified intervals.
+
+## Installation
+
+TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG` 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 UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` 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/mizinsky/cron_calc.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+require 'rubocop/rake_task'
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/cron_calc.gemspec

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+require_relative 'lib/cron_calc/version'
+
+Gem::Specification.new do |spec|
+  spec.name = 'cron_calc'
+  spec.version = CronCalc::VERSION
+  spec.authors = ['Jakub Miziński']
+  spec.email = ['jakubmizinski@gmail.com']
+
+  spec.summary = 'calculates cron job occurrences'
+  spec.description = 'calculates cron job occurrences within a specified period'
+  spec.homepage = 'https://github.com/mizinsky/cron_calc'
+  spec.license = 'MIT'
+  spec.required_ruby_version = '>= 2.6.0'
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = 'https://github.com/mizinsky/cron_calc'
+  spec.metadata['changelog_uri'] = 'https://github.com/mizinsky/cron_calc/blob/main/CHANGELOG.md'
+  spec.metadata['rubygems_mfa_required'] = 'true'
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(__dir__) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (File.expand_path(f) == __FILE__) ||
+        f.start_with?(*%w[bin/ test/ spec/ features/ .git .github appveyor Gemfile])
+    end
+  end
+  spec.bindir = 'exe'
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  # Uncomment to register a new dependency of your gem
+  spec.add_dependency 'rspec', '~> 3.12'
+
+  # For more information and examples about making a new gem, check out our
+  # guide at: https://bundler.io/guides/creating_gem.html
+end

data/lib/cron_calc/version.rb

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

data/lib/cron_calc.rb

@@ -0,0 +1,88 @@
+# frozen_string_literal: true
+
+require_relative 'cron_calc/version'
+require 'time'
+
+# The CronCalc is gem-wrapper module for the Parser class
+module CronCalc
+  class Error < StandardError; end
+
+  def self.new(cron_string, period)
+    Parser.new(cron_string, period)
+  end
+
+  # The Parser class provides functionality to parse and calculate occurrences
+  # of cron jobs within a given time period. It interprets cron strings and
+  # calculates when cron jobs will occur
+  class Parser
+    attr_reader :cron_string, :cron_parts, :period
+
+    RANGE = {
+      minutes: 0..59,
+      hours: 0..23,
+      days: 1..31,
+      months: 1..12
+    }.freeze
+
+    def initialize(cron_string, period)
+      @cron_string = cron_string
+      @period = period
+      @cron_parts = split_cron_string
+    end
+
+    def occurrences
+      raise 'Cron expression is not supported or invalid' unless cron_string_valid?
+
+      minutes, hours, days, months, years = parse_cron_expression
+
+      years.product(months, days, hours, minutes).each_with_object([]) do |(year, month, day, hour, minute), occ|
+        time = Time.new(year, month, day, hour, minute)
+        occ << time if Date.valid_date?(year, month, day) && period.include?(time)
+      end
+    end
+
+    private
+
+    def split_cron_string
+      splitted = cron_string.split
+
+      {
+        minutes: splitted[0],
+        hours: splitted[1],
+        days: splitted[2],
+        months: splitted[3]
+      }
+    end
+
+    def parse_cron_expression
+      %i[minutes hours days months].map { |unit| parse_cron_part(unit) } << (period.min.year..period.max.year).to_a
+    end
+
+    # rubocop:disable Metrics
+    def parse_cron_part(time_unit)
+      range = RANGE[time_unit]
+      part = cron_parts[time_unit]
+
+      case part
+      when '*'
+        range.to_a
+      when /,/
+        part.split(',').map(&:to_i)
+      when /-/
+        (part.split('-').first.to_i..part.split('-').last.to_i).to_a
+      when %r{/}
+        range.step(part.split('/').last.to_i).to_a
+      else
+        [part.to_i]
+      end
+    end
+    # rubocop:enable Metrics
+
+    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+)) \*\z}
+      # rubocop:enable Layout/LineLength
+      cron_string.match?(regex)
+    end
+  end
+end

data/sig/cron_calc.rbs

@@ -0,0 +1,4 @@
+module CronCalc
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,71 @@
+--- !ruby/object:Gem::Specification
+name: cron_calc
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Jakub Miziński
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2023-12-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.12'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.12'
+description: calculates cron job occurrences within a specified period
+email:
+- jakubmizinski@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- CHANGELOG.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- cron_calc.gemspec
+- lib/cron_calc.rb
+- lib/cron_calc/version.rb
+- sig/cron_calc.rbs
+homepage: https://github.com/mizinsky/cron_calc
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/mizinsky/cron_calc
+  source_code_uri: https://github.com/mizinsky/cron_calc
+  changelog_uri: https://github.com/mizinsky/cron_calc/blob/main/CHANGELOG.md
+  rubygems_mfa_required: 'true'
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.22
+signing_key: 
+specification_version: 4
+summary: calculates cron job occurrences
+test_files: []