cronjobber 1.0.1

data/init.rb

@@ -0,0 +1 @@
+require 'cronjob'

data/lib/cronjobber.rb

@@ -0,0 +1,21 @@
+require "cronjobber"
+require "cronjobber/tasks_helper"
+
+module Cronjobber
+  
+  mattr_accessor :tasks
+  @@tasks = []
+  
+  def self.setup
+    yield self
+  end
+  
+  class Engine < Rails::Engine#:nodoc:
+    config.cronjobber = Cronjobber
+    
+    initializer "cronjobber.initialize" do |app|
+      app.config.cronjobber = Cronjobber
+      ActionController::Base.send :include, Cronjobber::TasksHelper
+    end
+  end
+end

data/lib/cronjobber/tasks_helper.rb

@@ -0,0 +1,20 @@
+module Cronjobber
+  module TasksHelper
+    
+    def execute_cronjob_tasks tasks=nil
+      tasks = Array(tasks) + Cronjobber.tasks
+      tasks.map! do |task|
+        if task.is_a? String
+          task = task.camelize.constantize
+        else
+          task
+        end
+      end      
+      tasks.map! do |task|
+        task.cronjob_perform
+      end
+      return tasks, tasks.map(&:format)
+    end
+    
+  end
+end

data/spec/cronjobber_spec.rb

