rbcrontab 0.1

data/README

@@ -0,0 +1,22 @@
+Copyright (c) 2008 Rob Hurring
+
+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/Rakefile

@@ -0,0 +1,39 @@
+require 'rubygems'
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+require 'rake/gempackagetask'
+
+spec = Gem::Specification.new do |s|
+  s.name = 'rbcrontab'
+  s.version = '0.1'
+  s.summary = 'Generate crontabs using ruby'
+  s.author = 'Rob Hurring'
+  s.email = 'rob@ubrio.us'
+  s.homepage = 'http://robhurring.com'
+  s.platform = Gem::Platform::RUBY
+  s.rubyforge_project = 'rbcrontab'
+  s.has_rdoc = true
+  s.extra_rdoc_files = [ 'README' ]
+  s.rdoc_options << '--main' << 'README'
+  s.files = Dir.glob("{examples,lib}/**/*") +
+    [ 'README', 'Rakefile', 'TODO' ]
+end
+
+desc 'Generate RDoc'
+Rake::RDocTask.new :rdoc do |rd|
+  rd.rdoc_dir = 'doc'
+  rd.rdoc_files.add 'lib', 'README'
+  rd.main = 'README'
+end
+
+desc 'Build Gem'
+Rake::GemPackageTask.new spec do |pkg|
+  pkg.need_tar = true
+end
+
+desc 'Clean up'
+task :clean => [ :clobber_rdoc, :clobber_package ]
+
+desc 'Clean up'
+task :clobber => [ :clean ]

data/examples/cli_crontab.rb

@@ -0,0 +1,36 @@
+#!/usr/bin/env ruby -rrubygems
+require 'rbcrontab'
+
+# want to source my bash profile before certain schedules
+source_bash_profile = ['source $HOME/.bash_profile']
+
+crontab = Crontab.new do |cron|
+  
+  cron.mail_to  'user@example.com'
+  cron.home     '/home/user'
+  cron.path     ['/home/user/bin', '/home/user/something/bin']
+  
+  cron.desc 'Check for new requests every 5 minutes on weekdays'
+  cron.schedule(:every => 5.minutes, :on => Days::WEEKDAYS, :setup => source_bash_profile, :mail_to => 'someone@example.com') do
+    "rake requests:check"
+  end
+  
+  cron.schedule(:at => Time::MIDNIGHT, :on => Days::WEEKENDS) do
+    "party"
+  end
+  
+  cron.desc 'At 1:15p every 5 days in May mail my mom'
+  cron.schedule(:at => '13:15', :on_the => '5,10,15,20,25,30', :of => Month::MAY) do
+    'echo "hey mom!"|mail mom@example.com -s "your son forgot to call so hes emailing!"'
+  end
+  
+  cron.desc 'Check hourly for new mail on weekdays in March'
+  cron.schedule(:every => 1.hour, :in => Month::MARCH, :on => Days::WEEKDAYS) do
+    'check_for_mail'
+  end
+  
+end
+
+# this will use optparse to create 2 different options
+#   run this script using the '-h' option to see usage
+Crontab::CLI.start! binding

data/lib/extensions.rb

@@ -0,0 +1,40 @@
+# create the cron equiv of Fixnum.minutes
+# Example:
+#   10.minutes  #=> '10/* *'
+#   5.hours     #=> '* 5/*'
+class Fixnum
+  def minutes
+    '%s/* *' % self
+  end
+  alias_method :minute, :minutes
+  def hours
+    '* %s/*' % self
+  end
+  alias_method :hour, :hours
+end
+
+class Month
+  JANUARY   = 1
+  FEBRUARY  = 2
+  MARCH     = 3
+  APRIL     = 4
+  MAY       = 5
+  JUNE      = 6
+  JULY      = 7
+  AUGUST    = 8
+  SEPTEMBER = 9
+  OCTOBER   = 10
+  NOVEMBER  = 11
+  DECEMBER  = 12
+end
+
+class Time
+  MIDNIGHT  = '0:0'
+  NOON      = '12:0'
+end
+
+class Days
+  EVERYDAY  = '*'
+  WEEKDAYS  = '1-5'
+  WEEKENDS  = '0,6'
+end

