carrierwave_backgrounder 0.1.1 → 0.1.2

data/CHANGELOG.md

@@ -0,0 +1,30 @@
+## 0.1.2
+
+### enhancements
+  * Add a rails generator to generate the config file.
+```bash
+  rails g carrierwave_backgrounder:install
+```
+
+### bug fixes
+  * Check [column]_cache to make sure we are processessing when a form fails and [column]_cache is used.
+
+## 0.1.1
+
+### enhancements
+  * Allow passing of all options to sidekiq in config file.
+
+### bug fixes
+  * Revert where sidekiq was broken due to Sidekiq::Worker not properly being included.
+
+## 0.1.0
+
+### enhancements
+  * Add support to pass options to backends allowing queue names to be set in the initializer.
+  * Make threadsafe. [gitt]
+  * Add support to immediately process jobs if :immediate is set in config backend. [Antiarchitect]
+
+### bug fixes
+  * Girl Friday incorrectly referenses class #92
+  * Add documentation for testing with rspec #84.
+

data/README.md

@@ -2,7 +2,7 @@
 
 I like CarrierWave. That being said, I don't like tying up app instances waiting for images to process.
 
-This gem addresses that moving processing or storage/processing to a background task.
+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.
 
 ## Background options
@@ -38,27 +38,12 @@ In Rails, add the following your Gemfile:
 gem 'carrierwave_backgrounder'
 ```
 
-### Setup
-
-In an initializer:
-
-```ruby
-CarrierWave::Backgrounder.configure do |c|
-  # :delayed_job, :girl_friday, :sidekiq, :qu, :resque, or :qc
-  c.backend :delayed_job 
-end
-```
-
-If you would like to use a custom queue name for Delayed Job, Resque, Girl Friday, Sidekiq and Qu pass in the following option.
-The queue name will default to carrierwave.
-
-```ruby
-CarrierWave::Backgrounder.configure do |c|
-  c.backend :delayed_job, queue: :awesome_queue 
-end
+Run the generator which will create an initializer in config/initializers.
+```bash
+  rails g carrierwave_backgrounder:install
 ```
 
-You can also pass additional configuration options to Girl Friday
+You can pass additional configuration options to Girl Friday and Sidekiq:
 
 ```ruby
 CarrierWave::Backgrounder.configure do |c|

data/lib/backgrounder/orm/activemodel.rb

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

data/lib/backgrounder/version.rb

@@ -1,5 +1,5 @@
 module CarrierWave
   module Backgrounder
-    VERSION = "0.1.1"
+    VERSION = "0.1.2"
   end
 end

data/lib/backgrounder/workers/process_asset.rb

@@ -3,10 +3,7 @@ module CarrierWave
   module Workers
 
     class ProcessAsset < Struct.new(:klass, :id, :column)
-
-      if defined?(::Sidekiq)
-        include ::Sidekiq::Worker
-      end
+      include ::Sidekiq::Worker if defined?(::Sidekiq)
 
       def self.perform(*args)
         new(*args).perform

data/lib/backgrounder/workers/store_asset.rb

@@ -3,11 +3,7 @@ module CarrierWave
   module Workers
 
     class StoreAsset < Struct.new(:klass, :id, :column)
-      if defined?(::Sidekiq)
-        include ::Sidekiq::Worker
-
-        sidekiq_options :queue => @queue
-      end
+      include ::Sidekiq::Worker if defined?(::Sidekiq)
 
       def self.perform(*args)
         new(*args).perform

data/lib/generators/carrierwave_backgrounder/USAGE

@@ -0,0 +1,8 @@
+Description:
+    To copy CarrierWaveBackgrounder initializer to your Rails App, with some configuration values, run the following:
+
+Example:
+    rails generate carrierwave_backgrounder:install
+
+    This will create:
+        config/initializer/carrierwave_backgrounder.rb

data/lib/generators/carrierwave_backgrounder/install_generator.rb

@@ -0,0 +1,20 @@
+module CarrierwaveBackgrounder
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      source_root File.expand_path('../templates', __FILE__)
+
+      def copy_config
+        template "config/initializers/carrierwave_backgrounder.rb"
+      end
+
+      def info_config
+        puts <<-EOF
+
+        \e[33mBy default :delayed_job is used as the backend for carrierwave_backgrounder with :carrierwave as the queue name.
+        To change this, edit config/initializers/carrierwave_backgrounder.rb.\e[0m
+
+        EOF
+      end
+    end
+  end
+end

data/lib/generators/carrierwave_backgrounder/templates/config/initializers/carrierwave_backgrounder.rb

@@ -0,0 +1,8 @@
+CarrierWave::Backgrounder.configure do |c|
+  c.backend :delayed_job, queue: :carrierwave
+  # c.backend :resque, queue: :carrierwave
+  # c.backend :sidekiq, queue: :carrierwave
+  # c.backend :girl_friday, queue: :carrierwave
+  # c.backend :qu, queue: :carrierwave
+  # c.backend :qc
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: carrierwave_backgrounder
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-12-13 00:00:00.000000000 Z
+date: 2012-12-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: carrierwave
@@ -84,6 +84,7 @@ extra_rdoc_files: []
 files:
 - .gitignore
 - .rspec
+- CHANGELOG.md
 - Gemfile
 - README.md
 - Rakefile
@@ -98,6 +99,9 @@ files:
 - lib/backgrounder/workers/process_asset.rb
 - lib/backgrounder/workers/store_asset.rb
 - lib/carrierwave_backgrounder.rb
+- lib/generators/carrierwave_backgrounder/USAGE
+- lib/generators/carrierwave_backgrounder/install_generator.rb
+- lib/generators/carrierwave_backgrounder/templates/config/initializers/carrierwave_backgrounder.rb
 - spec/backgrounder/orm/activemodel_spec.rb
 - spec/backgrounder/orm/base_spec.rb
 - spec/backgrounder/support/backends_spec.rb
@@ -120,7 +124,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -4115860577896091097
+      hash: -4429973419830496543
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -129,7 +133,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -4115860577896091097
+      hash: -4429973419830496543
 requirements: []
 rubyforge_project: carrierwave_backgrounder
 rubygems_version: 1.8.24