Why structure conventions matter in Ruby on Rails - See It in Action

Why structure conventions matter

📖 Scenario: You are building a simple blog application using Ruby on Rails. Rails has a specific folder and file structure that helps the framework find your code easily and keeps your project organized.Following these conventions makes your app work smoothly and helps other developers understand your code quickly.

🎯 Goal: Create a basic Rails model, controller, and view following Rails naming and folder conventions to display a list of blog posts.

📋 What You'll Learn

Create a model named Post in the correct folder

Create a controller named PostsController in the correct folder

Add an action index in PostsController

Create a view file index.html.erb in the correct folder

Use Rails conventions for naming and file placement

💡 Why This Matters

🌍 Real World

Rails conventions make it easy to build web apps quickly and maintain them as they grow.

💼 Career

Understanding Rails structure is essential for working on Rails projects in web development jobs.

1

Create the Post model

Create a Ruby class named Post inside the file app/models/post.rb. The class should inherit from ApplicationRecord.

Ruby on Rails

# Create the Post model class here

Hint

The model class goes inside app/models/ and inherits from ApplicationRecord.

2

Create the PostsController with index action

Create a controller class named PostsController inside the file app/controllers/posts_controller.rb. Add a method index that will be used to show all posts.

Ruby on Rails

# Create PostsController with index action below

Hint

Controllers go inside app/controllers/ and inherit from ApplicationController.

Define the index method inside the controller.

3

Create the index view for posts

Create a view file named index.html.erb inside the folder app/views/posts/. Add a simple HTML heading <h1>All Posts</h1> inside this file.

Ruby on Rails

Hint

Views are placed in app/views/ inside a folder named after the controller (pluralized).

The file name matches the action name with extension .html.erb.

4

Add route for posts index

In the file config/routes.rb, add a route that maps GET /posts to the index action of PostsController using resources :posts, only: [:index].

Ruby on Rails

# Add route for posts index below

Hint

Routes are defined in config/routes.rb. Use resources :posts, only: [:index] to create the route.

Practice

1. Why is it important to follow structure conventions in a Rails application?

easy

A. Because Rails uses these conventions to automatically find files and connect parts of the app

B. Because it makes the app run faster by skipping code checks

C. Because it allows you to write less code by removing all comments

D. Because it prevents users from accessing the app without a password

Solution

1. Step 1: Understand Rails conventions role

   Rails relies on a specific folder and file structure to locate controllers, models, views, and other components automatically.

2. Step 2: Recognize the benefit of conventions

   Following these conventions means Rails can connect parts of the app without extra configuration, making development smoother.

3. Final Answer:

   Because Rails uses these conventions to automatically find files and connect parts of the app -> Option A

4. Quick Check:

   Rails conventions = automatic file connection [OK]

Hint: Rails finds files by convention, so follow the structure [OK]

Common Mistakes:

• Thinking conventions speed up runtime performance
• Believing conventions remove the need for comments
• Confusing conventions with security features

2. Which of the following is the correct folder for Rails controllers according to convention?

easy

A. app/models

B. app/controllers

C. app/views

D. app/helpers

Solution

1. Step 1: Recall Rails folder roles

   In Rails, controllers handle user requests and are placed in the app/controllers folder.

2. Step 2: Match folder to purpose

   Models go in app/models, views in app/views, and helpers in app/helpers.

3. Final Answer:

   app/controllers -> Option B

4. Quick Check:

   Controllers folder = app/controllers [OK]

Hint: Controllers live in app/controllers folder by Rails rules [OK]

Common Mistakes:

• Putting controllers in app/models
• Confusing views folder with controllers
• Using app/helpers for controllers

3. Given this Rails controller code, what will happen if the file is placed in app/models instead of app/controllers?

class ProductsController < ApplicationController
  def index
    @products = Product.all
  end
end

medium

A. The app will ignore the controller and show a blank page

B. Rails will find and use the controller normally

C. The code will run but views won't render

D. Rails will raise an error because it expects controllers in app/controllers

Solution

1. Step 1: Understand Rails file loading

   Rails loads controllers only from the app/controllers folder by convention.

2. Step 2: Predict behavior if misplaced

   If the controller file is in app/models, Rails won't find it as a controller and will raise a routing or missing controller error.

3. Final Answer:

   Rails will raise an error because it expects controllers in app/controllers -> Option D

4. Quick Check:

   Controllers must be in app/controllers [OK]

Hint: Controllers outside app/controllers cause errors [OK]

Common Mistakes:

• Assuming Rails finds controllers anywhere
• Thinking views won't render but no error occurs
• Believing the app ignores misplaced controllers silently

4. You moved a model file from app/models/user.rb to app/controllers/user.rb. What problem will this cause?

medium

A. Rails will treat the model as a controller and cause errors

B. Rails will load the model normally without issues

C. Rails will ignore the model and use a default one

D. Rails will automatically fix the file location

Solution

1. Step 1: Identify Rails loading rules for models

   Models must be in app/models for Rails to load them as data objects.

2. Step 2: Understand effect of wrong location

   Placing a model file in app/controllers makes Rails treat it as a controller, causing errors because the code does not match controller expectations.

3. Final Answer:

   Rails will treat the model as a controller and cause errors -> Option A

4. Quick Check:

   Models outside app/models cause loading errors [OK]

Hint: Models must stay in app/models or Rails misinterprets them [OK]

Common Mistakes:

• Thinking Rails auto-corrects file locations
• Assuming models load fine anywhere
• Believing Rails uses default models if missing

5. You want to add a new feature to your Rails app that shows a list of books. Which folder should you place the view files in to follow Rails conventions and ensure the app works correctly?

hard

A. app/models/books

B. app/controllers/books

C. app/views/books

D. app/assets/books

Solution

1. Step 1: Recall Rails view folder structure

   Views are stored in app/views inside a folder named after the controller, here books.

2. Step 2: Match feature to folder

   Since the feature is about books, the views go in app/views/books to match the BooksController and render pages properly.

3. Final Answer:

   app/views/books -> Option C

4. Quick Check:

   Views for books = app/views/books [OK]

Hint: Put views in app/views/controller_name folder [OK]

Common Mistakes:

• Placing views in controllers or models folders
• Using app/assets for views
• Not matching view folder to controller name