class Mail::Matchers::HasSentEmailMatcher - mail-2.5.4 Documentation

# class Mail::Matchers::HasSentEmailMatcher

### Public Class Methods

new(_context) click to toggle source

    # File lib/mail/matchers/has_sent_mail.rb, line 8
    def initialize(_context)
    end

### Public Instance Methods

description() click to toggle source

    # File lib/mail/matchers/has_sent_mail.rb, line 52
    def description
      result = "send a matching email"
      result
    end

failure_message() click to toggle source

    # File lib/mail/matchers/has_sent_mail.rb, line 57
    def failure_message
      result = "Expected email to be sent "
      result += explain_expectations
      result += dump_deliveries
      result
    end

from(sender) click to toggle source

    # File lib/mail/matchers/has_sent_mail.rb, line 16
    def from(sender)
      @sender = sender
      self
    end

matches?(subject) click to toggle source

    # File lib/mail/matchers/has_sent_mail.rb, line 11
    def matches?(subject)
      matching_deliveries = filter_matched_deliveries(Mail::TestMailer.deliveries)
      !(matching_deliveries.empty?)
    end

matching_body(body_matcher) click to toggle source

    # File lib/mail/matchers/has_sent_mail.rb, line 47
    def matching_body(body_matcher)
      @body_matcher = body_matcher
      self
    end

matching_subject(subject_matcher) click to toggle source

    # File lib/mail/matchers/has_sent_mail.rb, line 37
    def matching_subject(subject_matcher)
      @subject_matcher = subject_matcher
      self
    end

negative_failure_message() click to toggle source

    # File lib/mail/matchers/has_sent_mail.rb, line 64
    def negative_failure_message
      result = "Expected no email to be sent "
      result += explain_expectations
      result += dump_deliveries
      result
    end

to(recipient_or_list) click to toggle source

    # File lib/mail/matchers/has_sent_mail.rb, line 21
    def to(recipient_or_list)
      @recipients ||= []

      if recipient_or_list.kind_of?(Array)
        @recipients += recipient_or_list
      else
        @recipients << recipient_or_list
      end
      self
    end

with_body(body) click to toggle source

    # File lib/mail/matchers/has_sent_mail.rb, line 42
    def with_body(body)
      @body = body
      self
    end

with_subject(subject) click to toggle source

    # File lib/mail/matchers/has_sent_mail.rb, line 32
    def with_subject(subject)
      @subject = subject
      self
    end

### Protected Instance Methods

dump_deliveries() click to toggle source

    # File lib/mail/matchers/has_sent_mail.rb, line 119
    def dump_deliveries
      "(actual deliveries: " + Mail::TestMailer.deliveries.inspect + ")"
    end

explain_expectations() click to toggle source

    # File lib/mail/matchers/has_sent_mail.rb, line 108
    def explain_expectations
      result = ''
      result += "from #{@sender} " if instance_variable_defined?('@sender')
      result += "to #{@recipients.inspect} " if instance_variable_defined?('@recipients')
      result += "with subject \"#{@subject}\" " if instance_variable_defined?('@subject')
      result += "with subject matching \"#{@subject_matcher}\" " if instance_variable_defined?('@subject_matcher')
      result += "with body \"#{@body}\" " if instance_variable_defined?('@body')
      result += "with body matching \"#{@body_matcher}\" " if instance_variable_defined?('@body_matcher')
      result
    end

filter_matched_deliveries(deliveries) click to toggle source

    # File lib/mail/matchers/has_sent_mail.rb, line 73
    def filter_matched_deliveries(deliveries)
      candidate_deliveries = deliveries

      %w(sender recipients subject subject_matcher body body_matcher).each do |modifier_name|
        next unless instance_variable_defined?("@#{modifier_name}")
        candidate_deliveries = candidate_deliveries.select{|matching_delivery| self.send("matches_on_#{modifier_name}?", matching_delivery)}
      end

      candidate_deliveries
    end

matches_on_body?(delivery) click to toggle source

    # File lib/mail/matchers/has_sent_mail.rb, line 100
    def matches_on_body?(delivery)
      delivery.body == @body
    end

matches_on_body_matcher?(delivery) click to toggle source

    # File lib/mail/matchers/has_sent_mail.rb, line 104
    def matches_on_body_matcher?(delivery)
      @body_matcher.match delivery.body.raw_source
    end

matches_on_recipients?(delivery) click to toggle source

    # File lib/mail/matchers/has_sent_mail.rb, line 88
    def matches_on_recipients?(delivery)
      @recipients.all? {|recipient| delivery.to.include?(recipient) }
    end

matches_on_sender?(delivery) click to toggle source

    # File lib/mail/matchers/has_sent_mail.rb, line 84
    def matches_on_sender?(delivery)
      delivery.from.include?(@sender)
    end

matches_on_subject?(delivery) click to toggle source

    # File lib/mail/matchers/has_sent_mail.rb, line 92
    def matches_on_subject?(delivery)
      delivery.subject == @subject
    end

matches_on_subject_matcher?(delivery) click to toggle source

    # File lib/mail/matchers/has_sent_mail.rb, line 96
    def matches_on_subject_matcher?(delivery)
      @subject_matcher.match delivery.subject
    end