Merge pull request rails#48920 from fidalgo/fidalgo/update-assert_enqueued_with-documentation

adrianna-chang-shopify · web-flow · commit 27c5c7cd99f7 · 2023-08-29T10:36:22.000-04:00
[docs] Update assert_enqueued_with documentation with keyword arguments example
diff --git a/activejob/lib/active_job/test_helper.rb b/activejob/lib/active_job/test_helper.rb
@@ -354,6 +354,13 @@ def assert_no_performed_jobs(only: nil, except: nil, queue: nil, &block)
     #     assert_enqueued_with(at: Date.tomorrow.noon, queue: "my_queue")
     #   end
     #
+    # For keyword arguments, specify them as a hash inside an array:
+    #
+    #   def test_assert_enqueued_with_keyword_arguments
+    #     MyJob.perform_later(arg1: 'value1', arg2: 'value2')
+    #     assert_enqueued_with(job: MyJob, args: [{ arg1: 'value1', arg2: 'value2' }])
+    #   end
+    #
     # The given arguments may also be specified as matcher procs that return a
     # boolean value indicating whether a job's attribute meets certain criteria.
     #

Original file line number	Diff line number	Diff line change
`@@ -354,6 +354,13 @@ def assert_no_performed_jobs(only: nil, except: nil, queue: nil, &block)`
`354`	`354`	`# assert_enqueued_with(at: Date.tomorrow.noon, queue: "my_queue")`
`355`	`355`	`# end`
`356`	`356`	`#`
	`357`	`+ # For keyword arguments, specify them as a hash inside an array:`
	`358`	`+ #`
	`359`	`+ # def test_assert_enqueued_with_keyword_arguments`
	`360`	`+ # MyJob.perform_later(arg1: 'value1', arg2: 'value2')`
	`361`	`+ # assert_enqueued_with(job: MyJob, args: [{ arg1: 'value1', arg2: 'value2' }])`
	`362`	`+ # end`
	`363`	`+ #`
`357`	`364`	`# The given arguments may also be specified as matcher procs that return a`
`358`	`365`	`# boolean value indicating whether a job's attribute meets certain criteria.`
`359`	`366`	`#`