cron-spec 0.1.0

data/lib/cron-spec/minute_factory.rb

@@ -0,0 +1,16 @@
+module CronSpec
+
+  class MinuteFactory < CronSpecificationFactory
+
+    MinuteLowerLimit = 0
+    MinuteUpperLimit = 59
+
+    def initialize
+      super
+      @lower_limit = MinuteLowerLimit
+      @upper_limit = MinuteUpperLimit
+    end
+
+  end
+
+end

data/lib/cron-spec/month_factory.rb

@@ -0,0 +1,32 @@
+module CronSpec
+  class MonthFactory < CronSpecificationFactory
+
+    MonthLowerLimit = 1
+    MonthUpperLimit = 12
+
+    Months = %w{ jan feb mar apr may jun jul aug sep oct nov dec }
+
+    MonthExpression = Months.join('|')
+
+    MonthSingleValuePattern = /\A(#{MonthExpression}|\d+)\z/
+
+    MonthRangePattern = /\A(#{MonthExpression}|\d+)-(#{MonthExpression}|\d+)\z/
+
+    NamedMonthPattern = /\A(#{MonthExpression})\z/
+
+    def initialize
+      super
+      @lower_limit = MonthLowerLimit
+      @upper_limit = MonthUpperLimit
+      @single_value_pattern = MonthSingleValuePattern
+      @range_pattern = MonthRangePattern
+    end
+
+    private
+
+    def convert_value(value)
+      (value =~ NamedMonthPattern) ? Months.index(value) + 1 : value.to_i
+    end
+
+  end
+end

data/lib/cron-spec/range_cron_value.rb

@@ -0,0 +1,23 @@
+module CronSpec
+
+  class RangeCronValue < CronValueBase
+
+    attr_reader :range_lower, :range_upper
+
+    def initialize(lower_limit, upper_limit, range_lower, range_upper)
+      super(lower_limit, upper_limit)
+      @range_lower = range_lower
+      @range_upper = range_upper
+
+      raise "Invalid lower range value: #{@range_lower}" unless is_value_within_limits?(@range_lower)
+      raise "Invalid upper range value: #{@range_upper}" unless is_value_within_limits?(@range_upper)
+      raise "Lower limit must be less than or equal to the upper limit" if @range_lower > @range_upper
+    end
+
+    def is_effective?(value)
+      @range_lower <= value && value <= @range_upper
+    end
+
+  end
+
+end

data/lib/cron-spec/single_value_cron_value.rb

@@ -0,0 +1,21 @@
+module CronSpec
+
+  class SingleValueCronValue < CronValueBase
+
+    attr_reader :single_value
+
+    def initialize(lower_limit, upper_limit, single_value)
+      super(lower_limit, upper_limit)
+
+      @single_value = single_value
+
+      raise "Value is out of range: #{@single_value}" unless is_value_within_limits?(@single_value)
+    end
+
+    def is_effective?(value)
+      @single_value == value
+    end
+
+  end
+
+end

data/lib/cron-spec/step_cron_value.rb

@@ -0,0 +1,21 @@
+module CronSpec
+
+  class StepCronValue < CronValueBase
+
+    attr_reader :step_value
+
+    def initialize(lower_limit, upper_limit, step_value)
+      super(lower_limit, upper_limit)
+
+      @step_value = step_value
+
+      raise "Invalid step value: #{@step_value}" if step_value == 0 || step_value > upper_limit
+    end
+
+    def is_effective?(value)
+      value % @step_value == 0
+    end
+
+  end
+
+end

data/lib/cron-spec/wildcard_cron_value.rb

@@ -0,0 +1,15 @@
+module CronSpec
+
+  class WildcardCronValue < CronValueBase
+
+    def initialize(lower_limit, upper_limit)
+      super(lower_limit, upper_limit)
+    end
+
+    def is_effective?(value)
+      true
+    end
+
+  end
+
+end

data/spec/cron_specification_spec.rb

@@ -0,0 +1,119 @@
+require 'spec_helper'
+
+describe CronSpec::CronSpecification do
+
+  it "should honor the yearly shortcut value" do
+    cs = CronSpec::CronSpecification.new("@yearly")
+
+    # Verify that we will match if at midnight january 1st
+    jan_1_00_00 = Time.new(2011, 1, 1, 0, 0, 0)
+    cs.is_specification_in_effect?(jan_1_00_00).should be true
+
+    # Verify that nothing else matches
+    jan_1_00_10 = Time.new(2011, 1, 1, 0, 10, 0)
+    cs.is_specification_in_effect?(jan_1_00_10).should be false
+  end
+
+  it "should honor the annually shortcut value" do
+    cs = CronSpec::CronSpecification.new("@annually")
+
+    # Verify that we will match if at midnight january 1st
+    jan_1_00_00 = Time.new(2011, 1, 1, 0, 0, 0)
+    cs.is_specification_in_effect?(jan_1_00_00).should be true
+
+    # Verify that nothing else matches
+    jan_1_00_10 = Time.new(2011, 1, 1, 0, 10, 0)
+    cs.is_specification_in_effect?(jan_1_00_10).should be false
+  end
+
+  it "should honor the monthly shortcut value" do
+    cs = CronSpec::CronSpecification.new("@monthly")
+
+    # Verify that we will match if at midnight january 1st
+    (1..12).each do |month|
+      any_month_at_midnight = Time.new(2011, month, 1, 0, 0, 0)
+      cs.is_specification_in_effect?(any_month_at_midnight).should be true
+    end
+
+    # Verify that nothing else matches
+    jan_1_00_10 = Time.new(2011, 1, 2, 0, 10, 0)
+    cs.is_specification_in_effect?(jan_1_00_10).should be false
+  end
+
+  it "should honor the weekly shortcut value" do
+    cs = CronSpec::CronSpecification.new("@weekly")
+
+    # It should honor every sunday
+    (0..3).each do |week|
+      sunday = Time.new(2011, 1, 2 + (week * 7), 0, 0, 0)
+      cs.is_specification_in_effect?(sunday).should be true
+    end
+    # It should ignore every monday
+    (0..3).each do |week|
+      sunday = Time.new(2011, 1, 3 + (week * 7), 0, 0, 0)
+      cs.is_specification_in_effect?(sunday).should be false
+    end
+  end
+
+  it "should honor the daily shortcut value" do
+    cs = CronSpec::CronSpecification.new("@daily")
+
+    # It should honor every day of the week at midnight
+    (1..20).each do |day|
+      sunday = Time.new(2011, 1, day, 0, 0, 0)
+      cs.is_specification_in_effect?(sunday).should be true
+    end
+    # It should ignore every day of the week at times other than midnight
+    (1..20).each do |day|
+      sunday = Time.new(2011, 1, day, 8, 0, 0)
+      cs.is_specification_in_effect?(sunday).should be false
+    end
+  end
+
+  it "should honor the midnight shortcut value" do
+    cs = CronSpec::CronSpecification.new("@midnight")
+
+    # It should honor every day of the week at midnight
+    (1..20).each do |day|
+      sunday = Time.new(2011, 1, day, 0, 0, 0)
+      cs.is_specification_in_effect?(sunday).should be true
+    end
+    # It should ignore every day of the week at times other than midnight
+    (1..20).each do |day|
+      sunday = Time.new(2011, 1, day, 8, 0, 0)
+      cs.is_specification_in_effect?(sunday).should be false
+    end
+  end
+
+  it "should honor the hourly shortcut value" do
+    cs = CronSpec::CronSpecification.new("@hourly")
+
+    # It should honor every day of the week at midnight
+    (0..23).each do |hour|
+      sunday = Time.new(2011, 1, 1, hour, 0, 0)
+      cs.is_specification_in_effect?(sunday).should be true
+    end
+    # It should ignore every day of the week at times other than midnight
+    (0..23).each do |hour|
+      sunday = Time.new(2011, 1, 1, hour, 10, 0)
+      cs.is_specification_in_effect?(sunday).should be false
+    end
+  end
+
+  it "should honor named days of the week" do
+    cs = CronSpec::CronSpecification.new("* * * * mon,tue,thu-sat")
+
+    # Make sure the correct days are honored
+    [1, 2, 4, 5, 6].each do |dow|
+#        next if dow == 4
+      day = Time.new(2011, 1, 2 + dow, 11, 0, 0)
+      cs.is_specification_in_effect?(day).should be true
+    end
+
+    # Make sure the bad days are ignored.
+    [0, 3].each do |dow|
+      day = Time.new(2011, 1, 2 + dow, 11, 0, 0)
+      cs.is_specification_in_effect?(day).should be false
+    end
+  end
+end

data/spec/range_cron_value_spec.rb

@@ -0,0 +1,18 @@
+require 'spec_helper'
+
+describe CronSpec::RangeCronValue do
+
+  before(:each) do
+    @cv = CronSpec::RangeCronValue.new(0, 16, 2, 12)
+  end
+
+  it "should indicate effective if value is within range" do
+    (2..12).each { | value | @cv.is_effective?(value).should be true }
+  end
+
+  it "should indicate not effective if value is not within range" do
+    (-1..1).each { | value | @cv.is_effective?(value).should be false }
+    (13..16).each { | value | @cv.is_effective?(value).should be false }
+  end
+
+end

data/spec/single_value_cron_value_spec.rb

@@ -0,0 +1,18 @@
+require 'spec_helper'
+
+describe CronSpec::SingleValueCronValue do
+
+  before(:each) do
+    @cv = CronSpec::SingleValueCronValue.new(0, 32, 8)
+  end
+
+  it "should indicate effective if the value matches" do
+    @cv.is_effective?(8).should be true
+  end
+
+  it "should indicate not effective if value does not match" do
+    (-1..7).each { | value | @cv.is_effective?(value).should be false }
+    (9..32).each { | value | @cv.is_effective?(value).should be false }
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,12 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'rspec'
+require 'cron-spec'
+
+# Requires supporting files with custom matchers and macros, etc,
+# in ./support/ and its subdirectories.
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
+
+RSpec.configure do |config|
+  
+end

data/spec/step_cron_value_spec.rb

@@ -0,0 +1,17 @@
+require 'spec_helper'
+
+describe CronSpec::StepCronValue do
+
+  before(:each) do
+    @cv = CronSpec::StepCronValue.new(0, 32, 2)
+  end
+
+  it "should indicate effective if the values match the step" do
+    (0..32).each { | value | next unless (value % 2 == 0); @cv.is_effective?(value).should be true }
+  end
+
+  it "should indicate not effective if the values do not match the step" do
+    (0..32).each { | value | next if (value % 2 == 0); @cv.is_effective?(value).should be false }
+  end
+
+end

data/spec/wildcard_cron_value_spec.rb

@@ -0,0 +1,13 @@
+require 'spec_helper'
+
+describe CronSpec::WildcardCronValue do
+
+  before(:each) do
+    @cv = CronSpec::WildcardCronValue.new(0, 32)
+  end
+
+  it "should indicate effective for all values within limits" do
+    (0..32).each { | value | @cv.is_effective?(value).should be true }
+  end
+
+end

metadata

@@ -0,0 +1,164 @@
+--- !ruby/object:Gem::Specification 
+name: cron-spec
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Dave Sieh
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-02-27 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 2
+        - 1
+        - 0
+        version: 2.1.0
+  type: :development
+  prerelease: false
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: bundler
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 0
+        - 0
+        version: 1.0.0
+  type: :development
+  prerelease: false
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: jeweler
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 5
+        - 2
+        version: 1.5.2
+  type: :development
+  prerelease: false
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: rcov
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  prerelease: false
+  version_requirements: *id004
+description: Cron specification implementation
+email: dave.sieh@nursinghomequality.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE.txt
+- README.rdoc
+files: 
+- .document
+- .idea/.name
+- .idea/.rakeTasks
+- .idea/cron-spec.iml
+- .idea/encodings.xml
+- .idea/misc.xml
+- .idea/modules.xml
+- .idea/vcs.xml
+- .idea/workspace.xml
+- .rspec
+- .rvmrc
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.rdoc
+- Rakefile
+- VERSION
+- cron-spec.gemspec
+- lib/cron-spec.rb
+- lib/cron-spec/cron_specification.rb
+- lib/cron-spec/cron_specification_factory.rb
+- lib/cron-spec/cron_value_base.rb
+- lib/cron-spec/day_factory.rb
+- lib/cron-spec/dow_factory.rb
+- lib/cron-spec/hour_factory.rb
+- lib/cron-spec/minute_factory.rb
+- lib/cron-spec/month_factory.rb
+- lib/cron-spec/range_cron_value.rb
+- lib/cron-spec/single_value_cron_value.rb
+- lib/cron-spec/step_cron_value.rb
+- lib/cron-spec/wildcard_cron_value.rb
+- spec/cron_specification_spec.rb
+- spec/range_cron_value_spec.rb
+- spec/single_value_cron_value_spec.rb
+- spec/spec_helper.rb
+- spec/step_cron_value_spec.rb
+- spec/wildcard_cron_value_spec.rb
+has_rdoc: true
+homepage: http://github.com/j0hnds/cron-spec
+licenses: 
+- MIT
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3189745320292493514
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Cron specification implementation
+test_files: 
+- spec/cron_specification_spec.rb
+- spec/range_cron_value_spec.rb
+- spec/single_value_cron_value_spec.rb
+- spec/spec_helper.rb
+- spec/step_cron_value_spec.rb
+- spec/wildcard_cron_value_spec.rb