rbcrontab 0.1 → 1.0

data/Rakefile

@@ -6,7 +6,7 @@ require 'rake/gempackagetask'
 
 spec = Gem::Specification.new do |s|
   s.name = 'rbcrontab'
-  s.version = '0.1'
+  s.version = '1.0'
   s.summary = 'Generate crontabs using ruby'
   s.author = 'Rob Hurring'
   s.email = 'rob@ubrio.us'

data/examples/full_example.rb

@@ -0,0 +1,72 @@
+#!/usr/bin/env ruby -rrubygems
+require 'rbcrontab'
+
+# setup your basic file paths
+ROOT    = File.dirname(__FILE__)
+
+# global setup -- we want to source our profile before any cron command
+source_bash = 'source $HOME/.bash_profile'
+
+# simple rake helper method
+def rake(app, command, silent = true)
+  "rake -f#{ROOT}/#{app}/Rakefile #{'-s' if silent} #{command}"
+end
+
+# simple script helper method
+def script(name)
+  "#{ROOT}/scripts/name"
+end
+
+#
+# Crontab Start
+#
+
+crontab = Crontab.new do |cron|
+  
+  # mail it to me
+  cron.mail_to  'you@example.com'
+  # add my custom paths
+  cron.path     %w{/usr/local/bin /usr/bin $HOME/bin}, false
+  # setup my home variable
+  cron.home     ENV['HOME']
+  # make sure every schedule sources the bash profile and sets
+  # the RAILS_ENV to production
+  cron.global_setup source_bash, 'RAILS_ENV=production'
+  
+  # handle some requests through rake on some app
+  cron.desc 'handle requests at 5 min intervals on weekdays'
+  cron.schedule :every => 5.minutes, :on => Days::WEEKDAYS do
+    rake 'app', 'requests:process'
+  end
+  
+  # do some nightly database backups through a bash script we have
+  # in our scripts folder
+  cron.desc 'backup app database files at midnight on weekdays'
+  cron.schedule :at => Time::MIDNIGHT, :on => Days::WEEKDAYS do
+    script 'backup_database_script'
+  end
+  
+  # clean up some old user searches if they are old
+  cron.desc 'clean old user searches in some app if > 1 week old on monday'
+  # set the DAYS_OLD environment variable so the rake task can use it
+  cron.schedule :at => Time::MIDNIGHT, :on => Days::MONDAY, :setup => 'DAYS_OLD=7' do
+    rake 'app', 'searches:clean'
+  end
+  
+  # just a stupid 'hello world' task to show how to ignore global setups
+  cron.desc 'at 8:30am echo "I GOT A CASE OF THE MUNDAYS!" on mondays'
+  cron.schedule :at => '08:30', :on => Days::MONDAY, :ignore_global_setup => true do
+    "echo 'I GOT A CASE OF THE MUNDAYS!'"
+  end
+
+  # pointless, but just to show how to override the global setup and make your own for this one
+  # schedule
+  cron.desc 'using our OWN setup, not the global one'
+  cron.schedule :every => 1.hour, :on => Days::WEEKENDS, :ignore_global_setup => true, :setup => ['A=1', 'B=2'] do
+    "echo $A && echo $B"
+  end
+
+end
+
+# eval the CLI script so you can run it from the command line
+Crontab::CLI.start! binding

data/lib/{extensions.rb → crontab_helper.rb}

@@ -1,14 +1,14 @@
 # create the cron equiv of Fixnum.minutes
 # Example:
-#   10.minutes  #=> '10/* *'
-#   5.hours     #=> '* 5/*'
+#   10.minutes  #=> '*/10 *'
+#   5.hours     #=> '0 */5'
 class Fixnum
   def minutes
-    '%s/* *' % self
+    '*/%s *' % self
   end
   alias_method :minute, :minutes
   def hours
-    '* %s/*' % self
+    '0 */%s' % self
   end
   alias_method :hour, :hours
 end
@@ -37,4 +37,12 @@ class Days
   EVERYDAY  = '*'
   WEEKDAYS  = '1-5'
   WEEKENDS  = '0,6'
