delayed_job 4.1.5 → 4.1.11

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: da067ee0d2ec947e25ae05f9ee33524d9ca3ebb9d7061b6ee5f16c9101351b50
-  data.tar.gz: c69b06a3d6df2f9703fffbc83ba224eaa65381a5243f6be55afecbfa17d70eea
+  metadata.gz: b5abe29ddb94836277901e7d618f7291ff9078ca25619b40405a3ccc5a471950
+  data.tar.gz: fb35d6e6eb7618ba31e44e31580c369aa80fe90353bbc282cf933613c82d152c
 SHA512:
-  metadata.gz: 3ae9dce2bd8ca944d8ad43a757b5826c2b4d6024e3f89faa3c75c3e3ed1b891fb99c7c6cddf7e5b5f835d042300e20c1c14371c74aae3d155ecd413cf239109c
-  data.tar.gz: 8ebc99e9d492bb793e6dbe769f0371cf6308ee397bb55a0983db225fa41ef38f5ac20f19d9e46cd5583ce628b1e7241a2c650316fadd7d5493a5f016a2d958ef
+  metadata.gz: 5427056c3a1adcd9a484a2eeec2d2ce6f3b2ad4c845f31a98d917a3ac228ee0c58a9ca7ced028b03a7935704dceaf6419ee71a4f7077287e7b39429dc517abd1
+  data.tar.gz: '082c6fa5d5407d3e87c2393f16c2dfdb233f12a2012bc28d03a1baca749d0d95ca8263d7ed67796561ab1376fe1fa7963af57c87fc06b362d6c1dffc07bc6b98'

data/CHANGELOG.md

