email_spec 0.6.6 → 1.0.1

data/examples/sinatra_root/features/support/env.rb

@@ -0,0 +1,21 @@
+# Generated by cucumber-sinatra. (Tue Jul 27 10:45:23 -0400 2010)
+
+require File.join(File.dirname(__FILE__), '..', '..', 'lib/example_sinatra_app.rb')
+require 'capybara'
+require 'capybara/cucumber'
+require 'rspec/core'
+#require 'activesupport'
+require File.expand_path(File.dirname(__FILE__) + '../../../../../lib/email_spec')
+require 'email_spec/cucumber'
+
+ExampleSinatraApp.set(:environment, :test)
+
+Capybara.app = ExampleSinatraApp
+
+class ExampleSinatraAppWorld
+  include Capybara
+end
+
+World do
+  ExampleSinatraAppWorld.new
+end

data/examples/{sinatra → sinatra_root}/features/support/paths.rb

@@ -1,18 +1,23 @@
+# Taken from the cucumber-rails project.
+
 module NavigationHelpers
   # Maps a name to a path. Used by the
   #
   #   When /^I go to (.+)$/ do |page_name|
   #
-  # step definition in webrat_steps.rb
+  # step definition in web_steps.rb
   #
   def path_to(page_name)
     case page_name
 
-    when /the homepage/
+    when /the home\s?page/
       '/'
 
-    when /request a newsletter/
-      "/newsletter/Joe Someone/example@example.com"
+    # Add more mappings here.
+    # Here is an example that pulls values out of the Regexp:
+    #
+    #   when /^(.*)'s profile page$/i
+    #     user_profile_path(User.find_by_login($1))
 
     else
       raise "Can't find mapping from \"#{page_name}\" to a path.\n" +

data/examples/sinatra_root/lib/example_sinatra_app.rb

@@ -0,0 +1,35 @@
+require 'sinatra/base'
+require 'pony'
+
+class ExampleSinatraApp < Sinatra::Base
+  get '/' do
+    <<-EOHTML
+  <form method="post" action="/signup">
+      <label for="Name">Name</label>
+      <input type="text" id="Name" name="user[name]">
+      <label for="Email">Email</label>
+      <input type="text" id="Email" name="user[email]">
+      <input type="submit" value="Sign up">
+  </form>
+    EOHTML
+  end
+
+  post '/signup' do
+    user = params[:user]
+    body = <<-EOHTML
+  Hello #{user['name']}!
+
+  <a href="http://www.example.com/confirm">Click here to confirm your account!</a>
+    EOHTML
+    Pony.mail(:from => 'admin@example.com',
+              :to => user['email'],
+              :subject => 'Account confirmation',
+              :body => body
+             )
+             'Thanks!  Go check your email!'
+  end
+
+  get '/confirm' do
+    'Confirm your new account!'
+  end
+end

data/lib/email_spec.rb

@@ -5,11 +5,11 @@ end
 
 $LOAD_PATH.unshift(File.expand_path(File.dirname(__FILE__))) unless $LOAD_PATH.include?(File.expand_path(File.dirname(__FILE__)))
 
+require 'rspec'
 require 'email_spec/background_processes'
 require 'email_spec/deliveries'
 require 'email_spec/address_converter'
 require 'email_spec/email_viewer'
 require 'email_spec/helpers'
 require 'email_spec/matchers'
-
-
+require 'email_spec/mail_ext'

data/lib/email_spec/deliveries.rb

@@ -9,11 +9,7 @@ module EmailSpec
     end
 
     def reset_mailer
-      if ActionMailer::Base.delivery_method == :cache
-        mailer.clear_cache
-      else
-        deliveries.clear
-      end
+      deliveries.clear
     end
 
     def mailbox_for(address)
@@ -36,12 +32,12 @@ module EmailSpec
 
   module ARMailerDeliveries
     def all_emails
-      Email.all.map{ |email| parse_to_tmail(email) }
+      Email.all.map{ |email| parse_to_mail(email) }
     end
 
     def last_email_sent
       if email = Email.last
-        TMail::Mail.parse(email.mail)
+        Mail.read(email.mail)
       else
         raise("No email has been sent!")
       end
@@ -55,11 +51,11 @@ module EmailSpec
       Email.all.select { |email|
         (email.to && email.to.include?(address)) ||
         (email.bcc && email.bcc.include?(address)) ||
-        (email.cc && email.cc.include?(address)) }.map{ |email| parse_to_tmail(email) }
+        (email.cc && email.cc.include?(address)) }.map{ |email| parse_to_mail(email) }
     end
 
-    def parse_to_tmail(email)
-      TMail::Mail.parse(email.mail)
+    def parse_to_mail(email)
+      Mail.read(email.mail)
     end
   end
 
