thoughtbot-shoulda 2.10.2 → 2.11.1

data/lib/shoulda/{rspec.rb → integrations/rspec.rb}

@@ -1,5 +1,6 @@
 require 'shoulda/active_record/matchers'
 require 'shoulda/action_controller/matchers'
+require 'shoulda/action_mailer/matchers'
 require 'active_support/test_case'
 
 # :enddoc:
@@ -7,5 +8,6 @@ module ActiveSupport
   class TestCase
     include Shoulda::ActiveRecord::Matchers
     include Shoulda::ActionController::Matchers
+    include Shoulda::ActionMailer::Matchers
   end
 end

data/lib/shoulda/integrations/rspec2.rb

@@ -0,0 +1,22 @@
+require 'shoulda/active_record/matchers'
+require 'shoulda/action_controller/matchers'
+require 'shoulda/action_mailer/matchers'
+
+# :enddoc:
+
+module RSpec
+  module Matchers
+    include Shoulda::ActiveRecord::Matchers
+  end
+
+  module Rails
+    module ControllerExampleGroup
+      include Shoulda::ActionController::Matchers
+    end
+
+    module MailerExampleGroup
+      include Shoulda::ActionMailer::Matchers
+    end
+  end
+end
+

data/lib/shoulda/macros.rb

@@ -2,6 +2,8 @@ require 'shoulda/private_helpers'
 
 module Shoulda # :nodoc:
   module Macros
+    # Deprecated.
+    #
     # Macro that creates a test asserting a change between the return value
     # of a block that is run before and after the current setup block
     # is run. This is similar to Active Support's <tt>assert_difference</tt>
@@ -34,24 +36,33 @@ module Shoulda # :nodoc:
     #
     #   # Assert the value changed to "new:"
     #   should_change("the post title", :to => "new") { @post.title }
+    #
+    # This macro was deprecated because these tests aren't as valuable as
+    # alternative tests that explicitly test the final state.
+    #
+    # Consider an alternative:
+    #
+    #   context "updating a post" do
+    #     setup do
+    #       @post = Post.create(:title => "old")
+    #       put :update, :post => {:title => "new"}, :id => @post.to_param
+    #     end
+    #     should "update the title" do
+    #       assert_equal "new", @post.reload.title
+    #     end
+    #   end
     def should_change(description, options = {}, &block)
+      ::ActiveSupport::Deprecation.warn("Not considered a useful test. Instead, test the end state explicitly.")
       by, from, to = get_options!([options], :by, :from, :to)
       stmt = "change #{description}"
       stmt << " from #{from.inspect}" if from
       stmt << " to #{to.inspect}" if to
       stmt << " by #{by.inspect}" if by
 
-      if block_given?
-        code = block
-      else
-        warn "[DEPRECATION] should_change(expression, options) is deprecated. " <<
-             "Use should_change(description, options) { code } instead."
-        code = lambda { eval(description) }
-      end
-      before = lambda { @_before_should_change = code.bind(self).call }
+      before = lambda { @_before_should_change = block.bind(self).call }
       should stmt, :before => before do
         old_value = @_before_should_change
-        new_value = code.bind(self).call
+        new_value = block.bind(self).call
         assert_operator from, :===, old_value, "#{description} did not originally match #{from.inspect}" if from
         assert_not_equal old_value, new_value, "#{description} did not change" unless by == 0
         assert_operator to, :===, new_value, "#{description} was not changed to match #{to.inspect}" if to
@@ -59,6 +70,8 @@ module Shoulda # :nodoc:
       end
     end
 
+    # Deprecated.
+    #
     # Macro that creates a test asserting no change between the return value
     # of a block that is run before and after the current setup block
     # is run. This is the logical opposite of should_change.
@@ -71,21 +84,32 @@ module Shoulda # :nodoc:
     #     setup { @post.update_attributes(:title => "new") }
     #     should_not_change("the number of posts") { Post.count }
     #   end
+    #
+    # This macro was deprecated because these tests aren't as valuable as
+    # alternative tests that explicitly test the final state.
+    #
+    # Consider an alternative:
+    #
+    #   context "updating a post" do
+    #     setup do
+    #       @post = Post.create(:title => "old")
+    #       put :update, :post => {:title => ""}, :id => @post.to_param
+    #     end
+    #     should "not update the title" do
+    #       assert_equal "old", @post.reload.title
+    #     end
+    #   end
     def should_not_change(description, &block)
