bmabey-email_spec 0.3.0 → 0.3.1

data/History.txt

@@ -3,14 +3,24 @@
  === New features
  === Bufixes
 
+ == 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.
+
+Big shoutout to Kieran Pilkington who did the majority of work for this release.
+
  == 0.3.0 2009-08-13
 
  === New features
   * New helper #last_email_address which returns the last address used by email-spec for that scenario. (Ben Mabey)
   * Steps now support third person language. (Kieran P)
-  * "[email] should receive ... " now supports "an" instead of just an integer. (Kieran P)
+  * "[email] should receive ... " now supports "an" instead of just an integer. (Kieran Pilkington)
     With these changes, the following is now possible:
-    
+
       Then "jack@example.com" should receive an email
       When they open the email
       Then they should see "Account has been created" in the subject

data/Rakefile

@@ -14,7 +14,8 @@ begin
     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["rails_generators/**/*"] + Dir["spec/**/*"] + Dir["examples/**/*"]
+    s.files        = %w(History.txt install.rb MIT-LICENSE.txt README.rdoc Rakefile) + Dir["lib/**/*"] + Dir["rails_generators/**/*"]
+    s.test_files   = Dir["spec/**/*"] + Dir["examples/**/*"]
     # rdoc
     s.has_rdoc         = true
     s.extra_rdoc_files = %w(README.rdoc MIT-LICENSE.txt)
@@ -24,6 +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`
+end
+
 begin
   require 'cucumber/rake/task'
   Cucumber::Rake::Task.new(:features)
@@ -51,8 +60,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/app/models/user_mailer.rb

@@ -1,6 +1,5 @@
 class UserMailer < ActionMailer::Base
-  default_url_options[:host] = ''
-
+  default_url_options = {:host => 'example.com'}
   def signup(email, name)
     @recipients  = email
     @from        = "admin@example.com"

data/examples/rails_root/config/boot.rb

@@ -44,6 +44,7 @@ module Rails
     def load_initializer
       require "#{RAILS_ROOT}/vendor/rails/railties/lib/initializer"
       Rails::Initializer.run(:install_gem_spec_stubs)
+      Rails::GemDependency.add_frozen_gem_path
     end
   end
 

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.2.2' unless defined? RAILS_GEM_VERSION
+RAILS_GEM_VERSION = '2.3.3' unless defined? RAILS_GEM_VERSION
 
 # Bootstrap the Rails environment, frameworks, and default configuration
 require File.join(File.dirname(__FILE__), 'boot')
@@ -13,7 +13,7 @@ require File.join(File.dirname(__FILE__), 'boot')
 Rails::Initializer.run do |config|
 
   config.time_zone = 'UTC'
- 
+
   config.action_controller.session = {
     :session_key => '_es_session',
     :secret      => 'b9327c7967925fb36f8901e43f47e0a3e8fc7856ae1b4533ddeda776381548f9ac051721446fdbc4ccc88c7353124708e73d8b0950a30487571d8f8eb5b24732'

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

@@ -20,14 +20,10 @@ config.action_controller.allow_forgery_protection    = false
 # The :test delivery method accumulates sent emails in the
 # ActionMailer::Base.deliveries array.
 config.action_mailer.delivery_method = :test
+config.action_mailer.default_url_options = { :host => "example.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
-
-
-
+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'

data/examples/rails_root/features/errors.feature

@@ -1,42 +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
-
-    Scenario: I fail to receive an email
-      Given I am at "/"
-      And no emails have been sent
-      When I fill in "Email" with "example@example.com"
-      And I press "Sign up"
-      And I should receive an email
-      When "example@example.com" opens the email with subject "no email"
-
-    Scenario: I fail to receive an email with the expected link
-      Given I am at "/"
-      And no emails have been sent
-      When I fill in "Email" with "example@example.com"
-      And I press "Sign up"
-      And 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
-      Given I am at "/"
-      And no emails have been sent
-      When I fill in "Email" with "example@example.com"
-      And I press "Sign up"
-      And I should receive an email
-      When I follow "confirm" in the email
-
-    Scenario: I attempt to check out an unopened email
-      Given I am at "/"
-      And no emails have been sent
-      When I fill in "Email" with "example@example.com"
-      And I press "Sign up"
-      Then I should see "confirm" in the email
-      And I should see "Account confirmation" in the subject
-
-
-
+  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/rails_root/features/example.feature

@@ -1,59 +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 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
+  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 "/"
+  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
 
-    When I fill in "Email" with "example@example.com"
-    And I fill in "Name" with "example Jones"
-    And I press "Sign up"
-
-    Then "example@example.com" should receive 1 email
-    And "example@example.com" should have 1 email
-    And "foo@bar.com" should not receive an email
+  Scenario: First person signup (as myself) with two ways of opening email
+    Then I should receive an email
+    And I should have 1 email
 
-    When "example@example.com" opens the email with subject "Account confirmation"
+    # 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
 
-    Then I should see "confirm" in the email
-    And I should see "example Jones" in the email
-    And I should see "Account confirmation" in the subject
+    # 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: 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 "example@example.com"
-    And I fill in "Name" with "example 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
+  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
 
-    When I follow "http:///confirm" in the email
-    Then I should see "Confirm your new account"
+    # 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
 
- Scenario: declarative
-    Given I am a real person wanting to sign up for an account
-    And I'm on the signup page
+    When they follow "Click here to confirm your account!" in the email
+    Then they should see "Confirm your new account"
 
-    When I submit my registration information
+  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/features/step_definitions/user_steps.rb

@@ -3,21 +3,24 @@ Given "I am a real person wanting to sign up for an account" do
 end
 
 When /^I submit my registration information$/ do
-  fill_in "Name", :with => valid_user_attributes[:name]
-  fill_in "Email", :with => valid_user_attributes[:email]
+  fill_in "Name", :with => 'Joe Someone'
+  fill_in "Email", :with => 'example@example.com'
   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 
-  
+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(valid_user_attributes[:email])
+  open_last_email_for(last_email_address)
   current_email.should have_subject(/Account confirmation/)
-  current_email.should have_body_text(valid_user_attributes[:name])
+  current_email.should have_body_text('Joe Someone')
 
   click_email_link_matching /confirm/
   response.should include_text("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/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