email_spec 0.6.1 → 0.6.2

data/History.txt

@@ -1,5 +1,10 @@
 (In Git)
 
+== 0.6.2 2010-03-21
+
+ === New features
+  * New reply_to matcher. (David Balatero)
+
 == 0.6.1 2010-03-17
 
  === New features

data/examples/rails_root/rerun.txt

@@ -0,0 +1 @@
+features/errors.feature:13:17:21:26:30

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

@@ -0,0 +1,182 @@
+# 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|
+  unread_emails_for(address).size.should == parse_email_count(amount)
+end
+
+Then /^(?:I|they|"([^"]*?)") should have (an|no|\d+) emails?$/ do |address, amount|
+  mailbox_for(address).size.should == parse_email_count(amount)
+end
+
+Then /^(?:I|they|"([^"]*?)") should receive (an|no|\d+) emails? with subject "([^"]*?)"$/ do |address, amount, subject|
+  unread_emails_for(address).select { |m| m.subject =~ Regexp.new(subject) }.size.should == 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 text "([^"]*?)"$/ do |address, text|
+  open_email(address, :with_text => text)
+end
+
+#
+# Inspect the Email Contents
+#
+
+Then /^(?:I|they) should see "([^"]*?)" in the email subject$/ do |text|
+  current_email.should have_subject(text)
+end
+
+Then /^(?:I|they) should see \/([^"]*?)\/ in the email subject$/ do |text|
+  current_email.should have_subject(Regexp.new(text))
+end
+
+Then /^(?:I|they) should see "([^"]*?)" in the email body$/ do |text|
+  current_email.body.should include(text)
+end
+
+Then /^(?:I|they) should see \/([^"]*?)\/ in the email body$/ do |text|
+  current_email.body.should =~ Regexp.new(text)
+end
+
+Then /^(?:I|they) should see the email delivered from "([^"]*?)"$/ do |text|
+  current_email.should be_delivered_from(text)
+end
+
+Then /^(?:I|they) should see "([^\"]*)" in the email "([^"]*?)" header$/ do |text, name|
+  current_email.should have_header(name, text)
+end
+
+Then /^(?:I|they) should see \/([^\"]*)\/ in the email "([^"]*?)" header$/ do |text, name|
+  current_email.should have_header(name, Regexp.new(text))
+end
+
+#
+# Inspect the Email Attachments
+#
+
+Then /^(?:I|they) should see (an|no|\d+) attachments? with the email$/ do |amount|
+  current_email_attachments.size.should == parse_email_count(amount)
+end
+
+Then /^there should be (an|no|\d+) attachments? named "([^"]*?)"$/ do |amount, filename|
+  current_email_attachments.select { |a| a.original_filename == filename }.size.should == parse_email_count(amount)
+end
+
+Then /^attachment (\d+) should be named "([^"]*?)"$/ do |index, filename|
+  current_email_attachments[(index.to_i - 1)].original_filename.should == filename
+end
+
+Then /^there should be (an|no|\d+) attachments? of type "([^"]*?)"$/ do |amount, content_type|
+  current_email_attachments.select { |a| a.content_type == content_type }.size.should == parse_email_count(amount)
+end
+
+Then /^attachment (\d+) should be of type "([^"]*?)"$/ do |index, content_type|
+  current_email_attachments[(index.to_i - 1)].content_type.should == content_type
+end
+
+Then /^all attachments should not be blank$/ do
+  current_email_attachments.each do |attachment|
+    attachment.size.should_not == 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) follow "([^"]*?)" in the email$/ do |link|
+  visit_in_email(link)
+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/matchers.rb

@@ -1,9 +1,37 @@
 module EmailSpec
+  module Matchers
+    class ReplyTo
+      def initialize(email)
+        @expected_reply_to = TMail::Address.parse(email)
+      end
 
-    module Matchers
+      def description
+        "have reply to as #{@expected_reply_to.address.to_s}"
+      end
 
