dchelimsky-rspec-rails 1.1.6

data/lib/spec/rails/example/helper_example_group.rb

@@ -0,0 +1,166 @@
+module Spec
+  module Rails
+    module Example
+      # Helper Specs live in $RAILS_ROOT/spec/helpers/.
+      #
+      # Helper Specs use Spec::Rails::Example::HelperExampleGroup, which allows you to
+      # include your Helper directly in the context and write specs directly
+      # against its methods.
+      #
+      # HelperExampleGroup also includes the standard lot of ActionView::Helpers in case your
+      # helpers rely on any of those.
+      #
+      # == Example
+      #
+      #   class ThingHelper
+      #     def number_of_things
+      #       Thing.count
+      #     end
+      #   end
+      #
+      #   describe "ThingHelper example_group" do
+      #     include ThingHelper
+      #     it "should tell you the number of things" do
+      #       Thing.should_receive(:count).and_return(37)
+      #       number_of_things.should == 37
+      #     end
+      #   end
+      class HelperExampleGroup < FunctionalExampleGroup
+        class HelperObject < ActionView::Base
+          def protect_against_forgery?
+            false
+          end
+          
+          def session=(session)
+            @session = session
+          end
+          
+          def request=(request)
+            @request = request
+          end
+          
+          def flash=(flash)
+            @flash = flash
+          end
+          
+          def params=(params)
+            @params = params
+          end
+          
+          def controller=(controller)
+            @controller = controller
+          end
+          
+          private
+            attr_reader :session, :request, :flash, :params, :controller
+        end
+        
+        class << self
+          # The helper name....
+          def helper_name(name=nil)
+            @helper_being_described = "#{name}_helper".camelize.constantize
+            send :include, @helper_being_described
+          end
+          
+          def helper
+            @helper_object ||= returning HelperObject.new do |helper_object|
+              if @helper_being_described.nil?
+                if described_type.class == Module
+                  helper_object.extend described_type
+                end
+              else
+                helper_object.extend @helper_being_described
+              end
+            end
+          end
+        end
+        
+        # Returns an instance of ActionView::Base with the helper being spec'd
+        # included.
+        #
+        # == Example
+        #
+        #   describe PersonHelper do
+        #     it "should write a link to person with the name" do
+        #       assigns[:person] = mock_model(Person, :full_name => "Full Name", :id => 37, :new_record? => false)
+        #       helper.link_to_person.should == %{<a href="/people/37">Full Name</a>}
+        #     end
+        #   end
+        #
+        #   module PersonHelper
+        #     def link_to_person
+        #       link_to person.full_name, url_for(person)
+        #     end
+        #   end
+        #
+        def helper
+          self.class.helper
+        end
+
+        # Reverse the load order so that custom helpers which are defined last
+        # are also loaded last.
+        ActionView::Base.included_modules.reverse.each do |mod|
+          include mod if mod.parents.include?(ActionView::Helpers)
+        end
+
+        before(:all) do
+          @controller_class_name = 'Spec::Rails::Example::HelperExampleGroupController'
+        end
+
+        before(:each) do
+          @controller.request = @request
+          @controller.url = ActionController::UrlRewriter.new @request, {} # url_for
+
+          @flash = ActionController::Flash::FlashHash.new
+          session['flash'] = @flash
+
+          ActionView::Helpers::AssetTagHelper::reset_javascript_include_default
+          
+          helper.session = session
+          helper.request = @request
+          helper.flash = flash
+          helper.params = params
+          helper.controller = @controller
+        end
+
+        def flash
+          @flash
+        end
+
+        def eval_erb(text)
+          erb_args = [text]
+          if helper.respond_to?(:output_buffer)
+            erb_args += [nil, nil, '@output_buffer']
+          end
+          
+          helper.instance_eval do
+            ERB.new(*erb_args).result(binding)
+          end
+        end
+
+        # TODO: BT - Helper Examples should proxy method_missing to a Rails View instance.
+        # When that is done, remove this method
+        def protect_against_forgery?
+          false
+        end
+
+        Spec::Example::ExampleGroupFactory.register(:helper, self)
+
+        protected
+        def _assigns_hash_proxy
+          @_assigns_hash_proxy ||= AssignsHashProxy.new self do
+            helper
+          end
+        end
+
+      end
+
+      class HelperExampleGroupController < ApplicationController #:nodoc:
+        attr_accessor :request, :url
+
+        # Re-raise errors
+        def rescue_action(e); raise e; end
+      end
+    end
+  end
+end

