email_spectacular 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0f37914ebc9f8c1fba4ef39afba24d808dce2557
-  data.tar.gz: 59dd333158d579bd98ba60c68eb795e9a88d380f
+  metadata.gz: 9271c7cddf1f63951c54a4685af8f6f8069ee9a8
+  data.tar.gz: aa500292e90e1d059b5434348fa6405cabafc02a
 SHA512:
-  metadata.gz: 17185632819ec97f045453a508ad419d4ea9bbb8f669415d070ccb249a118fcdaa7656ef7eea29d26062f5895396fba2cc91e65a8a3af396b2721f90cb96cd25
-  data.tar.gz: 1168413e77f916258af5a793dda207dfa0d98c4cda0e055c7e95e944393807faf175618eca0511e0d4083ec459b9ec54a110e886355479d62beaedd7c5f06b97
+  metadata.gz: 23a2af089ff52cce59e7c0922b933e34b1e055a0e7b87f2e14d0f06aebbc63e9cc76e8bb5a6c01ff5e1d306b71860f0a720c22e3e5e286db606703c7ae950070
+  data.tar.gz: 2d5f76c70907cf4d980c55e4712034e9c1d8e4368c3d3b730fc00c783ac54159669cbb9e51c10bfe70f3eeb1327383b01d30e326eea7289c50b541c6f06f0f26

data/README.md

