App folder organization in Ruby on Rails

Introduction

The app folder in a Rails project keeps your code organized by type. It helps you find and manage your files easily.

When starting a new Rails project to know where to put your code.

When adding new features like models, views, or controllers.

When debugging to quickly locate the relevant files.

When collaborating with others to follow a common structure.

When maintaining or updating your app to keep it clean.

Syntax

Ruby on Rails

app/
  controllers/
  models/
  views/
  helpers/
  assets/
  channels/
  jobs/
  mailers/

controllers/ holds code that responds to user actions.

models/ contains data and business logic.

Examples

This file handles user-related actions like signup or login.

Ruby on Rails

app/controllers/users_controller.rb

This file defines the User data and rules.

Ruby on Rails

app/models/user.rb

This file shows the list of users in the browser.

Ruby on Rails

app/views/users/index.html.erb

Sample Program

This example shows a simple controller in the controllers/ folder that responds with a plain text greeting. The route connects the URL /hello to this controller action.

Ruby on Rails

# File: app/controllers/greetings_controller.rb
class GreetingsController < ApplicationController
  def hello
    render plain: "Hello, Rails!"
  end
end

# File: config/routes.rb
Rails.application.routes.draw do
  get '/hello', to: 'greetings#hello'
end

Important Notes

Keep your code in the right folders to follow Rails conventions.

Use subfolders inside controllers/ or views/ for large apps to stay organized.

Summary

The app/ folder organizes your Rails code by type.

Controllers handle requests, models manage data, and views display content.

Following this structure makes your app easier to build and maintain.

Practice

1. What is the main purpose of the app/ folder in a Rails application?

easy

A. To store database backups and logs

B. To hold static assets like images and stylesheets

C. To keep configuration files for the server

D. To organize the code by its role, like models, views, and controllers

Solution

1. Step 1: Understand the role of app/ folder

   The app/ folder is designed to organize the main parts of the Rails app code by their function.

2. Step 2: Identify what belongs in app/

   Models, views, and controllers are the core components stored in app/, not backups or static files.

3. Final Answer:

   To organize the code by its role, like models, views, and controllers -> Option D

4. Quick Check:

   App folder organizes code by role = B [OK]

Hint: Remember MVC parts live inside app/ folder [OK]

Common Mistakes:

• Confusing app/ with config/ or public/ folders
• Thinking assets like images go inside app/
• Assuming app/ holds database files

2. Which folder inside app/ should contain the code that responds to user requests?

easy

A. controllers

B. views

C. models

D. helpers

Solution

1. Step 1: Identify the role of controllers

   Controllers handle incoming user requests and decide what to do next.

2. Step 2: Match folder to role

   The controllers folder contains this code, while models manage data and views display content.

3. Final Answer:

   controllers -> Option A

4. Quick Check:

   Request handling = controllers = C [OK]

Hint: Controllers respond to requests inside app/ [OK]

Common Mistakes:

• Choosing models instead of controllers
• Confusing views with controllers
• Thinking helpers handle requests

3. Given this folder structure inside app/:
app/models/user.rb,
app/controllers/users_controller.rb,
app/views/users/index.html.erb
What is the role of users_controller.rb?

medium

A. It contains the HTML layout for user pages

B. It defines how user data is stored in the database

C. It manages the logic to handle user-related requests

D. It stores user session information

Solution

1. Step 1: Identify the controller file

   The file users_controller.rb is inside the controllers folder, so it handles requests.

2. Step 2: Understand controller responsibility

   Controllers manage logic for requests, not data storage or views.

3. Final Answer:

   It manages the logic to handle user-related requests -> Option C

4. Quick Check:

   Controller file handles requests = A [OK]

Hint: Controllers handle logic for requests, not data or views [OK]

Common Mistakes:

• Confusing controller with model responsibilities
• Thinking controller holds HTML templates
• Assuming controller stores session data

4. You accidentally put a view template file inside app/models/. What problem will this cause?

medium

A. The view will not render because Rails looks for templates only in app/views/

B. No problem; Rails loads views from any folder inside app/

C. The model will try to execute the view code causing a crash

D. Rails will raise an error because views must be in app/views/

Solution

1. Step 1: Understand Rails folder conventions

   Rails expects view templates only inside app/views/ to render them properly.

2. Step 2: Identify effect of wrong folder

   If a view is inside app/models/, Rails will not find it and won't render it.

3. Final Answer:

   The view will not render because Rails looks for templates only in app/views/ -> Option A

4. Quick Check:

   Views must be in app/views = D [OK]

Hint: Views only render from app/views folder [OK]

Common Mistakes:

• Expecting Rails to raise an error immediately
• Thinking models execute view code
• Assuming views load from anywhere in app/

5. You want to add a new feature that sends emails when a user signs up. Where should you place the mailer class in the Rails app/ folder structure?

hard

A. Inside app/controllers/ because it handles user actions

B. Inside app/mailers/ because mailers have their own folder

C. Inside app/models/ because it deals with user data

D. Inside app/views/ because emails have templates

Solution

1. Step 1: Recall Rails folder for mailers

   Rails has a dedicated app/mailers/ folder for mailer classes that send emails.

2. Step 2: Understand why mailers don't go elsewhere

   Controllers handle requests, models manage data, and views hold templates, but mailers have their own place.

3. Final Answer:

   Inside app/mailers/ because mailers have their own folder -> Option B

4. Quick Check:

   Mailers live in app/mailers = A [OK]

Hint: Put mailers in app/mailers folder [OK]

Common Mistakes:

• Placing mailers in controllers or models folders
• Confusing mailer classes with views
• Not knowing mailers have a separate folder