thoughtbot-shoulda 2.0.1 → 2.0.2

data/README.rdoc

@@ -90,6 +90,19 @@ Macros to test the most common controller patterns...
     end
   end
 
+Test entire controllers in a few lines...
+
+  class PostsControllerTest < Test::Unit::TestCase
+    should_be_restful do |resource|
+      resource.parent = :user
+
+      resource.create.params = { :title => "first post", :body => 'blah blah blah'}
+      resource.update.params = { :title => "changed" }
+    end
+  end
+
+should_be_restful generates 40 tests on the fly, for both html and xml requests.
+
 === Helpful Assertions (ThoughtBot::Shoulda::Assertions)
 
 More to come here, but have fun with what's there.

data/lib/shoulda/active_record/macros.rb

@@ -28,8 +28,9 @@ module ThoughtBot # :nodoc:
       # For all of these helpers, the last parameter may be a hash of options.
       #
       module Macros
+        # <b>DEPRECATED:</b> Use <tt>fixtures :all</tt> instead
+        #
         # Loads all fixture files (<tt>test/fixtures/*.yml</tt>)
-        # Deprecated: Use <tt>fixtures :all</tt> instead
         def load_all_fixtures
           warn "[DEPRECATION] load_all_fixtures is deprecated.  Use `fixtures :all` instead."
           fixtures :all
@@ -602,7 +603,7 @@ module ThoughtBot # :nodoc:
         #   should_have_index :age
         #
         def should_have_indices(*columns)
-          table = model_class.name.tableize
+          table = model_class.table_name
           indices = ::ActiveRecord::Base.connection.indexes(table).map(&:columns)
 
           columns.each do |column|

data/lib/shoulda/context.rb

@@ -1,6 +1,6 @@
 module Thoughtbot # :nodoc:
   module Shoulda
-    VERSION = '2.0.0'
+    VERSION = '2.0.2'
 
     class << self
       attr_accessor :contexts
@@ -73,12 +73,12 @@ module Thoughtbot # :nodoc:
 
     # == Before statements
     #
-    # Before statements are simply should statements that run before the current
+    # Before statements are should statements that run before the current
     # context's setup. These are especially useful when setting expectations.
     #
     # === Example:
     #
-    #  class UserControllerTest << Test::Unit::TestCase
+    #  class UserControllerTest < Test::Unit::TestCase
     #    context "the index action" do
     #      setup do
     #        @users = [Factory(:user)]
@@ -86,11 +86,8 @@ module Thoughtbot # :nodoc:
     #      end
     #
     #      context "on GET" do
-    #        setup do
-    #          get :index
-    #        end
+    #        setup { get :index }
     #
-    #        # normal should statement
     #        should_respond_with :success
     #
     #        # runs before "get :index"

data/lib/shoulda/controller/macros.rb

@@ -22,7 +22,58 @@ module ThoughtBot # :nodoc:
       #   end
       #
       # Would produce 5 tests for the +show+ action
+      #
+      # Furthermore, the should_be_restful helper will create an entire set of tests which will verify that your
+      # controller responds restfully to a variety of requested formats.
       module Macros
+        # <b>DEPRECATED:</b> Please see
+        # http://thoughtbot.lighthouseapp.com/projects/5807/tickets/78 for more
+        # information.
+        #
+        # Generates a full suite of tests for a restful controller.
+        #
+        # The following definition will generate tests for the +index+, +show+, +new+,
+        # +edit+, +create+, +update+ and +destroy+ actions, in both +html+ and +xml+ formats:
+        #
+        #   should_be_restful do |resource|
+        #     resource.parent = :user
+        #
+        #     resource.create.params = { :title => "first post", :body => 'blah blah blah'}
+        #     resource.update.params = { :title => "changed" }
+        #   end
+        #
+        # This generates about 40 tests, all of the format:
+        #   "on GET to :show should assign @user."
+        #   "on GET to :show should not set the flash."
+        #   "on GET to :show should render 'show' template."
+        #   "on GET to :show should respond with success."
+        #   "on GET to :show as xml should assign @user."
+        #   "on GET to :show as xml should have ContentType set to 'application/xml'."
+        #   "on GET to :show as xml should respond with success."
+        #   "on GET to :show as xml should return <user/> as the root element."
+        # The +resource+ parameter passed into the block is a ResourceOptions object, and
+        # is used to configure the tests for the details of your resources.
+        #
+        def should_be_restful(&blk) # :yields: resource
+          warn "[DEPRECATION] should_be_restful is deprecated.  Please see http://thoughtbot.lighthouseapp.com/projects/5807/tickets/78 for more information."
+
+          resource = ResourceOptions.new
+          blk.call(resource)
+          resource.normalize!(self)
+
+          resource.formats.each do |format|
+            resource.actions.each do |action|
+              if self.respond_to? :"make_#{action}_#{format}_tests"
+                self.send(:"make_#{action}_#{format}_tests", resource)
+              else
+                should "test #{action} #{format}" do
+                  flunk "Test for #{action} as #{format} not implemented"
+                end
+              end
+            end
+          end
+        end
+
         # :section: Test macros
         # Macro that creates a test asserting that the flash contains the given value.
         # val can be a String, a Regex, or nil (indicating that the flash should not be set)
