Module: EmailSpec::Matchers

Defined in:
lib/email_spec/matchers.rb

Defined Under Namespace

Classes: BccTo, DeliverFrom, DeliverTo, ReplyTo

Instance Method Summary collapse

Instance Method Details

#bcc_to(*expected_email_addresses_or_objects_that_respond_to_email) ⇒ Object 



131
132
133
 
# File 'lib/email_spec/matchers.rb', line 131

def bcc_to(*expected_email_addresses_or_objects_that_respond_to_email)
  BccTo.new(expected_email_addresses_or_objects_that_respond_to_email.flatten)
end

#deliver_from(email) ⇒ Object Also known as: be_delivered_from 



96
97
98
 
# File 'lib/email_spec/matchers.rb', line 96

def deliver_from(email)
  DeliverFrom.new(email)
end

#deliver_to(*expected_email_addresses_or_objects_that_respond_to_email) ⇒ Object Also known as: be_delivered_to 



62
63
64
 
# File 'lib/email_spec/matchers.rb', line 62

def deliver_to(*expected_email_addresses_or_objects_that_respond_to_email)
  DeliverTo.new(expected_email_addresses_or_objects_that_respond_to_email.flatten)
end

#have_body_text(expected) ⇒ Object 



174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
 
# File 'lib/email_spec/matchers.rb', line 174

def have_body_text(expected)
  simple_matcher do |given, matcher|

    if expected.is_a?(String)
      normalized_body = given.body.gsub(/\s+/, " ")
      normalized_expected = expected.gsub(/\s+/, " ")
      matcher.description = "have body including #{normalized_expected.inspect}"
      matcher.failure_message = "expected the body to contain #{normalized_expected.inspect} but was #{normalized_body.inspect}"
      matcher.negative_failure_message = "expected the body not to contain #{normalized_expected.inspect} but was #{normalized_body.inspect}"

      normalized_body.include?(normalized_expected)
    else
      given_body = given.body
      matcher.description = "have body matching #{expected.inspect}"
      matcher.failure_message = "expected the body to match #{expected.inspect}, but did not.  Actual body was: #{given_body.inspect}"
      matcher.negative_failure_message = "expected the body not to match #{expected.inspect} but #{given_body.inspect} does match it."

      !!(given_body =~ expected)
    end
  end
end

#have_header(expected_name, expected_value) ⇒ Object 



196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
 
# File 'lib/email_spec/matchers.rb', line 196

def have_header(expected_name, expected_value)
  simple_matcher do |given, matcher|
    given_header = given.header

    if expected_value.is_a?(String)
      matcher.description = "have header #{expected_name}: #{expected_value}"
      matcher.failure_message = "expected the headers to include '#{expected_name}: #{expected_value}' but they were #{given_header.inspect}"
      matcher.negative_failure_message = "expected the headers not to include '#{expected_name}: #{expected_value}' but they were #{given_header.inspect}"

      given_header[expected_name].to_s == expected_value
    else
      matcher.description = "have header #{expected_name} with value matching #{expected_value.inspect}"
      matcher.failure_message = "expected the headers to include '#{expected_name}' with a value matching #{expected_value.inspect} but they were #{given_header.inspect}"
      matcher.negative_failure_message = "expected the headers not to include '#{expected_name}' with a value matching #{expected_value.inspect} but they were #{given_header.inspect}"

      given_header[expected_name].to_s =~ expected_value
    end
  end
end

#have_subject(expected) ⇒ Object 



135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
 
# File 'lib/email_spec/matchers.rb', line 135

def have_subject(expected)
  simple_matcher do |given, matcher|
    given_subject = given.subject

    if expected.is_a?(String)
      matcher.description = "have subject of #{expected.inspect}"
      matcher.failure_message = "expected the subject to be #{expected.inspect} but was #{given_subject.inspect}"
      matcher.negative_failure_message = "expected the subject not to be #{expected.inspect} but was"

      given_subject == expected
    else
      matcher.description = "have subject matching #{expected.inspect}"
      matcher.failure_message = "expected the subject to match #{expected.inspect}, but did not.  Actual subject was: #{given_subject.inspect}"
      matcher.negative_failure_message = "expected the subject not to match #{expected.inspect} but #{given_subject.inspect} does match it."

      !!(given_subject =~ expected)
    end
  end
end

#include_email_with_subject(expected) ⇒ Object 



155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
 
# File 'lib/email_spec/matchers.rb', line 155

def include_email_with_subject(expected)
  simple_matcher do |given_emails, matcher|

    if expected.is_a?(String)
      matcher.description = "include email with subject of #{expected.inspect}"
      matcher.failure_message = "expected at least one email to have the subject #{expected.inspect} but none did. Subjects were #{given_emails.map(&:subject).inspect}"
      matcher.negative_failure_message = "expected no email with the subject #{expected.inspect} but found at least one. Subjects were #{given_emails.map(&:subject).inspect}"

      given_emails.map(&:subject).include?(expected)
    else
      matcher.description = "include email with subject matching #{expected.inspect}"
      matcher.failure_message = "expected at least one email to have a subject matching #{expected.inspect}, but none did. Subjects were #{given_emails.map(&:subject).inspect}"
      matcher.negative_failure_message = "expected no email to have a subject matching #{expected.inspect} but found at least one. Subjects were #{given_emails.map(&:subject).inspect}"

      !!(given_emails.any?{ |mail| mail.subject =~ expected })
    end
  end
end

#reply_to(email) ⇒ Object Also known as: have_reply_to 



28
29
30
 
# File 'lib/email_spec/matchers.rb', line 28

def reply_to(email)
  ReplyTo.new(email)
end