parse-cron 0.0.1

data/.gitignore

@@ -0,0 +1,5 @@
+*.gem
+*.swp
+.bundle
+Gemfile.lock
+pkg/*

data/.rspec

@@ -0,0 +1 @@
+--color

data/Gemfile

@@ -0,0 +1,6 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in parse-cron.gemspec
+gemspec
+
+gem "ZenTest", "4.6.0"

data/README

@@ -0,0 +1,5 @@
+# parse-cron - parse crontab syntax & determine next scheduled run
+
+The goal of this gem is to parse a crontab timing specification and determine when the
+job should be run. It is not a scheduler, it does not run the jobs.
+

data/Rakefile

@@ -0,0 +1,11 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new
+task :default => :spec
+
+desc 'Start IRB with preloaded environment'
+task :console do
+  exec 'irb', "-I#{File.join(File.dirname(__FILE__), 'lib')}", '-rparse-cron'
+end

data/lib/cron_parser.rb

@@ -0,0 +1,184 @@
+#
+# Parses cron expressions and computes the next occurence of the "job"
+#
+class CronParser
+  # internal "mutable" time representation
+  class InternalTime
+    attr_accessor :year, :month, :day, :hour, :min
+
+    def initialize(time)
+      @year = time.year
+      @month = time.month
+      @day = time.day
+      @hour = time.hour
+      @min = time.min
+    end
+
+    def to_time
+      Time.utc(@year, @month, @day, @hour, @min, 0)
+    end
+    alias :inspect :to_time
+  end
+
+  SYMBOLS = {
+     "jan" => "0",
+     "feb" => "1",
+     "mar" => "2",
+     "apr" => "3",
+     "may" => "4",
+     "jun" => "5",
+     "jul" => "6",
+     "aug" => "7",
+     "sep" => "8",
+     "oct" => "9",
+     "nov" => "10",
+     "dec" => "11",
+
+     "sun" => "0",
+     "mon" => "1",
+     "tue" => "2",
+     "wed" => "3",
+     "thu" => "4",
+     "fri" => "5",
+     "sat" => "6"
+  }
+
+  def initialize(source)
+    @source = source
+  end
+
+
+  # returns the next occurence after the given date
+  def next(now = Time.now)
+    t = InternalTime.new(now)
+
+    unless time_specs[:month].include?(t.month)
+      nudge_month(t)
+      t.day = 0
+    end
+
+    unless t.day == 0 || interpolate_weekdays(t.year, t.month).include?(t.day)
+      nudge_date(t)
+      t.hour = -1
+    end
+
+    unless time_specs[:hour].include?(t.hour)
+      nudge_hour(t)
+      t.min = -1
+    end
+
+    # always nudge the minute
+    nudge_minute(t)
+    t.to_time
+  end
+
+  SUBELEMENT_REGEX = %r{^(\d+)(-(\d+)(/(\d+))?)?$}
+  def parse_element(elem, allowed_range)
+    elem.split(',').map do |subel|
+      if subel =~ /^\*/
+        step = subel.length > 1 ? subel[2..-1].to_i : 1
+        stepped_range(allowed_range, step)
+      else
+        if SUBELEMENT_REGEX === subel
+          if $5 # with range
+            stepped_range($1.to_i..($3.to_i + 1), $5.to_i)
+          elsif $3 # range without step
+            stepped_range($1.to_i..($3.to_i + 1), 1)
+          else # just a numeric
+            [$1.to_i]
+          end
+        else
+          raise "Bad Vixie-style specification #{subel}"
+        end
+      end
+    end.flatten.sort
+  end
+
+
+  protected
+
+  # returns a list of days which do both match time_spec[:dom] and time_spec[:dow]
+  def interpolate_weekdays(year, month)
+    t = Date.new(year, month, 1)
+    valid_mday = time_specs[:dom]
+    valid_wday = time_specs[:dow]
+
+    result = []
+    while t.month == month
+      result << t.mday if valid_mday.include?(t.mday) && valid_wday.include?(t.wday)
+      t = t.succ
+    end
+
+    result
+  end
+
+  def nudge_year(t)
+    t.year = t.year + 1
+  end
+
+  def nudge_month(t)
+    spec = time_specs[:month]
+    next_value = find_best_next(t.month, spec)
+    t.month = next_value || spec.first
+    next_value.nil? ?  nudge_year(t) : t
+  end
+
+  def nudge_date(t)
+    spec = interpolate_weekdays(t.year, t.month)
+    next_value = find_best_next(t.day, spec)
+    t.day = next_value || spec.first
+    next_value.nil? ?  nudge_month(t) : t
+  end
+
+  def nudge_hour(t)
+    spec = time_specs[:hour]
+    next_value = find_best_next(t.hour, spec)
+    t.hour = next_value || spec.first
+    next_value.nil? ?  nudge_date(t) : t
+  end
+
+  def nudge_minute(t)
+    spec = time_specs[:minute]
+    next_value = find_best_next(t.min, spec)
+    t.min = next_value || spec.first
+    next_value.nil? ?  nudge_hour(t) : t
+  end
+
+  def time_specs
+    @time_specs ||= begin
+      # tokens now contains the 5 fields
+      tokens = substitute_parse_symbols(@source).split(/\s+/)
+      {
+        :minute => parse_element(tokens[0], 0..59), #minute
+        :hour   => parse_element(tokens[1], 0..23), #hour
+        :dom    => parse_element(tokens[2], 1..31), #DOM
+        :month  => parse_element(tokens[3], 1..12), #mon
+        :dow    => parse_element(tokens[4], 0..6)  #DOW
+      }
+    end
+  end
+
+  def substitute_parse_symbols(str)
+    SYMBOLS.inject(str) do |s, (symbol, replacement)|
+      s.gsub(symbol, replacement)
+    end
+  end
+
+
+  def stepped_range(rng, step = 1)
+    len = rng.last - rng.first
+
+    num = len.div(step)
+    result = (0..num).map { |i| rng.first + step * i }
+
+    result.pop if result[-1] == rng.last and rng.exclude_end?
+    result
+  end
+
+
+  # returns the smallest element from allowed which is greater than current
+  # returns nil if no matching value was found
+  def find_best_next(current, allowed)
+    allowed.sort.find { |val| val > current }
+  end
+end