@@ -49,6 +100,24 @@ module ThoughtBot # :nodoc:
         def should_not_set_the_flash
           should_set_the_flash_to nil
         end
+        
+        # Macro that creates a test asserting that filter_parameter_logging
+        # is set for the specified keys
+        #
+        # Example:
+        #
+        #   should_filter_params :password, :ssn
+        def should_filter_params(*keys)
+          keys.each do |key|
+            should "filter #{key}" do
+              assert @controller.respond_to?(:filter_parameters),
+                "The key #{key} is not filtered"
+              filtered = @controller.send(:filter_parameters, {key.to_s => key.to_s})
+              assert_equal '[FILTERED]', filtered[key.to_s],
+                "The key #{key} is not filtered"
+            end
+          end
+        end
 
         # Macro that creates a test asserting that the controller assigned to
         # each of the named instance variable(s).
@@ -77,7 +146,7 @@ module ThoughtBot # :nodoc:
                 instantiate_variables_from_assigns do
                   expected_value = eval(opts[:equals], self.send(:binding), __FILE__, __LINE__)
                   assert_equal expected_value, assigned_value,
-                               "Instance variable @#{name} expected to be #{expected_value}" + 
+                               "Instance variable @#{name} expected to be #{expected_value}" +
                                " but was #{assigned_value}"
                 end
               end
@@ -113,6 +182,8 @@ module ThoughtBot # :nodoc:
         # Example:
         #
         #   should_respond_with_content_type 'application/rss+xml'
+        #   should_respond_with_content_type :rss
+        #   should_respond_with_content_type /rss/
         def should_respond_with_content_type(content_type)
           should "respond with content type of #{content_type}" do
             content_type = Mime::EXTENSION_LOOKUP[content_type.to_s].to_s if content_type.is_a? Symbol
@@ -158,13 +229,13 @@ module ThoughtBot # :nodoc:
           if expected_layout
             should "render with #{expected_layout} layout" do
               response_layout = @response.layout.blank? ? "" : @response.layout.split('/').last
-              assert_equal expected_layout, 
-                           response_layout, 
+              assert_equal expected_layout,
+                           response_layout,
                            "Expected to render with layout #{expected_layout} but was rendered with #{response_layout}"
             end
           else
             should "render without layout" do
-              assert_nil @response.layout, 
+              assert_nil @response.layout,
                          "Expected no layout, but was rendered using #{@response.layout}"
             end
           end
@@ -197,7 +268,7 @@ module ThoughtBot # :nodoc:
             assert_select "form", true, "The template doesn't contain a <form> element"
           end
         end
-        
+
         # Macro that creates a routing test. It tries to use the given HTTP
         # +method+ on the given +path+, and asserts that it routes to the
         # given +options+.
@@ -209,13 +280,16 @@ module ThoughtBot # :nodoc:
         #
         # Examples:
         #
