mischa-email_spec 0.0.3 → 0.0.4

data/README.rdoc

@@ -9,10 +9,10 @@ A collection of RSpec matchers and Cucumber steps to make testing emails go smoo
 
 === Gem Setup  (may or may not work atm)
   
-  gem install mischa-email_spec
+  gem install bmabey-email_spec
 
   # config/environments/test.rb
-  config.gem 'email_spec'
+  config.gem 'bmabey-email_spec', :lib => 'email_spec'
   
 === Cucumber
 
@@ -21,6 +21,12 @@ 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'
 
+Then:
+
+  script/generate email_spec
+
+This will give you a bunch of steps to get started with in step_definitions/email_steps.rb
+
 === RSpec
 	
 The matchers and helpers should be available for your specs by default, but you need to include them into the example groups you want to use them in.  To include them in all of your specs you can do this in your spec_helper.rb:
@@ -36,21 +42,16 @@ The matchers and helpers should be available for your specs by default, but you
 
   Scenario: A new person signs up
       Given I am at "/"
-      And a clear email queue
+      And no emails have been sent
       When I fill in "Email" with "quentin@example.com"
-      And I fill in "Password" with "monkey"
-      And I fill in "Password confirmation" with "monkey"
       And I press "Sign up"
-      Then "quentin@example.com" should receive 1 email
-      And "quentin@example.com" should have 1 email
-      And "foo@bar.com" should not receive an email
+      And I should receive an email
       When I open the email
       Then I should see "confirm" in the email
-      And I should see "Account confirmation" in the subject
       When I follow "confirm" in the email
       Then I should see "Confirm your new account"
 
-Check out an app that implements these features at http://github.com/bmabey/email-spec-sample-app
+For more examples, check out spec/rails_root in the source for a small example app that implements these steps.
 
 == TODO:
 

data/Rakefile

@@ -12,7 +12,7 @@ spec = Gem::Specification.new do |s|
   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["generators/**/*"]
+  s.files        = %w(History.txt install.rb MIT-LICENSE.txt README.rdoc Rakefile) + Dir["lib/**/*"] + Dir["generators/**/*"] + Dir["spec/**/*"]
   # rdoc
   s.has_rdoc         = true
   s.extra_rdoc_files = %w(README.rdoc MIT-LICENSE.txt)

data/generators/email_spec/templates/email_steps.rb

@@ -1,5 +1,22 @@
 #Commonly used email steps
+#
+# To add your own steps make a custom_email_steps.rb
+# The provided methods are:
+#
+# reset_mailer 
+# open_last_email
+# visit_in_email
+# unread_emails_for
+# mailbox_for
+# current_email
+# open_email
+# read_emails_for
+# find_email
 
+
+def current_email_address
+  "quentin@example.com" # Replace with your a way to find your current_email. e.g current_user.email
+end
 # Use this step to 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
@@ -8,37 +25,44 @@ end
 
 # Use this step to open the most recently sent e-mail. 
 When /^I open the email$/ do
-  open_last_email
+  open_email(current_email_address)
 end
 
 When /^I follow "(.*)" in the email$/ do |link|
   visit_in_email(link)
 end
 
-Then /^"([^']*?)" should receive (\d+) emails?$/ do |email, n|
-  unread_emails_for(email).size.should == n.to_i 
+Then /^I should receive (.*) emails?$/ do |amount|
+  amount = 1 if amount == "an"
+  unread_emails_for(current_email_address).size.should == amount
 end
 
-Then /^I should receive (\d+) emails?$/ do |n|
-  unread_emails_for(current_email).size.should == n.to_i
+Then /^"([^']*?)" should receive (\d+) emails?$/ do |address, n|
+  unread_emails_for(address).size.should == n.to_i 
 end
 
-Then /^"([^']*?)" should have (\d+) emails?$/ do |email, n|
-  mailbox_for(email).size.should == n.to_i
+Then /^"([^']*?)" should have (\d+) emails?$/ do |address, n|
+  mailbox_for(address).size.should == n.to_i
 end
 
-Then /^"([^']*?)" should not receive an email$/ do |email|
-  open_email(email).should be_nil
+Then /^"([^']*?)" should not receive an email$/ do |address|
+  find_email(address).should be_nil
 end
 
 Then /^I should see "(.*)" in the subject$/ do |text|
