carrierwave_backgrounder 0.0.5 → 0.0.6

data/{README.rdoc → README.md}

@@ -1,78 +1,95 @@
-= CarrierWave Backgrounder
+# CarrierWave Backgrounder
 
-I like CarrierWave. That being said, I don't like tying up app instances waiting for images to process. This gem addresses that issue.
+I like CarrierWave. That being said, I don't like tying up app instances waiting for images to process.
+
+This gem addresses that issue by disabling processing until a background process initiates it.
+It supports both Delayed Job and Resque.
+
+## Background options
 
-== Background options
-  
 There are currently two offerings for backgrounding upload tasks which are as follows;
 
-    Backgrounder::ORM::Base::process_in_background
+```ruby
+Backgrounder::ORM::Base::process_in_background
+```
 
 This method stores the original file and does no processing or versioning. Optionally you can add a column to the database which will be set to nil when the background processing is complete.
-  
-    Backgrounder::ORM::Base::store_in_background
-  
+
+```ruby
+Backgrounder::ORM::Base::store_in_background
+```
+
 This method does nothing to the file after it is cached which makes it super fast. It requires a column in the database which stores the cache location set by carrierwave. The drawback to using this method is the need for a central location to store the cached files. This leave heroku out. Heroku may deploy workers on separate servers from where your dyno cached the files. That being said, I only recommend using this method if you have full control over your temp storage directory.
 
-== Installation
+## Installation
 
