carrierwave_backgrounder 0.4.2 → 0.4.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: ea7ccc20dfbd12f0d5ca49a22aed4df13af757fe
-  data.tar.gz: 9483744462a3c7de8ec21c01c033fe5c7722c1b7
+SHA256:
+  metadata.gz: c08d7bdb01034545507f0ef13305aa12764e2771148c4ddc22f1291fbba8f7f9
+  data.tar.gz: 21d4f4a1cd200c5b05f9b967d4fda436e7d11752ba6fb6307f619a7b32ae1924
 SHA512:
-  metadata.gz: a9ccbcd89a9f510723a6f512197cc3595ffe4bfa00a9ea21c3c1e6b2530fee1901b47670d1bf0e6e44427d40fd71c83064eab553f09c7e1d0b75cb3283d0291e
-  data.tar.gz: 437d6b11a142e94ae83699672299bf1a3da800846f4465aa557027bb4026970619ee425b6fc63ca7e5e11687a9dfe417c08213ddbc9300ed826a8361a95f6e61
+  metadata.gz: 683938ec5318b2727ae40e177a717fc6135f479f397cbdd39e0b3639a70ff3508ef98406ced8fd203b6d34d4017a84d2a2eab64f164d69bd8d24c64e2ff1786c
+  data.tar.gz: 44b9e651e679fa450dfbe9620e58e5472c0be9bc20bd7f4ce29894de28c30c7f6d5c04f7dd9aa56fc4277bd8d0a3ff0205aa287fb31439e8bfaa5d6158ccbe0b

data/.travis.yml

@@ -1,10 +1,16 @@
 language: ruby
 
 rvm:
- - 1.9.3
- - 2.0.0
+ - 2.3
+ - 2.4
+ - 2.5
+ - 2.6
  - ruby-head
 
+before_install:
+ - yes | gem update --system --force
+ - gem install bundler
+
 matrix:
   allow_failures:
     - rvm: ruby-head

data/CHANGELOG.md

@@ -1,4 +1,10 @@
 
