carrierwave_backgrounder 1.0.2 → 1.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9db3ebd17e2fba8538ee90f3f451f6d37738a9d833bc5ac9f6f8123a3f7a214a
-  data.tar.gz: 3ef48ab1f8ac80b9ea3e374fd4806b769927baec00cc8c6d7a19b9340cebe906
+  metadata.gz: 5261f9e14c16c978b41ba71d0074359b5ec321d0ee7e3b410685e770f246fb87
+  data.tar.gz: 105e8b097e25d084f33d75e1556c3227aa6b758e5045315ce893fe2f0cda086b
 SHA512:
-  metadata.gz: 67965fc212f3fa08aa5936815b63a63215550780e2150759d6dc8d87683ca7be2d5614f8d7ba9b93a22e4c1537e6db9fcffb938649708e2e42508bb868835062
-  data.tar.gz: 20c1a3d50441f061701e8ada2af4b2b26706794496f71fa707ff865338358c834ede9de39369e2448b39c149a9cfb6f8528f8a7daa126c3f51a4e7bc1767fe81
+  metadata.gz: 2c9a5084377b753246a7be2c3d5f087c24b524c0f821b8a3375047512f766d0c0ca8a876e826a93bec2a389394e9e892c6e727ef11854c2e247721b4640ae8e0
+  data.tar.gz: 3d1d565d67a68c651b56a5eed01e10fa5a50e69a5b6b8880ee88daaa2507eda01eba2015732455ab64de8e5cb267d8f7640048e96649586c28fe04058f51cb2e

data/.github/workflows/ruby-ci.yml

@@ -0,0 +1,43 @@
+name: Ruby CI
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    branches: [ main ]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby: ['3.2', '3.4', 'ruby-head']
+        queue_adapter: ['sidekiq', 'active_job']
+    continue-on-error: ${{ matrix.ruby == 'ruby-head' }}
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Install ImageMagick
+        run: sudo apt-get update && sudo apt-get install -y imagemagick
+
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+          bundler-cache: true
+
+      - name: Update RubyGems
+        run: yes | gem update --system --force
+
+      - name: Install Bundler
+        run: gem install bundler
+
+      - name: Set QUEUE_ADAPTER env
+        run: echo "QUEUE_ADAPTER=${{ matrix.queue_adapter }}" >> $GITHUB_ENV
+
+      - name: Install dependencies
+        run: bundle install --jobs 4 --retry 3
+
+      - name: Run tests
+        run: bundle exec rake

data/.gitignore

