bmabey-email_spec 0.0.5 → 0.0.6

data/History.txt

@@ -1,4 +1,12 @@
-== 0.0.1 2008-12-18
+(In Git)                                                                                                                                                                                                
+ === New features
 
-* 1 major enhancement:
-  * Initial release
+
+== 0.0.6 2008-12-23
+ === New features
+  * Improved RSpec documentaioni 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 contributos: http://www.benmabey.com/2008/12/18/github-rocks/

data/README.rdoc

@@ -31,14 +31,28 @@ Then:
 This will give you a bunch of steps to get started with in step_definitions/email_steps.rb
 
 === RSpec
-	
-The matchers and helpers should be available for your specs by default, but you need to include them into the example groups you want to use them in.  To include them in all of your specs you can do this in your spec_helper.rb:
+
+	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
@@ -55,12 +69,59 @@ The matchers and helpers should be available for your specs by default, but you
 
 For more examples, check out spec/rails_root in the source for a small example app that implements these steps.
 
-== TODO:
-
-- refactor!
-- provide custom matchers to give better messages
+=== RSpec
 
-== Authors
+  ==== 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.body.should have_text(/Jojo Binks/)
+      end
+
+      it "should contain a link to the confirmation link" do
+        @email.body.should have_text(/#{confirm_account_url}/)
+      end
+      
+      it "should have the correct subject" do
+        @email.subject.should =~ /Account confirmation/
+      end
+      
+    end
+     
+    ==== Using the helpers when not testing in isolation ==== 
+
+      WRITE ME
+      For now take a look at Email::Helpers to see what you can do.
+
+== Original Authors
 
 Ben Mabey, Aaron Gibralter, Mischa Fierer
 
+Please see History.txt for upcoming changsets and other contributors.
+

data/Rakefile

@@ -6,7 +6,7 @@ spec = Gem::Specification.new do |s|
   s.version      = EmailSpec::VERSION
   s.platform     = Gem::Platform::RUBY
   s.authors      = ['Ben Mabrey', 'Aaron Gibralter', 'Mischa Fierer']
-  s.email        = "f.mischa@gmail.com"
+  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"
@@ -50,7 +50,7 @@ task :generate do
 end
 
 task :features => [:generate] do
-  system("cd spec/rails_root; rake features; cd ../..")
+  system("cucumber spec/rails_root/features")
 end
 
 task :default => :features

data/lib/email_spec.rb

@@ -1,3 +1,3 @@
 module EmailSpec
-  VERSION = '0.0.5'
+  VERSION = '0.0.6'
 end

data/lib/email_spec/cucumber.rb

@@ -1,7 +1,7 @@
 # require this in your env.rb file after you require cucumber/rails/world
 
 %w[helpers matchers].each do |file|
-  require File.join(File.dirname(__FILE__), "email_spec_#{file}.rb")
+  require File.join(File.dirname(__FILE__), file)
 end
 
 # Global Setup

data/lib/email_spec/{email_spec_helpers.rb → helpers.rb}

@@ -3,21 +3,12 @@ require 'uri'
 module EmailSpec
 
   module Helpers
-
-    def self.extended(base)
-      base.instance_eval do
-        @email_spec_hash = {}
-        @email_spec_hash[:read_emails] = {}
-        @email_spec_hash[:unread_emails] = {}
-        @email_spec_hash[:current_emails] = {}
-        @email_spec_hash[:current_email] = nil
-      end
-    end
     
     def reset_mailer
       ActionMailer::Base.deliveries.clear
     end
 
+
     def visit_in_email(link_text)
       visit(parse_email_for_link(current_email, link_text))
     end
@@ -35,7 +26,7 @@ module EmailSpec
     end
     
     def current_email(address=nil)
-      email = address ? @email_spec_hash[:current_emails][address] : @email_spec_hash[:current_email]
+      email = address ? email_spec_hash[:current_emails][address] : email_spec_hash[:current_email]
       raise Spec::Expectations::ExpectationNotMetError, "Expected an open email but none was found. Did you forget to call open_email?" unless email  
       email
     end
@@ -45,7 +36,7 @@ module EmailSpec
     end
     
     def read_emails_for(address)
-      @email_spec_hash[:read_emails][address] ||= []
+      email_spec_hash[:read_emails][address] ||= []
     end
     
     def mailbox_for(address)
@@ -63,6 +54,10 @@ module EmailSpec
     end
 
     private
+
+    def email_spec_hash
+      @email_spec_hash ||= {:read_emails => {}, :unread_emails => {}, :current_emails => {}, :current_email => nil}
+    end
 	
     def find_email!(address, opts={})
       email = find_email(address, opts)
@@ -76,8 +71,8 @@ module EmailSpec
     def set_current_email(email)
       return unless email
       read_emails_for(email.to) << email      
-      @email_spec_hash[:current_emails][email.to] = email
-      @email_spec_hash[:current_email] = email
+      email_spec_hash[:current_emails][email.to] = email
+      email_spec_hash[:current_email] = email
     end
     
     def parse_email_for_link(email, link_text)

data/spec/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/spec/rails_root/spec/models/user_mailer_spec.rb

@@ -0,0 +1,30 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+
+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.body.should have_text(/Jojo Binks/)
+  end
+
+  it "should contain a link to the confirmation link" do
+    @email.body.should have_text(/#{confirm_account_url}/)
+  end
+  
+  it "should have the correct subject" do
+    @email.subject.should =~ /Account confirmation/
+  end
+  
+  
+end
+

data/spec/rails_root/spec/spec_helper.rb

@@ -5,6 +5,9 @@ require File.expand_path(File.dirname(__FILE__) + "/../config/environment")
 require 'spec'
 require 'spec/rails'
 
+require File.expand_path(File.dirname(__FILE__) + '/../../../lib/email_spec/helpers.rb')
+require File.expand_path(File.dirname(__FILE__) + '/../../../lib/email_spec/matchers.rb')
+
 Spec::Runner.configure do |config|
   # If you're not using ActiveRecord you should remove these
   # lines, delete config/database.yml and disable :active_record

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: bmabey-email_spec
 version: !ruby/object:Gem::Version 
-  version: 0.0.5
+  version: 0.0.6
 platform: ruby
 authors: 
 - Ben Mabrey
@@ -11,12 +11,12 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-12-18 00:00:00 -08:00
+date: 2008-12-23 00:00:00 -08:00
 default_executable: 
 dependencies: []
 
 description: Easily test email in rspec and cucumber
-email: f.mischa@gmail.com
+email: ben@benmabey.com
 executables: []
 
 extensions: []
@@ -32,8 +32,8 @@ files:
 - Rakefile
 - lib/email_spec
 - lib/email_spec/cucumber.rb
-- lib/email_spec/email_spec_helpers.rb
-- lib/email_spec/email_spec_matchers.rb
+- lib/email_spec/helpers.rb
+- lib/email_spec/matchers.rb
 - lib/email_spec.rb
 - generators/email_spec
 - generators/email_spec/email_spec_generator.rb
@@ -86,8 +86,6 @@ files:
 - spec/rails_root/features/support/env.rb
 - spec/rails_root/lib
 - spec/rails_root/lib/tasks
-- spec/rails_root/lib/tasks/cucumber.rake
-- spec/rails_root/lib/tasks/rspec.rake
 - spec/rails_root/log
 - spec/rails_root/log/development.log
 - spec/rails_root/log/test.log
@@ -129,6 +127,10 @@ files:
 - spec/rails_root/script/spec
 - spec/rails_root/script/spec_server
 - spec/rails_root/spec
+- spec/rails_root/spec/controllers
+- spec/rails_root/spec/controllers/welcome_controller_spec.rb
+- spec/rails_root/spec/models
+- spec/rails_root/spec/models/user_mailer_spec.rb
 - spec/rails_root/spec/rcov.opts
 - spec/rails_root/spec/spec.opts
 - spec/rails_root/spec/spec_helper.rb

data/spec/rails_root/lib/tasks/cucumber.rake

@@ -1,7 +0,0 @@
-$:.unshift(RAILS_ROOT + '/vendor/plugins/cucumber/lib')
-require 'cucumber/rake/task'
-
-Cucumber::Rake::Task.new(:features) do |t|
-  t.cucumber_opts = "--format pretty"
-end
-task :features => 'db:test:prepare'

data/spec/rails_root/lib/tasks/rspec.rake

@@ -1,153 +0,0 @@
-raise "To avoid rake task loading problems: run 'rake clobber' in vendor/plugins/rspec" if File.directory?(File.join(File.dirname(__FILE__), *%w[.. .. vendor plugins rspec pkg]))
-raise "To avoid rake task loading problems: run 'rake clobber' in vendor/plugins/rspec-rails" if File.directory?(File.join(File.dirname(__FILE__), *%w[.. .. vendor plugins rspec-rails pkg]))
-
-# In rails 1.2, plugins aren't available in the path until they're loaded.
-# Check to see if the rspec plugin is installed first and require
-# it if it is.  If not, use the gem version.
-rspec_base = File.expand_path(File.dirname(__FILE__) + '/../../vendor/plugins/rspec/lib')
-$LOAD_PATH.unshift(rspec_base) if File.exist?(rspec_base)
-
-begin
-  require 'spec/rake/spectask'
-  Rake.application.instance_variable_get('@tasks').delete('default')
-
-  spec_prereq = File.exist?(File.join(RAILS_ROOT, 'config', 'database.yml')) ? "db:test:prepare" : :noop
-  task :noop do
-  end
-
-  task :default => :spec
-  task :stats => "spec:statsetup"
-
-  desc "Run all specs in spec directory (excluding plugin specs)"
-  Spec::Rake::SpecTask.new(:spec => spec_prereq) do |t|
-    t.spec_opts = ['--options', "\"#{RAILS_ROOT}/spec/spec.opts\""]
-    t.spec_files = FileList['spec/**/*/*_spec.rb']
-  end
-
-  namespace :spec do
-    desc "Run all specs in spec directory with RCov (excluding plugin specs)"
-    Spec::Rake::SpecTask.new(:rcov) do |t|
-      t.spec_opts = ['--options', "\"#{RAILS_ROOT}/spec/spec.opts\""]
-      t.spec_files = FileList['spec/**/*/*_spec.rb']
-      t.rcov = true
-      t.rcov_opts = lambda do
-        IO.readlines("#{RAILS_ROOT}/spec/rcov.opts").map {|l| l.chomp.split " "}.flatten
-      end
-    end
-
-    desc "Print Specdoc for all specs (excluding plugin specs)"
-    Spec::Rake::SpecTask.new(:doc) do |t|
-      t.spec_opts = ["--format", "specdoc", "--dry-run"]
-      t.spec_files = FileList['spec/**/*/*_spec.rb']
-    end
-
-    desc "Print Specdoc for all plugin examples"
-    Spec::Rake::SpecTask.new(:plugin_doc) do |t|
-      t.spec_opts = ["--format", "specdoc", "--dry-run"]
-      t.spec_files = FileList['vendor/plugins/**/spec/**/*/*_spec.rb'].exclude('vendor/plugins/rspec/*')
-    end
-
-    [:models, :controllers, :views, :helpers, :lib].each do |sub|
-      desc "Run the code examples in spec/#{sub}"
-      Spec::Rake::SpecTask.new(sub => spec_prereq) do |t|
-        t.spec_opts = ['--options', "\"#{RAILS_ROOT}/spec/spec.opts\""]
-        t.spec_files = FileList["spec/#{sub}/**/*_spec.rb"]
-      end
-    end
-
-    desc "Run the code examples in vendor/plugins (except RSpec's own)"
-    Spec::Rake::SpecTask.new(:plugins => spec_prereq) do |t|
-      t.spec_opts = ['--options', "\"#{RAILS_ROOT}/spec/spec.opts\""]
-      t.spec_files = FileList['vendor/plugins/**/spec/**/*/*_spec.rb'].exclude('vendor/plugins/rspec/*').exclude("vendor/plugins/rspec-rails/*")
-    end
-
-    namespace :plugins do
-      desc "Runs the examples for rspec_on_rails"
-      Spec::Rake::SpecTask.new(:rspec_on_rails) do |t|
-        t.spec_opts = ['--options', "\"#{RAILS_ROOT}/spec/spec.opts\""]
-        t.spec_files = FileList['vendor/plugins/rspec-rails/spec/**/*/*_spec.rb']
-      end
-    end
-
-    # Setup specs for stats
-    task :statsetup do
-      require 'code_statistics'
-      ::STATS_DIRECTORIES << %w(Model\ specs spec/models) if File.exist?('spec/models')
-      ::STATS_DIRECTORIES << %w(View\ specs spec/views) if File.exist?('spec/views')
-      ::STATS_DIRECTORIES << %w(Controller\ specs spec/controllers) if File.exist?('spec/controllers')
-      ::STATS_DIRECTORIES << %w(Helper\ specs spec/helpers) if File.exist?('spec/helpers')
-      ::STATS_DIRECTORIES << %w(Library\ specs spec/lib) if File.exist?('spec/lib')
-      ::CodeStatistics::TEST_TYPES << "Model specs" if File.exist?('spec/models')
-      ::CodeStatistics::TEST_TYPES << "View specs" if File.exist?('spec/views')
-      ::CodeStatistics::TEST_TYPES << "Controller specs" if File.exist?('spec/controllers')
-      ::CodeStatistics::TEST_TYPES << "Helper specs" if File.exist?('spec/helpers')
-      ::CodeStatistics::TEST_TYPES << "Library specs" if File.exist?('spec/lib')
-      ::STATS_DIRECTORIES.delete_if {|a| a[0] =~ /test/}
-    end
-
-    namespace :db do
-      namespace :fixtures do
-        desc "Load fixtures (from spec/fixtures) into the current environment's database.  Load specific fixtures using FIXTURES=x,y"
-        task :load => :environment do
-          require 'active_record/fixtures'
-          ActiveRecord::Base.establish_connection(RAILS_ENV.to_sym)
-          (ENV['FIXTURES'] ? ENV['FIXTURES'].split(/,/) : Dir.glob(File.join(RAILS_ROOT, 'spec', 'fixtures', '*.{yml,csv}'))).each do |fixture_file|
-            Fixtures.create_fixtures('spec/fixtures', File.basename(fixture_file, '.*'))
-          end
-        end
-      end
-    end
-
-    namespace :server do
-      daemonized_server_pid = File.expand_path("spec_server.pid", RAILS_ROOT + "/tmp")
-
-      desc "start spec_server."
-      task :start do
-        if File.exist?(daemonized_server_pid)
-          $stderr.puts "spec_server is already running."
-        else
-          $stderr.puts "Starting up spec server."
-          system("ruby", "script/spec_server", "--daemon", "--pid", daemonized_server_pid)
-        end
-      end
-
-      desc "stop spec_server."
-      task :stop do
-        unless File.exist?(daemonized_server_pid)
-          $stderr.puts "No server running."
-        else
-          $stderr.puts "Shutting down spec_server."
-          system("kill", "-s", "TERM", File.read(daemonized_server_pid).strip) && 
-          File.delete(daemonized_server_pid)
-        end
-      end
-
-      desc "reload spec_server."
-      task :restart do
-        unless File.exist?(daemonized_server_pid)
-          $stderr.puts "No server running."
-        else
-          $stderr.puts "Reloading down spec_server."
-          system("kill", "-s", "USR2", File.read(daemonized_server_pid).strip)
-        end
-      end
-    end
-  end
-rescue MissingSourceFile
-  # if rspec-rails is a configured gem, this will output helpful material and exit ...
-  require File.expand_path(File.dirname(__FILE__) + "/../../config/environment")
-
-  # ... otherwise, do this:
-  raise <<-MSG
-
-  You have rspec-rails rake tasks installed in
-  #{__FILE__},
-  but rspec-rails is not configured as a gem in
-  config/environment.rb
-
-  Either remove #{__FILE__}
-  or configure the rspec-rails gem in config/environment.rb.
-
-MSG
-end
-