dj_remixes 0.0.10 → 0.0.17

data/lib/dj_remixes/attributes.rb

@@ -0,0 +1,27 @@
+module DJ
+  class Worker
+    
+    attr_accessor :id
+    attr_accessor :attributes
+    
+    def initialize(attributes = {})
+      self.attributes = attributes
+      self.attributes = self.attributes.stringify_keys
+      self.id = self.attributes['id']
+    end
+    
+    def method_missing(sym, *args, &block)
+      attribute = sym.to_s
+      case attribute
+      when /(.+)\=$/
+        self.attributes[$1] = args.first
+      when /(.+)\?$/
+        # self.attributes.has_key?($1.to_sym)
+        return self.attributes[$1]
+      else
+        return self.attributes[attribute]
+      end
+    end
+    
+  end # Worker
+end # DJ

data/lib/dj_remixes/callbacks.rb

@@ -0,0 +1,22 @@
+module DJ
+  class Worker
+    
+    def before(job)
+      self.dj_object = job
+      job.touch(:started_at)
+    end
+    
+    def after(job)
+    end
+    
+    def success(job)
+      job.touch(:finished_at)
+      self.enqueue_again
+    end
+    
+    def failure(job, error)
+      job.update_attributes(:started_at => nil)
+    end
+    
+  end # Worker
+end # DJ

data/lib/dj_remixes/dj_remixes.rb

@@ -2,10 +2,27 @@ module DJ
   
   class << self
     
+    # Pass off calls to the backend:
     def method_missing(sym, *args, &block)
       Delayed::Worker.backend.send(sym, *args, &block)
     end
     
   end
   
+end
+
+Delayed::Worker.backend.send(:class_eval) do
+  def invoke_job_with_callbacks
+    payload_object.before(self) if payload_object.respond_to?(:before)
+    begin
+      invoke_job_without_callbacks
+      payload_object.success(self) if payload_object.respond_to?(:success)
+    rescue Exception => e
+      payload_object.failure(self, e) if payload_object.respond_to?(:failure)
+      raise e
+    ensure
+      payload_object.after(self) if payload_object.respond_to?(:after)
+    end
+  end
+  alias_method_chain :invoke_job, :callbacks
 end

data/lib/dj_remixes/hoptoad.rb

@@ -1,12 +1,15 @@
-module DJ
-  class Worker
+if Object.const_defined?(:HoptoadNotifier)
+  module DJ
+    class Worker
     
-    def failure_with_hoptoad(job, error)
-      HoptoadNotifier.notify_or_ignore(error, :cgi_data => self.attributes)
-      failure_without_hoptoad(job, error)
-    end
+      # Report Errors to Hoptoad:
+      def failure_with_hoptoad(job, error)
+        HoptoadNotifier.notify_or_ignore(error, :cgi_data => self.attributes)
+        failure_without_hoptoad(job, error)
+      end
     
-    alias_method_chain :failure, :hoptoad
+      alias_method_chain :failure, :hoptoad
     
-  end
-end
+    end # Worker
+  end # DJ
+end # defined?

data/lib/dj_remixes/priority.rb

@@ -0,0 +1,34 @@
+module DJ
+  class Worker
+    
+    # A helpful list of symbols to priority levels
+    PRIORITY_LEVELS = {:urgent => -100000, :immediate => -10000, :high => -1000, :medium => -500, :normal => 0, :low => 100, :who_cares => 1000}
+    
+    attr_accessor :priority
+    
+    class << self
+      
+      def priority(level = 0)
+        define_method('priority') do
+          if level.is_a?(Symbol)
+            level = DJ::Worker::PRIORITY_LEVELS[level] ||= 0
+          end
+          return @priority ||= level
+        end
+      end
+      
+    end
+    
+    def priority
+      case @priority
+      when Symbol
+        DJ::Worker::PRIORITY_LEVELS[@priority] ||= 0
+      when Fixnum
+        @priority
+      else
+        0
+      end
+    end
+    
+  end
+end

data/lib/dj_remixes/rails3/action_mailer.rb

@@ -2,7 +2,8 @@ module Mail
   class Message
     
     class MailmanWorker < DJ::Worker
-      priority :immediate
+      priority :urgent
+      run_at {1.year.ago}
       
       def perform
         message = Marshal.load(self.mail)

data/lib/dj_remixes/re_enqueue.rb

@@ -0,0 +1,44 @@
+module DJ
+  class Worker
+    
+    class << self
+      
+      # Class level accessor to let DJ know whether it
+      # should be enqueued again after it has successfully
+      # completed.
+      attr_accessor :re_enqueuable
+      
+      # A convience method to tell DJ to re-enqueue this worker
+      # after it has successfully completely. NOTE: This will actually
+      # create a new DJ object in the database, not reuse the same one.
+      # 
+      # Example:
+      #   # Run every 30 days and charge a credit card.
+      #   class SubscriptionWorker < DJ::Worker
+      #     re_enqueue
+      #
+      #     def run_at
+      #       30.days.from_now
+      #     end
+      # 
+      #     def perform
+      #       # charge the credit card...
+      #     end
+      #   end
+      def re_enqueue
+        self.re_enqueuable = true
+      end
+      
+    end
+    
+    protected
+    # clone and re-enqueue the worker.
+    def enqueue_again # :nodoc:
+      if self.class.re_enqueuable
+        new_worker = self.clone()
+        new_worker.enqueue
+      end
+    end
+    
+  end # Worker
+end # DJ

