carrierwave_backgrounder 0.0.7 → 0.0.8

data/README.md

@@ -33,6 +33,15 @@ gem 'carrierwave_backgrounder'
 
 ## Getting Started
 
+In an initializer:
+
+```ruby
+CarrierWave::Backgrounder.configure do |c|
+  # :delayed_job, :girl_friday, :sidekiq, :qu, :resque, or :qc
+  c.backend = :delayed_job 
+end
+```
+
 In your CarrierWave uploader file:
 
 ```ruby

data/lib/backgrounder/orm/activerecord.rb

@@ -13,7 +13,7 @@ module CarrierWave
 
           class_eval  <<-RUBY, __FILE__, __LINE__ + 1
             def trigger_#{column}_background_processing?
-              process_#{column}_upload != true && #{column}_changed?
+              process_#{column}_upload != true && (#{column}_changed? || remote_#{column}_url.present?)
             end
           RUBY
         end
@@ -23,7 +23,7 @@ module CarrierWave
 
           class_eval  <<-RUBY, __FILE__, __LINE__ + 1
             def trigger_#{column}_background_storage?
-              process_#{column}_upload != true && #{column}_changed?
+              process_#{column}_upload != true && (#{column}_changed? || remote_#{column}_url.present?)
             end
           RUBY
         end

data/lib/backgrounder/orm/base.rb

@@ -50,15 +50,7 @@ module CarrierWave
             end
 
             def enqueue_#{column}_background_job
-              if defined? ::GirlFriday
-                CARRIERWAVE_QUEUE << { :worker => #{worker}.new(self.class.name, id, #{column}.mounted_as) }
-              elsif defined? ::Delayed::Job
-                ::Delayed::Job.enqueue #{worker}.new(self.class.name, id, #{column}.mounted_as)
-              elsif defined? ::Resque
-                ::Resque.enqueue #{worker}, self.class.name, id, #{column}.mounted_as
-              elsif defined? ::Qu
-                ::Qu.enqueue #{worker}, self.class.name, id, #{column}.mounted_as
-              end
+              CarrierWave::Backgrounder.enqueue_for_backend(#{worker}, self.class.name, id.to_s, #{column}.mounted_as)
             end
 
             def trigger_#{column}_background_processing?
@@ -98,7 +90,7 @@ module CarrierWave
 
             def write_#{column}_identifier
               super() and return if process_#{column}_upload
-              self.#{column}_tmp = _mounter(:#{column}).cache_name
+              self.#{column}_tmp = _mounter(:#{column}).cache_name if _mounter(:#{column}).cache_name
             end
 
             def store_#{column}!
@@ -106,15 +98,7 @@ module CarrierWave
             end
 
             def enqueue_#{column}_background_job
-              if defined? ::GirlFriday
-                CARRIERWAVE_QUEUE << { :worker => #{worker}.new(self.class.name, id, #{column}.mounted_as) }
-              elsif defined? ::Delayed::Job
-                ::Delayed::Job.enqueue #{worker}.new(self.class.name, id, #{column}.mounted_as)
-              elsif defined? ::Resque
-                ::Resque.enqueue #{worker}, self.class.name, id, #{column}.mounted_as
-              elsif defined? ::Qu
-                ::Qu.enqueue #{worker}, self.class.name, id, #{column}.mounted_as
-              end
+              CarrierWave::Backgrounder.enqueue_for_backend(#{worker}, self.class.name, id.to_s, #{column}.mounted_as)
             end
 
             def trigger_#{column}_background_storage?

data/lib/backgrounder/orm/mongoid.rb

@@ -10,7 +10,7 @@ module CarrierWave
 
           class_eval  <<-RUBY, __FILE__, __LINE__ + 1
             def trigger_#{column}_background_processing?
-              process_#{column}_upload != true && #{column}_changed?
+              process_#{column}_upload != true && (#{column}_changed? || remote_#{column}_url.present?)
             end
           RUBY
         end
@@ -20,7 +20,7 @@ module CarrierWave
 
           class_eval  <<-RUBY, __FILE__, __LINE__ + 1
             def trigger_#{column}_background_storage?
-              process_#{column}_upload != true && #{column}_changed?
+              process_#{column}_upload != true && (#{column}_changed? || remote_#{column}_url.present?)
             end
           RUBY
         end
@@ -30,4 +30,4 @@ module CarrierWave
   end # Backgrounder
 end # CarrierWave
 
-Mongoid::Document::ClassMethods.send(:include, ::CarrierWave::Backgrounder::ORM::Mongoid)
+Mongoid::Document::ClassMethods.send(:include, ::CarrierWave::Backgrounder::ORM::Mongoid)

data/lib/backgrounder/version.rb

@@ -1,5 +1,5 @@
 module CarrierWave
   module Backgrounder
-    VERSION = "0.0.7"
+    VERSION = "0.0.8"
   end
 end

data/lib/backgrounder/workers/process_asset.rb

@@ -3,24 +3,31 @@ module CarrierWave
   module Workers
 
     class ProcessAsset < Struct.new(:klass, :id, :column)
+      include ::Sidekiq::Worker if defined?(::Sidekiq)
       @queue = :process_asset
 
       def self.perform(*args)
         new(*args).perform
       end
 
-      def perform
+      def perform(*args)
+        set_args(*args) unless args.empty?
         resource = klass.is_a?(String) ? klass.constantize : klass
         record = resource.find id
 
         if record
           record.send(:"process_#{column}_upload=", true)
           if record.send(:"#{column}").recreate_versions! && record.respond_to?(:"#{column}_processing")
-            record.update_attribute :"#{column}_processing", nil
+            record.send :"#{column}_processing=", nil
+            record.save!
           end
         end
       end
 
+      def set_args(klass, id, column)
+        self.klass, self.id, self.column = klass, id, column
+      end
+
     end # ProcessAsset
 
   end # Workers

data/lib/backgrounder/workers/store_asset.rb

@@ -3,13 +3,15 @@ module CarrierWave
   module Workers
 
     class StoreAsset < Struct.new(:klass, :id, :column)
+      include ::Sidekiq::Worker if defined?(::Sidekiq)
       @queue = :store_asset
 
       def self.perform(*args)
         new(*args).perform
       end
 
-      def perform
+      def perform(*args)
+        set_args(*args) unless args.empty?
         resource = klass.is_a?(String) ? klass.constantize : klass
         record = resource.find id
         if tmp = record.send(:"#{column}_tmp")
@@ -26,6 +28,10 @@ module CarrierWave
         end
       end
       
+      def set_args(klass, id, column)
+        self.klass, self.id, self.column = klass, id, column
+      end
+
     end # StoreAsset
     
   end # Workers

data/lib/carrierwave_backgrounder.rb

@@ -1,5 +1,6 @@
 module CarrierWave
   module Backgrounder
+
     Logger = Logger.new(STDOUT)
 
     autoload :Delay, 'backgrounder/delay'
@@ -8,6 +9,70 @@ module CarrierWave
     module ORM
       autoload :Base, 'backgrounder/orm/base'
     end
+
+    class << self
+      def backend=(value)
+        @backend = value
+        self.configure_backend
+      end
+
+      def backend
+        return @backend unless @backend.nil?
+        if available_backends.empty?
+          warn 'WARNING: No queue backends found to use for CarrierWave::Backgrounder'
+        elsif available_backends.size == 1
+          self.backend = available_backends.first
+        elsif available_backends.size > 1
+          warn 'WARNING: Multiple queue backends found for CarrierWave::Backgrounder. You need to set one explicitly.'
+        end
+      end
+
+      def configure
+        yield self
+      end
+
+      def available_backends
+        @available_backends ||= begin
+          backends = []
+          backends << :girl_friday if defined? ::GirlFriday
+          backends << :delayed_job if defined? ::Delayed::Job
+          backends << :resque      if defined? ::Resque
+          backends << :qu          if defined? ::Qu
+          backends << :sidekiq     if defined? ::Sidekiq
+          backends << :qc          if defined? ::QC
+          backends
+        end
+      end
+
+      def configure_backend
+        if backend == :girl_friday
+          require 'girl_friday'
+          @girl_friday_queue = GirlFriday::WorkQueue.new(:carrierwave) do |msg|
+            worker = msg[:worker]
+            worker.perform
+          end
+        end
+      end
+
+      def enqueue_for_backend(worker, class_name, subject_id, mounted_as)
+        case backend
+        when :girl_friday
+          @girl_friday_queue << { :worker => worker.new(self.class.name, subject_id, mounted_as) }
+        when :delayed_job
+          ::Delayed::Job.enqueue worker.new(class_name, subject_id, mounted_as)
+        when :resque
+          ::Resque.enqueue worker, class_name, subject_id, mounted_as
+        when :qu
+          ::Qu.enqueue worker, class_name, subject_id, column.mounted_as
+        when :sidekiq
+          ::Sidekiq::Client.enqueue worker, class_name, subject_id, mounted_as
+        when :qc
+          ::QC.enqueue "#{worker.name}.perform", class_name, subject_id, mounted_as.to_s
+        end
+      end
+
+    end
+
   end
 end
 
@@ -35,11 +100,3 @@ if defined?(Rails)
   end
 end
 
-if defined?(GirlFriday)
-  require 'girl_friday'
-
-  CARRIERWAVE_QUEUE = GirlFriday::WorkQueue.new(:carrierwave) do |msg|
-    worker = msg[:worker]
-    worker.perform
-  end
-end

data/spec/backgrounder/backends_spec.rb

@@ -0,0 +1,67 @@
+require 'spec_helper'
+require 'carrierwave_backgrounder'
+
+describe CarrierWave::Backgrounder do
+
+  describe 'enumerating available backends' do
+
+    it 'detects GirlFriday' do
+      CarrierWave::Backgrounder.available_backends.should include(:girl_friday)
+    end
+    it 'detects Delayed::Job' do
+      CarrierWave::Backgrounder.available_backends.should include(:delayed_job)
+    end
+    it 'detects Resque' do
+      CarrierWave::Backgrounder.available_backends.should include(:resque)
+    end
+    it 'detects Qu' do
+      CarrierWave::Backgrounder.available_backends.should include(:qu)
+    end
+    it 'detects Sidekiq' do
+      CarrierWave::Backgrounder.available_backends.should include(:sidekiq)
+    end
+    it 'detects QC' do
+      CarrierWave::Backgrounder.available_backends.should include(:qc)
+    end
+  end
+
+  describe 'automatically setting backends' do
+
+    before do
+      CarrierWave::Backgrounder.instance_variable_set('@backend', nil)
+    end
+
+    it 'does not set a backend if none are available' do
+      suppress_warnings do
+        CarrierWave::Backgrounder.stubs(:available_backends).returns([])
+        CarrierWave::Backgrounder.backend.should be_nil
+      end
+    end
+    it 'sets a backend automatically if only one is available' do
+      CarrierWave::Backgrounder.stubs(:available_backends).returns([ :qu ])
+      CarrierWave::Backgrounder.backend.should eq(:qu)
+    end
+    it 'does not set a backend if more than one is available' do
+      suppress_warnings do
+        CarrierWave::Backgrounder.stubs(:available_backends).returns([:qu, :resque])
+        CarrierWave::Backgrounder.backend.should be_nil
+      end
+    end
+
+    it 'does not clobber a manually set backend' do
+      CarrierWave::Backgrounder.backend = :not_a_backend
+      CarrierWave::Backgrounder.backend.should eq(:not_a_backend)
+    end
+
+    it 'calls configure_backend when setting the backend' do
+      CarrierWave::Backgrounder.stubs(:available_backends).returns([ :qu ])
+      CarrierWave::Backgrounder.expects(:configure_backend).once
+      CarrierWave::Backgrounder.backend.should eq(:qu)
+    end
+
+  end
+
+
+
+end
+

data/spec/{workers → backgrounder/workers}/process_asset_spec.rb

@@ -19,15 +19,27 @@ describe CarrierWave::Workers::ProcessAsset do
   end
 
   context "#perform" do
-    it 'processes versions' do
+    it 'processes versions with image_processing column' do
       user.expects(:find).with('22').returns(user).once
       user.expects(:image).once.returns(image)
       user.expects(:process_image_upload=).with(true).once
 
       image.expects(:recreate_versions!).once.returns(true)
       user.expects(:respond_to?).with(:image_processing).once.returns(true)
-      user.expects(:update_attribute).with(:image_processing, nil).once
+      user.expects(:image_processing=).with(nil).once
+      user.expects(:save!)
+      worker.perform
+    end
 
+    it 'processes versions without image_processing column' do
+      user.expects(:find).with('22').returns(user).once
+      user.expects(:image).once.returns(image)
+      user.expects(:process_image_upload=).with(true).once
+
+      image.expects(:recreate_versions!).once.returns(true)
+      user.expects(:respond_to?).with(:image_processing).once.returns(false)
+      user.expects(:image_processing=).never
+      user.expects(:save!).never
       worker.perform
     end
   end

data/spec/spec_helper.rb

@@ -1,7 +1,21 @@
 # encoding: utf-8
 require 'rubygems'
 require 'bundler/setup'
+require 'support/backend_constants'
+require 'logger'
+
+module WarningSuppression
+  def suppress_warnings
+    original_verbosity = $VERBOSE
+    $VERBOSE = nil
+    result = yield
+    $VERBOSE = original_verbosity
+    return result
+  end
+end
 
 RSpec.configure do |c|
   c.mock_with :mocha
-end
+  c.include WarningSuppression
+end
+

data/spec/support/backend_constants.rb

@@ -0,0 +1,23 @@
+# Fixture module declarations for backend detection testing
+
+module GirlFriday
+end
+
+module Delayed
+  module Job
+  end
+end
+
+module Resque
+end
+
+module Qu
+end
+
+module Sidekiq
+  module Worker
+  end
+end
+
+module QC
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: carrierwave_backgrounder
 version: !ruby/object:Gem::Version
-  version: 0.0.7
+  version: 0.0.8
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-05-30 00:00:00.000000000 Z
+date: 2012-10-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: carrierwave
@@ -98,10 +98,12 @@ files:
 - lib/backgrounder/workers/process_asset.rb
 - lib/backgrounder/workers/store_asset.rb
 - lib/carrierwave_backgrounder.rb
+- spec/backgrounder/backends_spec.rb
+- spec/backgrounder/workers/fixtures/test.jpg
+- spec/backgrounder/workers/process_asset_spec.rb
+- spec/backgrounder/workers/store_asset_spec.rb
 - spec/spec_helper.rb
-- spec/workers/fixtures/test.jpg
-- spec/workers/process_asset_spec.rb
-- spec/workers/store_asset_spec.rb
+- spec/support/backend_constants.rb
 homepage: ''
 licenses: []
 post_install_message: 
@@ -114,21 +116,29 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: -3222022521039944985
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: -3222022521039944985
 requirements: []
 rubyforge_project: carrierwave_backgrounder
-rubygems_version: 1.8.21
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: Offload CarrierWave's image processing and storage to a background process
   using Delayed Job
 test_files:
+- spec/backgrounder/backends_spec.rb
+- spec/backgrounder/workers/fixtures/test.jpg
+- spec/backgrounder/workers/process_asset_spec.rb
+- spec/backgrounder/workers/store_asset_spec.rb
 - spec/spec_helper.rb
-- spec/workers/fixtures/test.jpg
-- spec/workers/process_asset_spec.rb
-- spec/workers/store_asset_spec.rb
+- spec/support/backend_constants.rb