data/lib/spec/rails/example/model_example_group.rb

@@ -0,0 +1,14 @@
+module Spec
+  module Rails
+    module Example
+      # Model examples live in $RAILS_ROOT/spec/models/.
+      #
+      # Model examples use Spec::Rails::Example::ModelExampleGroup, which
+      # provides support for fixtures and some custom expectations via extensions
+      # to ActiveRecord::Base.
+      class ModelExampleGroup < RailsExampleGroup
+        Spec::Example::ExampleGroupFactory.register(:model, self)
+      end
+    end
+  end
+end

data/lib/spec/rails/example/rails_example_group.rb

@@ -0,0 +1,33 @@
+require 'spec/interop/test'
+
+if ActionView::Base.respond_to?(:cache_template_extension)
+  ActionView::Base.cache_template_extensions = false
+end
+
+module Spec
+  module Rails
+
+    module Example
+      class RailsExampleGroup < Test::Unit::TestCase
+        
+        # Rails >= r8570 uses setup/teardown_fixtures explicitly
+        # However, Rails >= r8664 extracted these out to use ActiveSupport::Callbacks.
+        # The latter case is handled at the TestCase level, in interop/testcase.rb
+        unless ActiveSupport.const_defined?(:Callbacks) and self.include?(ActiveSupport::Callbacks)
+          before(:each) do
+            setup_fixtures if self.respond_to?(:setup_fixtures)
+          end
+          after(:each) do
+            teardown_fixtures if self.respond_to?(:teardown_fixtures)
+          end
+        end
+        
+        include Spec::Rails::Matchers
+        include Spec::Rails::Mocks
+        
+        Spec::Example::ExampleGroupFactory.default(self)
+        
+      end
+    end
+  end
+end

data/lib/spec/rails/example/render_observer.rb

@@ -0,0 +1,93 @@
+require 'spec/mocks/framework'
+
+module Spec
+  module Rails
+    module Example
+      # Extends the #should_receive, #should_not_receive and #stub! methods in rspec's
+      # mocking framework to handle #render calls to controller in controller examples
+      # and template and view examples
+      module RenderObserver
+
+        # DEPRECATED
+        #
+        # Use should_receive(:render).with(opts) instead
+        def expect_render(opts={})
+          warn_deprecation("expect_render", "should_receive")
+          register_verify_after_each
+          render_proxy.should_receive(:render, :expected_from => caller(1)[0]).with(opts)
+        end
+
+        # DEPRECATED
+        #
+        # Use stub!(:render).with(opts) instead
+        def stub_render(opts={})
+          warn_deprecation("stub_render", "stub!")
+          register_verify_after_each
+          render_proxy.stub!(:render, :expected_from => caller(1)[0]).with(opts)
+        end
+        
+        def warn_deprecation(deprecated_method, new_method)
+          Kernel.warn <<-WARNING
+#{deprecated_method} is deprecated and will be removed from a future version of rspec-rails.
+
+Please just use object.#{new_method} instead.
+WARNING
+        end
+  
+        def verify_rendered # :nodoc:
+          render_proxy.rspec_verify
+        end
+  
+        def unregister_verify_after_each #:nodoc:
+          proc = verify_rendered_proc
+          Spec::Example::ExampleGroup.remove_after(:each, &proc)
+        end
+
+        def should_receive(*args)
+          if args[0] == :render
+            register_verify_after_each
+            render_proxy.should_receive(:render, :expected_from => caller(1)[0])
+          else
+            super
+          end
+        end
+        
+        def should_not_receive(*args)
+          if args[0] == :render
+            register_verify_after_each
+            render_proxy.should_not_receive(:render)
+          else
+            super
+          end
+        end
+        
+        def stub!(*args)
+          if args[0] == :render
+            register_verify_after_each
+            render_proxy.stub!(:render, :expected_from => caller(1)[0])
+          else
+            super
+          end
+        end
+
+        def verify_rendered_proc #:nodoc:
+          template = self
+          @verify_rendered_proc ||= Proc.new do
+            template.verify_rendered
+            template.unregister_verify_after_each
+          end
+        end
+
+        def register_verify_after_each #:nodoc:
+          proc = verify_rendered_proc
+          Spec::Example::ExampleGroup.after(:each, &proc)
+        end
+  
+        def render_proxy #:nodoc:
+          @render_proxy ||= Spec::Mocks::Mock.new("render_proxy")
+        end
+  
+      end
+    end
+  end
+end

