glennr-email_spec 0.3.5

data/History.txt

@@ -0,0 +1,135 @@
+(In Git)
+
+ === New features
+ === Bufixes
+
+== 0.3.5 2009-09-30 The Pony Release!
+
+ === New features
+ * Support for Pony mailer library. (Rob Holland)
+
+== 0.3.4 2009-09-26
+
+=== Bugfixes
+ * Typo and logic fixes for DeliverFrom matcher. (Yury Kotlyarov)
+
+ == 0.3.3 2009-09-18
+
+ === New features
+ * DeliverFrom matcher. i.e. email.should deliver_from(blah) or email.should be_delivered_from(blah) (Diego Carrion)
+
+ == 0.3.2 2009-09-10
+
+ === New features
+  * Support for delayed_job. (Kieran Pilkington)
+
+ == 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.4.0 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 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
+
+  * Additional default steps (Balint Erdi)
+    * Then /^I should not receive any emails?$/
+    * When %r{^"([^"]*?)" opens? the email$} do |address|
+
+ === Bufixes
+
+ == 0.2.1 2009-5-29
+
+ === New Features
+  * BCC RSpec matcher. (Josh Nichols)
+
+ === Bugfixes
+  * Include BCCed and CCed messsages in the mailbox. (Jakub Kosiński)
+
+== 0.2.0 2009-6-08
+No changes. Bumping version for RubyForge release.
+
+
+ == 0.1.4 2009-5-29
+
+ === Bufixes
+  * Require deliveries in the helpers so it doesn't blow up with RSpec. (Craig Webster)
+
+ == 0.1.3 2009-4-15
+
+ === Bufixes
+  * Fixed regular expressions in genertaed steps. (Ben Mabey)
+  * World semantics changed in cucumber (0.2.3.2), email_spec now uses the new API. (Hector Morales)
+
+ == 0.1.2 2009-4-05
+
+ === New features
+ === Bufixes
+  * Actually added the renamed generators to the gem so people could use it! D'oh! (Ben Mabey)
+    * You can either use "./script generate email_spec" or "rubigen rails email_spec"
+  * Removed Rake tasks from example application to prevent conflicts when used as a plugin. (Ben Mabey)
+
+ == 0.1.1 2009-3-26
+ === New features
+  * Switched dir structure over to support rubigen. (Dr. Nic)
+
+ === Bufixes
+
+ == 0.1.0 2009-3-25
+ === New features
+  * Change Rakefile to run all specs and features, as well as prepare the db (Mischa Fierer)
+  * Allow for array to be passed into deliver_to matcher. (Diego Carrion)
+  * Added matcher for checking if a collection of emails includes an email with a particular subject (Luke Melia, Noah Davis)
+  * Introduced hook to convert objects to email addresses (Luke Melia and Lee Bankewitz)
+
+    This allows you, in your step matcher, to say something like:
+    maillbox_for(some_user)
+
+    Use it in your cucumber env.rb like so:
+
+      EmailSpec::AddressConverter.instance.conversion do |input|
+       if input.is_a?(User)
+         input.email
+       else
+         input
+       end
+      end
+
+=== Bufixes
+ * Revert parse_email_for_link helper method to allow for text links as well as explicit link finding. (Mischa Fierer)
+ * Isolated variances between using email-spec with an ARMailer project. (Luke Melia)
+
+
+== 0.0.9 2009-2-15
+ === New features
+  * have_body_text, have_header matchers (Luke Melia)
+  * EmailViewer - opens all sent emails in a given scenario when the environment variables are set. (Luke Melia)
+  * Added compatibility with using ARMailer in test mode. (Luke Melia)
+ === Bugfixes
+  * set_current_email now works with multiple addresses in To field. (Brian McManus, Ben Mabey)
+
+== 0.0.7 2009-1-20
+ === New features
+  * have_subject matcher (Ben Mabey)
+
+== 0.0.6 2008-12-23
+ === New features
+  * Improved RSpec documentation and refactorings. (Ben Mabey)
+ === Bugfixes
+  * Removed sample app Rake Tasks to have it play nice with environments that use Cucumber as plugin- not gem. (Ben Mabey, Ivor- on github)
+
+== 0.0.5 2008-12-18
+  * Initial release - see this post for full history and contributors: http://www.benmabey.com/2008/12/18/github-rocks/

data/MIT-LICENSE.txt

