Custom modules as mixins in Ruby

Introduction

Mixins let you share code between classes easily. Custom modules help you add useful features without repeating code.

You want to add the same behavior to many classes without repeating code.

You want to organize related methods in one place and use them in different classes.

You want to keep your classes simple and add extra features only when needed.

Syntax

Ruby

module ModuleName
  def method_name
    # code here
  end
end

class ClassName
  include ModuleName
end

Use module to create a module with methods.

Use include inside a class to add module methods as instance methods.

Examples

This example adds a greeting method to the Person class using the Greet module.

Ruby

module Greet
  def say_hello
    puts "Hello!"
  end
end

class Person
  include Greet
end

p = Person.new
p.say_hello

This example adds a square method to Calculator using the MathHelpers module.

Ruby

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

class Calculator
  include MathHelpers
end

calc = Calculator.new
puts calc.square(4)

Sample Program

This program shows how the Logger module adds a log method to the User class. When we call create, it logs a message.

Ruby

module Logger
  def log(message)
    puts "LOG: #{message}"
  end
end

class User
  include Logger

  def create
    log("User created")
  end
end

user = User.new
user.create

Important Notes

Modules cannot be instantiated like classes; they are only for sharing code.

Using include adds module methods as instance methods.

You can also use extend to add module methods as class methods.

Summary

Custom modules let you share methods across classes without repeating code.

Use include to add module methods as instance methods.

Mixins help keep your code organized and reusable.

Practice

1. What is the main purpose of using a custom module as a mixin in Ruby?

easy

A. To share methods across multiple classes without repeating code

B. To create a new class that inherits from multiple classes

C. To define global variables accessible everywhere

D. To replace the need for classes entirely

Solution

1. Step 1: Understand what a module is

   A module groups methods that can be reused in different classes.

2. Step 2: Recognize the role of mixins

   Mixins let classes include these modules to share behavior without inheritance.

3. Final Answer:

   To share methods across multiple classes without repeating code -> Option A

4. Quick Check:

   Modules as mixins = code sharing [OK]

Hint: Modules share methods to avoid repeating code [OK]

Common Mistakes:

• Confusing modules with multiple inheritance
• Thinking modules define global variables
• Believing modules replace classes

2. Which of the following is the correct syntax to include a module named Greetings inside a class Person?

easy

A. module Person; include Greetings; end

B. class Person; extend Greetings; end

C. class Person; use Greetings; end

D. class Person; include Greetings; end

Solution

1. Step 1: Identify how to add instance methods from a module

   Use include inside the class to add module methods as instance methods.

2. Step 2: Check syntax correctness

   Only class Person; include Greetings; end is valid Ruby syntax for this purpose.

3. Final Answer:

   class Person; include Greetings; end -> Option D

4. Quick Check:

   Include module inside class = class Person; include Greetings; end [OK]

Hint: Use include to add module methods as instance methods [OK]

Common Mistakes:

• Using extend instead of include for instance methods
• Writing module instead of class
• Using non-existent keyword 'use'

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

module Talk
  def speak
    "Hello!"
  end
end

class Dog
  include Talk
end

puts Dog.new.speak

medium

A. NoMethodError

B. Hello!

C. speak

D. nil

Solution

1. Step 1: Understand module inclusion

   The Talk module defines speak method. Including it in Dog adds speak as an instance method.

2. Step 2: Call the method on Dog instance

   Dog.new.speak calls the method and returns "Hello!" string.

3. Final Answer:

   Hello! -> Option B

4. Quick Check:

   Included method call = "Hello!" [OK]

Hint: Included module methods become instance methods [OK]

Common Mistakes:

• Expecting NoMethodError because of missing method
• Confusing include with extend
• Thinking output is method name or nil

4. Identify the error in the following Ruby code that tries to use a module as a mixin:

module Helper
  def help
    "Helping"
  end
end

class User
  extend Helper
end

puts User.new.help

medium

A. Using extend instead of include causes NoMethodError on instance

B. Module Helper is not defined properly

C. User class should be a module

D. help method should be a class method

Solution

1. Step 1: Understand extend vs include

   extend Helper adds methods as class methods, not instance methods.

2. Step 2: Analyze method call on instance

   User.new.help calls help on an instance, but method is only on class, causing NoMethodError.

3. Final Answer:

   Using extend instead of include causes NoMethodError on instance -> Option A

4. Quick Check:

   extend adds class methods, not instance methods [OK]

Hint: Use include for instance methods, extend for class methods [OK]

Common Mistakes:

• Confusing extend and include
• Calling instance method on class method only
• Thinking module definition is wrong

5. Given two modules Walk and Talk with methods walk and speak respectively, how can you create a class Person that uses both modules as mixins and calls both methods on an instance? Choose the correct code snippet.

hard

A. class Person
extend Walk
extend Talk
end

p = Person.new
puts p.walk
puts p.speak

B. class Person
include Walk Talk
end

p = Person.new
puts p.walk
puts p.speak

C. class Person
include Walk
include Talk
end

p = Person.new
puts p.walk
puts p.speak

D. class Person
use Walk
use Talk
end

p = Person.new
puts p.walk
puts p.speak

Solution

1. Step 1: Understand including multiple modules

   You can include multiple modules by calling include multiple times inside the class.

2. Step 2: Verify method calls on instance

   Including modules adds their methods as instance methods, so p.walk and p.speak work.

3. Final Answer:

   class Person include Walk include Talk end p = Person.new puts p.walk puts p.speak -> Option C

4. Quick Check:

   Include modules separately for instance methods [OK]

Hint: Include each module separately for instance methods [OK]

Common Mistakes:

• Using extend instead of include for instance methods
• Trying to include multiple modules in one line
• Using non-existent keyword 'use'