bmabey-email_spec 0.0.7 → 0.0.9

data/History.txt

@@ -1,9 +1,37 @@
-(In Git)                                                                                                                                                                                                
-  === New features
+(In Git)
+
+ === New features 
+  * Added matcher for checking if a collection of emails includes an email with a particular subject (Luke Melia, Noah Davis)
+  * Introduced hook to convert objects to email addresses (Luke Melia and Lee Bankewitz)
+
+    This allows you, in your step matcher, to say something like:
+    maillbox_for(some_user)
+
+    Use it in your cucumber env.rb like so:
+
+      EmailSpec::AddressConverter.instance.conversion do |input|
+       if input.is_a?(User)
+         input.email
+       else
+         input
+       end
+      end
+
+=== Bufixes
+ * Isolated variances between using email-spec with an ARMailer project. (Luke Melia)
+ 
+
+== 0.0.9 2008-2-15
+ === New features
+  * have_body_text, have_header matchers (Luke Melia)
+  * EmailViewer - opens all sent emails in a given scenario when the environment variables are set. (Luke Melia)
+  * Added compatibility with using ARMailer in test mode. (Luke Melia)
+ === Bugfixes
+  * set_current_email now works with multiple addresses in To field. (Brian McManus, Ben Mabey)
 
 == 0.0.7 2008-1-20
  === New features
-  * have_subject matcher
+  * have_subject matcher (Ben Mabey)
 
 == 0.0.6 2008-12-23
  === New features

data/MIT-LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2007 Bryan Helmkamp, Seth Fitzsimmons
+Copyright (c) 2008-2009 Ben Mabey
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/Rakefile

@@ -1,52 +1,36 @@
-['rubygems',"rake/gempackagetask",'rake/rdoctask',"rake/clean",'spec', 'spec/rake/spectask', File.expand_path('./lib/email_spec.rb')].each {|file| require file}
-
-# package + maintenance stuff
-spec = Gem::Specification.new do |s|
-  s.name         = "email_spec"
-  s.version      = EmailSpec::VERSION
-  s.platform     = Gem::Platform::RUBY
-  s.authors      = ['Ben Mabey', 'Aaron Gibralter', 'Mischa Fierer']
-  s.email        = "ben@benmabey.com"
-  s.homepage     = "http://github.com/bmabey/email-spec/"
-  s.summary      = "Easily test email in rspec and cucumber"
-  s.bindir       = "bin"
-  s.description  = s.summary
-  s.require_path = "lib"
-  s.files        = %w(History.txt install.rb MIT-LICENSE.txt README.rdoc Rakefile) + Dir["lib/**/*"] + Dir["generators/**/*"] + Dir["spec/**/*"] + Dir["examples/**/*"]
-  # rdoc
-  s.has_rdoc         = true
-  s.extra_rdoc_files = %w(README.rdoc MIT-LICENSE.txt)
-end
-
-desc 'Show information about the gem.'
-task :debug_gem do
-  puts spec.to_ruby
-end
-
-task :gemspec do
-  system "rake debug_gem | grep -v \"(in \" > email-spec.gemspec"
-end
-
-Rake::GemPackageTask.new(spec) do |package|
-  package.gem_spec = spec
-end
-
-
-CLEAN.include ["pkg", "*.gem", "doc", "ri", "coverage", '**/.*.sw?', '*.gem', '.config', '**/.DS_Store', '**/*.class', '**/*.jar', '**/.*.swp' ]
-
-desc 'Install the package as a gem.'
-task :install_gem => [:clean, :package] do
-  gem = Dir['pkg/*.gem'].first
-  sh "sudo gem install --local #{gem}"
+require 'rubygems'
+require 'spec/rake/spectask'
+
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |s|
+    s.name         = "email_spec"
+    s.platform     = Gem::Platform::RUBY
+    s.authors      = ['Ben Mabey', 'Aaron Gibralter', 'Mischa Fierer']
+    s.email        = "ben@benmabey.com"
+    s.homepage     = "http://github.com/bmabey/email-spec/"
+    s.summary      = "Easily test email in rspec and cucumber"
+    s.bindir       = "bin"
+    s.description  = s.summary
+    s.require_path = "lib"
+    s.files        = %w(History.txt install.rb MIT-LICENSE.txt README.rdoc Rakefile) + Dir["lib/**/*"] + Dir["generators/**/*"] + Dir["spec/**/*"] + Dir["examples/**/*"]
+    # rdoc
+    s.has_rdoc         = true
+    s.extra_rdoc_files = %w(README.rdoc MIT-LICENSE.txt)
+  end
+rescue LoadError
+  puts "Jeweler not available. Install it with: sudo gem install technicalpickles-jeweler -s http://gems.github.com"
 end
 
 # Testing
 
 desc "Run the generator on the tests"
 task :generate do
