carrierwave_backgrounder 1.0.3 → 1.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9c0b0d85fb1f579359409a4f93fa77b2434cc90d6c9e59c7cd0f9c4759e9d97e
-  data.tar.gz: 722d48271ca9e31f3acc3a61a0c7ae8a159493f3c4500903219ff8046d167709
+  metadata.gz: 1e007beb6c4d7bdd9d12f197d3dd1ef9a1fd0db2cff176c91bf556167311c916
+  data.tar.gz: d6d3ffca8551ea931c9788c02b1b6aa73ace34274229152c5816ed871f9e50a2
 SHA512:
-  metadata.gz: 40fd30e91feeb0dba7892714066cd0a132d97e835e3eff5b0e97ecc09ddd0c978b296869a3ff35aabff3207e1484c8cec13de39fe771f12a875934149bad9a20
-  data.tar.gz: 10b06251d0030b42ec736c7de8dcbecc46c32bc16d11a1d32ae2c3bee88867c68172ff4432a3efae8260eab215c3d25d161471d84ede4abfeee255e6d6927f39
+  metadata.gz: 2186ebdc16e2e3dd6dc76d5998ba79b23903caaf956d18fa403228f75e636b145bb3b7a0b0d0ef078e3c9530bb868dbae20d3b83beddd0a4bfa9a168c351b667
+  data.tar.gz: 35cc9df51de365463319a0d4cdd9df204ecb44105f5975d37cbaf1a1e3aff68335082fbf3f83ac98975722e9012447dc93429c039603d44def6856fe1c2cab7d

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/CHANGELOG.md

@@ -1,7 +1,12 @@
+## 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 [gstokkink]
+  * Add support for Rails 8.0 [damisul]
 
 ## 1.0.2
 

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,17 +6,20 @@ 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.1"]
 

data/lib/backgrounder/version.rb

@@ -1,5 +1,5 @@
 module CarrierWave
   module Backgrounder
-    VERSION = "1.0.3"
+    VERSION = "1.1.1"
   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,17 +9,17 @@ 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'
 
@@ -34,7 +34,6 @@ module CarrierWave
       when :sidekiq
         @worker_klass = 'CarrierWave::Workers'
 
-        require 'sidekiq'
         ::CarrierWave::Workers::ProcessAsset.class_eval do
           include ::Sidekiq::Worker
         end
@@ -43,6 +42,10 @@ module CarrierWave
         end
       end
     end
+
+    def self.suppress_record_not_found_errors(surpress_errors = true)
+      @suppress_not_found_errors = surpress_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/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/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/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/config/initializers/carrierwave_backgrounder.rb

@@ -1,3 +1,6 @@
+require 'active_job'
+require 'sidekiq'
+
 queue_adapter = ENV['QUEUE_ADAPTER'] || :active_job
 CarrierWave::Backgrounder.configure do |c|
   c.backend queue_adapter.to_sym, queue: :carrierwave

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: carrierwave_backgrounder
 version: !ruby/object:Gem::Version
-  version: 1.0.3
+  version: 1.1.1
 platform: ruby
 authors:
 - Larry Sprock
@@ -139,9 +139,9 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/ruby-ci.yml"
 - ".gitignore"
 - ".rspec"
-- ".travis.yml"
 - CHANGELOG.md
 - Gemfile
 - README.md
@@ -242,7 +242,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '3.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -252,7 +252,7 @@ requirements: []
 rubygems_version: 3.6.9
 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
+  using ActiveJob or Sidekiq.
 test_files:
 - spec/backgrounder/orm/activemodel_spec.rb
 - spec/backgrounder/orm/base_spec.rb

data/.travis.yml

@@ -1,20 +0,0 @@
-language: ruby
-
-rvm:
- - 2.7
- - 3.0
- - 3.1
- - 3.2
- - ruby-head
-
-env:
-- QUEUE_ADAPTER='sidekiq'
-- QUEUE_ADAPTER='active_job'
-
-before_install:
- - yes | gem update --system --force
- - gem install bundler
-
-matrix:
-  allow_failures:
-    - rvm: ruby-head