Convention over configuration principle in Ruby on Rails

Introduction

This principle helps you write less setup code by following common rules. Rails knows what to do if you follow its naming and structure.

When creating a new Rails app and you want to avoid writing extra setup code.

When naming files and folders in your Rails project to make things work automatically.

When you want Rails to guess your database table names from your model names.

When you want to speed up development by trusting Rails defaults.

When you want your team to follow the same simple rules to avoid confusion.

Syntax

Ruby on Rails

No special code syntax; it means following Rails naming and folder rules.

For example, a model named Article uses a database table named articles automatically.

Controllers named ArticlesController handle views in app/views/articles/ folder by default.

Examples

Rails expects the database table to be named articles automatically.

Ruby on Rails

# Model file: app/models/article.rb
class Article < ApplicationRecord
end

Rails looks for the view template in app/views/articles/index.html.erb by default.

Ruby on Rails

# Controller file: app/controllers/articles_controller.rb
class ArticlesController < ApplicationController
  def index
    @articles = Article.all
  end
end

Rails uses the table name articles matching the model Article.

Ruby on Rails

# Migration file: db/migrate/20240101000000_create_articles.rb
class CreateArticles < ActiveRecord::Migration[7.0]
  def change
    create_table :articles do |t|
      t.string :title
      t.text :content
      t.timestamps
    end
  end
end

Sample Program

This example shows a Post model, a controller PostsController, and a view in app/views/posts/index.html.erb. Rails connects them automatically because of the naming conventions.

Ruby on Rails

# app/models/post.rb
class Post < ApplicationRecord
end

# app/controllers/posts_controller.rb
class PostsController < ApplicationController
  def index
    @posts = Post.all
  end
end

# app/views/posts/index.html.erb
<% @posts.each do |post| %>
  <h2><%= post.title %></h2>
  <p><%= post.content %></p>
<% end %>

Important Notes

Following Rails conventions saves time and reduces errors.

You can override conventions, but it requires extra configuration.

Always name files, classes, and folders carefully to match Rails expectations.

Summary

Rails uses conventions to guess what you want, so you write less setup code.

Models, controllers, views, and database tables follow naming rules to connect automatically.

Following these rules helps you build apps faster and with fewer mistakes.

Practice

1. What does the Convention over configuration principle in Rails primarily help with?

easy

A. Automatically generating user interface designs

B. Reducing the amount of setup code by following naming rules

C. Making Rails apps run faster by optimizing queries

D. Forcing developers to write detailed configuration files

Solution

1. Step 1: Understand the principle's goal

   Convention over configuration means Rails guesses what you want if you follow its naming rules.

2. Step 2: Identify the main benefit

   This reduces the need to write extra setup or configuration code manually.

3. Final Answer:

   Reducing the amount of setup code by following naming rules -> Option B

4. Quick Check:

   Convention over configuration = less setup code [OK]

Hint: Think: Rails guesses if you follow rules, so less setup [OK]

Common Mistakes:

• Confusing it with performance optimization
• Thinking it forces more configuration files
• Assuming it auto-generates UI designs

2. Which of the following is the correct Rails convention for naming a model class representing users?

easy

A. class User < ApplicationRecord

B. class users < ApplicationRecord

C. class user < ApplicationRecord

D. class USER < ApplicationRecord

Solution

1. Step 1: Recall Rails naming conventions for models

   Model class names are singular and start with a capital letter, e.g., User.

2. Step 2: Check syntax correctness

   class User < ApplicationRecord uses correct class name capitalization and inherits from ApplicationRecord.

3. Final Answer:

   class User < ApplicationRecord -> Option A

4. Quick Check:

   Model class names are singular and capitalized [OK]

Hint: Model names are singular and capitalized classes [OK]

Common Mistakes:

• Using plural or lowercase class names
• Not capitalizing the class name
• Using all uppercase letters

3. Given a Rails model named Article, which database table name will Rails expect by convention?

medium

A. articles

B. article

C. Article

D. article_table

Solution

1. Step 1: Recall Rails table naming convention

   Rails expects database tables to be plural lowercase versions of model names.

2. Step 2: Apply to the model 'Article'

   The plural lowercase form is 'articles'.

3. Final Answer:

   articles -> Option A

4. Quick Check:

   Model 'Article' maps to table 'articles' [OK]

Hint: Model name pluralized lowercase = table name [OK]

Common Mistakes:

• Using singular table names
• Using capitalized table names
• Adding extra suffixes like '_table'

4. You created a model class class Person < ApplicationRecord but named the database table people_data. What is the main issue here?

medium

A. Rails will use the people_data table without problems

B. Rails will automatically find the table despite the name difference

C. Rails will raise an error because the table name does not follow convention

D. Rails will ignore the model and use a default table

Solution

1. Step 1: Understand default table naming

   Rails expects the table name to be the plural form of the model name, here 'people'.

2. Step 2: Check mismatch impact

   Since the table is named 'people_data', Rails won't find it automatically and will raise an error unless explicitly told.

3. Final Answer:

   Rails will raise an error because the table name does not follow convention -> Option C

4. Quick Check:

   Table name mismatch causes error unless configured [OK]

Hint: Table name must match plural model name or configure explicitly [OK]

Common Mistakes:

• Assuming Rails guesses any table name
• Thinking Rails silently ignores the model
• Believing Rails auto-corrects table names

5. You want to create a Rails controller for managing blog posts. According to convention, which controller class name and file path are correct?

hard

A. class BlogPostController < ApplicationController in app/controllers/blog_post_controller.rb

B. class blogpostscontroller < ApplicationController in app/controllers/blogposts_controller.rb

C. class BlogPosts < ApplicationController in app/controllers/blog_posts.rb

D. class BlogPostsController < ApplicationController in app/controllers/blog_posts_controller.rb

Solution

1. Step 1: Recall controller naming conventions

   Controllers are plural, camel case with 'Controller' suffix, e.g., BlogPostsController.

2. Step 2: Recall file path conventions

   File names are snake_case plural with '_controller.rb' suffix, e.g., blog_posts_controller.rb.

3. Final Answer:

   class BlogPostsController < ApplicationController in app/controllers/blog_posts_controller.rb -> Option D

4. Quick Check:

   Controller class plural + Controller suffix, file snake_case plural [OK]

Hint: Controller class plural CamelCase + file snake_case plural_controller.rb [OK]

Common Mistakes:

• Using singular controller class names
• Incorrect file naming or casing
• Omitting 'Controller' suffix