email_spec 2.2.1 → 2.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 11bdd9e521aecbb968f672214cc109869f111f1ac981b793e1a3c41bcf4691ce
-  data.tar.gz: 7cd61105485eae764f8786ef4a3e2ccdbd9309f8d020f883177d8d62df7df184
+  metadata.gz: 4e0a37bd9d3d9eaa30f18b427930baa52d8b895b50d4d7b831650d621a9c955e
+  data.tar.gz: 4193090888bee1123f782507dc6c8496b9bca6ff0aea94612624a48f9d45d65b
 SHA512:
-  metadata.gz: 540ed6ea489564623c0ab0c781c70842782b8485307cf70d7396fc0221896ac396cae83a58d72e64586bb879b58a68b3e93b61f24120586657fe9acaea9f9486
-  data.tar.gz: 57b37098385ff0d8f545e385195693ddf67c04d03d4c37a9219cf4677d36cc2a880e0dea6bca6eed595ac977eb9afd1841062d180e47410ce5ec6fe20c1820fd
+  metadata.gz: 97b61a1089f4c29bdcfffca000405a5d66bc2430dca4c9e293090cea5a12ebae9bacc108c3663b9a3961a5f955d59a0870a28c53a19d0782ed9d66ff6cfea15a
+  data.tar.gz: b38641514a7ceace6ea75f178865dffd9b910cebbc2eb28fea8c1ea3a7f64786e248900f34dd881f722c251ceb12e5f52f071257cf10b15eb316ad1a2e9e9427

data/Changelog.md

