cron-spec 0.1.0

data/Gemfile

@@ -0,0 +1,13 @@
+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 "rspec", "~> 2.1.0"
+  gem "bundler", "~> 1.0.0"
+  gem "jeweler", "~> 1.5.2"
+  gem "rcov", ">= 0"
+end

data/Gemfile.lock

@@ -0,0 +1,28 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    diff-lcs (1.1.2)
+    git (1.2.5)
+    jeweler (1.5.2)
+      bundler (~> 1.0.0)
+      git (>= 1.2.5)
+      rake
+    rake (0.8.7)
+    rcov (0.9.8)
+    rspec (2.1.0)
+      rspec-core (~> 2.1.0)
+      rspec-expectations (~> 2.1.0)
+      rspec-mocks (~> 2.1.0)
+    rspec-core (2.1.0)
+    rspec-expectations (2.1.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.1.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.0.0)
+  jeweler (~> 1.5.2)
+  rcov
+  rspec (~> 2.1.0)

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Dave Sieh
+
+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.rdoc

@@ -0,0 +1,19 @@
+= cron-spec
+
+Description goes here.
+
+== Contributing to cron-spec
+ 
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
+* Fork the project
+* Start a feature/bugfix branch
+* Commit and push until you are happy with your contribution
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+== Copyright
+
+Copyright (c) 2011 Dave Sieh. See LICENSE.txt for
+further details.
+

data/Rakefile

@@ -0,0 +1,50 @@
+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://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "cron-spec"
+  gem.homepage = "http://github.com/j0hnds/cron-spec"
+  gem.license = "MIT"
+  gem.summary = "Cron specification implementation"
+  gem.description = "Cron specification implementation"
+  gem.email = "dave.sieh@nursinghomequality.com"
+  gem.authors = ["Dave Sieh"]
+  # Include your dependencies below. Runtime dependencies are required when using your gem,
+  # and development dependencies are only needed for development (ie running rake tasks, tests, etc)
+  #  gem.add_runtime_dependency 'jabber4r', '> 0.1'
+  #  gem.add_development_dependency 'rspec', '> 1.2.3'
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+RSpec::Core::RakeTask.new(:rcov) do |spec|
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "cron-spec #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

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

data/cron-spec.gemspec