-      if block_given?
-        code = block
-      else
-        warn "[DEPRECATION] should_not_change(expression) is deprecated. " <<
-             "Use should_not_change(description) { code } instead."
-        code = lambda { eval(description) }
-      end
-      before = lambda { @_before_should_not_change = code.bind(self).call }
+      ::ActiveSupport::Deprecation.warn("Not considered a useful test. Instead, test the end state explicitly.")
+      before = lambda { @_before_should_not_change = block.bind(self).call }
       should "not change #{description}", :before => before do
-        new_value = code.bind(self).call
+        new_value = block.bind(self).call
         assert_equal @_before_should_not_change, new_value, "#{description} changed"
       end
     end
 
+    # Deprecated.
+    #
     # Macro that creates a test asserting that a record of the given class was
     # created.
     #
@@ -96,9 +120,12 @@ module Shoulda # :nodoc:
     #     should_create :post
     #   end
     def should_create(class_name)
+      ::ActiveSupport::Deprecation.warn
       should_change_record_count_of(class_name, 1, 'create')
     end
 
+    # Deprecated.
+    #
     # Macro that creates a test asserting that a record of the given class was
     # destroyed.
     #
@@ -109,6 +136,7 @@ module Shoulda # :nodoc:
     #     should_destroy :post
     #   end
     def should_destroy(class_name)
+      ::ActiveSupport::Deprecation.warn
       should_change_record_count_of(class_name, -1, 'destroy')
     end
 

data/lib/shoulda/rails.rb

@@ -4,10 +4,5 @@ require 'shoulda'
 
 require 'shoulda/active_record'     if defined? ActiveRecord::Base
 require 'shoulda/action_controller' if defined? ActionController::Base
-require 'shoulda/action_view'       if defined? ActionView::Base
 require 'shoulda/action_mailer'     if defined? ActionMailer::Base
 
-if defined?(RAILS_ROOT)
-  # load in the 3rd party macros from vendorized plugins and gems
-  Shoulda.autoload_macros RAILS_ROOT, File.join("vendor", "{plugins,gems}", "*")
-end

data/lib/shoulda/tasks/yaml_to_shoulda.rake

@@ -1,28 +1,28 @@
 namespace :shoulda do
   # From http://blog.internautdesign.com/2007/11/2/a-yaml_to_shoulda-rake-task
   # David.Lowenfels@gmail.com
-  desc "Converts a YAML file (FILE=./path/to/yaml) into a Shoulda skeleton" 
+  desc "Converts a YAML file (FILE=./path/to/yaml) into a Shoulda skeleton"
   task :from_yaml do
     require 'yaml'
-    
+
     def yaml_to_context(hash, indent = 0)
       indent1 = '  ' * indent
       indent2 = '  ' * (indent + 1)
       hash.each_pair do |context, shoulds|
-        puts indent1 + "context \"#{context}\" do" 
-        puts    
+        puts indent1 + "context \"#{context}\" do"
+        puts
         shoulds.each do |should|
           yaml_to_context( should, indent + 1 ) and next if should.is_a?( Hash )
-          puts indent2 + "should_eventually \"" + should.gsub(/^should +/,'') + "\" do" 
-          puts indent2 + "end" 
+          puts indent2 + "should_eventually \"" + should.gsub(/^should +/,'') + "\" do"
+          puts indent2 + "end"
           puts
         end
-        puts indent1 + "end" 
+        puts indent1 + "end"
       end
-    end 
-    
+    end
+
     puts("Please pass in a FILE argument.") and exit unless ENV['FILE']
-      
+
     yaml_to_context( YAML.load_file( ENV['FILE'] ) )
   end
-end
+end

data/lib/shoulda/version.rb

@@ -0,0 +1,4 @@
+module Shoulda
+  VERSION = "2.11.1"
+end
+

data/rails/init.rb

@@ -1,7 +1,8 @@
 if RAILS_ENV == 'test'
   if defined? Spec
-    require 'shoulda/rspec'
+    require 'shoulda/integrations/rspec'
   else
-    require 'shoulda/rails' 
+    require 'shoulda/integrations/test_unit'
+    Shoulda.autoload_macros RAILS_ROOT, File.join("vendor", "{plugins,gems}", "*")
   end
 end

data/test/fail_macros.rb

@@ -27,13 +27,29 @@ module Shoulda
 
   class Context
     # alias_method_chain hack to allow the should_fail macro to work