-  system "mkdir -p examples/rails_root/vendor/plugins/email_spec"
-  system "cp -R generators examples/rails_root/vendor/plugins/email_spec"
-  system "cd examples/rails_root; ./script/generate email_spec"
+  current_dir = File.expand_path(File.dirname(__FILE__))
+  system "mkdir -p #{current_dir}/examples/rails_root/vendor/plugins/email_spec"
+  system "cp -R #{current_dir}/generators #{current_dir}/examples/rails_root/vendor/plugins/email_spec"
+  system "cd #{current_dir}/examples/rails_root && ./script/generate email_spec"
 end
 
 task :features => [:generate] do

data/examples/rails_root/app/models/user.rb

@@ -0,0 +1,2 @@
+class User < ActiveRecord::Base
+end

data/examples/rails_root/config/environments/test.rb

@@ -22,8 +22,12 @@ config.action_controller.allow_forgery_protection    = false
 config.action_mailer.delivery_method = :test
 
 
-config.gem 'webrat' , :source => "http://gems.github.com"
-config.gem 'rspec', :lib => 'spec'
-config.gem 'rspec-rails', :lib => 'spec/rails'
-config.gem 'cucumber' , :source => "http://gems.github.com"
+# I HATE config.gem.. it doesn't work as advertised...
+config.gem 'webrat', :source => "http://gems.github.com"
+#config.gem 'rspec', :lib => 'spec'
+#config.gem 'rspec-rails', :lib => 'spec/rails'
+config.gem 'cucumber', :source => "http://gems.github.com" # aslakhellesoy-cucumber
+config.gem 'nakajima-fixjour', :lib => 'fixjour', :source => "http://gems.github.com" # nakajima-fixjour
+
+
 

data/examples/rails_root/cucumber.yml

@@ -0,0 +1 @@
+default: features/example.feature

data/examples/rails_root/db/migrate/20090125013728_create_users.rb

@@ -0,0 +1,11 @@
+class CreateUsers < ActiveRecord::Migration
+  def self.up
+    create_table :users do |t|
+      t.string :email, :name
+    end
+  end
+
+  def self.down
+    drop_table :users
+  end
+end

data/examples/rails_root/db/schema.rb

@@ -9,6 +9,13 @@
 #
 # It's strongly recommended to check this file into your version control system.
 
-ActiveRecord::Schema.define(:version => 0) do
+ActiveRecord::Schema.define(:version => 20090125013728) do
+
+  create_table "users", :force => true do |t|
+    t.string   "email"
+    t.string   "name"
+    t.string   "confirm_code"
+    t.datetime "confirmed_at"
+  end
 
 end

data/examples/rails_root/features/example.feature

@@ -1,34 +1,58 @@
-Feature: Email-spec example
+Feature: EmailSpec Example -- Prevent Bots from creating accounts
 
 In order to help alleviate email testing in apps
-As a email-spec contributor I a newcomer
-Should be able to easily adopt email-spec in their app by following this example
-
-Scenario: A new person signs up declaratively
-      Given I am at "/"
-      And no emails have been sent
-      When I fill in "Email" with "quentin@example.com"
-      And I press "Sign up"
-      Then "quentin@example.com" should receive 1 email
-      And "quentin@example.com" should have 1 email
-      And "foo@bar.com" should not receive an email
-      When "quentin@example.com" opens the email with subject "Account confirmation"
-      Then I should see "confirm" in the email
-      And I should see "Account confirmation" in the subject
-      When I follow "confirm" in the email
-      Then I should see "Confirm your new account"
-
-
-Scenario: I sign up imperatively
-      Given I am at "/"
-      And no emails have been sent
-      When I fill in "Email" with "quentin@example.com"
-      And I press "Sign up"
-      And I should receive an email
-      When I open the email
-      Then I should see "confirm" in the email
-      When I follow "confirm" in the email
-      Then I should see "Confirm your new account"
+As an email-spec contributor I want new users of the library
+to easily adopt email-spec in their app by following this example
+
+In order to prevent bots from setting up new accounts
+As a site manager I want new users
+to verify their email address with a confirmation link
+
+Scenario: A new person signs up imperatively 
+    Given I am a real person wanting to sign up for an account
+    And I am at "/"
+
+    When I fill in "Email" with "quentin@example.com"
+    And I fill in "Name" with "Quentin Jones"
+    And I press "Sign up"
+
+    Then "quentin@example.com" should receive 1 email
+    And "quentin@example.com" should have 1 email
+    And "foo@bar.com" should not receive an email
+
+    When "quentin@example.com" opens the email with subject "Account confirmation"
+
+    Then I should see "confirm" in the email
+    And I should see "Quentin Jones" in the email
+    And I should see "Account confirmation" in the subject
+
+    When I follow "confirm" in the email
+    Then I should see "Confirm your new account"
+
+
+Scenario: slightly more declarative, but still mostly imperative
+    Given I am a real person wanting to sign up for an account
+    And I'm on the signup page
+
+    When I fill in "Email" with "quentin@example.com"
+    And I fill in "Name" with "Quentin Jones"
+    And I press "Sign up"
+
+    Then I should receive an email
+
+    When I open the email
+    Then I should see "Account confirmation" in the subject
+
+    When I follow "confirm" in the email
+    Then I should see "Confirm your new account"
+
+
+ Scenario: declarative
+    Given I am a real person wanting to sign up for an account
+    And I'm on the signup page
+
+    When I submit my registration information
+    Then I should receive an email with a link to a confirmation page
 
 
 

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

