dalliance 0.1.0 → 0.1.1

data/README.rdoc

@@ -1,8 +1,8 @@
 = dalliance
 
-Opinionated background processing for ActiveRecord w/ delayed_job & state_machine
+Background processing for ActiveRecord w/ a 'delayable' worker & a state_machine
 
-A simple wrapper for asynchronous processing w/ error handling & a progress_meter
+Built in support for delayed_job or resque.
 
 == Getting Started
 
@@ -15,14 +15,14 @@ In your model:
     class Model < ActiveRecord::Base
       dalliance :process_method
     end
-    
+
 process_method is the name of the method to invoke for background processing
 to kick it off just call dalliance_background_process
 
 Handle your migrations:
 
    rails g dalliance:progress_meter
-   
+
    rails g dalliance:update model_name
 
 == ProgressMeter
@@ -33,7 +33,7 @@ Create a method called dalliance_progress_meter_total_count
 Inside process_method call dalliance_progress_meter.increment! after each iteration
 
 In your views you can then call dalliance_progress to get feedback on your asynchronous process
-     
+
 == Copyright
 
 Copyright (c) 2012 Annkissam. See LICENSE for details.

data/dalliance.gemspec

@@ -9,7 +9,7 @@ Gem::Specification.new do |s|
   s.email       = ["eric.sullivan@annkissam.com"]
   s.homepage    = "https://github.com/annkissam/dalliance"
   s.summary     = %q{ Wrapper for an ActiveRecord model with a single ascynhronous method }
-  s.description = %q{ Background processing for ActiveRecord using a 'delay' method and a state_machine }
+  s.description = %q{ Background processing for ActiveRecord using a 'delayable' worker and a state_machine }
 
   s.rubyforge_project = "dalliance"
 
@@ -24,7 +24,9 @@ Gem::Specification.new do |s|
   s.add_dependency('state_machine')
 
   s.add_development_dependency('rspec')
-  s.add_development_dependency('delayed_job', '>= 2.0.0')
+  s.add_development_dependency('delayed_job', '>= 3.0.0')
   s.add_development_dependency('delayed_job_active_record')
   s.add_development_dependency('sqlite3')
+
+  s.add_development_dependency('resque')
 end

data/lib/dalliance/progress_meter.rb

@@ -3,7 +3,7 @@ require 'active_record'
 module Dalliance
   class ProgressMeter < ::ActiveRecord::Base
     self.table_name = 'dalliance_progress_meters'
-    
+
     belongs_to :dalliance_progress_model, :polymorphic => true
 
     validates_presence_of :dalliance_progress_model
@@ -16,11 +16,11 @@ module Dalliance
     def current_count
       self[:current_count] ||= 0
     end
-    
+
     def total_count
       self[:total_count] ||= 1
     end
-    
+
     def total_count=(count)
       if count <= 0
         self[:total_count] = 1
@@ -28,19 +28,34 @@ module Dalliance
         self[:total_count] = count
       end
     end
-    
-    before_validation :calculate_progress
 
-    def calculate_progress
+    #before_validation :calculate_progress
+    #
+    #def calculate_progress
+    #  begin
+    #    self.progress = (current_count.to_f / total_count.to_f * 100).to_i
+    #
+    #    #Handle an incorrect total_count...
+    #    self.progress = 100 if progress > 100
+    #  rescue
+    #    #what, are you diving by zero?
+    #    self.progress = 0
+    #  end
+    #end
+
+    #TODO: This is just a stopgap until I fix increment! to be thread-safe
+    def progress
       begin
-        self.progress = (current_count.to_f / total_count.to_f * 100).to_i
-        
+        _progress = (current_count.to_f / total_count.to_f * 100).to_i
+
         #Handle an incorrect total_count...
-        self.progress = 100 if progress > 100
+        _progress = 100 if _progress > 100
       rescue
         #what, are you diving by zero?
-        self.progress = 0
+        _progress = 0
       end
+
+      _progress
     end
 
     def increment!

data/lib/dalliance/version.rb

