email_spec 0.3.1 → 0.3.5

data/History.txt

@@ -3,13 +3,33 @@
  === New features
  === Bufixes
 
+== 0.3.5 2009-09-30 The Pony Release!
+
+ === New features
+ * Support for Pony mailer library. (Rob Holland)
+
+== 0.3.4 2009-09-26
+
+=== Bugfixes
+ * Typo and logic fixes for DeliverFrom matcher. (Yury Kotlyarov)
+
+ == 0.3.3 2009-09-18
+
+ === New features
+ * DeliverFrom matcher. i.e. email.should deliver_from(blah) or email.should be_delivered_from(blah) (Diego Carrion)
+
+ == 0.3.2 2009-09-10
+
+ === New features
+  * Support for delayed_job. (Kieran Pilkington)
+
  == 0.3.1 2009-08-19
 This release is a general refactoring of the steps and helpers.
 The example rails app was also updated to use the lateset rails and webrat.  It also takes advantages
 and the newer step definistions including the new third-person forms.
 
 Some of the generated steps are being removed in favor of some of the newer ones.  The older ones
-will remain until 0.3.5 but will issue deprecation warnings.
+will remain until 0.4.0 but will issue deprecation warnings.
 
 Big shoutout to Kieran Pilkington who did the majority of work for this release.
 

data/README.rdoc

@@ -8,12 +8,12 @@ A collection of RSpec matchers and Cucumber steps to make testing emails go smoo
   script/plugin install git://github.com/bmabey/email-spec.git
 
 === Gem Setup
-  
+
   gem install bmabey-email_spec
 
   # config/environments/test.rb
   config.gem 'bmabey-email_spec', :lib => 'email_spec'
-  
+
 === Cucumber
 
 To use the steps in features put the following in your env.rb:
@@ -21,7 +21,7 @@ To use the steps in features put the following in your env.rb:
   # Make sure this require is after you require cucumber/rails/world.
   require 'email_spec/cucumber'
 
-This will load all the helpers that the steps rely on. 
+This will load all the helpers that the steps rely on.
 It will also add a Before hook for Cucumber so that emails are cleared at the start of each scenario.
 
 Then:
@@ -32,7 +32,7 @@ This will give you a bunch of steps to get started with in step_definitions/emai
 
 === RSpec
 
-	First you need to require the helpers and matchers in your spec_helper.rb like so:
+  First you need to require the helpers and matchers in your spec_helper.rb like so:
 
   require "email_spec/helpers"
   require "email_spec/matchers"
@@ -95,11 +95,11 @@ For more examples, check out examples/rails_root in the source for a small examp
       before(:all) do
         @email = UserMailer.create_signup("jojo@yahoo.com", "Jojo Binks")
       end
-      
+
       it "should be set to be delivered to the email passed in" do
         @email.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/)
       end
