email_spec 0.3.0 → 0.3.1

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

@@ -1,104 +1,137 @@
+require File.expand_path(File.join(File.dirname(__FILE__), "..", "support", "paths"))
+
 # Commonly used webrat steps
 # http://github.com/brynary/webrat
 
-Given /^I am at "(.+)"$/ do |path|
-  visit path
+Given /^I am on (.+)$/ do |page_name|
+  visit path_to(page_name)
 end
 
-Given /^I'm on the (.+) page$/ do |page|
-  locations = {"signup" => "/"}
-  visit locations[page]
+When /^I go to (.+)$/ do |page_name|
+  visit path_to(page_name)
 end
 
-When /^I press "(.*)"$/ do |button|
+When /^I press "([^\"]*)"$/ do |button|
   click_button(button)
 end
 
-When /^I follow "(.*)"$/ do |link|
+When /^I follow "([^\"]*)"$/ do |link|
   click_link(link)
 end
 
-When /^I fill in "(.*)" with "(.*)"$/ do |field, value|
-  fill_in(field, :with => value) 
+When /^I follow "([^\"]*)" within "([^\"]*)"$/ do |link, parent|
+  click_link_within(parent, link)
+end
+
+When /^I fill in "([^\"]*)" with "([^\"]*)"$/ do |field, value|
+  fill_in(field, :with => value)
 end
 
-When /^I select "(.*)" from "(.*)"$/ do |value, field|
-  select(value, :from => field) 
+When /^I select "([^\"]*)" from "([^\"]*)"$/ do |value, field|
+  select(value, :from => field)
 end
 
 # Use this step in conjunction with Rail's datetime_select helper. For example:
-# When I select "December 25, 2008 10:00" as the date and time 
-When /^I select "(.*)" as the date and time$/ do |time|
+# When I select "December 25, 2008 10:00" as the date and time
+When /^I select "([^\"]*)" as the date and time$/ do |time|
   select_datetime(time)
 end
 
-# Use this step when using multiple datetime_select helpers on a page or 
+# Use this step when using multiple datetime_select helpers on a page or
 # you want to specify which datetime to select. Given the following view:
-#   <%= f.label :preferred %><br />
-#   <%= f.datetime_select :preferred %>
-#   <%= f.label :alternative %><br />
-#   <%= f.datetime_select :alternative %>
+#   <%%= f.label :preferred %><br />
+#   <%%= f.datetime_select :preferred %>
+#   <%%= f.label :alternative %><br />
+#   <%%= f.datetime_select :alternative %>
 # The following steps would fill out the form:
-# When I select "November 23, 2004 11:20" as the "Preferred" data and time
-# And I select "November 25, 2004 10:30" as the "Alternative" data and time
-When /^I select "(.*)" as the "(.*)" date and time$/ do |datetime, datetime_label|
+# When I select "November 23, 2004 11:20" as the "Preferred" date and time
+# And I select "November 25, 2004 10:30" as the "Alternative" date and time
+When /^I select "([^\"]*)" as the "([^\"]*)" date and time$/ do |datetime, datetime_label|
   select_datetime(datetime, :from => datetime_label)
 end
 
-# Use this step in conjuction with Rail's time_select helper. For example:
+# Use this step in conjunction with Rail's time_select helper. For example:
 # When I select "2:20PM" as the time
 # Note: Rail's default time helper provides 24-hour time-- not 12 hour time. Webrat
-# will convert the 2:20PM to 14:20 and then select it. 
-When /^I select "(.*)" as the time$/ do |time|
+# will convert the 2:20PM to 14:20 and then select it.
+When /^I select "([^\"]*)" as the time$/ do |time|
   select_time(time)
 end
 
 # Use this step when using multiple time_select helpers on a page or you want to
 # specify the name of the time on the form.  For example:
 # When I select "7:30AM" as the "Gym" time
-When /^I select "(.*)" as the "(.*)" time$/ do |time, time_label|
+When /^I select "([^\"]*)" as the "([^\"]*)" time$/ do |time, time_label|
   select_time(time, :from => time_label)
 end
 