@@ -2,7 +2,7 @@ module Dalliance
   module VERSION
     MAJOR = 0
     MINOR = 1
-    TINY  = 0
+    TINY  = 1
     PRE   = nil
 
     STRING = [MAJOR, MINOR, TINY, PRE].compact.join('.')

data/lib/dalliance/workers/delayed_job.rb

@@ -0,0 +1,13 @@
+module Dalliance
+  module Workers
+    class DelayedJob < Struct.new(:instance_klass, :instance_id)
+      def self.enqueue(instance)
+        ::Delayed::Job.enqueue(self.new(instance.class.name, instance.id), :queue => 'dalliance')
+      end
+
+      def perform
+        instance_klass.constantize.find(instance_id).dalliance_process(true)
+      end
+    end
+  end
+end

data/lib/dalliance/workers/resque.rb

@@ -0,0 +1,15 @@
+module Dalliance
+  module Workers
+    class Resque
+      @queue = :dalliance
+
+      def self.enqueue(instance)
+        ::Resque.enqueue(self, instance.class.name, instance.id)
+      end
+
+      def self.perform(instance_klass, instance_id)
+        instance_klass.constantize.find(instance_id).dalliance_process(true)
+      end
+    end
+  end
+end

data/lib/dalliance/workers.rb

@@ -0,0 +1,6 @@
+module Dalliance
+	module Workers
+    autoload :DelayedJob, 'dalliance/workers/delayed_job'
+    autoload :Resque, 'dalliance/workers/resque'
+  end
+end

data/lib/dalliance.rb

@@ -4,6 +4,7 @@ if defined?(Rails::Railtie)
   require 'dalliance/railtie'
 end
 
+require 'dalliance/workers'
 require 'dalliance/progress_meter'
 
 module Dalliance
@@ -14,7 +15,7 @@ module Dalliance
       @options ||= {
         :background_processing => (defined?(Rails) ? Rails.env.production? : true),
         :dalliance_progress_meter_total_count_method => :dalliance_progress_meter_total_count,
-        :delay_method => :delay
+        :worker_class => detect_worker_class
       }
     end
 
@@ -29,6 +30,11 @@ module Dalliance
     def configure
       yield(self) if block_given?
     end
+
+    def detect_worker_class
+      return Dalliance::Workers::DelayedJob if defined? ::Delayed::Job
+      return Dalliance::Workers::Resque     if defined? ::Resque
+    end
   end
 
   included do
@@ -84,11 +90,7 @@ module Dalliance
   #Force backgound_processing w/ true
   def dalliance_background_process(backgound_processing = nil)
     if backgound_processing || (backgound_processing.nil? && Dalliance.background_processing?)
-      if respond_to?(self.class.dalliance_options[:delay_method])
-        self.send(self.class.dalliance_options[:delay_method]).dalliance_process(true)
-      else
-        raise NoMethodError.new("#{self.class.dalliance_options[:delay_method]} is undefined")
-      end
+      self.class.dalliance_options[:worker_class].enqueue(self)
     else
       dalliance_process(false)
     end

data/spec/dalliance/{asynchronous_spec.rb → asynchronous_delayed_job_spec.rb}

@@ -7,10 +7,14 @@ describe DallianceModel do
     Dalliance.options[:background_processing] = true
   end
 
-  context "no delay method" do
+  before do
+    Delayed::Job.destroy_all
+  end
+
+  context "no worker_class" do
     before(:all) do
       DallianceModel.dalliance_options[:dalliance_method] = :dalliance_success_method
-      DallianceModel.dalliance_options[:delay_method] = :not_delay
+      DallianceModel.dalliance_options[:worker_class] = nil
     end
 
     it "should raise an error" do
@@ -21,7 +25,7 @@ describe DallianceModel do
   context "success" do
     before(:all) do
       DallianceModel.dalliance_options[:dalliance_method] = :dalliance_success_method
-      DallianceModel.dalliance_options[:delay_method] = :delay
+      DallianceModel.dalliance_options[:worker_class] = Dalliance::Workers::DelayedJob
     end
 
     it "should not call the dalliance_method w/o a Delayed::Worker" do
