Module: ViewComponent::TestHelpers

Included in:
SystemTestHelpers, TestCase
Defined in:
lib/view_component/test_helpers.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Instance Attribute Details

#rendered_content ⇒ ActionView::OutputBuffer (readonly)

Returns the result of a render_inline call.

Returns:

  • (ActionView::OutputBuffer) 


38
39
40
 
# File 'lib/view_component/test_helpers.rb', line 38

def rendered_content
  @rendered_content
end

Instance Method Details

#render_in_view_context(*args, &block) ⇒ Object

Execute the given block in the view context (using ‘instance_exec`). Internally sets `page` to be a `Capybara::Node::Simple`, allowing for Capybara assertions to be used. All arguments are forwarded to the block.

“‘ruby render_in_view_context(arg1, arg2: nil) do |arg1, arg2:|

render(MyComponent.new(arg1, arg2))

end

assert_text(“Hello, World!”) “‘



124
125
126
127
128
 
# File 'lib/view_component/test_helpers.rb', line 124

def render_in_view_context(*args, &block)
  @page = nil
  @rendered_content = vc_test_controller.view_context.instance_exec(*args, &block)
  Nokogiri::HTML.fragment(@rendered_content)
end

#render_inline(component, **args, &block) ⇒ Nokogiri::HTML

Render a component inline. Internally sets ‘page` to be a `Capybara::Node::Simple`, allowing for Capybara assertions to be used:

“‘ruby render_inline(MyComponent.new) assert_text(“Hello, World!”) “`

Parameters:

Returns:

  • (Nokogiri::HTML) 


50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
 
# File 'lib/view_component/test_helpers.rb', line 50

def render_inline(component, **args, &block)
  @page = nil
  @rendered_content =
    if Rails.version.to_f >= 6.1
      vc_test_controller.view_context.render(component, args, &block)

    # :nocov:
    else
      vc_test_controller.view_context.render_component(component, &block)
    end

  # :nocov:

  Nokogiri::HTML.fragment(@rendered_content)
end

#render_preview(name, from: __vc_test_helpers_preview_class, params: {}) ⇒ Nokogiri::HTML

Render a preview inline. Internally sets ‘page` to be a `Capybara::Node::Simple`, allowing for Capybara assertions to be used:

“‘ruby render_preview(:default) assert_text(“Hello, World!”) “`

Note: ‘#rendered_preview` expects a preview to be defined with the same class name as the calling test, but with `Test` replaced with `Preview`:

MyComponentTest -> MyComponentPreview etc.

In RSpec, ‘Preview` is appended to `described_class`.

Parameters:

  • name (String) —

    The name of the preview to be rendered.

  • from (ViewComponent::Preview) (defaults to: __vc_test_helpers_preview_class) —

    The class of the preview to be rendered.

  • params (Hash) (defaults to: {}) —

    Parameters to be passed to the preview.

Returns:

  • (Nokogiri::HTML) 


95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
 
# File 'lib/view_component/test_helpers.rb', line 95

def render_preview(name, from: __vc_test_helpers_preview_class, params: {})
  previews_controller = __vc_test_helpers_build_controller(Rails.application.config.view_component.preview_controller.constantize)

  # From what I can tell, it's not possible to overwrite all request parameters
  # at once, so we set them individually here.
  params.each do |k, v|
    previews_controller.request.params[k] = v
  end

  previews_controller.request.params[:path] = "#{from.preview_name}/#{name}"
  previews_controller.set_response!(ActionDispatch::Response.new)
  result = previews_controller.previews

  @rendered_content = result

  Nokogiri::HTML.fragment(@rendered_content)
end

#rendered_json ⇒ Object

‘JSON.parse`-d component output.

“‘ruby render_inline(MyJsonComponent.new) assert_equal(rendered_json, “world”) “`



72
73
74
 
# File 'lib/view_component/test_helpers.rb', line 72

def rendered_json
  JSON.parse(rendered_content)
end

#vc_test_controller ⇒ ActionController::Base

Access the controller used by ‘render_inline`:

“‘ruby test “logged out user sees login link” do

vc_test_controller.expects(:logged_in?).at_least_once.returns(false)
render_inline(LoginComponent.new)
assert_selector("[aria-label='You must be signed in']")

end “‘

Returns:

  • (ActionController::Base) 


252
253
254
 
# File 'lib/view_component/test_helpers.rb', line 252

def vc_test_controller
  @vc_test_controller ||= __vc_test_helpers_build_controller(Base.test_controller.constantize)
end

#vc_test_request ⇒ ActionDispatch::TestRequest

Access the request used by ‘render_inline`:

“‘ruby test “component does not render in Firefox” do

request.env["HTTP_USER_AGENT"] = "Mozilla/5.0"
render_inline(NoFirefoxComponent.new)
refute_component_rendered

end “‘

Returns:

  • (ActionDispatch::TestRequest) 


267
268
269
270
271
272
273
274
275
276
 
# File 'lib/view_component/test_helpers.rb', line 267

def vc_test_request
  require "action_controller/test_case"

  @vc_test_request ||=
    begin
      out = ActionDispatch::TestRequest.create
      out.session = ActionController::TestSession.new
      out
    end
end

#with_controller_class(klass) ⇒ Object

Set the controller to be used while executing the given block, allowing access to controller-specific methods:

“‘ruby with_controller_class(UsersController) do

render_inline(MyComponent.new)

end “‘

Parameters:

  • klass (Class<ActionController::Base>) —

    The controller to be used.



159
160
161
162
163
164
165
166
 
# File 'lib/view_component/test_helpers.rb', line 159

def with_controller_class(klass)
  old_controller = defined?(@vc_test_controller) && @vc_test_controller

  @vc_test_controller = __vc_test_helpers_build_controller(klass)
  yield
ensure
  @vc_test_controller = old_controller
end

#with_format(format) ⇒ Object

Set format of the current request

“‘ruby with_format(:json) do

render_inline(MyComponent.new)

end “‘

Parameters:

  • format (Symbol) —

    The format to be set for the provided block.



177
178
179
 
# File 'lib/view_component/test_helpers.rb', line 177

def with_format(format)
  with_request_url("/", format: format) { yield }
end

#with_request_url(full_path, host: nil, method: nil, format: ViewComponent::Base::VC_INTERNAL_DEFAULT_FORMAT) ⇒ Object

Set the URL of the current request (such as when using request-dependent path helpers):

“‘ruby with_request_url(“/users/42”) do

render_inline(MyComponent.new)

end “‘

To use a specific host, pass the host param:

“‘ruby with_request_url(“/users/42”, host: “app.example.com”) do

render_inline(MyComponent.new)

end “‘

To specify a request method, pass the method param:

“‘ruby with_request_url(“/users/42”, method: “POST”) do

render_inline(MyComponent.new)

end “‘

Parameters:

  • full_path (String) —

    The path to set for the current request.

  • host (String) (defaults to: nil) —

    The host to set for the current request.

  • method (String) (defaults to: nil) —

    The request method to set for the current request.



208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
 
# File 'lib/view_component/test_helpers.rb', line 208

def with_request_url(full_path, host: nil, method: nil, format: ViewComponent::Base::VC_INTERNAL_DEFAULT_FORMAT)
  old_request_host = vc_test_request.host
  old_request_method = vc_test_request.request_method
  old_request_path_info = vc_test_request.path_info
  old_request_path_parameters = vc_test_request.path_parameters
  old_request_query_parameters = vc_test_request.query_parameters
  old_request_query_string = vc_test_request.query_string
  old_request_format = vc_test_request.format.symbol
  old_controller = defined?(@vc_test_controller) && @vc_test_controller

  path, query = full_path.split("?", 2)
  vc_test_request.instance_variable_set(:@fullpath, full_path)
  vc_test_request.instance_variable_set(:@original_fullpath, full_path)
  vc_test_request.host = host if host
  vc_test_request.request_method = method if method
  vc_test_request.path_info = path
  vc_test_request.path_parameters = Rails.application.routes.recognize_path_with_request(vc_test_request, path, {})
  vc_test_request.set_header("action_dispatch.request.query_parameters",
    Rack::Utils.parse_nested_query(query).with_indifferent_access)
  vc_test_request.set_header(Rack::QUERY_STRING, query)
  vc_test_request.format = format
  yield
ensure
  vc_test_request.host = old_request_host
  vc_test_request.request_method = old_request_method
  vc_test_request.path_info = old_request_path_info
  vc_test_request.path_parameters = old_request_path_parameters
  vc_test_request.set_header("action_dispatch.request.query_parameters", old_request_query_parameters)
  vc_test_request.set_header(Rack::QUERY_STRING, old_request_query_string)
  vc_test_request.format = old_request_format
  @vc_test_controller = old_controller
end

#with_variant(variant) ⇒ Object

Set the Action Pack request variant for the given block:

“‘ruby with_variant(:phone) do

render_inline(MyComponent.new)

end “‘

Parameters:

  • variant (Symbol) —

    The variant to be set for the provided block.



140
141
142
143
144
145
146
147
 
# File 'lib/view_component/test_helpers.rb', line 140

def with_variant(variant)
  old_variants = vc_test_controller.view_context.lookup_context.variants

  vc_test_controller.view_context.lookup_context.variants = variant
  yield
ensure
  vc_test_controller.view_context.lookup_context.variants = old_variants
end