@@ -107,14 +107,14 @@ For more examples, check out examples/rails_root in the source for a small examp
       it "should contain a link to the confirmation link" do
         @email.should have_text(/#{confirm_account_url}/)
       end
-      
+
       it "should have the correct subject" do
         @email.should have_subject(/Account confirmation/)
       end
-      
+
     end
-     
-    ==== Using the helpers when not testing in isolation ==== 
+
+    ==== Using the helpers when not testing in isolation ====
 
       Don't. :)  Seriously, if you do just take a look at the helpers and use them as you wish.
 

data/Rakefile

@@ -25,12 +25,14 @@ rescue LoadError
   puts "Jeweler not available. Install it with: sudo gem install technicalpickles-jeweler -s http://gems.github.com"
 end
 
-
-begin
-  gem 'fixjour'
-rescue Gem::LoadError
-  puts "Installing fixjour for the example rails app..."
-  puts `gem install fixjour --no-rdoc --no-ri`
+# TODO: Maybe use geminstaller instead?
+%w[collectiveidea-delayed_job fixjour pony sinatra rack-test].each do |gem_name|
+  begin
+    gem gem_name
+  rescue Gem::LoadError
+    puts "Installing #{gem_name} for the example rails app..."
+    puts `gem install #{gem_name} --no-rdoc --no-ri`
+  end
 end
 
 begin
@@ -60,8 +62,14 @@ task :default => [:features, :spec, 'example_app:spec']
 
 desc "Cleans the project of any tmp file that should not be included in the gemspec."
 task :clean do
+  FileUtils.rm_f('examples/rails_root/features/step_definitions/email_steps.rb')
+  FileUtils.rm_rf('examples/rails_root/log')
+  FileUtils.rm_rf('examples/rails_root/vendor')
   %w[*.sqlite3 *.log].each do |pattern|
     `find . -name "#{pattern}" -delete`
   end
 end
 
+desc "Cleans the dir and builds the gem"
+task :prep => [:clean, :gemspec, :build]
+

data/examples/rails_root/Rakefile

@@ -5,3 +5,9 @@ require 'rake/testtask'
 require 'rake/rdoctask'
 
 require 'tasks/rails'
+
+begin
+  require 'delayed/tasks'
+rescue LoadError
+  STDERR.puts "Run `rake gems:install` to install delayed_job"
+end

data/examples/rails_root/app/controllers/welcome_controller.rb

@@ -6,4 +6,7 @@ class WelcomeController < ApplicationController
   def confirm
   end
 
+  def newsletter
+    UserMailer.send_later(:deliver_newsletter, params['Email'], params['Name'])
+  end
 end

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

@@ -8,4 +8,11 @@ class UserMailer < ActionMailer::Base
     @body[:name] = name
   end
 
+  def newsletter(email, name)
+    @recipients  = email
+    @from        = "admin@example.com"
+    @subject     = "Newsletter sent"
+    @sent_on     = Time.now
+    @body[:name] = name
+  end
 end

data/examples/rails_root/app/views/user_mailer/newsletter.erb

@@ -0,0 +1,8 @@
+Hello <%= @name %>!
+
+This week.....
+.....
+.....
+
+Regards
+Rails Example App

data/examples/rails_root/config/environment.rb

@@ -5,7 +5,7 @@
 # ENV['RAILS_ENV'] ||= 'production'
 
 # Specifies gem version of Rails to use when vendor/rails is not present
-RAILS_GEM_VERSION = '2.3.3' unless defined? RAILS_GEM_VERSION
+RAILS_GEM_VERSION = '2.3.4' unless defined? RAILS_GEM_VERSION
 
 # Bootstrap the Rails environment, frameworks, and default configuration
 require File.join(File.dirname(__FILE__), 'boot')

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

@@ -22,8 +22,9 @@ config.action_controller.allow_forgery_protection    = false
 config.action_mailer.delivery_method = :test
 config.action_mailer.default_url_options = { :host => "example.com" }
 
-config.gem 'cucumber',         :lib => false
-config.gem 'webrat',           :lib => false
-config.gem 'rspec',            :lib => false
-config.gem 'rspec-rails',      :lib => 'spec/rails'
-config.gem 'fixjour', :lib => 'fixjour'
+config.gem 'cucumber',                   :lib => false
+config.gem 'webrat',                     :lib => false
+config.gem 'rspec',                      :lib => false
+config.gem 'rspec-rails',                :lib => 'spec/rails'
+config.gem 'fixjour',                    :lib => 'fixjour'
+config.gem 'collectiveidea-delayed_job', :lib => 'delayed_job', :source => 'http://gems.github.com'

data/examples/rails_root/config/routes.rb

@@ -17,7 +17,7 @@ ActionController::Routing::Routes.draw do |map|
 
   # Sample resource route with sub-resources:
   #   map.resources :products, :has_many => [ :comments, :sales ], :has_one => :seller
-  
+
   # Sample resource route with more complex sub-resources
   #   map.resources :products do |products|
   #     products.resources :comments
@@ -33,6 +33,7 @@ ActionController::Routing::Routes.draw do |map|
   # You can have the root of your site routed with map.root -- just remember to delete public/index.html.
   map.root :controller => "welcome", :action => "index"
   map.confirm_account "/confirm", :controller => "welcome", :action => "confirm"
+  map.request_newsletter "/newsletter", :controller => "welcome", :action => "newsletter"
   # See how all your routes lay out with "rake routes"
 
   # Install the default routes as the lowest priority.

data/examples/rails_root/db/migrate/20090908054656_create_delayed_jobs.rb

@@ -0,0 +1,20 @@
+class CreateDelayedJobs < ActiveRecord::Migration
+  def self.up
+    create_table :delayed_jobs, :force => true do |table|
+      table.integer  :priority, :default => 0      # Allows some jobs to jump to the front of the queue
+      table.integer  :attempts, :default => 0      # Provides for retries, but still fail eventually.
+      table.text     :handler                      # YAML-encoded string of the object that will do work
+      table.text     :last_error                   # reason for last failure (See Note below)
+      table.datetime :run_at                       # When to run. Could be Time.now for immediately, or sometime in the future.
+      table.datetime :locked_at                    # Set when a client is working on this object
+      table.datetime :failed_at                    # Set when all retries have failed (actually, by default, the record is deleted instead)
+      table.string   :locked_by                    # Who is working on this object (if locked)
+      table.timestamps
+    end
+
+  end
+  
+  def self.down
+    drop_table :delayed_jobs  
+  end
+end

data/examples/rails_root/db/schema.rb

@@ -9,7 +9,20 @@
 #
 # It's strongly recommended to check this file into your version control system.
 
-ActiveRecord::Schema.define(:version => 20090125013728) do
+ActiveRecord::Schema.define(:version => 20090908054656) do
+
+  create_table "delayed_jobs", :force => true do |t|
+    t.integer  "priority",   :default => 0
+    t.integer  "attempts",   :default => 0
+    t.text     "handler"
+    t.text     "last_error"
+    t.datetime "run_at"
+    t.datetime "locked_at"
+    t.datetime "failed_at"
+    t.string   "locked_by"
+    t.datetime "created_at"
+    t.datetime "updated_at"
+  end
 
   create_table "users", :force => true do |t|
     t.string "email"

data/examples/rails_root/features/delayed_job.feature

@@ -0,0 +1,13 @@
+Feature: Delayed Job support
+  In order for developers using delayed_job to test emails
+  I want to be able to provide a compatibility layer, which
+  should run all delayed jobs before checking email boxes
+  In order to populate deliveries done via send_later
+
+  Scenario: Newsletter
+    Given no emails have been sent
+    And I go to request a newsletter
+    Then I should receive an email
+    And I should have 1 email
+    When I open the email
+    Then I should see "Newsletter sent" in the email subject

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

@@ -17,7 +17,7 @@ Then /^(?:I|they) should receive an email with a link to a confirmation page$/ d
   current_email.should have_body_text('Joe Someone')
 
   click_email_link_matching /confirm/
-  response.should include_text("Confirm your new account")
+  response_body.should contain("Confirm your new account")
 end
 
 # Basically aliases "I should see [text]", but for third person

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

@@ -95,21 +95,21 @@ When /^I attach the file at "([^\"]*)" to "([^\"]*)"$/ do |path, field|
 end
 
 Then /^I should see "([^\"]*)"$/ do |text|
-  response.should contain(text)
+  response_body.should contain(text)
 end
 
 Then /^I should see \/([^\/]*)\/$/ do |regexp|
   regexp = Regexp.new(regexp)
-  response.should contain(regexp)
+  response_body.should contain(regexp)
 end
 
 Then /^I should not see "([^\"]*)"$/ do |text|
-  response.should_not contain(text)
+  response_body.should_not contain(text)
 end
 
 Then /^I should not see \/([^\/]*)\/$/ do |regexp|
   regexp = Regexp.new(regexp)
-  response.should_not contain(regexp)
+  response_body.should_not contain(regexp)
 end
 
 Then /^the "([^\"]*)" field should contain "([^\"]*)"$/ do |field, value|

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

@@ -8,11 +8,11 @@ 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
+#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
+#Cucumber::Rails.bypass_rescue
 
 require 'webrat'
 require 'cucumber/webrat/table_locator' # Lets you do table.diff!(table_at('#my_table').to_a)

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

@@ -11,6 +11,9 @@ module NavigationHelpers
     when /the homepage/
       '/'
 
+    when /request a newsletter/
+      request_newsletter_url('Name' => 'Joe Someone', 'Email' => 'example@example.com')
+
     else
       raise "Can't find mapping from \"#{page_name}\" to a path.\n" +
         "Now, go and add a mapping in #{__FILE__}"

data/examples/rails_root/script/delayed_job

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require File.expand_path(File.join(File.dirname(__FILE__), '..', 'config', 'environment'))
+require 'delayed/command'
+Delayed::Command.new(ARGV).daemonize

data/examples/sinatra/app.rb

@@ -0,0 +1,33 @@
+require 'sinatra'
+require 'pony'
+
+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

data/examples/sinatra/features/errors.feature

@@ -0,0 +1,32 @@
+Feature: Email-spec errors example
+  In order to help alleviate email testing in apps
+  As a email-spec contributor I a newcomer
+  Should be able to easily determine where I have gone wrong
+  These scenarios should fail with helpful messages
+
+  Background:
+    Given I am on the homepage
+    And no emails have been sent
+    When I fill in "Email" with "example@example.com"
+    And I press "Sign up"
+
+  Scenario: I fail to open an email with incorrect subject
+    Then I should receive an email
+    When "example@example.com" opens the email with subject "no email"
+
+  Scenario: I fail to open an email with incorrect text
+    Then I should receive an email
+    When "example@example.com" opens the email with text "no email"
+
+  Scenario: I fail to receive an email with the expected link
+    Then I should receive an email
+    When I open the email
+    When I follow "link that doesn't exist" in the email
+
+  Scenario: I attempt to operate on an email that is not opened
+    Then I should receive an email
+    When I follow "confirm" in the email
+
+  Scenario: I attempt to check out an unopened email
+    Then I should see "confirm" in the email body
+    And I should see "Account confirmation" in the email subject

data/examples/sinatra/features/example.feature

@@ -0,0 +1,62 @@
+Feature: EmailSpec Example -- Prevent Bots from creating accounts
+
+  In order to help alleviate email testing in apps
+  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
+
+  Background:
+    Given no emails have been sent
+    And I am a real person wanting to sign up for an account
+    And I am on the homepage
+    And I submit my registration information
+
+  Scenario: First person signup (as myself) with two ways of opening email
+    Then I should receive an email
+    And I should have 1 email
+
+    # Opening email #1
+    When I open the email
+    Then I should see "Account confirmation" in the email subject
+    And I should see "Joe Someone" in the email body
+    And I should see "confirm" in the email body
+
+    # Opening email #2
+    When I open the email with subject "Account confirmation"
+    Then I should see "Account confirmation" in the email subject
+    And I should see "Joe Someone" in the email body
+    And I should see "confirm" in the email body
+
+    When I follow "Click here to confirm your account!" in the email
+    Then I should see "Confirm your new account"
+
+    And "foo@bar.com" should have no emails
+
+  Scenario: Third person signup (emails sent to others) with two ways of opening email
+    Then "foo@bar.com" should have no emails
+    And "example@example.com" should receive an email
+    And "example@example.com" should have 1 email
+
+    # Opening email #1
+    When they open the email
+    Then they should see "Account confirmation" in the email subject
+    And they should see "Joe Someone" in the email body
+    And they should see "confirm" in the email body
+
+    # Opening email #2
+    When "example@example.com" opens the email with subject "Account confirmation"
+    Then they should see "Account confirmation" in the email subject
+    And they should see "Joe Someone" in the email body
+    And they should see "confirm" in the email body
+
+    When they follow "Click here to confirm your account!" in the email
+    Then they should see "Confirm your new account"
+
+  Scenario: Declarative First Person signup
+    Then I should receive an email with a link to a confirmation page
+
+  Scenario: Declarative First Person signup
+    Then they should receive an email with a link to a confirmation page

data/examples/{rails_root → sinatra}/features/step_definitions/email_steps.rb

@@ -58,7 +58,7 @@ end
 
 # DEPRECATED
 # The following methods are left in for backwards compatibility and
-# should be removed by version 0.3.5.
+# should be removed by version 0.4.0
 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."
@@ -96,7 +96,7 @@ end
 
 # DEPRECATED
 # The following methods are left in for backwards compatibility and
-# should be removed by version 0.3.5.
+# should be removed by version 0.4.0.
 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."

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

@@ -0,0 +1,26 @@
+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 => 'Joe Someone'
+  fill_in "Email", :with => 'example@example.com'
+  click_button
+end
+
+Then /^(?:I|they) should receive an email with a link to a confirmation page$/ do
+  unread_emails_for(current_email_address).size.should == 1
+
+  # this call will store the email and you can access it with current_email
+  open_last_email_for(last_email_address)
+  current_email.should have_subject(/Account confirmation/)
+  current_email.should have_body_text('Joe Someone')
+
+  click_email_link_matching /confirm/
+  response_body.should contain("Confirm your new account")
+end
+
+# Basically aliases "I should see [text]", but for third person
+Then /^they should see "([^\"]*)"$/ do |text|
+  Then "I should see \"#{text}\""
+end

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

@@ -0,0 +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 on (.+)$/ do |page_name|
+  visit path_to(page_name)
+end
+
+When /^I go to (.+)$/ do |page_name|
+  visit path_to(page_name)
+end
+
+When /^I press "([^\"]*)"$/ do |button|
+  click_button(button)
+end
+
+When /^I follow "([^\"]*)"$/ do |link|
+  click_link(link)
+end
+
+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)
+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|
+  select_datetime(time)
+end
+
+# 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 %>
+# The following steps would fill out the form:
+# 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 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|
+  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|
+  select_time(time, :from => time_label)
+end
+
+# 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|
+  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|
+  select_date(date, :from => date_label)
+end
+
+When /^I check "([^\"]*)"$/ do |field|
+  check(field)
+end
+
+When /^I uncheck "([^\"]*)"$/ do |field|
+  uncheck(field)
+end
+
+When /^I choose "([^\"]*)"$/ do |field|
+  choose(field)
+end
+
+When /^I attach the file at "([^\"]*)" to "([^\"]*)"$/ do |path, field|
+  attach_file(field, path)
+end
+
+Then /^I should see "([^\"]*)"$/ do |text|
+  response_body.should contain(text)
+end
+
+Then /^I should see \/([^\/]*)\/$/ do |regexp|
+  regexp = Regexp.new(regexp)
+  response_body.should contain(regexp)
+end
+
+Then /^I should not see "([^\"]*)"$/ do |text|
+  response_body.should_not contain(text)
+end
+
+Then /^I should not see \/([^\/]*)\/$/ do |regexp|
+  regexp = Regexp.new(regexp)
+  response_body.should_not contain(regexp)
+end
+
+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/sinatra/features/support/env.rb