-    class DeliverTo
+      def matches?(email)
+        @email = email
+        @actual_reply_to = (email.reply_to || []).first
+        !@actual_reply_to.nil? &&
+          @actual_reply_to == @expected_reply_to.address
+      end
+
+      def failure_message
+        "expected #{@email.inspect} to reply to #{@expected_reply_to.address.inspect}, but it replied to #{@actual_reply_to.inspect}"
+      end
+
+      def negative_failure_message
+        "expected #{@email.inspect} not to deliver to #{@expected_reply_to.inspect}, but it did"
+      end
+    end
+
+    def reply_to(email)
+      ReplyTo.new(email)
+    end
+
+    alias :have_reply_to :reply_to
 
+    class DeliverTo
       def initialize(expected_email_addresses_or_objects_that_respond_to_email)
         emails = expected_email_addresses_or_objects_that_respond_to_email.map do |email_or_object|
           email_or_object.kind_of?(String) ? email_or_object : email_or_object.email
@@ -50,7 +78,7 @@ module EmailSpec
       def matches?(email)
         @email = email
         @actual_sender = (email.from_addrs || []).first
-        
+
         !@actual_sender.nil? &&
           @actual_sender.address == @expected_sender.address &&
           @actual_sender.name == @expected_sender.name
@@ -122,68 +150,68 @@ module EmailSpec
           !!(given_subject =~ expected)
         end
       end
-     end
-
-     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
-
-     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
-
-      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
+
+    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
+
+    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
+
+    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
 
   end
 end

data/spec/email_spec/matchers_spec.rb

@@ -1,47 +1,60 @@
-
 require File.dirname(__FILE__) + '/../spec_helper'
 
-
-
 describe EmailSpec::Matchers do
+  include EmailSpec::Matchers
 
+  class MatcherMatch
+    def initialize(object_to_test_match)
+      @object_to_test_match = object_to_test_match
+    end
 
-    class MatcherMatch
+    def description
+      "match when provided #{@object_to_test_match.inspect}"
+    end
 
-      def initialize(object_to_test_match)
-        @object_to_test_match = object_to_test_match
-      end
+    def matches?(matcher)
+      @matcher = matcher
+      matcher.matches?(@object_to_test_match)
+    end
 
-      def description
-        "match when provided #{@object_to_test_match.inspect}"
-      end
+    def failure_message
+      "expected #{@matcher.inspect} to match when provided #{@object_to_test_match.inspect}, but it did not"
+    end
 
-      def matches?(matcher)
-        @matcher = matcher
-        matcher.matches?(@object_to_test_match)
-      end
+    def negative_failure_message
+      "expected #{@matcher.inspect} not to match when provided #{@object_to_test_match.inspect}, but it did"
+    end
+  end
 
-      def failure_message
-        "expected #{@matcher.inspect} to match when provided #{@object_to_test_match.inspect}, but it did not"
-      end
+  def match(object_to_test_match)
+    if object_to_test_match.is_a?(Regexp)
+      super # delegate to rspec's built in 'match' matcher
+    else
+      MatcherMatch.new(object_to_test_match)
+    end
+  end
 
-      def negative_failure_message
-        "expected #{@matcher.inspect} not to match when provided #{@object_to_test_match.inspect}, but it did"
-      end
+  def mock_email(stubs)
+    mock("email", stubs)
+  end
+
+  describe "#reply_to" do
+    it "should match when the email is set to deliver to the specified address" do
+      email = mock_email(:reply_to => ["test@gmail.com"])
+      reply_to("test@gmail.com").should match(email)
     end
 
-    def match(object_to_test_match)
-      if object_to_test_match.is_a?(Regexp)
-        super # delegate to rspec's built in 'match' matcher
-      else
-        MatcherMatch.new(object_to_test_match)
-      end
+    it "should match given a name and address" do
+      email = mock_email(:reply_to => ["test@gmail.com"])
+      reply_to("David Balatero <test@gmail.com>").should match(email)
     end
 