@@ -4,3 +4,5 @@
 Gemfile.lock
 pkg/*
 vendor/*
+spec/support/dummy_app/log/*
+spec/support/dummy_app/tmp/*

data/CHANGELOG.md

@@ -1,3 +1,18 @@
+## 1.1.2
+
+### enhancements
+  * Add support for Rails 8.1 [gstokkink]
+
+## 1.1.0
+
+### enhancements
+  * Suppress NotFoundError if a record gets deleted before it is processed. This is configurable and defaults to true. [lardawge]
+
+## 1.0.3
+
+### enhancements
+  * Add support for Rails 8.0 [damisul]
+
 ## 1.0.2
 
 ### bugfixes

data/README.md

@@ -1,13 +1,11 @@
 # CarrierWave Backgrounder
 
-[![Build Status](https://app.travis-ci.com/lardawge/carrierwave_backgrounder.svg?branch=master)](https://app.travis-ci.com/lardawge/carrierwave_backgrounder)
-[![Code Climate](https://codeclimate.com/github/lardawge/carrierwave_backgrounder.png)](https://codeclimate.com/github/lardawge/carrierwave_backgrounder)
-
-NOTICE: Version 1.0.0 contains breaking changes if you are coming from an earlier version.
-The most notible change is the removal of queue backend options other than active_job and sidekiq.
-If you are using other backends, switch over to active_job which should support your preference.
-If you are using Sidekiq, there is nothing to change.
+[![Build Status](https://github.com/lardawge/carrierwave_backgrounder/actions/workflows/ruby-ci.yml/badge.svg)](https://github.com/lardawge/carrierwave_backgrounder/actions/workflows/ruby-ci.yml)
+[![Maintainability](https://qlty.sh/gh/lardawge/projects/carrierwave_backgrounder/maintainability.svg)](https://qlty.sh/gh/lardawge/projects/carrierwave_backgrounder)
+---
+NOTICE: Version 1.1.0 contains a change in behavior from previous version. When a record is deleted before the job is picked up, it will no longer raise an error. Prior to this change, when using `process_in_background`, if a record was missing, an error was raised. Some users might have relied on that. By default, this will no longer happen. If you want to maintain that behavior, you must set the `suppress_record_not_found_errors` configuration to `false`. This will raise a RecordNotFound error.
 
+---
 I am a fan of CarrierWave. That being said, I don't like tying up requests waiting for images to process.
 
 This gem addresses that by offloading processing or storaging/processing to a background task.
@@ -190,11 +188,6 @@ class MyActiveJobWorker < ::CarrierWave::Workers::ActiveJob::StoreAsset
 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 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.
-
 ## License
 
 Copyright (c) 2011 Larry Sprock

data/carrierwave_backgrounder.gemspec

@@ -6,19 +6,22 @@ Gem::Specification.new do |s|
   s.name        = "carrierwave_backgrounder"
   s.version     = CarrierWave::Backgrounder::VERSION
   s.platform    = Gem::Platform::RUBY
+
   s.authors     = ["Larry Sprock"]
   s.email       = ["larry@lucidbleu.com"]
   s.homepage    = "https://github.com/lardawge/carrierwave_backgrounder"
   s.licenses    = ["MIT"]
-  s.summary     = %q{Offload CarrierWave's image processing and storage to a background process using Delayed Job, Resque, Sidekiq, Qu, Queue Classic or Girl Friday}
+  s.summary     = %q{Offload CarrierWave's image processing and storage to a background process using ActiveJob or Sidekiq.}
 
   s.files         = `git ls-files`.split("\n")
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   s.require_paths = ["lib"]
 
+  s.required_ruby_version = '>= 3.0'
+
   s.add_dependency "carrierwave", ["> 2.0", "< 4.0"]
-  s.add_dependency "rails", ["> 6.0", "< 8.0"]
+  s.add_dependency "rails", ["> 6.0", "< 8.2"]
 
   s.add_development_dependency "rspec", ["~> 3.12"]
   s.add_development_dependency "rake"

data/lib/backgrounder/support/backends.rb

@@ -10,10 +10,10 @@ module CarrierWave
         module ClassMethods
           attr_reader :queue_options
 
-          def backend(queue_name=nil, args={})
+          def backend(backend_name=nil, args={})
             return @backend if @backend
-            @queue_options = args
-            @backend = queue_name
+            @queue_options = set_queue_name_default(args)
+            @backend = backend_name
           end
 
           def enqueue_for_backend(worker, class_name, subject_id, mounted_as)
@@ -23,17 +23,29 @@ module CarrierWave
           private
 
           def enqueue_active_job(worker, *args)
-            worker.perform_later(*args.map(&:to_s))
+            options = if worker.new.queue_name != 'default'
+              queue_options.except(:queue)
+            else
+              queue_options
+            end
+
+            worker.set(options).perform_later(*args.map(&:to_s))
           end
 
           def enqueue_sidekiq(worker, *args)
-            override_queue_name = worker.sidekiq_options['queue'] == 'default' || worker.sidekiq_options['queue'].nil?
+            override_queue_name = worker.sidekiq_options['queue'] == 'default'
             args = sidekiq_queue_options(override_queue_name, 'class' => worker, 'args' => args.map(&:to_s))
             worker.client_push(args)
           end
 
           private
 
+          def set_queue_name_default(options)
+            options.tap do |opts|
+              opts[:queue] ||= :carrierwave
+            end
+          end
+
           def sidekiq_queue_options(override_queue_name, args)
             if override_queue_name && queue_options[:queue]
               args['queue'] = queue_options[:queue]

data/lib/backgrounder/version.rb

@@ -1,5 +1,5 @@
 module CarrierWave
   module Backgrounder
-    VERSION = "1.0.2"
+    VERSION = "1.1.2"
   end
 end

data/lib/backgrounder/workers/base.rb

@@ -14,12 +14,13 @@ module CarrierWave
         set_args(*args) if args.present?
         self.record = constantized_resource.find id
       rescue *not_found_errors
+        raise not_found_errors.first unless CarrierWave::Backgrounder.suppress_not_found_errors
       end
 
       private
 
       def not_found_errors
-        [].tap do |errors|
+        @not_found_errors ||= [].tap do |errors|
           errors << ::ActiveRecord::RecordNotFound      if defined?(::ActiveRecord)
           errors << ::Mongoid::Errors::DocumentNotFound if defined?(::Mongoid)
         end

data/lib/backgrounder/workers/process_asset_mixin.rb

@@ -11,6 +11,9 @@ module CarrierWave
 
       def perform(*args)
         record = super(*args)
+
+        return unless record
+
         record.send(:"process_#{column}_upload=", true)
         asset = record.send(:"#{column}")
 

data/lib/carrierwave_backgrounder.rb

@@ -9,32 +9,22 @@ module CarrierWave
     include Support::Backends
 
     class << self
-      attr_reader :worker_klass
+      attr_reader :worker_klass, :suppress_not_found_errors
     end
 
     def self.configure
       yield self
 
+      @suppress_not_found_errors ||= true
+
       case backend
       when :active_job
         @worker_klass = 'CarrierWave::Workers::ActiveJob'
-
-        require 'active_job'
         require 'backgrounder/workers/active_job/process_asset'
         require 'backgrounder/workers/active_job/store_asset'
-
-        queue_name = queue_options[:queue] || 'carrierwave'
-
-        ::CarrierWave::Workers::ActiveJob::ProcessAsset.class_eval do
-          queue_as queue_name
-        end
-        ::CarrierWave::Workers::ActiveJob::StoreAsset.class_eval do
-          queue_as queue_name
-        end
       when :sidekiq
         @worker_klass = 'CarrierWave::Workers'
 
-        require 'sidekiq'
         ::CarrierWave::Workers::ProcessAsset.class_eval do
           include ::Sidekiq::Worker
         end
@@ -43,6 +33,10 @@ module CarrierWave
         end
       end
     end
+
+    def self.suppress_record_not_found_errors(suppress_errors = true)
+      @suppress_not_found_errors = suppress_errors
+    end
   end
 end
 

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

@@ -1,4 +1,7 @@
 CarrierWave::Backgrounder.configure do |c|
   c.backend :active_job, queue: :carrierwave
   # c.backend :sidekiq, queue: :carrierwave
+
+  ## Uncomment if you would like a NotFoundError raised if a record is deleted before processing
+  # c.suppress_record_not_found_errors false
 end

data/spec/backgrounder/orm/activemodel_spec.rb

@@ -1,5 +1,4 @@
 require 'spec_helper'
-require 'ostruct'
 require 'backgrounder/orm/activemodel'
 
 RSpec.describe CarrierWave::Backgrounder::ORM::ActiveModel do
@@ -9,7 +8,7 @@ RSpec.describe CarrierWave::Backgrounder::ORM::ActiveModel do
       def self.after_commit(method, opts); nil; end
       def avatar_changed?; nil;  end
       def avatar_present?; true; end
-      def remote_avatar_url; OpenStruct.new(:present? => true); end
+      def remote_avatar_url; true; end
       def remove_avatar?; false; end
       def previous_changes; {}; end
       def self.uploader_options; {}; end

data/spec/backgrounder/support/backends_spec.rb

@@ -44,7 +44,9 @@ 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.map(&:to_s) })
+          expect(MockSidekiqWorker).to receive(:client_push).with({ 'class' => MockSidekiqWorker,
+                                                                    'args' => args.map(&:to_s),
+                                                                    'queue' => :carrierwave  })
           mock_module.backend :sidekiq
           mock_module.enqueue_for_backend(MockSidekiqWorker, *args)
         end

data/spec/integrations/process_in_background_spec.rb

@@ -22,6 +22,35 @@ RSpec.describe '::process_in_background', clear_images: true do
     end
   end
 
+  context 'when a record gets deleted before it is processed' do
+    context 'and suppress_record_not_found_errors is set to true' do
+      before do
+        admin.update(avatar: load_file('test-1.jpg'))
+      end
+
+      it 'does not raise an error' do
+        admin.delete
+        expect { process_latest_sidekiq_job }.not_to raise_error
+      end
+    end
+
+    context 'and suppress_record_not_found_errors is set to false' do
+      before do
+        admin.update(avatar: load_file('test-1.jpg'))
+        CarrierWave::Backgrounder.suppress_record_not_found_errors(false)
+      end
+
+      after do
+        CarrierWave::Backgrounder.suppress_record_not_found_errors(true)
+      end
+
+      it 'raises an error' do
+        admin.delete
+        expect { process_latest_sidekiq_job }.to raise_error(ActiveRecord::RecordNotFound)
+      end
+    end
+  end
+
   context 'when processing the worker' do
     before do
       admin.update(avatar: load_file('test-1.jpg'))

data/spec/integrations/queue_name_spec.rb

@@ -0,0 +1,68 @@
+require 'rails_helper'
+
+RSpec.describe 'Queue Name', clear_images: true do
+  let(:user) { User.new }
+
+  context 'when using built in worker' do
+    context 'when queue name is passed in via config' do
+      before do
+        CarrierWave::Backgrounder.instance_variable_set(:@queue_options, queue: 'carrierwaver')
+      end
+
+      after do
+        CarrierWave::Backgrounder.instance_variable_set(:@queue_options, queue: 'carrierwave')
+      end
+
+      it 'uses the config queue name' do
+        user.update(avatar: load_file('test-1.jpg'))
+        expect(Sidekiq::Queues["carrierwaver"].size).to eql(1)
+      end
+    end
+
+    context 'when not queue name is not set' do
+      it 'uses the default name carrierwave' do
+        user.update(avatar: load_file('test-1.jpg'))
+        expect(Sidekiq::Queues["carrierwave"].size).to eql(1)
+      end
+    end
+  end
+
+  context 'when using a subclassed worker' do
+    context 'when queue name is passed in via config' do
+      before do
+        CarrierWave::Backgrounder.instance_variable_set(:@queue_options, queue: 'carrierwaver')
+      end
+
+      after do
+        CarrierWave::Backgrounder.instance_variable_set(:@queue_options, queue: 'carrierwave')
+      end
+
+      it 'uses the config queue name' do
+        user.update(portrait: load_file('test-1.jpg'))
+        expect(Sidekiq::Queues["carrierwaver"].size).to eql(1)
+      end
+    end
+
+    context 'when not queue name is not set' do
+      it 'uses the default name carrierwave' do
+        user.update(portrait: load_file('test-1.jpg'))
+        expect(Sidekiq::Queues["carrierwave"].size).to eql(1)
+      end
+    end
+
+    context 'when overridden via subclassed worker' do
+      before do
+        PortraitProcessJob.queue_as :custom_queue
+      end
+
+      after do
+        PortraitProcessJob.queue_as :carrierwave
+      end
+
+      it 'uses the queue name passed in' do
+        user.update(portrait: load_file('test-1.jpg'))
+        expect(Sidekiq::Queues["custom_queue"].size).to eql(1)
+      end
+    end
+  end
+end

data/spec/integrations/store_in_background_spec.rb

@@ -31,6 +31,11 @@ RSpec.describe '::store_in_background', clear_images: true do
       user.reload
     end
 
+    it 'processes the original image' do
+      image = MiniMagick::Image.open(user.avatar.path)
+      expect(image.width).to eql(1960)
+    end
+
     it 'creates the versions' do
       version_paths = user.avatar.versions.keys.map { |key| user.avatar.send(key).current_path }
       version_paths.each { |path| expect(File.exist?(path)).to be(true) }
@@ -63,6 +68,35 @@ RSpec.describe '::store_in_background', clear_images: true do
     end
   end
 
+  context 'when a record gets deleted before it is processed' do
+    context 'and suppress_record_not_found_errors is set to true' do
+      before do
+        user.update(avatar: load_file('test-1.jpg'))
+      end
+
+      it 'does not raise an error' do
+        user.delete
+        expect { process_latest_sidekiq_job }.not_to raise_error
+      end
+    end
+
+    context 'and suppress_record_not_found_errors is set to false' do
+      before do
+        user.update(avatar: load_file('test-1.jpg'))
+        CarrierWave::Backgrounder.suppress_record_not_found_errors(false)
+      end
+
+      after do
+        CarrierWave::Backgrounder.suppress_record_not_found_errors(true)
+      end
+
+      it 'raises an error' do
+        user.delete
+        expect { process_latest_sidekiq_job }.to raise_error(ActiveRecord::RecordNotFound)
+      end
+    end
+  end
+
   context 'when setting a column for removal' do
     let!(:user) {
       Sidekiq::Testing.inline! do

data/spec/rails_helper.rb

@@ -7,6 +7,19 @@ require 'sidekiq/testing'
 require 'rspec/rails'
 require 'backgrounder/railtie'
 
+if ENV['QUEUE_ADAPTER'] == 'sidekiq'
+  Object.send(:remove_const, :PortraitProcessJob) if defined?(PortraitProcessJob)
+  class PortraitProcessJob
+    include CarrierWave::Workers::ProcessAssetMixin
+    include Sidekiq::Worker
+  end
+else
+  Object.send(:remove_const, :PortraitProcessJob) if defined?(PortraitProcessJob)
+  class PortraitProcessJob < ::ActiveJob::Base
+    include CarrierWave::Workers::ProcessAssetMixin
+  end
+end
+
 begin
   ActiveRecord::Migration.maintain_test_schema!
 rescue ActiveRecord::PendingMigrationError => e

data/spec/support/dummy_app/Gemfile

@@ -1,13 +1,13 @@
 source "https://rubygems.org"
 git_source(:github) { |repo| "https://github.com/#{repo}.git" }
 
-ruby "3.0.0"
+ruby "3.4.5"
 
 # Bundle edge Rails instead: gem "rails", github: "rails/rails", branch: "main"
-gem "rails", "~> 7.0.6"
+gem "rails", "~> 8.1.1"
 
 # Use sqlite3 as the database for Active Record
-gem "sqlite3", "~> 1.4"
+gem "sqlite3", "~> 2.7"
 
 # Use the Puma web server [https://github.com/puma/puma]
 # gem "puma", "~> 5.0"
@@ -46,4 +46,3 @@ group :development do
   # Speed up commands on slow machines / big apps [https://github.com/rails/spring]
   # gem "spring"
 end
-

data/spec/support/dummy_app/app/jobs/portrait_process_job.rb

@@ -0,0 +1,5 @@
+class PortraitProcessJob
+  def perform(*args)
+    # Do something later
+  end
+end

data/spec/support/dummy_app/app/models/admin.rb

@@ -6,5 +6,5 @@ class Admin < ApplicationRecord
   # Multi attachment support
   mount_uploaders :images, AvatarUploader
   process_in_background :images
-  serialize :images, JSON
+  serialize :images, coder: JSON
 end

data/spec/support/dummy_app/app/models/user.rb

@@ -6,5 +6,8 @@ class User < ApplicationRecord
   # Multi attachment support
   mount_uploaders :images, AvatarUploader
   store_in_background :images
-  serialize :images, JSON
+  serialize :images, coder: JSON
+
+  mount_uploader :portrait, AvatarUploader
+  store_in_background :portrait, PortraitProcessJob
 end

data/spec/support/dummy_app/app/uploaders/avatar_uploader.rb

@@ -31,6 +31,7 @@ class AvatarUploader < CarrierWave::Uploader::Base
 
   # Process files as they are uploaded:
   # process scale: [200, 300]
+  process resize_to_fit: [1960, 1960]
   #
   # def scale(width, height)
   #   # do something

data/spec/support/dummy_app/bin/ci

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+require_relative "../config/boot"
+require "active_support/continuous_integration"
+
+CI = ActiveSupport::ContinuousIntegration
+require_relative "../config/ci.rb"

data/spec/support/dummy_app/bin/dev

@@ -0,0 +1,2 @@
+#!/usr/bin/env ruby
+exec "./bin/rails", "server", *ARGV

data/spec/support/dummy_app/bin/setup

@@ -1,11 +1,10 @@
 #!/usr/bin/env ruby
 require "fileutils"
 
-# path to your application root.
 APP_ROOT = File.expand_path("..", __dir__)
 
 def system!(*args)
-  system(*args) || abort("\n== Command #{args} failed ==")
+  system(*args, exception: true)
 end
 
 FileUtils.chdir APP_ROOT do
@@ -14,7 +13,6 @@ FileUtils.chdir APP_ROOT do
   # Add necessary setup steps to this file.
 
   puts "== Installing dependencies =="
-  system! "gem install bundler --conservative"
   system("bundle check") || system!("bundle install")
 
   # puts "\n== Copying sample files =="
@@ -24,10 +22,14 @@ FileUtils.chdir APP_ROOT do
 
   puts "\n== Preparing database =="
   system! "bin/rails db:prepare"
+  system! "bin/rails db:reset" if ARGV.include?("--reset")
 
   puts "\n== Removing old logs and tempfiles =="
   system! "bin/rails log:clear tmp:clear"
 
-  puts "\n== Restarting application server =="
-  system! "bin/rails restart"
+  unless ARGV.include?("--skip-server")
+    puts "\n== Starting development server =="
+    STDOUT.flush # flush the output before exec(2) so that it displays
+    exec "bin/dev"
+  end
 end

data/spec/support/dummy_app/config/application.rb

@@ -21,7 +21,12 @@ Bundler.require(*Rails.groups)
 module DummyApp
   class Application < Rails::Application
     # Initialize configuration defaults for originally generated Rails version.
-    config.load_defaults 7.0
+    config.load_defaults 8.0
+
+    # Please, add to the `ignore` list any other `lib` subdirectories that do
+    # not contain `.rb` files, or that should not be reloaded or eager loaded.
+    # Common ones are `templates`, `generators`, or `middleware`, for example.
+    config.autoload_lib(ignore: %w[assets tasks])
 
     # Configuration for the application, engines, and railties goes here.
     #

data/spec/support/dummy_app/config/ci.rb

@@ -0,0 +1,14 @@
+# Run using bin/ci
+
+CI.run do
+  step "Setup", "bin/setup --skip-server"
+
+
+  # Optional: set a green GitHub commit status to unblock PR merge.
+  # Requires the `gh` CLI and `gh extension install basecamp/gh-signoff`.
+  # if success?
+  #   step "Signoff: All systems go. Ready for merge and deploy.", "gh signoff"
+  # else
+  #   failure "Signoff: CI failed. Do not merge or deploy.", "Fix the issues and try again."
+  # end
+end