dchelimsky-rspec-rails 1.1.6

data/generators/rspec_scaffold/templates/index_erb_spec.rb

@@ -0,0 +1,27 @@
+require File.expand_path(File.dirname(__FILE__) + '<%= '/..' * class_nesting_depth %>/../../spec_helper')
+
+describe "/<%= table_name %>/index.<%= default_file_extension %>" do
+  include <%= controller_class_name %>Helper
+  
+  before(:each) do
+    assigns[:<%= table_name %>] = [
+<% [1,2].each_with_index do |id, model_index| -%>
+      stub_model(<%= class_name %><%= attributes.empty? ? (model_index == 1 ? ')' : '),') : ',' %>
+<% attributes.each_with_index do |attribute, attribute_index| -%><% unless attribute.name =~ /_id/ || [:datetime, :timestamp, :time, :date].index(attribute.type) -%>
+        :<%= attribute.name %> => <%= attribute.default_value %><%= attribute_index == attributes.length - 1 ? '' : ','%>
+<% end -%><% end -%>
+<% if !attributes.empty? -%>
+      <%= model_index == 1 ? ')' : '),' %>
+<% end -%>
+<% end -%>
+    ]
+  end
+
+  it "should render list of <%= table_name %>" do
+    render "/<%= table_name %>/index.<%= default_file_extension %>"
+<% for attribute in attributes -%><% unless attribute.name =~ /_id/ || [:datetime, :timestamp, :time, :date].index(attribute.type) -%>
+    response.should have_tag("tr>td", <%= attribute.default_value %>, 2)
+<% end -%><% end -%>
+  end
+end
+

data/generators/rspec_scaffold/templates/new_erb_spec.rb

@@ -0,0 +1,26 @@
+require File.expand_path(File.dirname(__FILE__) + '<%= '/..' * class_nesting_depth %>/../../spec_helper')
+
+describe "/<%= table_name %>/new.<%= default_file_extension %>" do
+  include <%= controller_class_name %>Helper
+  
+  before(:each) do
+    assigns[:<%= file_name %>] = stub_model(<%= class_name %>,
+      :new_record? => true<%= attributes.empty? ? '' : ',' %>
+<% attributes.each_with_index do |attribute, attribute_index| -%><% unless attribute.name =~ /_id/ || [:datetime, :timestamp, :time, :date].index(attribute.type) -%>
+      :<%= attribute.name %> => <%= attribute.default_value %><%= attribute_index == attributes.length - 1 ? '' : ','%>
+<% end -%><% end -%>
+    )
+  end
+
+  it "should render new form" do
+    render "/<%= table_name %>/new.<%= default_file_extension %>"
+    
+    response.should have_tag("form[action=?][method=post]", <%= table_name %>_path) do
+<% for attribute in attributes -%><% unless attribute.name =~ /_id/ || [:datetime, :timestamp, :time, :date].index(attribute.type) -%>
+      with_tag("<%= attribute.input_type -%>#<%= file_name %>_<%= attribute.name %>[name=?]", "<%= file_name %>[<%= attribute.name %>]")
+<% end -%><% end -%>
+    end
+  end
+end
+
+

data/generators/rspec_scaffold/templates/routing_spec.rb

@@ -0,0 +1,59 @@
+require File.expand_path(File.dirname(__FILE__) + '<%= '/..' * class_nesting_depth %>/../spec_helper')
+
+describe <%= controller_class_name %>Controller do
+  describe "route generation" do
+    it "should map #index" do
+      route_for(:controller => "<%= table_name %>", :action => "index").should == "/<%= table_name %>"
+    end
+  
+    it "should map #new" do
+      route_for(:controller => "<%= table_name %>", :action => "new").should == "/<%= table_name %>/new"
+    end
+  
+    it "should map #show" do
+      route_for(:controller => "<%= table_name %>", :action => "show", :id => 1).should == "/<%= table_name %>/1"
+    end
+  
+    it "should map #edit" do
+      route_for(:controller => "<%= table_name %>", :action => "edit", :id => 1).should == "/<%= table_name %>/1<%= resource_edit_path %>"
+    end
+  
+    it "should map #update" do
+      route_for(:controller => "<%= table_name %>", :action => "update", :id => 1).should == "/<%= table_name %>/1"
+    end
+  
+    it "should map #destroy" do
+      route_for(:controller => "<%= table_name %>", :action => "destroy", :id => 1).should == "/<%= table_name %>/1"
+    end
+  end
+
+  describe "route recognition" do
+    it "should generate params for #index" do
+      params_from(:get, "/<%= table_name %>").should == {:controller => "<%= table_name %>", :action => "index"}
+    end
+  
+    it "should generate params for #new" do
+      params_from(:get, "/<%= table_name %>/new").should == {:controller => "<%= table_name %>", :action => "new"}
+    end
+  
+    it "should generate params for #create" do
+      params_from(:post, "/<%= table_name %>").should == {:controller => "<%= table_name %>", :action => "create"}
+    end
+  
+    it "should generate params for #show" do
+      params_from(:get, "/<%= table_name %>/1").should == {:controller => "<%= table_name %>", :action => "show", :id => "1"}
+    end
+  
+    it "should generate params for #edit" do
+      params_from(:get, "/<%= table_name %>/1<%= resource_edit_path %>").should == {:controller => "<%= table_name %>", :action => "edit", :id => "1"}
+    end
+  
+    it "should generate params for #update" do
+      params_from(:put, "/<%= table_name %>/1").should == {:controller => "<%= table_name %>", :action => "update", :id => "1"}
+    end
+  
+    it "should generate params for #destroy" do
+      params_from(:delete, "/<%= table_name %>/1").should == {:controller => "<%= table_name %>", :action => "destroy", :id => "1"}
+    end
+  end
+end

data/generators/rspec_scaffold/templates/show_erb_spec.rb

@@ -0,0 +1,23 @@
+require File.expand_path(File.dirname(__FILE__) + '<%= '/..' * class_nesting_depth %>/../../spec_helper')
+
+describe "/<%= table_name %>/show.<%= default_file_extension %>" do
+  include <%= controller_class_name %>Helper
+  
+  before(:each) do
+    assigns[:<%= file_name %>] = @<%= file_name %> = stub_model(<%= class_name %><%= attributes.empty? ? ')' : ',' %>
+<% attributes.each_with_index do |attribute, attribute_index| -%><% unless attribute.name =~ /_id/ || [:datetime, :timestamp, :time, :date].index(attribute.type) -%>
+      :<%= attribute.name %> => <%= attribute.default_value %><%= attribute_index == attributes.length - 1 ? '' : ','%>
+<% end -%><% end -%>
+<% if !attributes.empty? -%>
+    )
+<% end -%>
+  end
+
+  it "should render attributes in <p>" do
+    render "/<%= table_name %>/show.<%= default_file_extension %>"
+<% for attribute in attributes -%><% unless attribute.name =~ /_id/ || [:datetime, :timestamp, :time, :date].index(attribute.type) -%>
+    response.should have_text(/<%= Regexp.escape(attribute.default_value)[1..-2]%>/)
+<% end -%><% end -%>
+  end
+end
+

data/init.rb

@@ -0,0 +1,9 @@
+# Placeholder to satisfy Rails.
+#
+# Do NOT add any require statements to this file. Doing
+# so will cause Rails to load this plugin all of the time.
+#
+# Running 'ruby script/generate rspec' will
+# generate spec/spec_helper.rb, which includes the necessary
+# require statements and configuration. This file should
+# be required by all of your spec files.

data/lib/autotest/discover.rb

@@ -0,0 +1 @@
+# This needs to be here for >= ZenTest-3.9.0 to add this directory to the load path.

data/lib/autotest/rails_rspec.rb

@@ -0,0 +1,76 @@
+# (c) Copyright 2006 Nick Sieger <nicksieger@gmail.com>
+#
+# Permission is hereby granted, free of charge, to any person
+# obtaining a copy of this software and associated documentation files
+# (the "Software"), to deal in the Software without restriction,
+# including without limitation the rights to use, copy, modify, merge,
+# publish, distribute, sublicense, and/or sell copies of the Software,
+# and to permit persons to whom the Software is furnished to do so,
+# subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be
+# included in all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
+# BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
+# ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+# CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+# SOFTWARE.
+
+$:.push(*Dir["vendor/rails/*/lib"])
+
+require 'active_support'
+require 'autotest/rspec'
+
+Autotest.add_hook :initialize do |at|
+  %w{config/ coverage/ db/ doc/ log/ public/ script/ tmp/ vendor/rails vendor/plugins previous_failures.txt}.each do |exception|
+    at.add_exception(exception)
+  end
+  
+  at.clear_mappings
+  
+  at.add_mapping(%r%^(test|spec)/fixtures/(.*).yml$%) { |_, m|
+    ["spec/models/#{m[2].singularize}_spec.rb"] + at.files_matching(%r%^spec\/views\/#{m[2]}/.*_spec\.rb$%)
+  }
+  at.add_mapping(%r%^spec/(models|controllers|views|helpers|lib)/.*rb$%) { |filename, _|
+    filename
+  }
+  at.add_mapping(%r%^app/models/(.*)\.rb$%) { |_, m|
+    ["spec/models/#{m[1]}_spec.rb"]
+  }
+  at.add_mapping(%r%^app/views/(.*)$%) { |_, m|
+    at.files_matching %r%^spec/views/#{m[1]}_spec.rb$%
+  }
+  at.add_mapping(%r%^app/controllers/(.*)\.rb$%) { |_, m|
+    if m[1] == "application"
+      at.files_matching %r%^spec/controllers/.*_spec\.rb$%
+    else
+      ["spec/controllers/#{m[1]}_spec.rb"]
+    end
+  }
+  at.add_mapping(%r%^app/helpers/(.*)_helper\.rb$%) { |_, m|
+    if m[1] == "application" then
+      at.files_matching(%r%^spec/(views|helpers)/.*_spec\.rb$%)
+    else
+      ["spec/helpers/#{m[1]}_helper_spec.rb"] + at.files_matching(%r%^spec\/views\/#{m[1]}/.*_spec\.rb$%)
+    end
+  }
+  at.add_mapping(%r%^config/routes\.rb$%) {
+    at.files_matching %r%^spec/(controllers|views|helpers)/.*_spec\.rb$%
+  }
+  at.add_mapping(%r%^config/database\.yml$%) { |_, m|
+    at.files_matching %r%^spec/models/.*_spec\.rb$%
+  }
+  at.add_mapping(%r%^(spec/(spec_helper|shared/.*)|config/(boot|environment(s/test)?))\.rb$%) {
+    at.files_matching %r%^spec/(models|controllers|views|helpers)/.*_spec\.rb$%
+  }
+  at.add_mapping(%r%^lib/(.*)\.rb$%) { |_, m|
+    ["spec/lib/#{m[1]}_spec.rb"]
+  }
+end
+
+class Autotest::RailsRspec < Autotest::Rspec
+end

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

@@ -0,0 +1,37 @@
+module Spec
+  module Rails
+    module Example
+      class AssignsHashProxy #:nodoc:
+        def initialize(example_group, &block)
+          @target = block.call
+          @example_group = example_group
+        end
+
+        def [](key)
+          assigns[key] || assigns[key.to_s] || @target.instance_variable_get("@#{key}")
+        end
+
+        def []=(key, val)
+          @target.instance_variable_set("@#{key}", val)
+        end
+
+        def delete(key)
+          assigns.delete(key.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