@@ -0,0 +1,256 @@
+require "spec_helper"
+
+describe Cronjobber::Task do
+
+  after :each do
+    Cronjobber::Task.destroy_all
+  end
+  
+  describe "initialization" do
+    before :each do
+      class DefaultJob < Cronjobber::Task
+        run_task
+      end
+      
+      class CustomizedJob < Cronjobber::Task
+        run_task :every => 10.minutes, :in_background => true, :method => :custom_run_method, :at => ["12:34", "56:78"]
+      end
+      
+      module ModulizedJob
+        class CustomizedJob < Cronjobber::Task
+          run_task :every => 10.minutes, :in_background => true, :method => :custom_run_method, :at => ["12:34", "56:78"]
+        end
+      end
+    end
+
+    it "should fill default values" do
+      DefaultJob.cronjob_frequency.should == 0.minutes
+      DefaultJob.cronjob_delayed.should be false
+      DefaultJob.cronjob_method.should == 'run'
+      DefaultJob.cronjob_timesteps.should == []
+    end
+  
+    it "should change frequency" do
+      CustomizedJob.cronjob_frequency.should == 10.minutes    
+    end
+    
+    it "should change delay option" do
+      CustomizedJob.cronjob_delayed.should be true
+    end
+    
+    it "should change run method" do
+      CustomizedJob.cronjob_method.should == "custom_run_method"
+    end
+    
+    it "should initialize with timesteps" do
+      CustomizedJob.cronjob_timesteps.should == ["12:34", "56:78"]
+    end
+    
+    it "should generate cronjob name" do
+      DefaultJob.cronjob_name.should == "default_job"
+      ModulizedJob::CustomizedJob.cronjob_name.should == "modulized_job/customized_job"
+    end
+  end
+
+  describe "instance" do
+    before :each do 
+      class TestJob < Cronjobber::Task
+        run_task
+      end
+      
+      class FailJob < Cronjobber::Task
+        run_task
+        
+        def run
+          raise "job failed with exception message"
+        end
+      end
+      
+      class BackgroundJob < Cronjobber::Task
+        run_task :in_background => true
+        def self.cronjob_enqueue
+          # mock with empty method for testing
+        end
+      end
+      
+      @job = TestJob.create!({ :run_at => Time.now - 1.day, :name => TestJob.cronjob_name })
+      FailJob.create!({ :run_at => Time.now - 1.day, :name => FailJob.cronjob_name })
+      BackgroundJob.create!({ :run_at => Time.now - 1.day, :name => BackgroundJob.cronjob_name })
+    end
+
+    after :each do
+      Cronjobber::Task.destroy_all
+    end
+    
+    it "should lock" do
+      @job.locked?.should be false
+      @job.lock!.should be true
+      @job.locked?.should be true
+    end
+    
+    it "should lock only once" do
+      @job.lock!.should be true
+      @job.lock!.should be false
+    end
+    
+    it "should unlock" do
+      @job.lock!.should be true
+      @job.unlock!.should be true
+      @job.locked?.should be false
+    end
+
+    it "should be locked for invalid key" do
+      @job.lock!.should be true
+      @job.locked?("123456").should be true
+    end
+        
+    it "should not be locked for valid key" do
+      @job.lock!.should be true
+      @job.locked?(@job.locking_key).should be false
+    end
+    
+    it "should perform the job" do
+      job = TestJob.cronjob_perform
+      job.id.should be @job.id
+      
+      job.locked?.should be false
+      job.last_error.should be_nil
+      job.duration.should_not be_nil
+      job.status.should == "performed"
+    end
+    
+    it "should not perform the job when exception occurs" do
+      job = FailJob.cronjob_perform
+      job.locked?.should be false
+      job.status.should == "exception"
+      job.last_error.starts_with?("job failed with exception message").should be true
+    end
+    
+    it "should enqueue the job in background" do
+      job = BackgroundJob.cronjob_perform
+      job.locked?.should be true
+      job.status.should == "enqueued"
+      job.last_error.should be_nil
+    end
+    
+    it "should perform background job with valid key" do
+      job = BackgroundJob.cronjob_perform
+      job.locked?.should be true
+      BackgroundJob.cronjob_perform_delayed(job.locking_key)
+      job.locked?.should be false
+      job.status.should == "performed"
+      job.last_error.should be_nil
+    end
+    
+    it "should not perform background job with invalidvalid key" do
+      job = BackgroundJob.cronjob_perform
+      job.locked?.should be true
+      BackgroundJob.cronjob_perform_delayed("some invalid key")
+      job.locked?.should be true
+      job.status.should == "locked"
+    end
+  end
+
+  describe "without frequency and without time" do
+    before :each do
+      class TestJob < Cronjobber::Task
+        run_task :every => 0.minutes, :at => []
+      end
+      @test_job = TestJob.new({ :run_at => Time.parse("2011-1-1 12:00") })
+      @test_job.save!
+    end
+    
+    it "should be runable before run_at time" do
+      @test_job.should_run?(Time.parse("2011-1-1 11:00")).should be true
+    end
+    
+    it "should be runable on run_at time" do
+      @test_job.should_run?(Time.parse("2011-1-1 12:00")).should be true
+    end
+    
+    it "should be runable after run_at time" do
+      @test_job.should_run?(Time.parse("2011-1-1 13:00")).should be true
+    end
+  end
+  
+  describe "with frequency and without time" do
+    before :each do
+      class TestJob < Cronjobber::Task
+        run_task :every => 10.minutes, :at => []
+      end
+      @test_job = TestJob.new({ :run_at => Time.parse("2011-1-1 12:00") })
+      @test_job.save!
+    end
+    
+    it "should not be runable before run_at time" do
+      @test_job.should_run?(Time.parse("2011-1-1 11:00")).should be false
+    end
+    
+    it "should not be runable on run_at time" do
+      @test_job.should_run?(Time.parse("2011-1-1 12:00")).should be false
+    end
+    
+    it "should not be runable after run_at time before frequency elapses" do
+      @test_job.should_run?(Time.parse("2011-1-1 12:09")).should be false
+    end
+    
+    it "should be runable after run_at time after frequency elapsed" do
+      @test_job.should_run?(Time.parse("2011-1-1 12:10")).should be true
+    end
+  end
+  
+  describe "without frequency and with time" do
+    before :each do
+      class TestJob < Cronjobber::Task
+        run_task :every => 0.minutes, :at => ["12:00"]
+      end
+      @test_job = TestJob.new({ :run_at => Time.parse("2011-1-1 12:00") })
+      @test_job.save!
+    end
+    
+    it "should not be runable before run_at time" do
+      @test_job.should_run?(Time.parse("2010-1-1 11:00")).should be false
+      @test_job.should_run?(Time.parse("2011-1-1 11:00")).should be false
+      @test_job.should_run?(Time.parse("2011-1-1 11:59")).should be false
+    end
+    
+    it "should not be runable on run_at time" do
+      @test_job.should_run?(Time.parse("2011-1-1 12:00")).should be false
+    end
+    
+    it "should be runable after run_at time" do
+      @test_job.should_run?(Time.parse("2011-1-1 12:01")).should be true
+      @test_job.should_run?(Time.parse("2011-1-1 13:00")).should be true
+      @test_job.should_run?(Time.parse("2012-1-1 12:01")).should be true
+    end
+  end
+  
+  describe "with frequency and with time" do
+    before :each do
+      class TestJob < Cronjobber::Task
+        run_task :every => 30.minutes, :at => ["12:00"]
+      end
+      @test_job = TestJob.new({ :run_at => Time.parse("2011-1-1 12:00") })
+      @test_job.save!
+    end
+    
+    it "should not be runable before run_at time" do
+      @test_job.should_run?(Time.parse("2010-1-1 11:00")).should be false
+      @test_job.should_run?(Time.parse("2011-1-1 11:00")).should be false
+      @test_job.should_run?(Time.parse("2011-1-1 11:59")).should be false
+    end
+    
+    it "should not be runable after run_at within frequency time" do
+      @test_job.should_run?(Time.parse("2011-1-1 12:00")).should be false
+      @test_job.should_run?(Time.parse("2011-1-1 12:01")).should be false
+      @test_job.should_run?(Time.parse("2011-1-1 12:29")).should be false
+    end
+    
+    it "should be runable after run_at time after frequency time" do
+      @test_job.should_run?(Time.parse("2011-1-1 12:30")).should be true
+      @test_job.should_run?(Time.parse("2011-1-1 13:31")).should be true
+      @test_job.should_run?(Time.parse("2012-1-1 12:00")).should be true
+    end
+  end
+  
+end

data/spec/dummy/Rakefile