data/lib/rbcrontab.rb

@@ -0,0 +1,186 @@
+# == About
+# 
+# Author:: Rob Hurring <rob@ubrio.us>
+# Website:: http://robhurring.com
+# 
+# This is s a stupid simple way to make managing crontabs easier
+# It allows you to write basic cron tasks in ruby and output the
+# complete crontab. I find it easier with setup tasks and repetitive
+# schedules and such. Really only meant as a simple cron mgt. script
+# 
+# == License
+#
+# Copyright (c) 2008 Rob Hurring
+# 
+# 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.
+require 'optparse'
+require 'extensions'
+# Example:
+#   crontab = Crontab.new do |cron| 
+#     cron.desc 'this is my schedule description'
+#     cron.schedule(:every => 10.minutes, :on => Days::WEEKDAYS) { 'do something' }
+#   end
+#   puts crontab.to_crontab
+# 
+# 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
+    @schedules = []
+    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)
+    @paths = []
+    @paths << '$PATH' if include_path
+    @paths << paths
+    @paths = @paths.flatten.join(':')
+  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
+    @last_description = nil
+    @schedules << Schedule.new(*args, &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" }
+  end
+  # sets the description for the schedule immediately following
+  def desc(description)
+    @last_description = description
+  end
+  # lists the descriptions of all cron schedules for easy reviewing
+  def describe
+    output = "Crontabs\n" + ('-' * 40) + "\n"
+    descriptions = @schedules.map{ |s| s.description }.compact
+    descriptions.each_with_index do |d, i|
+      output << "##{i + 1}: #{d}\n"
+    end
+    output
+  end
+  def header #:nodoc:
+    headers = []
+    headers << "HOME=%s" % @home if @home
+    headers << "PATH=%s" % @paths if @paths
+    headers << "MAILTO=%s" % @mail_to if @mail_to
+    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!' }
+  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
+    # * :on => '1,2,3' -- days of the _week_, or Day::CONSTANT
+    # * :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 }
+      @do = yield
+    end
+    # builds the cron schedule line
+    def to_cron
+      cron_lines = []
+      cron_lines << cron_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
+  private
+    def cron_description #:nodoc:
+      "# #{@description}" if @description
+    end
+    def command #:nodoc:
+      all_commands = []
+      all_commands << @setup if @setup
+      all_commands << @do
+      all_commands.join ' && '
+    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
+  end
+  # Simple CLI class which includes basic command line options
+  # to the cron script
+  # Options:
+  #   -h  --help        print the usage
+  #   -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)
+      eval %{if $0 == __FILE__
+        options = {}
+        OptionParser.new do |opts|
+          opts.banner = "Usage: #{$0} [options]"
+          opts.on('-d', '--describe', 'Describe current cron schedules') do |d|
+            options[:describe] = d
+          end
+          opts.on_tail("-h", "--help", "Show this message") do
+            puts opts
+            exit
+          end
+        end.parse!
+
+        if options[:describe]
+          puts crontab.describe
+        else
+          puts crontab.to_crontab
+        end
+      end
+      }, the_binding
+    end
+  end
+end

metadata

@@ -0,0 +1,59 @@
+--- !ruby/object:Gem::Specification 
+name: rbcrontab
+version: !ruby/object:Gem::Version 
+  version: "0.1"
+platform: ruby
+authors: 
+- Rob Hurring
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-08-24 00:00:00 -04:00
+default_executable: 
+dependencies: []
+
+description: 
+email: rob@ubrio.us
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README
+files: 
+- examples/cli_crontab.rb
+- lib/extensions.rb
+- lib/rbcrontab.rb
+- README
+- Rakefile
+- TODO
+has_rdoc: true
+homepage: http://robhurring.com
+post_install_message: 
+rdoc_options: 
+- --main
+- README
+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: rbcrontab
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: Generate crontabs using ruby
+test_files: []
+