@@ -0,0 +1,33 @@
+# Sets up the Rails environment for Cucumber
+ENV["RACK_ENV"] ||= "test"
+require File.expand_path(File.dirname(__FILE__) + '/../../app.rb')
+
+# Comment out the next line if you don't want Cucumber Unicode support
+require 'cucumber/formatter/unicode'
+
+require 'rack/test'
+require 'webrat'
+require 'cucumber/webrat/table_locator' # Lets you do table.diff!(table_at('#my_table').to_a)
+
+Webrat.configure do |config|
+  config.mode = :rack
+end
+
+require 'webrat/core/matchers'
+
+# email testing in cucumber
+require 'activesupport'
+require File.expand_path(File.dirname(__FILE__) + '../../../../../lib/email_spec')
+require 'email_spec/cucumber'
+
+class AppWorld
+  include Rack::Test::Methods
+  include Webrat::Methods
+  include Webrat::Matchers
+
+  def app
+    Sinatra::Application.new
+  end
+end
+
+World { AppWorld.new }

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

@@ -0,0 +1,24 @@
+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/
+      '/'
+
+    when /request a newsletter/
+      "/newsletter/Joe Someone/example@example.com"
+
+    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/lib/email_spec.rb

@@ -1,10 +1,11 @@
-unless defined?(ActionMailer)
-  Kernel.warn("ActionMailer did not appear to be loaded so email-spec is requiring it.")
+unless defined?(Pony) or defined?(ActionMailer)
+  Kernel.warn("Neither Pony nor ActionMailer appear to be loaded so email-spec is requiring ActionMailer.")
   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/background_processes'
 require 'email_spec/deliveries'
 require 'email_spec/address_converter'
 require 'email_spec/email_viewer'