-# Use this step in conjuction with Rail's date_select helper.  For example:
+# Use this step in conjunction with Rail's date_select helper.  For example:
 # When I select "February 20, 1981" as the date
-When /^I select "(.*)" as the date$/ do |date|
+When /^I select "([^\"]*)" as the date$/ do |date|
   select_date(date)
 end
 
 # Use this step when using multiple date_select helpers on one page or
 # you want to specify the name of the date on the form. For example:
 # When I select "April 26, 1982" as the "Date of Birth" date
-When /^I select "(.*)" as the "(.*)" date$/ do |date, date_label|
+When /^I select "([^\"]*)" as the "([^\"]*)" date$/ do |date, date_label|
   select_date(date, :from => date_label)
 end
 
-When /^I check "(.*)"$/ do |field|
-  check(field) 
+When /^I check "([^\"]*)"$/ do |field|
+  check(field)
 end
 
-When /^I uncheck "(.*)"$/ do |field|
-  uncheck(field) 
+When /^I uncheck "([^\"]*)"$/ do |field|
+  uncheck(field)
 end
 
-When /^I choose "(.*)"$/ do |field|
+When /^I choose "([^\"]*)"$/ do |field|
   choose(field)
 end
 
-When /^I attach the file at "(.*)" to "(.*)" $/ do |path, field|
+When /^I attach the file at "([^\"]*)" to "([^\"]*)"$/ do |path, field|
   attach_file(field, path)
 end
 
-Then /^I should see "(.*)"$/ do |text|
-  response.body.should =~ /#{text}/m
+Then /^I should see "([^\"]*)"$/ do |text|
+  response.should contain(text)
+end
+
+Then /^I should see \/([^\/]*)\/$/ do |regexp|
+  regexp = Regexp.new(regexp)
+  response.should contain(regexp)
+end
+
+Then /^I should not see "([^\"]*)"$/ do |text|
+  response.should_not contain(text)
 end
 
-Then /^I should not see "(.*)"$/ do |text|
-  response.body.should_not =~ /#{text}/m
+Then /^I should not see \/([^\/]*)\/$/ do |regexp|
+  regexp = Regexp.new(regexp)
+  response.should_not contain(regexp)
 end
 
-Then /^the "(.*)" checkbox should be checked$/ do |label|
+Then /^the "([^\"]*)" field should contain "([^\"]*)"$/ do |field, value|
+  field_labeled(field).value.should =~ /#{value}/
+end
+
+Then /^the "([^\"]*)" field should not contain "([^\"]*)"$/ do |field, value|
+  field_labeled(field).value.should_not =~ /#{value}/
+end
+
+Then /^the "([^\"]*)" checkbox should be checked$/ do |label|
   field_labeled(label).should be_checked
 end
 
+Then /^the "([^\"]*)" checkbox should not be checked$/ do |label|
+  field_labeled(label).should_not be_checked
+end
+
+Then /^I should be on (.+)$/ do |page_name|
+  URI.parse(current_url).path.should == path_to(page_name)
+end
 
+Then /^show me the page$/ do
+  save_and_open_page
+end

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

@@ -1,19 +1,30 @@
 # Sets up the Rails environment for Cucumber
-ENV["RAILS_ENV"] = "test"
+ENV["RAILS_ENV"] ||= "test"
 require File.expand_path(File.dirname(__FILE__) + '/../../config/environment')
 require 'cucumber/rails/world'
+
+# Comment out the next line if you don't want Cucumber Unicode support
+require 'cucumber/formatter/unicode'
+
+# Comment out the next line if you don't want transactions to
+# open/roll back around each scenario
 Cucumber::Rails.use_transactional_fixtures
 
+# Comment out the next line if you want Rails' own error handling
+# (e.g. rescue_action_in_public / rescue_responses / rescue_from)
+Cucumber::Rails.bypass_rescue
+
 require 'webrat'
