crontab_syntax_checker 0.1.0

data/Gemfile

@@ -0,0 +1,14 @@
+source "http://rubygems.org"
+# Add dependencies required to use your gem here.
+# Example:
+#   gem "activesupport", ">= 2.3.5"
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem "shoulda", ">= 0"
+  gem "rdoc", "~> 3.12"
+  gem "bundler", "~> 1.0"
+  gem "jeweler", "~> 2.0.1"
+  gem "simplecov", ">= 0"
+end

data/License.txt

@@ -0,0 +1,7 @@
+Copyright (c) 2011 Stephen Sloan
+
+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,83 @@
+# Crontab Syntax Checker - Validate crontab entries
+
+Ruby gem to validate an entry that will be used in [crontab](http://www.manpagez.com/man/5/crontab/ "man 5 crontab").
+
+## Quick start examples
+
+The crontab syntax checker is simple to use. These examples demonstrate three ways to quickly check that an entry is formatted correctly.
+
+### Example 1 - Verify from a string
+
+You may input your candidate crontab entry as a string to the verify_crontab_line() function:
+
+```ruby
+> require 'crontab_syntax_checker'
+=> true 
+> verify_crontab_line("5,35 */2 10-20,25-30 * 1-5 /foo/var | spam - > eggs.log")
+=> "5,35 */2 10-20,25-30 * 1-5 /foo/var | spam - > eggs.log"
+```
+
+A string representation is returned upon success.  A RuntimeError is raised when the format is invalid.
+
+### Example 2 - Verify from a hash
+
+Another way to validate entries is by breaking up the crontab fields into a hash:
+
+```ruby
+> require 'crontab_syntax_checker'
+=> true 
+> verify_crontab_hash(
+    :minute=>"5,35",
+    :hour=>"*/2",
+    :day=>"10-20,25-30",
+    :month=>"*",
+    :weekday=>"1-5",
+    :command=>"/foo/var | spam - > eggs.log")
+=> "5,35 */2 10-20,25-30 * 1-5 /foo/var | spam - > eggs.log"
+```
+
+A string representation is returned upon success.  A RuntimeError is raised when the format is invalid.
+
+### Example 3 - Using an object
+
+Finally you can create a CrontabLine object directly and use setter methods for each field, which will be validated as they are set.  For example:
+
+```ruby
+> require 'crontab_syntax_checker'
+=> true
+> crontab = CrontabLine.new
+=> #<CrontabLine:0x100... >
+> crontab.minute = "5,35"
+=> "5,35"
+> crontab.hour = "*/2"
+=> "*/2"
+> crontab.day = "10-20,25-30"
+=> "10-20,25-30"
+> crontab.month = "*"
+=> "*"
+> crontab.weekday = "1-5"
+=> "1-5"
+> crontab.command = "/foo/var | spam - > eggs.log"
+=> "/foo/var | spam - > eggs.log"
+> crontab.to_s
+=> "5,35 */2 10-20,25-30 * 1-5 /foo/var | spam - > eggs.log"
+```
+
+When no RuntimeError is raised, the crontab field is valid.
+
+# Notes
+
+Keep in mind that the verify functions or CrontabLine#to_s may not return exactly the same string as your input.  The output, though possibly not equal, should be equivalent crontab syntax.  If a crontab list in a field contains an asterisk, with no stepping indicated, then the entire field will be converted to an asterisk.  Extra white space in the command field will be truncated.  If this is a concern, use your own input in crontab after it has been validated.
+
+The crontab validation here is based on the man 5 crontab file syntax description.  Supported fields are asterisks, numbers, ranges, lists, and stepping (for ranges and asterisks).  Numbers must be within the valid range as per the man file.  Not supported are macro/named times.  See the man file for more info.
+
+# Credits
+
+Crontab Syntax Checker is maintained by [Stephen Sloan](https://github.com/SteveSJ76) and is funded by [BookRenter.com](http://www.bookrenter.com "BookRenter.com").
+
+![BookRenter.com Logo](http://assets0.bookrenter.com/images/header/bookrenter_logo.gif "BookRenter.com")
+
+
+# Copyright
+
+Copyright (c) 2011 Stephen Sloan, Bookrenter.com. See LICENSE.txt for further details.

data/Rakefile

@@ -0,0 +1,50 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://guides.rubygems.org/specification-reference/ for more options
+  gem.name = 'crontab_syntax_checker'
+  gem.homepage = 'https://github.com/bkr/crontab_syntax_checker'
+  gem.summary = 'Validate an entry that will be used in crontab'
+  gem.license = "MIT"
+  gem.email = 'steve@stevesloan.com'
+  gem.authors = ['Stephen Sloan']
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+desc "Code coverage detail"
+task :simplecov do
+  ENV['COVERAGE'] = "true"
+  Rake::Task['test'].execute
+end
+
+task :default => :test
+
+require 'rdoc/task'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "helloworld #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/lib/crontab_fields.rb

@@ -0,0 +1,100 @@
+
+class AbstractCrontabField
+  @@CRONTAB_FIELD_REGEX = /^(\*|(\d)+)(-(\d+))?(\/(\d+))?$/
+  @@START_GROUP_NUM = 1
+  @@STOP_GROUP_NUM = 4
+  @@STEP_GROUP_NUM = 6
+  @@ASTERISK_FIELD_REGEX = /^\*(\/(\d+))?$/
+  def initialize(start, stop=nil, step=nil)
+    @start = start.to_i
+    @stop = stop.nil? ? @start : stop.to_i
+    @step = step.nil? ? 1 : step.to_i
+    if @step > 1 and @stop == @start
+      raise "Stepping must be used with ranges or asterisk only"
+    end
+  end
+  def self.create_from_string(field_string)
+    md = @@CRONTAB_FIELD_REGEX.match(field_string)
+    if md
+      asterisk_md = @@ASTERISK_FIELD_REGEX.match(md[@@START_GROUP_NUM])
+      if asterisk_md
+        step = md[@@STEP_GROUP_NUM]
+        CrontabAsterisk.new(step)
+      else
+        start = md[@@START_GROUP_NUM]
+        stop = md[@@STOP_GROUP_NUM]
+        step = md[@@STEP_GROUP_NUM]
+        new(start, stop, step)
+      end
+    else
+      raise "Can't parse crontab field \"#{field_string}\""
+    end
+  end
+  def to_s
+    as_s = @start.to_s
+    as_s += "-#{@stop}" if @stop > @start
+    as_s += "/#{@step}" if @step > 1
+    as_s
+  end
+end
+
+class CrontabAsterisk < AbstractCrontabField
+  def initialize(step=nil)
+    step.nil? ? @step = 1 : @step = step.to_i
+  end
+  def to_s
+    as_s = '*'
+    as_s += "/#{@step}" if @step > 1
+    as_s
+  end
+end
+
+class CrontabMinute < AbstractCrontabField
+  @@min = 0
+  @@max = 59
+  def initialize(start, stop=nil, step=nil)
+    super(start, stop, step)
+    raise "Minute field #{@start} must not be greater than #{@@min}" if @start < @@min
+    raise "Minute field #{@stop} must not be greater than #{@@max}" if @stop > @@max
+  end
+end
+
+class CrontabHour < AbstractCrontabField
+  @@min = 0
+  @@max = 23
+  def initialize(start, stop=nil, step=nil)
+    super(start, stop, step)
+    raise "Hour field #{@start} must not be greater than #{@@min}" if @start < @@min
+    raise "Hour field #{@stop} must not be greater than #{@@max}" if @stop > @@max
+  end
+end
+
+class CrontabDay < AbstractCrontabField
+  @@min = 1
+  @@max = 31
+  def initialize(start, stop=nil, step=nil)
+    super(start, stop, step)
+    raise "Day field #{@start} must not be greater than #{@@min}" if @start < @@min
+    raise "Day field #{@stop} must not be greater than #{@@max}" if @stop > @@max
+  end
+end
+
+class CrontabMonth < AbstractCrontabField
+  @@min = 1
+  @@max = 12
+  def initialize(start, stop=nil, step=nil)
+    super(start, stop, step)
+    raise "Month field #{@start} must not be greater than #{@@min}" if @start < @@min
+    raise "Month field #{@stop} must not be greater than #{@@max}" if @stop > @@max
+  end
+end
+
+class CrontabWeekday < AbstractCrontabField
+  @@min = 0
+  @@max = 7
+  def initialize(start, stop=nil, step=nil)
+    super(start, stop, step)
+    raise "Weekday field #{@start} must not be greater than #{@@min}" if @start < @@min
+    raise "Weekday field #{@stop} must not be greater than #{@@max}" if @stop > @@max
+  end
+end

data/lib/crontab_line.rb

@@ -0,0 +1,86 @@
+require 'crontab_fields'
+require 'crontab_line_base'
+
+class CrontabLine < CrontabLineBase
+
+  cron_attr_accessor :minute, :hour, :day, :month, :weekday
+  attr_accessor :user
+  attr_reader :command
+
+  @@ENTRY_REGEX = /^([-\/,0-9*]+)\s+([-\/,0-9*]+)\s+([-\/,0-9*]+)\s+([-\/,0-9*]+)\s+([-\/,0-9*]+)\s+(.*)$/
+  @@MINUTE_GROUP_NUM = 1
+  @@HOUR_GROUP_NUM = 2
+  @@DAY_GROUP_NUM = 3
+  @@MONTH_GROUP_NUM = 4
+  @@WEEKDAY_GROUP_NUM = 5
+  @@COMMAND_GROUP_NUM = 6
+  @@SPACE_IN_LIST_REGEX = /\d+(-\d+(\/\d+)?)?,\s\d+/
+  def initialize
+    @minute = [CrontabAsterisk.new]
+    @hour = [CrontabAsterisk.new]
+    @day = [CrontabAsterisk.new]
+    @month = [CrontabAsterisk.new]
+    @weekday = [CrontabAsterisk.new]
+    @command = ""
+    @user = nil
+  end
+  def command=(value)
+    value = "" if value.nil?
+    value = value.to_s unless value.instance_of?(String)
+    @command = value
+  end
+  def self.create_by_hash(crontab_hash)
+    crontab = CrontabLine.new
+    crontab_hash.each() do |key, value|
+        crontab.send("#{key}=", value)
+    end
+    crontab
+  end
+  def self.create_by_entry(entry)
+    md = @@SPACE_IN_LIST_REGEX.match(entry)
+    if md
+      raise "I think you have a space in a crontab field (but I'm not very smart).  " +
+           "Use 'create_by_hash()' instead to override me."
+    end
+    md = @@ENTRY_REGEX.match(entry)
+    if md
+      crontab = CrontabLine.new
+      crontab.minute = md[@@MINUTE_GROUP_NUM]
+      crontab.hour = md[@@HOUR_GROUP_NUM]
+      crontab.day = md[@@DAY_GROUP_NUM]
+      crontab.month = md[@@MONTH_GROUP_NUM]
+      crontab.weekday = md[@@WEEKDAY_GROUP_NUM]
+      crontab.command = md[@@COMMAND_GROUP_NUM]
+      crontab
+    else
+      raise "Entry did match expected pattern"
+    end
+  end
+  def to_s
+    fields = [minute, hour, day, month, weekday, command]
+    fields.insert(-2, user) unless user.nil?
+    fields.join(" ")
+  end
+  private
+  @@FIELD_CLASS_BY_PARAM = {
+    :@minute => CrontabMinute,
+    :@hour => CrontabHour,
+    :@day => CrontabDay,
+    :@month => CrontabMonth,
+    :@weekday => CrontabWeekday
+  }
+  def get_field_class(param)
+    @@FIELD_CLASS_BY_PARAM[param]
+  end
+  def param_setter(param, value)
+    raise "Crontab fields may not contain white-space characters" if value =~ /\s/
+    value = "*" if value.nil?
+    value = value.to_s unless value.instance_of? String
+    if value =~ /\*(,|$)/
+      instance_variable_set(param, [CrontabAsterisk.new])
+    else
+      minute_strings = value.split(',')
+      instance_variable_set(param, minute_strings.map {|min_s| (get_field_class(param)).create_from_string(min_s)})
+    end
+  end
+end

data/lib/crontab_line_base.rb

@@ -0,0 +1,14 @@
+class CrontabLineBase
+  def self.make_cron_attr(field_sym)
+    field_str = field_sym.to_s
+    define_method(field_sym) do
+      instance_variable_get("@#{field_str}").join(',')
+    end
+    define_method("#{field_str}=") do |value|
+      param_setter("@#{field_str}".to_sym, value)
+    end
+  end
+  def self.cron_attr_accessor(*args)
+    args.each { |arg| self.make_cron_attr(arg) }
+  end
+end

data/lib/crontab_syntax_checker.rb

@@ -0,0 +1,17 @@
+require 'crontab_line'
+
+def verify_crontab_line(crontab_line)
+  begin
+    CrontabLine.create_by_entry(crontab_line).to_s
+  rescue RuntimeError => e
+    raise "Invalid entry \"#{crontab_line}\": #{e.message}"
+  end
+end
+
+def verify_crontab_hash(crontab_hash)
+  begin
+    CrontabLine.create_by_hash(crontab_hash).to_s
+  rescue RuntimeError => e
+    raise "Invalid entry \"#{crontab_hash.inspect}\": #{e.message}"
+  end
+end

data/test/test_crontab_line.rb

@@ -0,0 +1,513 @@
+$:.unshift(File.join("..","lib",File.dirname(__FILE__)))
+require 'test/unit'
+require 'crontab_syntax_checker'
+
+class TestCrontabLineGetters < Test::Unit::TestCase
+  def setup
+    @crontab = CrontabLine.new
+  end
+  def test_default_minute
+    assert_equal '*', @crontab.minute, "Default minute is wrong"
+  end
+  def test_default_hour
+    assert_equal '*', @crontab.hour, "Default hour is wrong"
+  end
+  def test_default_day
+    assert_equal '*', @crontab.day, "Default day is wrong"
+  end
+  def test_default_month
+    assert_equal '*', @crontab.month, "Default month is wrong"
+  end
+  def test_default_weekday
+    assert_equal '*', @crontab.weekday, "Default weekday is wrong"
+  end
+  def test_default_command
+    assert_equal '', @crontab.command, "Default command is wrong"
+  end
+end
+
+class TestCrontabLineSetters < Test::Unit::TestCase
+  def setup
+    @crontab = CrontabLine.new
+  end
+  def test_set_minute_to_1
+    @crontab.minute = "1"
+    assert_equal "1", @crontab.minute, "The minute value was incorrect"
+  end
+  def test_set_minute_to_1_by_int
+    @crontab.minute = 1
+    assert_equal "1", @crontab.minute, "The minute value was incorrect"
+  end
+  def test_set_minute_to_1_2_3
+    set_to = "1,2,3"
+    @crontab.minute = set_to
+    assert_equal set_to, @crontab.minute, "The minute value was incorrect"
+  end
+  def test_set_minute_to_nil
+    @crontab.minute = nil
+    assert_equal '*', @crontab.minute, "The minute value was incorrect"
+  end
+  def test_set_hour_to_1
+    @crontab.hour = "1"
+    assert_equal "1", @crontab.hour, "The hour value was incorrect"
+  end
+  def test_set_hour_to_1_by_int
+    @crontab.hour = 1
+    assert_equal "1", @crontab.hour, "The hour value was incorrect"
+  end
+  def test_set_hour_to_1_2_3
+    set_to = "1,2,3"
+    @crontab.hour = set_to
+    assert_equal set_to, @crontab.hour, "The hour value was incorrect"
+  end
+  def test_set_hour_to_nil
+    @crontab.hour = nil
+    assert_equal '*', @crontab.hour, "The hour value was incorrect"
+  end
+  def test_set_day_to_1
+    @crontab.day = "1"
+    assert_equal "1", @crontab.day, "The day value was incorrect"
+  end
+  def test_set_day_to_1_by_int
+    @crontab.day = 1
+    assert_equal "1", @crontab.day, "The day value was incorrect"
+  end
+  def test_set_day_to_1_2_3
+    set_to = "1,2,3"
+    @crontab.day = set_to
+    assert_equal set_to, @crontab.day, "The day value was incorrect"
+  end
+  def test_set_day_to_nil
+    @crontab.day = nil
+    assert_equal '*', @crontab.day, "The day value was incorrect"
+  end
+  def test_set_month_to_1
+    @crontab.month = "1"
+    assert_equal '1', @crontab.month, "The month value was incorrect"
+  end
+  def test_set_month_to_1_by_int
+    @crontab.month = 1
+    assert_equal '1', @crontab.month, "The month value was incorrect"
+  end
+  def test_set_month_to_1_2_3
+    set_to = '1,2,3'
+    @crontab.month = set_to
+    assert_equal set_to, @crontab.month, "The month value was incorrect"
+  end
+  def test_set_month_to_nil
+    @crontab.month = nil
+    assert_equal '*', @crontab.month, "The month value was incorrect"
+  end
+  def test_set_weekday_to_1
+    @crontab.weekday = '1'
+    assert_equal '1', @crontab.weekday, "The weekday value was incorrect"
+  end
+  def test_set_weekday_to_1_by_int
+    @crontab.weekday = 1
+    assert_equal '1', @crontab.weekday, "The weekday value was incorrect"
+  end
+  def test_set_weekday_to_1_2_3
+    set_to = '1,2,3'
+    @crontab.weekday = set_to
+    assert_equal set_to, @crontab.weekday, "The weekday value was incorrect"
+  end
+  def test_set_weekday_to_nil
+    @crontab.weekday = nil
+    assert_equal '*', @crontab.weekday, "The weekday value was incorrect"
+  end
+  def test_set_command_no_space
+    @crontab.command = "foobar"
+    assert_equal "foobar", @crontab.command, "The command value was incorrect"
+  end
+  def test_set_command_with_space
+    set_to = "foo -bar | spam - > eggs.log"
+    @crontab.command = set_to
+    assert_equal set_to, @crontab.command, "The command value was incorrect"
+  end
+  def test_set_command_nill
+    @crontab.command = nil
+    assert_equal "", @crontab.command, "The command value was incorrect"
+  end
+end
+
+class TestCrontabLineValidNumbers < Test::Unit::TestCase
+  def setup
+    @crontab = CrontabLine.new
+  end
+  def test_minute_too_low
+    assert_raise(RuntimeError) { @crontab.minute = -1 }
+    assert_raise(RuntimeError) { @crontab.minute = -10 }
+    assert_raise(RuntimeError) { @crontab.minute = -100 }
+  end
+  def test_minute_just_right
+    (0..59).to_enum.each do |i|
+      assert_nothing_raised(RuntimeError) { @crontab.minute = i }
+      assert_equal i.to_s, @crontab.minute, "Minute value didn't match"
+    end
+  end
+  def test_minute_too_high
+    assert_raise(RuntimeError) {  @crontab.minute = 60 }
+    assert_raise(RuntimeError) {  @crontab.minute = 100 }
+    assert_raise(RuntimeError) {  @crontab.minute = 1000 }
+  end
+  def test_hour_too_low
+    assert_raise(RuntimeError) { @crontab.hour = -1 }
+    assert_raise(RuntimeError) { @crontab.hour = -10 }
+    assert_raise(RuntimeError) { @crontab.hour = -100 }
+  end
+  def test_hour_just_right
+    (0..23).to_enum.each do |i|
+      assert_nothing_raised(RuntimeError) { @crontab.hour = i }
+      assert_equal i.to_s, @crontab.hour, "Hour value didn't match"
+    end
+  end
+  def test_hour_too_high
+    assert_raise(RuntimeError) { @crontab.hour = 24 }
+    assert_raise(RuntimeError) { @crontab.hour = 240 }
+    assert_raise(RuntimeError) { @crontab.hour = 2400 }
+  end
+  def test_day_too_low
+    assert_raise(RuntimeError) { @crontab.day = 0 }
+    assert_raise(RuntimeError) { @crontab.day = -1 }
+    assert_raise(RuntimeError) { @crontab.day = -10 }
+  end
+  def test_day_just_right
+    (1..31).to_enum.each do |i|
+      assert_nothing_raised(RuntimeError) { @crontab.day = i }
+      assert_equal i.to_s, @crontab.day, "Day value didn't match"
+    end
+  end
+  def test_day_too_high
+    assert_raise(RuntimeError) { @crontab.day = 32 }
+    assert_raise(RuntimeError) { @crontab.day = 320 }
+    assert_raise(RuntimeError) { @crontab.day = 3200 }
+  end
+  def test_month_too_low
+    assert_raise(RuntimeError) { @crontab.month = 0 }
+    assert_raise(RuntimeError) { @crontab.month = -1 }
+    assert_raise(RuntimeError) { @crontab.month = -10 }
+  end
+  def test_month_just_right
+    (1..12).to_enum.each do |i|
+      assert_nothing_raised(RuntimeError) { @crontab.month = i }
+      assert_equal i.to_s, @crontab.month, "Month value didn't match"
+    end
+  end
+  def test_month_too_high
+    assert_raise(RuntimeError) { @crontab.month = 13 }
+    assert_raise(RuntimeError) { @crontab.month = 100 }
+    assert_raise(RuntimeError) { @crontab.month = 1000 }
+  end
+  def test_weekday_too_low
+    assert_raise(RuntimeError) { @crontab.weekday = -1 }
+    assert_raise(RuntimeError) { @crontab.weekday = -10 }
+    assert_raise(RuntimeError) { @crontab.weekday = -100 }
+  end
+  def test_weekday_just_right
+    (0..7).to_enum.each do |i|
+      assert_nothing_raised(RuntimeError) { @crontab.weekday = i }
+      assert_equal i.to_s, @crontab.weekday, "Weekday value didn't match"
+    end
+  end
+  def test_weekday_too_high
+    assert_raise(RuntimeError) { @crontab.weekday = 8 }
+    assert_raise(RuntimeError) { @crontab.weekday = 10 }
+    assert_raise(RuntimeError) { @crontab.weekday = 100 }
+  end
+end
+
+class TestCrontabLineRanges < Test::Unit::TestCase
+  def setup
+    @crontab = CrontabLine.new
+  end
+  def test_minute_range_low_end
+    assert_nothing_raised(RuntimeError) { @crontab.minute = "0-5" }
+    assert_equal "0-5", @crontab.minute
+  end
+  def test_minute_range_high_end
+    assert_nothing_raised(RuntimeError) { @crontab.minute = "54-59"}
+    assert_equal "54-59", @crontab.minute
+  end
+  def test_minute_entire_range
+    assert_nothing_raised(RuntimeError) { @crontab.minute = "0-59" }
+    assert_equal "0-59", @crontab.minute
+  end
+  def test_minute_multiple_ranges
+    set_to = "0-5,10-15,50-59"
+    assert_nothing_raised(RuntimeError) { @crontab.minute = set_to }
+    assert_equal set_to, @crontab.minute
+  end
+  def test_minute_out_of_range_high
+    assert_raise(RuntimeError) { @crontab.minute = "0-100" }
+  end
+  def test_minute_out_of_range_low
+    assert_raise(RuntimeError) { @crontab.minute = "-1-59" }
+  end
+  def test_minute_multiple_out_of_range
+    assert_raise(RuntimeError) { @crontab.minute = "0-5,50-100" }
+  end
+  def test_hour_range_low_end
+    assert_nothing_raised(RuntimeError) { @crontab.hour = "0-5" }
+    assert_equal "0-5", @crontab.hour
+  end
+  def test_hour_range_high_end
+    assert_nothing_raised(RuntimeError) { @crontab.hour = "18-23" }
+    assert_equal "18-23", @crontab.hour
+  end
+  def test_hour_entire_range
+    assert_nothing_raised(RuntimeError) { @crontab.hour = "0-23" }
+    assert_equal "0-23", @crontab.hour
+  end
+  def test_hour_multiple_ranges
+    set_to = "0-1,2-3,8-10,15-23"
+    assert_nothing_raised(RuntimeError) { @crontab.hour = set_to }
+    assert_equal set_to, @crontab.hour
+  end
+  def test_hour_out_of_range_high
+    assert_raise(RuntimeError) { @crontab.hour = "0-100" }
+  end
+  def test_hour_out_of_range_low
+    assert_raise(RuntimeError) { @crontab.hour = "-1-23" }
+  end
+  def test_hour_multiple_out_of_range
+    assert_raise(RuntimeError) { @crontab.hour = "0-10,15-24" }
+  end
+  def test_day_range_low_end
+    assert_nothing_raised(RuntimeError) { @crontab.day = "1-6" }
+    assert_equal "1-6", @crontab.day
+  end
+  def test_day_range_high_end
+    assert_nothing_raised(RuntimeError) { @crontab.day = "26-31"}
+    assert_equal "26-31", @crontab.day
+  end
+  def test_day_entire_range
+    assert_nothing_raised(RuntimeError) { @crontab.day = "1-31" }
+    assert_equal "1-31", @crontab.day
+  end
+  def test_day_multiple_ranges
+    set_to = "1-5,10-15,20-30"
+    assert_nothing_raised(RuntimeError) { @crontab.day = set_to }
+    assert_equal set_to, @crontab.day
+  end
+  def test_day_out_of_range_high
+    assert_raise(RuntimeError) { @crontab.day = "0-100" }
+  end
+  def test_day_out_of_range_low
+    assert_raise(RuntimeError) { @crontab.day = "-1-31" }
+  end
+  def test_day_multiple_out_of_range
+    assert_raise(RuntimeError) { @crontab.day = "0-10,30-35,15-25" }
+  end
+  def test_month_range_low_end
+    assert_nothing_raised(RuntimeError) { @crontab.month = "1-6" }
+    assert_equal "1-6", @crontab.month
+  end
+  def test_month_range_high_end
+    assert_nothing_raised(RuntimeError) { @crontab.month = "5-12"}
+    assert_equal "5-12", @crontab.month
+  end
+  def test_month_entire_range
+    assert_nothing_raised(RuntimeError) { @crontab.month = "1-12" }
+    assert_equal "1-12", @crontab.month
+  end
+  def test_month_multiple_ranges
+    set_to = "1-3,5-8,11-12"
+    assert_nothing_raised(RuntimeError) { @crontab.month = set_to }
+    assert_equal set_to, @crontab.month
+  end
+  def test_month_out_of_range_high
+    assert_raise(RuntimeError) { @crontab.month = "0-100" }
+  end
+  def test_month_out_of_range_low
+    assert_raise(RuntimeError) { @crontab.month = "-1-12" }
+  end
+  def test_month_multiple_out_of_range
+    assert_raise(RuntimeError) { @crontab.month = "1-3,5-8,11-14" }
+  end
+  def test_weekday_range_low_end
+    assert_nothing_raised(RuntimeError) { @crontab.weekday = "0-3" }
+    assert_equal "0-3", @crontab.weekday
+  end
+  def test_weekday_range_high_end
+    assert_nothing_raised(RuntimeError) { @crontab.weekday = "4-7" }
+    assert_equal "4-7", @crontab.weekday
+  end
+  def test_weekday_entire_range
+    assert_nothing_raised(RuntimeError) { @crontab.weekday = "0-7" }
+    assert_equal "0-7", @crontab.weekday
+  end
+  def test_weekday_multiple_ranges
+    set_to = "1-2,3-4,6-7"
+    assert_nothing_raised(RuntimeError) { @crontab.weekday = set_to }
+    assert_equal set_to, @crontab.weekday
+  end
+  def test_weekday_out_of_range_high
+    assert_raise(RuntimeError) { @crontab.weekday = "0-100" }
+  end
+  def test_weekday_out_of_range_low
+    assert_raise(RuntimeError) { @crontab.weekday = "-1-7" }
+  end
+  def test_weekday_multiple_out_of_range
+    assert_raise(RuntimeError) { @crontab.weekday = "0-2,4-10,7" }
+  end
+end
+
+class TestCrontabLineStepping < Test::Unit::TestCase
+  def setup
+    @crontab = CrontabLine.new
+  end
+  def test_minute_asterix_with_stepping
+    set_to = '*/2'
+    assert_nothing_raised(RuntimeError) { @crontab.minute = set_to }
+    assert_equal set_to, @crontab.minute
+  end
+  def test_minute_range_with_stepping
+    set_to = '0-30/5'
+    assert_nothing_raised(RuntimeError) { @crontab.minute = set_to }
+    assert_equal set_to, @crontab.minute
+  end
+  def test_minute_stepping_with_multiple_ranges
+    set_to = '0-10/2,12,13-15,18-21/3'
+    assert_nothing_raised(RuntimeError) { @crontab.minute = set_to }
+    assert_equal set_to, @crontab.minute
+  end
+  def test_minute_stepping_with_no_range_raises
+    set_to = '10/5'
+    assert_raise(RuntimeError) { @crontab.minute = set_to }
+  end
+  def test_hour_asterix_with_stepping
+    set_to = '*/2'
+    assert_nothing_raised(RuntimeError) { @crontab.hour = set_to }
+    assert_equal set_to, @crontab.hour
+  end
+  def test_hour_range_with_stepping
+    set_to = '0-22/2'
+    assert_nothing_raised(RuntimeError) { @crontab.hour = set_to }
+    assert_equal set_to, @crontab.hour
+  end
+  def test_hour_stepping_with_multiple_ranges
+    set_to = '0-10/2,16-22/2'
+    assert_nothing_raised(RuntimeError) { @crontab.hour = set_to }
+    assert_equal set_to, @crontab.hour
+  end
+  def test_hour_stepping_with_no_range_raises
+    set_to = '10/5'
+    assert_raise(RuntimeError) { @crontab.hour = set_to }
+  end
+  def test_day_asterix_with_stepping
+    set_to = '*/2'
+    assert_nothing_raised(RuntimeError) { @crontab.day = set_to }
+    assert_equal set_to, @crontab.day
+  end
+  def test_day_range_with_stepping
+    set_to = '1-30/5'
+    assert_nothing_raised(RuntimeError) { @crontab.day = set_to }
+    assert_equal set_to, @crontab.day
+  end
+  def test_day_stepping_with_multiple_ranges
+    set_to = '1-11/2,15,20-30/2'
+    assert_nothing_raised(RuntimeError) { @crontab.day = set_to }
+    assert_equal set_to, @crontab.day
+  end
+  def test_day_stepping_with_no_range_raises
+    set_to = '10/5'
+    assert_raise(RuntimeError) { @crontab.day = set_to }
+  end
+  def test_month_asterix_with_stepping
+    set_to = '*/2'
+    assert_nothing_raised(RuntimeError) { @crontab.month = set_to }
+    assert_equal set_to, @crontab.month
+  end
+  def test_month_range_with_stepping
+    set_to = '2-12/2'
+    assert_nothing_raised(RuntimeError) { @crontab.month = set_to }
+    assert_equal set_to, @crontab.month
+  end
+  def test_month_stepping_with_multiple_ranges
+    set_to = '1-3/2,5,7-11/2'
+    assert_nothing_raised(RuntimeError) { @crontab.month = set_to }
+    assert_equal set_to, @crontab.month
+  end
+  def test_month_stepping_with_no_range_raises
+    set_to = '10/5'
+    assert_raise(RuntimeError) { @crontab.month = set_to }
+  end
+  def test_weekday_asterix_with_stepping
+    set_to = '*/2'
+    assert_nothing_raised(RuntimeError) { @crontab.weekday = set_to }
+    assert_equal set_to, @crontab.weekday
+  end
+  def test_weekday_range_with_stepping
+    set_to = '0-4/2'
+    assert_nothing_raised(RuntimeError) { @crontab.weekday = set_to }
+    assert_equal set_to, @crontab.weekday
+  end
+  def test_weekday_stepping_with_multiple_ranges
+    set_to = '0-3/3,4-6/2'
+    assert_nothing_raised(RuntimeError) { @crontab.weekday = set_to }
+    assert_equal set_to, @crontab.weekday
+  end
+  def test_weekday_stepping_with_no_range_raises
+    set_to = '3/5'
+    assert_raise(RuntimeError) { @crontab.weekday = set_to }
+  end
+end
+
+class TestVerifyCrontabLine < Test::Unit::TestCase
+  def test_valid_crontab_line
+    assert_nothing_raised(RuntimeError) { verify_crontab_line("5,35 */2 10-20,25-30 * 1-5 /foo/var | spam - > eggs.log") }
+  end
+  def test_invalid_crontab_line
+    assert_raise(RuntimeError) { verify_crontab_line("5, 35 */2 10-20,25-30 13 1-5 /foo/var | spam - > eggs.log") }
+  end
+end
+
+class TestVerifyCrontabHash < Test::Unit::TestCase
+  def test_valid_crontab_hash
+    crontab_hash = { :minute=>"5,35", :hour=>"*/2", :day=>"10-20,25-30", :month=>"*", :weekday=>"1-5", :command=>"/foo/var | spam - > eggs.log" }
+    assert_nothing_raised(RuntimeError) do
+      verify_crontab_hash(crontab_hash)
+    end
+  end
+  def test_invalid_crontab_hash
+    crontab_hash = { :minute=>"5, 35", :hour=>"*/2", :day=>"10-20,25-30", :month=>"13", :weekday=>"1-5", :command=>"/foo/var | spam - > eggs.log" }
+    assert_raise(RuntimeError) do
+      verify_crontab_hash(crontab_hash)
+    end
+  end
+  def test_valid_crontab_hash_with_user
+    crontab_hash = { :minute=>"5,35", :hour=>"*/2", :day=>"10-20,25-30", :month=>"*", :weekday=>"1-5", :user=>"root", :command=>"/foo/var | spam - > eggs.log" }
+    assert_nothing_raised(RuntimeError) do
+      result = verify_crontab_hash(crontab_hash)
+    end
+  end
+end
+
+class TestCrontabstringOutput < Test::Unit::TestCase
+  def setup
+    @crontab = CrontabLine.new
+    @crontab.minute = "*"
+    @crontab.hour = "*"
+    @crontab.day = "*"
+    @crontab.month = "*"
+    @crontab.weekday = "*"
+    @crontab.command = "/foo/var | spam - > eggs.log"
+  end
+  def test_to_string_output
+    assert_equal "* * * * * /foo/var | spam - > eggs.log", @crontab.to_s, "Converting crontab to string failed"
+  end
+  def test_to_string_output_with_user
+    @crontab.user = "root"
+    assert_equal "* * * * * root /foo/var | spam - > eggs.log", @crontab.to_s, "Converting crontab to string (with user) failed"
+  end
+end
+
+class TestCrontabstringOutputFromHash < Test::Unit::TestCase
+  def setup
+    @crontab_hash = { :minute=>"5,35", :hour=>"*/2", :day=>"10-20,25-30", :month=>"*", :weekday=>"1-5", :user=>"root", :command=>"/foo/var | spam - > eggs.log" }
+    @expected_string = "5,35 */2 10-20,25-30 * 1-5 root /foo/var | spam - > eggs.log"
+  end
+  def test_to_string_output_with_user_from_hash
+    assert @expected_string, verify_crontab_hash(@crontab_hash)
+  end
+end

metadata

@@ -0,0 +1,139 @@
+--- !ruby/object:Gem::Specification
+name: crontab_syntax_checker
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Stephen Sloan
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-04-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: shoulda
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.12'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: jeweler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.0.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.0.1
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email: steve@stevesloan.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.md
+files:
+- Gemfile
+- License.txt
+- README.md
+- Rakefile
+- VERSION
+- lib/crontab_fields.rb
+- lib/crontab_line.rb
+- lib/crontab_line_base.rb
+- lib/crontab_syntax_checker.rb
+- test/test_crontab_line.rb
+homepage: https://github.com/bkr/crontab_syntax_checker
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 3912384251142507461
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23.2
+signing_key: 
+specification_version: 3
+summary: Validate an entry that will be used in crontab
+test_files: []