@@ -70,7 +66,7 @@ module EmailSpec
       end
 
       def self.mail(options)
-        deliveries << build_tmail(options)
+        deliveries << build_mail(options)
       end
     end
   end

data/lib/email_spec/email_viewer.rb

@@ -81,7 +81,7 @@ module EmailSpec
     end
 
     def self.tmp_email_filename(extension = '.txt')
-      "#{RAILS_ROOT}/tmp/email-#{Time.now.to_i}#{extension}"
+      "#{Rails.root}/tmp/email-#{Time.now.to_i}#{extension}"
     end
   end
 end

data/lib/email_spec/helpers.rb

@@ -12,7 +12,7 @@ module EmailSpec
 
     def click_email_link_matching(regex, email = current_email)
       url = links_in_email(email).detect { |link| link =~ regex }
-      raise "No link found matching #{regex.inspect} in #{email.body}" unless url
+      raise "No link found matching #{regex.inspect} in #{email.default_part_body}" unless url
       request_uri = URI::parse(url).request_uri
       visit request_uri
     end
@@ -40,7 +40,7 @@ module EmailSpec
     def current_email(address=nil)
       address = convert_address(address)
       email = address ? email_spec_hash[:current_emails][address] : email_spec_hash[:current_email]
-      raise Spec::Expectations::ExpectationNotMetError, "Expected an open email but none was found. Did you forget to call open_email?" unless email
+      raise   RSpec::Expectations::ExpectationNotMetError, "Expected an open email but none was found. Did you forget to call open_email?" unless email
       email
     end
 
@@ -61,14 +61,14 @@ module EmailSpec
       if opts[:with_subject]
         mailbox_for(address).find { |m| m.subject =~ Regexp.new(opts[:with_subject]) }
       elsif opts[:with_text]
-        mailbox_for(address).find { |m| m.body =~ Regexp.new(opts[:with_text]) }
+        mailbox_for(address).find { |m| m.default_part_body =~ Regexp.new(opts[:with_text]) }
       else
         mailbox_for(address).first
       end
     end
 
     def links_in_email(email)
-      URI.extract(email.body, ['http', 'https'])
+      URI.extract(email.default_part_body.to_s, ['http', 'https'])
     end
 
     private
@@ -81,7 +81,7 @@ module EmailSpec
       email = find_email(address, opts)
       if email.nil?
         error = "#{opts.keys.first.to_s.humanize unless opts.empty?} #{('"' + opts.values.first.to_s.humanize + '"') unless opts.empty?}"
-        raise Spec::Expectations::ExpectationNotMetError, "Could not find email #{error}. \n Found the following emails:\n\n #{all_emails.to_s}"
+        raise   RSpec::Expectations::ExpectationNotMetError, "Could not find email #{error}. \n Found the following emails:\n\n #{all_emails.to_s}"
        end
       email
     end
@@ -114,7 +114,7 @@ module EmailSpec
 
     # e.g. Click here in  <a href="http://confirm">Click here</a>
     def parse_email_for_anchor_text_link(email, link_text)