-    def should_with_failure_scenario(name, options = {}, &block)
+    def should_with_failure_scenario(*args, &block)
+      should_without_failure_scenario(*args, &block)
+      wrap_last_should_with_failure_expectation
+    end
+    alias_method_chain :should, :failure_scenario
+
+    # alias_method_chain hack to allow the should_fail macro to work
+    def should_not_with_failure_scenario(*args, &block)
+      should_not_without_failure_scenario(*args, &block)
+      wrap_last_should_with_failure_expectation
+    end
+    alias_method_chain :should_not, :failure_scenario
+
+    def wrap_last_should_with_failure_expectation
       if Shoulda.expected_exceptions
         expected_exceptions = Shoulda.expected_exceptions
-        failure_block = lambda { assert_raise(*expected_exceptions, &block.bind(self)) }
+        should = self.shoulds.last
+        assertion_block = should[:block]
+        failure_block = lambda do
+          assert_raise(*expected_exceptions, &assertion_block.bind(self))
+        end
+        should[:block] = failure_block
       end
-      should_without_failure_scenario(name, options, &(failure_block || block))
     end
-    alias_method_chain :should, :failure_scenario
   end
 end

data/test/functional/posts_controller_test.rb

@@ -1,4 +1,4 @@
-require File.dirname(__FILE__) + '/../test_helper'
+require 'test_helper'
 require 'posts_controller'
 
 # Re-raise errors caught by the controller.
@@ -54,8 +54,6 @@ class PostsControllerTest < ActionController::TestCase
       end
       should_assign_to :posts
       should_not_assign_to :foo, :bar
-      should_render_page_with_metadata :description => /Posts/, :title => /index/
-      should_render_page_with_metadata :keywords => "posts"
     end
 
     context "viewing posts for a user with rss format" do
@@ -65,8 +63,12 @@ class PostsControllerTest < ActionController::TestCase
       end
       should_respond_with :success
       should_respond_with_content_type 'application/rss+xml'
-      should_respond_with_content_type :rss
-      should_respond_with_content_type /rss/
+      context "with a symbol" do
+        should_respond_with_content_type :rss
+      end
+      context "with a regexp" do
+        should_respond_with_content_type /rss/
+      end
       should_set_session(:mischief) { nil }
       should_set_session(:special) { '$2 off your next purchase' }
       should_set_session(:special_user_id) { @user.id }
@@ -85,7 +87,6 @@ class PostsControllerTest < ActionController::TestCase
         should_render_with_layout :wide
       end
       should_assign_to :false_flag
-      should_set_the_flash_to nil
       should_fail do
         should_set_the_flash_to /.*/
       end
@@ -95,7 +96,6 @@ class PostsControllerTest < ActionController::TestCase
       setup { get :new, :user_id => users(:first) }
       should_render_without_layout
       should_not_set_the_flash
-      should_render_a_form
     end
 
     context "on POST to #create" do

data/test/functional/users_controller_test.rb

@@ -1,4 +1,4 @@
-require File.dirname(__FILE__) + '/../test_helper'
+require 'test_helper'
 require 'users_controller'
 
 # Re-raise errors caught by the controller.

data/test/matchers/action_mailer/have_sent_email_test.rb

@@ -0,0 +1,70 @@
+require 'test_helper'
+
+class HaveSentEmailTest < ActiveSupport::TestCase # :nodoc:
+  def add_mail_to_deliveries
+    if defined?(AbstractController::Rendering)
+      ::ActionMailer::Base.deliveries << Mailer.the_email
+    else
+      ::ActionMailer::Base.deliveries << Mailer.create_the_email
+    end
+  end
+
+  context "an email" do
+    setup do
+      define_mailer :mailer, [:the_email] do
+        def the_email
+          if defined?(AbstractController::Rendering)
+            mail :from    => "do-not-reply@example.com",
+                 :to      => "myself@me.com",
+                 :subject => "This is spam",
+                 :body    => "Every email is spam."
+          else
+            from       "do-not-reply@example.com"
+            recipients "myself@me.com"
+            subject    "This is spam"
+            body       "Every email is spam."
+          end
+        end
+      end
+      add_mail_to_deliveries
+    end
+
+    teardown { ::ActionMailer::Base.deliveries.clear }
+
+    should "accept based on the subject" do
+      assert_accepts have_sent_email.with_subject(/is spam$/), nil
+      assert_rejects have_sent_email.with_subject(/totally safe/), nil,
+                     :message => /Expected sent email with subject/
+    end
+
+    should "accept based on the sender" do
+      assert_accepts have_sent_email.from('do-not-reply@example.com'), nil
+      assert_rejects have_sent_email.from('you@example.com'), nil,
+                     :message => /Expected sent email from/
+    end
+
+    should "accept based on the body" do
+      assert_accepts have_sent_email.with_body(/is spam\./), nil
+      assert_rejects have_sent_email.with_body(/totally safe/), nil,
+                     :message => /Expected sent email with body/
+    end
+
+    should "accept based on the recipient" do
+      assert_accepts have_sent_email.to('myself@me.com'), nil
+      assert_rejects have_sent_email.to('you@example.com'), nil,
+                     :message => /Expected sent email to/
+    end
+
+    should "list all deliveries within failure message" do
+      add_mail_to_deliveries
+
+      assert_rejects have_sent_email.to('you@example.com'), nil,
+                                        :message => /Deliveries:\n"This is spam" to \["myself@me\.com"\]\n"This is spam" to \["myself@me\.com"\]/
+    end
+
+    should "chain" do
+      assert_accepts have_sent_email.with_subject(/spam/).from('do-not-reply@example.com').with_body(/spam/).to('myself@me.com'), nil
+      assert_rejects have_sent_email.with_subject(/ham/).from('you@example.com').with_body(/ham/).to('them@example.com'), nil
+    end
+  end
+end

