email_spec 1.6.0 → 2.0.0

data/examples/sinatra_root/features/support/env.rb

@@ -0,0 +1,21 @@
+# Generated by cucumber-sinatra. (Tue Jul 27 10:45:23 -0400 2010)
+
+require File.join(File.dirname(__FILE__), '..', '..', 'lib/example_sinatra_app.rb')
+require 'capybara'
+require 'capybara/cucumber'
+require 'rspec/core'
+#require 'activesupport'
+require File.expand_path(File.dirname(__FILE__) + '../../../../../lib/email_spec')
+require 'email_spec/cucumber'
+
+ExampleSinatraApp.set(:environment, :test)
+
+Capybara.app = ExampleSinatraApp
+
+class ExampleSinatraAppWorld
+  include Capybara::DSL
+end
+
+World do
+  ExampleSinatraAppWorld.new
+end

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

@@ -0,0 +1,29 @@
+# Taken from the cucumber-rails project.
+
+module NavigationHelpers
+  # Maps a name to a path. Used by the
+  #
+  #   When /^I go to (.+)$/ do |page_name|
+  #
+  # step definition in web_steps.rb
+  #
+  def path_to(page_name)
+    case page_name
+
+    when /the home\s?page/
+      '/'
+
+    # Add more mappings here.
+    # Here is an example that pulls values out of the Regexp:
+    #
+    #   when /^(.*)'s profile page$/i
+    #     user_profile_path(User.find_by_login($1))
+
+    else
+      raise "Can't find mapping from \"#{page_name}\" to a path.\n" +
+        "Now, go and add a mapping in #{__FILE__}"
+    end
+  end
+end
+
+World(NavigationHelpers)

data/examples/sinatra_root/lib/example_sinatra_app.rb

@@ -0,0 +1,45 @@
+require 'sinatra/base'
+require 'pony'
+
+class ExampleSinatraApp < Sinatra::Base
+  get '/' do
+    <<-EOHTML
+  <form method="post" action="/signup">
+      <label for="Name">Name</label>
+      <input type="text" id="Name" name="user[name]">
+      <label for="Email">Email</label>
+      <input type="text" id="Email" name="user[email]">
+      <input type="submit" value="Sign up">
+  </form>
+    EOHTML
+  end
+
+  post '/signup' do
+    user = params[:user]
+    body = <<-EOTEXT
+  Hello #{user['name']}!
+
+  Copy and paste this URL into your browser to confirm your account!
+
+  http://www.example.com/confirm
+  This is the text part.
+    EOTEXT
+    html_body = <<-EOHTML
+  Hello #{user['name']}!
+
+  <a href="http://www.example.com/confirm">Click here to confirm your account!</a>
+  This is the HTML part.
+    EOHTML
+    Pony.mail(:from => 'admin@example.com',
+              :to => user['email'],
+              :subject => 'Account confirmation',
+              :body => body,
+              :html_body => html_body
+             )
+             'Thanks!  Go check your email!'
+  end
+
+  get '/confirm' do
+    'Confirm your new account!'
+  end
+end

data/features/rails4_app.feature

@@ -0,0 +1,32 @@
+Feature: Email Spec in Rails 4 App
+
+In order to prevent me from shipping a defective email_spec gem
+As a email_spec dev
+I want to verify that the example rails 4 app runs all of it's features as expected
+
+  Scenario: generators test
+    Given the rails4 app is setup with the latest generators
+    When I run "bundle exec rails g email_spec:steps" in the rails4 app
+    Then the rails4 app should have the email steps in place
+
+  Scenario: regression test
+    Given the rails4 app is setup with the latest email steps
+    When I run "bundle exec rake db:migrate RAILS_ENV=test" in the rails4 app
+    And I run "bundle exec cucumber features -q --no-color" in the rails4 app
+    Then I should see the following summary report:
+    """
+    15 scenarios (7 failed, 8 passed)
+    136 steps (7 failed, 1 skipped, 128 passed)
+    """
+
+   When I run "bundle exec rake spec RAILS_ENV=test" in the rails4 app
+   Then I should see the following summary report:
+   """
+   9 examples, 0 failures
+   """
+
+   When I run "bundle exec rake test RAILS_ENV=test" in the rails4 app
+   Then I should see the following summary report:
+   """
+   8 runs, 8 assertions, 0 failures, 0 errors, 0 skips
+   """

data/features/sinatra_app.feature

@@ -0,0 +1,14 @@
+Feature: Email Spec in Sinatra App
+
+In order to prevent me from shipping a defective email_spec gem
+As a email_spec dev
+I want to verify that the example sinatra app runs all of it's features as expected
+
+  Scenario: regression test
+    Given the sinatra app is setup with the latest email steps
+    When I run "bundle exec cucumber features -q --no-color" in the sinatra app
+    Then I should see the following summary report:
+    """
+    12 scenarios (7 failed, 5 passed)
+    110 steps (7 failed, 1 skipped, 102 passed)
+    """