+## 0.4.3
+
+### enhancements
+  * [#307] Add support for Sidekiq 7 [holstvoogd]
+  * [#278] Add sidekiq queue config [IlkhamGaysin]
+
 ## 0.4.2
 
 ### enhancements

data/README.md

@@ -2,7 +2,6 @@
 
 [![Build Status](https://secure.travis-ci.org/lardawge/carrierwave_backgrounder.png)](http://travis-ci.org/lardawge/carrierwave_backgrounder)
 [![Code Climate](https://codeclimate.com/github/lardawge/carrierwave_backgrounder.png)](https://codeclimate.com/github/lardawge/carrierwave_backgrounder)
-[![Still Maintained](http://stillmaintained.com/lardawge/carrierwave_backgrounder.png)](http://stillmaintained.com/lardawge/carrierwave_backgrounder)
 
 I like CarrierWave. That being said, I don't like tying up app instances waiting for images to process.
 
@@ -55,6 +54,14 @@ CarrierWave::Backgrounder.configure do |c|
 end
 ```
 
+**IMPORTANT FOR SIDEKIQ BACKEND** - Custom queue should be defined inside the Sidekiq configuration otherwise jobs won't be processed:
+
+```yml
+:queues:
+  - [awesome_queue, 1]
+  - default
+```
+
 In your CarrierWave uploader file:
 
 ```ruby
@@ -135,9 +142,36 @@ class MyParanoidWorker < ::CarrierWave::Workers::ProcessAsset
   # other hooks you might care about
 end
 ```
+
+### ActiveJob
+Use overriden worker that inherits from ActiveJob::Base and includes relevant worker mixin:
+```ruby
+class MyActiveJobWorker < ActiveJob::Base
+  include ::CarrierWave::Workers::ProcessAssetMixin
+  # ... or include ::CarrierWave::Workers::StoreAssetMixin
+
+  after_perform do
+    # your code here
+  end
+
+  # Sometimes job gets performed before the file is uploaded and ready.
+  # You can define how to handle that case by overriding `when_not_ready` method
+  # (by default it does nothing)
+  def when_not_ready
+    retry_job
+  end
+end
+```
+Don't forget to set `active_job` as a backend in the config:
+```ruby
+CarrierWave::Backgrounder.configure do |c|
+  c.backend :active_job, queue: :carrierwave
+end
+```
+
 ### Testing with Rspec
 We use the after_commit hook when using active_record. This creates a problem when testing with Rspec because after_commit never gets fired
-if you're using trasactional fixtures. One solution to the problem is to use the [TestAfterCommit gem](https://github.com/grosser/test_after_commit).
+if you're using transactional fixtures. One solution to the problem is to use the [TestAfterCommit gem](https://github.com/grosser/test_after_commit).
 There are various other solutions in which case google is your friend.
 
 ### Uploaders mounted on mongoid embedded documents

data/carrierwave_backgrounder.gemspec

@@ -17,8 +17,8 @@ Gem::Specification.new do |s|
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   s.require_paths = ["lib"]
 
-  s.add_dependency "carrierwave", ["~> 0.5"]
+  s.add_dependency "carrierwave", [">= 0.5", "< 2.2"]
 
-  s.add_development_dependency "rspec", ["~> 3.1.0"]
+  s.add_development_dependency "rspec", ["~> 3.10.0"]
   s.add_development_dependency "rake"
 end

data/lib/backgrounder/orm/base.rb

@@ -82,7 +82,7 @@ module CarrierWave
 
             def write_#{column}_identifier
               super and return if process_#{column}_upload
-              self.#{column}_tmp = _mounter(:#{column}).cache_name if _mounter(:#{column}).cache_name
+              self.#{column}_tmp = #{column}_cache if #{column}_cache
             end
 
             def store_#{column}!

data/lib/backgrounder/orm/data_mapper.rb

@@ -26,7 +26,7 @@ module CarrierWave
 
             def write_#{column}_identifier
               super and return if process_#{column}_upload
-              self.#{column}_tmp = _mounter(:#{column}).cache_name
+              self.#{column}_tmp = #{column}_cache
             end
           RUBY
         end

data/lib/backgrounder/support/backends.rb

@@ -22,6 +22,10 @@ module CarrierWave
 
           private
 
+          def enqueue_active_job(worker, *args)
+            worker.perform_later(*args.map(&:to_s))
+          end
+
           def enqueue_delayed_job(worker, *args)
             worker_args = {}
             if ::Delayed::Job.new.respond_to?(:queue)
@@ -44,7 +48,7 @@ module CarrierWave
 
           def enqueue_sidekiq(worker, *args)
             override_queue_name = worker.sidekiq_options['queue'] == 'default' || worker.sidekiq_options['queue'].nil?
-            args = sidekiq_queue_options(override_queue_name, 'class' => worker, 'args' => args)
+            args = sidekiq_queue_options(override_queue_name, 'class' => worker, 'args' => args.map(&:to_s))
             worker.client_push(args)
           end
 

data/lib/backgrounder/version.rb

@@ -1,5 +1,5 @@
 module CarrierWave
   module Backgrounder
-    VERSION = "0.4.2"
+    VERSION = "0.4.3"
   end
 end

data/lib/backgrounder/workers/base.rb

@@ -1,14 +1,18 @@
+# encoding: utf-8
 module CarrierWave
   module Workers
-    class Base < Struct.new(:klass, :id, :column)
 
-      def self.perform(*args)
-        new(*args).perform
+    module Base
+      attr_accessor :klass, :id, :column, :record
+
+      def initialize(*args)
+        super(*args) unless self.class.superclass == Object
+        set_args(*args) if args.present?
       end
 
       def perform(*args)
         set_args(*args) if args.present?
-        constantized_resource.find id
+        self.record = constantized_resource.find id
       rescue *not_found_errors
       end
 
@@ -29,6 +33,10 @@ module CarrierWave
         klass.is_a?(String) ? klass.constantize : klass
       end
 
-    end
-  end
-end
+      def when_not_ready
+      end
+
+    end # Base
+
+  end # Workers
+end # CarrierWave

data/lib/backgrounder/workers/class_methods.rb

@@ -0,0 +1,14 @@
+# encoding: utf-8
+module CarrierWave
+  module Workers
+
+    module ClassMethods
+
+      def perform(*args)
+        new(*args).perform
+      end
+
+    end # ClassMethods
+
+  end # Workers
+end # Backgrounder

data/lib/backgrounder/workers/process_asset.rb

@@ -2,19 +2,8 @@
 module CarrierWave
   module Workers
 
-    class ProcessAsset < Base
-
-      def perform(*args)
-        record = super(*args)
-
-        if record && record.send(:"#{column}").present?
-          record.send(:"process_#{column}_upload=", true)
-          if record.send(:"#{column}").recreate_versions! && record.respond_to?(:"#{column}_processing")
-            record.update_attribute :"#{column}_processing", false
-          end
-        end
-      end
-
+    class ProcessAsset
+      include CarrierWave::Workers::ProcessAssetMixin
     end # ProcessAsset
 
   end # Workers

data/lib/backgrounder/workers/process_asset_mixin.rb

@@ -0,0 +1,28 @@
+# encoding: utf-8
+module CarrierWave
+  module Workers
+
+    module ProcessAssetMixin
+      include CarrierWave::Workers::Base
+
+      def self.included(base)
+        base.extend CarrierWave::Workers::ClassMethods
+      end
+
+      def perform(*args)
+        record = super(*args)
+
+        if record && record.send(:"#{column}").present?
+          record.send(:"process_#{column}_upload=", true)
+          if record.send(:"#{column}").recreate_versions! && record.respond_to?(:"#{column}_processing")
+            record.update_attribute :"#{column}_processing", false
+          end
+        else
+          when_not_ready
+        end
+      end
+
+    end # ProcessAssetMixin
+
+  end # Workers
+end # Backgrounder

data/lib/backgrounder/workers/store_asset.rb

@@ -2,32 +2,8 @@
 module CarrierWave
   module Workers
 
-    class StoreAsset < Base
-      attr_reader :cache_path, :tmp_directory
-
-      def perform(*args)
-        record = super(*args)
-
-        if record && record.send(:"#{column}_tmp")
-          store_directories(record)
-          record.send :"process_#{column}_upload=", true
-          record.send :"#{column}_tmp=", nil
-          record.send :"#{column}_processing=", false if record.respond_to?(:"#{column}_processing")
-          File.open(cache_path) { |f| record.send :"#{column}=", f }
-          if record.save!
-            FileUtils.rm_r(tmp_directory, :force => true)
-          end
-        end
-      end
-
-      private
-
-      def store_directories(record)
-        asset, asset_tmp = record.send(:"#{column}"), record.send(:"#{column}_tmp")
-        cache_directory  = File.expand_path(asset.cache_dir, asset.root)
-        @cache_path      = File.join(cache_directory, asset_tmp)
-        @tmp_directory   = File.join(cache_directory, asset_tmp.split("/").first)
-      end
+    class StoreAsset
+      include CarrierWave::Workers::StoreAssetMixin
     end # StoreAsset
 
   end # Workers

data/lib/backgrounder/workers/store_asset_mixin.rb

@@ -0,0 +1,43 @@
+# encoding: utf-8
+module CarrierWave
+  module Workers
+
+    module StoreAssetMixin
+      include CarrierWave::Workers::Base
+
+      def self.included(base)
+        base.extend CarrierWave::Workers::ClassMethods
+      end
+
+      attr_reader :cache_path, :tmp_directory
+
+      def perform(*args)
+        record = super(*args)
+
+        if record && record.send(:"#{column}_tmp")
+          store_directories(record)
+          record.send :"process_#{column}_upload=", true
+          record.send :"#{column}_tmp=", nil
+          record.send :"#{column}_processing=", false if record.respond_to?(:"#{column}_processing")
+          File.open(cache_path) { |f| record.send :"#{column}=", f }
+          if record.save!
+            FileUtils.rm_r(tmp_directory, :force => true)
+          end
+        else
+          when_not_ready
+        end
+      end
+
+      private
+
+      def store_directories(record)
+        asset, asset_tmp = record.send(:"#{column}"), record.send(:"#{column}_tmp")
+        cache_directory  = File.expand_path(asset.cache_dir, asset.root)
+        @cache_path      = File.join(cache_directory, asset_tmp)
+        @tmp_directory   = File.join(cache_directory, asset_tmp.split("/").first)
+      end
+
+    end # StoreAssetMixin
+
+  end # Workers
+end # Backgrounder

data/lib/backgrounder/workers.rb

@@ -1,3 +1,6 @@
 require 'backgrounder/workers/base'
+require 'backgrounder/workers/class_methods'
+require 'backgrounder/workers/process_asset_mixin'
+require 'backgrounder/workers/store_asset_mixin'
 require 'backgrounder/workers/process_asset'
 require 'backgrounder/workers/store_asset'

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

@@ -1,5 +1,6 @@
 CarrierWave::Backgrounder.configure do |c|
   c.backend :delayed_job, queue: :carrierwave
+  # c.backend :active_job, queue: :carrierwave
   # c.backend :resque, queue: :carrierwave
   # c.backend :sidekiq, queue: :carrierwave
   # c.backend :girl_friday, queue: :carrierwave

data/spec/backgrounder/support/backends_spec.rb

@@ -31,6 +31,16 @@ module CarrierWave::Backgrounder
     describe '#enqueue_for_backend' do
       let!(:worker) { MockWorker.new('FakeClass', 1, :image) }
 
+      context 'active_job' do
+        let(:args) { ['FakeClass', 1, :image] }
+
+        it 'invokes perform_later with string arguments' do
+          expect(MockWorker).to receive(:perform_later).with('FakeClass', '1', 'image')
+          mock_module.backend :active_job
+          mock_module.enqueue_for_backend(MockWorker, *args)
+        end
+      end
+
       context 'delayed_job' do
         before do
           @mock_worker = Class.new do
@@ -112,7 +122,7 @@ module CarrierWave::Backgrounder
         let(:args) { ['FakeClass', 1, :image] }
 
         it 'invokes client_push on the class with passed args' do
-          expect(MockSidekiqWorker).to receive(:client_push).with({ 'class' => MockSidekiqWorker, 'args' => args })
+          expect(MockSidekiqWorker).to receive(:client_push).with({ 'class' => MockSidekiqWorker, 'args' => args.map(&:to_s) })
           mock_module.backend :sidekiq
           mock_module.enqueue_for_backend(MockSidekiqWorker, *args)
         end
@@ -122,7 +132,7 @@ module CarrierWave::Backgrounder
                                                                     'retry' => false,
                                                                     'timeout' => 60,
                                                                     'queue' => :awesome_queue,
-                                                                    'args' => args })
+                                                                    'args' => args.map(&:to_s) })
           options = {:retry => false, :timeout => 60, :queue => :awesome_queue}
           mock_module.backend :sidekiq, options
           mock_module.enqueue_for_backend(MockSidekiqWorker, *args)
@@ -132,7 +142,7 @@ module CarrierWave::Backgrounder
           expect(MockNamedSidekiqWorker).to receive(:client_push).with({ 'class' => MockNamedSidekiqWorker,
                                                                     'retry' => false,
                                                                     'timeout' => 60,
-                                                                    'args' => args })
+                                                                    'args' => args.map(&:to_s) })
           options = {:retry => false, :timeout => 60}
           mock_module.backend :sidekiq, options
           mock_module.enqueue_for_backend(MockNamedSidekiqWorker, *args)

metadata

@@ -1,43 +1,49 @@
 --- !ruby/object:Gem::Specification
 name: carrierwave_backgrounder
 version: !ruby/object:Gem::Version
-  version: 0.4.2
+  version: 0.4.3
 platform: ruby
 authors:
 - Larry Sprock
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2015-08-26 00:00:00.000000000 Z
+date: 2023-07-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: carrierwave
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0.5'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0.5'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.2'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.1.0
+        version: 3.10.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.1.0
+        version: 3.10.0
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -52,7 +58,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: 
+description:
 email:
 - larry@lucidbleu.com
 executables: []
@@ -76,8 +82,11 @@ files:
 - lib/backgrounder/version.rb
 - lib/backgrounder/workers.rb
 - lib/backgrounder/workers/base.rb
+- lib/backgrounder/workers/class_methods.rb
 - lib/backgrounder/workers/process_asset.rb
+- lib/backgrounder/workers/process_asset_mixin.rb
 - lib/backgrounder/workers/store_asset.rb
+- lib/backgrounder/workers/store_asset_mixin.rb
 - lib/carrierwave_backgrounder.rb
 - lib/generators/carrierwave_backgrounder/USAGE
 - lib/generators/carrierwave_backgrounder/install_generator.rb
@@ -95,7 +104,7 @@ homepage: https://github.com/lardawge/carrierwave_backgrounder
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -110,9 +119,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.2.2
-signing_key: 
+rubygems_version: 3.1.6
+signing_key:
 specification_version: 4
 summary: Offload CarrierWave's image processing and storage to a background process
   using Delayed Job, Resque, Sidekiq, Qu, Queue Classic or Girl Friday