rspec-rails 1.1.5

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/example/assigns_hash_proxy.rb

@@ -0,0 +1,43 @@
+module Spec
+  module Rails
+    module Example
+      class AssignsHashProxy #:nodoc:
+        def initialize(example_group, &block)
+          @block = block
+          @example_group = example_group
+        end
+
+        def [](ivar)
+          if assigns.include?(ivar.to_s)
+            assigns[ivar.to_s]
+          elsif assigns.include?(ivar)
+            assigns[ivar]
+          else
+            nil
+          end
+        end
+
+        def []=(ivar, val)
+          @block.call.instance_variable_set("@#{ivar}", val)
+        end
+
+        def delete(name)
+          assigns.delete(name.to_s)
+        end
+
+        def each(&block)
+          assigns.each &block
+        end
+
+        def has_key?(key)
+          assigns.key?(key.to_s)
+        end
+
+        protected
+        def assigns
+          @example_group.orig_assigns
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,256 @@
+module Spec
+  module Rails
+    module Example
+      # Controller Examples live in $RAILS_ROOT/spec/controllers/.
+      #
+      # Controller Examples use Spec::Rails::Example::ControllerExampleGroup, which supports running specs for
+      # Controllers in two modes, which represent the tension between the more granular
+      # testing common in TDD and the more high level testing built into
+      # rails. BDD sits somewhere in between: we want to a balance between
+      # specs that are close enough to the code to enable quick fault
+      # isolation and far enough away from the code to enable refactoring
+      # with minimal changes to the existing specs.
+      #
+      # == Isolation mode (default)
+      #
+      # No dependencies on views because none are ever rendered. The
+      # benefit of this mode is that can spec the controller completely
+      # independent of the view, allowing that responsibility to be
+      # handled later, or by somebody else. Combined w/ separate view
+      # specs, this also provides better fault isolation.
+      #
+      # == Integration mode
+      #
+      # To run in this mode, include the +integrate_views+ declaration
+      # in your controller context:
+      #
+      #   describe ThingController do
+      #     integrate_views
+      #     ...
+      #
+      # In this mode, controller specs are run in the same way that
+      # rails functional tests run - one set of tests for both the
+      # controllers and the views. The benefit of this approach is that
+      # you get wider coverage from each spec. Experienced rails
+      # developers may find this an easier approach to begin with, however
+      # we encourage you to explore using the isolation mode and revel
+      # in its benefits.
+      #
+      # == Expecting Errors
+      #
+      # Rspec on Rails will raise errors that occur in controller actions.
+      # In contrast, Rails will swallow errors that are raised in controller
+      # actions and return an error code in the header. If you wish to override
+      # Rspec and have Rail's default behaviour,tell the controller to use
+      # rails error handling ...
+      #
+      #   before(:each) do
+      #     controller.use_rails_error_handling!
+      #   end
+      #
+      # When using Rail's error handling, you can expect error codes in headers ...
+      #
+      #   it "should return an error in the header" do
+      #     response.should be_error
+      #   end
+      #
+      #   it "should return a 501" do
+      #     response.response_code.should == 501
+      #   end
+      #
+      #   it "should return a 501" do
+      #     response.code.should == "501"
+      #   end
+      class ControllerExampleGroup < FunctionalExampleGroup
+        class << self
+                    
+          # Use this to instruct RSpec to render views in your controller examples (Integration Mode).
+          #
+          #   describe ThingController do
+          #     integrate_views
+          #     ...
+          #
+          # See Spec::Rails::Example::ControllerExampleGroup for more information about
+          # Integration and Isolation modes.
+          def integrate_views(integrate_views = true)
+            @integrate_views = integrate_views
+          end
+          
+          def integrate_views? # :nodoc:
+            @integrate_views
+          end
+          
+          def inherited(klass) # :nodoc:
+            klass.controller_class_name = controller_class_name
+            klass.integrate_views(integrate_views?)
+            super
+          end
+
+          # You MUST provide a controller_name within the context of
+          # your controller specs:
+          #
+          #   describe "ThingController" do
+          #     controller_name :thing
+          #     ...
+          def controller_name(name)
+            @controller_class_name = "#{name}_controller".camelize
+          end
+          attr_accessor :controller_class_name # :nodoc:
+        end
+
+        before(:each) do
+          # Some Rails apps explicitly disable ActionMailer in environment.rb
+          if defined?(ActionMailer)
+            @deliveries = []
+            ActionMailer::Base.deliveries = @deliveries
+          end
+
+          unless @controller.class.ancestors.include?(ActionController::Base)
+            Spec::Expectations.fail_with <<-EOE
+            You have to declare the controller name in controller specs. For example:
+            describe "The ExampleController" do
+            controller_name "example" #invokes the ExampleController
+            end
+            EOE
+          end
+          (class << @controller; self; end).class_eval do
+            def controller_path #:nodoc:
+              self.class.name.underscore.gsub('_controller', '')
+            end
+            include ControllerInstanceMethods
+          end
+          @controller.integrate_views! if @integrate_views
+          @controller.session = session
+        end
+
+        attr_reader :response, :request, :controller
+
+        def initialize(defined_description, &implementation) #:nodoc:
+          super
+          controller_class_name = self.class.controller_class_name
+          if controller_class_name
+            @controller_class_name = controller_class_name.to_s
+          else
+            @controller_class_name = self.class.described_type.to_s
+          end
+          @integrate_views = self.class.integrate_views?
+        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)
+          ensure_that_routes_are_loaded
+          ActionController::Routing::Routes.generate(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
+          ActionController::Routing::Routes.recognize_path(path, :method => method)
+        end
+
+        protected
+        def _assigns_hash_proxy
+          @_assigns_hash_proxy ||= AssignsHashProxy.new self do
+            @response.template
+          end
+        end
+
+        private
+        def ensure_that_routes_are_loaded
+          ActionController::Routing::Routes.reload if ActionController::Routing::Routes.empty?
+        end
+
+        module ControllerInstanceMethods #:nodoc:
+          include Spec::Rails::Example::RenderObserver
+
+          # === render(options = nil, deprecated_status_or_extra_options = nil, &block)
+          #
+          # This gets added to the controller's singleton meta class,
+          # allowing Controller Examples to run in two modes, freely switching
+          # from context to context.
+          def render(options=nil, deprecated_status_or_extra_options=nil, &block)
+            if ::Rails::VERSION::STRING >= '2.0.0' && deprecated_status_or_extra_options.nil?
+              deprecated_status_or_extra_options = {}
+            end
+              
+            unless block_given?
+              unless integrate_views?
+                if @template.respond_to?(:finder)
+                  (class << @template.finder; self; end).class_eval do
+                    define_method :file_exists? do; true; end
+                  end
+                else
+                  (class << @template; self; end).class_eval do
+                    define_method :file_exists? do; true; end
+                  end
+                end
+                (class << @template; self; end).class_eval do
+                  define_method :render_file do |*args|
+                    @first_render ||= args[0] unless args[0] =~ /^layouts/
+                    @_first_render ||= args[0] unless args[0] =~ /^layouts/
+                  end
+                  
+                  define_method :_pick_template do |*args|
+                    @_first_render ||= args[0] unless args[0] =~ /^layouts/
+                    PickedTemplate.new
+                  end
+                end
+              end
+            end
+
+            if matching_message_expectation_exists(options)
+              render_proxy.render(options, &block)
+              @performed_render = true
+            else
+              if matching_stub_exists(options)
+                @performed_render = true
+              else
+                super(options, deprecated_status_or_extra_options, &block)
+              end
+            end
+          end
+          
+          def response(&block)
+            # NOTE - we're setting @update for the assert_select_spec - kinda weird, huh?
+            @update = block
+            @_response || @response
+          end
+
+          def integrate_views!
+            @integrate_views = true
+          end
+
+          private
+
+          def integrate_views?
+            @integrate_views
+          end
+
+          def matching_message_expectation_exists(options)
+            render_proxy.send(:__mock_proxy).send(:find_matching_expectation, :render, options)
+          end
+        
+          def matching_stub_exists(options)
+            render_proxy.send(:__mock_proxy).send(:find_matching_method_stub, :render, options)
+          end
+        
+        end
+
+        Spec::Example::ExampleGroupFactory.register(:controller, self)
+      end
+      
+      class PickedTemplate
+        def render_template(*ignore_args); end
+        def render_partial(*ignore_args);  end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,25 @@
+require 'action_controller/cookies'
+
+module Spec
+  module Rails
+    module Example
+      class CookiesProxy
+        def initialize(example)
+          @example = example
+        end
+      
+        def[]=(name, value)
+          @example.request.cookies[name.to_s] = CGI::Cookie.new(name.to_s, value)
+        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,87 @@
+module Spec
+  module Rails
+    module Example
+      class FunctionalExampleGroup < RailsExampleGroup
+        include ActionController::TestProcess
+        include ActionController::Assertions
+
+        attr_reader :request, :response
+        before(:each) do
+          @controller_class = Object.path2class @controller_class_name
+          raise "Can't determine controller class for #{@controller_class_name}" if @controller_class.nil?
+
+          @controller = @controller_class.new
+          @request = ActionController::TestRequest.new
+          @response = ActionController::TestResponse.new
+          @response.session = @request.session
+        end
+
+        def params
+          request.parameters
+        end
+
+        def flash
+          response.flash
+        end
+
+        def session
+          response.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 >= 1.2.6)
+        #
+        #   cookies[:user_id] = '1234'
+        #   get :index
+        #   assigns[:user].id.should == '1234'
+        #
+        #   post :login
+        #   cookies[:login].expires.should == 1.week.from_now
+        #
+        # == Examples (Rails >= 2.0.0 only)
+        #
+        #   cookies[:user_id] = {:value => '1234', :expires => 1.minute.ago}
+        #   get :index
+        #   response.should be_redirect
+        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) in order to avoid breaking old specs.
+        #++
+        def assigns(key = nil)
+          if key.nil?
+            _assigns_hash_proxy
+          else
+            _assigns_hash_proxy[key]
+          end
+        end
+
+      end
+    end
+  end
+end