cron_describer 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: a72eb20b1b1637fff6bf409289667313e77d8d6524315099b8b4620ab4f0c72c
+  data.tar.gz: 5c4da5ac5775ecb2d9b439ecfc8a1f0ada6ccde97a75acc924366a9b6f4a9c0f
+SHA512:
+  metadata.gz: be4cc3cd5ff45fb9a8865b070ff1a831c9c709573d077731fb5c26ed6729b0879791c7943dcaceb7c9ea94bf0d6727a9948a3bfcf5c84608c2d15a389ba14c2c
+  data.tar.gz: daae3b954bcc707b8dab8228bb2749d6e7a019d779ae05999bfe182f3aa56f7b94dee588dc1115f31232fde4b9f8b64887d533ad9b154e273318cd28b3147108

data/.rspec

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

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2023-09-08
+
+- Initial release

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2023 Aleksander Lopez
+
+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,54 @@
+# CronDescriber
+
+CronDescriber is a simple Ruby gem that converts cron schedule strings into human-readable time descriptions. It can help you describe complex cron schedules in a way that is easy to understand.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'cron_describer'
+```
+
+And then execute:
+
+```
+$ bundle install
+```
+
+Or install it yourself as:
+
+```
+$ gem install cron_describer
+```
+
+
+## Usage
+
+Here is a basic example of how to use the CronDescriber gem:
+
+```ruby
+require 'cron_describer'
+
+cron_schedule = "30 6 1 */3 *"
+description = CronDescriber.parse(cron_schedule)
+puts description
+# Output: "At 6:30 AM, on day 1 of the month, every 3 months"
+```
+
+You can pass any valid cron schedule string to the describe_cron method to get a human-readable description.
+
+## 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 tags, and push the `.gem` file to rubygems.org.
+
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/logicalgroove/cron_describer. This project is intended to be a safe, welcoming space for collaboration,
+
+## 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,8 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/cron_describer.gemspec

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+require_relative "lib/cron_describer/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "cron_describer"
+  spec.version = CronDescriber::VERSION
+  spec.authors = ["Aleksander Lopez Yazikov"]
+  spec.email = ["webodessa@gmail.com"]
+
+  spec.summary = "A gem to convert cron schedule strings into human-readable time"
+  spec.description = "A Ruby gem that takes a cron schedule string and converts it into a human-readable time description."
+  spec.homepage = "https://github.com/logicalgroove/cron_describer"
+  spec.license = "MIT"
+  spec.required_ruby_version = ">= 2.6.0"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/logicalgroove/cron_describer"
+  spec.metadata["changelog_uri"] = "https://github.com/logicalgroove/cron_describer"
+
+  # 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 .circleci appveyor Gemfile])
+    end
+  end
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

data/lib/cron_describer/version.rb

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

data/lib/cron_describer.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+require_relative "cron_describer/version"
+
+module CronDescriber
+  class Error < StandardError; end
+
+  def self.parse(cron_schedule)
+    days_of_week = {0 => "Sunday", 1 => "Monday", 2 => "Tuesday", 3 => "Wednesday", 4 => "Thursday", 5 => "Friday", 6 => "Saturday"}
+
+    minute, hour, day_of_month, month, day_of_week = cron_schedule.split(" ")
+
+    time_string = ""
+    day_string = ""
+    month_string = ""
+
+    # For time string
+    if minute == "0" && hour != "*"
+      time_string = "At #{hour.to_i}:00 AM"
+    elsif minute != "*" && hour != "*"
+      hour_val = hour.to_i
+      time_string = "At #{hour_val > 12 ? hour_val - 12 : hour_val}:#{minute.to_i.to_s.rjust(2, '0')} #{hour_val >= 12 ? 'PM' : 'AM'}"
+    elsif minute != "*" && hour == "*"
+      time_string = "At #{minute.to_i} minutes past the hour"
+    end
+
+    # For day string
+    if day_of_month != "*"
+      day_string = ", on day #{day_of_month} of the month"
+    elsif day_of_week =~ /\d#(\d)/
+      week_num = $1
+      day_num = day_of_week[0].to_i
+      day_string = ", on the #{week_num.ordinalize} #{days_of_week[day_num]} of the month"
+    elsif day_of_week != "*"
+      day_num = day_of_week.to_i
+      day_string = ", only on #{days_of_week[day_num]}"
+    end
+
+    # For month string
+    if month != "*" && month != "*/1"
+      month_string = ", every #{month.gsub('*/','')} months"
+    end
+
+    return "#{time_string}#{day_string}#{month_string}"
+  end
+end

data/sig/cron_describer.rbs

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

metadata

@@ -0,0 +1,70 @@
+--- !ruby/object:Gem::Specification
+name: cron_describer
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Aleksander Lopez Yazikov
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2023-09-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: A Ruby gem that takes a cron schedule string and converts it into a human-readable
+  time description.
+email:
+- webodessa@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- CHANGELOG.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- cron_describer.gemspec
+- lib/cron_describer.rb
+- lib/cron_describer/version.rb
+- sig/cron_describer.rbs
+homepage: https://github.com/logicalgroove/cron_describer
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/logicalgroove/cron_describer
+  source_code_uri: https://github.com/logicalgroove/cron_describer
+  changelog_uri: https://github.com/logicalgroove/cron_describer
+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.2.32
+signing_key:
+specification_version: 4
+summary: A gem to convert cron schedule strings into human-readable time
+test_files: []