-  include EmailSpec::Matchers
+    it "should give correct failure message when the email is not set to deliver to the specified address" do
+      matcher = reply_to("jimmy_bean@yahoo.com")
+      matcher.matches?(mock_email(:inspect => 'email', :reply_to => ['freddy_noe@yahoo.com']))
+      matcher.failure_message.should == %{expected email to reply to "jimmy_bean@yahoo.com", but it replied to "freddy_noe@yahoo.com"}
+    end
 
-  def mock_email(stubs)
-    mock("email", stubs)
   end
 
   describe "#deliver_to" do
@@ -84,7 +97,7 @@ describe EmailSpec::Matchers do
       email = mock_email(:from_addrs => [TMail::Address.parse("jimmy_bean@yahoo.com")])
       deliver_from("jimmy_bean@yahoo.com").should match(email)
     end
-    
+
     it "should match when the email is set to deliver from the specified name and address" do
       email = mock_email(:from_addrs => [TMail::Address.parse("Jimmy Bean <jimmy_bean@yahoo.com>")])
       deliver_from("Jimmy Bean <jimmy_bean@yahoo.com>").should match(email)
@@ -94,7 +107,7 @@ describe EmailSpec::Matchers do
       email = mock_email(:from_addrs => nil)
       deliver_from("jimmy_bean@yahoo.com").should_not match(email)
     end
-    
+
     it "should not match when the email addresses match but the names do not" do
       email = mock_email(:from_addrs => [TMail::Address.parse("Jimmy Bean <jimmy_bean@yahoo.com>")])
       deliver_from("Freddy Noe <jimmy_bean@yahoo.com>").should_not match(email)
@@ -109,7 +122,7 @@ describe EmailSpec::Matchers do
       email = mock_email(:from_addrs => [TMail::Address.parse("freddy_noe@yahoo.com")])
       deliver_from("jimmy_bean@yahoo.com").should_not match(email)
     end
-    
+
     it "should give correct failure message when the email is not set to deliver from the specified address" do
       matcher = deliver_from("jimmy_bean@yahoo.com")
       matcher.matches?(mock_email(:inspect => 'email', :from_addrs => [TMail::Address.parse("freddy_noe@yahoo.com")]))
@@ -180,11 +193,9 @@ describe EmailSpec::Matchers do
 
         matcher.negative_failure_message.should == 'expected the subject not to match /b/ but "bar" does match it.'
       end
-
     end
 
     describe "when strings are used" do
-
       it "should match when the subject equals the passed in string exactly" do
         email = mock_email(:subject => 'foo')
 
@@ -206,17 +217,13 @@ describe EmailSpec::Matchers do
         matcher.failure_message.should == 'expected the subject to be "foo" but was "bar"'
       end
 
-
       it "should offer helpful negative failing messages" do
         matcher = have_subject("bar")
         matcher.matches?(mock_email(:subject => "bar"))
 
         matcher.negative_failure_message.should == 'expected the subject not to be "bar" but was'
       end
-
     end
-
-
   end
 
   describe "#include_email_with_subject" do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: email_spec
 version: !ruby/object:Gem::Version 
-  version: 0.6.1
+  version: 0.6.2
 platform: ruby
 authors: 
 - Ben Mabey
@@ -11,7 +11,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-03-17 00:00:00 -06:00
+date: 2010-03-21 00:00:00 -06:00
 default_executable: 
 dependencies: []
 
@@ -129,6 +129,7 @@ test_files:
 - examples/rails_root/public/javascripts/prototype.js
 - examples/rails_root/public/robots.txt
 - examples/rails_root/Rakefile
+- examples/rails_root/rerun.txt
 - examples/rails_root/script/about
 - examples/rails_root/script/autospec
 - examples/rails_root/script/console
@@ -158,6 +159,7 @@ test_files:
 - examples/sinatra/app.rb
 - examples/sinatra/features/errors.feature
 - examples/sinatra/features/example.feature
+- examples/sinatra/features/step_definitions/email_steps.rb
 - examples/sinatra/features/step_definitions/user_steps.rb
 - examples/sinatra/features/step_definitions/web_steps.rb
 - examples/sinatra/features/support/env.rb