data/lib/email_spec/address_converter.rb

@@ -1,3 +1,5 @@
+require 'singleton'
+
 module EmailSpec
   class AddressConverter
     include Singleton

data/lib/email_spec/background_processes.rb

@@ -0,0 +1,31 @@
+module EmailSpec
+  module BackgroundProcesses
+    module DelayedJob
+      def all_emails
+        Delayed::Job.work_off
+        super
+      end
+
+      def last_email_sent
+        Delayed::Job.work_off
+        super
+      end
+
+      def reset_mailer
+        Delayed::Job.work_off
+        super
+      end
+
+      def mailbox_for(address)
+        Delayed::Job.work_off
+        super
+      end
+    end
+
+    module Compatibility
+      if defined?(Delayed)
+        include EmailSpec::BackgroundProcesses::DelayedJob
+      end
+    end
+  end
+end

data/lib/email_spec/cucumber.rb

@@ -1,12 +1,14 @@
 # require this in your env.rb file after you require cucumber/rails/world
 
 # Global Setup
-ActionMailer::Base.delivery_method = :test unless ActionMailer::Base.delivery_method == :activerecord
-ActionMailer::Base.perform_deliveries = true
+if defined?(ActionMailer)
+  ActionMailer::Base.delivery_method = :test unless ActionMailer::Base.delivery_method == :activerecord
+  ActionMailer::Base.perform_deliveries = true
 
