Why Method naming conventions (? and ! suffixes) in Ruby? - Purpose & Use Cases

The Big Idea

What if your method names could warn you about surprises before you even run the code?

The Scenario

Imagine you have many methods in your Ruby program, but none of them clearly tell you if they just check something or if they change data. You have to guess or read the code every time.

The Problem

This guessing wastes time and causes mistakes. You might call a method thinking it only checks a value, but it actually changes it! This can break your program in ways that are hard to find.

The Solution

Ruby uses special method name endings: ? for methods that answer yes/no questions without changing anything, and ! for methods that do something risky or change data. This helps you understand what methods do just by their names.

Before vs After

✗ Before

def save
  # saves data
end

def save?
  # unclear if it checks or saves
end

✓ After

def save!
  # saves data and might raise error
end

def saved?
  # clearly checks if saved
end

What It Enables

This naming style lets you quickly know if a method is safe to call or if it might change things, making your code easier and safer to use.

Real Life Example

When you call user.valid?, you know it just checks if the user data is good. But user.save! will try to save and might raise an error if something goes wrong. This saves you from surprises.

Key Takeaways

Method names ending with ? mean they check and return true/false without changing anything.

Method names ending with ! mean they do something important or risky, like changing data or raising errors.

This helps you write and read code that is clear and less error-prone.

Practice

1. Which method name follows Ruby convention for a method that returns a boolean value?
? is used at the end of method names that return true or false.

easy

A. save

B. update!

C. calculate

D. valid?

Solution

1. Step 1: Understand the meaning of ? suffix

   In Ruby, methods ending with ? return true or false, indicating a boolean check.

2. Step 2: Identify the method that returns a boolean

   Among the options, valid? clearly suggests a boolean check, while others do not.

3. Final Answer:

   valid? -> Option D

4. Quick Check:

   Boolean methods end with ? = valid? [OK]

Hint: Boolean methods end with ? to show true/false result [OK]

Common Mistakes:

• Confusing ! with ? suffix
• Using ? for methods that modify objects
• Not using ? for boolean-returning methods

2. Which of the following method names is correctly written to indicate it modifies the object in Ruby?

easy

A. delete

B. delete!

C. delete?

D. deleted

Solution

1. Step 1: Understand the meaning of ! suffix

   In Ruby, methods ending with ! usually modify the object or perform a 'dangerous' action.

2. Step 2: Identify the method that modifies the object

   delete! clearly indicates modification, while delete may not, and delete? suggests a boolean check.

3. Final Answer:

   delete! -> Option B

4. Quick Check:

   Modification methods end with ! = delete! [OK]

Hint: Use ! for methods that change the object [OK]

Common Mistakes:

• Using ? instead of ! for modifying methods
• Not adding ! for dangerous methods
• Confusing method names without suffixes

3. What will be the output of this Ruby code?

class User
  def active?
    true
  end

  def deactivate!
    @active = false
    "User deactivated"
  end
end

user = User.new
puts user.active?
puts user.deactivate!
puts user.active?

medium

A. true
User deactivated
true

B. true
User deactivated
false

C. false
User deactivated
false

D. true
User deactivated
nil

Solution

1. Step 1: Analyze the active? method

   This method always returns true because it returns the literal true without checking any variable.

2. Step 2: Analyze the deactivate! method and second active? call

   deactivate! sets @active = false but active? does not use @active, so it still returns true.

3. Final Answer:

   true User deactivated true -> Option A

4. Quick Check:

   active? returns true always = true User deactivated true [OK]

Hint: Check if boolean method uses instance variables or fixed return [OK]

Common Mistakes:

• Assuming deactivate! changes active? output
• Confusing method side effects
• Ignoring method return values

4. Identify the error in this Ruby method definition:

def save?
  # saves the object
  puts "Saving..."
  true
end

What is wrong with this method name?

medium

A. Method name cannot contain ?

B. Method should end with ! instead of ?

C. Method ends with ? but performs an action, not a boolean check

D. No error, method is correct

Solution

1. Step 1: Understand the meaning of ? suffix

   Methods ending with ? should return true or false and not perform side effects like saving.

2. Step 2: Analyze the method behavior

   This method prints "Saving..." which is a side effect, so it should not end with ?.

3. Final Answer:

   Method ends with ? but performs an action, not a boolean check -> Option C

4. Quick Check:

   Methods with ? should not have side effects [OK]

Hint: ? means boolean check, not side effects [OK]

Common Mistakes:

• Using ? for methods that change state
• Ignoring method side effects
• Confusing ! and ? suffix meanings

5. You want to write a Ruby method that checks if a string is empty and also a method that clears the string content. Which method names follow Ruby conventions?

hard

A. empty? and clear!

B. empty! and clear?

C. empty and clear!

D. empty? and clear

Solution

1. Step 1: Identify boolean check method

   The method checking if a string is empty should return true or false, so it should end with ?, e.g., empty?.

2. Step 2: Identify modifying method

   The method that clears the string modifies it, so it should end with !, e.g., clear!.

3. Final Answer:

   empty? and clear! -> Option A

4. Quick Check:

   Boolean check ends with ?; modifying method ends with ! [OK]

Hint: Boolean methods end with ?; modifying methods end with ! [OK]

Common Mistakes:

• Swapping ? and ! suffixes
• Not using suffixes for clarity
• Using no suffix for modifying methods