carrierwave_backgrounder 0.0.6 → 0.0.7

data/README.md

@@ -1,9 +1,9 @@
-# CarrierWave Backgrounder
+# CarrierWave Backgrounder [![Build Status](https://secure.travis-ci.org/lardawge/carrierwave_backgrounder.png)](http://travis-ci.org/lardawge/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 by disabling processing until a background process initiates it.
-It supports both Delayed Job and Resque.
+It supports Delayed Job, Resque and Girl Friday.
 
 ## Background options
 
@@ -33,6 +33,16 @@ gem 'carrierwave_backgrounder'
 
 ## Getting Started
 
+In your CarrierWave uploader file:
+
+```ruby
+class AvatarUploader < CarrierWave::Uploader::Base
+  include ::CarrierWave::Backgrounder::Delay
+
+  #etc...
+end
+```
+
 ### To use process_in_background
 
 In your model:
@@ -42,6 +52,12 @@ mount_uploader :avatar, AvatarUploader
 process_in_background :avatar
 ```
 
+Optionally you can add a column to the database which will be set to nil when the background processing is complete.
+
+```ruby
+add_column :users, :avatar_processing, :boolean
+```
+
 ### To use store_in_background
 
 In your model:
@@ -57,16 +73,6 @@ Add a column to the model you want to background which will store the temp file
 add_column :users, :avatar_tmp, :string
 ```
 
-In your CarrierWave uploader file:
-
-```ruby
-class AvatarUploader < CarrierWave::Uploader::Base
-  include ::CarrierWave::Backgrounder::DelayStorage
-
-  #ect...
-end
-```
-
 ## Usage Tips
 
 If you need to process/store the upload immediately:
