Devise gem overview in Ruby on Rails - Mini Project: Build & Apply

Devise Gem Overview in Rails

📖 Scenario: You are building a simple Rails application that needs user authentication. To make this easier, you will use the Devise gem, which helps add sign up, login, and logout features quickly.

🎯 Goal: Learn how to set up the Devise gem step-by-step in a Rails app. You will create the initial user model, configure Devise, add authentication routes, and complete the setup to have a working user login system.

📋 What You'll Learn

Create a new Rails app with Devise installed

Generate a User model with Devise modules

Configure Devise settings in the app

Add Devise routes to the application

Complete the setup to enable user authentication

💡 Why This Matters

🌍 Real World

Most web apps need user accounts and login features. Devise makes adding these features fast and secure.

💼 Career

Knowing how to use Devise is a key skill for Rails developers working on real-world applications with user authentication.

1

Install Devise and Generate User Model

Add the devise gem to your Gemfile and run bundle install. Then run rails generate devise:install to set up Devise. Finally, generate a User model with Devise by running rails generate devise User.

Ruby on Rails

# Add gem 'devise' to Gemfile and run bundle install
# Then run rails generate devise:install
# Then run rails generate devise User

Hint

Start by adding gem 'devise' to your Gemfile. Then run the commands to install and generate the User model.

2

Configure Devise Settings

Open the config/initializers/devise.rb file and set the config.mailer_sender to "[e-mail]". Also, ensure you have run rails db:migrate to create the users table.

Ruby on Rails

gem 'devise'

# Set config.mailer_sender in config/initializers/devise.rb
# Run rails db:migrate to create users table

Hint

Devise needs a mailer sender email set. Also, run migrations to create the users table.

3

Add Devise Routes to Your Application

In the config/routes.rb file, add devise_for :users to create all the routes needed for user authentication.

Ruby on Rails

gem 'devise'

# Add devise_for :users in config/routes.rb
# Your code here

Hint

This line adds all the routes Devise needs for user sign up, login, logout, and more.

4

Complete Setup and Test Authentication

Add a root route in config/routes.rb pointing to home#index. Create a simple HomeController with an index action and view. Use before_action :authenticate_user! in the controller to require login. This completes the Devise setup for user authentication.

Ruby on Rails

gem 'devise'

# Add root route and HomeController with authenticate_user! before_action
# Your code here

Hint

Set a root page and protect it so only logged-in users can see it.

Practice

1. What is the primary purpose of the Devise gem in a Rails application?

easy

A. To manage database migrations automatically

B. To add user authentication features like login and registration

C. To style the user interface with CSS

D. To optimize SQL queries for performance

Solution

1. Step 1: Understand Devise's role in Rails

   Devise is a gem designed to handle user authentication tasks such as login, registration, password recovery, and more.

2. Step 2: Compare options with Devise's purpose

   Options B, C, and D relate to database, styling, and optimization, which are not Devise's focus.

3. Final Answer:

   To add user authentication features like login and registration -> Option B

4. Quick Check:

   Devise = User authentication [OK]

Hint: Devise is about user login and registration [OK]

Common Mistakes:

• Confusing Devise with database or styling tools
• Thinking Devise manages database migrations
• Assuming Devise handles UI design

2. Which command correctly installs Devise in a Rails project?

easy

A. rails devise setup

B. rails new devise install

C. rails generate devise:install

D. gem install devise

Solution

1. Step 1: Identify the standard Devise installation command

   The correct command to set up Devise after adding it to the Gemfile is rails generate devise:install.

2. Step 2: Check other options for correctness

   A: rails devise setup is invalid syntax, B: rails new devise install is invalid syntax, C installs the gem globally but not in Rails.

3. Final Answer:

   rails generate devise:install -> Option C

4. Quick Check:

   Devise install command = rails generate devise:install [OK]

Hint: Use 'rails generate devise:install' to set up Devise [OK]

Common Mistakes:

• Using 'gem install devise' instead of Rails generator
• Typing incorrect Rails commands
• Confusing gem installation with setup commands

3. Given the following code snippet in a Rails app using Devise:

class User < ApplicationRecord
  devise :database_authenticatable, :registerable
end

What feature does the :registerable module add to the User model?

medium

A. Allows users to sign up and edit their registration details

B. Encrypts user passwords in the database

C. Enables password reset via email

D. Locks user accounts after failed login attempts

Solution

1. Step 1: Understand the :registerable module

   The :registerable module in Devise adds features for user sign-up, editing, and deleting their account.

2. Step 2: Match other options to correct modules

   Password encryption is handled by :database_authenticatable, password reset by :recoverable, and account locking by :lockable.

3. Final Answer:

   Allows users to sign up and edit their registration details -> Option A

4. Quick Check:

   :registerable = sign up and edit [OK]

Hint: :registerable means users can sign up and edit info [OK]

Common Mistakes:

• Confusing :registerable with password or lock features
• Assuming :registerable encrypts passwords
• Mixing up Devise modules

4. You added Devise to your Rails app and ran rails generate devise User, but you get an error saying uninitialized constant Devise. What is the most likely cause?

medium

A. You ran the generator before creating the User model manually

B. Devise does not support generating User models

C. You need to restart the Rails server before running the generator

D. You forgot to add gem 'devise' to your Gemfile and run bundle install

Solution

1. Step 1: Identify cause of 'uninitialized constant Devise'

   This error usually means the Devise gem is not loaded, often because it was not added to the Gemfile or bundle install was not run.

2. Step 2: Evaluate other options

   The generator creates the User model, so manual creation is not needed. Restarting server does not fix missing gem. Devise supports User model generation.

3. Final Answer:

   You forgot to add gem 'devise' to your Gemfile and run bundle install -> Option D

4. Quick Check:

   Missing gem in Gemfile = uninitialized constant error [OK]

Hint: Add gem and run bundle install before generators [OK]

Common Mistakes:

• Running generator without adding gem to Gemfile
• Assuming User model must exist before generator
• Restarting server without bundling

5. You want to add email confirmation to users signing up with Devise. Which steps should you follow to enable this feature?

hard

A. Add :confirmable to the User model's devise call, generate a migration to add confirmation fields, then run migrations

B. Add :confirmable to the User model and restart the server only

C. Add :confirmable to the User model and create a new controller for confirmations manually

D. Add :confirmable to the User model and update the routes file with confirmation paths

Solution

1. Step 1: Enable :confirmable in User model

   Add :confirmable to the list of Devise modules in the User model to activate confirmation features.

2. Step 2: Add confirmation fields via migration

   Generate and run a migration to add necessary database columns like confirmation_token and confirmed_at.

3. Step 3: Run database migrations

   Run rails db:migrate to apply changes so Devise can track confirmations.

4. Final Answer:

   Add :confirmable to the User model's devise call, generate a migration to add confirmation fields, then run migrations -> Option A

5. Quick Check:

   :confirmable + migration + migrate = email confirmation [OK]

Hint: Add :confirmable and migrate database to enable confirmation [OK]

Common Mistakes:

• Forgetting to create and run migration for confirmation fields
• Assuming adding :confirmable alone is enough
• Manually creating controllers unnecessarily