-These instructions assume you have previously set up {CarrierWave}[https://github.com/jnicklas/carrierwave] and {DelayedJob}[https://github.com/collectiveidea/delayed_job]
+These instructions assume you have previously set up [CarrierWave](https://github.com/jnicklas/carrierwave) and [DelayedJob](https://github.com/collectiveidea/delayed_job) or Resque
 
 In Rails, add the following your Gemfile:
-    
-    gem 'carrierwave_backgrounder'
-    
-== Getting Started
 
-=== To use process_in_background
-    
+```ruby
+gem 'carrierwave_backgrounder'
+```
+
+## Getting Started
+
+### To use process_in_background
+
 In your model:
-    
-    mount_uploader :avatar, AvatarUploader
-    process_in_background :avatar
- 
-=== To use store_in_background
-    
+
+```ruby
+mount_uploader :avatar, AvatarUploader
+process_in_background :avatar
+```
+
+### To use store_in_background
+
 In your model:
 
-    mount_uploader :avatar, AvatarUploader
-    process_in_background :avatar
+```ruby
+mount_uploader :avatar, AvatarUploader
+store_in_background :avatar
+```
 
 Add a column to the model you want to background which will store the temp file location:
 
-    add_column :users, :avatar_tmp, :string
+```ruby
+add_column :users, :avatar_tmp, :string
+```
 
 In your CarrierWave uploader file:
 
-    class AvatarUploader < CarrierWave::Uploader::Base
-      include ::CarrierWave::Backgrounder::DelayStorage
+```ruby
+class AvatarUploader < CarrierWave::Uploader::Base
+  include ::CarrierWave::Backgrounder::DelayStorage
 
-      #ect...
-    end
+  #ect...
+end
+```
 
-== Usage Tips
+## Usage Tips
 
 If you need to process/store the upload immediately:
 
-    @user.process_<column>_upload = true 
-    
-== ORM
+```ruby
+@user.process_<column>_upload = true
+```
 
-Currently ActiveRecord is the default orm and I have not tested this with others but it should work by adding the following to your carrierwave initializer:
+## ORM
 
-    DataMapper::Model.send(:include, ::CarrierWave::Backgrounder::ORM::Base)
-    # or
-    Mongoid::Document::ClassMethods.send(:include, ::CarrierWave::Backgrounder::ORM::Base)
-    # or
-    Sequel::Model.send(:extend, ::CarrierWave::Backgrounder::ORM::Base)
-    
-Contributions are gladly accepted from those who use these orms.
+Currently ActiveRecord is the default orm and I have not tested this with others but it should work by adding the following to your carrierwave initializer:
 
-== TODO
+```ruby
+DataMapper::Model.send(:include, ::CarrierWave::Backgrounder::ORM::Base)
+# or
+Mongoid::Document::ClassMethods.send(:include, ::CarrierWave::Backgrounder::ORM::Base)
+# or
+Sequel::Model.send(:extend, ::CarrierWave::Backgrounder::ORM::Base)
+```
 
-More specs
+Contributions are gladly accepted from those who use these orms.
 
-== License
+## License
 
 Copyright (c) 2011 Larry Sprock
 
@@ -93,4 +110,4 @@ 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.
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/lib/backgrounder/delay_storage.rb

@@ -2,14 +2,23 @@ module CarrierWave
   module Backgrounder
 
     module DelayStorage
+
+      ##
+      #Intercept carrierwave#cache_versions! so we can process versions later.
       def cache_versions!(new_file)
         super(new_file) if proceed_with_versioning?
       end
       
+      def process!(new_file=nil)
+        super(new_file) if proceed_with_versioning?
+      end
+      
+      private
+
       def proceed_with_versioning?
         !model.respond_to?(:"process_#{mounted_as}_upload") || model.send(:"process_#{mounted_as}_upload")
       end
     end # DelayStorage
     
   end # Backgrounder
-end # CarrierWave
+end # CarrierWave

data/lib/backgrounder/orm/base.rb

@@ -50,7 +50,15 @@ module CarrierWave
             end
 
             def enqueue_#{column}_background_job
-              ::Delayed::Job.enqueue #{worker}.new(self.class, id, #{column}.mounted_as)
+              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
             end
 
             def trigger_#{column}_background_processing?
@@ -98,7 +106,15 @@ module CarrierWave
             end
 
             def enqueue_#{column}_background_job
-              ::Delayed::Job.enqueue #{worker}.new(self.class, id, #{column}.mounted_as)
+              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
             end
 
             def trigger_#{column}_background_storage?

data/lib/backgrounder/version.rb

@@ -1,5 +1,5 @@
 module CarrierWave
   module Backgrounder
-    VERSION = "0.0.5"
+    VERSION = "0.0.6"
   end
 end

data/lib/backgrounder/workers/process_asset.rb

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

data/lib/backgrounder/workers/store_asset.rb

@@ -3,19 +3,25 @@ module CarrierWave
   module Workers
 
     class StoreAsset < Struct.new(:klass, :id, :column)
-  
+      @queue = :store_asset
+
+      def self.perform(*args)
+        new(*args).perform
+      end
+
       def perform
-        record = klass.find id
+        resource = klass.is_a?(String) ? klass.constantize : klass
+        record = resource.find id
         if tmp = record.send(:"#{column}_tmp")
           asset = record.send(:"#{column}")
           cache_dir  = [asset.root, asset.cache_dir].join("/")
           cache_path = [cache_dir, tmp].join("/")
-        
+          tmp_dir = [cache_dir, tmp.split("/")[0]].join("/")
           record.send :"process_#{column}_upload=", true
           record.send :"#{column}_tmp=", nil
           File.open(cache_path) { |f| record.send :"#{column}=", f }
           if record.save!
-            FileUtils.rm(cache_path)
+            FileUtils.rm_r(tmp_dir, :force => true)
           end
         end
       end

data/lib/carrierwave_backgrounder.rb

@@ -21,3 +21,12 @@ if defined?(Rails)
     end
   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/workers/process_asset_spec.rb

@@ -2,24 +2,33 @@
 require 'spec_helper'
 require 'backgrounder/workers/process_asset'
 
-describe worker = CarrierWave::Workers::ProcessAsset do
-  before do
-    @user   = mock('User')
-    @image  = mock('UserAsset')
-    @worker = worker.new(@user, '22', :image)
+describe CarrierWave::Workers::ProcessAsset do
+  let(:worker_class) { CarrierWave::Workers::ProcessAsset }
+  let(:user)   { mock('User') }
+  let(:image)  { mock('UserAsset') }
+  let!(:worker) { worker_class.new(user, '22', :image) }
+
+  context ".perform" do
+    it 'creates a new instance and calls perform' do
+      args = [user, '22', :image]
+      worker_class.expects(:new).with(*args).returns(worker)
+      worker_class.any_instance.expects(:perform)
+
+      worker_class.perform(*args)
+    end
   end
 
   context "#perform" do
     it 'processes versions' do
-      @user.expects(:find).with('22').returns(@user).once
-      @user.expects(:image).once.returns(@image)
-      @user.expects(:process_image_upload=).with(true).once
+      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
+      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
 
-      @worker.perform
+      worker.perform
     end
   end
 end

data/spec/workers/store_asset_spec.rb

@@ -2,28 +2,36 @@
 require 'spec_helper'
 require 'backgrounder/workers/store_asset'
 
-describe worker = CarrierWave::Workers::StoreAsset do
-  before do
-    @user   = mock('User')
-    @image  = mock('UserAsset')
-    @worker = worker.new(@user, '22', :image)
+describe CarrierWave::Workers::StoreAsset do
+  let(:worker_class) { CarrierWave::Workers::StoreAsset }
+  let(:user)   { mock('User') }
+  let(:image)  { mock('UserAsset') }
+  let!(:worker) { worker_class.new(user, '22', :image) }
+
+  context ".perform" do
+    it 'creates a new instance and calls perform' do
+      args = [user, '22', :image]
+      worker_class.expects(:new).with(*args).returns(worker)
+      worker_class.any_instance.expects(:perform)
+
+      worker_class.perform(*args)
+    end
   end
 
   context "#perform" do
     it 'processes versions' do
-      File.expects(:open).with('../fixtures/test.jpg').once.returns('apple')
-      FileUtils.expects(:rm).with('../fixtures/test.jpg').once
-      @user.expects(:find).with('22').once.returns(@user)
-      @user.expects(:image_tmp).once.returns('test.jpg')
-      @user.expects(:image).once.returns(@image)
-      @image.expects(:root).once.returns('..')
-      @image.expects(:cache_dir).once.returns('fixtures')
-      @user.expects(:process_image_upload=).with(true).once
-      @user.expects(:image=).with('apple').once
-      @user.expects(:image_tmp=).with(nil).once
-      @user.expects(:save!).once.returns(true)
+      FileUtils.expects(:rm_r).with(File.expand_path('../fixtures/test.jpg', __FILE__),:force=>true).once
+      user.expects(:find).with('22').once.returns(user)
+      user.expects(:image_tmp).once.returns('test.jpg')
+      user.expects(:image).once.returns(image)
+      image.expects(:root).once.returns(File.expand_path('..', __FILE__))
+      image.expects(:cache_dir).once.returns('fixtures')
+      user.expects(:process_image_upload=).with(true).once
+      user.expects(:image=).once
+      user.expects(:image_tmp=).with(nil).once
+      user.expects(:save!).once.returns(true)
 
-      @worker.perform
+      worker.perform
     end
   end
-end
+end

metadata

@@ -2,7 +2,7 @@
 name: carrierwave_backgrounder
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.0.5
+  version: 0.0.6
 platform: ruby
 authors: 
 - Larry Sprock
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-08-29 00:00:00 -07:00
+date: 2011-12-07 00:00:00 -08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -59,7 +59,7 @@ files:
 - .gitignore
 - .rspec
 - Gemfile
-- README.rdoc
+- README.md
 - Rakefile
 - carrierwave_backgrounder.gemspec
 - lib/backgrounder/delay_storage.rb
@@ -71,6 +71,7 @@ files:
 - lib/backgrounder/workers/store_asset.rb
 - lib/carrierwave_backgrounder.rb
 - spec/spec_helper.rb
+- spec/workers/fixtures/test.jpg
 - spec/workers/process_asset_spec.rb
 - spec/workers/store_asset_spec.rb
 has_rdoc: true
@@ -103,5 +104,6 @@ specification_version: 3
 summary: Offload CarrierWave's image processing and storage to a background process using Delayed Job
 test_files: 
 - spec/spec_helper.rb
+- spec/workers/fixtures/test.jpg
 - spec/workers/process_asset_spec.rb
 - spec/workers/store_asset_spec.rb