-#  raise ArgumentError, "To check the subject, you must first open an e-mail" if current_email.nil?
-#  current_email.should_not be_nil
   current_email.subject.should =~ Regexp.new(text)
 end
 
 Then /^I should see "(.*)" in the email$/ do |text|
-#  current_email.should_not be_nil
   current_email.body.should =~ Regexp.new(text)
 end
 
+When %r{^"([^']*?)" opens? the email with subject "([^']*?)"$} do |address, subject|
+  open_email(address, :with_subject => subject)
+end
+
+When %r{^"([^']*?)" opens? the email with text "([^']*?)"$} do |address, text|
+  open_email(address, :with_text => text)
+end
+
+

data/lib/email_spec/email_spec_helpers.rb

@@ -22,55 +22,74 @@ module EmailSpec
       visit(parse_email_for_link(current_email, link_text))
     end
     
-    def open_email(email_address, opts={})
-      if opts[:with_subject]
-        email = mailbox_for(email_address).find { |m| m.subject =~ Regexp.new(opts[:with_subject]) }
-      elsif opts[:with_text]
-        email = mailbox_for(email_address).find { |m| m.body =~ Regexp.new(opts[:with_text]) }
-      else
-        email = mailbox_for(email_address).first
-      end
-            
-      read_emails_for(email_address) << email if email
-      @email_spec_hash[:current_emails][email_address] = email
-      @email_spec_hash[:current_email] = email
+    def open_email(address, opts={})
+      email = find_email!(address, opts) 
+      email.should_not be_nil
+      set_current_email(email)
     end
 
     def open_last_email
       email = ActionMailer::Base.deliveries.last
-      raise "Last email was nil" unless email #TODO: fix
-      read_emails_for(email.to) << email if email
-      @email_spec_hash[:current_emails][email.to] = email
-      @email_spec_hash[:current_email] = email
+      email.should_not be_nil
+      set_current_email(email)
+    end
+    
+    def current_email(address=nil)
+      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  
+      email
     end
     
-    def current_email(email_address=nil)
-      email_address ? @email_spec_hash[:current_emails][email_address] : @email_spec_hash[:current_email]
+    def unread_emails_for(address)
+      mailbox_for(address) - read_emails_for(address)
     end
     
-    def unread_emails_for(email_address)
-      mailbox_for(email_address) - read_emails_for(email_address)
+    def read_emails_for(address)
+      @email_spec_hash[:read_emails][address] ||= []
     end
     
-    def read_emails_for(email_address)
-      @email_spec_hash[:read_emails][email_address] ||= []
+    def mailbox_for(address)
+      ActionMailer::Base.deliveries.select { |m| m.to.include?(address) }
     end
     
-    def mailbox_for(email)
-      ActionMailer::Base.deliveries.select { |m| m.to.include?(email) }
+    def find_email(address, opts={})
+     if opts[:with_subject]
+        email = 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]) }
+      else
+        email = mailbox_for(address).first
+      end
+    end
+
+    private
+	
+    def find_email!(address, opts={})
+      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?}"
+	raise Spec::Expectations::ExpectationNotMetError, "Could not find email #{error}. \n Found the following emails:\n\n #{ActionMailer::Base.deliveries.to_s}"
+       end
+      email
+    end
+
+    def set_current_email(email)
+      return unless email
+      read_emails_for(email.to) << email      
+      @email_spec_hash[:current_emails][email.to] = email
+      @email_spec_hash[:current_email] = email
     end
     
