cronos 0.3.1 → 0.4.0

data/CHANGELOG

@@ -1,3 +1,7 @@
+== 0.4.0 2009-03-06
+- every method now handles days and months eg. every(:mon, :tue), every('mon'..'wed'), every(:jan, :feb) etc.
+- added schedule method which takes a command and outputs it in the cron string
+
 == 0.3.1 2009-02-03
 - added ranges to #days
 

data/README.rdoc

@@ -10,33 +10,41 @@ you are after instead of trying to remember the cron syntax and conventions.
 
   cron = Cronos::Interval
   
-  cron.new.hourly.to_s 
+  puts cron.new.hourly
   # => '0 * * * *'
 
-  cron.new.daily.to_s 
+  puts cron.new.daily
   # => '0 0 * * *'
   
-  cron.new.weekly.to_s 
+  puts cron.new.weekly
   # => '0 0 * * 0'
 
-  cron.new.weekdays.at(12.30).to_s 
+  puts cron.new.weekdays.at(12.30)
   # => '30 12 * * 1-5'
   
-  cron.new.weekends.at(12.30).to_s
+  puts cron.new.weekends.at(12.30)
   # => '30 12 * * 0,6'
 
-  cron.new.at('1.30pm').daily.to_s
+  puts cron.new.at('1.30pm').daily
   # => '30 13 * * *'
 
-  cron.new.every(6).hours.on('15th').of(:january).to_s
+  puts cron.new.every(6).hours.on('15th').of(:january)
   # => '0 0,6,12,18 15 1 *' 
 
-  cron.new.every(20).minutes.on(15..18).of(:jan, :feb, :mar).to_s
+  puts cron.new.every(20).minutes.on('15th'..'18th').of(:jan, :feb, :mar)
   # => '0,20,40 * 15-18 1,2,3 *'
 
-  cron.new.at(14.45).on_days(:monday, :tuesday).to_s
+  puts cron.new.at(14.45).every(:monday, :tuesday)
   # => '45 14 * * 1,2'
 
+
+You can also output the whole cron task string using the schedule method:
+
+  puts Cronos.schedule('some_task').every(:Sunday).at('3am')
+  # => '0 3 * * 0 some_task'
+
+This does not actually schedule the task in cron. Cronos is merely a DSL to output the cron intervals.
+
 == Caveats
 
 Certain combinations produce unintuitive results. They should be obvious but just in case I will

data/lib/cronos.rb

@@ -1,11 +1,15 @@
 module Cronos
 
-  VERSION = '0.3.1'
+  VERSION = '0.4.0'
+
+  def self.schedule(task)
+    TaskInterval.new(task)
+  end
 
   class Interval
     attr_accessor :min, :hour, :day, :month, :dow
 
-    MONTHS = [:jan, :feb, :mar, :apr, :may, :jun, :jul, :aug, :sep, :oct, :nov, :dec]
+    MONTHS = [nil, :jan, :feb, :mar, :apr, :may, :jun, :jul, :aug, :sep, :oct, :nov, :dec]
 
     DAYS = [:sun, :mon, :tue, :wed, :thu, :fri, :sat]
 
@@ -37,17 +41,18 @@ module Cronos
     #
     # or use as an alias for #on or #days
     #   every(:monday)
+    #   every(:mon, :tues)
+    #   every('Monday'.. 'Wednesday')
     #   every('February', :march)
+    #   every('Feb'..'June')
     #
     def every(*multiple)
       return RepeatInterval.new(multiple.first, self) if multiple.first.is_a?(Fixnum)
 
-      abbrs = multiple.map {|i| i.to_s.downcase[0..2].to_sym }
-
-      if abbrs.all? {|abbr| MONTHS.include?(abbr) }
-        of(*abbrs)
-      elsif abbrs.all? {|abbr| DAYS.include?(abbr) }
-        days(*abbrs)
+      if multiple.all? {|abbr| is_month?(abbr) }
+        of(*multiple)
+      elsif multiple.all? {|abbr| is_day?(abbr) }
+        days(*multiple)
       else
         raise "Unknown interval type passed to #every"
       end
@@ -57,6 +62,7 @@ module Cronos
     #   on(13)
     #   on('13th')
     #   on(13..17)
+    #   on('13th'..'17th')
     #   on(13...18)
     #   on_the('13th')
     #
@@ -76,6 +82,7 @@ module Cronos
     #   days('Monday')
     #   days(:mon)
     #   days(1..3)
+    #   days('mon'..'wed')
     #   days(1...4)
     #   on_day(:monday)
     #   days(:mon, :tues)
@@ -85,7 +92,7 @@ module Cronos
       if args.first.is_a?(Range)
         @dow = format_range(args.first)
       else
-        list = args.map {|day| DAYS.index(day.to_s.downcase[0..2].to_sym) }
+        list = args.map {|day| day_value(day) unless day.is_a?(Fixnum) }
         @dow = list.join(',')
       end
       self