@@ -0,0 +1,7 @@
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require File.expand_path('../config/application', __FILE__)
+require 'rake'
+
+Dummy::Application.load_tasks

data/spec/dummy/app/controllers/application_controller.rb

@@ -0,0 +1,3 @@
+class ApplicationController < ActionController::Base
+  protect_from_forgery
+end

data/spec/dummy/app/helpers/application_helper.rb

@@ -0,0 +1,2 @@
+module ApplicationHelper
+end

data/spec/dummy/app/views/layouts/application.html.erb

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Dummy</title>
+  <%= stylesheet_link_tag :all %>
+  <%= javascript_include_tag :defaults %>
+  <%= csrf_meta_tag %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/spec/dummy/config.ru

@@ -0,0 +1,4 @@
+# This file is used by Rack-based servers to start the application.
+
+require ::File.expand_path('../config/environment',  __FILE__)
+run Dummy::Application

data/spec/dummy/config/application.rb

@@ -0,0 +1,45 @@
+require File.expand_path('../boot', __FILE__)
+
+require "active_model/railtie"
+require "active_record/railtie"
+require "action_controller/railtie"
+require "action_view/railtie"
+require "action_mailer/railtie"
+
+Bundler.require
+require "cronjobber"
+
+module Dummy
+  class Application < Rails::Application
+    # Settings in config/environments/* take precedence over those specified here.
+    # Application configuration should go into files in config/initializers
+    # -- all .rb files in that directory are automatically loaded.
+
+    # Custom directories with classes and modules you want to be autoloadable.
+    # config.autoload_paths += %W(#{config.root}/extras)
+
+    # Only load the plugins named here, in the order given (default is alphabetical).
+    # :all can be used as a placeholder for all plugins not explicitly named.
+    # config.plugins = [ :exception_notification, :ssl_requirement, :all ]
+
+    # Activate observers that should always be running.
+    # config.active_record.observers = :cacher, :garbage_collector, :forum_observer
+
+    # Set Time.zone default to the specified zone and make Active Record auto-convert to this zone.
+    # Run "rake -D time" for a list of tasks for finding time zone names. Default is UTC.
+    # config.time_zone = 'Central Time (US & Canada)'
+
+    # The default locale is :en and all translations from config/locales/*.rb,yml are auto loaded.
+    # config.i18n.load_path += Dir[Rails.root.join('my', 'locales', '*.{rb,yml}').to_s]
+    # config.i18n.default_locale = :de
+
+    # JavaScript files you want as :defaults (application.js is always included).
+    # config.action_view.javascript_expansions[:defaults] = %w(jquery rails)
+
+    # Configure the default encoding used in templates for Ruby 1.9.
+    config.encoding = "utf-8"
+
+    # Configure sensitive parameters which will be filtered from the log file.
+    config.filter_parameters += [:password]
+  end
+end

data/spec/dummy/config/boot.rb

@@ -0,0 +1,10 @@
+require 'rubygems'
+gemfile = File.expand_path('../../../../Gemfile', __FILE__)
+
+if File.exist?(gemfile)
+  ENV['BUNDLE_GEMFILE'] = gemfile
+  require 'bundler'
+  Bundler.setup
+end
+
+$:.unshift File.expand_path('../../../../lib', __FILE__)

data/spec/dummy/config/database.yml

@@ -0,0 +1,22 @@
+# SQLite version 3.x
+#   gem install sqlite3-ruby (not necessary on OS X Leopard)
+development:
+  adapter: sqlite3
+  database: db/development.sqlite3
+  pool: 5
+  timeout: 5000
+
+# Warning: The database defined as "test" will be erased and
+# re-generated from your development database when you run "rake".
+# Do not set this db to the same as development or production.
+test:
+  adapter: sqlite3
+  database: db/test.sqlite3
+  pool: 5
+  timeout: 5000
+
+production:
+  adapter: sqlite3
+  database: db/production.sqlite3
+  pool: 5
+  timeout: 5000

data/spec/dummy/config/environment.rb

@@ -0,0 +1,5 @@
+# Load the rails application
+require File.expand_path('../application', __FILE__)
+
+# Initialize the rails application
+Dummy::Application.initialize!

data/spec/dummy/config/environments/development.rb

@@ -0,0 +1,26 @@
+Dummy::Application.configure do
+  # Settings specified here will take precedence over those in config/application.rb
+
+  # In the development environment your application's code is reloaded on
+  # every request.  This slows down response time but is perfect for development
+  # since you don't have to restart the webserver when you make code changes.
+  config.cache_classes = false
+
+  # Log error messages when you accidentally call methods on nil.
+  config.whiny_nils = true
+
+  # Show full error reports and disable caching
+  config.consider_all_requests_local       = true
+  config.action_view.debug_rjs             = true
+  config.action_controller.perform_caching = false
+
+  # Don't care if the mailer can't send
+  config.action_mailer.raise_delivery_errors = false
+
+  # Print deprecation notices to the Rails logger
+  config.active_support.deprecation = :log
+
+  # Only use best-standards-support built into browsers
+  config.action_dispatch.best_standards_support = :builtin
+end
+