bmabey-email_spec 0.0.5

data/History.txt

@@ -0,0 +1,4 @@
+== 0.0.1 2008-12-18
+
+* 1 major enhancement:
+  * Initial release

data/MIT-LICENSE.txt

@@ -0,0 +1,19 @@
+Copyright (c) 2007 Bryan Helmkamp, Seth Fitzsimmons
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,66 @@
+= Email Spec
+
+A collection of RSpec matchers and Cucumber steps to make testing emails go smoothly.
+
+
+== Setup
+
+  script/plugin install git://github.com/bmabey/email-spec.git
+
+=== Gem Setup  (may or may not work atm)
+  
+  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:
+
+  # 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. 
+It will also add a Before hook for Cucumber so that emails are cleared at the start of each scenario.
+
+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:
+
+  Spec::Runner.configure do |config|
+    config.include(EmailSpec::Helpers)
+    config.include(EmailSpec::Matchers)
+  end
+
+== Usage
+
+=== Cucumber
+
+  Scenario: A new person signs up
+      Given I am at "/"
+      When I fill in "Email" with "quentin@example.com"
+      And I press "Sign up"
+      And I should receive an email
+      When I open the email
+      Then I should see "confirm" in the email
+      When I follow "confirm" in the email
+      Then I should see "Confirm your new account"
+
+For more examples, check out spec/rails_root in the source for a small example app that implements these steps.
+
+== TODO:
+
+- refactor!
+- provide custom matchers to give better messages
+
+== Authors
+
+Ben Mabey, Aaron Gibralter, Mischa Fierer
+

data/Rakefile

@@ -0,0 +1,57 @@
+['rubygems',"rake/gempackagetask",'rake/rdoctask',"rake/clean",'spec', 'spec/rake/spectask', File.expand_path('./lib/email_spec.rb')].each {|file| require file}
+
+# package + maintenance stuff
+spec = Gem::Specification.new do |s|
+  s.name         = "email_spec"
+  s.version      = EmailSpec::VERSION
+  s.platform     = Gem::Platform::RUBY
+  s.authors      = ['Ben Mabrey', 'Aaron Gibralter', 'Mischa Fierer']
+  s.email        = "f.mischa@gmail.com"
+  s.homepage     = "http://github.com/bmabey/email-spec/"
+  s.summary      = "Easily test email in rspec and cucumber"
+  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/**/*"] + Dir["spec/**/*"]
+  # rdoc
+  s.has_rdoc         = true
+  s.extra_rdoc_files = %w(README.rdoc MIT-LICENSE.txt)
+end
+
+desc 'Show information about the gem.'
+task :debug_gem do
+  puts spec.to_ruby
+end
+
+task :gemspec do
+  system "rake debug_gem | grep -v \"(in \" > email-spec.gemspec"
+end
+
+Rake::GemPackageTask.new(spec) do |package|
+  package.gem_spec = spec
+end
+
+
+CLEAN.include ["pkg", "*.gem", "doc", "ri", "coverage", '**/.*.sw?', '*.gem', '.config', '**/.DS_Store', '**/*.class', '**/*.jar', '**/.*.swp' ]
+
+desc 'Install the package as a gem.'
+task :install_gem => [:clean, :package] do
+  gem = Dir['pkg/*.gem'].first
+  sh "sudo gem install --local #{gem}"
+end
+
+# Testing
+
+desc "Run the generator on the tests"
+task :generate do
+  system "mkdir -p spec/rails_root/vendor/plugins/email_spec"
+  system "cp -R generators spec/rails_root/vendor/plugins/email_spec"
+  system "cd spec/rails_root; ./script/generate email_spec"
+end
+
+task :features => [:generate] do
+  system("cd spec/rails_root; rake features; cd ../..")
+end
+
+task :default => :features
+

data/generators/email_spec/email_spec_generator.rb

@@ -0,0 +1,16 @@
+# This generator adds email steps to the step definitions directory 
+class EmailSpecGenerator < Rails::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/generators/email_spec/templates/email_steps.rb