@@ -35,9 +35,9 @@ When /^I follow "(.*)" in the email$/ do |link|
   visit_in_email(link)
 end
 
-Then /^I should receive (.*) emails?$/ do |amount|
+Then /^I should receive (.+) emails?$/ do |amount|
   amount = 1 if amount == "an"
-  unread_emails_for(current_email_address).size.should == amount
+  unread_emails_for(current_email_address).size.should == amount.to_i
 end
 
 Then /^"([^']*?)" should receive (\d+) emails?$/ do |address, n|

data/examples/rails_root/features/step_definitions/user_steps.rb

@@ -0,0 +1,23 @@
+Given "I am a real person wanting to sign up for an account" do
+  # no-op.. for documentation purposes only!
+end
+
+When /^I submit my registration information$/ do
+  fill_in "Name", :with => valid_user_attributes[:name]
+  fill_in "Email", :with => valid_user_attributes[:email]
+  click_button
+end
+
+Then /^I should receive an email with a link to a confirmation page$/ do
+  unread_emails_for(valid_user_attributes[:email]).size.should == 1 
+  
+  # this call will store the email and you can access it with current_email
+  open_last_email_for(valid_user_attributes[:email])
+  current_email.should have_subject(/Account confirmation/)
+  current_email.should have_body_text(valid_user_attributes[:name])
+
+  click_email_link_matching /confirm/
+  response.should include_text("Confirm your new account")
+  
+end
+

data/examples/rails_root/features/step_definitions/webrat_steps.rb

@@ -5,6 +5,10 @@ Given /^I am at "(.+)"$/ do |path|
   visit path
 end
 
+Given /^I'm on the (.+) page$/ do |page|
+  locations = {"signup" => "/"}
+  visit locations[page]
+end
 
 When /^I press "(.*)"$/ do |button|
   click_button(button)

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

@@ -4,11 +4,20 @@ require File.expand_path(File.dirname(__FILE__) + '/../../config/environment')
 require 'cucumber/rails/world'
 Cucumber::Rails.use_transactional_fixtures
 
-require 'webrat/rails'
+require 'webrat'
 require 'cucumber/rails/rspec'
-require 'webrat/rspec-rails'
+require 'webrat/core/matchers'
 
-require File.expand_path(File.dirname(__FILE__) + '../../../../../lib/email_spec/cucumber.rb')
+Webrat.configure do |config|
+  config.mode = :rails
+end
 
 
 
+require File.expand_path(File.dirname(__FILE__) + '../../../../../lib/email_spec')
+require 'email_spec/cucumber'
+
+require File.expand_path(File.dirname(__FILE__) +'/../../spec/model_factory.rb')
+World { |world| world.extend(Fixjour) }
+
+

data/examples/rails_root/spec/model_factory.rb

@@ -0,0 +1,6 @@
+require 'fixjour'
+
+Fixjour do
+  define_builder(User, :name => "Jojo Binks", :email => "jojo@thebinks.com")
+end
+

data/examples/rails_root/spec/models/user_mailer_spec.rb

@@ -1,5 +1,10 @@
 require File.dirname(__FILE__) + '/../spec_helper'
 
+# These two example groups are specifying the exact same behavior.  However, the documentation style is different
+# and the value that each one provides is different with various trade-offs.  Run these examples with the specdoc 
+# formatter to get an idea of how they differ.
+
+# Example of documenting the behaviour explicitly and expressing the intent in the example's sentence.
 describe "Signup Email" do
   include EmailSpec::Helpers
   include EmailSpec::Matchers
