Added Rspec and Webrat plugins and started porting Selenium on Rails tests to Rspec Plain Text Stories driving Webrat driving Selenium.

This commit is contained in:
Luke Melia 2008-06-18 02:57:57 -04:00
parent 0600756bbf
commit 0f7d6f7a1d
602 changed files with 47788 additions and 29 deletions

View file

@ -0,0 +1,43 @@
module Spec
module Rails
module Example
class AssignsHashProxy #:nodoc:
def initialize(object)
@object = object
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)
@object.instance_variable_set "@#{ivar}", val
assigns[ivar.to_s] = 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
@object.assigns
end
end
end
end
end

View file

@ -0,0 +1,271 @@
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 @controller
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]
end
end
end
end
if matching_message_expectation_exists(options)
expect_render_mock_proxy.render(options, &block)
@performed_render = true
else
unless matching_stub_exists(options)
super(options, deprecated_status_or_extra_options, &block)
end
end
end
def raise_with_disable_message(old_method, new_method)
raise %Q|
controller.#{old_method}(:render) has been disabled because it
can often produce unexpected results. Instead, you should
use the following (before the action):
controller.#{new_method}(*args)
See the rdoc for #{new_method} for more information.
|
end
def should_receive(*args)
if args[0] == :render
raise_with_disable_message("should_receive", "expect_render")
else
super
end
end
def stub!(*args)
if args[0] == :render
raise_with_disable_message("stub!", "stub_render")
else
super
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)
expect_render_mock_proxy.send(:__mock_proxy).send(:find_matching_expectation, :render, options)
end
def matching_stub_exists(options)
expect_render_mock_proxy.send(:__mock_proxy).send(:find_matching_method_stub, :render, options)
end
end
Spec::Example::ExampleGroupFactory.register(:controller, self)
end
end
end
end

View file

@ -0,0 +1,59 @@
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
# :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

View file

@ -0,0 +1,164 @@
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 helper
end
end
class HelperExampleGroupController < ApplicationController #:nodoc:
attr_accessor :request, :url
# Re-raise errors
def rescue_action(e); raise e; end
end
end
end
end

View file

@ -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

View file

@ -0,0 +1,29 @@
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
before(:each) do
setup_fixtures if self.respond_to?(:setup_fixtures)
end
after(:each) do
teardown_fixtures if self.respond_to?(:teardown_fixtures)
end
include Spec::Rails::Matchers
include Spec::Rails::Mocks
Spec::Example::ExampleGroupFactory.default(self)
end
end
end
end

View file

@ -0,0 +1,90 @@
require 'spec/mocks/framework'
module Spec
module Rails
module Example
# Provides specialized mock-like behaviour for controller and view examples,
# allowing you to mock or stub calls to render with specific arguments while
# ignoring all other calls.
module RenderObserver
# Similar to mocking +render+ with the exception that calls to +render+ with
# any other options are passed on to the receiver (i.e. controller in
# controller examples, template in view examples).
#
# This is necessary because Rails uses the +render+ method on both
# controllers and templates as a dispatcher to render different kinds of
# things, sometimes resulting in many calls to the render method within one
# request. This approach makes it impossible to use a normal mock object, which
# is designed to observe all incoming messages with a given name.
#
# +expect_render+ is auto-verifying, so failures will be reported without
# requiring you to explicitly request verification.
#
# Also, +expect_render+ uses parts of RSpec's mock expectation framework. Because
# it wraps only a subset of the framework, using this will create no conflict with
# other mock frameworks if you choose to use them. Additionally, the object returned
# by expect_render is an RSpec mock object, which means that you can call any of the
# chained methods available in RSpec's mocks.
#
# == Controller Examples
#
# controller.expect_render(:partial => 'thing', :object => thing)
# controller.expect_render(:partial => 'thing', :collection => things).once
#
# controller.stub_render(:partial => 'thing', :object => thing)
# controller.stub_render(:partial => 'thing', :collection => things).twice
#
# == View Examples
#
# template.expect_render(:partial => 'thing', :object => thing)
# template.expect_render(:partial => 'thing', :collection => things)
#
# template.stub_render(:partial => 'thing', :object => thing)
# template.stub_render(:partial => 'thing', :collection => things)
#
def expect_render(opts={})
register_verify_after_each
expect_render_mock_proxy.should_receive(:render, :expected_from => caller(1)[0]).with(opts)
end
# This is exactly like expect_render, with the exception that the call to render will not
# be verified. Use this if you are trying to isolate your example from a complicated render
# operation but don't care whether it is called or not.
def stub_render(opts={})
register_verify_after_each
expect_render_mock_proxy.stub!(:render, :expected_from => caller(1)[0]).with(opts)
end
def verify_rendered # :nodoc:
expect_render_mock_proxy.rspec_verify
end
def unregister_verify_after_each #:nodoc:
proc = verify_rendered_proc
Spec::Example::ExampleGroup.remove_after(:each, &proc)
end
protected
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 expect_render_mock_proxy #:nodoc:
@expect_render_mock_proxy ||= Spec::Mocks::Mock.new("expect_render_mock_proxy")
end
end
end
end
end

View file

@ -0,0 +1,178 @@
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 @controller
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
end
end
end
end