le1t0-whenever 0.4.2.003 → 0.6.2.001

data/.gitignore

@@ -1,4 +0,0 @@
-.DS_Store
-pkg
-doc
-le1t0-whenever.gemspec

data/README.rdoc

@@ -1,105 +0,0 @@
-== Introduction
-
-Whenever is a Ruby gem that provides a clear syntax for defining cron jobs. It outputs valid cron syntax and can even write your crontab file for you. It is designed to work well with Rails applications and can be deployed with Capistrano. Whenever works fine independently as well.
-
-Ryan Bates created a great Railscast about Whenever: http://railscasts.com/episodes/164-cron-in-ruby
-
-Discussion: http://groups.google.com/group/whenever-gem
-
-== Installation
-  
-$ sudo gem install whenever
-
-== Getting started
-
-  $ cd /my/rails/app
-  $ wheneverize .
-
-This will create an initial "config/schedule.rb" file you.
-
-== Example schedule.rb file
-  
-  every 3.hours do
-    runner "MyModel.some_process"       
-    rake "my:rake:task"                 
-    command "/usr/bin/my_great_command"
-  end
-
-  every 1.day, :at => '4:30 am' do 
-    runner "MyModel.task_to_run_at_four_thirty_in_the_morning"
-  end
-
-  every :hour do # Many shortcuts available: :hour, :day, :month, :year, :reboot
-    runner "SomeModel.ladeeda"
-  end
-
-  every :sunday, :at => '12pm' do # Use any day of the week or :weekend, :weekday 
-    runner "Task.do_something_great"
-  end
-
-More examples on the wiki: http://wiki.github.com/javan/whenever/instructions-and-examples
-
-== Cron output
-
-  $ cd /my/rails/app
-  $ whenever
-
-And you'll see your schedule.rb converted to cron sytax. Note: running `whenever' with no options does not display your current crontab file, it simply shows you the output of converting your schedule.rb file.
-
-== Capistrano integration
-
-In your "config/deploy.rb" file do something like:
-
-  after "deploy:symlink", "deploy:update_crontab"
-
-  namespace :deploy do
-    desc "Update the crontab file"
-    task :update_crontab, :roles => :db do
-      run "cd #{release_path} && whenever --update-crontab #{application}"
-    end
-  end
-
-This will update your crontab file, leaving any existing entries unharmed. When using the <code>--update-crontab</code> option, Whenever will only update the entries in your crontab file related to the current schedule.rb file. You can replace the <code>#{application}</code> with any identifying string you'd like. You can have any number of apps deploy to the same crontab file peacefully given they each use a different identifier.
-
-If you wish to simply overwrite your crontab file each time you deploy, use the <code>--write-crontab</code> option. This is ideal if you are only working with one app and every crontab entry is contained in a single schedule.rb file.
-
-By mixing and matching the <code>--load-file</code> and <code>--user</code> options with your various :roles in Capistrano it is entirely possible to deploy different crontab schedules under different users to all your various servers. Get creative!
-
-If you want to override a variable (like your environment) at the time of deployment you can do so with the <code>--set</code> option: http://wiki.github.com/javan/whenever/setting-variables-on-the-fly
-
-== Credit
-
-Whenever was created for use at Inkling (http://inklingmarkets.com) where I work. Their take on it: http://blog.inklingmarkets.com/2009/02/whenever-easy-way-to-do-cron-jobs-from.html
-
-While building Whenever, I learned a lot by digging through the source code of Capistrano - http://github.com/jamis/capistrano
-
-== Discussion / Feedback / Issues / Bugs
-
-For general discussion and questions, please use the google group: http://groups.google.com/group/whenever-gem
-
-If you've found a genuine bug or issue, please use the Issues section on github: http://github.com/javan/whenever/issues
-
-== License
-
-Copyright (c) 2009+ Javan Makhmali
-
-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/lib/whenever/base.rb

@@ -1,15 +0,0 @@
-module Whenever
-  
-  def self.cron(options)
-    Whenever::JobList.new(options).generate_cron_output
-  end
-  
-  def self.path
-    if defined?(RAILS_ROOT)
-      RAILS_ROOT 
-    elsif defined?(::RAILS_ROOT)
-      ::RAILS_ROOT
-    end
-  end
-
-end

data/lib/whenever/job_types/default.rb

@@ -1,45 +0,0 @@
-module Whenever
-  module Job
-    class Default
-      
-      attr_accessor :task, :at, :output, :output_redirection
-    
-      def initialize(options = {})
-        opts                = options.clone
-        @task               = opts.delete(:task)
-        @at                 = opts.delete(:at)
-        @output_redirection = opts.delete(:output) || :not_set
-        @environment        = opts.delete(:environment) || :production
-        @path               = opts.delete(:path) || Whenever.path
-        @envvars            = envvars(opts)
-      end
-    
-      def output
-        envvars + task
-      end
-      
-      def envvars(opts=nil)
-        return @envvars if opts.nil?
-        env_vars = opts
-        if env_vars.is_a?(Hash)
-          env_vars.keys.select do |key|
-            key.to_sym != :RAILS_ENV && key.to_s =~ /^[A-Z_]+$/
-          end.collect do |key|
-            "#{key}=#{env_vars[key]}"
-          end.join(' ') + ' '
-        elsif env_vars.is_a?(Array)
-          env_vars.join(' ') + ' '
-        else
-          env_vars.to_s + ' '
-        end
-      end
-      
-    protected
-
-      def path_required
-        raise ArgumentError, "No path available; set :path, '/your/path' in your schedule file" if @path.blank?
-      end
-      
-    end
-  end
-end

data/lib/whenever/job_types/rake_task.rb

@@ -1,12 +0,0 @@
-module Whenever
-  module Job
-    class RakeTask < Whenever::Job::Default
-      
-      def output
-        path_required
-        "cd #{@path} && #{envvars}RAILS_ENV=#{@environment} /usr/bin/env rake #{task}"
-      end
-      
-    end
-  end
-end

data/lib/whenever/job_types/runner.rb

@@ -1,12 +0,0 @@
-module Whenever
-  module Job
-    class Runner < Whenever::Job::Default
-
-      def output
-        path_required
-        %Q(cd #{File.join(@path)} && #{envvars}script/runner -e #{@environment} #{task.inspect})
-      end
-      
-    end
-  end
-end

data/lib/whenever/outputs/cron/output_redirection.rb

@@ -1,60 +0,0 @@
-module Whenever
-  module Output
-    class Cron
-      class OutputRedirection
-        
-        def initialize(output)
-          @output = output
-        end
-        
-        def to_s
-          return '' unless defined?(@output)
-          case @output
-            when String   then redirect_from_string
-            when Hash     then redirect_from_hash
-            when NilClass then ">> /dev/null 2>&1"
-            else ''
-          end 
-        end
-        
-      protected
-        
-        def stdout
-          return unless @output.has_key?(:standard)
-          @output[:standard].nil? ? '/dev/null' : @output[:standard]
-        end
-
-        def stderr
-          return unless @output.has_key?(:error)
-          @output[:error].nil? ? '/dev/null' : @output[:error]
-        end
-
-        def redirect_from_hash
-          case
-            when stdout == '/dev/null' && stderr == '/dev/null'
-              "> /dev/null 2>&1"
-            when stdout && stderr == '/dev/null'
-              ">> #{stdout} 2> /dev/null"
-            when stdout && stderr
-              ">> #{stdout} 2>> #{stderr}"
-            when stderr == '/dev/null'
-              "2> /dev/null"
-            when stderr
-              "2>> #{stderr}"
-            when stdout == '/dev/null'
-              "> /dev/null"
-            when stdout
-              ">> #{stdout}"
-            else
-              ''
-          end
-        end
-
-        def redirect_from_string
-          ">> #{@output} 2>&1"
-        end
-        
-      end
-    end
-  end
-end

data/test/command_line_test.rb

@@ -1,101 +0,0 @@
-require File.expand_path(File.dirname(__FILE__) + "/test_helper")
-
-class CommandLineTest < Test::Unit::TestCase
-  
-  context "A command line write" do
-    setup do
-      File.expects(:exists?).with('config/schedule.rb').returns(true)
-      @command = Whenever::CommandLine.new(:write => true, :identifier => 'My identifier')
-      @task = "#{two_hours} /my/command"
-      Whenever.expects(:cron).returns(@task)
-    end
-
-    should "output the cron job with identifier blocks" do
-      output = <<-EXPECTED
-# Begin Whenever generated tasks for: My identifier
-#{@task}
-# End Whenever generated tasks for: My identifier
-EXPECTED
-      
-      assert_equal output, @command.send(:whenever_cron)
-    end
-    
-    should "write the crontab when run" do
-      @command.expects(:write_crontab).returns(true)
-      assert @command.run
-    end
-  end
-  
-  context "A command line update" do
-    setup do
-      File.expects(:exists?).with('config/schedule.rb').returns(true)
-      @command = Whenever::CommandLine.new(:update => true, :identifier => 'My identifier')
-      @task = "#{two_hours} /my/command"
-      Whenever.expects(:cron).returns(@task)
-    end
-
-    should "add the cron to the end of the file if there is no existing identifier block" do
-      existing = '# Existing crontab'
-      @command.expects(:read_crontab).at_least_once.returns(existing)
-      
-      new_cron = <<-EXPECTED
-#{existing}
-
-# Begin Whenever generated tasks for: My identifier
-#{@task}
-# End Whenever generated tasks for: My identifier
-EXPECTED
-      
-      assert_equal new_cron, @command.send(:updated_crontab)
-      
-      @command.expects(:write_crontab).with(new_cron).returns(true)
-      assert @command.run
-    end
-    
-    should "replace an existing block if the identifier matches" do
-      existing = <<-EXISTING_CRON
-# Something
-
-# Begin Whenever generated tasks for: My identifier
-My whenever job that was already here
-# End Whenever generated tasks for: My identifier
-
-# Begin Whenever generated tasks for: Other identifier
-This shouldn't get replaced
-# End Whenever generated tasks for: Other identifier
-EXISTING_CRON
-
-      @command.expects(:read_crontab).at_least_once.returns(existing)
-      
-      new_cron = <<-NEW_CRON
-# Something
-
-# Begin Whenever generated tasks for: My identifier
-#{@task}
-# End Whenever generated tasks for: My identifier
-
-# Begin Whenever generated tasks for: Other identifier
-This shouldn't get replaced
-# End Whenever generated tasks for: Other identifier
-NEW_CRON
-      
-      assert_equal new_cron, @command.send(:updated_crontab)
-      
-      @command.expects(:write_crontab).with(new_cron).returns(true)
-      assert @command.run
-    end
-  end
-  
-  context "A command line update with no identifier" do
-    setup do
-      File.expects(:exists?).with('config/schedule.rb').returns(true)
-      Whenever::CommandLine.any_instance.expects(:default_identifier).returns('DEFAULT')
-      @command = Whenever::CommandLine.new(:update => true, :file => @file)
-    end
-
-    should "use the default identifier" do
-      assert_equal "Whenever generated tasks for: DEFAULT", @command.send(:comment_base)
-    end
-  end
-  
-end

data/test/output_command_test.rb

@@ -1,37 +0,0 @@
-require File.expand_path(File.dirname(__FILE__) + "/test_helper")
-
-class OutputCommandTest < Test::Unit::TestCase
-  
-  context "A plain command" do
-    setup do
-      @output = Whenever.cron \
-      <<-file
-        every 2.hours do
-          command "blahblah"
-        end
-      file
-    end
-    
-    should "output the command" do
-      assert_match /^.+ .+ .+ .+ blahblah$/, @output
-    end
-  end
-  
-  context "An every statement with two commands in it" do
-    setup do
-      @output = Whenever.cron \
-      <<-file
-        every 1.hour do
-          command "first"
-          command "second"
-        end
-      file
-    end
-
-    should "output both commands" do
-      assert_match "0 * * * * first", @output
-      assert_match "0 * * * * second", @output
-    end
-  end
-    
-end

data/test/output_env_test.rb

@@ -1,56 +0,0 @@
-require File.expand_path(File.dirname(__FILE__) + "/test_helper")
-
-class OutputEnvTest < Test::Unit::TestCase
-
-  context "The output from Whenever with environment variables set" do
-    setup do
-      @output = Whenever.cron \
-      <<-file
-        env :MYVAR, 'blah'
-        env 'MAILTO', "someone@example.com"
-      file
-    end
-
-    should "output MYVAR environment variable" do
-      assert_match "MYVAR=blah", @output
-    end
-  
-    should "output MAILTO environment variable" do
-      assert_match "MAILTO=someone@example.com", @output
-    end
-  end
-  
-  context "No PATH environment variable set" do
-    setup do
-      Whenever::JobList.any_instance.expects(:read_path).at_least_once.returns('/usr/local/bin')
-      @output = Whenever.cron ""
-    end
-    
-    should "add a PATH variable based on the user's PATH" do
-      assert_match "PATH=/usr/local/bin", @output
-    end
-  end
-  
-  context "A PATH environment variable set" do
-    setup do
-      Whenever::JobList.stubs(:read_path).returns('/usr/local/bin')
-      @output = Whenever.cron "env :PATH, '/my/path'"
-    end
-    
-    should "use that path and the user's PATH" do
-      assert_match "PATH=/my/path", @output
-      assert_no_match /local/, @output
-    end
-  end
-  
-  context "No PATH set and instructed not to automatically load the user's path" do
-    setup do
-      @output = Whenever.cron "set :set_path_automatically, false"
-    end
-    
-    should "not have a PATH set" do
-      assert_no_match /PATH/, @output
-    end
-  end
-
-end