markbates-delayed_job_extras 0.1.1.20090805150516

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License
+
+Copyright (c) 2009 markbates
+
+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/README

@@ -0,0 +1 @@
+Adds support for Hoptoad and is_paranoid to Delayed::Job. Additionally it also adds 'stats' for your workers, and it even includes a base worker that encapsulates a some common functionality.

data/generators/dj_extras_generator.rb

@@ -0,0 +1,10 @@
+class DjExtrasGenerator < Rails::Generator::Base
+  
+  def manifest
+    record do |m|
+      m.migration_template "migration.rb", 'db/migrate',
+                           :migration_file_name => "add_delayed_job_extras"
+    end
+  end
+  
+end

data/generators/templates/migration.rb

@@ -0,0 +1,11 @@
+class AddDelayedJobExtras < ActiveRecord::Migration
+  def self.up
+    add_column :delayed_jobs, :deleted_at, :datetime
+    add_column :delayed_jobs, :worker_class_name, :string
+  end
+
+  def self.down
+    remove_column :delayed_jobs, :worker_class_name
+    remove_column :delayed_jobs, :deleted_at
+  end
+end

data/lib/delayed_job_extras.rb

@@ -0,0 +1,19 @@
+begin
+  # If the hoptoad_notifier gem is available
+  # let's use it so we can get some good notifications
+  # when an exception is raised.
+  require 'hoptoad_notifier'
+rescue Exception => e
+end
+
+begin
+  # If the is_paranoid gem is available
+  # let's use it so we can have a record of the
+  # tasks that have been performed.
+  require 'is_paranoid'
+rescue Exception => e
+end
+
+Dir.glob(File.join(File.dirname(__FILE__), 'delayed_job_extras', '**/*.rb')).each do |f|
+  require File.expand_path(f)
+end

data/lib/delayed_job_extras/job.rb

@@ -0,0 +1,46 @@
+module Delayed
+  class Job
+    
+    if (self.respond_to?(:is_paranoid))
+      is_paranoid
+    else
+      alias_method :count_with_destroyed, :count
+      alias_method :find_with_destroyed, :find
+    end
+    
+    def payload_object=(object)
+      self.worker_class_name = object.worker_class_name if object.respond_to?(:worker_class_name)
+      self['handler'] = object.to_yaml
+    end
+    
+    class << self
+      
+      def stats(start_date = 1.day.ago.beginning_of_day, end_date = Time.now.beginning_of_day)
+        workers = {}
+        Delayed::Job.find_with_destroyed(:all, :select => :worker_class_name, :group => :worker_class_name).each do |dj|
+          dj.worker_class_name = 'UNKNOWN' if dj.worker_class_name.blank?
+          workers[dj.worker_class_name] = {} 
+        end
+        workers.each do |worker, stats|
+          wname = (worker == 'UNKNOWN' ? nil : worker)
+          stats[:total] = Delayed::Job.count_with_destroyed(:conditions => {:worker_class_name => wname})
+          stats[:remaining] = Delayed::Job.count(:conditions => {:worker_class_name => wname})
+          stats[:processed] = stats[:total] - stats[:remaining]
+          stats[:failures] = Delayed::Job.count(:conditions => ['worker_class_name = ? and attempts > 1', wname])
+          if start_date
+            date_stats = {:start_date => start_date, :end_date => end_date}
+            date_stats[:total] = Delayed::Job.count_with_destroyed(:conditions => ['worker_class_name = ? and (created_at > ? and created_at < ?)', wname, start_date, end_date])
+            date_stats[:remaining] = Delayed::Job.count(:conditions => ['worker_class_name = ? and (created_at > ? and created_at < ?)', wname, start_date, end_date])
+            date_stats[:processed] = stats[:total] - stats[:remaining]
+            date_stats[:failures] = Delayed::Job.count(:conditions => ['worker_class_name = ? and attempts > 1 and (created_at > ? and created_at < ?)', wname, start_date, end_date])
+            stats[:date_range] = date_stats
+          end
+          workers[worker] = stats
+        end
+        workers
+      end
+      
+    end
+    
+  end # Job
+end # Delayed

data/lib/delayed_job_extras/performable_method.rb

@@ -0,0 +1,29 @@
+module Delayed
+  class PerformableMethod
+    
+    attr_accessor :worker_class_name
+    
+    def initialize_with_worker_class_name(object, method, args)
+      self.worker_class_name = "#{object.class}__#{method}".underscore
+      initialize_without_worker_class_name(object, method, args)
+    end
+    
+    alias_method_chain :initialize, :worker_class_name
+    
+    if Object.const_defined?(:HoptoadNotifier)
+      include HoptoadNotifier::Catcher
+      
+      def perform_with_hoptoad
+        begin
+          perform_without_hoptoad
+        rescue Exception => e
+          notify_hoptoad(e)
+          raise e
+        end
+      end
+    
+      alias_method_chain :perform, :hoptoad
+    end
+    
+  end # PerformableMethod
+end # Delayed

data/lib/delayed_job_extras/worker.rb

@@ -0,0 +1,46 @@
+module Delayed
+  class Worker
+    
+    if Object.const_defined?(:HoptoadNotifier)
+      include HoptoadNotifier::Catcher
+    else
+      def notify_hoptoad(e)
+      end
+    end
+    
+    def worker_class_name
+      self.class.to_s.underscore
+    end
+    
+    def logger
+      RAILS_DEFAULT_LOGGER
+    end
+
+    class << self
+      
+      # VideoWorker.encode(1) # => Delayed::Job.enqueue(VideoWorker.new(:encode, 1))
+      def method_missing(sym, *args)
+        self.enqueue(sym, *args)
+      end
+      
+      # VideoWorker.enqueue(1) # => Delayed::Job.enqueue(VideoWorker.new(1))
+      def enqueue(*args)
+        Delayed::Job.enqueue(self.new(*args))
+      end
+      
+      def perform(&block)
+        define_method(:perform) do
+          begin
+            self.instance_eval(&block)
+          rescue Exception => e
+            # send to hoptoad!
+            notify_hoptoad(e)
+            raise e
+          end
+        end
+      end
+
+    end
+    
+  end # Worker
+end # Delayed

data/lib/delayed_job_test_enhancements.rb

@@ -0,0 +1,7 @@
+module Delayed
+  class Job
+    def self.enqueue(obj, *args)
+      obj.perform
+    end
+  end
+end

metadata

@@ -0,0 +1,63 @@
+--- !ruby/object:Gem::Specification 
+name: markbates-delayed_job_extras
+version: !ruby/object:Gem::Version 
+  version: 0.1.1.20090805150516
+platform: ruby
+authors: 
+- markbates
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-08-05 00:00:00 -07:00
+default_executable: 
+dependencies: []
+
+description: Adds support for Hoptoad and is_paranoid to Delayed::Job. Additionally it also adds 'stats' for your workers, and it even includes a base worker that encapsulates a some common functionality.
+email: ""
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README
+- LICENSE
+files: 
+- lib/delayed_job_extras/job.rb
+- lib/delayed_job_extras/performable_method.rb
+- lib/delayed_job_extras/worker.rb
+- lib/delayed_job_extras.rb
+- lib/delayed_job_test_enhancements.rb
+- README
+- LICENSE
+- generators/dj_extras_generator.rb
+- generators/templates/migration.rb
+has_rdoc: false
+homepage: ""
+licenses: 
+post_install_message: 
+rdoc_options: []
+
+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: magrathea
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: delayed_job_extras
+test_files: []
+