email_spec 0.6.0 → 0.6.1

data/History.txt

@@ -1,5 +1,10 @@
 (In Git)
 
+== 0.6.1 2010-03-17
+
+ === New features
+  * Ability to click image links via the image alt tag. (Tim Harper)
+
 == 0.6.0 2010-03-05
 
  === New features
@@ -146,7 +151,7 @@ No changes. Bumping version for RubyForge release.
  === 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)
+  * Added matcher for checking if a collision 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:

data/Rakefile

@@ -26,7 +26,7 @@ rescue LoadError
 end
 
 # TODO: switch to gem bundler
-([['delayed_job', '1.8.4']] + %w[fixjour pony sinatra rack-test].map{|g| [g]}).each do |gem_args|
+([['delayed_job', '1.8.4']] + %w[mimetype-fu fixjour pony sinatra rack-test].map{|g| [g]}).each do |gem_args|
   gem_name = gem_args.first
   gem_version = gem_args.size > 1 ? gem_args[1] : nil
   begin

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

@@ -9,4 +9,8 @@ class WelcomeController < ApplicationController
   def newsletter
     UserMailer.send_later(:deliver_newsletter, params['Email'], params['Name'])
   end
+
+  def attachments
+    UserMailer.deliver_attachments(params['Email'], params['Name'])
+  end
 end

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

@@ -15,4 +15,25 @@ class UserMailer < ActionMailer::Base
     @sent_on     = Time.now
     @body[:name] = name
   end
+
+  def attachments(email, name)
+    @recipients  = email
+    @from        = "admin@example.com"
+    @subject     = "Attachments test"
+    @sent_on     = Time.now
+    @body[:name] = name
+    add_attachment 'image.png'
+    add_attachment 'document.pdf'
+  end
+
+  private
+
+  def add_attachment(attachment_name)
+    content_type 'multipart/mixed'
+    attachment_path = File.join(RAILS_ROOT, 'attachments', attachment_name)
+    File.open(attachment_path) do |file|
+      filename = File.basename(file.path)
+      attachment :filename => filename, :content_type => File.mime_type?(file), :body => file.read
+    end
+  end
 end

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

@@ -0,0 +1,6 @@
+Hello <%= @name %>!
+
+Documents are attached.
+
+Regards
+Rails Example App

data/examples/rails_root/config/environment.rb

@@ -16,6 +16,7 @@ Rails::Initializer.run do |config|
 
   config.gem 'fixjour',     :lib => 'fixjour'
   config.gem 'delayed_job', :lib => 'delayed_job'
+  config.gem 'mimetype-fu', :lib => 'mimetype_fu'
 
   config.time_zone = 'UTC'
 

data/examples/rails_root/config/routes.rb

@@ -34,6 +34,7 @@ ActionController::Routing::Routes.draw do |map|
   map.root :controller => "welcome", :action => "index"
   map.confirm_account "/confirm", :controller => "welcome", :action => "confirm"
   map.request_newsletter "/newsletter", :controller => "welcome", :action => "newsletter"
+  map.request_attachments "/attachments", :controller => "welcome", :action => "attachments"
   # See how all your routes lay out with "rake routes"
 
   # Install the default routes as the lowest priority.

data/examples/rails_root/features/attachments.feature

@@ -0,0 +1,27 @@
+Feature: Attachment testing support
+  In order for developers to test attachments in emails
+  I want to be able to provide working steps which inspect attachments
+
+  Scenario: Email with Attachments
+    Given no emails have been sent
+    And I go to request attachments be sent to me
+    Then I should receive an email
+    When I open the email
+    Then I should see 2 attachments with the email
+    And there should be an attachment named "image.png"
+    And there should be an attachment named "document.pdf"
+    And attachment 1 should be named "image.png"
+    And attachment 2 should be named "document.pdf"
+    And there should be an attachment of type "image/png"
+    And there should be an attachment of type "application/pdf"
+    And attachment 1 should be of type "image/png"
+    And attachment 2 should be of type "application/pdf"
+    And all attachments should not be blank
+
+  Scenario: Email without Attachments
+    Given no emails have been sent
+    And I am on the homepage
+    And I submit my registration information
+    Then I should receive an email
+    When I open the email
+    Then I should see no attachments with the email

data/examples/rails_root/features/support/paths.rb

@@ -20,6 +20,9 @@ module NavigationHelpers
     when /request a newsletter/
       request_newsletter_url('Name' => 'Joe Someone', 'Email' => 'example@example.com')
 
+    when /request attachments be sent to me/
+      request_attachments_url('Name' => 'Joe Someone', 'Email' => 'example@example.com')
+
     else
       raise "Can't find mapping from \"#{page_name}\" to a path.\n" +
         "Now, go and add a mapping in #{__FILE__}"

data/lib/email_spec/helpers.rb

@@ -44,6 +44,10 @@ module EmailSpec
       email
     end
 
+    def current_email_attachments(address=nil)
+      current_email(address).attachments || Array.new
+    end
+
     def unread_emails_for(address)
       mailbox_for(address) - read_emails_for(address)
     end
@@ -110,9 +114,16 @@ module EmailSpec
 
     # e.g. Click here in  <a href="http://confirm">Click here</a>
     def parse_email_for_anchor_text_link(email, link_text)
