Feature/have enqueued mail matcher #2047

jdlubrano · 2018-12-11T15:29:39Z

Work in progress to add a have_enqueued_mail RSpec matcher

Fixes #1901

JonRowe

Great start! Are you going to add some of the other bits of the active job matcher? (Like exactly etc?)

spec/rspec/rails/matchers/have_enqueued_mail_spec.rb

lib/rspec/rails/matchers/have_enqueued_mail.rb

jdlubrano · 2018-12-13T23:15:58Z

@JonRowe After I started poking around the ActiveJob matcher I realized that a lot could be added to the have_enqueued_mail matcher which is admittedly barebones. To answer your question, yes I do plan to mimic as much as I can with regards to the ActiveJob functionality.

jdlubrano · 2018-12-31T21:59:21Z

@JonRowe

How does this look to you now? The only piece of functionality, I think, that I didn't implement for the have_enqueued_mail matcher was the ability to pass a block to .with. Is that missing functionality a necessity? I was kind of scratching my head wondering what the use case for passing a block to .with for ActiveJobs was in the first place. I understand how it works from the documentation and the code.

Nevertheless, it didn't seem as easy to pass along only the mailer arguments to that with block given the implementation of the RSpec::Rails::Matchers::HaveEnqueuedJob#check method. Before I potentially extracted something in the ActiveJob matchers, I wanted to get a better understanding of a real(ish) use case for passing a block .with in order to consider how such a case could apply to a ActionMailer.

JonRowe · 2019-01-02T17:06:20Z

Very good! The with block allows you to express more complex argument matching than is possible directly, e.g.

expect { ... }.to have_enqueued_mail.with { |a| expect(a).to eq("a").or eq("b") }

I think its desirable, but its not a blocker. Let me know what you think.

JonRowe · 2019-01-02T17:06:47Z

lib/rspec/rails/matchers/have_enqueued_mail.rb

+
+        def mailer_job
+          ActionMailer::DeliveryJob
+        end


Not a blocker, but why not just use the constant name directly in places?

I had the hardest time keeping the constant straight in my head. I kept wanting to call it ActionDelivery::MailerJob or ActionMailer::DeliverJob. So I guess out of frustration, I just made it a method 😅

JonRowe · 2019-01-02T17:07:17Z

spec/rspec/rails/matchers/have_enqueued_mail_spec.rb

+      message = "expected to enqueue TestMailer.email_with_args exactly 1 time with [1, 2], but enqueued 0" + \
+                "\nQueued deliveries:" + \
+                "\n  TestMailer.test_email" + \
+                "\n  TestMailer.email_with_args with [3, 4], on queue #{queue}, at #{send_time}"


Not a blocker, but it might be nice to show other jobs are not mentioned here.

Okay, that's a good callout; I will add that!

jdlubrano · 2019-01-03T15:04:20Z

@JonRowe I may have a way to replicate the with block capability that would not require too much overhead. I will try that out and if it proves to be straightforward, I will include it. I can probably get to it this weekend.

benoittgt · 2019-01-03T15:46:44Z

Thanks a lot @jdlubrano

JonRowe · 2019-01-03T22:32:15Z

lib/rspec/rails/matchers/have_enqueued_mail.rb

-          super(*mailer_args)
+
+          super(*mailer_args) do |*job_args|
+            block.call(*(job_args - base_mailer_args)) if block.present?


This should just call super if block is nil, else pass this block

lib/rspec/rails/matchers/have_enqueued_mail.rb

jdlubrano · 2019-01-04T20:58:44Z

@JonRowe

I believe that I addressed the latest changes that you requested. It looks like the builds are failing on Travis CI due to bundler issues, however. I'm fairly certain those failures are not specific to this branch...

JonRowe · 2019-01-04T21:07:49Z

Awaiting #2061 probably, will ask you to give it a poke when thats merged!

JonRowe · 2019-01-09T09:34:37Z

#2061 is merged so a rebase would get this green hopefully.

…ater

Moving the internals of https://github.com/jdlubrano/deliver_later_matchers into rspec-rails as a new RSpec::Rails::Matchers::HaveEnqueuedMail class.

…existing ActiveJob matcher tests.

…atcher.

…ing email methods that accept parameters when no specific arguments are expected.

The ActiveJob matcher provides output for each unmatching, enqueued job in its failure messages. Those unmatching jobs have certainly helped me catch typos in the past, so it makes sense to provide similar feedback in enqueued email failure messages.

deliver_later can be called with `wait`, `wait_until`, and `queue` keyword arguments, so the have_enqueued_mail matcher should support matching those types of things. At this point, I am beginning to suspect that this code would be better off using inheritance over composition. I am going to try and refactor to inherit from the ActiveJob base matcher now that I have all of the tests in a good state.

…ing the failed test

