hectoregm-email_spec 0.1.2

data/examples/rails_root/public/robots.txt

@@ -0,0 +1,5 @@
+# See http://www.robotstxt.org/wc/norobots.html for documentation on how to use the robots.txt file
+#
+# To ban all spiders from the entire site uncomment the next two lines:
+# User-Agent: *
+# Disallow: /

data/examples/rails_root/script/about

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+require File.dirname(__FILE__) + '/../config/boot'
+$LOAD_PATH.unshift "#{RAILTIES_PATH}/builtin/rails_info"
+require 'commands/about'

data/examples/rails_root/script/autospec

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+ENV['RSPEC'] = 'true'     # allows autotest to discover rspec
+ENV['AUTOTEST'] = 'true'  # allows autotest to run w/ color on linux
+system((RUBY_PLATFORM =~ /mswin|mingw/ ? 'autotest.bat' : 'autotest'), *ARGV) ||
+  $stderr.puts("Unable to find autotest.  Please install ZenTest or fix your PATH")

data/examples/rails_root/script/console

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+require File.dirname(__FILE__) + '/../config/boot'
+require 'commands/console'

data/examples/rails_root/script/cucumber

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+begin
+  load File.expand_path(File.dirname(__FILE__) + "/../vendor/plugins/cucumber/bin/cucumber")
+rescue LoadError
+  require "rubygems"
+  load File.join(Gem.bindir, "cucumber")
+end

data/examples/rails_root/script/dbconsole

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+require File.dirname(__FILE__) + '/../config/boot'
+require 'commands/dbconsole'

data/examples/rails_root/script/destroy

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+require File.dirname(__FILE__) + '/../config/boot'
+require 'commands/destroy'

data/examples/rails_root/script/generate

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+require File.dirname(__FILE__) + '/../config/boot'
+require 'commands/generate'

data/examples/rails_root/script/performance/benchmarker

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+require File.dirname(__FILE__) + '/../../config/boot'
+require 'commands/performance/benchmarker'

data/examples/rails_root/script/performance/profiler

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+require File.dirname(__FILE__) + '/../../config/boot'
+require 'commands/performance/profiler'

data/examples/rails_root/script/performance/request

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+require File.dirname(__FILE__) + '/../../config/boot'
+require 'commands/performance/request'

data/examples/rails_root/script/plugin

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+require File.dirname(__FILE__) + '/../config/boot'
+require 'commands/plugin'

data/examples/rails_root/script/process/inspector

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+require File.dirname(__FILE__) + '/../../config/boot'
+require 'commands/process/inspector'

data/examples/rails_root/script/process/reaper

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+require File.dirname(__FILE__) + '/../../config/boot'
+require 'commands/process/reaper'

data/examples/rails_root/script/process/spawner

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+require File.dirname(__FILE__) + '/../../config/boot'
+require 'commands/process/spawner'

data/examples/rails_root/script/runner

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+require File.dirname(__FILE__) + '/../config/boot'
+require 'commands/runner'

data/examples/rails_root/script/server

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+require File.dirname(__FILE__) + '/../config/boot'
+require 'commands/server'

data/examples/rails_root/script/spec

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+$LOAD_PATH.unshift(File.expand_path(File.dirname(__FILE__) + "/../vendor/plugins/rspec/lib"))
+require 'rubygems'
+require 'spec'
+exit ::Spec::Runner::CommandLine.run(::Spec::Runner::OptionParser.parse(ARGV, STDERR, STDOUT))

data/examples/rails_root/script/spec_server