@@ -11,18 +16,16 @@ describe "Signup Email" do
 
   subject { @email }
   
-  it "should be set to be delivered to the email passed in" do
+  it "should be delivered to the email passed in" do
     should deliver_to("jojo@yahoo.com")
   end
   
-  it "should contain the user's message in the mail body" do
-    @email.should have_text(/Jojo Binks/)
+  it "should contain the user's name in the mail body" do
+    @email.should have_body_text(/Jojo Binks/)
   end
 
-  it { should have_text(/Jojo Binks/) }
-
-  it "should contain a link to the confirmation link" do
-    @email.should have_text(/#{confirm_account_url}/)
+  it "should contain a link to the confirmation page" do
+    @email.should have_body_text(/#{confirm_account_url}/)
   end
   
   it { should have_subject(/Account confirmation/) }
@@ -30,3 +33,26 @@ describe "Signup Email" do
   
 end
 
+# In this example group more of the documentation is placed in the context trying to allow for more concise specs.
+describe "Signup Email" do
+  include EmailSpec::Helpers
+  include EmailSpec::Matchers
+  include ActionController::UrlWriter
+
+  before(:all) do
+    @email = UserMailer.create_signup("jojo@yahoo.com", "Jojo Binks")
+  end
+
+  subject { @email }
+
+  it { should have_body_text(/#{confirm_account_url}/) }
+  it { should have_subject(/Account confirmation/) }
+
+  describe "sent with email address of 'jojo@yahoo.com', and users name 'Jojo Binks'" do
+    subject { @email }
+    it { should deliver_to("jojo@yahoo.com") }
+    it { should have_body_text(/Jojo Binks/) }
+  end
+  
+  
+end

data/examples/rails_root/spec/models/user_spec.rb

@@ -0,0 +1,5 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe User do
+
+end

data/examples/rails_root/spec/spec_helper.rb

@@ -5,10 +5,11 @@ require File.expand_path(File.dirname(__FILE__) + "/../config/environment")
 require 'spec'
 require 'spec/rails'
 
-require (Rails.root + '/../../lib/email_spec/helpers.rb')
-require (Rails.root + '/../../lib/email_spec/matchers.rb')
+require File.expand_path(File.dirname(__FILE__) + "/model_factory.rb")
+require (Rails.root + '/../../lib/email_spec.rb')
 
 Spec::Runner.configure do |config|
+  config.include(Fixjour)
   # If you're not using ActiveRecord you should remove these
   # lines, delete config/database.yml and disable :active_record
   # in your config/boot.rb

data/examples/rails_root/vendor/plugins/email_spec/generators/email_spec/templates/email_steps.rb

@@ -35,9 +35,9 @@ When /^I follow "(.*)" in the email$/ do |link|
   visit_in_email(link)
 end
 
-Then /^I should receive (.*) emails?$/ do |amount|
+Then /^I should receive (.+) emails?$/ do |amount|
   amount = 1 if amount == "an"
-  unread_emails_for(current_email_address).size.should == amount
+  unread_emails_for(current_email_address).size.should == amount.to_i
 end
 
 Then /^"([^']*?)" should receive (\d+) emails?$/ do |address, n|

data/generators/email_spec/templates/email_steps.rb

@@ -35,9 +35,9 @@ When /^I follow "(.*)" in the email$/ do |link|
   visit_in_email(link)
 end
 
-Then /^I should receive (.*) emails?$/ do |amount|
+Then /^I should receive (.+) emails?$/ do |amount|
   amount = 1 if amount == "an"
-  unread_emails_for(current_email_address).size.should == amount
+  unread_emails_for(current_email_address).size.should == amount.to_i
 end
 
 Then /^"([^']*?)" should receive (\d+) emails?$/ do |address, n|

data/lib/email_spec/address_converter.rb

@@ -0,0 +1,27 @@
+module EmailSpec
+  class AddressConverter
+    include Singleton
+  
+    attr_accessor :converter
+  
+    # The block provided to conversion should convert to an email
+    # address string or return the input untouched. For example:
+    #
+    #  EmailSpec::AddressConverter.instance.conversion do |input|
+    #   if input.is_a?(User)
+    #     input.email
+    #   else
+    #     input
+    #   end
+    #  end
+    #    
+    def conversion(&block)
+      self.converter = block
+    end
+  
+    def convert(input)
+      return input unless converter
+      converter.call(input)
+    end
+  end
+end

data/lib/email_spec/cucumber.rb

@@ -1,16 +1,18 @@
 # require this in your env.rb file after you require cucumber/rails/world
 
-%w[helpers matchers].each do |file|
-  require File.join(File.dirname(__FILE__), file)
-end
-
 # Global Setup
-ActionMailer::Base.delivery_method = :test
+ActionMailer::Base.delivery_method = :test unless ActionMailer::Base.delivery_method == :activerecord
 ActionMailer::Base.perform_deliveries = true
 
-Before do 
+Before do
   # Scenario setup
-  ActionMailer::Base.deliveries.clear
+  ActionMailer::Base.deliveries.clear if ActionMailer::Base.delivery_method == :test
+end
+
+After do
+  EmailSpec::EmailViewer.save_and_open_all_raw_emails if ENV['SHOW_EMAILS']
+  EmailSpec::EmailViewer.save_and_open_all_html_emails if ENV['SHOW_HTML_EMAILS']
+  EmailSpec::EmailViewer.save_and_open_all_text_emails if ENV['SHOW_TEXT_EMAILS']
 end
 
 World do |world|

data/lib/email_spec/deliveries.rb

@@ -0,0 +1,55 @@
+module EmailSpec
+  module TestDeliveries
+    def all_emails
+      ActionMailer::Base.deliveries
+    end
+    
+    def last_email_sent
+      ActionMailer::Base.deliveries.last || raise("No email has been sent!")
+    end
+
+    def reset_mailer
+      ActionMailer::Base.deliveries.clear
+    end
+    
+    def mailbox_for(address)
+      address = AddressConverter.instance.convert(address)
+      ActionMailer::Base.deliveries.select { |m| m.to.include?(address) }
+    end
+  end
+  
+  module ARMailerDeliveries
+    def all_emails
+      Email.all.map{ |email| parse_to_tmail(email) }
+    end
+    
+    def last_email_sent
+      if email = Email.last
+        TMail::Mail.parse(email.mail)
+      else
+        raise("No email has been sent!")
+      end
+    end
+
+    def reset_mailer
+      Email.delete_all
+    end
+    
+    def mailbox_for(address)
+      address = AddressConverter.instance.convert(address)
+      Email.all.select { |email| email.to.include?(address) }.map{ |email| parse_to_tmail(email) }
+    end
+    
+    def parse_to_tmail(email)
+      TMail::Mail.parse(email.mail)
+    end    
+  end
+  
+  module Deliveries
+    if ActionMailer::Base.delivery_method == :activerecord
+      include EmailSpec::ARMailerDeliveries
+    else
+      include EmailSpec::TestDeliveries
+    end    
+  end
+end

data/lib/email_spec/email_viewer.rb

@@ -0,0 +1,70 @@
+module EmailSpec
+  class EmailViewer
+    extend Deliveries
+    
+    def self.save_and_open_all_raw_emails
+      filename = "#{RAILS_ROOT}/tmp/email-#{Time.now.to_i}.txt"
+
+      File.open(filename, "w") do |f|
+        all_emails.each do |m|
+          f.write m.to_s
+          f.write "\n" + '='*80 + "\n"
+        end
+      end
+
+      open_in_text_editor(filename)
+    end
+
+    def self.save_and_open_all_html_emails
+      all_emails.each_with_index do |m, index|
+        if m.multipart? && html_part = m.parts.detect{ |p| p.content_type == 'text/html' }
+          filename = tmp_email_filename("-#{index}.html")
+          File.open(filename, "w") do |f|
+            f.write m.parts[1].body
+          end
+          open_in_browser(filename)
+        end
+      end
+    end
+
+    def self.save_and_open_all_text_emails
+      filename = tmp_email_filename
+
+      File.open(filename, "w") do |f|
+        all_emails.each do |m|
+          if m.multipart? && text_part = m.parts.detect{ |p| p.content_type == 'text/plain' }
+            m.ordered_each{|k,v| f.write "#{k}: #{v}\n" }
+            f.write text_part.body
+          else
+            f.write m.to_s
+          end
+          f.write "\n" + '='*80 + "\n"
+        end
+      end
+
+      open_in_text_editor(filename)
+    end
+  
+    def self.save_and_open_email(mail)
+      filename = "#{RAILS_ROOT}/tmp/email-#{Time.now.to_i}.txt"
+
+      File.open(filename, "w") do |f|
+        f.write mail.to_s
+      end
+
+      open_in_text_editor(filename)
+    end
+    
+    def self.open_in_text_editor(filename)
+      `mate #{filename}`
+    end
+    
+    def self.open_in_browser(filename)
+      `open #{filename}`
+    end
+    
+    def self.tmp_email_filename(extension = '.txt')
+      "#{RAILS_ROOT}/tmp/email-#{Time.now.to_i}#{extension}"
+    end
+  end
+end

data/lib/email_spec/helpers.rb

@@ -3,50 +3,60 @@ require 'uri'
 module EmailSpec
 
   module Helpers
+    include Deliveries
     
-    def reset_mailer
-      ActionMailer::Base.deliveries.clear
-    end
-
-    def last_email_sent
-      ActionMailer::Base.deliveries.last || raise("No email has been sent!")
-    end
-
     def visit_in_email(link_text)
       visit(parse_email_for_link(current_email, link_text))
     end
     
+    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
+      request_uri = URI::parse(url).request_uri
+      visit request_uri
+    end
+    
+    def click_first_link_in_email(email = current_email)
+      link = links_in_email(email).first
+      request_uri = URI::parse(link).request_uri
+      visit request_uri
+    end
+    
     def open_email(address, opts={})
-      email = find_email!(address, opts) 
-      email.should_not be_nil
-      set_current_email(email)
+      address = convert_address(address)
+      set_current_email(find_email!(address, opts))
     end
+    
+    alias_method :open_email_for, :open_email
 
     def open_last_email
-      email = ActionMailer::Base.deliveries.last
-      email.should_not be_nil
-      set_current_email(email)
+      set_current_email(last_email_sent)
+    end
+
+    def open_last_email_for(address)
+      address = convert_address(address)
+      set_current_email(mailbox_for(address).last)
     end
     
     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  
       email
     end
     
     def unread_emails_for(address)
+      address = convert_address(address)
       mailbox_for(address) - read_emails_for(address)
     end
     
     def read_emails_for(address)
+      address = convert_address(address)
       email_spec_hash[:read_emails][address] ||= []
     end
     
-    def mailbox_for(address)
-      ActionMailer::Base.deliveries.select { |m| m.to.include?(address) }
-    end
-    
     def find_email(address, opts={})
+      address = convert_address(address)
      if opts[:with_subject]
         email = mailbox_for(address).find { |m| m.subject =~ Regexp.new(opts[:with_subject]) }
       elsif opts[:with_text]
@@ -55,40 +65,57 @@ module EmailSpec
         email = mailbox_for(address).first
       end
     end
+    
+    def links_in_email(email)
+      URI.extract(email.body, ['http', 'https'])
+    end
 
     private
 
     def email_spec_hash
       @email_spec_hash ||= {:read_emails => {}, :unread_emails => {}, :current_emails => {}, :current_email => nil}
     end
-	
+
     def find_email!(address, opts={})
+      address = convert_address(address)
       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 #{ActionMailer::Base.deliveries.to_s}"
+        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}"
        end
       email
     end
 
     def set_current_email(email)
       return unless email
-      read_emails_for(email.to) << email      
-      email_spec_hash[:current_emails][email.to] = email
+      email.to.each do |to|
+        read_emails_for(to) << email      
+        email_spec_hash[:current_emails][to] = email
+      end
       email_spec_hash[:current_email] = email
     end
+        
+    def parse_email_for_link(email, link_text_or_regex)
+      email.should have_body_text(link_text_or_regex)
+      regex = link_text_or_regex
+      regex = /#{Regexp.escape(regex)}/ unless regex.is_a?(Regexp)
+      url = links_in_email(email).detect { |link| link =~ regex }
+      raise "No link found matching #{regex.inspect} in #{email}" unless url
+      URI::parse(url).request_uri
+      # 
+      # if link_text =~ %r{^/.*$}
+      #   # if it's an explicit link
+      #   link_text
+      # elsif email.body =~ %r{<a[^>]*href=['"]?([^'"]*)['"]?[^>]*?>[^<]*?#{link_text}[^<]*?</a>}
+      #   # if it's an anchor tag
+      #   URI.split($~[1])[5..-1].compact!.join("?").gsub("&amp;", "&")
+      #   # sub correct ampersand after rails switches it (http://dev.rubyonrails.org/ticket/4002) 
+      #   # TODO: outsource this kind of parsing to webrat or someone else
+      # end
+    end
     
-    def parse_email_for_link(email, link_text)
-      email.body.should include_text(link_text)
-      if link_text =~ %r{^/.*$}
-	# if it's an explicit link
-	link_text
-      elsif email.body =~ %r{<a[^>]*href=['"]?([^'"]*)['"]?[^>]*?>[^<]*?#{link_text}[^<]*?</a>}
-	# if it's an anchor tag
-	URI.split($~[1])[5..-1].compact!.join("?").gsub("&amp;", "&")
-	# sub correct ampersand after rails switches it (http://dev.rubyonrails.org/ticket/4002) 
-	# TODO: outsource this kind of parsing to webrat or someone else
-      end
+    def convert_address(address)
+      AddressConverter.instance.convert(address)
     end
   end
 end

data/lib/email_spec/matchers.rb

@@ -1,7 +1,7 @@
 module EmailSpec
 
     module Matchers
-          
+
     class DeliverTo
 
       def initialize(expected_email_addresses_or_objects_that_respond_to_email)
@@ -12,6 +12,10 @@ module EmailSpec
         @expected_email_addresses = emails.sort
       end
 
+      def description
+        "be delivered to #{@expected_email_addresses.inspect}"
+      end
+
       def matches?(email)
         @email = email
         @actual_recipients = (email.to || []).sort
@@ -31,6 +35,8 @@ module EmailSpec
       DeliverTo.new(expected_email_addresses_or_objects_that_respond_to_email)
     end
 
+    alias :be_delivered_to :deliver_to
+
     def have_subject(expected)
       simple_matcher do |given, matcher|
         given_subject = given.subject
@@ -51,5 +57,66 @@ module EmailSpec
       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/lib/email_spec.rb

@@ -1,3 +1,14 @@
-module EmailSpec
-  VERSION = '0.0.7'
+unless defined?(ActionMailer)
+  Kernel.warn("ActionMailer did not appear to be loaded so email-spec is requiring it.")
+  require 'actionmailer'
 end
+
+$LOAD_PATH.unshift(File.expand_path(File.dirname(__FILE__))) unless $LOAD_PATH.include?(File.expand_path(File.dirname(__FILE__)))
+
+require 'email_spec/deliveries'
+require 'email_spec/address_converter'
+require 'email_spec/email_viewer'
+require 'email_spec/helpers'
+require 'email_spec/matchers'
+
+

data/spec/email_spec/matchers_spec.rb

@@ -1,8 +1,43 @@
+
 require File.dirname(__FILE__) + '/../spec_helper'
 
-        
+
+
 describe EmailSpec::Matchers do
 
+
+    class MatcherMatch
+
+      def initialize(object_to_test_match)
+        @object_to_test_match = object_to_test_match
+      end
+
+      def description
+        "match when provided #{@object_to_test_match.inspect}"
+      end
+
+      def matches?(matcher)
+        @matcher = matcher
+        matcher.matches?(@object_to_test_match)
+      end
+
+      def failure_message
+        "expected #{@matcher.inspect} to match when provided #{@object_to_test_match.inspect}, but it did not"
+      end
+
+      def negative_failure_message
+        "expected #{@matcher.inspect} not to match when provided #{@object_to_test_match.inspect}, but it did"
+      end
+    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
+
   include EmailSpec::Matchers
 
   def mock_email(stubs)
@@ -14,21 +49,21 @@ describe EmailSpec::Matchers do
     it "should match when the email is set to deliver to the specidied address" do
       email = mock_email(:to => "jimmy_bean@yahoo.com")
 
-      deliver_to("jimmy_bean@yahoo.com").matches?(email).should be_true
+      deliver_to("jimmy_bean@yahoo.com").should match(email)
     end
 
     it "should match when a list of emails is exact same as all of the email's recipients" do
       email = mock_email(:to => ["james@yahoo.com", "karen@yahoo.com"])
 
-      deliver_to("karen@yahoo.com", "james@yahoo.com").matches?(email).should be_true
-      deliver_to("karen@yahoo.com").matches?(email).should be_false
+      deliver_to("karen@yahoo.com", "james@yahoo.com").should match(email)
+      deliver_to("karen@yahoo.com").should_not match(email)
     end
 
     it "should use the passed in objects :email method if not a string" do
       email = mock_email(:to => "jimmy_bean@yahoo.com")
       user = mock("user", :email => "jimmy_bean@yahoo.com")
 
-      deliver_to(user).matches?(email).should be_true
+      deliver_to(user).should match(email)
     end
 
   end
@@ -40,9 +75,9 @@ describe EmailSpec::Matchers do
       it "should match when the subject mathches regexp" do
         email = mock_email(:subject => ' -- The Subject --')
 
-        have_subject(/The Subject/).matches?(email).should be_true
-        have_subject(/The Subject/).matches?(email).should be_true
-        have_subject(/foo/).matches?(email).should be_false
+        have_subject(/The Subject/).should match(email)
+        have_subject(/The Subject/).should match(email)
+        have_subject(/foo/).should_not match(email)
       end
 
       it "should have a helpful description" do
@@ -67,14 +102,14 @@ describe EmailSpec::Matchers do
       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')
 
-        have_subject("foo").matches?(email).should be_true
-        have_subject(" - foo -").matches?(email).should be_false
+        have_subject("foo").should match(email)
+        have_subject(" - foo -").should_not match(email)
       end
 
       it "should have a helpful description" do
@@ -98,8 +133,21 @@ describe EmailSpec::Matchers do
 
         matcher.negative_failure_message.should == 'expected the subject not to be "bar" but was'
       end
-      
+
     end
 
+
+  end
+
+  describe "#include_email_with_subject" do
+    it "should have specs!"
+  end
+
+  describe "#have_body_text" do
+    it "should have specs!"
+  end
+  
+  describe "#have_header" do
+    it "should have specs!"
   end
 end

data/spec/spec_helper.rb

@@ -1,4 +1,4 @@
+require 'rubygems'
+require 'actionmailer'
 require 'spec'
-
-require File.expand_path(File.dirname(__FILE__) + '/../lib/email_spec/helpers.rb')
-require File.expand_path(File.dirname(__FILE__) + '/../lib/email_spec/matchers.rb')
+require File.expand_path(File.dirname(__FILE__) + '/../lib/email_spec.rb')

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: bmabey-email_spec
 version: !ruby/object:Gem::Version 
-  version: 0.0.7
+  version: 0.0.9
 platform: ruby
 authors: 
 - Ben Mabey
@@ -11,7 +11,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-01-20 00:00:00 -08:00
+date: 2009-02-17 00:00:00 -08:00
 default_executable: 
 dependencies: []
 
@@ -31,7 +31,10 @@ files:
 - README.rdoc
 - Rakefile
 - lib/email_spec
+- lib/email_spec/address_converter.rb
 - lib/email_spec/cucumber.rb
+- lib/email_spec/deliveries.rb
+- lib/email_spec/email_viewer.rb
 - lib/email_spec/helpers.rb
 - lib/email_spec/matchers.rb
 - lib/email_spec.rb
@@ -52,6 +55,7 @@ files:
 - examples/rails_root/app/helpers/application_helper.rb
 - examples/rails_root/app/helpers/welcome_helper.rb
 - examples/rails_root/app/models
+- examples/rails_root/app/models/user.rb
 - examples/rails_root/app/models/user_mailer.rb
 - examples/rails_root/app/views
 - examples/rails_root/app/views/user_mailer
@@ -73,8 +77,11 @@ files:
 - examples/rails_root/config/initializers/mime_types.rb
 - examples/rails_root/config/initializers/new_rails_defaults.rb
 - examples/rails_root/config/routes.rb
+- examples/rails_root/cucumber.yml
 - examples/rails_root/db
 - examples/rails_root/db/development.sqlite3
+- examples/rails_root/db/migrate
+- examples/rails_root/db/migrate/20090125013728_create_users.rb
 - examples/rails_root/db/schema.rb
 - examples/rails_root/db/test.sqlite3
 - examples/rails_root/doc
@@ -84,6 +91,7 @@ files:
 - examples/rails_root/features/example.feature
 - examples/rails_root/features/step_definitions
 - examples/rails_root/features/step_definitions/email_steps.rb
+- examples/rails_root/features/step_definitions/user_steps.rb
 - examples/rails_root/features/step_definitions/webrat_steps.rb
 - examples/rails_root/features/support
 - examples/rails_root/features/support/env.rb
@@ -133,8 +141,10 @@ files:
 - examples/rails_root/spec
 - examples/rails_root/spec/controllers
 - examples/rails_root/spec/controllers/welcome_controller_spec.rb
+- examples/rails_root/spec/model_factory.rb
 - examples/rails_root/spec/models
 - examples/rails_root/spec/models/user_mailer_spec.rb
+- examples/rails_root/spec/models/user_spec.rb
 - examples/rails_root/spec/rcov.opts
 - examples/rails_root/spec/spec.opts
 - examples/rails_root/spec/spec_helper.rb
@@ -149,12 +159,12 @@ files:
 - examples/rails_root/vendor/plugins/email_spec/generators/email_spec/email_spec_generator.rb
 - examples/rails_root/vendor/plugins/email_spec/generators/email_spec/templates
 - examples/rails_root/vendor/plugins/email_spec/generators/email_spec/templates/email_steps.rb
-- examples/rails_root/vendor/plugins/rspec-rails
 has_rdoc: true
 homepage: http://github.com/bmabey/email-spec/
 post_install_message: 
-rdoc_options: []
-
+rdoc_options: 
+- --inline-source
+- --charset=UTF-8
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 

data/examples/rails_root/vendor/plugins/rspec-rails

@@ -1 +0,0 @@
-/Users/bmabey/p/ruby/rspec-dev/example_rails_app/vendor/plugins/rspec-rails