-require 'cucumber/rails/rspec'
-require 'webrat/core/matchers'
+require 'cucumber/webrat/table_locator' # Lets you do table.diff!(table_at('#my_table').to_a)
 
 Webrat.configure do |config|
   config.mode = :rails
 end
 
+require 'cucumber/rails/rspec'
+require 'webrat/core/matchers'
 
-
+# email testing in cucumber
 require File.expand_path(File.dirname(__FILE__) + '../../../../../lib/email_spec')
 require 'email_spec/cucumber'
 

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

@@ -0,0 +1,21 @@
+module NavigationHelpers
+  # Maps a name to a path. Used by the
+  #
+  #   When /^I go to (.+)$/ do |page_name|
+  #
+  # step definition in webrat_steps.rb
+  #
+  def path_to(page_name)
+    case page_name
+
+    when /the homepage/
+      '/'
+
+    else
+      raise "Can't find mapping from \"#{page_name}\" to a path.\n" +
+        "Now, go and add a mapping in #{__FILE__}"
+    end
+  end
+end
+
+World(NavigationHelpers)

data/examples/rails_root/script/cucumber

@@ -1,7 +1,9 @@
 #!/usr/bin/env ruby
 begin
   load File.expand_path(File.dirname(__FILE__) + "/../vendor/plugins/cucumber/bin/cucumber")
-rescue LoadError
-  require "rubygems"
-  load File.join(Gem.bindir, "cucumber")
-end
+rescue LoadError => e
+  raise unless e.to_s =~ /cucumber/
+  require 'rubygems'
+  require 'cucumber'
+  load Cucumber::BINARY
+end

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

@@ -3,12 +3,12 @@ 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
   include ActionController::UrlWriter
+  default_url_options = {:host => 'example.com'}
 
   before(:all) do
     @email = UserMailer.create_signup("jojo@yahoo.com", "Jojo Binks")
@@ -25,7 +25,7 @@ describe "Signup Email" do
   end
 
   it "should contain a link to the confirmation page" do
-    @email.should have_body_text(/#{confirm_account_url}/)
+    @email.should have_body_text(/#{confirm_account_url(:host => 'example.com')}/)
   end
   
   it { should have_subject(/Account confirmation/) }
@@ -45,7 +45,7 @@ describe "Signup Email" do
 
   subject { @email }
 
-  it { should have_body_text(/#{confirm_account_url}/) }
+  it { should have_body_text(/#{confirm_account_url(:host => 'example.com')}/) }
   it { should have_subject(/Account confirmation/) }
 
   describe "sent with email address of 'jojo@yahoo.com', and users name 'Jojo Binks'" do

data/examples/rails_root/spec/spec_helper.rb

@@ -6,7 +6,7 @@ require 'spec'
 require 'spec/rails'
 
 require File.expand_path(File.dirname(__FILE__) + "/model_factory.rb")
-require (Rails.root + '/../../lib/email_spec.rb')
+require (RAILS_ROOT + '/../../lib/email_spec.rb')
 
 Spec::Runner.configure do |config|
   config.include(Fixjour)

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

@@ -1,9 +1,10 @@
-#Commonly used email steps
+# Commonly used email steps
 #
 # To add your own steps make a custom_email_steps.rb
 # The provided methods are:
 #
-# reset_mailer 
+# last_email_address
+# reset_mailer
 # open_last_email
 # visit_in_email
 # unread_emails_for
@@ -12,6 +13,16 @@
 # 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
@@ -21,63 +32,88 @@ module EmailHelpers
     last_email_address || "example@example.com"
   end
 end
+
 World(EmailHelpers)
 
-# Use this step to reset the e-mail queue within a scenario.
+#
+# 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
 
-# Use this step to open the most recently sent e-mail. 
-When /^(?:I|they) open the email$/ do
-  open_email(current_email_address)
-end
+#
+# Check how many emails have been sent/received
+#
 
-When %r{^(?:I|they) follow "([^"]*?)" in the email$} do |link|
-  visit_in_email(link)
+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 receive (an|\d+) emails?$/ do |amount|
-  amount = 1 if amount == "an"
-  unread_emails_for(current_email_address).size.should == amount.to_i
+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 not receive any emails?$/ do
-  unread_emails_for(current_email_address).size.should == 0
+# DEPRECATED
+# The following methods are left in for backwards compatibility and
+# should be removed by version 0.3.5.
+Then /^(?:I|they|"([^"]*?)") should not receive an email$/ do |address|
+  email_spec_deprecate "The step 'I/they/[email] should not receive an email' is no longer supported.
+                      Please use 'I/they/[email] should receive no emails' instead."
+  unread_emails_for(address).size.should == 0
 end
 
-Then %r{^"([^"]*?)" should receive (an|\d+) emails?$} do |address, amount|
-  amount = 1 if amount == "an"
-  unread_emails_for(address).size.should == amount.to_i 
+#
+# Accessing emails
+#
+
+# Opens the most recently received email
+When /^(?:I|they|"([^"]*?)") opens? the email$/ do |address|
+  open_email(address)
 end
 
-Then %r{^"([^"]*?)" should have (\d+) emails?$} do |address, n|
-  mailbox_for(address).size.should == n.to_i
+When /^(?:I|they|"([^"]*?)") opens? the email with subject "([^"]*?)"$/ do |address, subject|
+  open_email(address, :with_subject => subject)
 end
 
-Then %r{^"([^"]*?)" should not receive an email$} do |address|
-  find_email(address).should be_nil
+When /^(?:I|they|"([^"]*?)") opens? the email with text "([^"]*?)"$/ do |address, text|
+  open_email(address, :with_text => text)
 end
 
-Then %r{^(?:I|they) should see "([^"]*?)" in the subject$} do |text|
+#
+# Inspect the Email Contents
+#
+
+Then /^(?:I|they) should see "([^"]*?)" in the email subject$/ do |text|
   current_email.should have_subject(Regexp.new(text))
 end
 
