crondonkulous 1.0.0

data/History.txt

@@ -0,0 +1,4 @@
+=== 1.0.0 2009-08-18
+
+* 1 major enhancement:
+  * Initial release

data/Manifest.txt

@@ -0,0 +1,15 @@
+History.txt
+Manifest.txt
+README.rdoc
+Rakefile
+lib/crondonkulous.rb
+lib/crondonkulous/recipes.rb
+rails_generators/crondonkulous_generator.rb
+rails_generators/templates/crondonkulous.rake
+rails_generators/templates/crontab.erb
+rails_generators/templates/readme.txt
+script/console
+script/destroy
+script/generate
+test/test_crondonkulous.rb
+test/test_helper.rb

data/README.rdoc

@@ -0,0 +1,74 @@
+= crondonkulous
+
+* http://github.com/bokmann/crondonkulous
+
+== DESCRIPTION:
+
+Ever need to have process run regularly for your rails app?  Ever want to use cron as the answer?  Sure you have!  So lets get it done.
+
+It sounds pretty easy... use cron to automate the periodic execution of some rake tasks... but in practice we run into a couple of problems:
+
+* Keeping the cron tasks in sync with your capistrano deploys
+* preventing the cron tasks from running while you are deploying/migrating
+* keeping the cron tasks from stepping on each other if they are taking longer than expected to run
+* having cron logging output intermingled with logging from your controllers
+
+Ever have any of these problems?  I know I have.  So lets solve them once and for all, and bundle it into a gem with some reusable conventions.  Enter Crondonkulous!
+
+== Here's what you get:
+* a crontab file with all the silly little syntax you need to specify tasks for:
+  * every minute
+  * every 5 minutes
+  * every 15 minutes
+  * every hour
+  * every day
+  * every week
+  * every month
+* a crondonkulous.rake template that separates logging out of your controller's log file, with a sane naming convention for logs
+* a lockfile, so that rake tasks invoked with cron won't start if there is another one running (and you specify the number of times to retry)
+* capistrano tasks that:
+  * stop the cronned rake tasks while deploying
+  * wait until any running ones are done before continuing the deploy
+  * load in any new cron entries when the webapp restarts.
+
+
+== REQUIREMENTS:
+
+* Its a gem for rails, so.. uh, all of that stuff.
+* a capistrano deploy (will gladly accept patches for vlad)
+* a server running cron that allows crontab entries by user
+* also relies on the lockfile gem
+
+== INSTALL:
+
+* sudo gem install bokmann-crondonkulous
+* ./script/generate crondonkulous
+* follow the instructions to modify the files it puts in your project
+
+== HISTORY:
+A couple of years ago I wrote the 'automate repeatable tasks' recipe for the book Advanced Rails Recipes from Pragmatic Bookshelf.  Some of these ideas are represented there, but they have evolved a lot as I have added better integration with capistrano, reliance on the lockfile gem, etc.
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2009 CodeSherpas Inc.
+
+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,20 @@
+require 'rake'
+require 'rake/testtask'
+require 'rcov/rcovtask'
+require 'shoulda/tasks'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gemspec|
+    gemspec.name = "crondonkulous"
+    gemspec.summary = "A generator and conventions for using cron with rake tasks in a rails application."
+    gemspec.description = "A generator and conventions for using cron with rake tasks in a rails application."
+    gemspec.email = "dbock@codesherpas.com"
+    gemspec.homepage = "http://github.com/bokmann/crondonkulous"
+    gemspec.authors = ["David Bock"]
+    gemspec.add_dependency('lockfile', '>= 1.4.0')
+    
+  end
+rescue LoadError
+  puts "Jeweler not available. Install it with: sudo gem install technicalpickles-jeweler -s http://gems.github.com"
+end

data/VERSION

@@ -0,0 +1 @@
+1.0.0

data/lib/crondonkulous.rb

@@ -0,0 +1,6 @@
+$:.unshift(File.dirname(__FILE__)) unless
+  $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
+
+module Crondonkulous
+  VERSION = '1.0.0'
+end

data/lib/crondonkulous/recipes.rb