data/lib/parse-cron/version.rb

@@ -0,0 +1,5 @@
+module Parse
+  module Cron
+    VERSION = "0.0.1"
+  end
+end

data/parse-cron.gemspec

@@ -0,0 +1,23 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "parse-cron/version"
+
+Gem::Specification.new do |s|
+  s.name        = "parse-cron"
+  s.version     = Parse::Cron::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Michael Siebert"]
+  s.email       = ["siebertm85@googlemail.com"]
+  s.homepage    = ""
+  s.summary     = %q{Parses cron expressions and calculates the next occurence}
+  s.description = %q{Parses cron expressions and calculates the next occurence}
+
+  s.rubyforge_project = "parse-cron"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_development_dependency 'rspec', '~>2.6.0'
+end

data/spec/cron_parser_spec.rb

@@ -0,0 +1,46 @@
+require "time"
+require "./spec/spec_helper"
+require "cron_parser"
+
+describe "CronParser#parse_element" do
+  [
+    ["*", 0..60, (0..60).to_a],
+    ["*/10", 0..60, [0, 10, 20, 30, 40, 50]],
+    ["10", 0..60, [10]],
+    ["10,30", 0..60, [10, 30]],
+    ["10-15", 0..60, [10, 11, 12, 13, 14, 15]],
+    ["10-40/10", 0..60, [10, 20, 30, 40]],
+  ].each do |element, range, expected|
+    it "should return #{expected} for '#{element}' when range is #{range}" do
+      parser = CronParser.new('')
+      parser.parse_element(element, range) == expected
+    end
+  end
+end
+
+describe "CronParser#next" do
+  [
+    ["* * * * *",       "2011-08-15T12:00",  "2011-08-15T12:01"],
+    ["* * * * *",       "2011-08-15T02:25",  "2011-08-15T02:26"],
+    ["* * * * *",       "2011-08-15T02:59",  "2011-08-15T03:00"],
+    ["*/15 * * * *",    "2011-08-15T02:02",  "2011-08-15T02:15"],
+    ["*/15,25 * * * *", "2011-08-15T02:15",  "2011-08-15T02:25"],
+    ["30 3,6,9 * * *",  "2011-08-15T02:15",  "2011-08-15T03:30"],
+    ["30 9 * * *",      "2011-08-15T10:15",  "2011-08-16T09:30"],
+    ["30 9 * * *",      "2011-08-31T10:15",  "2011-09-01T09:30"],
+    ["30 9 * * *",      "2011-09-30T10:15",  "2011-10-01T09:30"],
+    ["0 9 * * *",       "2011-12-31T10:15",  "2012-01-01T09:00"],
+    ["* * 12 * *",      "2010-04-15T10:15",  "2010-05-12T00:00"],
+    ["* * * * 1,3",     "2010-04-15T10:15",  "2010-04-19T00:00"],
+    ["0 0 1 1 *",       "2010-04-15T10:15",  "2011-01-01T00:00"],
+  ].each do |line, now, expected_next|
+    it "should return #{expected_next} for '#{line}' when now is #{now}" do
+      now = Time.xmlschema(now + ":00+00:00")
+      expected_next = Time.xmlschema(expected_next + ":00+00:00")
+
+      parser = CronParser.new(line)
+
+      parser.next(now).xmlschema.should == expected_next.xmlschema
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,9 @@
+spec_dir = File.dirname(__FILE__)
+lib_dir  = File.expand_path(File.join(spec_dir, '..', 'lib'))
+$:.unshift(lib_dir)
+$:.uniq!
+
+RSpec.configure do |config|
+end
+
+require 'cron_parser'

metadata

@@ -0,0 +1,93 @@
+--- !ruby/object:Gem::Specification 
+name: parse-cron
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: 
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Michael Siebert
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-08-17 00:00:00 +02:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 23
+        segments: 
+        - 2
+        - 6
+        - 0
+        version: 2.6.0
+  type: :development
+  version_requirements: *id001
+description: Parses cron expressions and calculates the next occurence
+email: 
+- siebertm85@googlemail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- .rspec
+- Gemfile
+- README
+- Rakefile
+- lib/cron_parser.rb
+- lib/parse-cron/version.rb
+- parse-cron.gemspec
+- spec/cron_parser_spec.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: ""
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: parse-cron
+rubygems_version: 1.4.2
+signing_key: 
+specification_version: 3
+summary: Parses cron expressions and calculates the next occurence
+test_files: 
+- spec/cron_parser_spec.rb
+- spec/spec_helper.rb