@@ -0,0 +1,125 @@
+#!/usr/bin/env ruby
+$LOAD_PATH.unshift File.dirname(__FILE__) + '/../vendor/plugins/rspec/lib' # For rspec installed as plugin
+require 'rubygems'
+require 'drb/drb'
+require 'rbconfig'
+require 'spec'
+require 'optparse'
+
+# This is based on Florian Weber's TDDMate
+module Spec
+  module Runner
+    class RailsSpecServer
+      def run(argv, stderr, stdout)
+        $stdout = stdout
+        $stderr = stderr
+        
+        unless ActiveRecord::Base.respond_to?(:clear_reloadable_connections!)
+          base = ActiveRecord::Base
+          def base.clear_reloadable_connections!
+            active_connections.each do |name, conn|
+              if conn.requires_reloading?
+                conn.disconnect!
+                active_connections.delete(name)
+              end
+            end
+          end
+        end
+
+        ActiveRecord::Base.clear_reloadable_connections!
+
+        if ActionController.const_defined?(:Dispatcher)
+          dispatcher = ::ActionController::Dispatcher.new($stdout)
+          dispatcher.cleanup_application
+        elsif ::Dispatcher.respond_to?(:reset_application!)
+          ::Dispatcher.reset_application!
+        else
+          raise "Application reloading failed"
+        end
+        if Object.const_defined?(:Fixtures) && Fixtures.respond_to?(:reset_cache)
+          Fixtures.reset_cache
+        end
+        
+        if ::ActiveSupport.const_defined?(:Dependencies)
+          ::ActiveSupport::Dependencies.mechanism = :load
+        else
+          ::Dependencies.mechanism = :load
+        end
+
+        require_dependency('application.rb') unless Object.const_defined?(:ApplicationController)
+        load File.dirname(__FILE__) + '/../spec/spec_helper.rb'
+
+        if in_memory_database?
+          load "#{RAILS_ROOT}/db/schema.rb" # use db agnostic schema by default
+          ActiveRecord::Migrator.up('db/migrate') # use migrations
+        end
+
+        ::Spec::Runner::CommandLine.run(
+          ::Spec::Runner::OptionParser.parse(
+            argv,
+            $stderr,
+            $stdout
+          )
+        )
+      end
+
+      def in_memory_database?
+        ENV["RAILS_ENV"] == "test" and
+        ::ActiveRecord::Base.connection.class.to_s == "ActiveRecord::ConnectionAdapters::SQLite3Adapter" and
+        ::Rails::Configuration.new.database_configuration['test']['database'] == ':memory:'
+      end
+    end
+  end
+end
+puts "Loading Rails environment"
+
+ENV["RAILS_ENV"] = "test"
+require File.expand_path(File.dirname(__FILE__) + "/../config/environment")
+require 'dispatcher'
+
+def restart_test_server
+  puts "restarting"
+  config       = ::Config::CONFIG
+  ruby         = File::join(config['bindir'], config['ruby_install_name']) + config['EXEEXT']
+  command_line = [ruby, $0, ARGV].flatten.join(' ')
+  exec(command_line)
+end
+
+def daemonize(pid_file = nil)
+  return yield if $DEBUG
+  pid = Process.fork{
+    Process.setsid
+    Dir.chdir(RAILS_ROOT)
+    trap("SIGINT"){ exit! 0 }
+    trap("SIGTERM"){ exit! 0 }
+    trap("SIGHUP"){ restart_test_server }
+    File.open("/dev/null"){|f|
+      STDERR.reopen f
+      STDIN.reopen  f
+      STDOUT.reopen f
+    }
+    yield
+  }
+  puts "spec_server launched. (PID: %d)" % pid
+  File.open(pid_file,"w"){|f| f.puts pid } if pid_file
+  exit! 0
+end
+
+options = Hash.new
+opts = OptionParser.new
+opts.on("-d", "--daemon"){|v| options[:daemon] = true }
+opts.on("-p", "--pid PIDFILE"){|v| options[:pid] = v }
+opts.parse!(ARGV)
+
+puts "Ready"
+exec_server = lambda {
+  trap("USR2") { restart_test_server } if Signal.list.has_key?("USR2")
+  DRb.start_service("druby://127.0.0.1:8989", Spec::Runner::RailsSpecServer.new)
+  DRb.thread.join
+}
+
+if options[:daemon]
+  daemonize(options[:pid], &exec_server)
+else
+  exec_server.call
+end

data/examples/rails_root/spec/controllers/welcome_controller_spec.rb

@@ -0,0 +1,15 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe WelcomeController do
+
+  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
+
+end

data/examples/rails_root/spec/model_factory.rb

@@ -0,0 +1,6 @@
+require 'fixjour'
+
+Fixjour do
+  define_builder(User, :name => "Jojo Binks", :email => "jojo@thebinks.com")
+end
+

data/examples/rails_root/spec/models/user_mailer_spec.rb

