Gemfile and dependency management in Ruby on Rails - Mini Project: Build & Apply

Managing Dependencies with Gemfile in Rails

📖 Scenario: You are building a new Rails application that needs some external libraries (gems) to add features like authentication and styling.To keep your project organized and ensure everyone uses the same versions of these libraries, you will use a Gemfile to manage dependencies.

🎯 Goal: Create a Gemfile with specific gems and versions, then configure and install them properly to prepare your Rails app for development.

📋 What You'll Learn

Create a Gemfile with exact gem entries

Add a Ruby version declaration in the Gemfile

Use bundle install to install the gems

Add a group block for development and test gems

💡 Why This Matters

🌍 Real World

Managing dependencies with a Gemfile is essential for any Rails project to ensure all developers use the same library versions and avoid conflicts.

💼 Career

Understanding Gemfile and dependency management is a fundamental skill for Rails developers, crucial for maintaining stable and secure applications.

1

Create the initial Gemfile with Ruby version and main gems

Create a Gemfile that specifies Ruby version '3.2.2' and includes these gems exactly: rails version '7.0.4', pg version '1.4', and puma version '5.6'. Write the lines exactly as shown.

Ruby on Rails

# Your code here

Hint

Start your Gemfile by declaring the Ruby version with ruby '3.2.2'. Then add each gem with gem 'name', 'version'.

2

Add a group block for development and test gems

Below the existing gems, add a group :development, :test do block that includes the gems byebug version '11.1' and rspec-rails version '5.0'. Close the group block properly.

Ruby on Rails

ruby '3.2.2'
gem 'rails', '7.0.4'
gem 'pg', '1.4'
gem 'puma', '5.6'
# Add development and test group gems below

Hint

Use group :development, :test do to wrap gems used only in development and testing. Don't forget the end to close the block.

3

Run bundle install to install the gems

Run the command bundle install in your terminal to install all gems listed in the Gemfile and generate the Gemfile.lock file.

Ruby on Rails

ruby '3.2.2'
gem 'rails', '7.0.4'
gem 'pg', '1.4'
gem 'puma', '5.6'
group :development, :test do
  gem 'byebug', '11.1'
  gem 'rspec-rails', '5.0'
end
# Run bundle install in terminal

Hint

Open your terminal in the project folder and type bundle install to install the gems and create Gemfile.lock.

4

Verify the Gemfile.lock and finalize setup

Confirm that the Gemfile.lock file is created and add a comment in your Gemfile that says # Gems installed and locked at the end of the file.

Ruby on Rails

ruby '3.2.2'
gem 'rails', '7.0.4'
gem 'pg', '1.4'
gem 'puma', '5.6'
group :development, :test do
  gem 'byebug', '11.1'
  gem 'rspec-rails', '5.0'
end
# Run 'bundle install' in terminal to install gems
# Add a comment confirming gems are installed

Hint

Look for the Gemfile.lock file in your project folder after running bundle install. Then add the comment at the end of your Gemfile.

Practice

1. What is the main purpose of a Gemfile in a Rails application?

easy

A. To list all the gems the app needs and manage their versions

B. To write Ruby code for the app's business logic

C. To configure the database connection settings

D. To define routes for the web application

Solution

1. Step 1: Understand the role of Gemfile

   The Gemfile is a file where you list all the extra tools (called gems) your Rails app needs to work properly.

2. Step 2: Identify what Gemfile manages

   It also helps keep everyone using the same versions of these gems, so the app runs the same everywhere.

3. Final Answer:

   To list all the gems the app needs and manage their versions -> Option A

4. Quick Check:

   Gemfile purpose = list gems and versions [OK]

Hint: Gemfile lists gems and versions for consistent setup [OK]

Common Mistakes:

• Confusing Gemfile with database config
• Thinking Gemfile contains app code
• Mixing Gemfile with routing files

2. Which of the following is the correct syntax to add the gem 'devise' in a Gemfile?

easy

A. gem 'devise'

B. gem devise

C. add_gem 'devise'

D. install 'devise'

Solution

1. Step 1: Recall Gemfile gem syntax

   In a Gemfile, gems are added using the keyword gem followed by the gem name in quotes.

2. Step 2: Check each option

   Only gem 'devise' uses the correct syntax: gem 'devise'. Others are invalid Ruby or Gemfile syntax.

3. Final Answer:

   gem 'devise' -> Option A

4. Quick Check:

   Correct gem syntax = gem 'name' [OK]

Hint: Use gem 'name' with quotes in Gemfile [OK]

Common Mistakes:

• Omitting quotes around gem name
• Using wrong keywords like add_gem or install
• Writing gem name without quotes

3. Given this Gemfile snippet:

group :development do
  gem 'pry'
end

group :test do
  gem 'rspec-rails'
end

Which gems will be installed when running bundle install --without test?

medium

A. Only 'rspec-rails' gem will be installed

B. Both 'pry' and 'rspec-rails' gems will be installed

C. Only 'pry' gem will be installed

D. No gems will be installed

Solution

1. Step 1: Understand groups and --without option

   The Gemfile groups gems by environment. The command bundle install --without test skips installing gems in the :test group.

2. Step 2: Identify which gems are installed

   Since :test group is excluded, 'rspec-rails' is skipped. Only 'pry' in :development group is installed.

3. Final Answer:

   Only 'pry' gem will be installed -> Option C

4. Quick Check:

   --without test skips test gems [OK]

Hint: --without skips gems in that group only [OK]

Common Mistakes:

• Assuming all gems install regardless of groups
• Confusing group names with gem names
• Thinking --without installs excluded gems

4. You added gem 'faker' to your Gemfile but running bundle install gives an error. Which of these is the most likely cause?

medium

A. You forgot to run bundle update after adding the gem

B. You did not save the Gemfile after adding the gem

C. You added the gem outside the Gemfile

D. You did not run bundle install after adding the gem

Solution

1. Step 1: Check common errors when bundle install fails

   If bundle install errors after adding a gem, a common cause is that the Gemfile changes were not saved, so bundler sees no new gem.

2. Step 2: Evaluate other options

   Running bundle update is not required after adding a gem; bundle install is enough. Adding gem outside Gemfile or not running bundle install contradicts the question.

3. Final Answer:

   You did not save the Gemfile after adding the gem -> Option B

4. Quick Check:

   Unsaved Gemfile changes cause bundle install errors [OK]

Hint: Always save Gemfile before running bundle install [OK]

Common Mistakes:

• Thinking bundle update is always needed
• Not saving Gemfile after editing
• Adding gems outside Gemfile file

5. You want to add a gem only for the test environment and ensure it is not loaded in production. Which Gemfile code correctly achieves this?

hard

A. gem 'capybara', only: :test

B. gem 'capybara', group: :test

C. group :production do
gem 'capybara'
end

D. group :test do
gem 'capybara'
end

Solution

1. Step 1: Understand how to limit gem to test environment

   Using a group :test do ... end block in Gemfile ensures gems inside load only in test environment.

2. Step 2: Check each option's correctness

   group :test do gem 'capybara' end uses the correct group block syntax. Options A and B use invalid options for gem method. group :production do gem 'capybara' end wrongly groups gem under production.

3. Final Answer:

   group :test do gem 'capybara' end -> Option D

4. Quick Check:

   Use group :test block to limit gems to test [OK]

Hint: Use group :test block to isolate test gems [OK]

Common Mistakes:

• Using invalid gem options like group: or only:
• Placing test gems in production group
• Not grouping gems by environment