add support for parameterized mailer when RAILS_VERSION > 5.1

Author: ignatiusreza

lib/rspec/rails/feature_check.rb

@@ -38,6 +38,10 @@ def has_action_mailer_show_preview?
           ::ActionMailer::Base.respond_to?(:show_previews=)
       end
 
+      def has_action_mailer_parameterized?
+        has_action_mailer? && defined?(::ActionMailer::Parameterized)
+      end
+
       def has_1_9_hash_syntax?
         ::Rails::VERSION::STRING > '4.0'
       end

lib/rspec/rails/matchers/active_job.rb

@@ -97,7 +97,7 @@ def supports_block_expectations?
 
           def check(jobs)
             @matching_jobs, @unmatching_jobs = jobs.partition do |job|
-              if arguments_match?(job) && other_attributes_match?(job)
+              if job_match?(job) && arguments_match?(job) && other_attributes_match?(job)
                 args = deserialize_arguments(job)
                 @block.call(*args)
                 true
@@ -134,6 +134,10 @@ def base_job_message(job)
             end
           end
 
+          def job_match?(job)
+            @job ? @job == job[:job] : true
+          end
+
           def arguments_match?(job)
             if @args.any?
               deserialized_args = deserialize_arguments(job)
@@ -151,7 +155,6 @@ def serialized_attributes
             {}.tap do |attributes|
               attributes[:at]    = serialized_at if @at
               attributes[:queue] = @queue if @queue
-              attributes[:job]   = @job if @job
             end
           end
 
@@ -310,7 +313,6 @@ def have_been_enqueued
       # @private
       def check_active_job_adapter
         return if ::ActiveJob::QueueAdapters::TestAdapter === ::ActiveJob::Base.queue_adapter
-
         raise StandardError, "To use ActiveJob matchers set `ActiveJob::Base.queue_adapter = :test`"
       end
     end

lib/rspec/rails/matchers/have_enqueued_mail.rb

@@ -18,7 +18,7 @@ def initialize(mailer_class, method_name)
           @mailer_class = mailer_class
           @method_name = method_name
           @mail_args = []
-          @args = mailer_args
+          @args = []
         end
 
         def description
@@ -27,7 +27,7 @@ def description
 
         def with(*args, &block)
           @mail_args = args
-          block.nil? ? super(*mailer_args) : super(*mailer_args, &yield_mail_args(block))
+          block.nil? ? super : super(&yield_mail_args(block))
         end
 
         def matches?(block)
@@ -63,9 +63,17 @@ def expected_count_message
           "#{message_expectation_modifier} #{@expected_number} #{@expected_number == 1 ? 'time' : 'times'}"
         end
 
-        def mailer_args
+        def job_match?(job)
+          super(job) || parameterized_mail?(job)
+        end
+
+        def parameterized_mail?(job)
+          RSpec::Rails::FeatureCheck.has_action_mailer_parameterized? && job[:job] == parameterized_mailer_job
+        end
+
+        def arguments_match?(job)
           if @mail_args.any?
-            base_mailer_args + @mail_args
+            @args = base_mailer_args + @mail_args
           else
             mailer_method_arity = @mailer_class.instance_method(@method_name).arity
 
@@ -74,9 +82,12 @@ def mailer_args
                              else
                                mailer_method_arity
                              end
+            number_of_args += 1 if parameterized_mail?(job)
 
-            base_mailer_args + Array.new(number_of_args) { anything }
+            @args = base_mailer_args + Array.new(number_of_args) { anything }
           end
+
+          super(job)
         end
 
         def base_mailer_args
@@ -124,6 +135,10 @@ def mail_job_message(job)
         def mailer_job
           ActionMailer::DeliveryJob
         end
+
+        def parameterized_mailer_job
+          ActionMailer::Parameterized::DeliveryJob
+        end
       end
       # @api public
       # Passes if an email has been enqueued inside block.

spec/rspec/rails/matchers/have_enqueued_mail_spec.rb

@@ -283,5 +283,30 @@ def self.name; "NonMailerJob"; end
         expect(second_arg).to eq('noon')
       }
     end
+
+    context 'when parameterized', :skip => !RSpec::Rails::FeatureCheck.has_action_mailer_parameterized? do
+      it "passes when mailer is parameterized" do
+        expect {
+          TestMailer.with('foo' => 'bar').test_email.deliver_later
+        }.to have_enqueued_mail(TestMailer, :test_email)
+      end
+
+      it "passes when mixing parameterized and non-parameterized emails" do
+        expect {
+          TestMailer.with('foo' => 'bar').test_email.deliver_later
+          TestMailer.email_with_args(1, 2).deliver_later
+        }.to have_enqueued_mail(TestMailer, :test_email).and have_enqueued_mail(TestMailer, :email_with_args)
+      end
+
+      it "passes with provided argument matchers" do
+        expect {
+          TestMailer.with('foo' => 'bar').test_email.deliver_later
+        }.to have_enqueued_mail(TestMailer, :test_email).with('foo' => 'bar')
+
+        expect {
+          TestMailer.with('foo' => 'bar').email_with_args(1, 2).deliver_later
+        }.not_to have_enqueued_mail(TestMailer, :email_with_args).with({ 'foo' => 'bar' }, 3, 4)
+      end
+    end
   end
 end