@@ -34,7 +38,7 @@ describe DallianceModel do
 
     it "should call the dalliance_method w/ a Delayed::Worker" do
       subject.dalliance_background_process
-      Delayed::Worker.new.work_off
+      Delayed::Worker.new(:queues => [:dalliance]).work_off
       subject.reload
 
       subject.should be_successful
@@ -43,7 +47,7 @@ describe DallianceModel do
 
     it "should set the dalliance_status to completed" do
       subject.dalliance_background_process
-      Delayed::Worker.new.work_off
+      Delayed::Worker.new(:queues => [:dalliance]).work_off
       subject.reload
 
       subject.should be_completed
@@ -51,7 +55,7 @@ describe DallianceModel do
 
     it "should set the dalliance_progress to 100" do
       subject.dalliance_background_process
-      Delayed::Worker.new.work_off
+      Delayed::Worker.new(:queues => [:dalliance]).work_off
       subject.reload
 
       subject.dalliance_progress.should == 100
@@ -61,20 +65,20 @@ describe DallianceModel do
   context "raise error" do
     before(:all) do
       DallianceModel.dalliance_options[:dalliance_method] = :dalliance_error_method
-      DallianceModel.dalliance_options[:delay_method] = :delay
+      DallianceModel.dalliance_options[:worker_class] = Dalliance::Workers::DelayedJob
     end
 
     it "should NOT raise an error" do
       subject.dalliance_background_process
 
-      Delayed::Worker.new.work_off
+      Delayed::Worker.new(:queues => [:dalliance]).work_off
 
       Delayed::Job.count.should == 0
     end
 
     it "should store the error" do
       subject.dalliance_background_process
-      Delayed::Worker.new.work_off
+      Delayed::Worker.new(:queues => [:dalliance]).work_off
       subject.reload
 
       subject.dalliance_error_hash.should_not be_empty
@@ -85,7 +89,7 @@ describe DallianceModel do
 
     it "should set the dalliance_status to processing_error" do
       subject.dalliance_background_process
-      Delayed::Worker.new.work_off
+      Delayed::Worker.new(:queues => [:dalliance]).work_off
       subject.reload
 
       subject.should be_processing_error
@@ -93,7 +97,7 @@ describe DallianceModel do
 
     it "should set the dalliance_progress to 0" do
       subject.dalliance_background_process
-      Delayed::Worker.new.work_off
+      Delayed::Worker.new(:queues => [:dalliance]).work_off
       subject.reload
 
       subject.dalliance_progress.should == 0

data/spec/dalliance/asynchronous_resque_spec.rb