+  SUNDAY    = 0
+  MONDAY    = 1
+  TUESDAY   = 2
+  WEDNESDAY = 3
+  THURSDAY  = 4
+  FRIDAY    = 5
+  SATURDAY  = 6
+  SUNDAY_ALT= 7
 end

data/lib/rbcrontab.rb

@@ -33,7 +33,7 @@
 # FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
 # OTHER DEALINGS IN THE SOFTWARE.
 require 'optparse'
-require 'extensions'
+require 'crontab_helper'
 # Example:
 #   crontab = Crontab.new do |cron| 
 #     cron.desc 'this is my schedule description'
@@ -43,18 +43,23 @@ require 'extensions'
 # 
 # see the examples directory for a more verbose example
 class Crontab
+  
   # can either use as a block or regular object
   # Crontab.new { |cron| ... }
   # crontab = Crontab.new
-  def initialize
+  def initialize(options = {})
     @schedules = []
+    @global_setup = nil
+    @header = options[:header] || false
     yield self if block_given?
   end
+  
   # set the MAILTO user for the _entire_ crontab
   # to set it per-schedule view the schedule :mail_to arg
   def mail_to(who)
     @mail_to = who
   end
+  
   # set the path for the _entire_ crontab
   # include_path will keep the original $PATH in there
   def path(paths, include_path = true)
@@ -63,28 +68,75 @@ class Crontab
     @paths << paths
     @paths = @paths.flatten.join(':')
   end
+  
+  # defines your setup for every schedule
+  def global_setup(*commands)
+    @global_setup = commands
+  end
+  
   # set your home path, probably not necessary, but why not
   def home(home_path)
     @home = home_path
   end
+  
   # creates a schedule object from the args passes
   # your command will go in the block
   #
   # crontab.schedule(:args => ...) { "command to run" }
-  def schedule(*args, &block)
-    args.first.merge! :description => @last_description if @last_description
+  def schedule(settings, &block)
+    settings.merge! :description => @last_description if @last_description
+    setup = []
+    setup << @global_setup if @global_setup and not settings[:ignore_global_setup]
+    setup << settings[:setup] if settings[:setup]
+    settings[:setup] = setup.flatten.uniq.join(' && ') unless setup.empty?
     @last_description = nil
-    @schedules << Schedule.new(*args, &block)
+    @schedules << Schedule.new(settings, &block)
   end
+  
   # runs the to_cron method on all schedules and dumps
   # the crontab to be copied/pasted
-  def to_crontab
-    @schedules.inject(header){ |o, s| o << s.to_cron + "\n\n" }
+  # if display_cron_header is true, it will output the
+  # text block in cron_description_block
+  #
+  # FIXME: ugly as fuck
+  def to_crontab(display_cron_header = false)
+    crontab = ''
+    crontab << header
+    crontab << cron_description_block if display_cron_header
+    @schedules.each { |s| crontab << s.to_cron + "\n\n" }
+    crontab
+  end
+  
+  # goofy cron description text to visually see whats going on if you aren't
+  # familiar with crontabs
+  # FIXME: ugly as fuck
+  def cron_description_block
+%{
+# +---------------- minute (0 - 59)
+# |  +------------- hour (0 - 23)
+# |  |  +---------- day of month (1 - 31)
+# |  |  |  +------- month (1 - 12)
+# |  |  |  |  +---- day of week (0 - 7) (Sunday=0 or 7)
+# |  |  |  |  |
+# *  *  *  *  *  command to be executed
+
+}
   end
+  
   # sets the description for the schedule immediately following
   def desc(description)
     @last_description = description
   end
+  
+  # creates a human readable list of all crob schedules
+  def to_s(verbose = true)
+    @schedules.inject('') do |o,s| 
+      o << s.to_s + "\n"
+      o << "`#{s.command}`\n" if verbose
+      o << "\n"
+    end
+  end
+  
   # lists the descriptions of all cron schedules for easy reviewing
   def describe
     output = "Crontabs\n" + ('-' * 40) + "\n"