-    def parse_email_for_link(mail, link_text)
-      if mail.body.include?(link_text)
-        if link_text =~ %r{^/.*$}
-          # if it's an explicit link
-          link_text
-        elsif mail.body =~ %r{<a[^>]*href=['"]?([^'"]*)['"]?[^>]*?>[^<]*?#{link_text}[^<]*?</a>}
-          # if it's an anchor tag
-          URI.split($~[1])[5..-1].compact!.join("?").gsub("&amp;", "&")
-	  # sub correct ampersand after rails switches it (http://dev.rubyonrails.org/ticket/4002) 
-	  # TODO: outsource this kind of parsing to webrat or someone else
-        end
+    def parse_email_for_link(email, link_text)
+      email.body.should include_text(link_text)
+      if link_text =~ %r{^/.*$}
+	# if it's an explicit link
+	link_text
+      elsif email.body =~ %r{<a[^>]*href=['"]?([^'"]*)['"]?[^>]*?>[^<]*?#{link_text}[^<]*?</a>}
+	# if it's an anchor tag
+	URI.split($~[1])[5..-1].compact!.join("?").gsub("&amp;", "&")
+	# sub correct ampersand after rails switches it (http://dev.rubyonrails.org/ticket/4002) 
+	# TODO: outsource this kind of parsing to webrat or someone else
       end
     end
   end

data/lib/email_spec.rb

@@ -1,3 +1,3 @@
 module EmailSpec
-  VERSION = '0.0.3'
+  VERSION = '0.0.4'
 end

data/spec/email_spec_helpers_spec.rb

@@ -0,0 +1,28 @@
+# require File.dirname(__FILE__) + '/spec_helper'
+# 
+# module ActionMailer
+#   class Base
+#   end  
+# end
+# 
+# 
+# module EmailSpec
+#   describe Helpers do
+#     before(:all) do
+#       @helper = Object.new
+#       @helper.extend EmailSpec::Helpers
+#     end
+#     
+#     describe "#reset_mailer" do
+#       it "should empty the all email deliveries" do
+#         #given
+#         ActionMailer::Base.stub!(:deliveries).and_return([mock("some email", mock("another email"))])
+#         #when
+#         @helper.reset_mailer
+#         #then
+#         ActionMailer::Base.deliveries.should be_empty      
+#       end
+#     end
+#   end
+# end
+# 

data/spec/rails_root/Rakefile

@@ -0,0 +1,10 @@
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require(File.join(File.dirname(__FILE__), 'config', 'boot'))
+
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+
+require 'tasks/rails'

data/spec/rails_root/app/controllers/application.rb

@@ -0,0 +1,15 @@
+# Filters added to this controller apply to all controllers in the application.
+# Likewise, all the methods added will be available for all controllers.
+
+class ApplicationController < ActionController::Base
+  helper :all # include all helpers, all the time
+
+  # See ActionController::RequestForgeryProtection for details
+  # Uncomment the :secret if you're not using the cookie session store
+  protect_from_forgery # :secret => 'a74714b35b202f269f7a297709d555ce'
+  
+  # See ActionController::Base for details 
+  # Uncomment this to filter the contents of submitted sensitive data parameters
+  # from your application log (in this case, all fields with names like "password"). 
+  # filter_parameter_logging :password
+end

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

@@ -0,0 +1,9 @@
+class WelcomeController < ApplicationController
+  def signup
+    UserMailer.deliver_signup(params['Email'], params['Name'])
+  end
+
+  def confirm
+  end
+
+end

data/spec/rails_root/app/helpers/application_helper.rb

@@ -0,0 +1,3 @@
+# Methods added to this helper will be available to all templates in the application.
+module ApplicationHelper
+end

data/spec/rails_root/app/helpers/welcome_helper.rb

@@ -0,0 +1,2 @@
+module WelcomeHelper
+end

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

@@ -0,0 +1,12 @@
+class UserMailer < ActionMailer::Base
+  default_url_options[:host] = ''
+
+  def signup(email, name)
+    @recipients  = email
+    @from        = "admin@example.com"
+    @subject     = "Account confirmation"
+    @sent_on     = Time.now
+    @body[:name] = name
+  end
+
+end

data/spec/rails_root/app/views/user_mailer/signup.erb

@@ -0,0 +1,3 @@
+Hello <%= @name %>!
+
+<%= link_to "Click here to confirm your account!", confirm_account_url %>

data/spec/rails_root/app/views/welcome/confirm.html.erb

@@ -0,0 +1 @@
+Confirm your new account!

data/spec/rails_root/app/views/welcome/index.html.erb

@@ -0,0 +1,8 @@
+<% form_tag '/welcome/signup' do -%>
+    <label for="Name">Name</label>
+    <%= text_field_tag 'Name' %>
+    <label for="Email">Email</label>
+    <%= text_field_tag 'Email' %>
+    <div><%= submit_tag 'Sign up' %></div>
+<% end -%>
+

data/spec/rails_root/app/views/welcome/signup.html.erb

@@ -0,0 +1 @@
+Thanks!  Go check your email!

data/spec/rails_root/config/boot.rb

@@ -0,0 +1,109 @@
+# Don't change this file!
+# Configure your app in config/environment.rb and config/environments/*.rb
+
+RAILS_ROOT = "#{File.dirname(__FILE__)}/.." unless defined?(RAILS_ROOT)
+
+module Rails
+  class << self
+    def boot!
+      unless booted?
+        preinitialize
+        pick_boot.run
+      end
+    end
+
+    def booted?
+      defined? Rails::Initializer
+    end
+
+    def pick_boot
+      (vendor_rails? ? VendorBoot : GemBoot).new
+    end
+
+    def vendor_rails?
+      File.exist?("#{RAILS_ROOT}/vendor/rails")
+    end
+
+    def preinitialize
+      load(preinitializer_path) if File.exist?(preinitializer_path)
+    end
+
+    def preinitializer_path
+      "#{RAILS_ROOT}/config/preinitializer.rb"
+    end
+  end
+
+  class Boot
+    def run
+      load_initializer
+      Rails::Initializer.run(:set_load_path)
+    end
+  end
+
+  class VendorBoot < Boot
+    def load_initializer
+      require "#{RAILS_ROOT}/vendor/rails/railties/lib/initializer"
+      Rails::Initializer.run(:install_gem_spec_stubs)
+    end
+  end
+
+  class GemBoot < Boot
+    def load_initializer
+      self.class.load_rubygems
+      load_rails_gem
+      require 'initializer'
+    end
+
+    def load_rails_gem
+      if version = self.class.gem_version
+        gem 'rails', version
+      else
+        gem 'rails'
+      end
+    rescue Gem::LoadError => load_error
+      $stderr.puts %(Missing the Rails #{version} gem. Please `gem install -v=#{version} rails`, update your RAILS_GEM_VERSION setting in config/environment.rb for the Rails version you do have installed, or comment out RAILS_GEM_VERSION to use the latest version installed.)
+      exit 1
+    end
+
+    class << self
+      def rubygems_version
+        Gem::RubyGemsVersion rescue nil
+      end
+
+      def gem_version
+        if defined? RAILS_GEM_VERSION
+          RAILS_GEM_VERSION
+        elsif ENV.include?('RAILS_GEM_VERSION')
+          ENV['RAILS_GEM_VERSION']
+        else
+          parse_gem_version(read_environment_rb)
+        end
+      end
+
+      def load_rubygems
+        require 'rubygems'
+        min_version = '1.3.1'
+        unless rubygems_version >= min_version
+          $stderr.puts %Q(Rails requires RubyGems >= #{min_version} (you have #{rubygems_version}). Please `gem update --system` and try again.)
+          exit 1
+        end
+
+      rescue LoadError
+        $stderr.puts %Q(Rails requires RubyGems >= #{min_version}. Please install RubyGems and try again: http://rubygems.rubyforge.org)
+        exit 1
+      end
+
+      def parse_gem_version(text)
+        $1 if text =~ /^[^#]*RAILS_GEM_VERSION\s*=\s*["']([!~<>=]*\s*[\d.]+)["']/
+      end
+
+      private
+        def read_environment_rb
+          File.read("#{RAILS_ROOT}/config/environment.rb")
+        end
+    end
+  end
+end
+
+# All that for this:
+Rails.boot!

data/spec/rails_root/config/database.yml

@@ -0,0 +1,22 @@
+# SQLite version 3.x
+#   gem install sqlite3-ruby (not necessary on OS X Leopard)
+development:
+  adapter: sqlite3
+  database: db/development.sqlite3
+  pool: 5
+  timeout: 5000
+
+# Warning: The database defined as "test" will be erased and
+# re-generated from your development database when you run "rake".
+# Do not set this db to the same as development or production.
+test:
+  adapter: sqlite3
+  database: db/test.sqlite3
+  pool: 5
+  timeout: 5000
+
+production:
+  adapter: sqlite3
+  database: db/production.sqlite3
+  pool: 5
+  timeout: 5000

data/spec/rails_root/config/environment.rb

@@ -0,0 +1,22 @@
+# Be sure to restart your server when you modify this file
+
+# Uncomment below to force Rails into production mode when
+# you don't control web/app server and can't set it the proper way
+# 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
+
+# Bootstrap the Rails environment, frameworks, and default configuration
+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'
+  }
+
+end

data/spec/rails_root/config/environments/development.rb

@@ -0,0 +1,17 @@
+# Settings specified here will take precedence over those in config/environment.rb
+
+# In the development environment your application's code is reloaded on
+# every request.  This slows down response time but is perfect for development
+# since you don't have to restart the webserver when you make code changes.
+config.cache_classes = false
+
+# Log error messages when you accidentally call methods on nil.
+config.whiny_nils = true
+
+# Show full error reports and disable caching
+config.action_controller.consider_all_requests_local = true
+config.action_view.debug_rjs                         = true
+config.action_controller.perform_caching             = false
+
+# Don't care if the mailer can't send
+config.action_mailer.raise_delivery_errors = false

data/spec/rails_root/config/environments/production.rb

@@ -0,0 +1,24 @@
+# Settings specified here will take precedence over those in config/environment.rb
+
+# The production environment is meant for finished, "live" apps.
+# Code is not reloaded between requests
+config.cache_classes = true
+
+# Enable threaded mode
+# config.threadsafe!
+
+# Use a different logger for distributed setups
+# config.logger = SyslogLogger.new
+
+# Full error reports are disabled and caching is turned on
+config.action_controller.consider_all_requests_local = false
+config.action_controller.perform_caching             = true
+
+# Use a different cache store in production
+# config.cache_store = :mem_cache_store
+
+# Enable serving of images, stylesheets, and javascripts from an asset server
+# config.action_controller.asset_host                  = "http://assets.example.com"
+
+# Disable delivery errors, bad email addresses will be ignored
+# config.action_mailer.raise_delivery_errors = false

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

@@ -0,0 +1,29 @@
+# Settings specified here will take precedence over those in config/environment.rb
+
+# The test environment is used exclusively to run your application's
+# test suite.  You never need to work with it otherwise.  Remember that
+# your test database is "scratch space" for the test suite and is wiped
+# and recreated between test runs.  Don't rely on the data there!
+config.cache_classes = true
+
+# Log error messages when you accidentally call methods on nil.
+config.whiny_nils = true
+
+# Show full error reports and disable caching
+config.action_controller.consider_all_requests_local = true
+config.action_controller.perform_caching             = false
+
+# Disable request forgery protection in test environment
+config.action_controller.allow_forgery_protection    = false
+
+# Tell Action Mailer not to deliver emails to the real world.
+# The :test delivery method accumulates sent emails in the
+# ActionMailer::Base.deliveries array.
+config.action_mailer.delivery_method = :test
+
+
+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"
+

data/spec/rails_root/config/initializers/inflections.rb

@@ -0,0 +1,10 @@
+# Be sure to restart your server when you modify this file.
+
+# Add new inflection rules using the following format 
+# (all these examples are active by default):
+# ActiveSupport::Inflector.inflections do |inflect|
+#   inflect.plural /^(ox)$/i, '\1en'
+#   inflect.singular /^(ox)en/i, '\1'
+#   inflect.irregular 'person', 'people'
+#   inflect.uncountable %w( fish sheep )
+# end

data/spec/rails_root/config/initializers/mime_types.rb

@@ -0,0 +1,5 @@
+# Be sure to restart your server when you modify this file.
+
+# Add new mime types for use in respond_to blocks:
+# Mime::Type.register "text/richtext", :rtf
+# Mime::Type.register_alias "text/html", :iphone

data/spec/rails_root/config/initializers/new_rails_defaults.rb

@@ -0,0 +1,17 @@
+# These settings change the behavior of Rails 2 apps and will be defaults
+# for Rails 3. You can remove this initializer when Rails 3 is released.
+
+if defined?(ActiveRecord)
+  # Include Active Record class name as root for JSON serialized output.
+  ActiveRecord::Base.include_root_in_json = true
+
+  # Store the full class name (including module namespace) in STI type column.
+  ActiveRecord::Base.store_full_sti_class = true
+end
+
+# Use ISO 8601 format for JSON serialized times and dates.
+ActiveSupport.use_standard_json_time_format = true
+
+# Don't escape HTML entities in JSON, leave that for the #json_escape helper.
+# if you're including raw json in an HTML page.
+ActiveSupport.escape_html_entities_in_json = false