data/test/matchers/active_record/allow_mass_assignment_of_matcher_test.rb

@@ -1,4 +1,4 @@
-require File.join(File.dirname(__FILE__), '..', '..', 'test_helper')
+require 'test_helper'
 
 class AllowMassAssignmentOfMatcherTest < ActiveSupport::TestCase # :nodoc:
 
@@ -63,6 +63,12 @@ class AllowMassAssignmentOfMatcherTest < ActiveSupport::TestCase # :nodoc:
     should "accept being mass-assignable" do
       assert_accepts allow_mass_assignment_of(:attr), @model
     end
+
+    should "assign a negative failure message" do
+      matcher = allow_mass_assignment_of(:attr)
+      matcher.matches?(@model)
+      assert_not_nil matcher.negative_failure_message
+    end
   end
 
 end

data/test/matchers/active_record/allow_value_matcher_test.rb

@@ -1,4 +1,4 @@
-require File.join(File.dirname(__FILE__), '..', '..', 'test_helper')
+require 'test_helper'
 
 class AllowValueMatcherTest < ActiveSupport::TestCase # :nodoc:
 

data/test/matchers/active_record/association_matcher_test.rb

@@ -1,4 +1,4 @@
-require File.join(File.dirname(__FILE__), '..', '..', 'test_helper')
+require 'test_helper'
 
 class AssociationMatcherTest < ActiveSupport::TestCase # :nodoc:
 
@@ -166,55 +166,55 @@ class AssociationMatcherTest < ActiveSupport::TestCase # :nodoc:
 
   context "have_one" do
     setup do
-      @matcher = have_one(:profile)
+      @matcher = have_one(:detail)
     end
 
     should "accept a valid association without any options" do
-      define_model :profile, :person_id => :integer
+      define_model :detail, :person_id => :integer
       define_model :person do
-        has_one :profile
+        has_one :detail
       end
       assert_accepts @matcher, Person.new
     end
 
     should "accept a valid association with an :as option" do
-      define_model :profile, :profilable_id   => :integer,
-                                  :profilable_type => :string
+      define_model :detail, :detailable_id   => :integer,
+                                  :detailable_type => :string
       define_model :person do
-        has_one :profile, :as => :profilable
+        has_one :detail, :as => :detailable
       end
       assert_accepts @matcher, Person.new
     end
 
     should "reject an association that has a nonexistent foreign key" do
-      define_model :profile
+      define_model :detail
       define_model :person do
-        has_one :profile
+        has_one :detail
       end
       assert_rejects @matcher, Person.new
     end
 
     should "reject an association with a bad :as option" do
-      define_model :profile, :profilable_id   => :integer,
-                                  :profilable_type => :string
+      define_model :detail, :detailable_id   => :integer,
+                                  :detailable_type => :string
       define_model :person do
-        has_one :profile, :as => :describable
+        has_one :detail, :as => :describable
       end
       assert_rejects @matcher, Person.new
     end
 
     should "accept an association with a valid :dependent option" do
-      define_model :profile, :person_id => :integer
+      define_model :detail, :person_id => :integer
       define_model :person do
-        has_one :profile, :dependent => :destroy
+        has_one :detail, :dependent => :destroy
       end
       assert_accepts @matcher.dependent(:destroy), Person.new
     end
 
     should "reject an association with a bad :dependent option" do
-      define_model :profile, :person_id => :integer
+      define_model :detail, :person_id => :integer
       define_model :person do
-        has_one :profile
+        has_one :detail
       end
       assert_rejects @matcher.dependent(:destroy), Person.new
     end