-Then %r{^(?:I|they) should see "([^"]*?)" in the email$} do |text|
+Then /^(?:I|they) should see "([^"]*?)" in the email body$/ do |text|
   current_email.body.should =~ Regexp.new(text)
 end
 
-When %r{^"([^"]*?)" opens? the email$} do |address|
-  open_email(address)
+# DEPRECATED
+# The following methods are left in for backwards compatibility and
+# should be removed by version 0.3.5.
+Then /^(?:I|they) should see "([^"]*?)" in the subject$/ do |text|
+  email_spec_deprecate "The step 'I/they should see [text] in the subject' is no longer supported.
+                      Please use 'I/they should see [text] in the email subject' instead."
+  current_email.should have_subject(Regexp.new(text))
 end
-
-When %r{^"([^"]*?)" opens? the email with subject "([^"]*?)"$} do |address, subject|
-  open_email(address, :with_subject => subject)
+Then /^(?:I|they) should see "([^"]*?)" in the email$/ do |text|
+  email_spec_deprecate "The step 'I/they should see [text] in the email' is no longer supported.
+                      Please use 'I/they should see [text] in the email body' instead."
+  current_email.body.should =~ Regexp.new(text)
 end
 
-When %r{^"([^"]*?)" opens? the email with text "([^"]*?)"$} do |address, text|
-  open_email(address, :with_text => text)
+#
+# 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

data/lib/email_spec/deliveries.rb

@@ -13,7 +13,6 @@ module EmailSpec
     end
 
     def mailbox_for(address)
-      address = AddressConverter.instance.convert(address)
       ActionMailer::Base.deliveries.select { |m| m.to.include?(address) || (m.bcc && m.bcc.include?(address)) || (m.cc && m.cc.include?(address)) }
     end
   end
@@ -36,7 +35,6 @@ module EmailSpec
     end
 
     def mailbox_for(address)
-      address = AddressConverter.instance.convert(address)
       Email.all.select { |email| email.to.include?(address) || email.bcc.include?(address) || email.cc.include?(address) }.map{ |email| parse_to_tmail(email) }
     end