email_spec 0.3.5 → 0.3.6

data/History.txt

@@ -1,8 +1,15 @@
 (In Git)
 
  === New features
+
  === Bufixes
 
+== 0.3.6 2009-12-16
+
+ === New features
+ * Cucumber steps for be_delivered_from, have_header matchers. (Joseph Holsten)
+ * Explicit regular expression steps. i.e. "I should see /foo/ in the email body" (Joseph Holsten)
+
 == 0.3.5 2009-09-30 The Pony Release!
 
  === New features

data/README.rdoc

@@ -8,11 +8,11 @@ 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
+   
+  gem install email_spec
 
   # config/environments/test.rb
-  config.gem 'bmabey-email_spec', :lib => 'email_spec'
+  config.gem 'email_spec', :lib => 'email_spec'
 
 === Cucumber
 
@@ -32,20 +32,20 @@ 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"
 
-  You will then need to include EmailSpec::Helpers and EmailSpec::Matchers in your example groups.
-  If you want to have access to the helpers and matchers in all of your examples you can do the following in your spec_helper.rb:
+You will then need to include EmailSpec::Helpers and EmailSpec::Matchers in your example groups.
+If you want to have access to the helpers and matchers in all of your examples you can do the following in your spec_helper.rb:
 
   Spec::Runner.configure do |config|
     config.include(EmailSpec::Helpers)
     config.include(EmailSpec::Matchers)
   end
 
-  Otherwise, you will need to include them in the example groups you wish to use them:
+Otherwise, you will need to include them in the example groups you wish to use them:
 
   describe "Signup Email" do
     include EmailSpec::Helpers
@@ -71,52 +71,52 @@ For more examples, check out examples/rails_root in the source for a small examp
 
 === RSpec
 
-  ==== Testing In Isolation ====
-    It is often useful to test your mailers in isolation.  You can accomplish this by using mocks to verify that the mailer is being called in the correct place and then write focued examples for the actual mailer.  This is a simple example from the sample app found in the gem:
-
-    Verify that the mailer is used correctly in the controller (this would apply to a model as well):
+==== Testing In Isolation
+It is often useful to test your mailers in isolation.  You can accomplish this by using mocks to verify that the mailer is being called in the correct place and then write focued examples for the actual mailer.  This is a simple example from the sample app found in the gem:
 
-     describe "POST /signup (#signup)" do
-        it "should deliver the signup email" do
-          # expect
-          UserMailer.should_receive(:deliver_signup).with("email@example.com", "Jimmy Bean")
-          # when
-          post :signup, "Email" => "email@example.com", "Name" => "Jimmy Bean"
-        end
-      end
+Verify that the mailer is used correctly in the controller (this would apply to a model as well):
 
-    Examples for the #signup method in UserMailer:
+  describe "POST /signup (#signup)" do
+    it "should deliver the signup email" do
+      # expect
+      UserMailer.should_receive(:deliver_signup).with("email@example.com", "Jimmy Bean")
+      # when
+      post :signup, "Email" => "email@example.com", "Name" => "Jimmy Bean"
+    end
+  end
 
-    describe "Signup Email" do
-      include EmailSpec::Helpers
-      include EmailSpec::Matchers
-      include ActionController::UrlWriter
+Examples for the #signup method in UserMailer:
 
-      before(:all) do
-        @email = UserMailer.create_signup("jojo@yahoo.com", "Jojo Binks")
-      end
+  describe "Signup Email" do
+    include EmailSpec::Helpers
+    include EmailSpec::Matchers
+    include ActionController::UrlWriter
 
-      it "should be set to be delivered to the email passed in" do
-        @email.should deliver_to("jojo@yahoo.com")
-      end
+    before(:all) do
+      @email = UserMailer.create_signup("jojo@yahoo.com", "Jojo Binks")
+    end
 
-      it "should contain the user's message in the mail body" do
-        @email.should have_text(/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 a link to the confirmation link" do
-        @email.should have_text(/#{confirm_account_url}/)
-      end
+    it "should contain the user's message in the mail body" do
+      @email.should have_text(/Jojo Binks/)
+    end
 
-      it "should have the correct subject" do
-        @email.should have_subject(/Account confirmation/)
-      end
+    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
 
-    ==== Using the helpers when not testing in isolation ====
+  end
+
+==== 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.
+Don't. :)  Seriously, if you do just take a look at the helpers and use them as you wish.
 
 == Original Authors
 

data/rails_generators/email_spec/templates/email_steps.rb

@@ -87,13 +87,34 @@ end
 #
 
 Then /^(?:I|they) should see "([^"]*?)" in the email subject$/ do |text|
+  current_email.should have_subject(text)
+end
+
+Then /^(?:I|they) should see \/([^"]*?)\/ in the email subject$/ do |text|
   current_email.should have_subject(Regexp.new(text))
 end
 
 Then /^(?:I|they) should see "([^"]*?)" in the email body$/ do |text|
+  current_email.body.should include(text)
+end
+
+Then /^(?:I|they) should see \/([^"]*?)\/ in the email body$/ do |text|
   current_email.body.should =~ Regexp.new(text)
 end
 
+Then /^(?:I|they) should see the email delivered from "([^"]*?)"$/ do |text|
+  current_email.should be_delivered_from(text)
+end
+
+Then /^(?:I|they) should see "([^\"]*)" in the email "([^"]*?)" header$/ do |text, name|
+  current_email.should have_header(name, text)
+end
+
+Then /^(?:I|they) should see \/([^\"]*)\/ in the email "([^"]*?)" header$/ do |text, name|
+  current_email.should have_header(name, Regexp.new(text))
+end
+
+
 # DEPRECATED
 # The following methods are left in for backwards compatibility and
 # should be removed by version 0.4.0.

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: email_spec
 version: !ruby/object:Gem::Version 
-  version: 0.3.5
+  version: 0.3.6
 platform: ruby
 authors: 
 - Ben Mabey
@@ -11,7 +11,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-10-08 00:00:00 -06:00
+date: 2009-12-16 00:00:00 -07:00
 default_executable: 
 dependencies: []
 
@@ -65,7 +65,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: email-spec
-rubygems_version: 1.3.3
+rubygems_version: 1.3.5
 signing_key: 
 specification_version: 3
 summary: Easily test email in rspec and cucumber
@@ -148,7 +148,6 @@ test_files:
 - examples/sinatra/app.rb
 - examples/sinatra/features/errors.feature
 - examples/sinatra/features/example.feature
-- examples/sinatra/features/step_definitions/email_steps.rb
 - examples/sinatra/features/step_definitions/user_steps.rb
 - examples/sinatra/features/step_definitions/webrat_steps.rb
 - examples/sinatra/features/support/env.rb

data/examples/sinatra/features/step_definitions/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.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."
-  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.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."
-  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
-