-Before do
-  # Scenario setup
-  ActionMailer::Base.deliveries.clear if ActionMailer::Base.delivery_method == :test
+  Before do
+    # Scenario setup
+    ActionMailer::Base.deliveries.clear if ActionMailer::Base.delivery_method == :test
+  end
 end
 
 After do

data/lib/email_spec/deliveries.rb

@@ -1,19 +1,19 @@
 module EmailSpec
-  module TestDeliveries
+  module MailerDeliveries
     def all_emails
-      ActionMailer::Base.deliveries
+      mailer.deliveries
     end
 
     def last_email_sent
-      ActionMailer::Base.deliveries.last || raise("No email has been sent!")
+      mailer.deliveries.last || raise("No email has been sent!")
     end
 
     def reset_mailer
-      ActionMailer::Base.deliveries.clear
+      mailer.deliveries.clear
     end
 
     def mailbox_for(address)
-      ActionMailer::Base.deliveries.select { |m| m.to.include?(address) || (m.bcc && m.bcc.include?(address)) || (m.cc && m.cc.include?(address)) }
+      mailer.deliveries.select { |m| m.to.include?(address) || (m.bcc && m.bcc.include?(address)) || (m.cc && m.cc.include?(address)) }
     end
   end
 
@@ -43,12 +43,29 @@ module EmailSpec
     end
   end
 