When using the HaveEnqueuedMail matcher, the error message should not complain about using "ActiveJob" matchers.

…dJob matcher Implementing as a subclass resulted in DRYer code IMO. There was no longer a need to reimplement once, twice, thrice and other duplicated methods that were basically just delegating to the job_matcher instance variable anyways.

…cher list of mail jobs

jdlubrano · 2019-01-11T21:31:18Z

@JonRowe

Looks like the build passed!

* Write first test case for calling simple mailer method with deliver_later * Move deliver_later gem logic into HaveEnqueuedMail matcher Moving the internals of https://github.com/jdlubrano/deliver_later_matchers into rspec-rails as a new RSpec::Rails::Matchers::HaveEnqueuedMail class. * Add tests for arguments matcher and error messages. Largely based on existing ActiveJob matcher tests. * Add exactly, at_least, at_most functionality for have_enqueued_mail matcher. * Support mailer methods with default/optional arguments; Support matching email methods that accept parameters when no specific arguments are expected. * Correct private YARD doc on RSpec::Rails::Matchers::HaveEnqueuedJob * Provide unmatching enqueued email info in failure messages The ActiveJob matcher provides output for each unmatching, enqueued job in its failure messages. Those unmatching jobs have certainly helped me catch typos in the past, so it makes sense to provide similar feedback in enqueued email failure messages. * Add tests for have_enqueued_mail matcher at_least and at_most modifiers * Add support for `at` and `on_queue` deliver_later can be called with `wait`, `wait_until`, and `queue` keyword arguments, so the have_enqueued_mail matcher should support matching those types of things. At this point, I am beginning to suspect that this code would be better off using inheritance over composition. I am going to try and refactor to inherit from the ActiveJob base matcher now that I have all of the tests in a good state. * Explicitly require rspec/mocks for access to `anything` method * Ignore Rubocop class length for HaveEnqueuedMail class * Replace .negative? with < 0 for older ruby versions * Remove .inspect call from test to see if that works... * Remove %i array syntax for older ruby versions * Remove the send_time part of the error message to see if that is causing the failed test * Replace new Hash key syntax with old => format for Ruby 1.8.7 * Call strftime in test to get some semblance of timestamp verification * Fix Ruby 1.8.7 syntax errors * Fix ActiveJob::Base.queue_adapter error When using the HaveEnqueuedMail matcher, the error message should not complain about using "ActiveJob" matchers. * Refactor HaveEnqueuedMail matcher to be a subclass of the HaveEnqueuedJob matcher Implementing as a subclass resulted in DRYer code IMO. There was no longer a need to reimplement once, twice, thrice and other duplicated methods that were basically just delegating to the job_matcher instance variable anyways. * Support with blocks * Test that non-mailer jobs do not appear in the have_enqueued_mail matcher list of mail jobs * Make 'deliver_now' a frozen constant * Only pass a mailer-specific block to super if a block is provided * Fix hash rocket syntax for Ruby 1.8.7

JonRowe requested changes Dec 13, 2018

View reviewed changes

spec/rspec/rails/matchers/have_enqueued_mail_spec.rb Show resolved Hide resolved

lib/rspec/rails/matchers/have_enqueued_mail.rb Outdated Show resolved Hide resolved

jdlubrano force-pushed the feature/have-enqueued-mail-matcher branch 2 times, most recently from ea4f4b4 to 6330850 Compare December 25, 2018 18:25

JonRowe approved these changes Jan 2, 2019

View reviewed changes

JonRowe reviewed Jan 2, 2019

View reviewed changes

JonRowe reviewed Jan 3, 2019

View reviewed changes

lib/rspec/rails/matchers/have_enqueued_mail.rb Outdated Show resolved Hide resolved

jdlubrano force-pushed the feature/have-enqueued-mail-matcher branch from 9048adc to 4dc20ae Compare January 4, 2019 16:06

jdlubrano changed the title ~~[WIP] Feature/have enqueued mail matcher~~ Feature/have enqueued mail matcher Jan 4, 2019

Joel Lubrano added 12 commits January 9, 2019 15:54

Write first test case for calling simple mailer method with deliver_l…

5de5efa

…ater

Move deliver_later gem logic into HaveEnqueuedMail matcher

7e7a218

Moving the internals of https://github.com/jdlubrano/deliver_later_matchers into rspec-rails as a new RSpec::Rails::Matchers::HaveEnqueuedMail class.

Add tests for arguments matcher and error messages. Largely based on …

1692d1d

…existing ActiveJob matcher tests.

Add exactly, at_least, at_most functionality for have_enqueued_mail m…

003b3fa

…atcher.

Support mailer methods with default/optional arguments; Support match…

0af1edd

…ing email methods that accept parameters when no specific arguments are expected.