-        #   should_route :get, '/posts', :action => :index
-        #   should_route :post, '/posts', :controller => :posts, :action => :create
-        #   should_route :get, '/posts/1', :action => :show, :id => 1
-        #   should_route :put, '/posts/1', :action => :update, :id => "1"
-        #   should_route :delete, '/posts/1', :action => :destroy, :id => 1
-        #   should_route :get, '/posts/new', :action => :new
-        # 
+        #   should_route :get, "/posts", :controller => :posts, :action => :index
+        #   should_route :get, "/posts/new", :action => :new
+        #   should_route :post, "/posts", :action => :create
+        #   should_route :get, "/posts/1", :action => :show, :id => 1
+        #   should_route :edit, "/posts/1", :action => :show, :id => 1
+        #   should_route :put, "/posts/1", :action => :update, :id => 1
+        #   should_route :delete, "/posts/1", :action => :destroy, :id => 1
+        #   should_route :get, "/users/1/posts/1", 
+        #     :action => :show, :id => 1, :user_id => 1
+        #
         def should_route(method, path, options)
           unless options[:controller]
             options[:controller] = self.name.gsub(/ControllerTest$/, '').tableize

data/lib/shoulda/controller/resource_options.rb

@@ -1,10 +1,234 @@
 module ThoughtBot # :nodoc:
   module Shoulda # :nodoc:
     module Controller
+      # Formats tested by #should_be_restful.  Defaults to [:html, :xml]
       VALID_FORMATS = Dir.glob(File.join(File.dirname(__FILE__), 'formats', '*.rb')).map { |f| File.basename(f, '.rb') }.map(&:to_sym) # :doc:
       VALID_FORMATS.each {|f| require "shoulda/controller/formats/#{f}"}
 
+      # Actions tested by #should_be_restful
       VALID_ACTIONS = [:index, :show, :new, :edit, :create, :update, :destroy] # :doc:
