email_spec 0.3.0 → 0.3.1

data/lib/email_spec/helpers.rb

@@ -5,29 +5,28 @@ module EmailSpec
 
   module Helpers
     include Deliveries
-    
+
     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={})
-      address = convert_address(address)
       set_current_email(find_email!(address, opts))
     end
-    
+
     alias_method :open_email_for, :open_email
 
     def open_last_email
@@ -35,38 +34,35 @@ module EmailSpec
     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  
+      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] ||= []
+      email_spec_hash[:read_emails][convert_address(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]) }
+      if opts[:with_subject]
+        mailbox_for(address).find { |m| m.subject =~ Regexp.new(opts[:with_subject]) }
       elsif opts[:with_text]
-        email = mailbox_for(address).find { |m| m.body =~ Regexp.new(opts[:with_text]) }
+        mailbox_for(address).find { |m| m.body =~ Regexp.new(opts[:with_text]) }
       else
-        email = mailbox_for(address).first
+        mailbox_for(address).first
       end
     end
-    
+
     def links_in_email(email)
       URI.extract(email.body, ['http', 'https'])
     end
@@ -78,7 +74,6 @@ module EmailSpec
     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?}"
@@ -90,43 +85,65 @@ module EmailSpec
     def set_current_email(email)
       return unless email
       email.to.each do |to|
-        read_emails_for(to) << email      
+        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, text_or_regex)
       email.should have_body_text(text_or_regex)
-      
-      url = parse_email_for_explicit_link(email, text_or_regex) 
+
+      url = parse_email_for_explicit_link(email, text_or_regex)
       url ||= parse_email_for_anchor_text_link(email, text_or_regex)
 
       raise "No link found matching #{text_or_regex.inspect} in #{email}" unless url
       url
     end
-    
+
     # e.g. confirm in http://confirm
     def parse_email_for_explicit_link(email, regex)
       regex = /#{Regexp.escape(regex)}/ unless regex.is_a?(Regexp)
       url = links_in_email(email).detect { |link| link =~ regex }
       URI::parse(url).request_uri if url
     end
