Named routes and path helpers in Ruby on Rails - Cheat Sheet & Quick Revision

Recall & Review

beginner

What is a named route in Rails?

A named route is a shortcut that Rails creates for a URL pattern. It lets you use a simple method name instead of writing the full URL or path every time.

beginner

How do you use a path helper in a Rails view?

You call the helper method like posts_path or new_post_path to get the URL or path string for that route. This helps keep your code clean and easy to change.

intermediate

Example: What does edit_user_path(@user) return?

It returns the URL path to edit the user with the ID of @user. For example, if @user.id is 5, it returns /users/5/edit.

beginner

Why are named routes and path helpers better than hardcoding URLs?

They make your code easier to read and maintain. If you change the route in one place, all helpers update automatically. It also helps avoid mistakes and broken links.

intermediate

How do you define a named route in Rails routes file?

You define it by giving a name to a route in config/routes.rb. For example, get 'profile', to: 'users#show', as: 'profile' creates a profile_path helper.

What does the helper new_post_path usually return?

A The URL path to show a post

B The URL path to create a new post form

C The full URL of the homepage

D The URL path to delete a post

new_post_path returns the path to the form where you can create a new post, usually /posts/new.

How do you pass a model instance to a path helper for a show page?

A You pass the model instance as an argument, e.g., <code>post_path(@post)</code>

B You pass the model's class name as a string

C You don't pass anything, just call <code>post_path</code>

D You pass the model's ID as a string only

Passing the model instance lets Rails extract the ID and build the correct path, like /posts/3.

What is the benefit of using named routes over hardcoded URLs?

A They only work in controllers

B They make the app slower

C They require more typing

D They automatically update if routes change

Named routes keep your code DRY and update automatically if you change routes.

Where do you define named routes in a Rails app?

A In the controller files

B In the view templates

C In <code>config/routes.rb</code>

D In the model files

All routes, including named routes, are defined in config/routes.rb.

What helper method would Rails create for this route? get 'dashboard', to: 'home#index', as: 'dashboard'

A <code>dashboard_path</code>

B <code>home_path</code>

C <code>index_path</code>

D <code>dashboard_url</code>

The as: 'dashboard' option creates the dashboard_path helper.

Explain what named routes and path helpers are in Rails and why they are useful.

Think about how you avoid repeating full URLs in your code.

Describe how you would use a path helper in a Rails view to link to a user's edit page.

Consider how you create links to edit forms in Rails.

Practice

1. What is the main purpose of named routes in Rails?

easy

A. To automatically generate database tables

B. To style HTML elements with CSS

C. To give easy-to-use names for URLs in the app

D. To handle user authentication

Solution

1. Step 1: Understand named routes concept

   Named routes assign simple names to URL patterns in Rails routes file.

2. Step 2: Identify their purpose

   These names help generate URL or path helpers for cleaner, readable code.

3. Final Answer:

   To give easy-to-use names for URLs in the app -> Option C

4. Quick Check:

   Named routes = URL names [OK]

Hint: Named routes = easy URL names for helpers [OK]

Common Mistakes:

• Confusing named routes with database features
• Thinking named routes style HTML
• Mixing named routes with authentication

2. Which syntax correctly defines a named route for a 'profile' page in config/routes.rb?

easy

A. get '/profile', to: 'users#show', as: 'profile'

B. route '/profile' => 'users#show', name: 'profile'

C. get '/profile' => 'users#show', named: 'profile'

D. path '/profile', controller: 'users', action: 'show', alias: 'profile'

Solution

1. Step 1: Recall correct named route syntax

   Rails uses get '/url', to: 'controller#action', as: 'name' format.

2. Step 2: Match options to syntax

   get '/profile', to: 'users#show', as: 'profile' matches this exactly; others use invalid keywords.

3. Final Answer:

   get '/profile', to: 'users#show', as: 'profile' -> Option A

4. Quick Check:

   Correct named route syntax = get '/profile', to: 'users#show', as: 'profile' [OK]

Hint: Use 'get', 'to:', and 'as:' for named routes [OK]

Common Mistakes:

• Using wrong keywords like 'route' or 'named'
• Mixing hash rocket and symbol syntax incorrectly
• Forgetting 'as:' for naming the route

3. Given this route: get '/dashboard', to: 'home#dashboard', as: 'dashboard', what does dashboard_path return?

medium

A. '/dashboard_path'

B. '/home/dashboard'

C. 'dashboard_url'

D. '/dashboard'

Solution

1. Step 1: Understand named route helper

   The named route 'dashboard' creates dashboard_path helper returning the URL path string.

2. Step 2: Match helper output

   Since route is '/dashboard', dashboard_path returns '/dashboard'.

3. Final Answer:

   '/dashboard' -> Option D

4. Quick Check:

   dashboard_path = '/dashboard' [OK]

Hint: Named route 'foo' creates 'foo_path' returning URL path [OK]

Common Mistakes:

• Confusing _path with _url helpers
• Expecting controller/action strings
• Adding extra suffixes like '_path' in output

4. Identify the error in this route definition: get '/items', to: 'items#index', as: items_path

medium

A. The HTTP verb 'get' is incorrect here

B. The named route should be a symbol or string, not a method call

C. The controller action 'items#index' is invalid syntax

D. The URL path '/items' must not start with a slash

Solution

1. Step 1: Check named route naming

   The as: option expects a symbol or string name, not a method call like items_path.

2. Step 2: Identify correct usage

   It should be as: :items or as: 'items' to create items_path helper.

3. Final Answer:

   The named route should be a symbol or string, not a method call -> Option B

4. Quick Check:

   Use symbol/string for 'as:' [OK]

Hint: Use symbol/string for 'as:', not helper method call [OK]

Common Mistakes:

• Passing helper method name instead of symbol/string
• Misunderstanding 'as:' purpose
• Thinking HTTP verb or path is wrong here

5. You want to create a named route for editing a user profile with URL /users/:id/edit. Which route definition and helper usage is correct?

hard

A. Route: get '/users/:id/edit', to: 'users#edit', as: 'edit_user'; Helper: edit_user_path(5)

B. Route: get '/users/edit/:id', to: 'users#edit', as: 'edit_user'; Helper: edit_user_path(5)

C. Route: get '/users/:id/edit', to: 'users#edit', as: :edit_user; Helper: edit_user_url

D. Route: get '/users/edit/:id', to: 'users#edit', as: :edit_user; Helper: edit_user_path

Solution

1. Step 1: Confirm correct URL pattern

   The edit user URL is conventionally '/users/:id/edit'.

2. Step 2: Check named route and helper usage

   Route: get '/users/:id/edit', to: 'users#edit', as: 'edit_user'; Helper: edit_user_path(5) uses string for 'as:' and calls edit_user_path(5) which is correct. Route: get '/users/:id/edit', to: 'users#edit', as: :edit_user; Helper: edit_user_url uses symbol but calls edit_user_url without argument, which is incomplete.

3. Final Answer:

   Route: get '/users/:id/edit', to: 'users#edit', as: 'edit_user'; Helper: edit_user_path(5) -> Option A

4. Quick Check:

   Correct path + named route + helper call = Route: get '/users/:id/edit', to: 'users#edit', as: 'edit_user'; Helper: edit_user_path(5) [OK]

Hint: Use '/users/:id/edit' and call edit_user_path(id) [OK]

Common Mistakes:

• Swapping :id and 'edit' in URL path
• Using _url helper without required id argument
• Using symbol/string inconsistently for 'as:'