cronut 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4c43ded70bbed5f6cb9b5957274437899b14449c
+  data.tar.gz: d9edc9ac3bc194ea8b37c4dd7e5c24961f41f727
+SHA512:
+  metadata.gz: 40cc2971b966b3b88d28631b16dee5caea14c776b6b948fc0319cd74ec7047c1e722f75453372ae03f6ece15fff5d2cb077202292ab620707e688c8d38d11a53
+  data.tar.gz: fd81cc22af64660cfdce0fb22c7a20d15bc15b9ae2f587d1fefc9624a444657f5d5114bea7fb8e212946992e8988aaa40acf601b59b0aa96645e0394edff8b52

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.4.1
+  - 2.3.4

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE.md

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Josh McMillan
+
+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,79 @@
+# Cronut
+
+<img align="right" width="150" src="https://upload.wikimedia.org/wikipedia/commons/9/99/Cronut.jpg">
+
+Cronut is a tool for taking a cron expression (e.g. `* * * * * /bin/yes`) and outputting the times at which that cron expression will run. It supports most standard Vixie cron syntax, with some exceptions – see [known issues](#known-issues).
+
+## Installation
+
+1. Ensure you have Ruby 2.3 or higher installed
+1. Run `gem install cronut`
+
+## Usage
+
+There are two ways to use Cronut:
+
+### As a command-line tool
+
+To use Cronut as a command-line tool and get human-readable representations of a cron expression, simply run:
+
+```
+cronut <your_cron_expression>
+```
+
+For example:
+
+```
+cronut '*/15 0 1,15 * 1-5 /usr/bin/find'
+```
+
+will output:
+
+```
+minute        0 15 30 45
+hour          0
+day of month  1 15
+month         1 2 3 4 5 6 7 8 9 10 11 12
+day of week   1 2 3 4 5
+command       /usr/bin/find
+```
+
+### As a library
+
+After you've required Cronut in your application (via `require 'cronut'` or your Gemfile), it can be used like so:
+
+```ruby
+expression = Cronut::Expression.new('* * * * * /bin/yes')
+=> #<Cronut::Expression:0x007f975d06c8d0>
+
+expression.weekday.possibilities
+=> [0, 1, 2, 3, 4, 5, 6]
+
+expression.command
+=> "/bin/yes"
+```
+
+## Known Issues
+
+The following (largely non-standard) features of some cron parsers are currently unsupported:
+
+1. Shorthand macros (e.g. `@yearly`, `@monthly`, `@daily`)
+1. Compositions of lists, ranges and steps (e.g. `1-2,3,*/4`)
+1. Alternative single values for months (e.g. `JAN`, `DEC`)
+1. Alternative single values for weekdays (e.g. `MON`, `SUN`)
+
+## Development
+
+To work on Cronut:
+
+1. Clone this repository
+1. Run `bundle install`
+1. Run the tests using `rake`
+
+## License
+
+This project is licensed under the [MIT License](https://opensource.org/licenses/MIT).
+
+## Contribution Guidelines
+
+Please note that this project is released with a [Contributor Code of Conduct](http://contributor-covenant.org/version/1/4/). By participating in this project you agree to abide by its terms.

data/Rakefile

@@ -0,0 +1,6 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/cronut

@@ -0,0 +1,17 @@
+#!/usr/bin/env ruby
+
+require 'cronut'
+
+expression = ARGV[0]
+
+unless expression
+  puts 'Usage: cronut <expression>'
+  exit 1
+end
+
+begin
+  puts Cronut::Expression.new(expression)
+rescue ArgumentError => e
+  puts "Unable to parse '#{expression}': #{e.message}"
+  exit 1
+end

data/cronut.gemspec

@@ -0,0 +1,26 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'cronut/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'cronut'
+  spec.version       = Cronut::VERSION
+  spec.authors       = ['Josh McMillan']
+  spec.email         = ['josh@joshmcmillan.co.uk']
+
+  spec.summary       = 'A simple cron parser'
+  spec.homepage      = 'https://github.com/mcmillan/cronut'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+
+  spec.bindir        = 'bin'
+  spec.executables   = ['cronut']
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.14'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+end

data/lib/cronut.rb

@@ -0,0 +1,18 @@
+require 'cronut/version'
+
+require 'cronut/parser'
+require 'cronut/parser/base'
+require 'cronut/parser/any'
+require 'cronut/parser/list'
+require 'cronut/parser/range'
+require 'cronut/parser/step'
+require 'cronut/parser/exact'
+
+require 'cronut/segment/base'
+require 'cronut/segment/minute'
+require 'cronut/segment/hour'
+require 'cronut/segment/day'
+require 'cronut/segment/month'
+require 'cronut/segment/weekday'
+
+require 'cronut/expression'

data/lib/cronut/expression.rb

@@ -0,0 +1,36 @@
+module Cronut
+  class Expression
+    attr_reader :expression, :minute, :hour, :day, :month, :weekday, :command
+
+    def initialize(expression)
+      @expression = expression
+      parse
+    end
+
+    def to_s
+      <<~EOF
+        minute        #{minute}
+        hour          #{hour}
+        day of month  #{day}
+        month         #{month}
+        day of week   #{weekday}
+        command       #{command}
+      EOF
+    end
+
+    private
+
+    def parse
+      segments = expression.strip.split(/\s+/, 6)
+
+      raise ArgumentError, 'Must be 6 segments' unless segments.count == 6
+
+      @minute = Cronut::Segment::Minute.new(segments[0])
+      @hour = Cronut::Segment::Hour.new(segments[1])
+      @day = Cronut::Segment::Day.new(segments[2])
+      @month = Cronut::Segment::Month.new(segments[3])
+      @weekday = Cronut::Segment::Weekday.new(segments[4])
+      @command = segments[5]
+    end
+  end
+end

data/lib/cronut/parser.rb

@@ -0,0 +1,22 @@
+module Cronut
+  module Parser
+    def self.for(segment:, maximum:, minimum:)
+      case segment
+      when '*'
+        klass = Cronut::Parser::Any
+      when /,/
+        klass = Cronut::Parser::List
+      when /[0-9]+-[0-9]+/
+        klass = Cronut::Parser::Range
+      when /\//
+        klass = Cronut::Parser::Step
+      when /^[0-9]+$/
+        klass = Cronut::Parser::Exact
+      else
+        raise ArgumentError, "Invalid segment: #{segment}"
+      end
+
+      klass.new(segment: segment, maximum: maximum, minimum: minimum)
+    end
+  end
+end

data/lib/cronut/parser/any.rb

@@ -0,0 +1,11 @@
+module Cronut
+  module Parser
+    class Any < Base
+      private
+
+      def generate_possibilities
+        (minimum..maximum).to_a
+      end
+    end
+  end
+end

data/lib/cronut/parser/base.rb

@@ -0,0 +1,35 @@
+module Cronut
+  module Parser
+    class Base
+      attr_reader :segment, :minimum, :maximum, :possibilities
+
+      def initialize(segment:, minimum:, maximum:)
+        @segment = segment
+        @minimum = minimum
+        @maximum = maximum
+
+        @possibilities = generate_possibilities
+        validate_possibilities!
+      end
+
+      private
+
+      def generate_possibilities
+        raise NotImplementedError
+      end
+
+      def validate_possibilities!
+        @possibilities.each do |possibility|
+          next if (minimum..maximum).cover?(possibility)
+          raise ArgumentError, 'Possibilities exceed permitted range'
+        end
+      end
+
+      def safely_convert_to_integer(n)
+        Integer(n)
+      rescue ArgumentError
+        raise ArgumentError, "Non-numeric value supplied: #{n}"
+      end
+    end
+  end
+end

data/lib/cronut/parser/exact.rb

@@ -0,0 +1,11 @@
+module Cronut
+  module Parser
+    class Exact < Base
+      private
+
+      def generate_possibilities
+        @possibilities = [safely_convert_to_integer(segment)]
+      end
+    end
+  end
+end

data/lib/cronut/parser/list.rb

@@ -0,0 +1,13 @@
+module Cronut
+  module Parser
+    class List < Base
+      private
+
+      def generate_possibilities
+        segment.split(',').map do |n|
+          safely_convert_to_integer(n)
+        end
+      end
+    end
+  end
+end

data/lib/cronut/parser/range.rb

@@ -0,0 +1,15 @@
+module Cronut
+  module Parser
+    class Range < Base
+      private
+
+      def generate_possibilities
+        from, to = segment.split('-', 2).map do |n|
+          safely_convert_to_integer(n)
+        end
+
+        (from..to).to_a
+      end
+    end
+  end
+end

data/lib/cronut/parser/step.rb

@@ -0,0 +1,21 @@
+module Cronut
+  module Parser
+    class Step < Base
+      private
+
+      def generate_possibilities
+        start, step = segment.split('/', 2)
+
+        start = minimum if start == '*'
+
+        start = safely_convert_to_integer(start)
+        step = safely_convert_to_integer(step)
+
+        raise ArgumentError, 'start exceeds maximum' if start > maximum
+        raise ArgumentError, 'step exceeds maximum' if step > maximum
+
+        start.upto(maximum).each_slice(step).map(&:first)
+      end
+    end
+  end
+end

data/lib/cronut/segment/base.rb

@@ -0,0 +1,30 @@
+module Cronut
+  module Segment
+    class Base
+      attr_reader :possibilities
+
+      def initialize(segment)
+        parser = Cronut::Parser.for(
+          segment: segment,
+          minimum: minimum,
+          maximum: maximum
+        )
+        @possibilities = parser.possibilities
+      end
+
+      def to_s
+        possibilities.join(' ')
+      end
+
+      private
+
+      def minimum
+        raise NotImplementedError
+      end
+
+      def maximum
+        raise NotImplementedError
+      end
+    end
+  end
+end

data/lib/cronut/segment/day.rb

@@ -0,0 +1,15 @@
+module Cronut
+  module Segment
+    class Day < Base
+      private
+
+      def minimum
+        1
+      end
+
+      def maximum
+        31
+      end
+    end
+  end
+end

data/lib/cronut/segment/hour.rb

@@ -0,0 +1,15 @@
+module Cronut
+  module Segment
+    class Hour < Base
+      private
+
+      def minimum
+        0
+      end
+
+      def maximum
+        23
+      end
+    end
+  end
+end

data/lib/cronut/segment/minute.rb

@@ -0,0 +1,15 @@
+module Cronut
+  module Segment
+    class Minute < Base
+      private
+
+      def minimum
+        0
+      end
+
+      def maximum
+        59
+      end
+    end
+  end
+end

data/lib/cronut/segment/month.rb

@@ -0,0 +1,15 @@
+module Cronut
+  module Segment
+    class Month < Base
+      private
+
+      def minimum
+        1
+      end
+
+      def maximum
+        12
+      end
+    end
+  end
+end

data/lib/cronut/segment/weekday.rb

@@ -0,0 +1,15 @@
+module Cronut
+  module Segment
+    class Weekday < Base
+      private
+
+      def minimum
+        0
+      end
+
+      def maximum
+        6
+      end
+    end
+  end
+end

data/lib/cronut/version.rb

@@ -0,0 +1,3 @@
+module Cronut
+  VERSION = '0.1.1'.freeze
+end

metadata

@@ -0,0 +1,112 @@
+--- !ruby/object:Gem::Specification
+name: cronut
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Josh McMillan
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-08-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !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: 
+email:
+- josh@joshmcmillan.co.uk
+executables:
+- cronut
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.md
+- README.md
+- Rakefile
+- bin/cronut
+- cronut.gemspec
+- lib/cronut.rb
+- lib/cronut/expression.rb
+- lib/cronut/parser.rb
+- lib/cronut/parser/any.rb
+- lib/cronut/parser/base.rb
+- lib/cronut/parser/exact.rb
+- lib/cronut/parser/list.rb
+- lib/cronut/parser/range.rb
+- lib/cronut/parser/step.rb
+- lib/cronut/segment/base.rb
+- lib/cronut/segment/day.rb
+- lib/cronut/segment/hour.rb
+- lib/cronut/segment/minute.rb
+- lib/cronut/segment/month.rb
+- lib/cronut/segment/weekday.rb
+- lib/cronut/version.rb
+homepage: https://github.com/mcmillan/cronut
+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: []
+rubyforge_project: 
+rubygems_version: 2.6.11
+signing_key: 
+specification_version: 4
+summary: A simple cron parser
+test_files: []