@@ -0,0 +1,106 @@
+require 'spec_helper'
+
+describe DallianceModel do
+  subject { DallianceModel.create }
+
+  before(:all) do
+    Dalliance.options[:background_processing] = true
+  end
+
+  before do
+    Resque.remove_queue(:dalliance)
+  end
+
+  context "no worker_class" do
+    before(:all) do
+      DallianceModel.dalliance_options[:dalliance_method] = :dalliance_success_method
+      DallianceModel.dalliance_options[:worker_class] = nil
+    end
+
+    it "should raise an error" do
+      expect { subject.dalliance_background_process }.to raise_error(NoMethodError)
+    end
+  end
+
+  context "success" do
+    before(:all) do
+      DallianceModel.dalliance_options[:dalliance_method] = :dalliance_success_method
+      DallianceModel.dalliance_options[:worker_class] = Dalliance::Workers::Resque
+    end
+
+    it "should not call the dalliance_method w/o a Delayed::Worker" do
+      subject.dalliance_background_process
+      subject.reload
+
+      subject.should_not be_successful
+      Resque.size(:dalliance).should == 1
+    end
+
+    it "should call the dalliance_method w/ a Delayed::Worker" do
+      subject.dalliance_background_process
+      Resque::Worker.new(:dalliance).process
+      subject.reload
+
+      subject.should be_successful
+      Resque.size(:dalliance).should == 0
+    end
+
+    it "should set the dalliance_status to completed" do
+      subject.dalliance_background_process
+      Resque::Worker.new(:dalliance).process
+      subject.reload
+
+      subject.should be_completed
+    end
+
+    it "should set the dalliance_progress to 100" do
+      subject.dalliance_background_process
+      Resque::Worker.new(:dalliance).process
+      subject.reload
+
+      subject.dalliance_progress.should == 100
+    end
+  end
+
+  context "raise error" do
+    before(:all) do
+      DallianceModel.dalliance_options[:dalliance_method] = :dalliance_error_method
+      DallianceModel.dalliance_options[:worker_class] = Dalliance::Workers::Resque
+    end
+
+    it "should NOT raise an error" do
+      subject.dalliance_background_process
+
+      Resque::Worker.new(:dalliance).process
+
+      Resque.size(:dalliance).should == 0
+    end
+
+    it "should store the error" do
+      subject.dalliance_background_process
+      Resque::Worker.new(:dalliance).process
+      subject.reload
+
+      subject.dalliance_error_hash.should_not be_empty
+      subject.dalliance_error_hash[:error].should == RuntimeError.name #We store the class name...
+      subject.dalliance_error_hash[:message].should == 'RuntimeError'
+      subject.dalliance_error_hash[:backtrace].should_not be_blank
+    end
+
+    it "should set the dalliance_status to processing_error" do
+      subject.dalliance_background_process
+      Resque::Worker.new(:dalliance).process
+      subject.reload
+
+      subject.should be_processing_error
+    end
+
+    it "should set the dalliance_progress to 0" do
+      subject.dalliance_background_process
+      Resque::Worker.new(:dalliance).process
+      subject.reload
+
+      subject.dalliance_progress.should == 0
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -8,6 +8,7 @@ require 'state_machine'
 #Required for testing...
 require 'delayed_job'
 require 'delayed_job_active_record'
+require 'resque'
 
 require 'dalliance'
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: dalliance
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-08-17 00:00:00.000000000 Z
+date: 2012-09-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -82,7 +82,7 @@ dependencies:
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: 2.0.0
+        version: 3.0.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -90,7 +90,7 @@ dependencies:
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: 2.0.0
+        version: 3.0.0
 - !ruby/object:Gem::Dependency
   name: delayed_job_active_record
   requirement: !ruby/object:Gem::Requirement
@@ -123,8 +123,24 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
-description: ! ' Background processing for ActiveRecord using a ''delay'' method and
-  a state_machine '
+- !ruby/object:Gem::Dependency
+  name: resque
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: ! ' Background processing for ActiveRecord using a ''delayable'' worker
+  and a state_machine '
 email:
 - eric.sullivan@annkissam.com
 executables: []
@@ -143,11 +159,15 @@ files:
 - lib/dalliance/railtie.rb
 - lib/dalliance/schema.rb
 - lib/dalliance/version.rb
+- lib/dalliance/workers.rb
+- lib/dalliance/workers/delayed_job.rb
+- lib/dalliance/workers/resque.rb
 - lib/generators/dalliance/progress_meter/progress_meter_generator.rb
 - lib/generators/dalliance/progress_meter/templates/migration.rb
 - lib/generators/dalliance/update/templates/migration.rb.erb
 - lib/generators/dalliance/update/update_generator.rb
-- spec/dalliance/asynchronous_spec.rb
+- spec/dalliance/asynchronous_delayed_job_spec.rb
+- spec/dalliance/asynchronous_resque_spec.rb
 - spec/dalliance/dalliance_spec.rb
 - spec/dalliance/synchronous_spec.rb
 - spec/spec_helper.rb
@@ -177,7 +197,8 @@ signing_key:
 specification_version: 3
 summary: Wrapper for an ActiveRecord model with a single ascynhronous method
 test_files:
-- spec/dalliance/asynchronous_spec.rb
+- spec/dalliance/asynchronous_delayed_job_spec.rb
+- spec/dalliance/asynchronous_resque_spec.rb
 - spec/dalliance/dalliance_spec.rb
 - spec/dalliance/synchronous_spec.rb
 - spec/spec_helper.rb