Module methods in Ruby

Introduction

Module methods let you group reusable code that can be shared across different parts of your program.

When you want to share common functions between classes without repeating code.

When you want to organize helper methods that don't belong to a specific class.

When you want to add functionality to classes by mixing in modules.

When you want to keep your code clean and easy to maintain by grouping related methods.

Syntax

Ruby

module ModuleName
  def self.method_name
    # code here
  end
end

Use self.method_name to define a method that belongs to the module itself.

You can call module methods directly with ModuleName.method_name.

Examples

This defines a module method say_hello and calls it directly.

Ruby

module Greetings
  def self.say_hello
    puts "Hello!"
  end
end

Greetings.say_hello

This module method calculates the square of a number and returns it.

Ruby

module MathHelpers
  def self.square(x)
    x * x
  end
end

result = MathHelpers.square(4)
puts result

Sample Program

This program defines two module methods: one to greet a person by name and one to add two numbers. It then calls both methods and prints their results.

Ruby

module Tools
  def self.greet(name)
    "Hello, #{name}!"
  end

  def self.add(a, b)
    a + b
  end
end

puts Tools.greet("Alice")
puts Tools.add(5, 7)

Important Notes

Module methods are like static methods in other languages.

You cannot create instances of a module, so module methods are called on the module itself.

Modules help keep your code organized and avoid repeating the same code in multiple places.

Summary

Module methods are defined with self.method_name inside a module.

You call module methods directly on the module, like ModuleName.method_name.

Use modules to group reusable code that can be shared across your program.

Practice

1. What is the correct way to define a method inside a Ruby module so it can be called directly on the module?

easy

A. Define the method outside the module

B. Define the method without self inside the module

C. Define the method with self.method_name inside the module

D. Define the method with def module.method_name inside the module

Solution

1. Step 1: Understand module method definition

   In Ruby, to make a method callable directly on a module, you define it with self.method_name inside the module.

2. Step 2: Compare options

   Define the method with self.method_name inside the module uses self.method_name, which is correct. Other options either omit self or use invalid syntax.

3. Final Answer:

   Define the method with self.method_name inside the module -> Option C

4. Quick Check:

   Module methods use self.method_name = A [OK]

Hint: Use self.method_name to define module methods [OK]

Common Mistakes:

• Forgetting to add self before method name
• Defining methods outside the module
• Using invalid syntax like def module.method_name

2. Which of the following is the correct syntax to call a module method named greet defined in module Welcome?

easy

A. Welcome#greet

B. greet.Welcome

C. Welcome.new.greet

D. Welcome.greet

Solution

1. Step 1: Recall how to call module methods

   Module methods are called using dot notation: ModuleName.method_name.

2. Step 2: Check options

   Welcome.greet is the correct syntax using dot notation. Welcome#greet incorrectly uses #. greet.Welcome reverses the order. Welcome.new.greet confuses it with an instance method call.

3. Final Answer:

   Welcome.greet -> Option D

4. Quick Check:

   Call module methods with dot = D [OK]

Hint: Call module methods with ModuleName.method_name [OK]

Common Mistakes:

• Using # instead of . to call module methods
• Trying to call method with invalid syntax
• Confusing instance and module method calls

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

module MathTools
  def self.square(x)
    x * x
  end
end

puts MathTools.square(4)

medium

A. 16

B. square

C. Error: undefined method

D. 4

Solution

1. Step 1: Understand the method definition

   The method square is defined as a module method using self.square. It returns the square of the input.

2. Step 2: Calculate the output

   Calling MathTools.square(4) returns 4 * 4 = 16, which is printed.

3. Final Answer:

   16 -> Option A

4. Quick Check:

   4 squared = 16 [OK]

Hint: Multiply input by itself in module method [OK]

Common Mistakes:

• Forgetting self and causing undefined method error
• Confusing output with input
• Expecting method name as output

4. Identify the error in this Ruby module method code:

module Greetings
  def greet
    "Hello!"
  end
end

puts Greetings.greet

medium

A. Method greet is not defined as a module method

B. Module name is incorrect

C. Missing parentheses in method call

D. Syntax error in method body

Solution

1. Step 1: Check method definition inside module

   The method greet is defined without self., so it is an instance method, not a module method.

2. Step 2: Understand method call

   Calling Greetings.greet tries to call a module method, but none exists, causing an error.

3. Final Answer:

   Method greet is not defined as a module method -> Option A

4. Quick Check:

   Missing self. means no module method [OK]

Hint: Add self. to define module methods [OK]

Common Mistakes:

• Defining instance methods instead of module methods
• Calling module method without defining it
• Assuming parentheses are required in method call

5. Given the module below, how can you add a module method double that returns twice the input number?

module Calculator
  # Add your method here
end

hard

A. def double(x)
x + x
end

B. def self.double(x)
x * 2
end

C. def Calculator.double(x)
x * 2
end

D. def self.double
x * 2
end

Solution

1. Step 1: Define a module method with self

   To create a module method, define it with self.method_name inside the module.

2. Step 2: Write method to return twice the input

   The method should take one argument x and return x * 2.

3. Final Answer:

   def self.double(x) x * 2 end -> Option B

4. Quick Check:

   Module method with self and correct logic = A [OK]

Hint: Use def self.method(args) for module methods [OK]

Common Mistakes:

• Omitting self and creating instance method
• Missing method argument
• Defining method outside module