-      email.body =~ %r{<a[^>]*href=['"]?([^'"]*)['"]?[^>]*?>[^<]*?#{link_text}[^<]*?</a>}
-      URI.split($~[1])[5..-1].compact!.join("?").gsub("&amp;", "&")
-      # sub correct ampersand after rails switches it (http://dev.rubyonrails.org/ticket/4002)
+      if textify_images(email.body) =~ %r{<a[^>]*href=['"]?([^'"]*)['"]?[^>]*?>[^<]*?#{link_text}[^<]*?</a>}
+        URI.split($1)[5..-1].compact!.join("?").gsub("&amp;", "&")
+        # sub correct ampersand after rails switches it (http://dev.rubyonrails.org/ticket/4002)
+      else
+        return nil
+      end
+    end
+
+    def textify_images(email_body)
+      email_body.gsub(%r{<img[^>]*alt=['"]?([^'"]*)['"]?[^>]*?/>}) { $1 }
     end
 
     def parse_email_count(amount)

data/rails_generators/email_spec/templates/email_steps.rb

@@ -117,28 +117,28 @@ end
 # Inspect the Email Attachments
 #
 
-Then /^(?:I|they) should see (\d+) attachments? with the email$/ do |amount|
-  current_email.attachments.size.should == amount.to_i
+Then /^(?:I|they) should see (an|no|\d+) attachments? with the email$/ do |amount|
+  current_email_attachments.size.should == parse_email_count(amount)
 end
 
 Then /^there should be (an|no|\d+) attachments? named "([^"]*?)"$/ do |amount, filename|
-  current_email.attachments.select { |a| a.original_filename == filename }.size.should == parse_email_count(amount)
+  current_email_attachments.select { |a| a.original_filename == filename }.size.should == parse_email_count(amount)
 end
 
 Then /^attachment (\d+) should be named "([^"]*?)"$/ do |index, filename|
-  current_email.attachments[(index.to_i - 1)].original_filename.should == filename
+  current_email_attachments[(index.to_i - 1)].original_filename.should == filename
 end
 
 Then /^there should be (an|no|\d+) attachments? of type "([^"]*?)"$/ do |amount, content_type|
-  current_email.attachments.select { |a| a.content_type == content_type }.size.should == parse_email_count(amount)
+  current_email_attachments.select { |a| a.content_type == content_type }.size.should == parse_email_count(amount)
 end
 
 Then /^attachment (\d+) should be of type "([^"]*?)"$/ do |index, content_type|
-  current_email.attachments[(index.to_i - 1)].content_type.should == content_type
+  current_email_attachments[(index.to_i - 1)].content_type.should == content_type
 end
 
 Then /^all attachments should not be blank$/ do
-  current_email.attachments.each do |attachment|
+  current_email_attachments.each do |attachment|
     attachment.size.should_not == 0
   end
 end

data/spec/email_spec/helpers_spec.rb

@@ -0,0 +1,23 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+
+describe EmailSpec::Helpers do
+  include EmailSpec::Helpers
+  describe "#parse_email_for_link" do
+    it "properly finds links with text" do
+      email = stub(:has_body_text? => true,
+                   :body => %(<a href="/path/to/page">Click Here</a>))
+      parse_email_for_link(email, "Click Here").should == "/path/to/page"
+    end
+
+    it "recognizes img alt properties as text" do
+      email = stub(:has_body_text? => true,
+                   :body => %(<a href="/path/to/page"><img src="http://host.com/images/image.gif" alt="an image" /></a>))
+      parse_email_for_link(email, "an image").should == "/path/to/page"
+    end
+
+    it "causes a spec to fail if the body doesn't contain the text specified to click" do
+      email = stub(:has_body_text? => false)
+      lambda { parse_email_for_link(email, "non-existent text") }.should raise_error(Spec::Expectations::ExpectationNotMetError)
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: email_spec
 version: !ruby/object:Gem::Version 
-  version: 0.6.0
+  version: 0.6.1
 platform: ruby
 authors: 
 - Ben Mabey
@@ -11,7 +11,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-03-05 00:00:00 -07:00
+date: 2010-03-17 00:00:00 -06:00
 default_executable: 
 dependencies: []
 
@@ -70,6 +70,7 @@ signing_key:
 specification_version: 3
 summary: Easily test email in rspec and cucumber
 test_files: 
+- spec/email_spec/helpers_spec.rb
 - spec/email_spec/matchers_spec.rb
 - spec/spec.opts
 - spec/spec_helper.rb
@@ -79,12 +80,16 @@ test_files:
 - 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/attachments.erb
 - examples/rails_root/app/views/user_mailer/newsletter.erb
 - examples/rails_root/app/views/user_mailer/signup.erb
+- examples/rails_root/app/views/welcome/attachments.html.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/newsletter.html.erb
 - examples/rails_root/app/views/welcome/signup.html.erb
+- examples/rails_root/attachments/document.pdf
+- examples/rails_root/attachments/image.png
 - examples/rails_root/config/boot.rb
 - examples/rails_root/config/cucumber.yml
 - examples/rails_root/config/database.yml
@@ -101,6 +106,7 @@ test_files:
 - examples/rails_root/db/migrate/20090908054656_create_delayed_jobs.rb
 - examples/rails_root/db/schema.rb
 - examples/rails_root/doc/README_FOR_APP
+- examples/rails_root/features/attachments.feature
 - examples/rails_root/features/delayed_job.feature
 - examples/rails_root/features/errors.feature
 - examples/rails_root/features/example.feature
@@ -123,7 +129,6 @@ test_files:
 - examples/rails_root/public/javascripts/prototype.js
 - examples/rails_root/public/robots.txt
 - examples/rails_root/Rakefile
-- examples/rails_root/rerun.txt
 - examples/rails_root/script/about
 - examples/rails_root/script/autospec
 - examples/rails_root/script/console

data/examples/rails_root/rerun.txt

@@ -1 +0,0 @@
-features/errors.feature:13:17:21:26:30