mcmire-rspec-rails 1.1.99.9

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

@@ -0,0 +1,29 @@
+require 'action_controller/cookies'
+
+module Spec
+  module Rails
+    module Example
+      class CookiesProxy
+        def initialize(example)
+          @example = example
+        end
+      
+        def[]=(name, value)
+          if ::Rails::VERSION::STRING >= '2.3'
+            @example.request.cookies[name.to_s] = value
+          else
+            @example.request.cookies[name.to_s] = CGI::Cookie.new(name.to_s, value)
+          end
+        end
+        
+        def [](name)
+          @example.response.cookies[name.to_s]
+        end
+      
+        def delete(name)
+          @example.response.cookies.delete(name.to_s)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,84 @@
+require 'action_controller/test_case'
+
+module Spec
+  module Rails
+    module Example
+      class FunctionalExampleGroup < ActionController::TestCase
+        def setup
+          # no-op to override AC::TC's setup w/ conflicts with the before(:each) below
+        end
+
+        attr_reader :request, :response
+
+        def params
+          request.parameters
+        end
+
+        def flash
+          @controller.__send__ :flash
+        end
+
+        def session
+          request.session
+        end
+        
+        # Overrides the <tt>cookies()</tt> method in
+        # ActionController::TestResponseBehaviour, returning a proxy that
+        # accesses the requests cookies when setting a cookie and the
+        # responses cookies when reading one. This allows you to set and read
+        # cookies in examples using the same API with which you set and read
+        # them in controllers.
+        #
+        # == Examples (Rails 2.0 > 2.2)
+        #
+        #   cookies[:user_id] = {:value => '1234', :expires => 1.minute.ago}
+        #   get :index
+        #   response.should be_redirect
+        #
+        # == Examples (Rails 2.3)
+        #
+        # Rails 2.3 changes the way cookies are made available to functional
+        # tests (and therefore rspec controller specs), only making single
+        # values available with no access to other aspects of the cookie. This
+        # is backwards-incompatible, so you have to change your examples to
+        # look like this:
+        #
+        #   cookies[:foo] = 'bar'
+        #   get :index
+        #   cookies[:foo].should == 'bar'
+        def cookies
+          @cookies ||= Spec::Rails::Example::CookiesProxy.new(self)
+        end
+        
+        alias_method :orig_assigns, :assigns
+
+        # :call-seq:
+        #   assigns()
+        #
+        # Hash of instance variables to values that are made available to
+        # views. == Examples
+        #
+        #   #in thing_controller.rb
+        #   def new
+        #     @thing = Thing.new
+        #   end
+        #
+        #   #in thing_controller_spec
+        #   get 'new'
+        #   assigns[:registration].should == Thing.new
+        #--
+        # NOTE - Even though docs only use assigns[:key] format, this supports
+        # assigns(:key) for backwards compatibility.
+        #++
+        def assigns(key = nil)
+          if key.nil?
+            _assigns_hash_proxy
+          else
+            _assigns_hash_proxy[key]
+          end
+        end
+
+      end
+    end
+  end
+end

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

@@ -0,0 +1,167 @@
+module Spec
+  module Rails
+    module Example
+      class HelperExampleGroupController < ApplicationController #:nodoc:
+        attr_accessor :request, :url
+      end
+
+      # 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
+      #
+      #   module 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
+        tests HelperExampleGroupController
+        attr_accessor :output_buffer
+        
+        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
+        
+        def orig_assigns
+          helper.assigns
+        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(:each) do
+          @controller.request = @request
+          @controller.url = ActionController::UrlRewriter.new @request, {} # url_for
+
+          @flash = ActionController::Flash::FlashHash.new
+          session['flash'] = @flash
+          
+          @output_buffer = ""
+          @template = helper
+          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) {helper}
+        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 < ActiveSupport::TestCase
+        Spec::Example::ExampleGroupFactory.register(:model, self)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,67 @@
+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
+
+        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/routing_helpers.rb

@@ -0,0 +1,68 @@
+module Spec
+  module Rails
+    module Example
+      module RoutingHelpers
+        
+        module ParamsFromQueryString # :nodoc:
+          def params_from_querystring(querystring) # :nodoc:
+            params = {}
+            querystring.split('&').each do |piece|
+              key, value = piece.split('=')
+              params[key.to_sym] = value
+            end
+            params
+          end
+        end
+        
+        class RouteFor
+          include ::Spec::Rails::Example::RoutingHelpers::ParamsFromQueryString
+          def initialize(example, options)
+            @example, @options = example, options
+          end
+  
+          def ==(expected)
+            if Hash === expected
+              path, querystring = expected[:path].split('?')
+              path = expected.merge(:path => path)
+            else
+              path, querystring = expected.split('?')
+            end
+            params = querystring.blank? ? {} : @example.params_from_querystring(querystring)
+            @example.assert_recognizes(@options, path, params)
+            true
+          end
+        end
+
+        # Uses ActionController::Routing::Routes to generate
+        # the correct route for a given set of options.
+        # == Example
+        #   route_for(:controller => 'registrations', :action => 'edit', :id => 1)
+        #     => '/registrations/1;edit'
+        def route_for(options)
+          RouteFor.new(self, options)
+        end
+
+        # Uses ActionController::Routing::Routes to parse
+        # an incoming path so the parameters it generates can be checked
+        # == Example
+        #   params_from(:get, '/registrations/1/edit')
+        #     => :controller => 'registrations', :action => 'edit', :id => 1
+        def params_from(method, path)
+          ensure_that_routes_are_loaded
+          path, querystring = path.split('?')
+          params = ActionController::Routing::Routes.recognize_path(path, :method => method)
+          querystring.blank? ? params : params.merge(params_from_querystring(querystring))
+        end
+
+      private
+
+        include ParamsFromQueryString
+
+        def ensure_that_routes_are_loaded
+          ActionController::Routing::Routes.reload if ActionController::Routing::Routes.empty?
+        end
+
+      end
+    end
+  end
+end

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

@@ -0,0 +1,186 @@
+module Spec
+  module Rails
+    module Example
+      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
+
+      # 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
+        tests ViewExampleGroupController
+        class << self
+          def inherited(klass) # :nodoc:
+            klass.subject { template }
+            super
+          end
+        end
+
+        before {ensure_that_flash_and_session_work_properly}
+        after  {ensure_that_base_view_path_is_not_set_across_example_groups}
+
+        def ensure_that_flash_and_session_work_properly #:nodoc:
+          @controller.class.__send__ :public, :flash
+          @controller.__send__ :initialize_template_class, @response
+          @controller.__send__ :assign_shortcuts, @request, @response
+          @controller.__send__ :initialize_current_url
+          @session = @controller.session
+        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}".split('.').first
+        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 : {}
+          
+          if args.empty? 
+            unless [:partial, :inline, :file, :template, :xml, :json, :update].any? {|k| options.has_key? k} 
+              args << self.class.description_parts.first
+            end
+          end
+          
+          options[:template] = args.first.to_s.sub(/^\//,'') unless args.empty?
+          
+          set_base_view_path(options)
+          add_helpers(options)
+
+          assigns[:action_name] = @action_name
+          
+          @request.path_parameters = @request.path_parameters.merge(
+            :controller => derived_controller_name(options),
+            :action => derived_action_name(options)
+          ).merge(options[:path_parameters] || {})
+
+          defaults = { :layout => false }
+          options = defaults.merge options
+
+          @controller.__send__(:params).reverse_merge! @request.parameters
+
+          @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) {@response.template}
+        end
+      end
+
+    end
+  end
+end