email_spec 0.2.0

data/rails_generators/email_spec/email_spec_generator.rb

@@ -0,0 +1,17 @@
+# This generator adds email steps to the step definitions directory 
+generator_base = defined?(Rails) ? Rails::Generator::Base : RubiGen::Base
+class EmailSpecGenerator < 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/rails_generators/email_spec/templates/email_steps.rb

@@ -0,0 +1,74 @@
+#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(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 %r{^I follow "([^"]*?)" in the email$} do |link|
+  visit_in_email(link)
+end
+
+Then /^I should receive (an|\d+) emails?$/ do |amount|
+  amount = 1 if amount == "an"
+  unread_emails_for(current_email_address).size.should == amount.to_i
+end
+
+Then %r{^"([^"]*?)" should receive (\d+) emails?$} do |address, n|
+  unread_emails_for(address).size.should == n.to_i 
+end
+
+Then %r{^"([^"]*?)" should have (\d+) emails?$} do |address, n|
+  mailbox_for(address).size.should == n.to_i
+end
+
+Then %r{^"([^"]*?)" should not receive an email$} do |address|
+  find_email(address).should be_nil
+end
+
+Then %r{^I should see "([^"]*?)" in the subject$} do |text|
+  current_email.should have_subject(Regexp.new(text))
+end
+
+Then %r{^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
+
+When /^I click the first link in the email$/ do
+  click_first_link_in_email
+end
+

data/spec/email_spec/matchers_spec.rb

@@ -0,0 +1,159 @@
+
+require File.dirname(__FILE__) + '/../spec_helper'
+
+
+
+describe EmailSpec::Matchers do
+
+
+    class MatcherMatch
+
+      def initialize(object_to_test_match)
+        @object_to_test_match = object_to_test_match
+      end
+
+      def description
+        "match when provided #{@object_to_test_match.inspect}"
+      end
+
+      def matches?(matcher)
+        @matcher = matcher
+        matcher.matches?(@object_to_test_match)
+      end
+
+      def failure_message
+        "expected #{@matcher.inspect} to match when provided #{@object_to_test_match.inspect}, but it did not"
+      end
+
+      def negative_failure_message
+        "expected #{@matcher.inspect} not to match when provided #{@object_to_test_match.inspect}, but it did"
+      end
+    end
+
+    def match(object_to_test_match)
+      if object_to_test_match.is_a?(Regexp)
+        super # delegate to rspec's built in 'match' matcher
+      else
+        MatcherMatch.new(object_to_test_match)
+      end
+    end
+
+  include EmailSpec::Matchers
+
+  def mock_email(stubs)
+    mock("email", stubs)
+  end
+
+  describe "#deliver_to" do
+
+    it "should match when the email is set to deliver to the specidied address" do
+      email = mock_email(:to => "jimmy_bean@yahoo.com")
+
+      deliver_to("jimmy_bean@yahoo.com").should match(email)
+    end
+
+    it "should match when a list of emails is exact same as all of the email's recipients" do
+      email = mock_email(:to => ["james@yahoo.com", "karen@yahoo.com"])
+
+      deliver_to("karen@yahoo.com", "james@yahoo.com").should match(email)
+      deliver_to("karen@yahoo.com").should_not match(email)
+    end
+
+    it "should match when an array of emails is exact same as all of the email's recipients" do
+      addresses = ["james@yahoo.com", "karen@yahoo.com"]
+      email = mock_email(:to => addresses)
+      deliver_to(addresses).should match(email)
+    end
+
+    it "should use the passed in objects :email method if not a string" do
+      email = mock_email(:to => "jimmy_bean@yahoo.com")
+      user = mock("user", :email => "jimmy_bean@yahoo.com")
+
+      deliver_to(user).should match(email)
+    end
+
+  end
+
+  describe "#have_subject" do
+
+    describe "when regexps are used" do
+
+      it "should match when the subject mathches regexp" do
+        email = mock_email(:subject => ' -- The Subject --')
+
+        have_subject(/The Subject/).should match(email)
+        have_subject(/The Subject/).should match(email)
+        have_subject(/foo/).should_not match(email)
+      end
+
+      it "should have a helpful description" do
+        matcher = have_subject(/foo/)
+        matcher.matches?(mock_email(:subject => "bar"))
+
+        matcher.description.should == "have subject matching /foo/"
+      end
+
+      it "should offer helpful failing messages" do
+        matcher = have_subject(/foo/)
+        matcher.matches?(mock_email(:subject => "bar"))
+
+        matcher.failure_message.should == 'expected the subject to match /foo/, but did not.  Actual subject was: "bar"'
+      end
+
+      it "should offer helpful negative failing messages" do
+        matcher = have_subject(/b/)
+        matcher.matches?(mock_email(:subject => "bar"))
+
+        matcher.negative_failure_message.should == 'expected the subject not to match /b/ but "bar" does match it.'
+      end
+
+    end
+
+    describe "when strings are used" do
+
+      it "should match when the subject equals the passed in string exactly" do
+        email = mock_email(:subject => 'foo')
+
+        have_subject("foo").should match(email)
+        have_subject(" - foo -").should_not match(email)
+      end
+
+      it "should have a helpful description" do
+        matcher = have_subject("foo")
+        matcher.matches?(mock_email(:subject => "bar"))
+
+        matcher.description.should == 'have subject of "foo"'
+      end
+
+      it "should offer helpful failing messages" do
+        matcher = have_subject("foo")
+        matcher.matches?(mock_email(:subject => "bar"))
+
+        matcher.failure_message.should == 'expected the subject to be "foo" but was "bar"'
+      end
+
+
+      it "should offer helpful negative failing messages" do
+        matcher = have_subject("bar")
+        matcher.matches?(mock_email(:subject => "bar"))
+
+        matcher.negative_failure_message.should == 'expected the subject not to be "bar" but was'
+      end
+
+    end
+
+
+  end
+
+  describe "#include_email_with_subject" do
+    it "should have specs!"
+  end
+
+  describe "#have_body_text" do
+    it "should have specs!"
+  end
+  
+  describe "#have_header" do
+    it "should have specs!"
+  end
+end

data/spec/spec.opts

@@ -0,0 +1,4 @@
+--colour
+--format s
+--loadby mtime
+--reverse

data/spec/spec_helper.rb

@@ -0,0 +1,4 @@
+require 'rubygems'
+require 'actionmailer'
+require 'spec'
+require File.expand_path(File.dirname(__FILE__) + '/../lib/email_spec.rb')

metadata

@@ -0,0 +1,181 @@
+--- !ruby/object:Gem::Specification 
+name: email_spec
+version: !ruby/object:Gem::Version 
+  version: 0.2.0
+platform: ruby
+authors: 
+- Ben Mabey
+- Aaron Gibralter
+- Mischa Fierer
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-06-08 00:00:00 -06:00
+default_executable: 
+dependencies: []
+
+description: Easily test email in rspec and cucumber
+email: ben@benmabey.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- MIT-LICENSE.txt
+- README.rdoc
+files: 
+- History.txt
+- 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/log/development.log
+- examples/rails_root/log/test.log
+- 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
+- lib/email_spec/address_converter.rb
+- lib/email_spec/cucumber.rb
+- lib/email_spec/deliveries.rb
+- lib/email_spec/email_viewer.rb
+- lib/email_spec/helpers.rb
+- 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: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: email-spec
+rubygems_version: 1.3.3
+signing_key: 
+specification_version: 3
+summary: Easily test email in rspec and cucumber
+test_files: 
+- spec/email_spec/matchers_spec.rb
+- spec/spec_helper.rb
+- 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/config/boot.rb
+- 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/db/migrate/20090125013728_create_users.rb
+- examples/rails_root/db/schema.rb
+- 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/dispatch.rb
+- 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/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