@@ -0,0 +1,31 @@
+Capistrano::Configuration.instance.load do
+
+  #TODO wouldn't it be awesome if the deploy would wait for the crondonkulous rakefile to unlock?
+  set :cron_user, nil
+  
+  before "deploy:update_code", "crondonkulous:clear_crontab"
+  after "deploy:finalize_update", "crondonkulous:load_crontab"
+  
+  namespace :crondonkulous do
+
+    task :load_crontab do
+      require 'erb'
+      tempfile = "#{current_path}/log/crontab.rendered"
+      crontab = ERB.new(File.read("config/crontab.erb")).result(binding)
+      put crontab, "#{tempfile}"
+      u = cron_user || user
+      sudo "crontab -u #{u} #{tempfile}"
+    end
+    
+    task :clear_crontab do
+      begin
+        u = cron_user || user
+        sudo "crontab -r -u #{u}"
+      rescue
+      end
+      sleep 30 #TODO I want to make this safer, but lets give stuff a chance to finish...
+    end
+    
+  end
+
+end

data/rails_generators/crondonkulous_generator.rb

@@ -0,0 +1,9 @@
+class CrondonkulousGenerator < Rails::Generator::Base
+  def manifest
+    record do |m|
+      m.file('crondonkulous.rake', 'lib/tasks/crondonkulous.rake')
+      m.file('crontab.erb', 'config/crontab.erb')
+      m.readme('readme.txt')
+    end
+  end
+end

data/rails_generators/templates/crondonkulous.rake

@@ -0,0 +1,65 @@
+namespace :crondonkulous do
+
+  desc "Your description here"
+  task :every_minute => :environment do
+    crondonkulous_wrapper(RAILS_ROOT + "/log/every_minute.log", 0) do
+      #your code here
+    end
+  end
+  
+  desc "Your description here"
+  task :every_5_minutes => :environment do
+    crondonkulous_wrapper(RAILS_ROOT + "/log/every_5_minutes.log", 0) do
+      #your code here
+    end
+  end
+  
+  desc "Your description here"
+  task :every_15_minutes => :environment do
+    crondonkulous_wrapper(RAILS_ROOT + "/log/every_15_minutes.log", 0) do
+      #your code here
+    end
+  end
+  
+  desc "Your description here"
+  task :every_hour => :environment do
+    crondonkulous_wrapper(RAILS_ROOT + "/log/every_hour.log", 0) do
+      #your code here
+    end
+  end
+  
+  desc "Your description here"
+  task :every_week => :environment do
+    crondonkulous_wrapper(RAILS_ROOT + "/log/every_week.log", 0) do
+      #your code here
+    end
+  end
+  
+  desc "Your description here"
+  task :every_month => :environment do
+    crondonkulous_wrapper(RAILS_ROOT + "/log/every_month.log", 0) do
+      #your code here
+    end
+  end
+
+end
+
+def crondonkulous_wrapper(logfile, retries = 0)
+  ActiveRecord::Base.logger = Logger.new(logfile)
+  ActiveRecord::Base.logger.info "*-"*38
+  ActiveRecord::Base.logger.info "** Invoked at #{Time.now}"
+  
+  begin
+    Lockfile.new(RAILS_ROOT + "/log/crondonkulous.lock", :retries => retries) do      
+      yield
+    end
+  rescue Lockfile::MaxTriesLockError => e      
+    ActiveRecord::Base.logger.info "Another process is running.  Exiting gracefully."
+  rescue
+    ActiveRecord::Base.logger.error $!
+  ensure
+    ActiveRecord::Base.logger.info "** Completed at #{Time.now}"
+    ActiveRecord::Base.logger.close
+  end
+end
+

data/rails_generators/templates/crontab.erb

@@ -0,0 +1,7 @@
+*/1 * * * * rake -f <%= current_path %>/Rakefile RAILS_ENV=<%= rails_env %> crondonkulous:every_minute
+#*/5 * * * * rake -f <%= current_path %>/Rakefile RAILS_ENV=<%= rails_env %> crondonkulous:every_5_minutes
+#*/15 * * * * rake -f <%= current_path %>/Rakefile RAILS_ENV=<%= rails_env %> crondonkulous:every_15_minutes
+01 * * * * rake -f <%= current_path %>/Rakefile RAILS_ENV=<%= rails_env %> crondonkulous:every_hour
+02 0 * * * rake -f <%= current_path %>/Rakefile RAILS_ENV=<%= rails_env %> crondonkulous:every_day
+03 0 * * 1 rake -f <%= current_path %>/Rakefile RAILS_ENV=<%= rails_env %> crondonkulous:every_week
+04 0 1 * * rake -f <%= current_path %>/Rakefile RAILS_ENV=<%= rails_env %> crondonkulous:every_month