data/lib/dj_remixes/run_at.rb

@@ -0,0 +1,19 @@
+module DJ
+  class Worker
+    
+    attr_accessor :run_at
+    
+    class << self
+      
+      def run_at(&block)
+        define_method('run_at', &block)
+      end
+      
+    end
+    
+    def run_at
+      return @run_at ||= Time.now
+    end
+    
+  end # Worker
+end # DJ

data/lib/dj_remixes/unique.rb

@@ -0,0 +1,36 @@
+module DJ
+  class Worker
+    
+    class << self
+      
+      # Tell DJ to only allow one of this worker at a given time.
+      # 
+      # Example:
+      #   # We only want to charge the card once!
+      #   class PurchaseWorker < DJ::Worker
+      #     is_unique
+      # 
+      #     def perform
+      #       # charge the credit card...
+      #     end
+      #   end
+      def is_unique
+        define_method('unique?') do
+          return true
+        end
+      end
+      
+    end
+    
+    # Returns true or false based on whether this should be the only
+    # worker that should be allowed in the system at any one time.
+    # If set to true, using the is_unique class method, then when a 
+    # new job is enqueued it will be validated against the worker_class_name
+    # field in the database. If there is already a job with the same
+    # worker_class_name then the enqueing of the new job will fail.
+    def unique?
+      false
+    end
+    
+  end # Worker
+end # DJ

data/lib/dj_remixes/worker.rb

@@ -1,78 +1,17 @@
 module DJ
   class Worker
     
-    PRIORITY_LEVELS = {:immediate => 10000, :high => 1000, :medium => 500, :normal => 0, :low => -100, :who_cares => -1000}
-    
     attr_accessor :run_at
-    attr_accessor :priority
     attr_accessor :worker_class_name
-    attr_accessor :re_enqueuable
-    attr_accessor :id
-    attr_accessor :attributes
-    attr_accessor :dj_object
     
     class << self
       
-      def priority(level = 0)
-        define_method('priority') do
-          if level.is_a?(Symbol)
-            level = DJ::Worker::PRIORITY_LEVELS[level] ||= 0
-          end
-          return @priority ||= level
-        end
-      end
-      
-      def is_unique
-        define_method('unique?') do
-          return true
-        end
-      end
-      
       def enqueue(*args)
         self.new(*args).enqueue
       end
       
-      def re_enqueue(&block)
-        define_method('re_enqueuable') do
-          true
-        end
-        define_method('__re_enqueue_block') do
-          block
-        end
-      end
-      
-    end
-    
-    def initialize(attributes = {})
-      self.attributes = attributes
-      self.attributes = self.attributes.stringify_keys
-      self.id = self.attributes['id']
     end
     
-    def method_missing(sym, *args, &block)
-      attribute = sym.to_s
-      case attribute
-      when /(.+)\=$/
-        self.attributes[$1] = args.first
-      when /(.+)\?$/
-        # self.attributes.has_key?($1.to_sym)
-        return self.attributes[$1]
-      else
-        return self.attributes[attribute]
-      end
-    end
-    
-    def priority
-      case @priority
-      when Symbol
-        DJ::Worker::PRIORITY_LEVELS[@priority] ||= 0
-      when Fixnum
-        @priority
-      else
-        0
-      end
-    end
-
     def run_at
       return @run_at ||= Time.now
     end
@@ -102,46 +41,17 @@ module DJ
     
     alias_method :save, :enqueue
     
-    def unique?
-      false
+    # Needs to be implemented by subclasses! It's only here
+    # so people can hook into it.
+    def perform
+      raise NoMethodError.new('perform')
     end
     
-    def clone
+    def clone # :nodoc:
       cl = super
       cl.run_at = nil
       cl
     end
     
-    def before(job)
-      self.dj_object = job
-      job.touch(:started_at)
-    end
-    
-    def perform
-      raise NoMethodError.new('perform')
-    end
-    
-    def after(job)
-    end
-    
-    def success(job)
-      job.touch(:finished_at)
-      enqueue_again
-    end
-    
-    def failure(job, error)
-      job.update_attributes(:started_at => nil)
-    end
-    
-    def enqueue_again
-      if self.re_enqueuable
-        new_worker = self.clone()
-        if self.__re_enqueue_block
-          self.__re_enqueue_block.call(self, new_worker)
-        end
-        new_worker.enqueue
-      end
-    end
-    
-  end
-end
+  end # Worker
+end # DJ