@@ -1,4 +1,7 @@
-# EmailSpectacular
+<p align="center">
+  <img src="https://svgshare.com/i/CSb.svg" width="200px"><br/>
+  <h2 align="center">EmailSpectacular</h2>
+</p>
 
 [![Gem](https://img.shields.io/gem/dt/email_spectacular.svg)]()
 [![Build Status](https://travis-ci.org/greena13/email_spectacular.svg)](https://travis-ci.org/greena13/email_spectacular)
@@ -6,6 +9,16 @@
 
 High-level email spec helpers for acceptance, feature and request tests.
 
+## Basic Usage
+
+```ruby
+it 'does many things, including sending an email' do
+  # ...
+
+  expect(email).to have_been_sent.to('user@email.com')
+end
+```
+
 ## What EmailSpectacular is
 
 Expressive email assertions that let you succinctly describe when emails should and should not be sent.
@@ -27,22 +40,19 @@ end
 Add `email_spectacular` to your `spec/rails_helper.rb`
 
 ```ruby
-
-require 'email_spectacular'
-
-# ...
+require 'email_spectacular/rspec'
 
 RSpec.configure do |config|
   # ...
 
   email_spectacular_spec_types = %i[acceptance feature request]
-  
-  config.after(:each, type: email_spectacular_spec_types) do
-    # Clear emails between specs
-    clear_emails
-  end
-  
+
   email_spectacular_spec_types.each do |spec_type|
+    config.after(:each, type: spec_type) do
+      # Clear emails between specs
+      clear_emails
+    end
+    
     # Include email spectacular syntax in rspec tests
     config.include EmailSpectacular::RSpec, type: spec_type
   end
@@ -53,6 +63,46 @@ And then execute:
 
 ```bash
 bundle install
+```   
+
+### Configuration
+
+Email Spectacular is configured using the `configure` method. It's suggested you place this in your `spec/rails_helper.rb` file, after you require `email_specatular`:
+
+
+```ruby
+require 'email_spectacular/rspec'
+
+EmailSpectacular.configure do |config|
+  # Configuration here
+end
+```                   
+
+#### Setting the name of the email helper
+
+By default, Email Spectacular makes a `email` helper available for your expectation syntax (all examples below assume this default helper), however if this conflicts with anything in your test suite or is not preferred, you can specify a different helper name:
+
+```ruby
+EmailSpectacular.configure do |config|
+  config.helper_name = :an_email # Default is 'email' 
+end
+``` 
+
+#### Working with enqueued emails
+
+If your emails are not sent immediately in your application - using `deliver_later` - you must mock this method in test mode so they appear to have sent to Email Spectacular, which is enabled using the `mock_sending_enqueued_emails` option:
+
+```ruby
+EmailSpectacular.configure do |config|
+  # Mocks the enqueueing of emails so they appear in the list of sent email
+  config.mock_sending_enqueued_emails = true
+end
+```       
+
+This then enables the assertion `have_been_enqueued`, which has the same arguments and behaviour as `have_been_sent`, but will verify the email has been enqueued rather than sent immediately:
+
+```ruby
+expect(email).to have_been_enqueued.to('user@email.com')
 ```
 
 ## Usage
@@ -145,6 +195,16 @@ Emails can be cleared at any point by calling `clear_emails` in your tests. This
 
 If you followed in installation steps above, emails will automatically be cleared between each spec.
 
+## Gotchas and Troubleshooting
+
+EmailSpectacular expects your application to configure `ActionMailer` to store emails in the `ActionMailer::Base.deliveries` array.
+
+In a Rails app, this is done (automatically, by default) in your environment file: `config/environment/test.rb` 
+
+```ruby
+config.action_mailer.delivery_method = :test
+```
+
 ## Test suite
 
 `email_spectacular` comes with close-to-complete test coverage. You can run the test suite as follows:

data/email_spectacular.gemspec

@@ -21,12 +21,12 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(spec)/})
   spec.require_paths = ['lib']
 
-  spec.add_dependency 'actionmailer', '>= 0'
+  spec.add_dependency 'actionmailer'
   spec.add_dependency 'capybara', '~> 2.5', '>= 2.5.0'
 
-  spec.add_development_dependency 'bundler', '~> 1.6'
+  spec.add_development_dependency 'bundler', '~> 2'
   spec.add_development_dependency 'guard', '~> 2.1'
   spec.add_development_dependency 'guard-rspec', '~> 4.7'
-  spec.add_development_dependency 'rake', '~> 0'
+  spec.add_development_dependency 'rake', '>= 12.3.3'
   spec.add_development_dependency 'rspec', '>= 3.5.0'
 end

data/lib/email_spectacular.rb

@@ -1,6 +1,8 @@
 # frozen_string_literal: true
 
 require 'email_spectacular/version'
+require 'email_spectacular/adaptors/action_mailer_adaptor'
+require 'email_spectacular/extensions/action_mailer_extension'
 
 # High-level email spec helpers for acceptance, feature and request tests.
 #
@@ -8,4 +10,25 @@ require 'email_spectacular/version'
 #
 # @see https://github.com/greena13/email_spectacular EmailSpectacular Github page
 module EmailSpectacular
+  class << self
+    def helper_name=(method_name)
+      EmailSpectacular::ActionMailerAdaptor.alias_method method_name, :email
+      EmailSpectacular::ActionMailerAdaptor.remove_method :email
+    end
+
+    def mock_sending_enqueued_emails=(enabled)
+      return unless enabled
+
+      @_mocking_sending_enqueued_emails = true
+      ActionMailer::MessageDelivery.include(EmailSpectacular::ActionMailerExtension)
+    end
+
+    attr_reader :_mocking_sending_enqueued_emails
+
+    def configure
+      if block_given?
+        yield(EmailSpectacular)
+      end
+    end
+  end
 end

data/lib/email_spectacular/adaptors/action_mailer_adaptor.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module EmailSpectacular
+  module ActionMailerAdaptor
+    # Syntactic sugar for referencing the list of emails sent since the start of the
+    # test
+    #
+    # @example Asserting email has been sent
+    #   expect(email).to have_been_sent.to('test@email.com')
+    #
+    # @return [Array<Mail::Message>] List of sent emails
+    def email
+      ActionMailer::Base.deliveries
+    end
+
+    # Clears the list of sent emails.
+    #
+    # @return void
+    def clear_emails
+      ActionMailer::Base.deliveries = []
+    end
+  end
+end

data/lib/email_spectacular/adaptors/capybara_adaptor.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+require 'capybara'
+
+module EmailSpectacular
+  # Module for parsing email bodies
+  #
+  # @author Aleck Greenham
+  module CapybaraAdaptor
+    def parsed_email_parts(email)
+      email_parts_as_hash(email) do |email_part|
+        parse(email_part)
+      end
+    end
+
+    def raw_email_parts(email)
+      email_parts_as_hash(email)
+    end
+
+    private
+
+    def email_parts_as_hash(email)
+      if email.parts.any?
+        email.parts.each_with_object({}) do |email_part, memo|
+          decoded = email_part.body.decoded
+          memo[content_type_key(email_part)] = block_given? ? yield(decoded) : decoded
+        end
+      else
+        encoded = email.body.encoded
+        { content_type_key(email) => block_given? ? yield(encoded) : encoded }
+      end
+    end
+
+    def parse(target)
+      Capybara::Node::Simple.new(target)
+    end
+
+    def content_type_key(target)
+      target.content_type.split(';').first
+    end
+  end
+end

data/lib/email_spectacular/{dsl.rb → concerns/dsl.rb}

@@ -7,9 +7,10 @@ module EmailSpectacular
   module DSL
     def self.included(base) # rubocop:disable Metrics/MethodLength
       base.class_eval do
-        def initialize
+        def initialize(options = {})
           @scopes = {}
           @and_scope = nil
+          @enqueued = options[:enqueued]
         end
 
         # Allows chaining two assertions on the same email attribute together without
@@ -130,7 +131,7 @@ module EmailSpectacular
         #
         # @param [String] selector CSS selector that should match at least one sent
         #   email's body
-        # @return [EmailSpectacular::Expectation] reference to self, to allow for
+        # @return [EmailSpectacular::RSpecMatcher] reference to self, to allow for
         #   further method chaining
         def matching_selector(selector)
           @scopes[:matching_selector] ||= []

data/lib/email_spectacular/{failure_descriptions.rb → concerns/failure_descriptions.rb}

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
-require 'email_spectacular/parser'
-require 'email_spectacular/matchers'
+require 'email_spectacular/adaptors/capybara_adaptor'
+require 'email_spectacular/concerns/matchers'
 
 module EmailSpectacular
   # Module containing the helper methods to describe the difference between the expected
@@ -9,7 +9,7 @@ module EmailSpectacular
   #
   # @author Aleck Greenham
   module FailureDescriptions # rubocop:disable Metrics/ModuleLength
-    include Parser
+    include CapybaraAdaptor
 
     def self.included(base) # rubocop:disable Metrics/MethodLength
       base.class_eval do
@@ -19,7 +19,9 @@ module EmailSpectacular
           scopes.each do |attribute, expected|
             matching_emails =
               emails.select do |email|
-                email_matches?(email, EmailSpectacular::Matchers::MATCHERS[attribute], expected)
+                email_matches?(email, EmailSpectacular::Matchers::MATCHERS[attribute], expected) &&
+                  (!EmailSpectacular._mocking_sending_enqueued_emails ||
+                    email.instance_variable_get(:@enqueued) == @enqueued)
               end
 
             return [attribute, expected] if matching_emails.empty?
@@ -28,23 +30,30 @@ module EmailSpectacular
           [nil, nil]
         end
 
-        def describe_failed_assertion(emails, attribute_name, attribute_value)
+        def describe_failed_assertion(attribute_name, attribute_value)
+          action = mail_action_description
+
           field_descriptions = attribute_descriptions([attribute_name])
           value_descriptions = value_descriptions([attribute_value])
 
           base_clause = expectation_description(
-            'Expected an email to be sent',
+            "Expected an email to be #{action}",
             field_descriptions,
             value_descriptions
           )
 
-          if emails.empty?
-            "#{base_clause} However, no emails were sent."
+          if @emails.empty?
+            "#{base_clause} However, no emails were #{action}."
+          elsif @matching_emails[:sent].any? || @matching_emails[:enqueued].any?
+            opposite_action = @enqueued ? 'sent' : 'enqueued'
+            "#{base_clause} However, it was #{opposite_action} instead."
           else
-            email_values = sent_email_values(emails, attribute_name)
+            field_descriptions = attribute_descriptions([attribute_name])
+
+            email_values = sent_email_values(@emails, attribute_name)
 
             if email_values.any?
-              base_clause + " However, #{email_pluralisation(emails)} sent " \
+              base_clause + " However, #{email_pluralisation(@emails)} #{action} " \
               "#{result_description(field_descriptions, [to_sentence(email_values)])}."
             else
               base_clause
@@ -92,6 +101,14 @@ module EmailSpectacular
 
         private
 
+        def mail_action_description
+          if EmailSpectacular._mocking_sending_enqueued_emails
+            @enqueued ? 'enqueued' : 'sent'
+          else
+            'sent'
+          end
+        end
+
         def result_description(field_descriptions, values)
           to_sentence(
             field_descriptions.map.with_index do |field_description, index|
@@ -109,7 +126,11 @@ module EmailSpectacular
         def sent_email_values(emails, attribute)
           emails.each_with_object([]) do |email, memo|
             if %i[matching_selector with_link with_image].include?(attribute)
-              memo << email_body(email)
+              memo << raw_email_parts(email).inject([]) do |description, (content_type, raw_email_part)|
+                  description.push(
+                    "\n\n(Content Type #{content_type}):\n\n#{raw_email_part}"
+                  )
+                end.join('')
             else
               matcher = EmailSpectacular::Matchers::MATCHERS[attribute]
 
@@ -118,12 +139,19 @@ module EmailSpectacular
                 when String, Symbol
                   email.send(matcher)
                 when Hash
-                  matcher[:actual].call(email, parsed_emails(email))
+                  parsed_email_parts(email).inject([]) do |description, (content_type, parsed_email_part)|
+                    description.push(
+                      "\n\n(Content Type #{content_type}):\n\n#{matcher[:actual].call(email, parsed_email_part)}"
+                    )
+                  end.join('')
                 else
                   raise ArgumentError, "Failure related to an unknown or unsupported email attribute #{attribute}"
                 end
 
-              value = value.is_a?(String) ? "'#{value}'" : value.map { |element| "'#{element}'" }
+              unless attribute == :with_text
+                value = value.is_a?(String) ? "'#{value}'" : value.map { |element| "'#{element}'" }
+              end
+
               memo << value
             end
           end

data/lib/email_spectacular/concerns/matchers.rb

@@ -0,0 +1,78 @@
+# frozen_string_literal: true
+
+require 'email_spectacular/adaptors/capybara_adaptor'
+
+module EmailSpectacular
+  # Module containing helper methods for matching expectations against emails
+  #
+  # @author Aleck Greenham
+  module Matchers
+    include CapybaraAdaptor
+
+    MATCHERS = {
+      to: :to,
+      from: :from,
+      with_subject: :subject,
+      with_text: {
+        match: lambda { |_, email_parts, value|
+          value.all? { |text| email_parts.values.any? { |email_part| email_part.has_text?(text) } }
+        },
+        actual: ->(_, parsed_email_part) { parsed_email_part.text }
+      },
+      matching_selector: {
+        match: lambda { |_, email_parts, value|
+          email_parts.values.any? { |email_part| value.all? { |selector| email_part.has_selector?(selector) } }
+        },
+        actual: ->(_, parsed_email_part) { parsed_email_part.native },
+        actual_name: :with_body
+      },
+      with_link: {
+        match: lambda { |_, email_parts, value|
+          email_parts.values.any? { |email_part| value.all? { |url| email_part.has_selector?("a[href='#{url}']") } }
+        },
+        actual: ->(_, parsed_email_part) { parsed_email_part.native },
+        actual_name: :with_body
+      },
+      with_image: {
+        match: lambda { |_, email_parts, value|
+          email_parts.values.any? { |email_part| value.all? { |url| email_part.has_selector?("img[src='#{url}']") } }
+        },
+        actual: ->(_, parsed_email_part) { parsed_email_part.native },
+        actual_name: :with_body
+      }
+    }.freeze
+
+    def self.included(base) # rubocop:disable Metrics/MethodLength
+      base.class_eval do
+        def matching_emails(emails, scopes)
+          emails.each_with_object(sent: [], enqueued: []) do |email, memo|
+            matches_scopes = scopes.all? do |attribute, expected|
+              email_matches?(email, MATCHERS[attribute], expected)
+            end
+
+            if matches_scopes
+              if email.instance_variable_get(:@enqueued)
+                memo[:enqueued] << email
+              else
+                memo[:sent] << email
+              end
+            end
+          end
+        end
+
+        def email_matches?(email, assertion, expected)
+          case assertion
+          when :to
+            !(expected & email.send(assertion)).empty?
+          when String, Symbol
+            email.send(assertion).include?(expected)
+          when Hash
+            assertion[:match].call(email, parsed_email_parts(email), expected)
+          else
+            raise "Unsupported assertion mapping '#{assertion}' of type #{assertion.class.name}"
+          end
+        end
+      end
+    end
+  end
+end

data/lib/email_spectacular/email_filter.rb

@@ -1,8 +1,8 @@
 # frozen_string_literal: true
 
-require 'email_spectacular/dsl'
-require 'email_spectacular/failure_descriptions'
-require 'email_spectacular/matchers'
+require 'email_spectacular/concerns/dsl'
+require 'email_spectacular/concerns/failure_descriptions'
+require 'email_spectacular/concerns/matchers'
 
 module EmailSpectacular
   class EmailFilter

data/lib/email_spectacular/extensions/action_mailer_extension.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module EmailSpectacular
+  # Extensions to ActionMailer::MessageDelivery to mock the enqueuing of emails
+  module ActionMailerExtension
+    def self.included(base)
+      base.class_eval do
+        def deliver_later(options = {})
+          message.instance_variable_set(:@enqueued, true)
+          deliver_now
+        end
+      end
+    end
+  end
+end

data/lib/email_spectacular/rspec.rb

@@ -1,39 +1,41 @@
 # frozen_string_literal: true
 
-require 'email_spectacular/expectation'
+require 'email_spectacular.rb'
+require 'email_spectacular/rspec_matcher'
+require 'email_spectacular/adaptors/action_mailer_adaptor'
 
 module EmailSpectacular
   # Module containing email helper methods that can be mixed into the RSpec test scope
   #
   # @author Aleck Greenham
   module RSpec
-    # Syntactic sugar for referencing the list of emails sent since the start of the
-    # test
+    include ActionMailerAdaptor
+
+    # Creates a new email expectation that allows asserting emails should have specific
+    # attributes, applied only to send emails.
+    #
+    # @see EmailSpectacular::Expectation
     #
     # @example Asserting email has been sent
     #   expect(email).to have_been_sent.to('test@email.com')
-    #
-    # @return [Array<Mail::Message>] List of sent emails
-    def email
-      ActionMailer::Base.deliveries
-    end
-
-    # Clears the list of sent emails.
-    #
-    # @return void
-    def clear_emails
-      ActionMailer::Base.deliveries = []
+    def have_been_sent # rubocop:disable Naming/PredicateName
+      EmailSpectacular::RSpecMatcher.new(enqueued: false)
     end
 
     # Creates a new email expectation that allows asserting emails should have specific
-    # attributes.
+    # attributes, applied only to emails that have been enqueued to be sent.
     #
     # @see EmailSpectacular::Expectation
     #
-    # @example Asserting email has been sent
-    #   expect(email).to have_been_sent.to('test@email.com')
-    def have_been_sent # rubocop:disable Naming/PredicateName
-      EmailSpectacular::Expectation.new
+    # @example Asserting email has been enqueued
+    #   expect(email).to have_been_enqueued.to('test@email.com')
+    def have_been_enqueued # rubocop:disable Naming/PredicateName
+      unless EmailSpectacular._mocking_sending_enqueued_emails
+        raise 'EmailSpectacular: Cannot use the have_been_enqueued assertion without setting the ' \
+              'mock_sending_enqueued_emails configuration option.'
+      end
+
+      EmailSpectacular::RSpecMatcher.new(enqueued: true)
     end
   end
 end

data/lib/email_spectacular/{expectation.rb → rspec_matcher.rb}

@@ -1,6 +1,8 @@
 # frozen_string_literal: true
 
-require 'email_spectacular/email_filter'
+require 'email_spectacular/concerns/dsl'
+require 'email_spectacular/concerns/failure_descriptions'
+require 'email_spectacular/concerns/matchers'
 
 module EmailSpectacular
   # Backing class for {#have_been_sent} declarative syntax for specifying email
@@ -13,14 +15,10 @@ module EmailSpectacular
   #
   # @see EmailSpectacular::RSpec#email
   # @see EmailSpectacular::RSpec#have_been_sent
-  class Expectation < EmailFilter
-    # Creates a new EmailSpectacular::Expectation object
-    #
-    # @return [EmailSpectacular::Expectation] new expectation object
-    def initialize
-      @failure_message = 'Expected email to be sent'
-      super
-    end
+  class RSpecMatcher
+    include DSL
+    include Matchers
+    include FailureDescriptions
 
     # Declares that RSpec should not attempt to diff the actual and expected values
     # to put in the failure message. This class takes care of diffing and presenting
@@ -37,7 +35,8 @@ module EmailSpectacular
     # @return [Boolean] True when a matching email was sent
     def matches?(emails)
       @emails = emails
-      matching_emails(emails, @scopes).any?
+      @matching_emails = matching_emails(emails, @scopes)
+      (@enqueued ? @matching_emails[:enqueued] : @matching_emails[:sent]).any?
     end
 
     # Message to display to StdOut by RSpec if the equality check fails. Includes a
@@ -58,11 +57,7 @@ module EmailSpectacular
       attribute, expected_value =
         attribute_and_expected_value(@scopes, @emails)
 
-      describe_failed_assertion(
-        @emails,
-        attribute,
-        expected_value
-      )
+      describe_failed_assertion(attribute, expected_value)
     end
 
     # Failure message to display for negative RSpec assertions, i.e.

data/lib/email_spectacular/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module EmailSpectacular
-  VERSION = '1.0.0'
+  VERSION = '1.1.0'
 end

data/spec/email_expectation_spec.rb

@@ -249,7 +249,13 @@ RSpec.describe 'have_sent_email' do
       expect do
         expect(subject).to have_been_sent.with_text('Other text')
       end.to raise_error.with_message(
-        "Expected an email to be sent with text 'Other text'. However, 1 was sent with text '#{subject[0].text}'."
+        <<~MSG.chomp
+          Expected an email to be sent with text 'Other text'. However, 1 was sent with text 
+          
+          (Content Type text/html):
+          
+          #{subject[0].text}.
+        MSG
       )
     end
 
@@ -263,7 +269,13 @@ RSpec.describe 'have_sent_email' do
       expect do
         expect(subject).to have_been_sent.matching_selector('.other')
       end.to raise_error.with_message(
-        "Expected an email to be sent matching selector '.other'. However, 1 was sent with body #{subject[0].body}."
+        <<~MSG.chomp
+          Expected an email to be sent matching selector '.other'. However, 1 was sent with body 
+
+          (Content Type text/html):
+
+          #{subject[0].body}.
+        MSG
       )
     end
 
@@ -277,7 +289,13 @@ RSpec.describe 'have_sent_email' do
       expect do
         expect(subject).to have_been_sent.with_link('www.other.com')
       end.to raise_error.with_message(
-        "Expected an email to be sent with link 'www.other.com'. However, 1 was sent with body #{subject[0].body}."
+        <<~MSG.chomp
+          Expected an email to be sent with link 'www.other.com'. However, 1 was sent with body 
+
+          (Content Type text/html):
+
+          #{subject[0].body}.
+        MSG
       )
     end
 
@@ -291,7 +309,13 @@ RSpec.describe 'have_sent_email' do
       expect do
         expect(subject).to have_been_sent.with_image('www.other.com')
       end.to raise_error.with_message(
-        "Expected an email to be sent with image 'www.other.com'. However, 1 was sent with body #{subject[0].body}."
+        <<~MSG.chomp
+          Expected an email to be sent with image 'www.other.com'. However, 1 was sent with body 
+
+          (Content Type text/html):
+
+          #{subject[0].body}.
+        MSG
       )
     end
 
@@ -387,8 +411,13 @@ RSpec.describe 'have_sent_email' do
       expect do
         expect(subject).to have_been_sent.with_text('Other').and('Email')
       end.to raise_error.with_message(
-        "Expected an email to be sent with text 'Other' and 'Email'. However, 1 was " \
-        "sent with text '#{subject[0].text}'."
+        <<~MSG.chomp
+          Expected an email to be sent with text 'Other' and 'Email'. However, 1 was sent with text 
+
+          (Content Type text/html):
+
+          #{subject[0].text}.
+        MSG
       )
     end
 
@@ -396,7 +425,13 @@ RSpec.describe 'have_sent_email' do
       expect do
         expect(subject).to have_been_sent.with_text('Test').and('Other')
       end.to raise_error.with_message(
-        "Expected an email to be sent with text 'Test' and 'Other'. However, 1 was sent with text '#{subject[0].text}'."
+        <<~MSG.chomp
+          Expected an email to be sent with text 'Test' and 'Other'. However, 1 was sent with text 
+
+          (Content Type text/html):
+
+          #{subject[0].text}.
+        MSG
       )
     end
 

data/spec/support/email_mock.rb

@@ -42,4 +42,8 @@ class EmailBodyMock
   def decoded
     @text
   end
+
+  def content_type
+    'text/html; charset=UTF-8'
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: email_spectacular
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Aleck Greenham
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-04-11 00:00:00.000000000 Z
+date: 2020-04-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionmailer
@@ -50,14 +50,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.6'
+        version: '2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.6'
+        version: '2'
 - !ruby/object:Gem::Dependency
   name: guard
   requirement: !ruby/object:Gem::Requirement
@@ -90,16 +90,16 @@ dependencies:
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 12.3.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 12.3.3
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -134,13 +134,15 @@ files:
 - Rakefile
 - email_spectacular.gemspec
 - lib/email_spectacular.rb
-- lib/email_spectacular/dsl.rb
+- lib/email_spectacular/adaptors/action_mailer_adaptor.rb
+- lib/email_spectacular/adaptors/capybara_adaptor.rb
+- lib/email_spectacular/concerns/dsl.rb
+- lib/email_spectacular/concerns/failure_descriptions.rb
+- lib/email_spectacular/concerns/matchers.rb
 - lib/email_spectacular/email_filter.rb
-- lib/email_spectacular/expectation.rb
-- lib/email_spectacular/failure_descriptions.rb
-- lib/email_spectacular/matchers.rb
-- lib/email_spectacular/parser.rb
+- lib/email_spectacular/extensions/action_mailer_extension.rb
 - lib/email_spectacular/rspec.rb
+- lib/email_spectacular/rspec_matcher.rb
 - lib/email_spectacular/version.rb
 - spec/email_expectation_spec.rb
 - spec/spec_helper.rb

data/lib/email_spectacular/matchers.rb

@@ -1,66 +0,0 @@
-# frozen_string_literal: true
-
-require 'email_spectacular/parser'
-
-module EmailSpectacular
-  # Module containing helper methods for matching expectations against emails
-  #
-  # @author Aleck Greenham
-  module Matchers
-    include Parser
-
-    MATCHERS = {
-      to: :to,
-      from: :from,
-      with_subject: :subject,
-      with_text: {
-        match: ->(_, email, value) { value.all? { |text| email.has_text?(text) } },
-        actual: ->(_, email) { email.text }
-      },
-      matching_selector: {
-        match: ->(_, email, value) { value.all? { |selector| email.has_selector?(selector) } },
-        actual: ->(_, email) { email.native },
-        actual_name: :with_body
-      },
-      with_link: {
-        match: ->(_, email, value) { value.all? { |url| email.has_selector?("a[href='#{url}']") } },
-        actual: ->(_, email) { email.native },
-        actual_name: :with_body
-      },
-      with_image: {
-        match: ->(_, email, value) { value.all? { |url| email.has_selector?("img[src='#{url}']") } },
-        actual: ->(_, email) { email.native },
-        actual_name: :with_body
-      }
-    }.freeze
-
-    def self.included(base) # rubocop:disable Metrics/MethodLength
-      base.class_eval do
-        def matching_emails(emails, scopes)
-          if scopes.any?
-            emails.select do |email|
-              scopes.all? do |attribute, expected|
-                email_matches?(email, MATCHERS[attribute], expected)
-              end
-            end
-          else
-            emails
-          end
-        end
-
-        def email_matches?(email, assertion, expected)
-          case assertion
-          when :to
-            !(expected & email.send(assertion)).empty?
-          when String, Symbol
-            email.send(assertion).include?(expected)
-          when Hash
-            assertion[:match].call(email, parsed_emails(email), expected)
-          else
-            raise "Unsupported assertion mapping '#{assertion}' of type #{assertion.class.name}"
-          end
-        end
-      end
-    end
-  end
-end

data/lib/email_spectacular/parser.rb

@@ -1,26 +0,0 @@
-# frozen_string_literal: true
-
-require 'capybara'
-
-module EmailSpectacular
-  # Module for parsing email bodies
-  #
-  # @author Aleck Greenham
-  module Parser
-    def parsed_emails(email)
-      parser(email)
-    end
-
-    def parser(email)
-      Capybara::Node::Simple.new(email_body(email))
-    end
-
-    def email_body(email)
-      if email.parts.first
-        email.parts.first.body.decoded
-      else
-        email.body.encoded
-      end
-    end
-  end
-end