+  if defined?(Pony)
+    module ::Pony
+      def self.deliveries
+        @deliveries ||= []
+      end
+
+      def self.mail(options)
+        deliveries << build_tmail(options)
+      end
+    end
+  end
+
   module Deliveries
-    if ActionMailer::Base.delivery_method == :activerecord
+    if defined?(Pony)
+      def mailer; Pony; end
+      include EmailSpec::MailerDeliveries
+    elsif ActionMailer::Base.delivery_method == :activerecord
       include EmailSpec::ARMailerDeliveries
     else
-      include EmailSpec::TestDeliveries
+      def mailer; ActionMailer::Base; end
+      include EmailSpec::MailerDeliveries
     end
+    include EmailSpec::BackgroundProcesses::Compatibility
   end
 end
 

data/lib/email_spec/matchers.rb

@@ -23,7 +23,7 @@ module EmailSpec
       end
 
       def failure_message
-        "expected #{@email.inspect} to deliver to #{@expected_email_addresses.inspect}, but it delievered to #{@actual_recipients.inspect}"
+        "expected #{@email.inspect} to deliver to #{@expected_email_addresses.inspect}, but it delivered to #{@actual_recipients.inspect}"
       end
 
       def negative_failure_message
@@ -37,6 +37,37 @@ module EmailSpec
 
     alias :be_delivered_to :deliver_to
 