Correct private YARD doc on RSpec::Rails::Matchers::HaveEnqueuedJob

cd61a4d

Add tests for have_enqueued_mail matcher at_least and at_most modifiers

cd7ad09

Explicitly require rspec/mocks for access to anything method

0f6eb1a

Ignore Rubocop class length for HaveEnqueuedMail class

e2df63a

Replace .negative? with < 0 for older ruby versions

8a29d96

Joel Lubrano added 12 commits January 9, 2019 15:54

Remove .inspect call from test to see if that works...

5e9263f

Remove %i array syntax for older ruby versions

fdff42b

Remove the send_time part of the error message to see if that is caus…

9f6e792

…ing the failed test

Replace new Hash key syntax with old => format for Ruby 1.8.7

1929b11

Call strftime in test to get some semblance of timestamp verification

3b507fb

Fix Ruby 1.8.7 syntax errors

f588547

Fix ActiveJob::Base.queue_adapter error

0d1b0c9

When using the HaveEnqueuedMail matcher, the error message should not complain about using "ActiveJob" matchers.

Support with blocks

5753c6c

Test that non-mailer jobs do not appear in the have_enqueued_mail mat…

b32449e

…cher list of mail jobs

Make 'deliver_now' a frozen constant

c5b5895

Only pass a mailer-specific block to super if a block is provided

c8cc534

jdlubrano force-pushed the feature/have-enqueued-mail-matcher branch from 4dc20ae to c8cc534 Compare January 9, 2019 20:54

Fix hash rocket syntax for Ruby 1.8.7

53ac74a

JonRowe merged commit 1fb6e67 into rspec:master Jan 11, 2019

JonRowe added a commit that referenced this pull request Jan 11, 2019

Changelog for #2047

282200d

benoittgt mentioned this pull request Jan 12, 2019

Release rspec-rails 3.8.2 #2066

Closed

benoittgt pushed a commit to benoittgt/rspec-rails that referenced this pull request Jan 13, 2019

Changelog for rspec#2047

6779e0f

benoittgt mentioned this pull request Jan 16, 2019

3.8.2 release #2067

Merged

8 tasks

benoittgt pushed a commit to benoittgt/rspec-rails that referenced this pull request Jan 17, 2019

Backport: Changelog for rspec#2047

e8c0566

benoittgt pushed a commit to benoittgt/rspec-rails that referenced this pull request Jan 17, 2019

Backport: Changelog for rspec#2047

2ae472b

sebjacobs pushed a commit to futurelearn/rspec-rails that referenced this pull request Mar 15, 2019

Backport: Changelog for rspec#2047

6e29b6a

benoittgt pushed a commit to benoittgt/rspec-rails that referenced this pull request May 1, 2019

Changelog for rspec#2047

0a50a9c

ignatiusreza mentioned this pull request May 4, 2019

add missing require to have_enqueued_mail #2117

Merged

jdlubrano deleted the feature/have-enqueued-mail-matcher branch February 14, 2020 22:13

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Feature/have enqueued mail matcher #2047

Feature/have enqueued mail matcher #2047

jdlubrano commented Dec 11, 2018

JonRowe left a comment

jdlubrano commented Dec 13, 2018

jdlubrano commented Dec 31, 2018

JonRowe commented Jan 2, 2019

JonRowe Jan 2, 2019

jdlubrano Jan 3, 2019

JonRowe Jan 2, 2019

jdlubrano Jan 3, 2019

JonRowe Jan 3, 2019

jdlubrano commented Jan 3, 2019

benoittgt commented Jan 3, 2019

JonRowe Jan 3, 2019

jdlubrano commented Jan 4, 2019

JonRowe commented Jan 4, 2019

JonRowe commented Jan 9, 2019

jdlubrano commented Jan 11, 2019

Feature/have enqueued mail matcher #2047

Feature/have enqueued mail matcher #2047

Conversation

jdlubrano commented Dec 11, 2018

JonRowe left a comment

Choose a reason for hiding this comment

jdlubrano commented Dec 13, 2018

jdlubrano commented Dec 31, 2018

JonRowe commented Jan 2, 2019

JonRowe Jan 2, 2019

Choose a reason for hiding this comment

jdlubrano Jan 3, 2019

Choose a reason for hiding this comment

JonRowe Jan 2, 2019

Choose a reason for hiding this comment

jdlubrano Jan 3, 2019

Choose a reason for hiding this comment

JonRowe Jan 3, 2019

Choose a reason for hiding this comment

jdlubrano commented Jan 3, 2019

benoittgt commented Jan 3, 2019

JonRowe Jan 3, 2019

Choose a reason for hiding this comment

jdlubrano commented Jan 4, 2019

JonRowe commented Jan 4, 2019

JonRowe commented Jan 9, 2019

jdlubrano commented Jan 11, 2019