@@ -94,6 +146,7 @@ class Crontab
     end
     output
   end
+  
   def header #:nodoc:
     headers = []
     headers << "HOME=%s" % @home if @home
@@ -102,12 +155,14 @@ class Crontab
     headers << "\n" unless headers.empty?
     headers.join("\n")
   end
+  
   # Example:
   #   crontab.schedule(:at => Time::MIDNIGHT, :on => Day::WEEKDAYS) { 'backup_database' }
   #   crontab.schedule(:every => 10.minutes, :on => Day::WEEKENDS) { 'check something' }
   #   crontab.schedule(:at => '18:00', :on_the => '5', :of => Month::MAY) { 'party!' }
+  #   crontab.schedule(:every => 5.minutes, :on =>Days::WEEKDAYS, :setup => 'source $HOME/.bashrc') { 'command' }
+  #   crontab.schedule(:every => 1.hour, :on =>Days::MONDAY, :setup => ['HI=1', 'WORLD=2']) { 'command' }
   class Schedule
-    attr_reader :description
     # args consist of
     # * :every => 1.minute, 10.minutes, 1.hour, 5.hours -- minutes or hours
     # * :at => '00:00' -- 24 hour time for when to run
@@ -115,37 +170,130 @@ class Crontab
     # * :on_the => '1,2,3' -- days of the _month_
     # * :in => Month::JANUARY -- month [0..12]
     # * :of => Month::JANUARY -- month [0..12] -- alias for readability
-    def initialize(*args, &block)
-      args.first.each { |k,v| instance_variable_set "@#{k}", v }
+    # * :setup => 'command' (or ['command', 'command', ...]) -- anything to do _before_ running your comand (source bashrc or whatnot for example)
+    # * :ignore_global_setup => true|false -- if you would like to ignore the global setup command
+    def initialize(settings, &block)
+      settings.each { |k,v| instance_variable_set "@#{k}", v }
       @do = yield
     end
+    
+    # the command the schedule should run
+    def command
+      all_commands = []
+      all_commands << @setup if @setup
+      all_commands << @do
+      all_commands.join ' && '
+    end
+    
     # builds the cron schedule line
     def to_cron
       cron_lines = []
-      cron_lines << cron_description if @description
+      cron_lines << "# #{@description}" if @description
       cron_lines << ('MAILTO=%s' % [@mail_to]) if @mail_to
       cron_lines << ("%s %s %s %s %s" % [time, days_of_month, months, weekdays, command])
       cron_lines.join("\n")
     end
+    
+    # outputs a human readable format of the cron schedule
+    def to_s
+      output = ''
+      output << human_time if human_time
+      output << ' on ' + human_day_of_month if human_day_of_month
+      output << ' in ' + human_month if human_month
+      output << ' on ' + human_weekdays if human_weekdays
+      output << " \"#{@description}\"" if @description
+      output
+    end
+        
   private
-    def cron_description #:nodoc:
-      "# #{@description}" if @description
+  
+    # converts a cron weekday list into human readable form
+    def human_weekdays
+      case weekdays
+      when '*': nil
+      when Days::WEEKDAYS: 'Weekdays'
+      when Days::WEEKENDS: 'Weekends'
+      when Days::MONDAY: 'Monday'
+      when Days::TUESDAY: 'Tuesday'
+      when Days::WEDNESDAY: 'Wednesday'
+      when Days::THURSDAY: 'Thursday'
+      when Days::FRIDAY: 'Friday'
+      when Days::SATURDAY: 'Saturday'
+      when Days::SUNDAY, Days::SUNDAY_ALT: 'Sunday'
+      else
+         weekdays
+      end
     end