+
+      # A ResourceOptions object is passed into should_be_restful in order to configure the tests for your controller.
+      #
+      # Example:
+      #   class UsersControllerTest < Test::Unit::TestCase
+      #     fixtures :all
+      #
+      #     def setup
+      #       ...normal setup code...
+      #       @user = User.find(:first)
+      #     end
+      #
+      #     should_be_restful do |resource|
+      #       resource.identifier = :id
+      #       resource.klass      = User
+      #       resource.object     = :user
+      #       resource.parent     = []
+      #       resource.actions    = [:index, :show, :new, :edit, :update, :create, :destroy]
+      #       resource.formats    = [:html, :xml]
+      #
+      #       resource.create.params = { :name => "bob", :email => 'bob@bob.com', :age => 13}
+      #       resource.update.params = { :name => "sue" }
+      #
+      #       resource.create.redirect  = "user_url(@user)"
+      #       resource.update.redirect  = "user_url(@user)"
+      #       resource.destroy.redirect = "users_url"
+      #
+      #       resource.create.flash  = /created/i
+      #       resource.update.flash  = /updated/i
+      #       resource.destroy.flash = /removed/i
+      #     end
+      #   end
+      #
+      # Whenever possible, the resource attributes will be set to sensible defaults.
+      #
+      class ResourceOptions
+        # Configuration options for the create, update, destroy actions under should_be_restful
+        class ActionOptions
+          # String evaled to get the target of the redirection.
+          # All of the instance variables set by the controller will be available to the
+          # evaled code.
+          #
+          # Example:
+          #   resource.create.redirect  = "user_url(@user.company, @user)"
+          #
+          # Defaults to a generated url based on the name of the controller, the action, and the resource.parents list.
+          attr_accessor :redirect
+
+          # String or Regexp describing a value expected in the flash.  Will match against any flash key.
+          #
+          # Defaults:
+          # destroy:: /removed/
+          # create::  /created/
+          # update::  /updated/
+          attr_accessor :flash
+
+          # Hash describing the params that should be sent in with this action.
+          attr_accessor :params
+        end
+
+        # Configuration options for the denied actions under should_be_restful
+        #
+        # Example:
+        #   context "The public" do
+        #     setup do
+        #       @request.session[:logged_in] = false
+        #     end
+        #
+        #     should_be_restful do |resource|
+        #       resource.parent = :user
+        #
+        #       resource.denied.actions = [:index, :show, :edit, :new, :create, :update, :destroy]
+        #       resource.denied.flash = /get outta here/i
+        #       resource.denied.redirect = 'new_session_url'
+        #     end
+        #   end
+        #
+        class DeniedOptions
+          # String evaled to get the target of the redirection.
+          # All of the instance variables set by the controller will be available to the
+          # evaled code.
+          #
+          # Example:
+          #   resource.create.redirect  = "user_url(@user.company, @user)"
+          attr_accessor :redirect
+
+          # String or Regexp describing a value expected in the flash.  Will match against any flash key.
+          #
+          # Example:
+          #   resource.create.flash = /created/
+          attr_accessor :flash
+
+          # Actions that should be denied (only used by resource.denied).  <i>Note that these actions will
+          # only be tested if they are also listed in +resource.actions+</i>
+          # The special value of :all will deny all of the REST actions.
+          attr_accessor :actions
+        end
+
+        # Name of key in params that references the primary key.
+        # Will almost always be :id (default), unless you are using a plugin or have patched rails.
+        attr_accessor :identifier
+
+        # Name of the ActiveRecord class this resource is responsible for.  Automatically determined from
+        # test class if not explicitly set.  UserTest => "User"
+        attr_accessor :klass
+
+        # Name of the instantiated ActiveRecord object that should be used by some of the tests.
+        # Defaults to the underscored name of the AR class.  CompanyManager => :company_manager
+        attr_accessor :object
+
+        # Name of the parent AR objects.  Can be set as parent= or parents=, and can take either
+        # the name of the parent resource (if there's only one), or an array of names (if there's
+        # more than one).
+        #
+        # Example:
+        #   # in the routes...
+        #   map.resources :companies do
+        #     map.resources :people do
+        #       map.resources :limbs
+        #     end
+        #   end
+        #
+        #   # in the tests...
+        #   class PeopleControllerTest < Test::Unit::TestCase
+        #     should_be_restful do |resource|
+        #       resource.parent = :companies
+        #     end
+        #   end
+        #
+        #   class LimbsControllerTest < Test::Unit::TestCase
+        #     should_be_restful do |resource|
+        #       resource.parents = [:companies, :people]
+        #     end
+        #   end
+        attr_accessor :parent
+        alias parents parent
+        alias parents= parent=
+
+        # Actions that should be tested.  Must be a subset of VALID_ACTIONS (default).
+        # Tests for each actionw will only be generated if the action is listed here.
+        # The special value of :all will test all of the REST actions.
+        #
+        # Example (for a read-only controller):
+        #   resource.actions = [:show, :index]
+        attr_accessor :actions
+
+        # Formats that should be tested.  Must be a subset of VALID_FORMATS (default).
+        # Each action will be tested against the formats listed here.  The special value
+        # of :all will test all of the supported formats.
+        #
+        # Example:
+        #   resource.actions = [:html, :xml]
+        attr_accessor :formats
+
+        # ActionOptions object specifying options for the create action.
+        attr_accessor :create
+
+        # ActionOptions object specifying options for the update action.
+        attr_accessor :update
+
+        # ActionOptions object specifying options for the desrtoy action.
+        attr_accessor :destroy
+
+        # DeniedOptions object specifying which actions should return deny a request, and what should happen in that case.
+        attr_accessor :denied
+
+        def initialize # :nodoc:
+          @create  = ActionOptions.new
+          @update  = ActionOptions.new
+          @destroy = ActionOptions.new
+          @denied  = DeniedOptions.new
+
+          @create.flash  ||= /created/i
+          @update.flash  ||= /updated/i
+          @destroy.flash ||= /removed/i
+          @denied.flash  ||= /denied/i
+
+          @create.params  ||= {}
+          @update.params  ||= {}
+
+          @actions = VALID_ACTIONS
+          @formats = VALID_FORMATS
+          @denied.actions = []
+        end
+
+        def normalize!(target) # :nodoc:
+          @denied.actions  = VALID_ACTIONS if @denied.actions == :all
+          @actions         = VALID_ACTIONS if @actions        == :all
+          @formats         = VALID_FORMATS if @formats        == :all
+
+          @denied.actions  = @denied.actions.map(&:to_sym)
+          @actions         = @actions.map(&:to_sym)
+          @formats         = @formats.map(&:to_sym)
+
+          ensure_valid_members(@actions,        VALID_ACTIONS, 'actions')
+          ensure_valid_members(@denied.actions, VALID_ACTIONS, 'denied.actions')
+          ensure_valid_members(@formats,        VALID_FORMATS, 'formats')
+
+          @identifier    ||= :id
+          @klass         ||= target.name.gsub(/ControllerTest$/, '').singularize.constantize
+          @object        ||= @klass.name.tableize.singularize
+          @parent        ||= []
+          @parent          = [@parent] unless @parent.is_a? Array
+
+          collection_helper = [@parent, @object.to_s.pluralize, 'url'].flatten.join('_')
+          collection_args   = @parent.map {|n| "@#{object}.#{n}"}.join(', ')
+          @destroy.redirect ||= "#{collection_helper}(#{collection_args})"
+
+          member_helper = [@parent, @object, 'url'].flatten.join('_')
+          member_args   = [@parent.map {|n| "@#{object}.#{n}"}, "@#{object}"].flatten.join(', ')
+          @create.redirect  ||= "#{member_helper}(#{member_args})"
+          @update.redirect  ||= "#{member_helper}(#{member_args})"
+          @denied.redirect  ||= "new_session_url"
+        end
+
+        private
+
+        def ensure_valid_members(ary, valid_members, name)  # :nodoc:
+          invalid = ary - valid_members
+          raise ArgumentError, "Unsupported #{name}: #{invalid.inspect}" unless invalid.empty?
+        end
+      end
     end
   end
 end

