email_spec 2.2.1 → 2.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 11bdd9e521aecbb968f672214cc109869f111f1ac981b793e1a3c41bcf4691ce
-  data.tar.gz: 7cd61105485eae764f8786ef4a3e2ccdbd9309f8d020f883177d8d62df7df184
+  metadata.gz: 67b5cef2ce1c7cb7d919d61567a3fcdedab6747bf016962ca03da9b1d2abf660
+  data.tar.gz: 3694cba82a8b25469d5c0a7e5ec9f7d688471d357926a46cb37e7290320222f8
 SHA512:
-  metadata.gz: 540ed6ea489564623c0ab0c781c70842782b8485307cf70d7396fc0221896ac396cae83a58d72e64586bb879b58a68b3e93b61f24120586657fe9acaea9f9486
-  data.tar.gz: 57b37098385ff0d8f545e385195693ddf67c04d03d4c37a9219cf4677d36cc2a880e0dea6bca6eed595ac977eb9afd1841062d180e47410ce5ec6fe20c1820fd
+  metadata.gz: 780394b891b7fbcc9a75629fd20608e99730cca2a1ecf5882193d7e8f2fc59fd115c4360d517c1a0f94d7b6e8ca56c0bf01e00ae91f8f42f592d0d169fed09ae
+  data.tar.gz: 790bb0a29b5c44aacb5ddfb5c9d9f049cedea133df51a2ccf66c41f364b4610450ebb01ce4aa92a2f18ef815e4c48d402863fcb5a41530e7d819f3475242f01c

data/Changelog.md

@@ -1,6 +1,13 @@
+## 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/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/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/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module EmailSpec
-  VERSION = '2.2.1'
+  VERSION = "2.2.2"
 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

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.2.2
 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: 2023-06-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: htmlentities
@@ -227,6 +227,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 +261,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
@@ -309,7 +311,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.21
+rubygems_version: 3.4.10
 signing_key:
 specification_version: 4
 summary: Easily test email in RSpec, Cucumber or Minitest