-    
+
     # e.g. Click here in  <a href="http://confirm">Click here</a>
     def parse_email_for_anchor_text_link(email, link_text)
       email.body =~ %r{<a[^>]*href=['"]?([^'"]*)['"]?[^>]*?>[^<]*?#{link_text}[^<]*?</a>}
       URI.split($~[1])[5..-1].compact!.join("?").gsub("&amp;", "&")
-      # sub correct ampersand after rails switches it (http://dev.rubyonrails.org/ticket/4002) 
+      # sub correct ampersand after rails switches it (http://dev.rubyonrails.org/ticket/4002)
     end
 
+    def parse_email_count(amount)
+      case amount
+      when "no"
+        0
+      when "an"
+        1
+      else
+        amount.to_i
+      end
+    end
 
     attr_reader :last_email_address
-    
+
     def convert_address(address)
-      @last_email_address = address
-      AddressConverter.instance.convert(address)
+      @last_email_address = (address || current_email_address)
+      AddressConverter.instance.convert(@last_email_address)
+    end
+
+
+    def mailbox_for(address)
+      super(convert_address(address)) # super resides in Deliveries
     end
+
+    def email_spec_deprecate(text)
+      puts ""
+      puts "DEPRECATION: #{text.split.join(' ')}"
+      puts ""
+    end
+
   end
 end
 

data/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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: email_spec
 version: !ruby/object:Gem::Version 
-  version: 0.3.0
+  version: 0.3.1
 platform: ruby
 authors: 
 - Ben Mabey
@@ -11,7 +11,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-08-13 00:00:00 -06:00
+date: 2009-08-19 00:00:00 -06:00
 default_executable: 
 dependencies: []
 
@@ -29,78 +29,6 @@ files:
 - MIT-LICENSE.txt
 - README.rdoc
 - Rakefile
-- examples/rails_root/Rakefile
-- examples/rails_root/app/controllers/application.rb
-- examples/rails_root/app/controllers/welcome_controller.rb
-- examples/rails_root/app/helpers/application_helper.rb
-- 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/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/signup.html.erb
-- examples/rails_root/config/boot.rb
-- examples/rails_root/config/database.yml
-- examples/rails_root/config/environment.rb
-- examples/rails_root/config/environments/development.rb
-- examples/rails_root/config/environments/production.rb
-- examples/rails_root/config/environments/test.rb
-- examples/rails_root/config/initializers/inflections.rb
-- 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/migrate/20090125013728_create_users.rb
-- examples/rails_root/db/schema.rb
-- examples/rails_root/doc/README_FOR_APP
-- 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
-- examples/rails_root/public/404.html
-- examples/rails_root/public/422.html
-- examples/rails_root/public/500.html
-- examples/rails_root/public/dispatch.rb
-- examples/rails_root/public/favicon.ico
-- examples/rails_root/public/images/rails.png
-- examples/rails_root/public/javascripts/application.js
-- examples/rails_root/public/javascripts/controls.js
-- examples/rails_root/public/javascripts/dragdrop.js
-- examples/rails_root/public/javascripts/effects.js
-- examples/rails_root/public/javascripts/prototype.js
-- examples/rails_root/public/robots.txt
-- examples/rails_root/script/about
-- examples/rails_root/script/autospec
-- examples/rails_root/script/console
-- examples/rails_root/script/cucumber
-- examples/rails_root/script/dbconsole
-- examples/rails_root/script/destroy
-- examples/rails_root/script/generate
-- examples/rails_root/script/performance/benchmarker
-- examples/rails_root/script/performance/profiler
-- examples/rails_root/script/performance/request
-- examples/rails_root/script/plugin
-- examples/rails_root/script/process/inspector
-- examples/rails_root/script/process/reaper
-- examples/rails_root/script/process/spawner
-- examples/rails_root/script/runner
-- examples/rails_root/script/server
-- examples/rails_root/script/spec
-- examples/rails_root/script/spec_server
-- examples/rails_root/spec/controllers/welcome_controller_spec.rb
-- examples/rails_root/spec/model_factory.rb
-- 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
-- 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
 - install.rb
 - lib/email-spec.rb
 - lib/email_spec.rb
@@ -112,9 +40,6 @@ files:
 - lib/email_spec/matchers.rb
 - rails_generators/email_spec/email_spec_generator.rb
 - rails_generators/email_spec/templates/email_steps.rb
-- spec/email_spec/matchers_spec.rb
-- spec/spec.opts
-- spec/spec_helper.rb
 has_rdoc: true
 homepage: http://github.com/bmabey/email-spec/
 licenses: []
@@ -145,14 +70,20 @@ specification_version: 3
 summary: Easily test email in rspec and cucumber
 test_files: 
 - spec/email_spec/matchers_spec.rb
+- spec/spec.opts
 - spec/spec_helper.rb
-- examples/rails_root/app/controllers/application.rb
+- examples/rails_root/app/controllers/application_controller.rb
 - examples/rails_root/app/controllers/welcome_controller.rb
 - examples/rails_root/app/helpers/application_helper.rb
 - 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/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/signup.html.erb
 - examples/rails_root/config/boot.rb
+- examples/rails_root/config/database.yml
 - examples/rails_root/config/environment.rb
 - examples/rails_root/config/environments/development.rb
 - examples/rails_root/config/environments/production.rb
@@ -163,15 +94,51 @@ test_files:
 - examples/rails_root/config/routes.rb
 - examples/rails_root/db/migrate/20090125013728_create_users.rb
 - examples/rails_root/db/schema.rb
+- examples/rails_root/doc/README_FOR_APP
+- 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
+- examples/rails_root/features/support/paths.rb
+- examples/rails_root/public/404.html
+- examples/rails_root/public/422.html
+- examples/rails_root/public/500.html
 - examples/rails_root/public/dispatch.rb
+- examples/rails_root/public/favicon.ico
+- examples/rails_root/public/images/rails.png
+- examples/rails_root/public/javascripts/application.js
+- examples/rails_root/public/javascripts/controls.js
+- examples/rails_root/public/javascripts/dragdrop.js
+- examples/rails_root/public/javascripts/effects.js
+- examples/rails_root/public/javascripts/prototype.js
+- examples/rails_root/public/robots.txt
+- examples/rails_root/Rakefile
+- examples/rails_root/script/about
+- examples/rails_root/script/autospec
+- examples/rails_root/script/console
+- examples/rails_root/script/cucumber
+- examples/rails_root/script/dbconsole
+- examples/rails_root/script/destroy
+- examples/rails_root/script/generate
+- examples/rails_root/script/performance/benchmarker
+- examples/rails_root/script/performance/profiler
+- examples/rails_root/script/performance/request
+- examples/rails_root/script/plugin
+- examples/rails_root/script/process/inspector
+- examples/rails_root/script/process/reaper
+- examples/rails_root/script/process/spawner
+- examples/rails_root/script/runner
+- examples/rails_root/script/server
+- examples/rails_root/script/spec
+- examples/rails_root/script/spec_server
 - examples/rails_root/spec/controllers/welcome_controller_spec.rb
 - examples/rails_root/spec/model_factory.rb
 - 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
 - examples/rails_root/stories/all.rb
 - examples/rails_root/stories/helper.rb