data/lib/spec/rails/example/view_example_group.rb

@@ -0,0 +1,183 @@
+module Spec
+  module Rails
+    module Example
+      # View Examples live in $RAILS_ROOT/spec/views/.
+      #
+      # View Specs use Spec::Rails::Example::ViewExampleGroup,
+      # which provides access to views without invoking any of your controllers.
+      # See Spec::Rails::Expectations::Matchers for information about specific
+      # expectations that you can set on views.
+      #
+      # == Example
+      #
+      #   describe "login/login" do
+      #     before do
+      #       render 'login/login'
+      #     end
+      # 
+      #     it "should display login form" do
+      #       response.should have_tag("form[action=/login]") do
+      #         with_tag("input[type=text][name=email]")
+      #         with_tag("input[type=password][name=password]")
+      #         with_tag("input[type=submit][value=Login]")
+      #       end
+      #     end
+      #   end
+      class ViewExampleGroup < FunctionalExampleGroup
+        before(:each) do
+          ensure_that_flash_and_session_work_properly
+        end
+
+        after(:each) do
+          ensure_that_base_view_path_is_not_set_across_example_groups
+        end
+
+        def initialize(defined_description, &implementation) #:nodoc:
+          super
+          @controller_class_name = "Spec::Rails::Example::ViewExampleGroupController"
+        end
+
+        def ensure_that_flash_and_session_work_properly #:nodoc:
+          @controller.send :initialize_template_class, @response
+          @controller.send :assign_shortcuts, @request, @response
+          @session = @controller.session
+          @controller.class.send :public, :flash
+        end
+
+        def ensure_that_base_view_path_is_not_set_across_example_groups #:nodoc:
+          ActionView::Base.base_view_path = nil
+        end
+
+        def set_base_view_path(options) #:nodoc:
+          ActionView::Base.base_view_path = base_view_path(options)
+        end
+
+        def base_view_path(options) #:nodoc:
+          "/#{derived_controller_name(options)}/"
+        end
+
+        def derived_controller_name(options) #:nodoc:
+          parts = subject_of_render(options).split('/').reject { |part| part.empty? }
+          "#{parts[0..-2].join('/')}"
+        end
+
+        def derived_action_name(options) #:nodoc:
+          parts = subject_of_render(options).split('/').reject { |part| part.empty? }
+          "#{parts.last}"
+        end
+
+        def subject_of_render(options) #:nodoc:
+          [:template, :partial, :file].each do |render_type|
+            if options.has_key?(render_type)
+              return options[render_type]
+            end
+          end
+          return ""
+        end
+
+        def add_helpers(options) #:nodoc:
+          @controller.add_helper("application")
+          @controller.add_helper(derived_controller_name(options))
+          @controller.add_helper(options[:helper]) if options[:helper]
+          options[:helpers].each { |helper| @controller.add_helper(helper) } if options[:helpers]
+        end
+
+        # Renders a template for a View Spec, which then provides access to the result
+        # through the +response+. Also supports render with :inline, which you can
+        # use to spec custom form builders, helpers, etc, in the context of a view.
+        #
+        # == Examples
+        #
+        #   render('/people/list')
+        #   render('/people/list', :helper => MyHelper)
+        #   render('/people/list', :helpers => [MyHelper, MyOtherHelper])
+        #   render(:partial => '/people/_address')
+        #   render(:inline => "<% custom_helper 'argument', 'another argument' %>")
+        #
+        # See Spec::Rails::Example::ViewExampleGroup for more information.
+        def render(*args)
+          options = Hash === args.last ? args.pop : {}
+          options[:template] = args.first.to_s unless args.empty?
+
+          set_base_view_path(options)
+          add_helpers(options)
+
+          assigns[:action_name] = @action_name
+
+          @request.path_parameters = {
+          :controller => derived_controller_name(options),
+          :action => derived_action_name(options)
+          }
+
+          defaults = { :layout => false }
+          options = defaults.merge options
+
+          @controller.send(:params).reverse_merge! @request.parameters
+
+          @controller.send :initialize_current_url
+
+          @controller.class.instance_eval %{
+            def controller_path
+              "#{derived_controller_name(options)}"
+            end
+
+            def controller_name
+              "#{derived_controller_name(options).split('/').last}"
+            end
+          }
+
+          @controller.send :forget_variables_added_to_assigns
+          @controller.send :render, options
+          @controller.send :process_cleanup
+        end
+
+        # This provides the template. Use this to set mock
+        # expectations for dealing with partials
+        #
+        # == Example
+        #
+        #   describe "/person/new" do
+        #     it "should use the form partial" do
+        #       template.should_receive(:render).with(:partial => 'form')
+        #       render "/person/new"
+        #     end
+        #   end
+        def template
+          @controller.template
+        end
+
+        Spec::Example::ExampleGroupFactory.register(:view, self)
+
+        protected
+        def _assigns_hash_proxy
+          @_assigns_hash_proxy ||= AssignsHashProxy.new self do
+            @response.template
+          end
+        end
+      end
+
+      class ViewExampleGroupController < ApplicationController #:nodoc:
+        include Spec::Rails::Example::RenderObserver
+        attr_reader :template
+
+        def add_helper_for(template_path)
+          add_helper(template_path.split('/')[0])
+        end
+
+        def add_helper(name)
+          begin
+            helper_module = "#{name}_helper".camelize.constantize
+          rescue
+            return
+          end
+          (class << template; self; end).class_eval do
+            include helper_module
+          end
+        end
+        
+        def forget_variables_added_to_assigns
+        end
+      end
+    end
+  end
+end