data/features/step_definitions/app_steps.rb

@@ -0,0 +1,58 @@
+require 'fileutils'
+
+Given /^the (\w+) app is setup with the latest email steps$/ do |app_name|
+  app_dir = File.join(root_dir, 'examples',"#{app_name}_root")
+  email_specs_path = File.join(app_dir, 'features', 'step_definitions',
+                               'email_steps.rb')
+  latest_specs_path = File.join(root_dir, 'lib', 'generators', 'email_spec',
+                                'steps', 'templates','email_steps.rb')
+  FileUtils.rm(email_specs_path) if File.exists?(email_specs_path)
+  FileUtils.cp_r(latest_specs_path, email_specs_path)
+end
+
+Then /^the (\w+) app should have the email steps in place$/ do |app_name|
+  email_specs_path = "#{root_dir}/examples/#{app_name}_root/features/step_definitions/email_steps.rb"
+  expect(File.exists?(email_specs_path)).to be true
+end
+
+Then /^I should see the following summary report:$/ do |expected_report|
+  expect(@output).to include(expected_report)
+end
+
+Given /^the (\w+) app is setup with the latest generators$/ do |app_name|
+  app_dir= File.join(root_dir,'examples',"#{app_name}_root")
+  email_specs_path = File.join(app_dir,'features','step_definitions','email_steps.rb')
+  FileUtils.rm(email_specs_path) if File.exists?(email_specs_path)
+
+  if app_name == 'rails4'
+    #Testing using the gem
+    #make sure we are listed in the bundle
+    Dir.chdir(app_dir) do
+      output =`bundle list`
+      expect(output).to include('email_spec')
+    end
+  else
+    FileUtils.mkdir_p("#{app_dir}/vendor/plugins/email_spec")
+    FileUtils.cp_r("#{root_dir}/rails_generators","#{app_dir}/vendor/plugins/email_spec/")
+    Dir.chdir(app_dir) do
+      system "ruby ./script/generate email_spec"
+    end
+  end
+end
+
+When /^I run "([^\"]*)" in the (\w+) app$/ do |cmd, app_name|
+  #cmd.gsub!('cucumber', "#{Cucumber::RUBY_BINARY} #{Cucumber::BINARY}")
+  app_path = File.join(root_dir, 'examples', "#{app_name}_root")
+  app_specific_gemfile = File.join(app_path,'Gemfile')
+  Dir.chdir(app_path) do
+    #hack to fight competing bundles (email specs vs rails4_root's
+    if File.exists? app_specific_gemfile
+      orig_gemfile = ENV['BUNDLE_GEMFILE']
+      ENV['BUNDLE_GEMFILE'] = app_specific_gemfile
+      @output = `#{cmd}`
+      ENV['BUNDLE_GEMFILE'] = orig_gemfile
+    else
+      @output = `#{cmd}`
+    end
+  end
+end

data/features/support/env.rb

@@ -0,0 +1,16 @@
+require 'rubygems'
+#require 'spec/expectations'
+
+class EmailSpecWorld
+  def self.root_dir
+    @root_dir ||= File.join(File.expand_path(File.dirname(__FILE__)), "..", "..")
+  end
+
+  def root_dir
+    EmailSpecWorld.root_dir
+  end
+end
+
+World do
+  EmailSpecWorld.new
+end

data/lib/email_spec.rb

@@ -5,8 +5,8 @@ end
 
 $LOAD_PATH.unshift(File.expand_path(File.dirname(__FILE__))) unless $LOAD_PATH.include?(File.expand_path(File.dirname(__FILE__)))
 
+require 'htmlentities'
 require 'mail'
-require 'email_spec/background_processes'
 require 'email_spec/deliveries'
 require 'email_spec/address_converter'
 require 'email_spec/email_viewer'

data/lib/email_spec/deliveries.rb

@@ -79,7 +79,6 @@ module EmailSpec
       def mailer; ActionMailer::Base; end
       include EmailSpec::MailerDeliveries
     end
-    include EmailSpec::BackgroundProcesses::Compatibility
   end
 end
 

data/lib/email_spec/email_viewer.rb

@@ -35,7 +35,7 @@ module EmailSpec
           if m.multipart? && text_part = m.parts.detect{ |p| p.content_type.include?('text/plain') }
             if m.respond_to?(:ordered_each) # Rails 2 / TMail
               m.ordered_each{|k,v| f.write "#{k}: #{v}\n" }
-            else # Rails 3 / Mail
+            else # Rails 4 / Mail
               f.write(text_part.header.to_s + "\n")
             end
 

