Fix arguments for have_enqueued_mail matcher

Add additional logic to the ActionMailer argument parsing to accomodate for differences under Ruby 3.1/Rails 6.1 Co-authored-by: Fabio Napoleoni <[email protected]> Co-authored-by: Mikael Henriksson <[email protected]> Co-authored-by: Phil Pirozhkov <[email protected]>

Author: 4 people

.rubocop_todo.yml

@@ -9,3 +9,7 @@ Layout/LineLength:
 # Over time we'd like to get this down, but this is what we're at now.
 Metrics/MethodLength:
 Max: 43# default: 10
+
+Metrics/ClassLength:
+Exclude:
+ - lib/rspec/rails/matchers/have_enqueued_mail.rb

lib/rspec/rails/feature_check.rb

@@ -35,10 +35,18 @@ def has_action_mailer_unified_delivery?
 has_action_mailer? && defined?(::ActionMailer::MailDeliveryJob)
 end
 
+defhas_action_mailer_legacy_delivery_job?
+defined?(ActionMailer::DeliveryJob)
+end
+
 defhas_action_mailbox?
 defined?(::ActionMailbox)
 end
 
+defruby_3_1?
+RUBY_VERSION >= "3.1"
+end
+
 deftype_metatag(type)
 "type: :#{type}"
 end

lib/rspec/rails/matchers/have_enqueued_mail.rb

@@ -76,7 +76,7 @@ def job_match?(job)
 defarguments_match?(job)
 @args=
 if@mail_args.any?
-base_mailer_args + @mail_args
+base_mailer_args + process_arguments(job,@mail_args)
 elsif@mailer_class && @method_name
 base_mailer_args + [any_args]
 elsif@mailer_class
@@ -88,12 +88,38 @@ def arguments_match?(job)
 super(job)
 end
 
+defprocess_arguments(job,given_mail_args)
+# Old matcher behavior working with all builtin classes but ActionMailer::MailDeliveryJob
+returngiven_mail_argsifuse_given_mail_args?(job)
+
+# If matching args starts with a hash and job instance has params match with them
+ifgiven_mail_args.first.is_a?(Hash) && job[:args][3]['params'].present?
+[hash_including(params: given_mail_args[0],args: given_mail_args.drop(1))]
+else
+[hash_including(args: given_mail_args)]
+end
+end
+
+defuse_given_mail_args?(job)
+returntrueifFeatureCheck.has_action_mailer_parameterized? && job[:job] <= ActionMailer::Parameterized::DeliveryJob
+returnfalseifFeatureCheck.ruby_3_1?
+
+ !(FeatureCheck.has_action_mailer_unified_delivery? && job[:job] <= ActionMailer::MailDeliveryJob)
+end
+
 defbase_mailer_args
 [mailer_class_name,@method_name.to_s,MAILER_JOB_METHOD]
 end
 
 defyield_mail_args(block)
-proc{ |*job_args| block.call(*(job_args - base_mailer_args))}
+procdo |*job_args|
+mailer_args=job_args - base_mailer_args
+ifmailer_args.first.is_a?(Hash)
+block.call(*mailer_args.first[:args])
+else
+block.call(*mailer_args)
+end
+end
 end
 
 defcheck_active_job_adapter
@@ -120,18 +146,25 @@ def unmatching_mail_jobs_message
 
 defmail_job_message(job)
 mailer_method=job[:args][0..1].join('.')
-
-mailer_args=job[:args][3..-1]
+mailer_args=deserialize_arguments(job)[3..-1]
+mailer_args=mailer_args.first[:args]ifunified_mail?(job)
 msg_parts=[]
-msg_parts << "with #{mailer_args}"ifmailer_args.any?
+display_args=display_mailer_args(mailer_args)
+msg_parts << "with #{display_args}"ifdisplay_args.any?
 msg_parts << "on queue #{job[:queue]}"ifjob[:queue] && job[:queue] != 'mailers'
 msg_parts << "at #{Time.at(job[:at])}"ifjob[:at]
 
 "#{mailer_method}#{msg_parts.join(', ')}".strip
 end
 
+defdisplay_mailer_args(mailer_args)
+returnmailer_argsunlessmailer_args.first.is_a?(Hash) && mailer_args.first.key?(:args)
+
+mailer_args.first[:args]
+end
+
 deflegacy_mail?(job)
-job[:job] <= ActionMailer::DeliveryJob
+RSpec::Rails::FeatureCheck.has_action_mailer_legacy_delivery_job? && job[:job] <= ActionMailer::DeliveryJob
 end
 
 defparameterized_mail?(job)

spec/rspec/rails/matchers/have_enqueued_mail_spec.rb

@@ -22,7 +22,12 @@ def test_email; end
 defemail_with_args(arg1,arg2);end
 end
 
-classDeliveryJobSubClass < ActionMailer::DeliveryJob
+ifRSpec::Rails::FeatureCheck.has_action_mailer_legacy_delivery_job?
+classDeliveryJobSubClass < ActionMailer::DeliveryJob
+end
+else
+classDeliveryJobSubClass < ActionMailer::MailDeliveryJob
+end
 end
 
 classUnifiedMailerWithDeliveryJobSubClass < ActionMailer::Base
@@ -393,18 +398,22 @@ def self.name; "NonMailerJob" end
 }.tohave_enqueued_mail(UnifiedMailer,:test_email).andhave_enqueued_mail(UnifiedMailer,:email_with_args)
 end
 
-it"passes with provided argument matchers"do
+it"matches arguments when mailer has only args"do
+expect{
+UnifiedMailer.email_with_args(1,2).deliver_later
+}.tohave_enqueued_mail(UnifiedMailer,:email_with_args).with(1,2)
+end
+
+it"matches arguments when mailer is parameterized"do
 expect{
 UnifiedMailer.with('foo'=>'bar').test_email.deliver_later
-}.tohave_enqueued_mail(UnifiedMailer,:test_email).with(
-a_hash_including(params: {'foo'=>'bar'})
-)
+}.tohave_enqueued_mail(UnifiedMailer,:test_email).with('foo'=>'bar')
+end
 
+it"matches arguments when mixing parameterized and non-parameterized emails"do
 expect{
 UnifiedMailer.with('foo'=>'bar').email_with_args(1,2).deliver_later
-}.tohave_enqueued_mail(UnifiedMailer,:email_with_args).with(
-a_hash_including(params: {'foo'=>'bar'},args: [1,2])
-)
+}.tohave_enqueued_mail(UnifiedMailer,:email_with_args).with({'foo'=>'bar'},1,2)
 end
 
 it"passes when using a mailer with `delivery_job` set to a sub class of `ActionMailer::DeliveryJob`"do