Convention over configuration principle in Ruby on Rails - Performance & Optimization

Performance: Convention over configuration principle

MEDIUM IMPACT

This principle affects initial page load speed and developer efficiency by reducing custom setup and unnecessary code.

Setting up database table names and model associations

Ruby on Rails

class User < ApplicationRecord
  has_many :posts
end

Using Rails naming conventions avoids extra configuration and speeds up loading.

📈 Performance Gainreduces boot time by avoiding unnecessary lookups

Setting up database table names and model associations

Ruby on Rails

class User < ApplicationRecord
  self.table_name = 'users_table'
  has_many :posts, foreign_key: 'user_id'
end

Explicitly configuring table names and keys adds extra code and processing during app boot.

📉 Performance Costadds milliseconds to boot time and increases code complexity

Performance Comparison

Pattern	DOM Operations	Reflows	Paint Cost	Verdict
Explicit configuration for naming	No direct DOM impact	0	0	[OK]
Using Rails conventions for naming	No direct DOM impact	0	0	[OK] Good

Rendering Pipeline

Convention over configuration reduces the amount of custom code Rails must process before rendering views, improving the critical rendering path.

→Application Boot

→Routing

→View Rendering

⚠️ BottleneckApplication Boot time due to configuration parsing

Core Web Vital Affected

LCP

This principle affects initial page load speed and developer efficiency by reducing custom setup and unnecessary code.

Optimization Tips

1Use Rails naming conventions to reduce explicit configuration code.

2Avoid custom table names and keys unless necessary to speed up boot.

3Less configuration means faster app startup and quicker content paint.

Performance Quiz - 3 Questions

How does following Rails conventions affect app boot time?

A It has no effect on boot time

B It increases boot time due to more code being loaded

C It reduces boot time by avoiding extra configuration parsing

D It causes more reflows during rendering

DevTools: Performance

How to check: Record app startup and page load times; compare boot time with and without explicit configuration.

What to look for: Look for longer scripting and initialization times when explicit configuration is used.

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