Named routes and path helpers in Ruby on Rails

Introduction

Named routes give easy names to your URLs so you can use them in your code without typing the full path. Path helpers are methods that generate these URLs for you.

When you want to link to a page in your app without hardcoding the URL.

When you want to redirect users to a specific page after an action.

When you want to keep your URLs consistent and easy to update.

When you want to generate URLs dynamically in views or controllers.

When you want to improve code readability by using meaningful names.

Syntax

Ruby on Rails

get '/articles/:id', to: 'articles#show', as: 'article'

# Then in views or controllers:
article_path(id)  # returns the URL path for the article
article_url(id)   # returns the full URL including domain

The as: option defines the name of the route.

Use _path for relative URLs and _url for full URLs.

Examples

A simple named route without parameters.

Ruby on Rails

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

# Usage:
profile_path  # => "/profile"

Named route with a dynamic segment :id.

Ruby on Rails

get '/articles/:id', to: 'articles#show', as: 'article'

# Usage:
article_path(5)  # => "/articles/5"

Using resources generates many named routes automatically.

Ruby on Rails

resources :books

# Usage:
books_path       # => "/books"
new_book_path    # => "/books/new"
book_path(3)    # => "/books/3"

Sample Program

This example shows how to define named routes and use their path helpers to generate URLs. The welcome_path returns "/welcome" and product_path(10) returns "/products/10".

Ruby on Rails

# config/routes.rb
Rails.application.routes.draw do
  get '/welcome', to: 'home#welcome', as: 'welcome'
  get '/products/:id', to: 'products#show', as: 'product'
end

# app/controllers/home_controller.rb
class HomeController < ApplicationController
  def welcome
    render plain: "Welcome page"
  end
end

# app/controllers/products_controller.rb
class ProductsController < ApplicationController
  def show
    render plain: "Product ID: #{params[:id]}"
  end
end

# Usage in a view or controller:
# welcome_path  # => "/welcome"
# product_path(10)  # => "/products/10"

Important Notes

Always use named routes instead of hardcoding URLs to make your app easier to maintain.

Path helpers automatically handle URL encoding and parameters.

You can see all named routes by running rails routes in your terminal.

Summary

Named routes give easy names to URLs for cleaner code.

Path helpers generate URL strings using these names.

Use as: in routes to create named routes and call _path or _url helpers in your app.

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:'