carrierwave_backgrounder 0.2.0 → 0.2.1

data/CHANGELOG.md

@@ -1,3 +1,12 @@
+## 0.2.1
+
+### enhancements
+  * [#119] Add support for SuckerPunch [rewritten].
+
+### bug fixes
+  * [#115] column_remove! should not trigger a background job
+  * [#112] Raise a NoMethodError when using backend= instead of silent failure.
+
 ## 0.2.0
 
 ### enhancements

data/README.md

@@ -7,7 +7,7 @@
 I like CarrierWave. That being said, I don't like tying up app instances waiting for images to process.
 
 This gem addresses that by offloading processing or storage/processing to a background task.
-We currently support Delayed Job, Resque, Sidekiq, Girl Friday, Qu, and Queue Classic.
+We currently support Delayed Job, Resque, Sidekiq, SuckerPunch, Girl Friday, Qu, and Queue Classic.
 
 ## Background options
 
@@ -55,6 +55,19 @@ CarrierWave::Backgrounder.configure do |c|
 end
 ```
 
+For SuckerPunch, you have to configure your queue with a specific worker.
+
+```ruby
+SuckerPunch.config do
+  queue name: :carrierwave, worker: CarrierWave::Workers::StoreAsset, size: 2
+end
+
+CarrierWave::Backgrounder.configure do |c|
+  c.backend :sucker_punch, queue: :carrierwave
+end
+```
+
+
 In your CarrierWave uploader file:
 
 ```ruby

data/lib/backgrounder/orm/base.rb

@@ -100,7 +100,7 @@ module CarrierWave
             def #{column}_updated?; true; end
 
             def enqueue_#{column}_background_job?
-              !process_#{column}_upload && #{column}_updated?
+              !remove_#{column}? && !process_#{column}_upload && #{column}_updated?
             end
 
             def enqueue_#{column}_background_job

data/lib/backgrounder/railtie.rb

@@ -0,0 +1,25 @@
+module CarrierWave
+  module Backgrounder
+    class Railtie < Rails::Railtie
+
+      initializer "carrierwave_backgrounder.active_record" do
+        ActiveSupport.on_load :active_record do
+          require 'backgrounder/orm/activemodel'
+          ::ActiveRecord::Base.extend CarrierWave::Backgrounder::ORM::ActiveModel
+        end
+      end
+
+      initializer "carrierwave_backgrounder.data_mapper", :before =>"data_mapper.add_to_prepare" do
+        require 'backgrounder/orm/data_mapper' if defined?(DataMapper)
+      end
+
+      initializer "carrierwave_backgrounder.mongoid" do
+        if defined?(Mongoid)
+          require 'backgrounder/orm/activemodel'
+          ::Mongoid::Document::ClassMethods.send(:include, ::CarrierWave::Backgrounder::ORM::ActiveModel)
+        end
+      end
+
+    end
+  end
+end

data/lib/backgrounder/support/backends.rb

@@ -6,7 +6,6 @@ module Support
     end
 
     module ClassMethods
-      attr_writer :backend
       attr_reader :queue_options
 
       def backend(queue_name=nil, args={})
@@ -31,12 +30,8 @@ module Support
       end
 
       def enqueue_sidekiq(worker, *args)
-        sidekiq_client_args = { 'class' => worker, 'args' => args }
-        sidekiq_client_args['queue'] = queue_options[:queue] unless queue_options[:queue].nil?
-        sidekiq_client_args['retry'] = queue_options[:retry] unless queue_options[:retry].nil?
-        sidekiq_client_args['timeout'] = queue_options[:timeout] unless queue_options[:timeout].nil?
-        sidekiq_client_args['backtrace'] = queue_options[:backtrace] unless queue_options[:backtrace].nil?
-        worker.client_push(sidekiq_client_args)
+        args = sidekiq_queue_options('class' => worker, 'args' => args)
+        worker.client_push(args)
       end
 
       def enqueue_girl_friday(worker, *args)
@@ -47,6 +42,11 @@ module Support
         @girl_friday_queue << { :worker => worker.new(*args) }
       end
 
+      def enqueue_sucker_punch(worker, *args)
+        @sucker_punch_queue ||= SuckerPunch::Queue[queue_options[:queue] || :carrierwave]
+        @sucker_punch_queue.async.perform(*args)
+      end
+
       def enqueue_qu(worker, *args)
         worker.instance_variable_set('@queue', queue_options[:queue] || :carrierwave)
         ::Qu.enqueue worker, *args
@@ -60,6 +60,14 @@ module Support
       def enqueue_immediate(worker, *args)
         worker.new(*args).perform
       end
+
+      def sidekiq_queue_options(args)
+        args['queue'] = queue_options[:queue] if queue_options[:queue]
+        args['retry'] = queue_options[:retry] unless queue_options[:retry].nil?
+        args['timeout'] = queue_options[:timeout] if queue_options[:timeout]
+        args['backtrace'] = queue_options[:backtrace] if queue_options[:backtrace]
+        args
+      end
     end
   end
 end

data/lib/backgrounder/version.rb

@@ -1,5 +1,5 @@
 module CarrierWave
   module Backgrounder
-    VERSION = "0.2.0"
+    VERSION = "0.2.1"
   end
 end

data/lib/carrierwave_backgrounder.rb

@@ -12,7 +12,8 @@ module CarrierWave
 
     def self.configure
       yield self
-      if @backend == :sidekiq
+      case @backend
+      when :sidekiq
         ::CarrierWave::Workers::ProcessAsset.class_eval do
           require 'sidekiq'
           include ::Sidekiq::Worker
@@ -21,36 +22,19 @@ module CarrierWave
           require 'sidekiq'
           include ::Sidekiq::Worker
         end
-      end
-    end
-
-  end
-end
-
-if defined?(Rails)
-  module CarrierWave
-    module Backgrounder
-      class Railtie < Rails::Railtie
-
-        initializer "carrierwave_backgrounder.active_record" do
-          ActiveSupport.on_load :active_record do
-            require 'backgrounder/orm/activemodel'
-            ::ActiveRecord::Base.extend CarrierWave::Backgrounder::ORM::ActiveModel
-          end
-        end
-
-        initializer "carrierwave_backgrounder.data_mapper", :before =>"data_mapper.add_to_prepare" do
-          require 'backgrounder/orm/data_mapper' if defined?(DataMapper)
+      when :sucker_punch
+        ::CarrierWave::Workers::ProcessAsset.class_eval do
+          require 'sucker_punch'
+          include ::SuckerPunch::Worker
         end
-
-        initializer "carrierwave_backgrounder.mongoid" do
-          if defined?(Mongoid)
-            require 'backgrounder/orm/activemodel'
-            ::Mongoid::Document::ClassMethods.send(:include, ::CarrierWave::Backgrounder::ORM::ActiveModel)
-          end
+        ::CarrierWave::Workers::StoreAsset.class_eval do
+          require 'sucker_punch'
+          include ::SuckerPunch::Worker
         end
-
       end
     end
+
   end
 end
+
+require 'backgrounder/railtie' if defined?(Rails)

data/spec/backgrounder/orm/activemodel_spec.rb

@@ -9,6 +9,7 @@ describe CarrierWave::Backgrounder::ORM::ActiveModel do
       def self.after_commit(method, opts); nil; end
       def avatar_changed?; nil;  end
       def remote_avatar_url; OpenStruct.new(:present? => true); end
+      def remove_avatar?; false; end
       def previous_changes; {}; end
     end
 

data/spec/backgrounder/support/backends_spec.rb

@@ -11,8 +11,9 @@ describe Support::Backends do
 
   describe 'setting backend' do
     it 'using #backend=' do
-      mock_module.backend = :delayed_job
-      expect(mock_module.backend).to eql(:delayed_job)
+      expect {
+        mock_module.backend = :delayed_job
+      }.to raise_error(NoMethodError)
     end
 
     it 'using #backend' do
@@ -123,6 +124,28 @@ describe Support::Backends do
       end
     end
 
+    context 'sucker_punch' do
+      let(:args) { [MockWorker, 'FakeClass', 1, :image] }
+      let(:mock_sp) { mock('SuckerPunch')}
+
+      before do
+        mock_sp.expects(:async).returns(mock_sp)
+        mock_sp.expects(:perform).with('FakeClass', 1, :image)
+      end
+
+      it 'sets the queue to :carrierwave by default' do
+        SuckerPunch::Queue.expects(:[]).with(:carrierwave).returns(mock_sp)
+        mock_module.backend :sucker_punch
+        mock_module.enqueue_for_backend(*args)
+      end
+
+      it 'sets the queue to backend :queue option' do
+        SuckerPunch::Queue.expects(:[]).with(:awesome_queue).returns(mock_sp)
+        mock_module.backend :sucker_punch, :queue => :awesome_queue
+        mock_module.enqueue_for_backend(*args)
+      end
+    end
+
     context 'qu' do
       let(:args) { [MockWorker, 'FakeClass', 1, :image] }
       before do

data/spec/support/backend_constants.rb

@@ -37,3 +37,8 @@ end
 
 module QC
 end
+
+module SuckerPunch
+  class Queue
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: carrierwave_backgrounder
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-02-04 00:00:00.000000000 Z
+date: 2013-03-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: carrierwave
@@ -94,6 +94,7 @@ files:
 - lib/backgrounder/orm/activemodel.rb
 - lib/backgrounder/orm/base.rb
 - lib/backgrounder/orm/data_mapper.rb
+- lib/backgrounder/railtie.rb
 - lib/backgrounder/support/backends.rb
 - lib/backgrounder/version.rb
 - lib/backgrounder/workers.rb
@@ -127,7 +128,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 517086272646554403
+      hash: 1936252162021597709
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -136,7 +137,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 517086272646554403
+      hash: 1936252162021597709
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.24