@@ -99,6 +106,7 @@ module Cronos
     #   of(:jan)
     #   of(:jan, :feb, :mar)
     #   of(1..3)
+    #   of('jan'..'mar')
     #   of(1...4)
     #   of_months(1, 2, 3)
     #   in(:january)
@@ -107,7 +115,7 @@ module Cronos
       if args.first.is_a?(Range)
         @month = format_range(args.first)
       else
-        list = args.map {|month| MONTHS.index(month.to_s.downcase[0..2].to_sym) + 1 unless month.is_a?(Fixnum) }
+        list = args.map {|month| month_value(month) unless month.is_a?(Fixnum) }
         @month = list.join(',')
       end
       self
@@ -205,10 +213,37 @@ module Cronos
     end
 
     def format_range(range)
-      list = Array(range).sort
+      values = [range.first, range.last]
+
+      if values.all? {|v| v.to_i > 0 }
+        first, last = values.first.to_i, values.last.to_i
+      elsif values.all? {|abbr| is_month?(abbr) }
+        first, last = month_value(values.first), month_value(values.last)
+      elsif values.all? {|abbr| is_day?(abbr) }
+        first, last = day_value(values.first), day_value(values.last)
+      end
+
+      int_range = range.exclude_end? ? first...last : first..last
+      list = Array(int_range).sort
       "#{list.first}-#{list.last}"
     end
 
+    def is_month?(value)
+      MONTHS.include?(value.to_s.downcase[0..2].to_sym)
+    end
+
+    def month_value(value)
+      MONTHS.index(value.to_s.downcase[0..2].to_sym)
+    end
+
+    def is_day?(value)
+      DAYS.include?(value.to_s.downcase[0..2].to_sym)
+    end
+
+    def day_value(value)
+      DAYS.index(value.to_s.downcase[0..2].to_sym)
+    end
+
     class RepeatInterval
 
       def initialize(multiple, interval)
@@ -258,4 +293,16 @@ module Cronos
 
   end
 
+  class TaskInterval < Interval
+    attr_accessor :task
+
+    def initialize(task)
+      @task = task
+    end
+
+    def to_s
+      "#{super} #{@task}"
+    end
+  end
+
 end

data/spec/cronos_spec.rb

@@ -1,5 +1,13 @@
 require File.dirname(__FILE__) + '/spec_helper'
 
+describe Cronos do
+
+  it "should return task interval instance from schedule method" do
+    Cronos.schedule('ls').should be_kind_of(Cronos::TaskInterval)
+  end
+
+end
+
 describe Cronos::Interval do
 
   it "should return default interval for every minute" do
@@ -57,6 +65,10 @@ describe Cronos::Interval do
       interval.on(15..17).to_s.should == '* * 15-17 * *'
     end
     
+    it "should output interval from string inclusive range as dashed day of month range " do
+      interval.on('15th'..'17th').to_s.should == '* * 15-17 * *'
+    end
+
     it "should output interval from exclusive range as dashed day of month range " do
       interval.on(15...18).to_s.should == '* * 15-17 * *'
     end
@@ -99,6 +111,10 @@ describe Cronos::Interval do
       interval.of(1..3).to_s.should == '* * * 1-3 *'
     end
 
+    it "should output interval from string inclusive range as dashed month range " do
+      interval.of('jan'..'mar').to_s.should == '* * * 1-3 *'
+    end
+
     it "should output interval from integer exclusive range as dashed month range " do
       interval.of(1...4).to_s.should == '* * * 1-3 *'
     end
@@ -133,6 +149,10 @@ describe Cronos::Interval do
       interval.days(1..3).to_s.should == '* * * * 1-3'
     end
 
+    it "should output interval from string inclusive range as dashed dow range " do
+      interval.days('mon'..'wed').to_s.should == '* * * * 1-3'
+    end
+
     it "should output interval from integer exclusive range as dashed dow range " do
       interval.days(1...4).to_s.should == '* * * * 1-3'
     end
@@ -327,3 +347,11 @@ describe Cronos::Interval do
     @interval ||= Cronos::Interval.new
   end
 end
+
+describe Cronos::TaskInterval do
+
+  it "should output task at end of interval string" do
+    Cronos::TaskInterval.new('ls').at('12pm').to_s.should == '0 12 * * * ls'
+  end
+
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: cronos
 version: !ruby/object:Gem::Version 
-  version: 0.3.1
+  version: 0.4.0
 platform: ruby
 authors: 
 - Adam Meehan
@@ -9,7 +9,7 @@ autorequire: cronos
 bindir: bin
 cert_chain: []
 
-date: 2009-02-03 00:00:00 +11:00
+date: 2009-03-12 00:00:00 +11:00
 default_executable: 
 dependencies: []