data/lib/shoulda/macros.rb

@@ -12,10 +12,7 @@ module ThoughtBot # :nodoc:
       # Example:
       #
       #   context "Creating a post"
-      #     setup do
-      #       Post.create
-      #     end
-      #
+      #     setup { Post.create }
       #     should_change "Post.count", :by => 1
       #   end
       #
@@ -57,10 +54,7 @@ module ThoughtBot # :nodoc:
       # Example:
       #
       #   context "Updating a post"
-      #     setup do
-      #       @post.update_attributes(:title => "new")
-      #     end
-      #
+      #     setup { @post.update_attributes(:title => "new") }
       #     should_not_change "Post.count"
       #   end
       def should_not_change(expression)

data/lib/shoulda.rb

@@ -3,6 +3,7 @@ require 'shoulda/proc_extensions'
 require 'shoulda/assertions'
 require 'shoulda/macros'
 require 'shoulda/helpers'
+require 'shoulda/rails' if defined? RAILS_ROOT
 
 module Test # :nodoc: all
   module Unit

data/rails/init.rb

@@ -0,0 +1 @@
+require 'shoulda/rails'

data/test/fail_macros.rb

@@ -0,0 +1,34 @@
+module Thoughtbot
+  module Shoulda
+    class << self
+      attr_accessor :expected_exceptions
+    end
+
+    # Enables the core shoulda test suite to test for failure scenarios.  For
+    # example, to ensure that a set of test macros should fail, do this:
+    #
+    #   should_fail do
+    #     should_require_attributes :comments
+    #     should_protect_attributes :name
+    #   end
+    def should_fail(&block)
+      context "should fail when trying to run:" do
+        Shoulda.expected_exceptions = [Test::Unit::AssertionFailedError]
+        yield block
+        Shoulda.expected_exceptions = nil
+      end
+    end
+
+    class Context
+      # alias_method_chain hack to allow the should_fail macro to work
+      def should_with_failure_scenario(name, options = {}, &block)
+        if Shoulda.expected_exceptions
+          expected_exceptions = Shoulda.expected_exceptions
+          failure_block = lambda { assert_raise(*expected_exceptions, &block.bind(self)) }
+        end
+        should_without_failure_scenario(name, options, &(failure_block || block))
+      end
+      alias_method_chain :should, :failure_scenario
+    end
+  end
+end

data/test/functional/posts_controller_test.rb

@@ -33,11 +33,32 @@ class PostsControllerTest < Test::Unit::TestCase
   should_route :get,    '/users/5/posts/new', :action => :new, :user_id => 5
   should_route :put,    '/users/5/posts/1',   :action => :update, :id => 1, :user_id => 5
 