@@ -0,0 +1,58 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+
+# These two example groups are specifying the exact same behavior.  However, the documentation style is different
+# and the value that each one provides is different with various trade-offs.  Run these examples with the specdoc 
+# formatter to get an idea of how they differ.
+
+# Example of documenting the behaviour explicitly and expressing the intent in the example's sentence.
+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
+
+  subject { @email }
+  
+  it "should be delivered to the email passed in" do
+    should deliver_to("jojo@yahoo.com")
+  end
+  
+  it "should contain the user's name in the mail body" do
+    @email.should have_body_text(/Jojo Binks/)
+  end
+
+  it "should contain a link to the confirmation page" do
+    @email.should have_body_text(/#{confirm_account_url}/)
+  end
+  
+  it { should have_subject(/Account confirmation/) }
+  
+  
+end
+
+# In this example group more of the documentation is placed in the context trying to allow for more concise specs.
+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
+
+  subject { @email }
+
+  it { should have_body_text(/#{confirm_account_url}/) }
+  it { should have_subject(/Account confirmation/) }
+
+  describe "sent with email address of 'jojo@yahoo.com', and users name 'Jojo Binks'" do
+    subject { @email }
+    it { should deliver_to("jojo@yahoo.com") }
+    it { should have_body_text(/Jojo Binks/) }
+  end
+  
+  
+end

data/examples/rails_root/spec/models/user_spec.rb

@@ -0,0 +1,5 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe User do
+
+end

data/examples/rails_root/spec/rcov.opts

@@ -0,0 +1,2 @@
+--exclude "spec/*,gems/*" 
+--rails

data/examples/rails_root/spec/spec.opts

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

data/examples/rails_root/spec/spec_helper.rb

@@ -0,0 +1,51 @@
+# This file is copied to ~/spec when you run 'ruby script/generate rspec'
+# from the project root directory.
+ENV["RAILS_ENV"] = "test"
+require File.expand_path(File.dirname(__FILE__) + "/../config/environment")
+require 'spec'
+require 'spec/rails'
+
+require File.expand_path(File.dirname(__FILE__) + "/model_factory.rb")
+require (Rails.root + '/../../lib/email_spec.rb')
+
+Spec::Runner.configure do |config|
+  config.include(Fixjour)
+  # If you're not using ActiveRecord you should remove these
+  # lines, delete config/database.yml and disable :active_record
+  # in your config/boot.rb
+  #config.use_transactional_fixtures = true
+  #config.use_instantiated_fixtures  = false
+  #config.fixture_path = RAILS_ROOT + '/spec/fixtures/'
+
+  # == Fixtures
+  #
+  # You can declare fixtures for each example_group like this:
+  #   describe "...." do
+  #     fixtures :table_a, :table_b
+  #
+  # Alternatively, if you prefer to declare them only once, you can
+  # do so right here. Just uncomment the next line and replace the fixture
+  # names with your fixtures.
+  #
+  # config.global_fixtures = :table_a, :table_b
+  #
+  # If you declare global fixtures, be aware that they will be declared
+  # for all of your examples, even those that don't use them.
+  #
+  # You can also declare which fixtures to use (for example fixtures for test/fixtures):
+  #
+  # config.fixture_path = RAILS_ROOT + '/spec/fixtures/'
+  #
+  # == Mock Framework
+  #
+  # RSpec uses it's own mocking framework by default. If you prefer to
+  # use mocha, flexmock or RR, uncomment the appropriate line:
+  #
+  # config.mock_with :mocha
+  # config.mock_with :flexmock
+  # config.mock_with :rr
+  #
+  # == Notes
+  # 
+  # For more information take a look at Spec::Runner::Configuration and Spec::Runner
+end

data/examples/rails_root/stories/all.rb

@@ -0,0 +1,4 @@
+dir = File.dirname(__FILE__)
+Dir[File.expand_path("#{dir}/**/*.rb")].uniq.each do |file|
+  require file
+end

data/examples/rails_root/stories/helper.rb

@@ -0,0 +1,3 @@
+ENV["RAILS_ENV"] = "test"
+require File.expand_path(File.dirname(__FILE__) + "/../config/environment")
+require 'spec/rails/story_adapter'

data/examples/rails_root/vendor/plugins/email_spec/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/examples/rails_root/vendor/plugins/email_spec/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 /^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 /^"([^']*?)" should receive (\d+) emails?$/ do |address, n|
+  unread_emails_for(address).size.should == n.to_i 
+end
+
+Then /^"([^']*?)" should have (\d+) emails?$/ do |address, n|
+  mailbox_for(address).size.should == n.to_i
+end
+
+Then /^"([^']*?)" should not receive an email$/ do |address|
+  find_email(address).should be_nil
+end
+
+Then /^I should see "(.*)" in the subject$/ do |text|
+  current_email.should have_subject(Regexp.new(text))
+end
+
+Then /^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/lib/email_spec/address_converter.rb

@@ -0,0 +1,27 @@
+module EmailSpec
+  class AddressConverter
+    include Singleton
+  
+    attr_accessor :converter
+  
+    # The block provided to conversion should convert to an email
+    # address string or return the input untouched. For example:
+    #
+    #  EmailSpec::AddressConverter.instance.conversion do |input|
+    #   if input.is_a?(User)
+    #     input.email
+    #   else
+    #     input
+    #   end
+    #  end
+    #    
+    def conversion(&block)
+      self.converter = block
+    end
+  
+    def convert(input)
+      return input unless converter
+      converter.call(input)
+    end
+  end
+end

data/lib/email_spec/cucumber.rb

@@ -0,0 +1,19 @@
+# require this in your env.rb file after you require cucumber/rails/world
+
+# Global Setup
+ActionMailer::Base.delivery_method = :test unless ActionMailer::Base.delivery_method == :activerecord
+ActionMailer::Base.perform_deliveries = true
+
+Before do
+  # Scenario setup
+  ActionMailer::Base.deliveries.clear if ActionMailer::Base.delivery_method == :test
+end
+
+After do
+  EmailSpec::EmailViewer.save_and_open_all_raw_emails if ENV['SHOW_EMAILS']
+  EmailSpec::EmailViewer.save_and_open_all_html_emails if ENV['SHOW_HTML_EMAILS']
+  EmailSpec::EmailViewer.save_and_open_all_text_emails if ENV['SHOW_TEXT_EMAILS']
+end
+
+World(EmailSpec::Helpers)
+World(EmailSpec::Matchers)

data/lib/email_spec/deliveries.rb

@@ -0,0 +1,55 @@
+module EmailSpec
+  module TestDeliveries
+    def all_emails
+      ActionMailer::Base.deliveries
+    end
+    
+    def last_email_sent
+      ActionMailer::Base.deliveries.last || raise("No email has been sent!")
+    end
+
+    def reset_mailer
+      ActionMailer::Base.deliveries.clear
+    end
+    
+    def mailbox_for(address)
+      address = AddressConverter.instance.convert(address)
+      ActionMailer::Base.deliveries.select { |m| m.to.include?(address) }
+    end
+  end
+  
+  module ARMailerDeliveries
+    def all_emails
+      Email.all.map{ |email| parse_to_tmail(email) }
+    end
+    
+    def last_email_sent
+      if email = Email.last
+        TMail::Mail.parse(email.mail)
+      else
+        raise("No email has been sent!")
+      end
+    end
+
+    def reset_mailer
+      Email.delete_all
+    end
+    
+    def mailbox_for(address)
+      address = AddressConverter.instance.convert(address)
+      Email.all.select { |email| email.to.include?(address) }.map{ |email| parse_to_tmail(email) }
+    end
+    
+    def parse_to_tmail(email)
+      TMail::Mail.parse(email.mail)
+    end    
+  end
+  
+  module Deliveries
+    if ActionMailer::Base.delivery_method == :activerecord
+      include EmailSpec::ARMailerDeliveries
+    else
+      include EmailSpec::TestDeliveries
+    end    
+  end
+end

data/lib/email_spec/email_viewer.rb

@@ -0,0 +1,70 @@
+module EmailSpec
+  class EmailViewer
+    extend Deliveries
+    
+    def self.save_and_open_all_raw_emails
+      filename = "#{RAILS_ROOT}/tmp/email-#{Time.now.to_i}.txt"
+
+      File.open(filename, "w") do |f|
+        all_emails.each do |m|
+          f.write m.to_s
+          f.write "\n" + '='*80 + "\n"
+        end
+      end
+
+      open_in_text_editor(filename)
+    end
+
+    def self.save_and_open_all_html_emails
+      all_emails.each_with_index do |m, index|
+        if m.multipart? && html_part = m.parts.detect{ |p| p.content_type == 'text/html' }
+          filename = tmp_email_filename("-#{index}.html")
+          File.open(filename, "w") do |f|
+            f.write m.parts[1].body
+          end
+          open_in_browser(filename)
+        end
+      end
+    end
+
+    def self.save_and_open_all_text_emails
+      filename = tmp_email_filename
+
+      File.open(filename, "w") do |f|
+        all_emails.each do |m|
+          if m.multipart? && text_part = m.parts.detect{ |p| p.content_type == 'text/plain' }
+            m.ordered_each{|k,v| f.write "#{k}: #{v}\n" }
+            f.write text_part.body
+          else
+            f.write m.to_s
+          end
+          f.write "\n" + '='*80 + "\n"
+        end
+      end
+
+      open_in_text_editor(filename)
+    end
+  
+    def self.save_and_open_email(mail)
+      filename = "#{RAILS_ROOT}/tmp/email-#{Time.now.to_i}.txt"
+
+      File.open(filename, "w") do |f|
+        f.write mail.to_s
+      end
+
+      open_in_text_editor(filename)
+    end
+    
+    def self.open_in_text_editor(filename)
+      `mate #{filename}`
+    end
+    
+    def self.open_in_browser(filename)
+      `open #{filename}`
+    end
+    
+    def self.tmp_email_filename(extension = '.txt')
+      "#{RAILS_ROOT}/tmp/email-#{Time.now.to_i}#{extension}"
+    end
+  end
+end