@@ -0,0 +1,71 @@
+#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
+
+module EmailHelpers
+  def current_email_address
+    "quentin@example.com" # Replace with your a way to find your current_email. e.g current_user.email
+  end
+end
+World {|world| world.extend EmailHelpers }
+
+# 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
+  reset_mailer
+end
+
+# Use this step to open the most recently sent e-mail. 
+When /^I open the email$/ do
+  open_email(current_email_address)
+end
+
+When /^I follow "(.*)" in the email$/ do |link|
+  visit_in_email(link)
+end
+
+Then /^I should receive (.*) emails?$/ do |amount|
+  amount = 1 if amount == "an"
+  unread_emails_for(current_email_address).size.should == amount
+end
+
+Then /^"([^']*?)" should receive (\d+) emails?$/ do |address, n|
+  unread_emails_for(address).size.should == n.to_i 
+end
+
+Then /^"([^']*?)" should have (\d+) emails?$/ do |address, n|
+  mailbox_for(address).size.should == n.to_i
+end
+
+Then /^"([^']*?)" should not receive an email$/ do |address|
+  find_email(address).should be_nil
+end
+
+Then /^I should see "(.*)" in the subject$/ do |text|
+  current_email.subject.should =~ Regexp.new(text)
+end
+
+Then /^I should see "(.*)" in the email$/ do |text|
+  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/cucumber.rb

@@ -0,0 +1,19 @@
+# require this in your env.rb file after you require cucumber/rails/world
+
+%w[helpers matchers].each do |file|
+  require File.join(File.dirname(__FILE__), "email_spec_#{file}.rb")
+end
+
+# Global Setup
+ActionMailer::Base.delivery_method = :test
+ActionMailer::Base.perform_deliveries = true
+
+Before do 
+  # Scenario setup
+  ActionMailer::Base.deliveries.clear
+end
+
+World do |world|
+  world.extend EmailSpec::Helpers
+  world.extend EmailSpec::Matchers
+end

data/lib/email_spec/email_spec_helpers.rb

@@ -0,0 +1,96 @@
+require 'uri'
+
+module EmailSpec
+
+  module Helpers
+
+    def self.extended(base)
+      base.instance_eval do
+        @email_spec_hash = {}
+        @email_spec_hash[:read_emails] = {}
+        @email_spec_hash[:unread_emails] = {}
+        @email_spec_hash[:current_emails] = {}
+        @email_spec_hash[:current_email] = nil
+      end
+    end
+    
+    def reset_mailer
+      ActionMailer::Base.deliveries.clear
+    end
+
+    def visit_in_email(link_text)
+      visit(parse_email_for_link(current_email, link_text))
+    end
+    
+    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
+      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 unread_emails_for(address)
+      mailbox_for(address) - read_emails_for(address)
+    end
+    
+    def read_emails_for(address)
+      @email_spec_hash[:read_emails][address] ||= []
+    end
+    
+    def mailbox_for(address)
+      ActionMailer::Base.deliveries.select { |m| m.to.include?(address) }
+    end
+    
+    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(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
+end

data/lib/email_spec/email_spec_matchers.rb

@@ -0,0 +1,34 @@
+module EmailSpec
+
+    module Matchers
+          
+    class DeliverTo
+
+      def initialize(expected_email_addresses)
+        @expected_email_addresses = expected_email_addresses.sort
+      end
+
+      def matches?(email)
+        @email = email
+        @actual_recipients = (email.to || []).sort
+        @actual_recipients.should == @expected_email_addresses
+        true
+      end
+
+      def failure_message
+        "expected #{@email.inspect} to deliver to #{@expected_email_addresses.inspect}, but it delievered to #{@actual_recipients.inspect}"
+      end
+
+      def negative_failure_message
+        "expected #{@email.inspect} not to deliver to #{@expected_email_addresses.inspect}, but it did"
+      end
+    end
+
+    def deliver_to(*expected_email_addresses_or_objects_that_respond_to_email)
+      emails = expected_email_addresses_or_objects_that_respond_to_email.map do |email_or_object|
+        email_or_object.kind_of?(String) ? email_or_object : email_or_object.email
+      end
+      DeliverTo.new(emails)
+    end
+  end
+end

data/lib/email_spec.rb

@@ -0,0 +1,3 @@
+module EmailSpec
+  VERSION = '0.0.5'
+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