-      if textify_images(email.body) =~ %r{<a[^>]*href=['"]?([^'"]*)['"]?[^>]*?>[^<]*?#{link_text}[^<]*?</a>}
+      if textify_images(email.default_part_body) =~ %r{<a[^>]*href=['"]?([^'"]*)['"]?[^>]*?>[^<]*?#{link_text}[^<]*?</a>}
         URI.split($1)[5..-1].compact!.join("?").gsub("&amp;", "&")
         # sub correct ampersand after rails switches it (http://dev.rubyonrails.org/ticket/4002)
       else
@@ -123,7 +123,7 @@ module EmailSpec
     end
 
     def textify_images(email_body)
-      email_body.gsub(%r{<img[^>]*alt=['"]?([^'"]*)['"]?[^>]*?/>}) { $1 }
+      email_body.to_s.gsub(%r{<img[^>]*alt=['"]?([^'"]*)['"]?[^>]*?/>}) { $1 }
     end
 
     def parse_email_count(amount)

data/lib/email_spec/mail_ext.rb

@@ -0,0 +1,11 @@
+module EmailSpec::MailExt
+  def default_part
+    @default_part ||= html_part || text_part || self
+  end
+
+  def default_part_body
+    default_part.body
+  end
+end
+
+Mail::Message.send(:include, EmailSpec::MailExt)

data/lib/email_spec/matchers.rb

@@ -2,11 +2,11 @@ module EmailSpec
   module Matchers
     class ReplyTo
       def initialize(email)
-        @expected_reply_to = TMail::Address.parse(email)
+        @expected_reply_to = Mail::ReplyToField.new(email).addrs.first
       end
 
       def description
-        "have reply to as #{@expected_reply_to.address.to_s}"
+        "have reply to as #{@expected_reply_to.address}"
       end
 
       def matches?(email)
@@ -21,7 +21,7 @@ module EmailSpec
       end
 
       def negative_failure_message
-        "expected #{@email.inspect} not to deliver to #{@expected_reply_to.inspect}, but it did"
+        "expected #{@email.inspect} not to deliver to #{@expected_reply_to.address.inspect}, but it did"
       end
     end
 
@@ -68,20 +68,20 @@ module EmailSpec
     class DeliverFrom
 
       def initialize(email)
-        @expected_sender = TMail::Address.parse(email)
+        @expected_sender = Mail::FromField.new(email).addrs.first
       end
 
       def description
-        "be delivered from #{@expected_sender.to_s}"
+        "be delivered from #{@expected_sender}"
       end
 
       def matches?(email)
         @email = email
-        @actual_sender = (email.from_addrs || []).first
+        @actual_sender = (email.header[:from].addrs || []).first
 
         !@actual_sender.nil? &&
           @actual_sender.address == @expected_sender.address &&
-          @actual_sender.name == @expected_sender.name
+          @actual_sender.display_name == @expected_sender.display_name
       end
 
       def failure_message
@@ -132,11 +132,11 @@ module EmailSpec
       BccTo.new(expected_email_addresses_or_objects_that_respond_to_email.flatten)
     end
 
-    Spec::Matchers.define :have_subject do
+      RSpec::Matchers.define :have_subject do
       match do |given|
         given_subject = given.subject
         expected_subject = expected.first
-
+        
         if expected_subject.is_a?(String)
           description { "have subject of #{expected_subject.inspect}" }
           failure_message_for_should { "expected the subject to be #{expected_subject.inspect} but was #{given_subject.inspect}" }
@@ -152,66 +152,71 @@ module EmailSpec
         end
       end
     end
-
-    Spec::Matchers.define :include_email_with_subject do
+    
+      RSpec::Matchers.define :include_email_with_subject do
       match do |given_emails|
         expected_subject = expected.first
-
+        
         if expected_subject.is_a?(String)
           description { "include email with subject of #{expected_subject.inspect}" }
           failure_message_for_should { "expected at least one email to have the subject #{expected_subject.inspect} but none did. Subjects were #{given_emails.map(&:subject).inspect}" }
           failure_message_for_should_not { "expected no email with the subject #{expected_subject.inspect} but found at least one. Subjects were #{given_emails.map(&:subject).inspect}" }
-
+          
           given_emails.map(&:subject).include?(expected_subject)
         else
           description { "include email with subject matching #{expected_subject.inspect}" }
           failure_message_for_should { "expected at least one email to have a subject matching #{expected_subject.inspect}, but none did. Subjects were #{given_emails.map(&:subject).inspect}" }
           failure_message_for_should_not { "expected no email to have a subject matching #{expected_subject.inspect} but found at least one. Subjects were #{given_emails.map(&:subject).inspect}" }
-
+          
           !!(given_emails.any?{ |mail| mail.subject =~ expected_subject })
         end
       end
     end
 
-    Spec::Matchers.define :have_body_text do
+      RSpec::Matchers.define :have_body_text do
       match do |given|
         expected_text = expected.first
-
+        
         if expected_text.is_a?(String)
-          normalized_body = given.body.gsub(/\s+/, " ")
+          normalized_body = given.default_part_body.to_s.gsub(/\s+/, " ")
           normalized_expected = expected_text.gsub(/\s+/, " ")
           description { "have body including #{normalized_expected.inspect}" }
           failure_message_for_should { "expected the body to contain #{normalized_expected.inspect} but was #{normalized_body.inspect}" }
           failure_message_for_should_not { "expected the body not to contain #{normalized_expected.inspect} but was #{normalized_body.inspect}" }
-
+    
           normalized_body.include?(normalized_expected)
         else
-          given_body = given.body
+          given_body = given.default_part_body.to_s
           description { "have body matching #{expected_text.inspect}" }
           failure_message_for_should { "expected the body to match #{expected_text.inspect}, but did not.  Actual body was: #{given_body.inspect}" }
           failure_message_for_should_not { "expected the body not to match #{expected_text.inspect} but #{given_body.inspect} does match it." }
-
+    
           !!(given_body =~ expected_text)
         end
       end
     end
 
-    Spec::Matchers.define :have_header do
+    def mail_headers_hash(email_headers)
+      email_headers.fields.inject({}) { |hash, field| hash[field.field.class::FIELD_NAME] = field.to_s; hash }
+    end
+
+      RSpec::Matchers.define :have_header do
       match do |given|
         given_header = given.header
         expected_name, expected_value = *expected
 
         if expected_value.is_a?(String)
           description { "have header #{expected_name}: #{expected_value}" }
-          failure_message_for_should { "expected the headers to include '#{expected_name}: #{expected_value}' but they were #{given_header.inspect}" }
-          failure_message_for_should_not { "expected the headers not to include '#{expected_name}: #{expected_value}' but they were #{given_header.inspect}" }
 
+          failure_message_for_should { "expected the headers to include '#{expected_name}: #{expected_value}' but they were #{mail_headers_hash(given_header).inspect}" }
+          failure_message_for_should_not { "expected the headers not to include '#{expected_name}: #{expected_value}' but they were #{mail_headers_hash(given_header).inspect}" }
+    
           given_header[expected_name].to_s == expected_value
         else
           description { "have header #{expected_name} with value matching #{expected_value.inspect}" }
-          failure_message_for_should { "expected the headers to include '#{expected_name}' with a value matching #{expected_value.inspect} but they were #{given_header.inspect}" }
-          failure_message_for_should_not { "expected the headers not to include '#{expected_name}' with a value matching #{expected_value.inspect} but they were #{given_header.inspect}" }
-
+          failure_message_for_should { "expected the headers to include '#{expected_name}' with a value matching #{expected_value.inspect} but they were #{mail_headers_hash(given_header).inspect}" }
+          failure_message_for_should_not { "expected the headers not to include '#{expected_name}' with a value matching #{expected_value.inspect} but they were #{mail_headers_hash(given_header).inspect}" }
+    
           given_header[expected_name].to_s =~ expected_value
         end
       end

data/lib/generators/email_spec/steps/USAGE

@@ -0,0 +1,5 @@
+Description:
+    Creates email_steps.rb in your cucumber step_definitions.
+    
+Examples:
+    `script/rails generate email_spec:steps`

data/lib/generators/email_spec/steps/steps_generator.rb

@@ -0,0 +1,14 @@
+# This generator adds email steps to the step definitions directory
+require 'rails/generators'
+
+module EmailSpec
+  class StepsGenerator < Rails::Generators::Base
+    def generate
+      copy_file 'email_steps.rb', 'features/step_definitions/email_steps.rb'
+    end
+
+    def self.source_root
+      File.join(File.dirname(__FILE__), 'templates')
+    end
+  end
+end

data/spec/email_spec/helpers_spec.rb

@@ -4,20 +4,18 @@ describe EmailSpec::Helpers do
   include EmailSpec::Helpers
   describe "#parse_email_for_link" do
     it "properly finds links with text" do
-      email = stub(:has_body_text? => true,
-                   :body => %(<a href="/path/to/page">Click Here</a>))
+      email = Mail.new(:body =>  %(<a href="/path/to/page">Click Here</a>))
       parse_email_for_link(email, "Click Here").should == "/path/to/page"
     end
 
     it "recognizes img alt properties as text" do
-      email = stub(:has_body_text? => true,
-                   :body => %(<a href="/path/to/page"><img src="http://host.com/images/image.gif" alt="an image" /></a>))
+      email = Mail.new(:body => %(<a href="/path/to/page"><img src="http://host.com/images/image.gif" alt="an image" /></a>))
       parse_email_for_link(email, "an image").should == "/path/to/page"
     end
 
     it "causes a spec to fail if the body doesn't contain the text specified to click" do
-      email = stub(:has_body_text? => false, :body => "hello")
-      lambda { parse_email_for_link(email, "non-existent text") }.should raise_error(Spec::Expectations::ExpectationNotMetError)
+      email = Mail.new(:body => "")
+      lambda { parse_email_for_link(email, "non-existent text") }.should raise_error(  RSpec::Expectations::ExpectationNotMetError)
     end
   end
 end

data/spec/email_spec/mail_ext_spec.rb

@@ -0,0 +1,34 @@
+require 'spec_helper'
+
+describe EmailSpec::MailExt do
+  describe "#default_part" do
+    it "prefers html_part over text_part" do
+      email = Mail.new do
+        text_part { body "This is text" }
+        html_part { body "This is html" }
+      end
+
+      email.default_part.body.to_s.should == "This is html"
+    end
+
+    it "returns text_part if html_part not available" do
+      email = Mail.new do
+        text_part { body "This is text" }
+      end
+
+      email.default_part.body.to_s.should == "This is text"
+    end
+
+    it "returns the email if not multi-part" do
+      email = Mail.new { body "This is the body" }
+      email.default_part.body.to_s.should == "This is the body"
+    end
+  end
+
+  describe "#default_part_body" do
+    it "returns default_part.body" do
+      email = Mail.new(:body => "hi")
+      email.default_part.body.should == email.default_part_body
+    end
+  end
+end