data/lib/spec/rails/example.rb

@@ -0,0 +1,47 @@
+dir = File.dirname(__FILE__)
+
+require 'spec/rails/example/assigns_hash_proxy'
+
+require "spec/rails/example/render_observer"
+require "spec/rails/example/rails_example_group"
+require "spec/rails/example/model_example_group"
+require "spec/rails/example/functional_example_group"
+require "spec/rails/example/controller_example_group"
+require "spec/rails/example/helper_example_group"
+require "spec/rails/example/view_example_group"
+require "spec/rails/example/cookies_proxy"
+
+module Spec
+  module Rails
+    # Spec::Rails::Example extends Spec::Example (RSpec's core Example module) to provide
+    # Rails-specific contexts for describing Rails Models, Views, Controllers and Helpers.
+    #
+    # == Model Examples
+    #
+    # These are the equivalent of unit tests in Rails' built in testing. Ironically (for the traditional TDD'er) these are the only specs that we feel should actually interact with the database.
+    #
+    # See Spec::Rails::Example::ModelExampleGroup
+    #
+    # == Controller Examples
+    #
+    # These align somewhat with functional tests in rails, except that they do not actually render views (though you can force rendering of views if you prefer). Instead of setting expectations about what goes on a page, you set expectations about what templates get rendered.
+    #
+    # See Spec::Rails::Example::ControllerExampleGroup
+    #
+    # == View Examples
+    #
+    # This is the other half of Rails functional testing. View specs allow you to set up assigns and render
+    # a template. By assigning mock model data, you can specify view behaviour with no dependency on a database
+    # or your real models.
+    #
+    # See Spec::Rails::Example::ViewExampleGroup
+    #
+    # == Helper Examples
+    #
+    # These let you specify directly methods that live in your helpers.
+    #
+    # See Spec::Rails::Example::HelperExampleGroup
+    module Example
+    end
+  end
+end

