Passing data to partials in Ruby on Rails

Introduction

Partials help reuse small pieces of view code. Passing data to partials lets you show different content inside the same partial.

You want to show a user profile card in many pages but with different user info.

You have a list of products and want to render each product using the same layout.

You want to reuse a comment box partial but with different comments each time.

You want to pass a title or message to a shared header partial.

You want to customize a form partial with different objects.

Syntax

Ruby on Rails

<%= render partial: 'partial_name', locals: { key: value } %>

Use locals to send data as key-value pairs to the partial.

Inside the partial, use the key as a local variable to access the passed data.

Examples

Passes the @user object to the _user.html.erb partial as user.

Ruby on Rails

<%= render partial: 'user', locals: { user: @user } %>

Shortcut syntax to pass @product as product to the _product.html.erb partial.

Ruby on Rails

<%= render 'product', product: @product %>

Passes a simple string 'Hello!' as text to the _message.html.erb partial.

Ruby on Rails

<%= render partial: 'message', locals: { text: 'Hello!' } %>

Sample Program

This example shows a user profile page. The show.html.erb view renders the _user_info.html.erb partial and passes the @user object as user. The partial then displays the user's name and email.

Ruby on Rails

<!-- app/views/users/show.html.erb -->
<h1>User Profile</h1>
<%= render partial: 'user_info', locals: { user: @user } %>

<!-- app/views/users/_user_info.html.erb -->
<p>Name: <%= user.name %></p>
<p>Email: <%= user.email %></p>

<!-- app/controllers/users_controller.rb -->
class UsersController < ApplicationController
  def show
    @user = OpenStruct.new(name: 'Alice', email: '[e-mail]')
  end
end

Important Notes

Partial names start with an underscore but you omit it when rendering.

Passing data with locals keeps partials flexible and reusable.

If you don't pass data, partials can still access instance variables from the parent view.

Summary

Partials let you reuse view code in Rails.

Use locals to pass data to partials as local variables.

This makes your views cleaner and easier to maintain.

Practice

1. What is the main purpose of using locals when rendering partials in Rails?

easy

A. To create a new controller action

B. To include JavaScript files in the partial

C. To define CSS styles for the partial

D. To pass data as local variables to the partial

Solution

1. Step 1: Understand partials in Rails

   Partials are reusable view templates that help keep code DRY (Don't Repeat Yourself).

2. Step 2: Role of locals

   The locals option lets you pass data as local variables to the partial, making it flexible and dynamic.

3. Final Answer:

   To pass data as local variables to the partial -> Option D

4. Quick Check:

   Passing data to partials = locals [OK]

Hint: Remember: locals pass data inside partials [OK]

Common Mistakes:

• Confusing locals with JavaScript or CSS inclusion
• Thinking partials create controller actions
• Assuming locals define styles

2. Which of the following is the correct syntax to pass a local variable named user with value @user to a partial called _profile.html.erb?

easy

A. <%= render partial: profile, user: @user %>

B. <%= render 'profile', locals: { user: @user } %>

C. <%= render profile, user: @user %>

D. <%= render partial: 'profile', locals: user: @user %>

Solution

1. Step 1: Identify correct render syntax with locals

   The correct way to pass locals is using locals: { key: value } inside the render call.

2. Step 2: Check each option

   <%= render 'profile', locals: { user: @user } %> uses locals: { user: @user } which is correct syntax. Others miss the locals hash or have wrong syntax.

3. Final Answer:

   <%= render 'profile', locals: { user: @user } %> -> Option B

4. Quick Check:

   Use locals hash to pass variables [OK]

Hint: Use locals: { var: value } to pass data [OK]

Common Mistakes:

• Omitting the locals keyword
• Passing variables directly without locals hash
• Incorrect hash syntax for locals

3. Given the following code in a Rails view:

user = User.new(name: 'Alice')
<%= render 'user_info', locals: { user: user } %>

And the partial _user_info.html.erb contains:

<p>Name: <%= user.name %></p>

What will be the rendered output?

medium

A. Name: Alice

B. Name:

C. Error: undefined local variable 'user'

D. Name: user

Solution

1. Step 1: Understand locals passing

   The variable user is passed as a local variable to the partial with value User.new(name: 'Alice').

2. Step 2: Partial uses user.name

   The partial accesses user.name, which is 'Alice', so it renders the name correctly.

3. Final Answer:

   <p>Name: Alice</p> -> Option A

4. Quick Check:

   Locals pass data correctly = Alice shown [OK]

Hint: Locals become variables inside partial [OK]

Common Mistakes:

• Forgetting to pass locals causes undefined variable error
• Assuming instance variables are automatically available
• Confusing variable names inside partial

4. Identify the error in this code snippet:

<%= render partial: 'comment', locals: { comment: @comment } %>

# In _comment.html.erb
<p><%= comment_text %></p>

What will happen when this view is rendered?

medium

A. Error: undefined local variable or method 'comment_text'

B. Renders the comment text correctly

C. Syntax error in render call

D. Renders nothing inside the paragraph

Solution

1. Step 1: Check locals passed to partial

   The locals hash passes comment: @comment, so inside the partial the variable comment is available.

2. Step 2: Check variable used in partial

   The partial uses comment_text, which is not defined or passed, causing an undefined variable error.

3. Final Answer:

   Error: undefined local variable or method 'comment_text' -> Option A

4. Quick Check:

   Variable name mismatch causes error [OK]

Hint: Variable names must match locals keys exactly [OK]

Common Mistakes:

• Using wrong variable name inside partial
• Assuming instance variables are available without passing
• Not passing required locals

5. You want to render a list of products using a partial _product.html.erb and pass each product as a local variable named item. Which code correctly renders the list with locals?

hard

A. <%= render product, collection: @products, as: :item %>

B. <%= render partial: 'product', collection: @products, locals: { item: product } %>

C. <%= render partial: 'product', collection: @products, as: :item %>

D. <% @products.each do |p| %>
<%= render 'product', locals: { item: product } %>
<% end %>

Solution

1. Step 1: Understand rendering collections with locals

   Rails allows rendering a collection with render partial: 'name', collection: array, as: :var to pass each element as a local variable.

2. Step 2: Check each option

   <%= render partial: 'product', collection: @products, as: :item %> correctly uses partial, collection, and as: :item to pass each product as item local variable. The <% @products.each do |p| %> <%= render 'product', locals: { item: product } %> <% end %> uses manual loop but product is undefined (loop var is p). The <%= render partial: 'product', collection: @products, locals: { item: product } %> has wrong locals usage (product undefined). The <%= render product, collection: @products, as: :item %> misses partial keyword and unquoted product undefined.

3. Final Answer:

   <%= render partial: 'product', collection: @products, as: :item %> -> Option C

4. Quick Check:

   Use collection + as for locals in partial [OK]

Hint: Use collection and as: :var for lists [OK]

Common Mistakes:

• Passing locals inside collection render incorrectly
• Forgetting to use as: to rename local variable
• Using manual loops instead of collection render