data/lib/email_spec/helpers.rb

@@ -43,7 +43,12 @@ module EmailSpec
     def current_email(address=nil)
       address = convert_address(address)
       email = address ? email_spec_hash[:current_emails][address] : email_spec_hash[:current_email]
-      raise   RSpec::Expectations::ExpectationNotMetError, "Expected an open email but none was found. Did you forget to call open_email?" unless email
+      exception_class = if defined?(RSpec)
+        RSpec::Expectations::ExpectationNotMetError
+      else
+        StandardError
+      end
+      raise exception_class, "Expected an open email but none was found. Did you forget to call open_email?" unless email
       email
     end
 
@@ -52,7 +57,8 @@ module EmailSpec
     end
 
     def unread_emails_for(address)
-      mailbox_for(address) - read_emails_for(address)
+      read_message_ids = read_emails_for(address).map(&:message_id)
+      mailbox_for(address).reject { |m| read_message_ids.include?(m.message_id) }
     end
 
     def read_emails_for(address)
@@ -76,7 +82,8 @@ module EmailSpec
     end
 
     def links_in_email(email)
-      URI.extract(email.default_part_body.to_s, ['http', 'https'])
+      links = URI.extract(email.default_part_body.to_s, ['http', 'https'])
+      links.map{|url| HTMLEntities.new.decode(url) }.uniq
     end
 
     private
@@ -107,7 +114,11 @@ module EmailSpec
 
     def parse_email_for_link(email, text_or_regex)
       matcher = EmailSpec::Matchers::HaveBodyText.new(text_or_regex)
-      RSpec::Expectations::PositiveExpectationHandler.handle_matcher(email, matcher)
+      if defined?(RSpec)
+        RSpec::Expectations::PositiveExpectationHandler.handle_matcher(email, matcher)
+      else
+        assert_must matcher, email
+      end
 
       url = parse_email_for_explicit_link(email, text_or_regex)
       url ||= parse_email_for_anchor_text_link(email, text_or_regex)
@@ -131,7 +142,7 @@ module EmailSpec
 
     # e.g. Click here in  <a href="http://confirm">Click here</a>
     def parse_email_for_anchor_text_link(email, link_text)
-      if textify_images(email.default_part_body) =~ %r{<a[^>]*href=['"]?([^'"]*)['"]?[^>]*?>[^<]*?#{link_text}[^<]*?</a>}
+      if textify_images(email.default_part_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

data/lib/email_spec/matchers.rb

@@ -57,7 +57,8 @@ module EmailSpec
 
       def matches?(email)
         @email = email
-        @actual_recipients = address_array{ email.header[:to].addrs }.map(&:to_s).sort
+        recipients = email.header[:to] || email.header[:bcc]
+        @actual_recipients = address_array{ recipients  && recipients.addrs }.map(&:to_s).sort
         @actual_recipients == @expected_recipients
       end
 

data/lib/email_spec/version.rb

@@ -0,0 +1,3 @@
+module EmailSpec
+  VERSION = '2.0.0'
+end

data/lib/generators/email_spec/steps/templates/email_steps.rb

@@ -49,19 +49,19 @@ end
 #
 
 Then /^(?:I|they|"([^"]*?)") should receive (an|no|\d+) emails?$/ do |address, amount|
-  unread_emails_for(address).size.should == parse_email_count(amount)
+  expect(unread_emails_for(address).size).to eql parse_email_count(amount)
 end
 
 Then /^(?:I|they|"([^"]*?)") should have (an|no|\d+) emails?$/ do |address, amount|
-  mailbox_for(address).size.should == parse_email_count(amount)
+  expect(mailbox_for(address).size).to eql parse_email_count(amount)
 end
 
 Then /^(?:I|they|"([^"]*?)") should receive (an|no|\d+) emails? with subject "([^"]*?)"$/ do |address, amount, subject|
-  unread_emails_for(address).select { |m| m.subject =~ Regexp.new(Regexp.escape(subject)) }.size.should == parse_email_count(amount)
+  expect(unread_emails_for(address).select { |m| m.subject =~ Regexp.new(Regexp.escape(subject)) }.size).to eql parse_email_count(amount)
 end
 
 Then /^(?:I|they|"([^"]*?)") should receive (an|no|\d+) emails? with subject \/([^"]*?)\/$/ do |address, amount, subject|
-  unread_emails_for(address).select { |m| m.subject =~ Regexp.new(subject) }.size.should == parse_email_count(amount)
+  expect(unread_emails_for(address).select { |m| m.subject =~ Regexp.new(subject) }.size).to eql parse_email_count(amount)
 end
 
 Then /^(?:I|they|"([^"]*?)") should receive an email with the following body:$/ do |address, expected_body|