@@ -0,0 +1,19 @@
+Copyright (c) 2008-2009 Ben Mabey
+
+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,125 @@
+= 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
+   
+  gem install email_spec
+
+  # config/environments/test.rb
+  config.gem '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
+
+  First you need to require the helpers and matchers in your spec_helper.rb like so:
+
+  require "email_spec/helpers"
+  require "email_spec/matchers"
+
+  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|
+    config.include(EmailSpec::Helpers)
+    config.include(EmailSpec::Matchers)
+  end
+
+  Otherwise, you will need to include them in the example groups you wish to use them:
+
+  describe "Signup Email" do
+    include EmailSpec::Helpers
+    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 examples/rails_root in the source for a small example app that implements these steps.
+
+=== RSpec
+
+  ==== Testing In Isolation ====
+    It is often useful to test your mailers in isolation.  You can accomplish this by using mocks to verify that the mailer is being called in the correct place and then write focued examples for the actual mailer.  This is a simple example from the sample app found in the gem:
+
+    Verify that the mailer is used correctly in the controller (this would apply to a model as well):
+
+     describe "POST /signup (#signup)" do
+        it "should deliver the signup email" do
+          # expect
+          UserMailer.should_receive(:deliver_signup).with("email@example.com", "Jimmy Bean")
+          # when
+          post :signup, "Email" => "email@example.com", "Name" => "Jimmy Bean"
+        end
+      end
+
+    Examples for the #signup method in UserMailer:
+
+    describe "Signup Email" do
+      include EmailSpec::Helpers
+      include EmailSpec::Matchers
+      include ActionController::UrlWriter
+
+      before(:all) do
+        @email = UserMailer.create_signup("jojo@yahoo.com", "Jojo Binks")
+      end
+
+      it "should be set to be delivered to the email passed in" do
+        @email.should deliver_to("jojo@yahoo.com")
+      end
+
+      it "should contain the user's message in the mail body" do
+        @email.should have_text(/Jojo Binks/)
+      end
+
+      it "should contain a link to the confirmation link" do
+        @email.should have_text(/#{confirm_account_url}/)
+      end
+
+      it "should have the correct subject" do
+        @email.should have_subject(/Account confirmation/)
+      end
+
+    end
+
+    ==== Using the helpers when not testing in isolation ====
+
+      Don't. :)  Seriously, if you do just take a look at the helpers and use them as you wish.
+
+== Original Authors
+
+Ben Mabey, Aaron Gibralter, Mischa Fierer
+
+Please see History.txt for upcoming changsets and other contributors.

data/Rakefile

@@ -0,0 +1,75 @@
+require 'rubygems'
+require 'spec/rake/spectask'
+
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |s|
+    s.name         = "email_spec"
+    s.platform     = Gem::Platform::RUBY
+    s.authors      = ['Ben Mabey', 'Aaron Gibralter', 'Mischa Fierer']
+    s.email        = "ben@benmabey.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["rails_generators/**/*"]
+    s.test_files   = Dir["spec/**/*"] + Dir["examples/**/*"]
+    # rdoc
+    s.has_rdoc         = true
+    s.extra_rdoc_files = %w(README.rdoc MIT-LICENSE.txt)
+    s.rubyforge_project = 'email-spec'
+  end
+rescue LoadError
+  puts "Jeweler not available. Install it with: sudo gem install technicalpickles-jeweler -s http://gems.github.com"
+end
+
+# TODO: Maybe use geminstaller instead?
+%w[collectiveidea-delayed_job fixjour pony sinatra rack-test].each do |gem_name|
+  begin
+    gem gem_name
+  rescue Gem::LoadError
+    puts "Installing #{gem_name} for the example rails app..."
+    puts `gem install #{gem_name} --no-rdoc --no-ri`
+  end
+end
+
+begin
+  require 'cucumber/rake/task'
+  Cucumber::Rake::Task.new(:features)
+rescue LoadError
+  task :features do
+    abort "Cucumber is not available. In order to run features, you must: sudo gem install cucumber"
+  end
+end
+
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+namespace :example_app do
+  Spec::Rake::SpecTask.new(:spec) do |spec|
+    desc "Specs for Example app"
+    spec.libs << 'lib' << 'spec'
+    spec.spec_files = FileList['examples/rails_root/spec/**/*_spec.rb']
+  end
+end
+
+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/Rakefile

@@ -0,0 +1,13 @@
+require(File.join(File.dirname(__FILE__), 'config', 'boot'))
+
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+
+require 'tasks/rails'
+
+begin
+  require 'delayed/tasks'
+rescue LoadError
+  STDERR.puts "Run `rake gems:install` to install delayed_job"
+end

data/examples/rails_root/app/controllers/application_controller.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/examples/rails_root/app/controllers/welcome_controller.rb

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

data/examples/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/examples/rails_root/app/helpers/welcome_helper.rb

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

data/examples/rails_root/app/models/user.rb

@@ -0,0 +1,2 @@
+class User < ActiveRecord::Base
+end

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

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

data/examples/rails_root/app/views/user_mailer/newsletter.erb

@@ -0,0 +1,8 @@
+Hello <%= @name %>!
+
+This week.....
+.....
+.....
+
+Regards
+Rails Example App

data/examples/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 %>