+    class DeliverFrom
+
+      def initialize(email)
+        @expected_email_addresses = email
+      end
+
+      def description
+        "be delivered from #{@expected_email_addresses.inspect}"
+      end
+
+      def matches?(email)
+        @email = email
+        @actual_sender = (email.from || []).first
+        @actual_sender.eql? @expected_email_addresses
+      end
+
+      def failure_message
+        "expected #{@email.inspect} to deliver from #{@expected_email_addresses.inspect}, but it delivered from #{@actual_sender.inspect}"
+      end
+
+      def negative_failure_message
+        "expected #{@email.inspect} not to deliver from #{@expected_email_addresses.inspect}, but it did"
+      end
+    end
+
+    def deliver_from(email)
+      DeliverFrom.new(email)
+    end
+
+    alias :be_delivered_from :deliver_from
+
     class BccTo
 
       def initialize(expected_email_addresses_or_objects_that_respond_to_email)

data/rails_generators/email_spec/templates/email_steps.rb

@@ -58,7 +58,7 @@ end
 
 # DEPRECATED
 # The following methods are left in for backwards compatibility and
-# should be removed by version 0.3.5.
+# should be removed by version 0.4.0
 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."
@@ -96,7 +96,7 @@ end
 
 # DEPRECATED
 # The following methods are left in for backwards compatibility and
-# should be removed by version 0.3.5.
+# should be removed by version 0.4.0.
 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."

data/spec/email_spec/matchers_spec.rb

@@ -45,7 +45,6 @@ describe EmailSpec::Matchers do
   end
 
   describe "#deliver_to" do
-
     it "should match when the email is set to deliver to the specidied address" do
       email = mock_email(:to => "jimmy_bean@yahoo.com")
 
@@ -72,6 +71,31 @@ describe EmailSpec::Matchers do
       deliver_to(user).should match(email)
     end
 
+    it "should give correct failure message when the email is not set to deliver to the specified address" do
+      matcher = deliver_to("jimmy_bean@yahoo.com")
+      matcher.matches?(mock_email(:inspect => 'email', :to => 'freddy_noe@yahoo.com'))
+      matcher.failure_message.should == %{expected email to deliver to ["jimmy_bean@yahoo.com"], but it delivered to ["freddy_noe@yahoo.com"]}
+    end
+
+  end
+
+  describe "#deliver_from" do
+    it "should match when the email is set to deliver from the specidied address" do
+      email = mock_email(:from => ["jimmy_bean@yahoo.com"])
+      deliver_from("jimmy_bean@yahoo.com").should match(email)
+    end
+
+    it "should not match when the email is not set to deliver from the specified address" do
+      email = mock_email(:from => nil)
+      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 => ['freddy_noe@yahoo.com']))
+      matcher.failure_message.should == %{expected email to deliver from "jimmy_bean@yahoo.com", but it delivered from "freddy_noe@yahoo.com"}
+    end
+
   end
 
   describe "#bcc_to" do
@@ -182,7 +206,7 @@ describe EmailSpec::Matchers do
   describe "#have_body_text" do
     it "should have specs!"
   end
-  
+
   describe "#have_header" do
     it "should have specs!"
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: email_spec
 version: !ruby/object:Gem::Version 
-  version: 0.3.1
+  version: 0.3.5
 platform: ruby
 authors: 
 - Ben Mabey
@@ -11,7 +11,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-08-19 00:00:00 -06:00
+date: 2009-10-08 00:00:00 -06:00
 default_executable: 
 dependencies: []
 
