adzap-cronos 0.2.1

data/CHANGELOG

@@ -0,0 +1,2 @@
+== 0.2.1 2009-01-17
+- added to_hash method with CronEdit compatible key names

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2008 Adam Meehan
+
+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,67 @@
+= Cronos
+
+A Ruby DSL for outputting Cron intervals. 
+
+Using a natural syntax to write cron task intervals assists in generating the correct cron interval
+you are after instead of trying to remember the cron syntax and conventions.
+
+
+== Examples
+
+  cron = Cronos::Interval
+  
+  cron.new.hourly.to_s 
+  # => '0 * * * *'
+
+  cron.new.daily.to_s 
+  # => '0 0 * * *'
+  
+  cron.new.weekly.to_s 
+  # => '0 0 * * 0'
+
+  cron.new.weekdays.at(12.30).to_s 
+  # => '30 12 * * 1-5'
+  
+  cron.new.weekends.at(12.30).to_s
+  # => '30 12 * * 0,6'
+
+  cron.new.at('1.30pm').daily.to_s
+  # => '30 13 * * *'
+
+  cron.new.every(6).hours.on('15th').of(:january).to_s
+  # => '0 0,6,12,18 15 1 *' 
+
+  cron.new.every(20).minutes.on(15..18).of(:jan, :feb, :mar).to_s
+  # => '0,20,40 * 15-18 1,2,3 *'
+
+  cron.new.at(14.45).on_days(:monday, :tuesday).to_s
+  # => '45 14 * * 1,2'
+
+== Caveats
+
+Certain combinations produce unintuitive results. They should be obvious but just in case I will
+list some. Such as
+
+  weekly.on_days(:monday, :tuesday) 
+
+Will actually run the task *twice* weekly
+
+TODO: more weird stuff?
+
+Also cron itself allows days of month and days of week to be set. These are independent of each other.
+
+For example:
+
+  on_the('15th').of(:jan).on_days(:mon, :tue)
+
+This will be run on the 15th of January AND every Monday and Tuesday of January, so be aware. Though it
+is a strange combination anyway, the result is the union of both and not the intersection.
+
+
+== Install
+
+  sudo gem install adzap-cronos -s http://gems.github.com
+  
+== Credits
+
+Adam Meehan (http://duckpunching.com, adam.meehan@gmail.com)

data/Rakefile

@@ -0,0 +1,57 @@
+require 'rubygems'
+require 'rake/gempackagetask'
+require 'rubygems/specification'
+require 'date'
+require 'spec/rake/spectask'
+
+GEM = "cronos"
+GEM_VERSION = "0.2.1"
+AUTHOR = "Adam Meehan"
+EMAIL = "adam.meehan@gmail.com"
+HOMEPAGE = "http://github.com/adzap/cronos"
+SUMMARY = "Tool for generating cron intervals using a natural syntax"
+
+spec = Gem::Specification.new do |s|
+  s.name = GEM
+  s.version = GEM_VERSION
+  s.platform = Gem::Platform::RUBY
+  s.has_rdoc = true
+  s.extra_rdoc_files = ["README.rdoc", "LICENSE", 'TODO']
+  s.summary = SUMMARY
+  s.description = s.summary
+  s.author = AUTHOR
+  s.email = EMAIL
+  s.homepage = HOMEPAGE
+  
+  # Uncomment this to add a dependency
+  # s.add_dependency "foo"
+  
+  s.require_path = 'lib'
+  s.autorequire = GEM
+  s.files = %w(LICENSE README.rdoc Rakefile TODO CHANGELOG) + Dir.glob("{lib,spec}/**/*")
+end
+
+task :default => :spec
+
+desc "Run specs"
+Spec::Rake::SpecTask.new do |t|
+  t.spec_files = FileList['spec/**/*_spec.rb']
+  t.spec_opts = %w(-fs --color)
+end
+
+
+Rake::GemPackageTask.new(spec) do |pkg|
+  pkg.gem_spec = spec
+end
+
+desc "install the gem locally"
+task :install => [:package] do
+  sh %{sudo gem install pkg/#{GEM}-#{GEM_VERSION}}
+end
+
+desc "create a gemspec file"
+task :make_spec do
+  File.open("#{GEM}.gemspec", "w") do |file|
+    file.puts spec.to_ruby
+  end
+end

data/TODO

@@ -0,0 +1,3 @@
+TODO:
+- more examples
+- more everything as its a start

data/lib/cronos.rb

@@ -0,0 +1,206 @@
+module Cronos
+
+  class Interval
+    attr_accessor :min, :hour, :day, :month, :dow
+
+    MONTHS = [:jan, :feb, :mar, :apr, :may, :jun, :jul, :aug, :sep, :oct, :nov, :dec]
+
+    DAYS = [:sun, :mon, :tue, :wed, :thu, :fri, :sat]
+
+    # Time:
+    #   at(12)
+    #   at(1.30)
+    #   at('01.30')
+    #   at(14.30)
+    #   at('2pm')
+    #
+    def at(time)
+      @hour, @min, meridian = parse_time(time)
+
+      raise "invalid hour value for 'at'" if @hour > 12 && meridian
+      raise "invalid minute value for 'at'" if @min > 59
+        
+      case meridian
+        when 'am': @hour = 0 if @hour == 12 
+        when 'pm': @hour += 12 if @hour < 12
+      end
+      raise "invalid hour value for 'at'" if @hour > 23
+      self
+    end
+
+    # Repeats an interval:
+    #   every(10).minutes
+    #   every(6).hours
+    #   every(2).months
+    #
+    def every(multiple)
+      RepeatInterval.new(multiple, self)
+    end
+
+    # Days of month:
+    #   on(13)
+    #   on('13th')
+    #   on(13..17)
+    #   on_the('13th')
+    #
+    def on(*args)
+      if args.first.is_a?(Range)
+        range = args.first
+        @day = "#{range.first.to_i}-#{range.last.to_i}"
+      else
+        list = args.collect {|day| day.to_s.to_i }
+        @day = list.join(',')
+      end 
+      self
+    end
+    alias on_the on
+
+    # Days of the week:
+    #   days(:monday)
+    #   days('Monday')
+    #   days(:mon)
+    #   on_day(:monday)
+    #   days(:mon, :tues)
+    #   on_days(:mon, :tues)
+    #
+    def days(*args)
+      list = args.map {|day| DAYS.index(day.to_s.downcase[0..2].to_sym) }
+      @dow = list.join(',')
+      self
+    end
+    alias on_days days
+    alias on_day days
+
+    # Months:
+    #   of(:january)
+    #   of('January')
+    #   of(:jan
+    #   of(:jan, :feb, :mar)
+    #   of_months(1, 2, 3)
+    #
+    def of(*args)
+      list = args.map {|month| MONTHS.index(month.to_s.downcase[0..2].to_sym) + 1 unless month.is_a?(Fixnum) }
+      @month = list.join(',') 
+      self
+    end
+    alias of_months of
+
+    def hourly
+      @min  = 0
+      @hour = nil
+      self
+    end
+
+    def daily
+      @min   ||= 0
+      @hour  ||= 0
+      @day   = nil
+      self
+    end
+    alias once_a_day daily
+
+    def weekly
+      @min   ||= 0
+      @hour  ||= 0
+      @dow   ||= 0
+      @day   = nil
+      @month = nil
+      self
+    end
+    alias once_a_week weekly
+    
+    def monthly
+      @min   ||= 0
+      @hour  ||= 0
+      @day   ||= 1
+      @month = nil
+      @dow   = nil
+      self
+    end
+    alias once_a_month monthly
+
+    def weekdays
+      @min  ||= 0
+      @hour ||= 0
+      @dow  = '1-5'
+      self
+    end
+    
+    def weekends
+      @min  ||= 0
+      @hour ||= 0
+      @dow  = '0,6'
+      self
+    end
+
+    def to_s
+      "#{min || '*'} #{hour || '*'} #{day || '*'} #{month || '*'} #{dow || '*'}"
+    end
+
+    def to_hash
+      {:minute => min || '*', :hour => hour || '*', :day => day || '*', :month => month || '*', :weekday => dow || '*'}
+    end
+
+    private
+
+    def parse_time(time)
+      meridian = /pm|am/i.match(time.to_s)[0].downcase rescue nil
+      hour, min = *time.to_s.split('.')
+
+      hour = hour.to_i
+      min = min.strip.ljust(2, '0').to_i if min
+      min ||= 0
+
+      return hour, min, meridian
+    end
+
+    class RepeatInterval
+
+      def initialize(multiple, interval)
+        @multiple, @interval = multiple, interval
+      end
+
+      def minutes
+        raise 'Multiple of minutes will not fit into an hour' if (60 % @multiple) > 0
+        calculate_intervals(60)
+        @interval.min = self 
+        @interval
+      end
+      
+      def hours
+        raise 'Multiple of hours will not fit into a day' if (24 % @multiple) > 0
+        calculate_intervals(24)
+        @interval.min  = 0
+        @interval.hour = self 
+        @interval
+      end
+
+      def months
+        raise 'Multiple of months will not fit into a year' if (12 % @multiple) > 0
+        calculate_intervals(12, 1)
+        @interval.min  ||= 0
+        @interval.hour ||= 0
+        @interval.day  ||= 1
+        @interval.month = self 
+        @interval
+      end
+
+      def calculate_intervals(base, initial = 0)
+        repeats = (base / @multiple) - 1
+        set = [initial]
+        1.upto(repeats) {|factor| set << (factor * @multiple + initial) }
+        @intervals = set
+      end
+
+      def to_s
+        @intervals.join(',')
+      end
+
+      def to_a
+        @intervals
+      end
+    end 
+
+  end
+
+end

data/spec/cronos_spec.rb

@@ -0,0 +1,277 @@
+require File.dirname(__FILE__) + '/spec_helper'
+
+describe Cronos::Interval do
+
+  it "should return default interval for every minute" do
+    interval.to_s.should == '* * * * *'
+  end
+
+  it "should return hash of values from to_hash method" do
+    interval.to_hash.should == {:minute => '*', :hour => '*', :day => '*', :month => '*', :weekday => '*'}
+  end
+
+  describe "at method" do
+    it "should output interval from integer with hour as integer value and 0 minute" do
+      interval.at(8).to_s.should == '0 8 * * *'
+    end
+
+    it "should output interval from a float with hour value from integer part and minute from decimal part" do
+      interval.at(8.21).to_s.should == '21 8 * * *'
+    end
+    
+    it "should output interval from a float with hour value from integer part and minute from decimal part left justified to 2 digits" do
+      interval.at(8.20).to_s.should == '20 8 * * *'
+    end
+
+    it "should output interval from time string with pm meridian having hour adjusted 24 hour time" do
+      interval.at('8.21pm').to_s.should == '21 20 * * *'
+    end
+    
+    it "should output interval from time string with pm meridian having hour unadjusted if hour is 12" do
+      interval.at('12.21pm').to_s.should == '21 12 * * *'
+    end
+
+    it "should output interval from time string with am meridian having hour adjusted to 0 if hour is 12" do
+      interval.at('12.21am').to_s.should == '21 0 * * *'
+    end
+
+    it "should raise error if hours out of range" do
+      lambda { interval.daily.at('24.21') }.should raise_error
+    end
+
+    it "should raise error if minutes out of range" do
+      lambda { interval.daily.at('23.60') }.should raise_error
+    end
+  end
+  
+  describe "on method" do
+    it "should output interval from integer with day of month as value" do
+      interval.on(15).to_s.should == '* * 15 * *'
+    end
+
+    it "should output interval from day string with ordinal suffix" do
+      interval.on('15th').to_s.should == '* * 15 * *'
+    end
+
+    it "should output interval from integer range as dashed day of month range " do
+      interval.on(15..17).to_s.should == '* * 15-17 * *'
+    end
+
+    it "should output interval from integer array as day number list" do
+      interval.on(15, 16, 17).to_s.should == '* * 15,16,17 * *'
+    end
+
+    it "should output interval from day string array as day number list" do
+      interval.on('15th', '16th', '17th').to_s.should == '* * 15,16,17 * *'
+    end
+  end
+
+  describe "of method" do
+    it "should output interval with month number from a symbol month name" do
+      interval.of(:january).to_s.should == '* * * 1 *'
+    end
+
+    it "should output interval with month number from a symbol short month name" do
+      interval.of(:jan).to_s.should == '* * * 1 *'
+    end
+
+    it "should output interval with month number from a strong month name" do
+      interval.of('January').to_s.should == '* * * 1 *'
+    end
+
+    it "should output interval with comma seperated month numbers from array of symbol month names" do
+      interval.of(:january, :february, :march).to_s.should == '* * * 1,2,3 *'
+    end
+
+    it "should output interval with comma seperated month numbers from array of short symbol month names" do
+      interval.of(:jan, :feb, :mar).to_s.should == '* * * 1,2,3 *'
+    end
+
+    it "should output interval with comma seperated month numbers from array of string month names" do
+      interval.of('January', 'February', 'March').to_s.should == '* * * 1,2,3 *'
+    end
+  end
+
+  describe "days method" do
+    it "should output interval with day number from a symbol day name" do
+      interval.days(:monday).to_s.should == '* * * * 1'
+    end
+
+    it "should output interval with day number from a string day name" do
+      interval.days('Mondays').to_s.should == '* * * * 1'
+    end
+
+    it "should output interval with day number from a symbol short day name" do
+      interval.days(:mon).to_s.should == '* * * * 1'
+    end
+
+    it "should output interval with day numbers from array of symbol day names" do
+      interval.days(:monday, :wednesday, :friday).to_s.should == '* * * * 1,3,5'
+    end
+
+    it "should output interval with day numbers from array of symbol short day names" do
+      interval.days(:mon, :wed, :fri).to_s.should == '* * * * 1,3,5'
+    end
+
+    it "should output interval with day numbers from array of string day names" do
+      interval.days('Monday', 'Wednesday', 'Friday').to_s.should == '* * * * 1,3,5'
+    end
+  end
+
+  describe "hourly method" do
+    it "should output interval to run at start of every hour" do
+      interval.hourly.to_s.should == '0 * * * *'
+    end
+
+    it "should only affect the hour and minutes" do
+      interval.day = 1
+      interval.month = 1
+      interval.dow = 1
+      interval.hourly.to_s.should == '0 * 1 1 1'
+    end
+  end
+
+  describe "daily method" do
+    it "should output interval to run at 00:00 every day by default" do
+      interval.daily.to_s.should == '0 0 * * *'
+    end
+
+    it "should only affect the hour, minutes and day" do
+      interval.month = 1
+      interval.dow = 1
+      interval.daily.to_s.should == '0 0 * 1 1'
+    end
+
+    it "should preserve hour and minutes if set" do
+      interval.min = 10
+      interval.hour = 11
+      interval.daily.to_s.should == '10 11 * * *'
+    end
+  end
+
+  describe "weekly method" do
+    it "should output interval to run on Sunday at 00:00 by default" do
+      interval.weekly.to_s.should == '0 0 * * 0'
+    end
+
+    it "should override day of month and month" do
+      interval.day = 1
+      interval.month = 1
+      interval.weekly.to_s.should == '0 0 * * 0'
+    end
+
+    it "should preserve hour, minute and day of week if set" do
+      interval.min = 10
+      interval.hour = 11
+      interval.dow = 1
+      interval.daily.to_s.should == '10 11 * * 1'
+    end
+  end
+
+  describe "monthly method" do
+    it "should output interval to run on the 1st day of every month at 00:00 by default" do
+      interval.monthly.to_s.should == '0 0 1 * *'
+    end
+
+    it "should override day of month and month" do
+      interval.day = 1
+      interval.month = 1
+      interval.monthly.to_s.should == '0 0 1 * *'
+    end
+
+    it "should preserve hour, minute and day if set" do
+      interval.min = 10
+      interval.hour = 11
+      interval.day = 12
+      interval.monthly.to_s.should == '10 11 12 * *'
+    end
+  end
+
+  describe "weekends method" do
+    it "should output interval to run at 00:00 every Saturday and Sunday" do
+      interval.weekends.to_s.should == '0 0 * * 0,6'
+    end
+  end
+
+  describe "weekdays method" do
+    it "should output interval to run at 00:00 every day Monday to Friday" do
+      interval.weekdays.to_s.should == '0 0 * * 1-5'
+    end
+  end
+
+  describe "every(x).minutes" do
+    it "should output interval for list of minutes differing by arg value" do
+      interval.every(15).minutes.to_s.should == '0,15,30,45 * * * *'
+    end
+
+    it "should raise error if x not a divisor of 60" do
+      lambda { interval.every(13).minutes }.should raise_error
+    end
+  end
+
+  describe "every(x).hours" do
+    it "should output interval for 0 minute and list of hours differing by arg value" do
+      interval.every(6).hours.to_s.should == '0 0,6,12,18 * * *'
+    end
+
+    it "should raise error if x not a divisor of 24" do
+      lambda { interval.every(13).minutes }.should raise_error
+    end
+  end
+
+  describe "every(x).months" do
+    it "should output interval for 00:00 on 1st day of month and list of months differing by arg value" do
+      interval.every(6).hours.to_s.should == '0 0,6,12,18 * * *'
+    end
+
+    it "should raise error if x not a divisor of 12" do
+      lambda { interval.every(7).minutes }.should raise_error
+    end
+  end
+  
+  describe "combinations" do
+    it "weekly.at(3.30) should output '30 3 * * 0'" do
+      interval.weekly.at(3.30).to_s.should == '30 3 * * 0'
+    end
+
+    it "monthly.at(3.30) should output '30 3 * * *'" do
+      interval.monthly.at(3.30).to_s.should == '30 3 1 * *'
+    end
+
+    it "monthly.on_the('15th').at(3.30) should output '30 3 15 * *'" do
+      interval.monthly.on_the('15th').at(3.30).to_s.should == '30 3 15 * *'
+    end
+
+    it "at('11pm').on_days(:monday, :tuesday) should output '0 11 * * 1,2'" do
+      interval.at('11pm').on_days(:monday, :tuesday).to_s.should == '0 23 * * 1,2'
+    end
+
+    it "on(15).of(:january) should output '* * 15 1 *'" do
+      interval.on(15).of(:january).to_s.should == '* * 15 1 *'
+    end
+
+    it "on(15, 16, 17).of(:january) should output '* * 15,16,17 1 *'" do
+      interval.on(15, 16, 17).of(:january).to_s.should == '* * 15,16,17 1 *'
+    end
+    
+    it "on(15..17).of(:january) should output '* * 15-17 1 *'" do
+      interval.on(15..17).of(:january).to_s.should == '* * 15-17 1 *'
+    end
+
+    it "on(15, 16, 17).of(:january) should output '* * 15 1,6,12 *'" do
+      interval.on(15).of(:jan, :jun, :dec).to_s.should == '* * 15 1,6,12 *'
+    end
+    
+    it "at('2.13pm').on_the_('15th').of(:january) should output '13 14 15 1'" do
+      interval.at('2.13pm').on_the(15).of(:january).to_s.should == '13 14 15 1 *'
+    end
+    
+    it "every(15).minutes.on_the('15th').of(:january) should output '0,15,30,45 * 15 1 *'" do
+      interval.every(15).minutes.on_the('15th').of(:january).to_s.should == '0,15,30,45 * 15 1 *'
+    end
+  end
+
+  def interval
+    @interval ||= Cronos::Interval.new
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,6 @@
+$TESTING=true
+$:.push File.join(File.dirname(__FILE__), '..', 'lib')
+
+require 'rubygems'
+require 'spec'
+require 'cronos'

metadata

@@ -0,0 +1,62 @@
+--- !ruby/object:Gem::Specification 
+name: adzap-cronos
+version: !ruby/object:Gem::Version 
+  version: 0.2.1
+platform: ruby
+authors: 
+- Adam Meehan
+autorequire: cronos
+bindir: bin
+cert_chain: []
+
+date: 2009-01-17 00:00:00 -08:00
+default_executable: 
+dependencies: []
+
+description: Tool for generating cron intervals using a natural syntax
+email: adam.meehan@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+- LICENSE
+- TODO
+files: 
+- LICENSE
+- README.rdoc
+- Rakefile
+- TODO
+- CHANGELOG
+- lib/cronos.rb
+- spec/spec_helper.rb
+- spec/cronos_spec.rb
+has_rdoc: true
+homepage: http://github.com/adzap/cronos
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: Tool for generating cron intervals using a natural syntax
+test_files: []
+