@@ -98,43 +98,47 @@ end
 #
 
 Then /^(?:I|they) should see "([^"]*?)" in the email subject$/ do |text|
-  current_email.should have_subject(text)
+  expect(current_email).to have_subject(text)
 end
 
 Then /^(?:I|they) should see \/([^"]*?)\/ in the email subject$/ do |text|
-  current_email.should have_subject(Regexp.new(text))
+  expect(current_email).to have_subject(Regexp.new(text))
 end
 
 Then /^(?:I|they) should see "([^"]*?)" in the email body$/ do |text|
-  current_email.default_part_body.to_s.should include(text)
+  expect(current_email.default_part_body.to_s).to include(text)
 end
 
 Then /^(?:I|they) should see \/([^"]*?)\/ in the email body$/ do |text|
-  current_email.default_part_body.to_s.should =~ Regexp.new(text)
+  expect(current_email.default_part_body.to_s).to match Regexp.new(text)
 end
 
 Then /^(?:I|they) should see the email delivered from "([^"]*?)"$/ do |text|
-  current_email.should be_delivered_from(text)
+  expect(current_email).to be_delivered_from(text)
+end
+
+Then /^(?:I|they) should see the email reply to "([^"]*?)"$/ do |text|
+  expect(current_email).to have_reply_to(text)
 end
 
 Then /^(?:I|they) should see "([^\"]*)" in the email "([^"]*?)" header$/ do |text, name|
-  current_email.should have_header(name, text)
+  expect(current_email).to have_header(name, text)
 end
 
 Then /^(?:I|they) should see \/([^\"]*)\/ in the email "([^"]*?)" header$/ do |text, name|
-  current_email.should have_header(name, Regexp.new(text))
+  expect(current_email).to have_header(name, Regexp.new(text))
 end
 
 Then /^I should see it is a multi\-part email$/ do
-    current_email.should be_multipart
+    expect(current_email).to be_multipart
 end
 
 Then /^(?:I|they) should see "([^"]*?)" in the email html part body$/ do |text|
-    current_email.html_part.body.to_s.should include(text)
+    expect(current_email.html_part.body.to_s).to include(text)
 end
 
 Then /^(?:I|they) should see "([^"]*?)" in the email text part body$/ do |text|
-    current_email.text_part.body.to_s.should include(text)
+    expect(current_email.text_part.body.to_s).to include(text)
 end
 
 #
@@ -142,28 +146,28 @@ end
 #
 
 Then /^(?:I|they) should see (an|no|\d+) attachments? with the email$/ do |amount|
-  current_email_attachments.size.should == parse_email_count(amount)
+  expect(current_email_attachments.size).to eql parse_email_count(amount)
 end
 
 Then /^there should be (an|no|\d+) attachments? named "([^"]*?)"$/ do |amount, filename|
-  current_email_attachments.select { |a| a.filename == filename }.size.should == parse_email_count(amount)
+  expect(current_email_attachments.select { |a| a.filename == filename }.size).to eql parse_email_count(amount)
 end
 
 Then /^attachment (\d+) should be named "([^"]*?)"$/ do |index, filename|
-  current_email_attachments[(index.to_i - 1)].filename.should == filename
+  expect(current_email_attachments[(index.to_i - 1)].filename).to eql filename
 end
 
 Then /^there should be (an|no|\d+) attachments? of type "([^"]*?)"$/ do |amount, content_type|
-  current_email_attachments.select { |a| a.content_type.include?(content_type) }.size.should == parse_email_count(amount)
+  expect(current_email_attachments.select { |a| a.content_type.include?(content_type) }.size).to eql 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 include(content_type)
+  expect(current_email_attachments[(index.to_i - 1)].content_type).to include(content_type)
 end
 
 Then /^all attachments should not be blank$/ do
   current_email_attachments.each do |attachment|
-    attachment.read.size.should_not == 0
+    expect(attachment.read.size).to_not eql 0
   end
 end
 

data/spec/email_spec/email_viewer_spec.rb

@@ -0,0 +1,20 @@
+require 'spec_helper'
+require 'launchy'
+
+describe EmailSpec::EmailViewer do
+  describe ".open_in_browser" do
+    it "should open with launchy" do
+      expected_uri = URI("file://#{File.expand_path("a_file")}")
+      expect(Launchy).to receive(:open).with(expected_uri)
+      EmailSpec::EmailViewer.open_in_browser("a_file")
+    end
+  end
+
+  describe ".open_in_text_editor" do
+    it "should open with launchy" do
+      expected_uri = URI("file://#{File.expand_path("a_file")}")
+      expect(Launchy).to receive(:open).with(expected_uri, {application: :editor})
+      EmailSpec::EmailViewer.open_in_text_editor("a_file")
+    end
+  end
+end