Convention over configuration principle in Ruby on Rails - Step-by-Step Execution

Concept Flow - Convention over configuration principle

Start Rails App

↓

Look for default folders

↓

Use default file names

↓

Apply default behaviors

↓

Run app with minimal setup

↓

Override only if needed

↓

App runs smoothly

Rails uses default names and folders so you write less setup code. It runs with these defaults unless you change them.

Execution Sample

Ruby on Rails

class User < ApplicationRecord
end

Defines a User model that Rails links automatically to the users table without extra config.

Execution Table

Step	Action	Evaluation	Result
1	Define User model class	User inherits from ApplicationRecord	Rails expects users table
2	No table name specified	Rails uses 'users' as table name by convention	No config needed
3	Call User.all	Rails queries 'users' table	Returns all user records
4	Add new model Product	No config for table name	Rails uses 'products' table
5	Override table name in model	Specify self.table_name = 'my_products'	Rails uses 'my_products' instead
6	Run app	Rails uses conventions or overrides	App runs with minimal config

💡 Rails stops looking for config when conventions are met or explicit overrides are given

Variable Tracker

Variable	Start	After Step 2	After Step 5	Final
Model Class	User < ApplicationRecord	Uses 'users' table	Uses 'my_products' table if overridden	Final table name depends on override
Table Name	None specified	'users' by convention	'my_products' if overridden	Used by Rails for queries

Key Moments - 3 Insights

Why does Rails not need explicit table names for models?

Rails assumes table names by pluralizing model class names, as shown in execution_table step 2 and 3.

What happens if I want to use a different table name?

You can override the table name in the model, as shown in execution_table step 5, so Rails uses your specified name.

Does Rails require configuration files for every model?

No, Rails uses conventions to reduce config, only requiring overrides when deviating from defaults, as shown in steps 1-6.

Visual Quiz - 3 Questions

Look at the execution_table, what table name does Rails use for the User model by default?

A 'User'

B 'user'

C 'users'

D 'users_table'

💡 Hint

Check step 2 and 3 in the execution_table where Rails uses 'users' by convention.

At which step does Rails switch to using a custom table name?

A Step 5

B Step 3

C Step 1

D Step 6

💡 Hint

Look at step 5 where the override self.table_name is set.

If you add a new model Product without configuration, what table will Rails query?

A 'product'

B 'products'

C 'Product'

D 'product_table'

💡 Hint

See step 4 where Rails uses pluralized model names as table names.

Concept Snapshot

Convention over configuration means Rails uses default names and folders so you write less setup.
Model names map to plural table names automatically.
You only configure when deviating from defaults.
This speeds up development and reduces errors.
Example: class User < ApplicationRecord uses 'users' table by default.

Full Transcript

The convention over configuration principle in Rails means the framework assumes default settings so developers don't have to write extra setup code. For example, a model named User automatically connects to a database table named users without specifying it. This reduces the need for configuration files or explicit declarations. If you want to use a different table name, you can override it in the model. This approach lets Rails apps run smoothly with minimal setup, speeding development and avoiding mistakes. The execution steps show how Rails looks for defaults, applies them, and only uses configuration when necessary.

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