data/lib/spec/rails/extensions/action_controller/base.rb

@@ -0,0 +1,14 @@
+module ActionController
+  class Base
+    class << self
+      def set_view_path(path)
+        [:append_view_path, :view_paths=, :template_root=].each do |method|
+          if respond_to?(method)
+            return send(method, path)
+          end
+        end
+      end
+    end
+  end
+end
+        

data/lib/spec/rails/extensions/action_controller/rescue.rb

@@ -0,0 +1,21 @@
+module ActionController
+  module Rescue
+    def use_rails_error_handling!
+      @use_rails_error_handling = true
+    end
+
+    def use_rails_error_handling?
+      @use_rails_error_handling ||= false
+    end
+
+    protected
+    def rescue_action_with_fast_errors(exception)
+      if use_rails_error_handling?
+        rescue_action_without_fast_errors exception
+      else
+        raise exception
+      end
+    end
+    alias_method_chain :rescue_action, :fast_errors
+  end
+end

data/lib/spec/rails/extensions/action_controller/test_response.rb

@@ -0,0 +1,11 @@
+module ActionController #:nodoc:
+  class TestResponse #:nodoc:
+    attr_writer :controller_path
+
+    def capture(name)
+      template.instance_variable_get "@content_for_#{name.to_s}"
+    end
+    alias [] capture
+
+  end
+end

data/lib/spec/rails/extensions/action_view/base.rb

@@ -0,0 +1,31 @@
+module ActionView #:nodoc:
+  class Base #:nodoc:
+    include Spec::Rails::Example::RenderObserver
+    cattr_accessor :base_view_path
+    def render_partial(partial_path, local_assigns = nil, deprecated_local_assigns = nil) #:nodoc:
+      if partial_path.is_a?(String)
+        unless partial_path.include?("/")
+          unless self.class.base_view_path.nil?
+            partial_path = "#{self.class.base_view_path}/#{partial_path}"
+          end
+        end
+      end
+      begin
+        super(partial_path, local_assigns, deprecated_local_assigns)
+      rescue ArgumentError # edge rails > 2.1 changed render_partial to accept only one arg
+        super(partial_path)
+      end
+    end
+
+    alias_method :orig_render, :render
+    def render(options = {}, old_local_assigns = {}, &block)
+      if render_proxy.send(:__mock_proxy).send(:find_matching_expectation, :render, options)
+        render_proxy.render(options)
+      else
+        unless render_proxy.send(:__mock_proxy).send(:find_matching_method_stub, :render, options)
+          orig_render(options, old_local_assigns, &block)
+        end
+      end
+    end
+  end
+end

data/lib/spec/rails/extensions/active_record/base.rb

@@ -0,0 +1,30 @@
+if defined?(ActiveRecord::Base)
+  module ActiveRecord #:nodoc:
+    class Base
+
+      (class << self; self; end).class_eval do
+        # Extension for <tt>should have</tt> on AR Model classes
+        #
+        #   ModelClass.should have(:no).records
+        #   ModelClass.should have(1).record
+        #   ModelClass.should have(n).records
+        def records
+          find(:all)
+        end
+        alias :record :records
+      end
+
+      # Extension for <tt>should have</tt> on AR Model instances
+      #
+      #   model.should have(:no).errors_on(:attribute)
+      #   model.should have(1).error_on(:attribute)
+      #   model.should have(n).errors_on(:attribute)
+      def errors_on(attribute)
+        self.valid?
+        [self.errors.on(attribute)].flatten.compact
+      end
+      alias :error_on :errors_on
+
+    end
+  end
+end

data/lib/spec/rails/extensions/object.rb

@@ -0,0 +1,5 @@
+class Object # :nodoc:
+  def self.path2class(klassname)
+    klassname.split('::').inject(Object) { |k,n| k.const_get n }
+  end
+end