+  context "The public" do
+    setup do
+      @request.session[:logged_in] = false
+    end
+
+    should_be_restful do |resource|
+      resource.parent = :user
+
+      resource.denied.actions = [:index, :show, :edit, :new, :create, :update, :destroy]
+      resource.denied.flash = /what/i
+      resource.denied.redirect = '"/"'
+    end
+  end
+
   context "Logged in" do
     setup do
       @request.session[:logged_in] = true
     end
 
+    should_be_restful do |resource|
+      resource.parent = :user
+
+      resource.create.params = { :title => "first post", :body => 'blah blah blah'}
+      resource.update.params = { :title => "changed" }
+    end
+
     context "viewing posts for a user" do
       setup do
         get :index, :user_id => users(:first)

data/test/functional/users_controller_test.rb

@@ -13,31 +13,26 @@ class UsersControllerTest < Test::Unit::TestCase
     @response   = ActionController::TestResponse.new
     @user       = User.find(:first)
   end
+  
+  should_filter_params :ssn
 
-  context "on GET to #index" do
-    setup { get :index }
+  should_be_restful do |resource|
+    resource.identifier = :id
+    resource.klass      = User
+    resource.object     = :user
+    resource.parent     = []
+    resource.actions    = [:index, :show, :new, :edit, :update, :create, :destroy]
+    resource.formats    = [:html, :xml]
 
-    should_respond_with :success
-    should_render_with_layout 'users'
-    should_render_template :index
-    should_assign_to :users
-  end
-  
-  context "on GET to #index.xml" do
-    setup { get :index, :format => 'xml' }
-  
-    should_respond_with :success
-    should_respond_with_xml_for
-    should_assign_to :users
-  end
-  
-  context "on GET to #show" do
-    setup { get :show, :id => @user }
+    resource.create.params = { :name => "bob", :email => 'bob@bob.com', :age => 13, :ssn => "123456789"}
+    resource.update.params = { :name => "sue" }
 
-    should_respond_with :success
-    should_render_with_layout 'users'
-    should_render_template :show
-    should_assign_to :user
+    resource.create.redirect  = "user_url(@user)"
+    resource.update.redirect  = "user_url(@user)"
+    resource.destroy.redirect = "users_url"
+
+    resource.create.flash  = /created/i
+    resource.update.flash  = /updated/i
+    resource.destroy.flash = /removed/i
   end
-  
 end

data/test/rails_root/app/controllers/users_controller.rb

@@ -1,4 +1,7 @@
 class UsersController < ApplicationController
+  
+  filter_parameter_logging :ssn
+  
   # GET /users
   # GET /users.xml
   def index

data/test/rails_root/app/views/layouts/wide.html.erb

@@ -0,0 +1 @@
+<html><%= yield %></html>

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: thoughtbot-shoulda
 version: !ruby/object:Gem::Version 
-  version: 2.0.1
+  version: 2.0.2
 platform: ruby
 authors: 
 - Tammer Saleh
@@ -53,9 +53,6 @@ files:
 - lib/shoulda/controller/helpers.rb
 - lib/shoulda/controller/macros.rb
 - lib/shoulda/controller/resource_options.rb
-- lib/shoulda/controller/routing
-- lib/shoulda/controller/routing/macros.rb
-- lib/shoulda/controller/routing.rb
 - lib/shoulda/controller.rb
 - lib/shoulda/helpers.rb
 - lib/shoulda/macros.rb
@@ -67,6 +64,9 @@ files:
 - lib/shoulda/tasks/yaml_to_shoulda.rake
 - lib/shoulda/tasks.rb
 - lib/shoulda.rb
+- rails
+- rails/init.rb
+- test/fail_macros.rb
 - test/fixtures
 - test/fixtures/addresses.yml
 - test/fixtures/friendships.yml
@@ -108,6 +108,7 @@ files:
 - test/rails_root/app/views/layouts
 - test/rails_root/app/views/layouts/posts.rhtml
 - test/rails_root/app/views/layouts/users.rhtml
+- test/rails_root/app/views/layouts/wide.html.erb
 - test/rails_root/app/views/posts
 - test/rails_root/app/views/posts/edit.rhtml
 - test/rails_root/app/views/posts/index.rhtml