@@ -0,0 +1,94 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{cron-spec}
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Dave Sieh"]
+  s.date = %q{2011-02-27}
+  s.description = %q{Cron specification implementation}
+  s.email = %q{dave.sieh@nursinghomequality.com}
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.rdoc"
+  ]
+  s.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"
+  ]
+  s.homepage = %q{http://github.com/j0hnds/cron-spec}
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{Cron specification implementation}
+  s.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"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<rspec>, ["~> 2.1.0"])
+      s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.5.2"])
+      s.add_development_dependency(%q<rcov>, [">= 0"])
+    else
+      s.add_dependency(%q<rspec>, ["~> 2.1.0"])
+      s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_dependency(%q<jeweler>, ["~> 1.5.2"])
+      s.add_dependency(%q<rcov>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<rspec>, ["~> 2.1.0"])
+    s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+    s.add_dependency(%q<jeweler>, ["~> 1.5.2"])
+    s.add_dependency(%q<rcov>, [">= 0"])
+  end
+end
+

data/lib/cron-spec.rb

@@ -0,0 +1,12 @@
+require 'cron-spec/cron_value_base'
+require 'cron-spec/range_cron_value'
+require 'cron-spec/single_value_cron_value'
+require 'cron-spec/step_cron_value'
+require 'cron-spec/wildcard_cron_value'
+require 'cron-spec/cron_specification'
+require 'cron-spec/cron_specification_factory'
+require 'cron-spec/day_factory'
+require 'cron-spec/dow_factory'
+require 'cron-spec/hour_factory'
+require 'cron-spec/minute_factory'
+require 'cron-spec/month_factory'

data/lib/cron-spec/cron_specification.rb

@@ -0,0 +1,70 @@
+module CronSpec
+  class CronSpecification
+
+    TimeMethods = [ :min, :hour, :day, :month, :wday ]
+
+    MINUTE = 0
+    HOUR = 1
+    DAY = 2
+    MONTH = 3
+    DOW = 4
+
+    # Shortcut patterns
+    YEARLY = 'yearly'
+    ANNUALLY = 'annually'
+    MONTHLY = 'monthly'
+    WEEKLY = 'weekly'
+    DAILY = 'daily'
+    MIDNIGHT = 'midnight'
+    HOURLY = 'hourly'
+
+    SHORTCUT_CRONS = {
+        YEARLY => '0 0 1 1 *',
+        ANNUALLY => '0 0 1 1 *',
+        MONTHLY => '0 0 1 * *',
+        WEEKLY => '0 0 * * 0',
+        DAILY => '0 0 * * *',
+        MIDNIGHT => '0 0 * * *',
+        HOURLY => '0 * * * *'}
+
+    SHORTCUT_PATTERN = /\A@(#{SHORTCUT_CRONS.keys.join('|')})\z/
+
+    attr_reader :raw_specification
+
+    def initialize(raw_specification)
+      raise "Must specify a cron specification" if raw_specification.nil?
+
+      @raw_specification = (raw_specification =~ SHORTCUT_PATTERN) ? SHORTCUT_CRONS[$1] : raw_specification
+
+      specification = @raw_specification.split(' ')
+      raise "Invalid cron specification" if specification.size != 5
+
+      @cron_values = []
+      @cron_values << parse_specification(specification[MINUTE], MinuteFactory.new)
+      @cron_values << parse_specification(specification[HOUR], HourFactory.new)
+      @cron_values << parse_specification(specification[DAY], DayFactory.new)
+      @cron_values << parse_specification(specification[MONTH], MonthFactory.new)
+      @cron_values << parse_specification(specification[DOW], DowFactory.new)
+    end
+
+        def is_specification_in_effect?(time=Time.now.in_time_zone(DISPLAY_TIME_ZONE))
+      idx = 0
+      test_results = @cron_values.collect do | cvalues |
+        time_value = time.send(TimeMethods[idx])
+        idx += 1
+        !cvalues.detect { | cv | cv.is_effective?(time_value) }.nil?
+      end.all?
+
+    end
+
+    private
+
+    def parse_specification(specification, factory)
+      specification.split(',').collect do |spec_component|
+        factory.parse(spec_component)
+      end
+    end
+
+  end
+
+end

data/lib/cron-spec/cron_specification_factory.rb

@@ -0,0 +1,39 @@
+module CronSpec
+
+  class CronSpecificationFactory
+
+    WildcardPattern = /\A\*\z/
+    SingleValuePattern = /\A(\d+)\z/
+    RangePattern = /\A(\d+)-(\d+)\z/
+    StepPattern = /\A\*\/(\d+)\z/
+
+    def initialize
+      @single_value_pattern = SingleValuePattern
+      @range_pattern = RangePattern
+      @step_pattern = StepPattern
+    end
+
+    def parse(value_spec)
+      case value_spec
+        when WildcardPattern
+          WildcardCronValue.new(@lower_limit, @upper_limit)
+        when @single_value_pattern
+          SingleValueCronValue.new(@lower_limit, @upper_limit, convert_value($1))
+        when @range_pattern
+          RangeCronValue.new(@lower_limit, @upper_limit, convert_value($1), convert_value($2))
+        when @step_pattern
+          StepCronValue.new(@lower_limit, @upper_limit, $1.to_i)
+        else
+          raise "Unrecognized cron specification pattern."
+      end
+    end
+
+    private
+
+    def convert_value(value)
+      value.to_i
+    end
+
+  end
+
+end

data/lib/cron-spec/cron_value_base.rb

@@ -0,0 +1,19 @@
+module CronSpec
+
+  class CronValueBase
+
+    attr_reader :lower_limit, :upper_limit
+
+    def initialize(lower_limit, upper_limit)
+      @lower_limit = lower_limit
+      @upper_limit = upper_limit
+
+      raise "Lower limit must be less than or equal to upper limit" if @lower_limit > @upper_limit
+    end
+
+    def is_value_within_limits?(value)
+      value >= @lower_limit && value <= upper_limit
+    end
+  end
+
+end

data/lib/cron-spec/day_factory.rb

@@ -0,0 +1,12 @@
+module CronSpec
+  class DayFactory < CronSpecificationFactory
+    DayLowerLimit = 1
+    DayUpperLimit = 31
+
+    def initialize
+      super
+      @lower_limit = DayLowerLimit
+      @upper_limit = DayUpperLimit
+    end
+  end
+end

data/lib/cron-spec/dow_factory.rb

@@ -0,0 +1,33 @@
+module CronSpec
+  class DowFactory < CronSpecificationFactory
+
+    DayOfWeekLowerLimit = 0
+    DayOfWeekUpperLimit = 6
+
+    DaysOfWeek = %w{ sun mon tue wed thu fri sat }
+
+    DayOfWeekExpression = DaysOfWeek.join('|')
+
+    DayOfWeekSingleValuePattern = /\A(#{DayOfWeekExpression}|\d)\z/
+
+    DayOfWeekRangePattern = /\A(#{DayOfWeekExpression}|\d)-(#{DayOfWeekExpression}|\d)\z/
+
+    NamedDayOfWeekPattern = /\A(#{DayOfWeekExpression})\z/
+
+    def initialize
+      super
+      @lower_limit = DayOfWeekLowerLimit
+      @upper_limit = DayOfWeekUpperLimit
+      @single_value_pattern = DayOfWeekSingleValuePattern
+      @range_pattern = DayOfWeekRangePattern
+    end
+
+    private
+
+    def convert_value(value)
+      dow = (value =~ NamedDayOfWeekPattern) ? DaysOfWeek.index(value) : value.to_i
+      # Sunday can be specified as index 7
+      (dow == 7) ? 0 : dow
+    end
+  end
+end

data/lib/cron-spec/hour_factory.rb

@@ -0,0 +1,16 @@
+module CronSpec
+
+  class HourFactory < CronSpecificationFactory
+
+    HourLowerLimit = 0
+    HourUpperLimit = 23
+
+    def initialize
+      super
+      @lower_limit = HourLowerLimit
+      @upper_limit = HourUpperLimit
+    end
+
+  end
+
+end