README.rdoc in email_spec-0.3.8 vs README.rdoc in email_spec-0.4.0
- old
+ new
@@ -1,16 +1,27 @@
= Email Spec
A collection of RSpec matchers and Cucumber steps to make testing emails go smoothly.
+This library works with ActionMailer and Pony. When using it with ActionMailer it works with
+DelayedJob, ActiveRecord Mailer, and action_mailer_cache_delivery.
+When using the action_mailer_cache_delivery library you must use this fork:
+http://github.com/liangzan/action_mailer_cache_delivery
+
+If you are testing emails in conjunction with an automated browser solution, like Selenium,
+you will want to use action_mailer_cache_delivery in your test environment. (This is
+because your test process and server processes are distinct and therefore need an
+intermediate store for the emails.) DelayedJob and ActiveRecord Mailer will also work but
+you generally don't want to include those projects unless you need them in production.
+
== Setup
script/plugin install git://github.com/bmabey/email-spec.git
=== Gem Setup
-
+
gem install email_spec
# config/environments/test.rb
config.gem 'email_spec', :lib => 'email_spec'
@@ -30,13 +41,12 @@
This will give you a bunch of steps to get started with in step_definitions/email_steps.rb
=== RSpec
-First you need to require the helpers and matchers in your spec_helper.rb like so:
+First you need to require email_spec in your spec_helper.rb:
- require "email_spec/helpers"
- require "email_spec/matchers"
+ require "email_spec"
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|