-    def command #:nodoc:
-      all_commands = []
-      all_commands << @setup if @setup
-      all_commands << @do
-      all_commands.join ' && '
+  
+    # converts a cron day of month list into human readable form
+    def human_day_of_month
+      case days_of_month
+      when '*': nil
+      else
+        "the %s" % days_of_month
+      end
+    end
+  
+    # converts a cron month into a human readable month
+    def human_month
+      case months
+      when '*': nil
+      when Month::JANUARY: 'January'
+      when Month::FEBRUARY: 'February'
+      when Month::MARCH: 'March'
+      when Month::APRIL: 'April'
+      when Month::MAY: 'May'
+      when Month::JUNE: 'June'
+      when Month::JULY: 'July'
+      when Month::AUGUST: 'August'
+      when Month::SEPTEMBER: 'September'
+      when Month::OCTOBER: 'October'
+      when Month::NOVEMBER: 'November'
+      else
+        months
+      end
+    end
+    
+    # converts a cron minute/hour list into human readable format
+    def human_time
+      minutes, hours = time.split(' ')
+      
+      minute_description = \
+        case minutes
+        when '*': 'Every minute'
+        when '0': nil
+        when /\*\/(\d*)/: "every #{$1} minutes"
+        end
+      
+      hour_description = \
+        case hours
+        when '*': nil
+        when /\*\/(\d*)/: $1.to_i == 1 ? 'every hour' : "every #{$1} hours"
+        end
+      
+      unless minute_description or hour_description
+        output = "at %02d:%02d" % [hours.to_i, minutes.to_i]
+      else
+        output = ''
+        output << minute_description if minute_description
+        output << ' in ' if hour_description and minute_description
+        output << hour_description if hour_description
+      end
+      output.capitalize
     end
+    
     def time #:nodoc:
       @at ? (@at || '*:*').split(':').reverse.join(' ') : (@every || '* *')
     end
+
     def days_of_month #:nodoc:
       @on_the || '*'
     end
+
     def months #:nodoc:
       @in || @of || '*'
     end
+
     def weekdays #:nodoc:
       @on || '*'
     end
@@ -153,14 +301,17 @@ class Crontab
   # Simple CLI class which includes basic command line options
   # to the cron script
   # Options:
-  #   -h  --help        print the usage
-  #   -d  --describe    describes the crontab
+  #   -h  --help          print the usage
+  #   --cron-description  shows the cron description block
+  #   -d  --describe      describes the crontab
   class CLI
     # evaluates the necessary script to handle CLI option parsing
     # it wants the current binding so inside your script you'd do
     # Example:
     #   Crontab::CLI.start!(binding)
-    def self.start!(the_binding)
+    # if your crontab is _not_ named 'crontab' you must pass the object in using
+    #   Crontab::CLI.start! binding, whatever_your_crontab_object_is_called
+    def self.start!(binding, crontab_object = 'crontab')
       eval %{if $0 == __FILE__
         options = {}
         OptionParser.new do |opts|
@@ -168,6 +319,9 @@ class Crontab
           opts.on('-d', '--describe', 'Describe current cron schedules') do |d|
             options[:describe] = d
           end
+          opts.on('--cron-description', 'Show the cron description block in the crontab') do |c|
+            options[:cron_description] = c
+          end
           opts.on_tail("-h", "--help", "Show this message") do
             puts opts
             exit
@@ -175,12 +329,12 @@ class Crontab
         end.parse!
 
         if options[:describe]
-          puts crontab.describe
+          puts #{crontab_object}.to_s
         else
-          puts crontab.to_crontab
+          puts #{crontab_object}.to_crontab(options[:cron_description])
         end
       end
-      }, the_binding
+      }, binding
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: rbcrontab
 version: !ruby/object:Gem::Version 
-  version: "0.1"
+  version: "1.0"
 platform: ruby
 authors: 
 - Rob Hurring
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-08-24 00:00:00 -04:00
+date: 2008-09-22 00:00:00 -04:00
 default_executable: 
 dependencies: []
 
@@ -23,7 +23,8 @@ extra_rdoc_files:
 - README
 files: 
 - examples/cli_crontab.rb
-- lib/extensions.rb
+- examples/full_example.rb
+- lib/crontab_helper.rb
 - lib/rbcrontab.rb
 - README
 - Rakefile