module RSpec::Rails::ViewExampleGroup::ExampleMethods
DSL exposed to view specs.
Public Instance Methods
Provides access to the params hash that will be available within the view.
params[:foo] = 'bar'
# File lib/rspec/rails/example/view_example_group.rb, line 99 def params controller.params end
@overload render @overload render({partial: path_to_file}) @overload render({partial: path_to_file}, {… locals …}) @overload render({partial: path_to_file}, {… locals …}) do … end
Delegates to ActionView::Base#render, so see documentation on that for more info.
The only addition is that you can call render with no arguments, and RSpec
will pass the top level description to render:
describe "widgets/new.html.erb" do it "shows all the widgets" do render # => view.render(file: "widgets/new.html.erb") # ... end end
# File lib/rspec/rails/example/view_example_group.rb, line 66 def render(options = {}, local_assigns = {}, &block) options = _default_render_options if Hash === options && options.empty? super(options, local_assigns, &block) end
@deprecated Use ‘rendered` instead.
# File lib/rspec/rails/example/view_example_group.rb, line 110 def response # `assert_template` expects `response` to implement a #body method # like an `ActionDispatch::Response` does to force the view to # render. For backwards compatibility, we use #response as an alias # for #rendered, but it needs to implement #body to avoid # `assert_template` raising a `NoMethodError`. unless rendered.respond_to?(:body) def rendered.body self end end rendered end
Simulates the presence of a template on the file system by adding a Rails’ FixtureResolver to the front of the view_paths list. Designed to help isolate view examples from partials rendered by the view template that is the subject of the example.
stub_template("widgets/_widget.html.erb" => "This content.")
# File lib/rspec/rails/example/view_example_group.rb, line 91 def stub_template(hash) view.view_paths.unshift(StubResolverCache.resolver_for(hash)) end
@deprecated Use ‘view` instead.
# File lib/rspec/rails/example/view_example_group.rb, line 104 def template RSpec.deprecate("template", replacement: "view") view end
The instance of ‘ActionView::Base` that is used to render the template. Use this to stub methods before calling `render`.
describe "widgets/new.html.erb" do it "shows all the widgets" do view.stub(:foo) { "foo" } render # ... end end
# File lib/rspec/rails/example/view_example_group.rb, line 81 def view _view end
Private Instance Methods
# File lib/rspec/rails/example/view_example_group.rb, line 165 def _controller_path _path_parts[0..-2].join("/") end
# File lib/rspec/rails/example/view_example_group.rb, line 127 def _default_render_options formats = if ActionView::Template::Types.respond_to?(:symbols) ActionView::Template::Types.symbols else [:html, :text, :js, :css, :xml, :json].map(&:to_s) end.map { |x| Regexp.escape(x) }.join("|") handlers = ActionView::Template::Handlers.extensions.map { |x| Regexp.escape(x) }.join("|") locales = "[a-z]{2}(?:-[A-Z]{2})?" variants = "[^.]*" path_regex = %r{ \A (?<template>.*?) (?:\.(?<locale>#{locales}))?? (?:\.(?<format>#{formats}))?? (?:\+(?<variant>#{variants}))?? (?:\.(?<handler>#{handlers}))? \z }x # This regex should always find a match. # Worst case, everything will be nil, and :template will just be # the original string. match = path_regex.match(_default_file_to_render) render_options = { template: match[:template] } render_options[:handlers] = [match[:handler].to_sym] if match[:handler] render_options[:formats] = [match[:format].to_sym] if match[:format] render_options[:locales] = [match[:locale].to_sym] if match[:locale] render_options[:variants] = [match[:variant].to_sym] if match[:variant] render_options end
# File lib/rspec/rails/example/view_example_group.rb, line 173 def _include_controller_helpers helpers = controller._helpers view.singleton_class.class_exec do include helpers unless included_modules.include?(helpers) end end
# File lib/rspec/rails/example/view_example_group.rb, line 169 def _inferred_action _path_parts.last.split(".").first end
# File lib/rspec/rails/example/view_example_group.rb, line 161 def _path_parts _default_file_to_render.split("/") end