@@ -1,14 +1,42 @@
+4.1.11 - 2022-09-28
+===================
+* Fix missing require for Rails 7.0.3+
+
+4.1.10 - 2022-01-17
+===================
+* Support for Rails 7.0. NOTE: If you are using Delayed Job independent of Rails, Active Support 7 has dropped classic dependency autoloading. You will need to add and setup zeitwerk for autoloading to continue working in ActiveSupport 7.
+
+4.1.9 - 2020-12-09
+==================
+* Support for Rails 6.1
+* Add support for parameterized mailers via delay call (#1121)
+
+4.1.8 - 2019-08-16
+==================
+* Support for Rails 6.0.0
+
+4.1.7 - 2019-06-20
+==================
+* Fix loading Delayed::PerformableMailer when ActionMailer isn't loaded yet
+
+4.1.6 - 2019-06-19
+==================
+* Properly initialize ActionMailer outside railties (#1077)
+* Fix Psych load_tags support (#1093)
+* Replace REMOVED with FAILED in log message (#1048)
+* Misc doc updates (#1052, #1074, #1064, #1063)
+
 4.1.5 - 2018-04-13
-=================
+==================
 * Allow Rails 5.2
 
 4.1.4 - 2017-12-29
-=================
+==================
 * Use `yaml_tag` instead of deprecated `yaml_as` (#996)
 * Support ruby 2.5.0
 
 4.1.3 - 2017-05-26
-=================
+==================
 * Don't mutate the options hash (#877)
 * Log an error message when a deserialization error occurs (#894)
 * Adding the queue name to the log output (#917)

data/README.md

@@ -1,19 +1,16 @@
 **If you're viewing this at https://github.com/collectiveidea/delayed_job,
 you're reading the documentation for the master branch.
 [View documentation for the latest release
-(4.1.5).](https://github.com/collectiveidea/delayed_job/tree/v4.1.5)**
+(4.1.11).](https://github.com/collectiveidea/delayed_job/tree/v4.1.11)**
 
 Delayed::Job
 ============
-[![Gem Version](https://badge.fury.io/rb/delayed_job.png)][gem]
-[![Build Status](https://travis-ci.org/collectiveidea/delayed_job.png?branch=master)][travis]
-[![Dependency Status](https://gemnasium.com/collectiveidea/delayed_job.png?travis)][gemnasium]
-[![Code Climate](https://codeclimate.com/github/collectiveidea/delayed_job.png)][codeclimate]
-[![Coverage Status](https://coveralls.io/repos/collectiveidea/delayed_job/badge.png?branch=master)][coveralls]
+[![Gem Version](https://badge.fury.io/rb/delayed_job.svg)][gem]
+![CI](https://github.com/collectiveidea/delayed_job/workflows/CI/badge.svg)
+[![Code Climate](https://codeclimate.com/github/collectiveidea/delayed_job.svg)][codeclimate]
+[![Coverage Status](https://coveralls.io/repos/collectiveidea/delayed_job/badge.svg?branch=master)][coveralls]
 
 [gem]: https://rubygems.org/gems/delayed_job
-[travis]: https://travis-ci.org/collectiveidea/delayed_job
-[gemnasium]: https://gemnasium.com/collectiveidea/delayed_job
 [codeclimate]: https://codeclimate.com/github/collectiveidea/delayed_job
 [coveralls]: https://coveralls.io/r/collectiveidea/delayed_job
 
@@ -62,16 +59,16 @@ running the following command:
     rails generate delayed_job:active_record
     rake db:migrate
 
-For Rails 4.2, see [below](#rails-42)
+For Rails 4.2+, see [below](#active-job)
 
 Development
 ===========
 In development mode, if you are using Rails 3.1+, your application code will automatically reload every 100 jobs or when the queue finishes.
 You no longer need to restart Delayed Job every time you update your code in development.
 
-Rails 4.2
-=========
-Set the queue_adapter in config/application.rb
+Active Job
+==========
+In Rails 4.2+, set the queue_adapter in config/application.rb
 
 ```ruby
 config.active_job.queue_adapter = :delayed_job
@@ -170,9 +167,10 @@ end
 
 If you ever want to call a `handle_asynchronously`'d method without Delayed Job, for instance while debugging something at the console, just add `_without_delay` to the method name. For instance, if your original method was `foo`, then call `foo_without_delay`.
 
-Rails 3 Mailers
-===============
-Due to how mailers are implemented in Rails 3, we had to do a little work around to get delayed_job to work.
+Rails Mailers
+=============
+Delayed Job uses special syntax for Rails Mailers.
+Do not call the `.deliver` method when using `.delay`.
 
 ```ruby
 # without delayed_job
@@ -181,12 +179,16 @@ Notifier.signup(@user).deliver
 # with delayed_job
 Notifier.delay.signup(@user)
 
-# with delayed_job running at a specific time
+# delayed_job running at a specific time
 Notifier.delay(run_at: 5.minutes.from_now).signup(@user)
+
+# when using parameters, the .with method must be called before the .delay method
+Notifier.with(foo: 1, bar: 2).delay.signup(@user)
 ```
 
-Remove the `.deliver` method to make it work. It's not ideal, but it's the best
-we could do for now.
+You may also wish to consider using
+[Active Job with Action Mailer](https://edgeguides.rubyonrails.org/active_job_basics.html#action-mailer)
+which provides convenient `.deliver_later` syntax that forwards to Delayed Job under-the-hood.
 
 Named Queues
 ============
@@ -377,6 +379,9 @@ Hooks
 =====
 You can define hooks on your job that will be called at different stages in the process:
 
+
+**NOTE:** If you are using ActiveJob these hooks are **not** available to your jobs. You will need to use ActiveJob's callbacks. You can find details here https://guides.rubyonrails.org/active_job_basics.html#callbacks
+
 ```ruby
 class ParanoidNewsletterJob < NewsletterJob
   def enqueue(job)
@@ -430,7 +435,7 @@ end
 
 On error, the job is scheduled again in 5 seconds + N ** 4, where N is the number of attempts or using the job's defined `reschedule_at` method.
 
-The default `Worker.max_attempts` is 25. After this, the job either deleted (default), or left in the database with "failed_at" set.
+The default `Worker.max_attempts` is 25. After this, the job is either deleted (default), or left in the database with "failed_at" set.
 With the default of 25 attempts, the last retry will be 20 days later, with the last interval being almost 100 hours.
 
 The default `Worker.max_run_time` is 4.hours. If your job takes longer than that, another computer could pick it up. It's up to you to

data/delayed_job.gemspec

@@ -1,7 +1,7 @@
 # -*- encoding: utf-8 -*-
 
 Gem::Specification.new do |spec|
-  spec.add_dependency 'activesupport', ['>= 3.0', '< 5.3']
+  spec.add_dependency 'activesupport', ['>= 3.0', '< 8.0']
   spec.authors        = ['Brandon Keepers', 'Brian Ryckbost', 'Chris Gaffney', 'David Genord II', 'Erik Michaels-Ober', 'Matt Griffin', 'Steve Richert', 'Tobias Lütke']
   spec.description    = 'Delayed_job (or DJ) encapsulates the common pattern of asynchronously executing longer tasks in the background. It is a direct extraction from Shopify where the job table is responsible for a multitude of core tasks.'
   spec.email          = ['brian@collectiveidea.com']
@@ -13,5 +13,10 @@ Gem::Specification.new do |spec|
   spec.require_paths  = ['lib']
   spec.summary        = 'Database-backed asynchronous priority queue system -- Extracted from Shopify'
   spec.test_files     = Dir.glob('spec/**/*')
-  spec.version        = '4.1.5'
+  spec.version        = '4.1.11'
+  spec.metadata       = {
+    'changelog_uri'   => 'https://github.com/collectiveidea/delayed_job/blob/master/CHANGELOG.md',
+    'bug_tracker_uri' => 'https://github.com/collectiveidea/delayed_job/issues',
+    'source_code_uri' => 'https://github.com/collectiveidea/delayed_job'
+  }
 end

data/lib/delayed/backend/base.rb

@@ -133,7 +133,8 @@ module Delayed
       end
 
       def fail!
-        update_attributes(:failed_at => self.class.db_time_now)
+        self.failed_at = self.class.db_time_now
+        save!
       end
 
     protected

data/lib/delayed/backend/shared_spec.rb

@@ -523,7 +523,8 @@ shared_examples_for 'a delayed_job backend' do
       it 'reloads changed attributes' do
         story = Story.create(:text => 'hello')
         job = story.delay.tell
-        story.update_attributes :text => 'goodbye'
+        story.text = 'goodbye'
+        story.save!
         expect(job.reload.payload_object.object.text).to eq('goodbye')
       end
 

data/lib/delayed/psych_ext.rb

@@ -28,7 +28,13 @@ module Delayed
       end
 
       def visit_Psych_Nodes_Mapping(object) # rubocop:disable CyclomaticComplexity, MethodName, PerceivedComplexity
-        return revive(Psych.load_tags[object.tag], object) if Psych.load_tags[object.tag]
+        klass = Psych.load_tags[object.tag]
+        if klass
+          # Implementation changed here https://github.com/ruby/psych/commit/2c644e184192975b261a81f486a04defa3172b3f
+          # load_tags used to have class values, now the values are strings
+          klass = resolve_class(klass) if klass.is_a?(String)
+          return revive(klass, object)
+        end
 
         case object.tag
         when %r{^!ruby/object}

data/lib/delayed/railtie.rb

@@ -4,10 +4,6 @@ require 'rails'
 module Delayed
   class Railtie < Rails::Railtie
     initializer :after_initialize do
-      ActiveSupport.on_load(:action_mailer) do
-        ActionMailer::Base.extend(Delayed::DelayMail)
-      end
-
       Delayed::Worker.logger ||= if defined?(Rails)
         Rails.logger
       elsif defined?(RAILS_DEFAULT_LOGGER)

data/lib/delayed/worker.rb

@@ -1,5 +1,6 @@
 require 'timeout'
 require 'active_support/dependencies'
+require 'active_support/core_ext/kernel/reporting'
 require 'active_support/core_ext/numeric/time'
 require 'active_support/core_ext/class/attribute_accessors'
 require 'active_support/hash_with_indifferent_access'
@@ -251,7 +252,7 @@ module Delayed
         job.unlock
         job.save!
       else
-        job_say job, "REMOVED permanently because of #{job.attempts} consecutive failures", 'error'
+        job_say job, "FAILED permanently because of #{job.attempts} consecutive failures", 'error'
         failed(job)
       end
     end

data/lib/delayed_job.rb

@@ -3,12 +3,6 @@ require 'delayed/compatibility'
 require 'delayed/exceptions'
 require 'delayed/message_sending'
 require 'delayed/performable_method'
-
-if defined?(ActionMailer)
-  require 'action_mailer/version'
-  require 'delayed/performable_mailer'
-end
-
 require 'delayed/yaml_ext'
 require 'delayed/lifecycle'
 require 'delayed/plugin'
@@ -19,5 +13,15 @@ require 'delayed/worker'
 require 'delayed/deserialization_error'
 require 'delayed/railtie' if defined?(Rails::Railtie)
 
+ActiveSupport.on_load(:action_mailer) do
+  require 'delayed/performable_mailer'
+  ActionMailer::Base.extend(Delayed::DelayMail)
+  ActionMailer::Parameterized::Mailer.include(Delayed::DelayMail) if defined?(ActionMailer::Parameterized::Mailer)
+end
+
+module Delayed
+  autoload :PerformableMailer, 'delayed/performable_mailer'
+end
+
 Object.send(:include, Delayed::MessageSending)
 Module.send(:include, Delayed::MessageSendingClassMethods)

data/spec/delayed/backend/test.rb

@@ -87,11 +87,6 @@ module Delayed
           Time.current
         end
 
-        def update_attributes(attrs = {})
-          attrs.each { |k, v| send(:"#{k}=", v) }
-          save
-        end
-
         def destroy
           self.class.all.delete(self)
         end

data/spec/helper.rb

@@ -1,20 +1,25 @@
 require 'simplecov'
-require 'coveralls'
+require 'simplecov-lcov'
 
-SimpleCov.formatters = [SimpleCov::Formatter::HTMLFormatter, Coveralls::SimpleCov::Formatter]
+SimpleCov::Formatter::LcovFormatter.config do |c|
+  c.report_with_single_file = true
+  c.single_report_path = 'coverage/lcov.info'
+end
+SimpleCov.formatters = SimpleCov::Formatter::MultiFormatter.new(
+  [
+    SimpleCov::Formatter::HTMLFormatter,
+    SimpleCov::Formatter::LcovFormatter
+  ]
+)
 
 SimpleCov.start do
   add_filter '/spec/'
-  # Each version of ruby and version of rails test different things
-  # This should probably just be removed.
-  minimum_coverage(85.0)
 end
 
 require 'logger'
 require 'rspec'
 
 require 'action_mailer'
-require 'active_support/dependencies'
 require 'active_record'
 
 require 'delayed_job'
@@ -42,11 +47,21 @@ end
 
 Delayed::Worker.backend = :test
 
-# Add this directory so the ActiveSupport autoloading works
-ActiveSupport::Dependencies.autoload_paths << File.dirname(__FILE__)
+if ActiveSupport::VERSION::MAJOR < 7
+  require 'active_support/dependencies'
 
-# Add this to simulate Railtie initializer being executed
-ActionMailer::Base.extend(Delayed::DelayMail)
+  # Add this directory so the ActiveSupport autoloading works
+  ActiveSupport::Dependencies.autoload_paths << File.dirname(__FILE__)
+else
+  # Rails 7 dropped classic dependency auto-loading. This does a basic
+  # zeitwerk setup to test against zeitwerk directly as the Rails zeitwerk
+  # setup is intertwined in the application boot process.
+  require 'zeitwerk'
+
+  loader = Zeitwerk::Loader.new
+  loader.push_dir File.dirname(__FILE__)
+  loader.setup
+end
 
 # Used to test interactions between DJ and an ORM
 ActiveRecord::Base.establish_connection :adapter => 'sqlite3', :database => ':memory:'

data/spec/performable_mailer_spec.rb

@@ -1,6 +1,5 @@
 require 'helper'
 
-require 'action_mailer'
 class MyMailer < ActionMailer::Base
   def signup(email)
     mail :to => email, :subject => 'Delaying Emails', :from => 'delayedjob@example.com', :body => 'Delaying Emails Body'
@@ -41,3 +40,29 @@ describe ActionMailer::Base do
     end
   end
 end
+
+if defined?(ActionMailer::Parameterized::Mailer)
+  describe ActionMailer::Parameterized::Mailer do
+    describe 'delay' do
+      it 'enqueues a PerformableEmail job' do
+        expect do
+          job = MyMailer.with(:foo => 1, :bar => 2).delay.signup('john@example.com')
+          expect(job.payload_object.class).to eq(Delayed::PerformableMailer)
+          expect(job.payload_object.object.class).to eq(ActionMailer::Parameterized::Mailer)
+          expect(job.payload_object.object.instance_variable_get('@mailer')).to eq(MyMailer)
+          expect(job.payload_object.object.instance_variable_get('@params')).to eq(:foo => 1, :bar => 2)
+          expect(job.payload_object.method_name).to eq(:signup)
+          expect(job.payload_object.args).to eq(['john@example.com'])
+        end.to change { Delayed::Job.count }.by(1)
+      end
+    end
+
+    describe 'delay on a mail object' do
+      it 'raises an exception' do
+        expect do
+          MyMailer.with(:foo => 1, :bar => 2).signup('john@example.com').delay
+        end.to raise_error(RuntimeError)
+      end
+    end
+  end
+end

data/spec/psych_ext_spec.rb

@@ -3,10 +3,32 @@ require 'helper'
 describe 'Psych::Visitors::ToRuby', :if => defined?(Psych::Visitors::ToRuby) do
   context BigDecimal do
     it 'deserializes correctly' do
-      deserialized = YAML.load("--- !ruby/object:BigDecimal 18:0.1337E2\n...\n")
+      deserialized = YAML.load_dj("--- !ruby/object:BigDecimal 18:0.1337E2\n...\n")
 
       expect(deserialized).to be_an_instance_of(BigDecimal)
       expect(deserialized).to eq(BigDecimal('13.37'))
     end
   end
+
+  context 'load_tag handling' do
+    # This only broadly works in ruby 2.0 but will cleanly work through load_dj
+    # here because this class is so simple it only touches our extention
+    YAML.load_tags['!ruby/object:RenamedClass'] = SimpleJob
+    # This is how ruby 2.1 and newer works throughout the yaml handling
+    YAML.load_tags['!ruby/object:RenamedString'] = 'SimpleJob'
+
+    it 'deserializes class tag' do
+      deserialized = YAML.load_dj("--- !ruby/object:RenamedClass\ncheck: 12\n")
+
+      expect(deserialized).to be_an_instance_of(SimpleJob)
+      expect(deserialized.instance_variable_get(:@check)).to eq(12)
+    end
+
+    it 'deserializes string tag' do
+      deserialized = YAML.load_dj("--- !ruby/object:RenamedString\ncheck: 12\n")
+
+      expect(deserialized).to be_an_instance_of(SimpleJob)
+      expect(deserialized.instance_variable_get(:@check)).to eq(12)
+    end
+  end
 end

data/spec/yaml_ext_spec.rb

@@ -25,7 +25,7 @@ describe 'YAML' do
   it 'autoloads the class of an anonymous struct' do
     expect do
       yaml = "--- !ruby/struct\nn: 1\n"
-      object = YAML.load(yaml)
+      object = load_with_delayed_visitor(yaml)
       expect(object).to be_kind_of(Struct)
       expect(object.n).to eq(1)
     end.not_to raise_error

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: delayed_job
 version: !ruby/object:Gem::Version
-  version: 4.1.5
+  version: 4.1.11
 platform: ruby
 authors:
 - Brandon Keepers
@@ -12,10 +12,10 @@ authors:
 - Matt Griffin
 - Steve Richert
 - Tobias Lütke
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2018-04-13 00:00:00.000000000 Z
+date: 2022-09-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -26,7 +26,7 @@ dependencies:
         version: '3.0'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '5.3'
+        version: '8.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -36,7 +36,7 @@ dependencies:
         version: '3.0'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '5.3'
+        version: '8.0'
 description: Delayed_job (or DJ) encapsulates the common pattern of asynchronously
   executing longer tasks in the background. It is a direct extraction from Shopify
   where the job table is responsible for a multitude of core tasks.
@@ -102,8 +102,11 @@ files:
 homepage: http://github.com/collectiveidea/delayed_job
 licenses:
 - MIT
-metadata: {}
-post_install_message: 
+metadata:
+  changelog_uri: https://github.com/collectiveidea/delayed_job/blob/master/CHANGELOG.md
+  bug_tracker_uri: https://github.com/collectiveidea/delayed_job/issues
+  source_code_uri: https://github.com/collectiveidea/delayed_job
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -118,27 +121,26 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
-signing_key: 
+rubygems_version: 3.3.7
+signing_key:
 specification_version: 4
 summary: Database-backed asynchronous priority queue system -- Extracted from Shopify
 test_files:
-- spec/sample_jobs.rb
-- spec/lifecycle_spec.rb
-- spec/performable_method_spec.rb
-- spec/helper.rb
-- spec/psych_ext_spec.rb
-- spec/worker_spec.rb
-- spec/autoloaded/struct.rb
 - spec/autoloaded/clazz.rb
 - spec/autoloaded/instance_clazz.rb
 - spec/autoloaded/instance_struct.rb
-- spec/test_backend_spec.rb
-- spec/delayed/serialization/test.rb
+- spec/autoloaded/struct.rb
+- spec/daemons.rb
 - spec/delayed/backend/test.rb
 - spec/delayed/command_spec.rb
+- spec/delayed/serialization/test.rb
+- spec/helper.rb
+- spec/lifecycle_spec.rb
 - spec/message_sending_spec.rb
 - spec/performable_mailer_spec.rb
+- spec/performable_method_spec.rb
+- spec/psych_ext_spec.rb
+- spec/sample_jobs.rb
+- spec/test_backend_spec.rb
+- spec/worker_spec.rb
 - spec/yaml_ext_spec.rb
-- spec/daemons.rb