Convention over configuration principle in Ruby on Rails - Cheat Sheet & Quick Revision

Recall & Review

beginner

What does the 'Convention over Configuration' principle mean in Rails?

It means Rails uses standard defaults so developers don't have to write extra setup code. If you follow Rails' naming and structure rules, things just work.

beginner

How does 'Convention over Configuration' help speed up development?

By using common defaults, Rails reduces the need to write repetitive setup code. Developers focus on unique parts of their app instead of configuring every detail.

beginner

Give an example of a Rails convention that follows this principle.

If you create a model named 'Article', Rails expects the database table to be named 'articles'. You don’t have to tell Rails the table name explicitly.

intermediate

What happens if you don’t follow Rails conventions?

You must write extra configuration code to tell Rails how to find files, tables, or routes. This can slow development and add complexity.

beginner

Why is 'Convention over Configuration' good for beginners?

It helps beginners by reducing choices and setup. They can learn Rails by following simple rules and see results faster without getting stuck on setup details.

What does 'Convention over Configuration' encourage in Rails?

A Avoiding any configuration or conventions

B Writing detailed configuration files for everything

C Ignoring Rails defaults and customizing all settings

D Using standard defaults to reduce setup

Rails uses standard defaults so developers write less setup code.

If your model is named 'User', what table name does Rails expect by default?

A users

B user

C User

D user_table

Rails pluralizes model names to find the corresponding database table.

What must you do if you don’t follow Rails conventions?

A Write extra configuration to tell Rails your setup

B Restart the server multiple times

C Nothing, Rails automatically adjusts

D Use a different framework

Without conventions, you must configure Rails manually.

Which of these is a benefit of 'Convention over Configuration'?

A More errors

B More setup time

C Faster development

D Less code reuse

Following conventions speeds up development by reducing setup.

How does 'Convention over Configuration' help beginners?

A By forcing them to write complex configs

B By reducing setup choices and simplifying learning

C By hiding all code details

D By requiring advanced knowledge

It simplifies learning by using standard rules and defaults.

Explain the 'Convention over Configuration' principle in Rails and why it matters.

Think about how Rails expects files and names to be organized.

Describe what happens if you do not follow Rails conventions and how it affects your project.

Consider the extra work required when Rails defaults don’t match your setup.

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