@@ -75,6 +81,13 @@ If you need to process/store the upload immediately:
 @user.process_<column>_upload = true
 ```
 
+To overide the worker in cases where additional methods need to be called or you have app specific requirements, pass the worker class as the
+second argument:
+
+```ruby
+process_in_background :avatar, MyAppsAwesomeProcessingWorker
+```
+
 ## ORM
 
 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:

data/carrierwave_backgrounder.gemspec

@@ -22,4 +22,5 @@ Gem::Specification.new do |s|
 
   s.add_development_dependency "rspec", ["2.5.0"]
   s.add_development_dependency "mocha", ["~> 0.9"]
+  s.add_development_dependency "rake"
 end

data/lib/backgrounder/{delay_storage.rb → delay.rb}

@@ -2,13 +2,20 @@ module CarrierWave
   module Backgrounder
 
     module DelayStorage
+      def self.included(klass)
+        klass.send :include, Delay
+        Logger.warn "Carrierwave::Backgrounder::DelayStorage is deprecated, use Carrierwave::Backgrounder::Delay instead"
+      end
+    end
+    
+    module Delay
 
       ##
-      #Intercept carrierwave#cache_versions! so we can process versions later.
+      # 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
@@ -18,7 +25,7 @@ module CarrierWave
       def proceed_with_versioning?
         !model.respond_to?(:"process_#{mounted_as}_upload") || model.send(:"process_#{mounted_as}_upload")
       end
-    end # DelayStorage
+    end # Delay
     
   end # Backgrounder
 end # CarrierWave

data/lib/backgrounder/orm/data_mapper.rb

@@ -0,0 +1,75 @@
+module CarrierWave
+  module Backgrounder
+    module ORM
+
+      module DataMapper
+        include CarrierWave::Backgrounder::ORM::Base
+
+        def process_in_background(column, worker=::CarrierWave::Workers::ProcessAsset)
+          before :save, :"set_#{column}_processing"
+          after  :save, :"enqueue_#{column}_background_job"
+
+          class_eval  <<-RUBY, __FILE__, __LINE__ + 1
+            attr_accessor :process_#{column}_upload
+            attr_reader :#{column}_changed
+
+            def set_#{column}_processing
+              @#{column}_changed = attribute_dirty?(:#{column})
+              self.#{column}_processing = true if respond_to?(:#{column}_processing) 
+            end
+
+            def enqueue_#{column}_background_job
+              if trigger_#{column}_background_processing?
+                ::Delayed::Job.enqueue #{worker}.new(self.class, id, #{column}.mounted_as) 
+                @#{column}_changed = false
+              end
+            end
+
+            def trigger_#{column}_background_processing?
+              process_#{column}_upload != true && #{column}_changed
+            end
+
+          RUBY
+        end
+
+        def store_in_background(column, worker=::CarrierWave::Workers::StoreAsset)
+          before :save, :"set_#{column}_changed"
+          after :save, :"enqueue_#{column}_background_job"
+
+          class_eval  <<-RUBY, __FILE__, __LINE__ + 1
+            attr_accessor :process_#{column}_upload
+            attr_reader :#{column}_changed
+
+            def set_#{column}_changed
+              @#{column}_changed = attribute_dirty?(:#{column})
+            end
+
+            def write_#{column}_identifier
+              super() and return if process_#{column}_upload
+              self.#{column}_tmp = _mounter(:#{column}).cache_name
+            end
+
+            def store_#{column}!
+              super() if process_#{column}_upload
+            end
+
+            def enqueue_#{column}_background_job
+              if trigger_#{column}_background_storage?
+                ::Delayed::Job.enqueue #{worker}.new(self.class, id, #{column}.mounted_as) 
+                @#{column}_changed = false
+              end
+            end
+
+            def trigger_#{column}_background_storage?
+              process_#{column}_upload != true && #{column}_changed
+            end
+
+          RUBY
+        end
+      end # DataMapper
+
+    end #ORM
+  end #Backgrounder
+end #CarrierWave
+
+DataMapper::Model.append_extensions ::CarrierWave::Backgrounder::ORM::DataMapper

data/lib/backgrounder/orm/mongoid.rb

@@ -0,0 +1,33 @@
+module CarrierWave
+  module Backgrounder
+    module ORM
+
+      module Mongoid
+        include CarrierWave::Backgrounder::ORM::Base
+
+        def process_in_background(column, worker=::CarrierWave::Workers::ProcessAsset)
+          super
+
+          class_eval  <<-RUBY, __FILE__, __LINE__ + 1
+            def trigger_#{column}_background_processing?
+              process_#{column}_upload != true && #{column}_changed?
+            end
+          RUBY
+        end
+
+        def store_in_background(column, worker=::CarrierWave::Workers::StoreAsset)
+          super
+
+          class_eval  <<-RUBY, __FILE__, __LINE__ + 1
+            def trigger_#{column}_background_storage?
+              process_#{column}_upload != true && #{column}_changed?
+            end
+          RUBY
+        end
+      end # ActiveRecord
+
+    end # ORM
+  end # Backgrounder
+end # CarrierWave
+
+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.6"
+    VERSION = "0.0.7"
   end
 end

data/lib/backgrounder/workers/process_asset.rb

@@ -12,13 +12,16 @@ module CarrierWave
       def perform
         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
+
+        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
+          end
         end
       end
-      
+
     end # ProcessAsset
-    
+
   end # Workers
 end # Backgrounder

data/lib/carrierwave_backgrounder.rb

@@ -1,6 +1,9 @@
 module CarrierWave
   module Backgrounder
-    autoload :DelayStorage, 'backgrounder/delay_storage'
+    Logger = Logger.new(STDOUT)
+
+    autoload :Delay, 'backgrounder/delay'
+    autoload :DelayStorage, 'backgrounder/delay'
 
     module ORM
       autoload :Base, 'backgrounder/orm/base'
@@ -12,11 +15,21 @@ 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/activerecord'
           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
+          require 'backgrounder/orm/mongoid' if defined?(Mongoid)
+        end
+
       end
     end
   end

metadata

@@ -1,70 +1,98 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: carrierwave_backgrounder
-version: !ruby/object:Gem::Version 
+version: !ruby/object:Gem::Version
+  version: 0.0.7
   prerelease: 
-  version: 0.0.6
 platform: ruby
-authors: 
+authors:
 - Larry Sprock
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2011-12-07 00:00:00 -08:00
-default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2012-05-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: carrierwave
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  requirement: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        version: "0.5"
+      - !ruby/object:Gem::Version
+        version: '0.5'
   type: :runtime
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: rspec
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  version_requirements: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - "="
-      - !ruby/object:Gem::Version 
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.5'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
         version: 2.5.0
   type: :development
-  version_requirements: *id002
-- !ruby/object:Gem::Dependency 
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.5.0
+- !ruby/object:Gem::Dependency
   name: mocha
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
   prerelease: false
-  requirement: &id003 !ruby/object:Gem::Requirement 
+  version_requirements: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        version: "0.9"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: *id003
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: 
-email: 
+email:
 - larry@lucidbleu.com
 executables: []
-
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
+files:
 - .gitignore
 - .rspec
 - Gemfile
 - README.md
 - Rakefile
 - carrierwave_backgrounder.gemspec
-- lib/backgrounder/delay_storage.rb
+- lib/backgrounder/delay.rb
 - lib/backgrounder/orm/activerecord.rb
 - lib/backgrounder/orm/base.rb
+- lib/backgrounder/orm/data_mapper.rb
+- lib/backgrounder/orm/mongoid.rb
 - lib/backgrounder/version.rb
 - lib/backgrounder/workers.rb
 - lib/backgrounder/workers/process_asset.rb
@@ -74,35 +102,32 @@ files:
 - spec/workers/fixtures/test.jpg
 - spec/workers/process_asset_spec.rb
 - spec/workers/store_asset_spec.rb
-has_rdoc: true
-homepage: ""
+homepage: ''
 licenses: []
-
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      version: "0"
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: carrierwave_backgrounder
-rubygems_version: 1.5.0
+rubygems_version: 1.8.21
 signing_key: 
 specification_version: 3
-summary: Offload CarrierWave's image processing and storage to a background process using Delayed Job
-test_files: 
+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