Module: ViewComponent::TestHelpers

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Instance Attribute Details

#rendered_component ⇒ Object (readonly) 



31
32
33
 
# File 'lib/view_component/test_helpers.rb', line 31

def rendered_component
  @rendered_component
end

Instance Method Details

#build_controller(klass) ⇒ Object 



151
152
153
 
# File 'lib/view_component/test_helpers.rb', line 151

def build_controller(klass)
  klass.new.tap { |c| c.request = request }.extend(Rails.application.routes.url_helpers)
end

#controller ⇒ Object 



70
71
72
 
# File 'lib/view_component/test_helpers.rb', line 70

def controller
  @controller ||= build_controller(Base.test_controller.constantize)
end

#render_in_view_context(&block) ⇒ Object

Execute the given block in the view context. Internally sets ‘page` to be a `Capybara::Node::Simple`, allowing for Capybara assertions to be used:

“‘ruby render_in_view_context do

render(MyComponent.new)

end

assert_text(“Hello, World!”) “‘



64
65
66
67
 
# File 'lib/view_component/test_helpers.rb', line 64

def render_in_view_context(&block)
  @rendered_component = controller.view_context.instance_exec(&block)
  Nokogiri::HTML.fragment(@rendered_component)
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) 


43
44
45
46
47
48
49
50
51
52
 
# File 'lib/view_component/test_helpers.rb', line 43

def render_inline(component, **args, &block)
  @rendered_component =
    if Rails.version.to_f >= 6.1
      controller.view_context.render(component, args, &block)
    else
      controller.view_context.render_component(component, &block)
    end

  Nokogiri::HTML.fragment(@rendered_component)
end

#request ⇒ Object 



75
76
77
78
79
80
81
82
 
# File 'lib/view_component/test_helpers.rb', line 75

def request
  @request ||=
    begin
      request = ActionDispatch::TestRequest.create
      request.session = ActionController::TestSession.new
      request
    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 (ActionController::Base) —

    The controller to be used.



112
113
114
115
116
117
118
119
 
# File 'lib/view_component/test_helpers.rb', line 112

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

  @controller = build_controller(klass)
  yield
ensure
  @controller = old_controller
end

#with_request_url(path) ⇒ 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 “‘

Parameters:

  • path (String) —

    The path to set for the current request.



130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
 
# File 'lib/view_component/test_helpers.rb', line 130

def with_request_url(path)
  old_request_path_info = request.path_info
  old_request_path_parameters = request.path_parameters
  old_request_query_parameters = request.query_parameters
  old_request_query_string = request.query_string
  old_controller = defined?(@controller) && @controller

  request.path_info = path
  request.path_parameters = Rails.application.routes.recognize_path(path)
  request.set_header("action_dispatch.request.query_parameters", Rack::Utils.parse_query(path.split("?")[1]))
  request.set_header(Rack::QUERY_STRING, path.split("?")[1])
  yield
ensure
  request.path_info = old_request_path_info
  request.path_parameters = old_request_path_parameters
  request.set_header("action_dispatch.request.query_parameters", old_request_query_parameters)
  request.set_header(Rack::QUERY_STRING, old_request_query_string)
  @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.



93
94
95
96
97
98
99
100
 
# File 'lib/view_component/test_helpers.rb', line 93

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

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