data/rails_generators/templates/readme.txt

@@ -0,0 +1,24 @@
+Thanks for installing Crondonkulous!  There are still some things you have to do:
+
+1) open up your config/deploy.rb used by capistrano, and add this line to the top:
+
+  require 'crondonkulous/recipes.rb'
+
+  Our recipes hook into your deploy to load the crontab.
+
+2) Add this line to your config/environment.rb file:
+
+   config.gem "lockfile"
+
+3) uncomment the cron tasks you want to run in the config/crontab.erb file.
+
+4) add your own code to the lib/tasks/crondonkulous.rake file.
+
+5) optionally, you can add this line to your config/deploy.rb:
+  
+   set :cron_user, "username"
+
+   If you don't set this, crondonkulous will default to the deploying user.
+
+Have Fun!
+  - Your friends at CodeSherpas

data/script/console

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+# File: script/console
+irb = RUBY_PLATFORM =~ /(:?mswin|mingw)/ ? 'irb.bat' : 'irb'
+
+libs =  " -r irb/completion"
+# Perhaps use a console_lib to store any extra methods I may want available in the cosole
+# libs << " -r #{File.dirname(__FILE__) + '/../lib/console_lib/console_logger.rb'}"
+libs <<  " -r #{File.dirname(__FILE__) + '/../lib/crondonkulous.rb'}"
+puts "Loading crondonkulous gem"
+exec "#{irb} #{libs} --simple-prompt"

data/script/destroy

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+APP_ROOT = File.expand_path(File.join(File.dirname(__FILE__), '..'))
+
+begin
+  require 'rubigen'
+rescue LoadError
+  require 'rubygems'
+  require 'rubigen'
+end
+require 'rubigen/scripts/destroy'
+
+ARGV.shift if ['--help', '-h'].include?(ARGV[0])
+RubiGen::Base.use_component_sources! [:rubygems, :newgem, :newgem_theme, :test_unit]
+RubiGen::Scripts::Destroy.new.run(ARGV)

data/script/generate

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+APP_ROOT = File.expand_path(File.join(File.dirname(__FILE__), '..'))
+
+begin
+  require 'rubigen'
+rescue LoadError
+  require 'rubygems'
+  require 'rubigen'
+end
+require 'rubigen/scripts/generate'
+
+ARGV.shift if ['--help', '-h'].include?(ARGV[0])
+RubiGen::Base.use_component_sources! [:rubygems, :newgem, :newgem_theme, :test_unit]
+RubiGen::Scripts::Generate.new.run(ARGV)

data/test/test_crondonkulous.rb

@@ -0,0 +1,11 @@
+require File.dirname(__FILE__) + '/test_helper.rb'
+
+class TestCrondonkulous < Test::Unit::TestCase
+
+  def setup
+  end
+  
+  def test_truth
+    assert true
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,3 @@
+require 'stringio'
+require 'test/unit'
+require File.dirname(__FILE__) + '/../lib/crondonkulous'

metadata

@@ -0,0 +1,80 @@
+--- !ruby/object:Gem::Specification 
+name: crondonkulous
+version: !ruby/object:Gem::Version 
+  version: 1.0.0
+platform: ruby
+authors: 
+- David Bock
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-02-11 00:00:00 -05:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: lockfile
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.4.0
+    version: 
+description: A generator and conventions for using cron with rake tasks in a rails application.
+email: dbock@codesherpas.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+files: 
+- History.txt
+- Manifest.txt
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/crondonkulous.rb
+- lib/crondonkulous/recipes.rb
+- rails_generators/crondonkulous_generator.rb
+- rails_generators/templates/crondonkulous.rake
+- rails_generators/templates/crontab.erb
+- rails_generators/templates/readme.txt
+- script/console
+- script/destroy
+- script/generate
+- test/test_crondonkulous.rb
+- test/test_helper.rb
+has_rdoc: true
+homepage: http://github.com/bokmann/crondonkulous
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+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.3.5
+signing_key: 
+specification_version: 3
+summary: A generator and conventions for using cron with rake tasks in a rails application.
+test_files: 
+- test/test_crondonkulous.rb
+- test/test_helper.rb