data/lib/dj_remixes.rb

@@ -1,7 +1,7 @@
 # Dir.glob(File.join(File.dirname(__FILE__), 'dj_remixes', '**/*.rb')).each do |f|
 #   require File.expand_path(f)
 # end
-require 'delayed_job'
+# require 'delayed_job'
 
 Delayed::Worker.guess_backend
 
@@ -9,11 +9,17 @@ path = File.join(File.dirname(__FILE__), 'dj_remixes')
 
 require File.join(path, 'dj_remixes')
 require File.join(path, 'worker')
+require File.join(path, 'attributes')
+require File.join(path, 'callbacks')
+require File.join(path, 'priority')
+require File.join(path, 'run_at')
+require File.join(path, 'unique')
+require File.join(path, 're_enqueue')
 require File.join(path, 'hoptoad')
 
 if Rails.version.match(/^2/)
-  require File.join(path, 'rails2', 'action_mailer')
-  require File.join(path, 'rails2', 'unique_validator')
+  # require File.join(path, 'rails2', 'action_mailer')
+  # require File.join(path, 'rails2', 'unique_validator')
 else
   require File.join(path, 'rails3', 'railtie')
   require File.join(path, 'rails3', 'unique_validator')

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 0
-  - 10
-  version: 0.0.10
+  - 17
+  version: 0.0.17
 platform: ruby
 authors: 
 - markbates
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-06-14 00:00:00 -04:00
+date: 2010-07-06 00:00:00 -04:00
 default_executable: 
 dependencies: []
 
@@ -28,13 +28,17 @@ extra_rdoc_files:
 - README
 - LICENSE
 files: 
+- lib/dj_remixes/attributes.rb
+- lib/dj_remixes/callbacks.rb
 - lib/dj_remixes/dj_remixes.rb
 - lib/dj_remixes/hoptoad.rb
-- lib/dj_remixes/rails2/action_mailer.rb
-- lib/dj_remixes/rails2/unique_validator.rb
+- lib/dj_remixes/priority.rb
 - lib/dj_remixes/rails3/action_mailer.rb
 - lib/dj_remixes/rails3/railtie.rb
 - lib/dj_remixes/rails3/unique_validator.rb
+- lib/dj_remixes/re_enqueue.rb
+- lib/dj_remixes/run_at.rb
+- lib/dj_remixes/unique.rb
 - lib/dj_remixes/worker.rb
 - lib/dj_remixes.rb
 - README
@@ -49,6 +53,7 @@ rdoc_options: []
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
@@ -56,6 +61,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       - 0
       version: "0"
 required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
@@ -65,7 +71,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.6
+rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
 summary: dj_remixes

data/lib/dj_remixes/rails2/action_mailer.rb

@@ -1,62 +0,0 @@
-if defined?(ActionMailer)
-  module ActionMailer
-    class Base
-        
-      class << self
-        
-        def inherited(klass)
-          super
-          eval %{
-            class ::#{klass}Worker < DJ::Worker
-              
-              priority :immediate
-
-              attr_accessor :called_method
-              attr_accessor :args
-
-              def initialize(called_method, *args)
-                self.called_method = called_method
-                self.args = args
-              end
-
-              def perform
-                # ::#{klass}.send(self.called_method, *self.args)
-                ::#{klass}.send(:new, self.called_method, *self.args).deliver!
-              end
-
-              class << self
-
-                def method_missing(sym, *args)
-                  ::#{klass}Worker.enqueue(sym, *args)
-                end
-
-              end
-
-            end
-          }
-        end
-        
-        def method_missing_with_extras(method_symbol, *parameters) #:nodoc:
-          if ActionMailer::Base.delivery_method == :test
-            return method_missing_without_extras(method_symbol, *parameters)
-          end
-          
-          if match = matches_dynamic_method?(method_symbol)
-            case match[1]
-              when 'deliver'# then new(match[2], *parameters).deliver!
-                "#{self.name}Worker".constantize.enqueue(match[2], *parameters)
-              else
-                method_missing_without_extras(method_symbol, *parameters)
-            end
-          else
-            super
-          end
-        end
-        
-        alias_method_chain :method_missing, :extras
-        
-      end # class << self
-      
-    end # Base
-  end # ActionMailer
-end

data/lib/dj_remixes/rails2/unique_validator.rb

@@ -1,14 +0,0 @@
-Delayed::Worker.backend.send(:class_eval) do
-  def validate_with_unique
-    validate_without_unique
-    if self.payload_object.respond_to?(:unique?) && self.new_record?
-      if self.payload_object.unique?
-        if DJ.count(:all, :conditions => {:worker_class_name => self.payload_object.worker_class_name, :finished_at => nil}) > 0
-          self.errors.add_to_base("Only one #{self.payload_object.worker_class_name} can be queued at a time!")
-        end
-      end
-    end
-  end
-  
-  alias_method_chain :validate, :unique
-end