@@ -1,6 +1,20 @@
+## 2.3.0 2024-07-21
+
+* [Support the specified name and address for bcc_to and cc_to matchers](https://github.com/email-spec/email-spec/pull/212)
+* [Allow launchy 3.x versions](https://github.com/email-spec/email-spec/pull/226)
+* [Replace deprecated/removed File.exists? alias](https://github.com/email-spec/email-spec/pull/223)
+* [Extend have_body_text matcher to be able to specify which part in multipart to check](https://github.com/email-spec/email-spec/pull/196)
+
+## 2.2.2 2023-06-26
+
+* [Defer accommodating different delivery methods to runtime](https://github.com/email-spec/email-spec/pull/224)
+
 ## 2.2.1 2022-09-12
 
-* [Patch for eager loading](https://github.com/email-spec/email-spec/pull/219)
+* [Support to decode part in EmailSpec::MailExt#default_part_body](https://github.com/email-spec/email-spec/pull/211)
+* [Drop rubyforge_project from gemspec](https://github.com/email-spec/email-spec/pull/215)
+* [Avoid eagerly loading ActionMailer::Base](https://github.com/email-spec/email-spec/pull/219)
+* [README: use SVG badges](https://github.com/email-spec/email-spec/pull/217)
 
 ## 2.2.0 2018-04-03
 

data/README.md

@@ -302,6 +302,15 @@ expect(email).to have_body_text(/Hi Jojo Binks,/)
 ```
 
 
+You can specify which part in multipart to check with `in_html_part` or
+`in_text_part`.
+
+```ruby
+email = UserMailer.("jojo@yahoo.com", "Jojo Binks")
+expect(email).to have_body_text(/This is html/).in_html_part
+expect(email).to have_body_text(/This is text/).in_text_part
+```
+
 ##### have_header(key, value)
 
 This checks that the expected key/value pair is in the headers of the email.

data/examples/rails4_root/features/step_definitions/email_steps.rb

@@ -0,0 +1,226 @@
+# Commonly used email steps
+#
+# To add your own steps make a custom_email_steps.rb
+# The provided methods are:
+#
+# last_email_address
+# reset_mailer
+# open_last_email
+# visit_in_email
+# unread_emails_for
+# mailbox_for
+# current_email
+# open_email
+# read_emails_for
+# find_email
+#
+# General form for email scenarios are:
+#   - clear the email queue (done automatically by email_spec)
+#   - execute steps that sends an email
+#   - check the user received an/no/[0-9] emails
+#   - open the email
+#   - inspect the email contents
+#   - interact with the email (e.g. click links)
+#
+# The Cucumber steps below are setup in this order.
+
+module EmailHelpers
+  def current_email_address
+    # Replace with your a way to find your current email. e.g @current_user.email
+    # last_email_address will return the last email address used by email spec to find an email.
+    # Note that last_email_address will be reset after each Scenario.
+    last_email_address || "example@example.com"
+  end
+end
+
+World(EmailHelpers)
+
+#
+# Reset the e-mail queue within a scenario.
+# This is done automatically before each scenario.
+#
+
+Given /^(?:a clear email queue|no emails have been sent)$/ do
+  reset_mailer
+end
+
+#
+# Check how many emails have been sent/received
+#
+
+Then /^(?:I|they|"([^"]*?)") should receive (an|no|\d+) emails?$/ do |address, amount|
+  expect(unread_emails_for(address).size).to eql parse_email_count(amount)
+end
+
+Then /^(?:I|they|"([^"]*?)") should have (an|no|\d+) emails?$/ do |address, amount|
+  expect(mailbox_for(address).size).to eql parse_email_count(amount)
+end
+
+Then /^(?:I|they|"([^"]*?)") should receive (an|no|\d+) emails? with subject "([^"]*?)"$/ do |address, amount, subject|
+  expect(unread_emails_for(address).select { |m| m.subject =~ Regexp.new(Regexp.escape(subject)) }.size).to eql parse_email_count(amount)
+end
+
+Then /^(?:I|they|"([^"]*?)") should receive (an|no|\d+) emails? with subject \/([^"]*?)\/$/ do |address, amount, subject|
+  expect(unread_emails_for(address).select { |m| m.subject =~ Regexp.new(subject) }.size).to eql parse_email_count(amount)
+end
+
+Then /^(?:I|they|"([^"]*?)") should receive an email with the following body:$/ do |address, expected_body|
+  open_email(address, :with_text => expected_body)
+end
+
+#
+# Accessing emails
+#
+
+# Opens the most recently received email
+When /^(?:I|they|"([^"]*?)") opens? the email$/ do |address|
+  open_email(address)
+end
+
+When /^(?:I|they|"([^"]*?)") opens? the email with subject "([^"]*?)"$/ do |address, subject|
+  open_email(address, :with_subject => subject)
+end
+
+When /^(?:I|they|"([^"]*?)") opens? the email with subject \/([^"]*?)\/$/ do |address, subject|
+  open_email(address, :with_subject => Regexp.new(subject))
+end
+
+When /^(?:I|they|"([^"]*?)") opens? the email with text "([^"]*?)"$/ do |address, text|
+  open_email(address, :with_text => text)
+end
+
+When /^(?:I|they|"([^"]*?)") opens? the email with text \/([^"]*?)\/$/ do |address, text|
+  open_email(address, :with_text => Regexp.new(text))
+end
+
+#
+# Inspect the Email Contents
+#
+
+Then /^(?:I|they) should see "([^"]*?)" in the email subject$/ do |text|
+  expect(current_email).to have_subject(text)
+end
+
+Then /^(?:I|they) should see \/([^"]*?)\/ in the email subject$/ do |text|
+  expect(current_email).to have_subject(Regexp.new(text))
+end
+
+Then /^(?:I|they) should not see "([^"]*?)" in the email subject$/ do |text|
+  expect(current_email).not_to have_subject(text)
+end
+
+Then /^(?:I|they) should not see \/([^"]*?)\/ in the email subject$/ do |text|
+  expect(current_email).not_to have_subject(Regexp.new(text))
+end
+
+Then /^(?:I|they) should see "([^"]*?)" in the email body$/ do |text|
+  expect(current_email.default_part_body.to_s).to include(text)
+end
+
+Then /^(?:I|they) should not see "([^"]*?)" in the email body$/ do |text|
+  expect(current_email.default_part_body.to_s).not_to include(text)
+end
+
+Then /^(?:I|they) should see \/([^"]*?)\/ in the email body$/ do |text|
+  expect(current_email.default_part_body.to_s).to match Regexp.new(text)
+end
+
+Then /^(?:I|they) should not see \/([^"]*?)\/ in the email body$/ do |text|
+  expect(current_email.default_part_body.to_s).not_to match Regexp.new(text)
+end
+
+Then /^(?:I|they) should see the email delivered from "([^"]*?)"$/ do |text|
+  expect(current_email).to be_delivered_from(text)
+end
+
+Then /^(?:I|they) should see the email reply to "([^"]*?)"$/ do |text|
+  expect(current_email).to have_reply_to(text)
+end
+
+Then /^(?:I|they) should see "([^\"]*)" in the email "([^"]*?)" header$/ do |text, name|
+  expect(current_email).to have_header(name, text)
+end
+
+Then /^(?:I|they) should see \/([^\"]*)\/ in the email "([^"]*?)" header$/ do |text, name|
+  expect(current_email).to have_header(name, Regexp.new(text))
+end
+
+Then /^I should see it is a multi\-part email$/ do
+    expect(current_email).to be_multipart
+end
+
+Then /^(?:I|they) should see "([^"]*?)" in the email html part body$/ do |text|
+    expect(current_email.html_part.body.to_s).to include(text)
+end
+
+Then /^(?:I|they) should see "([^"]*?)" in the email text part body$/ do |text|
+    expect(current_email.text_part.body.to_s).to include(text)
+end
+
+#
+# Inspect the Email Attachments
+#
+
+Then /^(?:I|they) should see (an|no|\d+) attachments? with the email$/ do |amount|
+  expect(current_email_attachments.size).to eql parse_email_count(amount)
+end
+
+Then /^there should be (an|no|\d+) attachments? named "([^"]*?)"$/ do |amount, filename|
+  expect(current_email_attachments.select { |a| a.filename == filename }.size).to eql parse_email_count(amount)
+end
+
+Then /^attachment (\d+) should be named "([^"]*?)"$/ do |index, filename|
+  expect(current_email_attachments[(index.to_i - 1)].filename).to eql filename
+end
+
+Then /^there should be (an|no|\d+) attachments? of type "([^"]*?)"$/ do |amount, content_type|
+  expect(current_email_attachments.select { |a| a.content_type.include?(content_type) }.size).to eql parse_email_count(amount)
+end
+
+Then /^attachment (\d+) should be of type "([^"]*?)"$/ do |index, content_type|
+  expect(current_email_attachments[(index.to_i - 1)].content_type).to include(content_type)
+end
+
+Then /^all attachments should not be blank$/ do
+  current_email_attachments.each do |attachment|
+    expect(attachment.read.size).to_not eql 0
+  end
+end
+
+Then /^show me a list of email attachments$/ do
+  EmailSpec::EmailViewer::save_and_open_email_attachments_list(current_email)
+end
+
+#
+# Interact with Email Contents
+#
+
+When /^(?:I|they|"([^"]*?)") follows? "([^"]*?)" in the email$/ do |address, link|
+  visit_in_email(link, address)
+end
+
+When /^(?:I|they) click the first link in the email$/ do
+  click_first_link_in_email
+end
+
+#
+# Debugging
+# These only work with Rails and OSx ATM since EmailViewer uses RAILS_ROOT and OSx's 'open' command.
+# Patches accepted. ;)
+#
+
+Then /^save and open current email$/ do
+  EmailSpec::EmailViewer::save_and_open_email(current_email)
+end
+
+Then /^save and open all text emails$/ do
+  EmailSpec::EmailViewer::save_and_open_all_text_emails
+end
+
+Then /^save and open all html emails$/ do
+  EmailSpec::EmailViewer::save_and_open_all_html_emails
+end
+
+Then /^save and open all raw emails$/ do
+  EmailSpec::EmailViewer::save_and_open_all_raw_emails
+end

data/examples/sinatra_root/features/step_definitions/email_steps.rb

@@ -0,0 +1,226 @@
+# Commonly used email steps
+#
+# To add your own steps make a custom_email_steps.rb
+# The provided methods are:
+#
+# last_email_address
+# reset_mailer
+# open_last_email
+# visit_in_email
+# unread_emails_for
+# mailbox_for
+# current_email
+# open_email
+# read_emails_for
+# find_email
+#
+# General form for email scenarios are:
+#   - clear the email queue (done automatically by email_spec)
+#   - execute steps that sends an email
+#   - check the user received an/no/[0-9] emails
+#   - open the email
+#   - inspect the email contents
+#   - interact with the email (e.g. click links)
+#
+# The Cucumber steps below are setup in this order.
+
+module EmailHelpers
+  def current_email_address
+    # Replace with your a way to find your current email. e.g @current_user.email
+    # last_email_address will return the last email address used by email spec to find an email.
+    # Note that last_email_address will be reset after each Scenario.
+    last_email_address || "example@example.com"
+  end
+end
+
+World(EmailHelpers)
+
+#
+# Reset the e-mail queue within a scenario.
+# This is done automatically before each scenario.
+#
+
+Given /^(?:a clear email queue|no emails have been sent)$/ do
+  reset_mailer
+end
+
+#
+# Check how many emails have been sent/received
+#
+
+Then /^(?:I|they|"([^"]*?)") should receive (an|no|\d+) emails?$/ do |address, amount|
+  expect(unread_emails_for(address).size).to eql parse_email_count(amount)
+end
+
+Then /^(?:I|they|"([^"]*?)") should have (an|no|\d+) emails?$/ do |address, amount|
+  expect(mailbox_for(address).size).to eql parse_email_count(amount)
+end
+
+Then /^(?:I|they|"([^"]*?)") should receive (an|no|\d+) emails? with subject "([^"]*?)"$/ do |address, amount, subject|
+  expect(unread_emails_for(address).select { |m| m.subject =~ Regexp.new(Regexp.escape(subject)) }.size).to eql parse_email_count(amount)
+end
+
+Then /^(?:I|they|"([^"]*?)") should receive (an|no|\d+) emails? with subject \/([^"]*?)\/$/ do |address, amount, subject|
+  expect(unread_emails_for(address).select { |m| m.subject =~ Regexp.new(subject) }.size).to eql parse_email_count(amount)
+end
+
+Then /^(?:I|they|"([^"]*?)") should receive an email with the following body:$/ do |address, expected_body|
+  open_email(address, :with_text => expected_body)
+end
+
+#
+# Accessing emails
+#
+
+# Opens the most recently received email
+When /^(?:I|they|"([^"]*?)") opens? the email$/ do |address|
+  open_email(address)
+end
+
+When /^(?:I|they|"([^"]*?)") opens? the email with subject "([^"]*?)"$/ do |address, subject|
+  open_email(address, :with_subject => subject)
+end
+
+When /^(?:I|they|"([^"]*?)") opens? the email with subject \/([^"]*?)\/$/ do |address, subject|
+  open_email(address, :with_subject => Regexp.new(subject))
+end
+
+When /^(?:I|they|"([^"]*?)") opens? the email with text "([^"]*?)"$/ do |address, text|
+  open_email(address, :with_text => text)
+end
+
+When /^(?:I|they|"([^"]*?)") opens? the email with text \/([^"]*?)\/$/ do |address, text|
+  open_email(address, :with_text => Regexp.new(text))
+end
+
+#
+# Inspect the Email Contents
+#
+
+Then /^(?:I|they) should see "([^"]*?)" in the email subject$/ do |text|
+  expect(current_email).to have_subject(text)
+end
+
+Then /^(?:I|they) should see \/([^"]*?)\/ in the email subject$/ do |text|
+  expect(current_email).to have_subject(Regexp.new(text))
+end
+
+Then /^(?:I|they) should not see "([^"]*?)" in the email subject$/ do |text|
+  expect(current_email).not_to have_subject(text)
+end
+
+Then /^(?:I|they) should not see \/([^"]*?)\/ in the email subject$/ do |text|
+  expect(current_email).not_to have_subject(Regexp.new(text))
+end
+
+Then /^(?:I|they) should see "([^"]*?)" in the email body$/ do |text|
+  expect(current_email.default_part_body.to_s).to include(text)
+end
+
+Then /^(?:I|they) should not see "([^"]*?)" in the email body$/ do |text|
+  expect(current_email.default_part_body.to_s).not_to include(text)
+end
+
+Then /^(?:I|they) should see \/([^"]*?)\/ in the email body$/ do |text|
+  expect(current_email.default_part_body.to_s).to match Regexp.new(text)
+end
+
+Then /^(?:I|they) should not see \/([^"]*?)\/ in the email body$/ do |text|
+  expect(current_email.default_part_body.to_s).not_to match Regexp.new(text)
+end
+
+Then /^(?:I|they) should see the email delivered from "([^"]*?)"$/ do |text|
+  expect(current_email).to be_delivered_from(text)
+end
+
+Then /^(?:I|they) should see the email reply to "([^"]*?)"$/ do |text|
+  expect(current_email).to have_reply_to(text)
+end
+
+Then /^(?:I|they) should see "([^\"]*)" in the email "([^"]*?)" header$/ do |text, name|
+  expect(current_email).to have_header(name, text)
+end
+
+Then /^(?:I|they) should see \/([^\"]*)\/ in the email "([^"]*?)" header$/ do |text, name|
+  expect(current_email).to have_header(name, Regexp.new(text))
+end
+
+Then /^I should see it is a multi\-part email$/ do
+    expect(current_email).to be_multipart
+end
+
+Then /^(?:I|they) should see "([^"]*?)" in the email html part body$/ do |text|
+    expect(current_email.html_part.body.to_s).to include(text)
+end
+
+Then /^(?:I|they) should see "([^"]*?)" in the email text part body$/ do |text|
+    expect(current_email.text_part.body.to_s).to include(text)
+end
+
+#
+# Inspect the Email Attachments
+#
+
+Then /^(?:I|they) should see (an|no|\d+) attachments? with the email$/ do |amount|
+  expect(current_email_attachments.size).to eql parse_email_count(amount)
+end
+
+Then /^there should be (an|no|\d+) attachments? named "([^"]*?)"$/ do |amount, filename|
+  expect(current_email_attachments.select { |a| a.filename == filename }.size).to eql parse_email_count(amount)
+end
+
+Then /^attachment (\d+) should be named "([^"]*?)"$/ do |index, filename|
+  expect(current_email_attachments[(index.to_i - 1)].filename).to eql filename
+end
+
+Then /^there should be (an|no|\d+) attachments? of type "([^"]*?)"$/ do |amount, content_type|
+  expect(current_email_attachments.select { |a| a.content_type.include?(content_type) }.size).to eql parse_email_count(amount)
+end
+
+Then /^attachment (\d+) should be of type "([^"]*?)"$/ do |index, content_type|
+  expect(current_email_attachments[(index.to_i - 1)].content_type).to include(content_type)
+end
+
+Then /^all attachments should not be blank$/ do
+  current_email_attachments.each do |attachment|
+    expect(attachment.read.size).to_not eql 0
+  end
+end
+
+Then /^show me a list of email attachments$/ do
+  EmailSpec::EmailViewer::save_and_open_email_attachments_list(current_email)
+end
+
+#
+# Interact with Email Contents
+#
+
+When /^(?:I|they|"([^"]*?)") follows? "([^"]*?)" in the email$/ do |address, link|
+  visit_in_email(link, address)
+end
+
+When /^(?:I|they) click the first link in the email$/ do
+  click_first_link_in_email
+end
+
+#
+# Debugging
+# These only work with Rails and OSx ATM since EmailViewer uses RAILS_ROOT and OSx's 'open' command.
+# Patches accepted. ;)
+#
+
+Then /^save and open current email$/ do
+  EmailSpec::EmailViewer::save_and_open_email(current_email)
+end
+
+Then /^save and open all text emails$/ do
+  EmailSpec::EmailViewer::save_and_open_all_text_emails
+end
+
+Then /^save and open all html emails$/ do
+  EmailSpec::EmailViewer::save_and_open_all_html_emails
+end
+
+Then /^save and open all raw emails$/ do
+  EmailSpec::EmailViewer::save_and_open_all_raw_emails
+end

data/features/step_definitions/app_steps.rb

@@ -6,13 +6,13 @@ Given /^the (\w+) app is setup with the latest email steps$/ do |app_name|
                                'email_steps.rb')
   latest_specs_path = File.join(root_dir, 'lib', 'generators', 'email_spec',
                                 'steps', 'templates','email_steps.rb')
-  FileUtils.rm(email_specs_path) if File.exists?(email_specs_path)
+  FileUtils.rm(email_specs_path) if File.exist?(email_specs_path)
   FileUtils.cp_r(latest_specs_path, email_specs_path)
 end
 
 Then /^the (\w+) app should have the email steps in place$/ do |app_name|
   email_specs_path = "#{root_dir}/examples/#{app_name}_root/features/step_definitions/email_steps.rb"
-  expect(File.exists?(email_specs_path)).to be true
+  expect(File.exist?(email_specs_path)).to be true
 end
 
 Then /^I should see the following summary report:$/ do |expected_report|
@@ -22,7 +22,7 @@ end
 Given /^the (\w+) app is setup with the latest generators$/ do |app_name|
   app_dir= File.join(root_dir,'examples',"#{app_name}_root")
   email_specs_path = File.join(app_dir,'features','step_definitions','email_steps.rb')
-  FileUtils.rm(email_specs_path) if File.exists?(email_specs_path)
+  FileUtils.rm(email_specs_path) if File.exist?(email_specs_path)
 
   if app_name == 'rails4'
     #Testing using the gem
@@ -46,7 +46,7 @@ When /^I run "([^\"]*)" in the (\w+) app$/ do |cmd, app_name|
   app_specific_gemfile = File.join(app_path,'Gemfile')
   Dir.chdir(app_path) do
     #hack to fight competing bundles (email specs vs rails4_root's
-    if File.exists? app_specific_gemfile
+    if File.exist? app_specific_gemfile
       orig_gemfile = ENV['BUNDLE_GEMFILE']
       ENV['BUNDLE_GEMFILE'] = app_specific_gemfile
       @output = `#{cmd}`

data/lib/email_spec/deliveries.rb

@@ -1,5 +1,5 @@
 module EmailSpec
-  module MailerDeliveries
+  module Deliveries
     def all_emails
       deliveries
     end
@@ -9,7 +9,9 @@ module EmailSpec
     end
 
     def reset_mailer
-      if defined?(ActionMailer) && ActionMailer::Base.delivery_method == :cache
+      if defined?(ActionMailer) && ActionMailer::Base.delivery_method == :activerecord
+        Email.delete_all
+      elsif defined?(ActionMailer) && ActionMailer::Base.delivery_method == :cache
         mailer.clear_cache
       else
         deliveries.clear
@@ -23,36 +25,22 @@ module EmailSpec
     protected
 
     def deliveries
-      if ActionMailer::Base.delivery_method == :cache
+      if defined?(Pony)
+        Pony.deliveries
+      elsif ActionMailer::Base.delivery_method == :activerecord
+        Email.all.map { |email| parse_ar_to_mail(email) }
+      elsif ActionMailer::Base.delivery_method == :cache
         mailer.cached_deliveries
       else
         mailer.deliveries
       end
     end
-  end
-
-  module ARMailerDeliveries
-    def all_emails
-      Email.all.map{ |email| parse_to_mail(email) }
-    end
 
-    def last_email_sent
-      if email = Email.last
-        parse_to_mail(email)
-      else
-        raise("No email has been sent!")
-      end
+    def mailer
+      ActionMailer::Base
     end
 
-    def reset_mailer
-      Email.delete_all
-    end
-
-    def mailbox_for(address)
-      Email.all.select { |email| email.destinations.include?(address) }.map{ |email| parse_to_mail(email) }
-    end
-
-    def parse_to_mail(email)
+    def parse_ar_to_mail(email)
       Mail.read(email.mail)
     end
   end
@@ -68,24 +56,4 @@ module EmailSpec
       end
     end
   end
-
-  module Deliveries
-    if defined?(Pony)
-      def deliveries; Pony::deliveries ; end
-      include EmailSpec::MailerDeliveries
-    else
-      ActiveSupport.on_load(:action_mailer) do
-        if delivery_method == :activerecord
-          ::EmailSpec::Helpers.include EmailSpec::ARMailerDeliveries
-        else
-          ::EmailSpec::Deliveries.module_eval do
-            def mailer
-              ActionMailer::Base
-            end
-          end
-          ::EmailSpec::Helpers.include ::EmailSpec::MailerDeliveries
-        end
-      end
-    end
-  end
 end

data/lib/email_spec/extractors.rb

@@ -0,0 +1,45 @@
+module EmailSpec
+  module Extractors
+    class Base
+      attr_accessor :mail
+
+      def initialize(mail)
+        @mail = mail
+      end
+
+      def call
+        part_body ? HTMLEntities.new.decode(part_body) : ''
+      end
+
+      private
+
+      def part_body
+        raise NotImplementedError
+      end
+    end
+
+    class DefaultPartBody < Base
+      private
+
+      def part_body
+        (mail.html_part || mail.text_part || mail).body
+      end
+    end
+
+    class HtmlPartBody < Base
+      private
+
+      def part_body
+        mail.html_part ? mail.html_part.body : nil
+      end
+    end
+
+    class TextPartBody < Base
+      private
+
+      def part_body
+        mail.text_part ? mail.text_part.body : nil
+      end
+    end
+  end
+end

data/lib/email_spec/matchers.rb

@@ -1,3 +1,5 @@
+require_relative 'extractors'
+
 module EmailSpec
   module Matchers
     class EmailMatcher
@@ -128,7 +130,7 @@ module EmailSpec
 
       def matches?(email)
         @email = email
-        @actual_recipients = address_array{ email.bcc }.sort
+        @actual_recipients = address_array { email[:bcc].formatted }.sort
         @actual_recipients == @expected_email_addresses
       end
 
@@ -162,7 +164,7 @@ module EmailSpec
 
       def matches?(email)
         @email = email
-        @actual_recipients = address_array { email.cc }.sort
+        @actual_recipients = address_array { email[:cc].formatted }.sort
         @actual_recipients == @expected_email_addresses
       end
 
@@ -274,6 +276,7 @@ module EmailSpec
 
       def initialize(text)
         @expected_text = text
+        @extractor = EmailSpec::Extractors::DefaultPartBody
       end
 
       def description
@@ -284,13 +287,23 @@ module EmailSpec
         end
       end
 
+      def in_html_part
+        @extractor = EmailSpec::Extractors::HtmlPartBody
+        self
+      end
+
+      def in_text_part
+        @extractor = EmailSpec::Extractors::TextPartBody
+        self
+      end
+
       def matches?(email)
         if @expected_text.is_a?(String)
-          @given_text = email.default_part_body.to_s.gsub(/\s+/, " ")
+          @given_text = @extractor.new(email).call.to_s.gsub(/\s+/, " ")
           @expected_text = @expected_text.gsub(/\s+/, " ")
           @given_text.include?(@expected_text)
         else
-          @given_text = email.default_part_body.to_s
+          @given_text = @extractor.new(email).call.to_s
           !!(@given_text =~ @expected_text)
         end
       end
@@ -358,7 +371,14 @@ module EmailSpec
       alias negative_failure_message failure_message_when_negated
 
       def mail_headers_hash(email_headers)
-        email_headers.fields.inject({}) { |hash, field| hash[field.field.class::FIELD_NAME] = field.to_s; hash }
+        email_headers.fields.inject({}) do |hash, field|
+          if field.field.class.const_defined?('FIELD_NAME')
+            hash[field.field.class::FIELD_NAME] = field.to_s
+          else
+            hash[field.field.class::NAME.downcase] = field.to_s
+          end
+          hash
+        end
       end
     end
 

data/lib/email_spec/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module EmailSpec
-  VERSION = '2.2.1'
+  VERSION = "2.3.0"
 end

data/spec/email_spec/mail_ext_spec.rb

@@ -1,5 +1,4 @@
 require 'spec_helper'
-require 'active_support'
 
 describe EmailSpec::MailExt do
   describe "#default_part" do
@@ -40,8 +39,9 @@ describe EmailSpec::MailExt do
     it "decodes parts before return" do
       email = Mail.new(:body => "hello\r\nquoted-printable")
       email.content_transfer_encoding = 'quoted-printable'
-      expect(email.encoded).to include("hello=0D\nquoted-printable")
-      expect(email.default_part_body).to eq("hello\r\nquoted-printable")
+      
+      expect(email.encoded).to include("hello\r\nquoted-printable=")
+      expect(email.default_part_body).to eq("hello\nquoted-printable")
     end
   end
 

data/spec/email_spec/matchers_spec.rb

@@ -137,7 +137,7 @@ describe EmailSpec::Matchers do
     end
 
     it "should not match when the email does not have a sender" do
-      email = Mail::Message.new(:from => nil)
+      email = Mail::Message.new(:from => "johnshow@yahoo.com")
       expect(deliver_from("jimmy_bean@yahoo.com")).not_to match(email)
     end
 
@@ -178,6 +178,12 @@ describe EmailSpec::Matchers do
       expect(bcc_to("jimmy_bean@yahoo.com")).to match(email)
     end
 
+    it "should match when the email is set to deliver to the specified name and address" do
+      email = Mail::Message.new(:bcc => "Jimmy Bean <jimmy_bean@yahoo.com>")
+
+      expect(bcc_to("Jimmy Bean <jimmy_bean@yahoo.com>")).to match(email)
+    end
+
     it "should match when a list of emails is exact same as all of the email's recipients" do
       email = Mail::Message.new(:bcc => ["james@yahoo.com", "karen@yahoo.com"])
 
@@ -214,6 +220,12 @@ describe EmailSpec::Matchers do
       expect(cc_to("jimmy_bean@yahoo.com")).to match(email)
     end
 
+    it "should match when the email is set to deliver to the specified name and address" do
+      email = Mail::Message.new(:cc => "Jimmy Bean <jimmy_bean@yahoo.com>")
+
+      expect(cc_to("Jimmy Bean <jimmy_bean@yahoo.com>")).to match(email)
+    end
+
     it "should match when a list of emails is exact same as all of the email's recipients" do
       email = Mail::Message.new(:cc => ["james@yahoo.com", "karen@yahoo.com"])
 
@@ -454,6 +466,106 @@ describe EmailSpec::Matchers do
     end
   end
 
+  describe "#have_body_text", ".in_html_part" do
+    describe 'when html part is definded in mulitpart' do
+      it 'should match when the body matches regexp' do
+        email = Mail.new do
+          html_part do
+            body 'This is html'
+          end
+        end
+
+        expect(have_body_text(/This is html/).in_html_part).to match(email)
+      end
+    end
+
+    describe 'when text part is definded in mulitpart' do
+      it 'should not look at text part' do
+        email = Mail.new do
+          text_part do
+            body 'This is text'
+          end
+        end
+
+        expect(have_body_text(/This is text/).in_html_part).not_to match(email)
+      end
+    end
+
+    describe 'when html and text parts are definded in mulitpart' do
+      it 'should look at html part' do
+        email = Mail.new do
+          html_part do
+            body 'This is html'
+          end
+          text_part do
+            body 'This is text'
+          end
+        end
+
+        expect(have_body_text(/This is html/).in_html_part).to match(email)
+        expect(have_body_text(/This is text/).in_html_part).not_to match(email)
+      end
+    end
+
+    describe 'when nothing is defined in mulitpart' do
+      it 'should not look at any parts' do
+        email = Mail.new(body: 'This is body')
+
+        expect(have_body_text(/This is body/).in_html_part).not_to match(email)
+      end
+    end
+  end
+
+  describe "#have_body_text", ".in_text_part" do
+    describe 'when text part is definded in mulitpart' do
+      it 'should match when the body matches regexp' do
+        email = Mail.new do
+          text_part do
+            body 'This is text'
+          end
+        end
+
+        expect(have_body_text(/This is text/).in_text_part).to match(email)
+      end
+    end
+
+    describe 'when text and html parts are definded in mulitpart' do
+      it 'should look at text part' do
+        email = Mail.new do
+          text_part do
+            body 'This is text'
+          end
+
+          html_part do
+            body 'This is html'
+          end
+        end
+
+        expect(have_body_text(/This is text/).in_text_part).to match(email)
+        expect(have_body_text(/This is html/).in_text_part).not_to match(email)
+      end
+    end
+
+    describe 'when html part is definded in mulitpart' do
+      it 'should not look at html part' do
+        email = Mail.new do
+          html_part do
+            body "This is html"
+          end
+        end
+
+        expect(have_body_text(/This is html/).in_text_part).not_to match(email)
+      end
+    end
+
+    describe 'when nothing is defined in mulitpart' do
+      it 'should not look at any parts' do
+        email = Mail.new(body: 'This is body')
+
+        expect(have_body_text(/This is body/).in_text_part).not_to match(email)
+      end
+    end
+  end
   describe "#have_header" do
     describe "when regexps are used" do
       it "should match when header matches passed in regexp" do

data/spec/spec_helper.rb

@@ -3,9 +3,6 @@ require 'action_mailer'
 require 'mail'
 require File.expand_path(File.dirname(__FILE__) + '/../lib/email_spec.rb')
 
-# Trigger loading ActionMailer::Base
-ActionMailer::Base
-
 RSpec.configure do |config|
   config.include EmailSpec::Helpers
   config.include EmailSpec::Matchers

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: email_spec
 version: !ruby/object:Gem::Version
-  version: 2.2.1
+  version: 2.3.0
 platform: ruby
 authors:
 - Ben Mabey
@@ -10,7 +10,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-09-12 00:00:00.000000000 Z
+date: 2024-07-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: htmlentities
@@ -30,16 +30,22 @@ dependencies:
   name: launchy
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '2.1'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '2.1'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4.0'
 - !ruby/object:Gem::Dependency
   name: mail
   requirement: !ruby/object:Gem::Requirement
@@ -82,20 +88,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 1.3.17
-- !ruby/object:Gem::Dependency
-  name: actionmailer
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '4.2'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '4.2'
 - !ruby/object:Gem::Dependency
   name: rack-test
   requirement: !ruby/object:Gem::Requirement
@@ -227,6 +219,7 @@ files:
 - examples/rails4_root/features/delayed_job.feature
 - examples/rails4_root/features/errors.feature
 - examples/rails4_root/features/example.feature
+- examples/rails4_root/features/step_definitions/email_steps.rb
 - examples/rails4_root/features/step_definitions/user_steps.rb
 - examples/rails4_root/features/step_definitions/web_steps.rb
 - examples/rails4_root/features/support/env.rb
@@ -260,6 +253,7 @@ files:
 - examples/sinatra_root/config.ru
 - examples/sinatra_root/features/errors.feature
 - examples/sinatra_root/features/example.feature
+- examples/sinatra_root/features/step_definitions/email_steps.rb
 - examples/sinatra_root/features/step_definitions/user_steps.rb
 - examples/sinatra_root/features/step_definitions/web_steps.rb
 - examples/sinatra_root/features/support/env.rb
@@ -276,6 +270,7 @@ files:
 - lib/email_spec/deliveries.rb
 - lib/email_spec/email_viewer.rb
 - lib/email_spec/errors.rb
+- lib/email_spec/extractors.rb
 - lib/email_spec/helpers.rb
 - lib/email_spec/mail_ext.rb
 - lib/email_spec/matchers.rb
@@ -309,7 +304,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.21
+rubygems_version: 3.5.10
 signing_key:
 specification_version: 4
 summary: Easily test email in RSpec, Cucumber or Minitest