@@ -33,6 +33,7 @@ files:
 - lib/email-spec.rb
 - lib/email_spec.rb
 - lib/email_spec/address_converter.rb
+- lib/email_spec/background_processes.rb
 - lib/email_spec/cucumber.rb
 - lib/email_spec/deliveries.rb
 - lib/email_spec/email_viewer.rb
@@ -78,9 +79,11 @@ test_files:
 - examples/rails_root/app/helpers/welcome_helper.rb
 - examples/rails_root/app/models/user.rb
 - examples/rails_root/app/models/user_mailer.rb
+- examples/rails_root/app/views/user_mailer/newsletter.erb
 - examples/rails_root/app/views/user_mailer/signup.erb
 - examples/rails_root/app/views/welcome/confirm.html.erb
 - examples/rails_root/app/views/welcome/index.html.erb
+- examples/rails_root/app/views/welcome/newsletter.html.erb
 - examples/rails_root/app/views/welcome/signup.html.erb
 - examples/rails_root/config/boot.rb
 - examples/rails_root/config/database.yml
@@ -93,11 +96,12 @@ test_files:
 - examples/rails_root/config/initializers/new_rails_defaults.rb
 - examples/rails_root/config/routes.rb
 - examples/rails_root/db/migrate/20090125013728_create_users.rb
+- examples/rails_root/db/migrate/20090908054656_create_delayed_jobs.rb
 - examples/rails_root/db/schema.rb
 - examples/rails_root/doc/README_FOR_APP
+- examples/rails_root/features/delayed_job.feature
 - examples/rails_root/features/errors.feature
 - examples/rails_root/features/example.feature
-- 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/env.rb
@@ -120,6 +124,7 @@ test_files:
 - examples/rails_root/script/console
 - examples/rails_root/script/cucumber
 - examples/rails_root/script/dbconsole
+- examples/rails_root/script/delayed_job
 - examples/rails_root/script/destroy
 - examples/rails_root/script/generate
 - examples/rails_root/script/performance/benchmarker
@@ -140,7 +145,11 @@ test_files:
 - examples/rails_root/spec/rcov.opts
 - examples/rails_root/spec/spec.opts
 - examples/rails_root/spec/spec_helper.rb
-- examples/rails_root/stories/all.rb
-- examples/rails_root/stories/helper.rb
-- examples/rails_root/vendor/plugins/email_spec/rails_generators/email_spec/email_spec_generator.rb
-- examples/rails_root/vendor/plugins/email_spec/rails_generators/email_spec/templates/email_steps.rb
+- 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/webrat_steps.rb
+- examples/sinatra/features/support/env.rb
+- examples/sinatra/features/support/paths.rb

data/examples/rails_root/stories/all.rb

@@ -1,4 +0,0 @@
-dir = File.dirname(__FILE__)
-Dir[File.expand_path("#{dir}/**/*.rb")].uniq.each do |file|
-  require file
-end

data/examples/rails_root/stories/helper.rb

@@ -1,3 +0,0 @@
-ENV["RAILS_ENV"] = "test"
-require File.expand_path(File.dirname(__FILE__) + "/../config/environment")
-require 'spec/rails/story_adapter'

data/examples/rails_root/vendor/plugins/email_spec/rails_generators/email_spec/email_spec_generator.rb

@@ -1,17 +0,0 @@
-# This generator adds email steps to the step definitions directory 
-generator_base = defined?(Rails) ? Rails::Generator::Base : RubiGen::Base
-class EmailSpecGenerator < generator_base
-  def manifest
-    record do |m|
-      m.directory 'features/step_definitions'
-      m.file      'email_steps.rb', 'features/step_definitions/email_steps.rb'
-    end
-  end
-
-protected
-
-  def banner
-    "Usage: #{$0} email_spec"
-  end
-
-end

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

@@ -1,122 +0,0 @@
-# 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
-
-# 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
-
-#
-# 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(Regexp.new(text))
-end
-
-Then /^(?:I|they) should see "([^"]*?)" in the email body$/ do |text|
-  current_email.body.should =~ Regexp.new(text)
-end
-
-# 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
-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
-
-#
-# 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
-