Class variables (@@) and their dangers in Ruby

Introduction

Class variables hold data shared by a class and all its subclasses. They let you keep track of information common to all objects of a class.

When you want to count how many objects of a class and its subclasses have been created.

When you need to share a setting or value across a class and all its subclasses.

When you want to keep track of a total or summary that applies to all instances of a class family.

Syntax

Ruby

class ClassName
  @@class_variable = value

  def some_method
    @@class_variable
  end
end

Class variables start with @@ and are shared by the class and all its subclasses.

Changing a class variable affects all classes in the inheritance chain.

Examples

This example counts all animals created, including dogs, using a class variable.

Ruby

class Animal
  @@count = 0

  def initialize
    @@count += 1
  end

  def self.count
    @@count
  end
end

class Dog < Animal
end

Dog.new
Dog.new
puts Animal.count

Changing the class variable in Child also changes it in Parent, showing shared state.

Ruby

class Parent
  @@value = 1
end

class Child < Parent
  def self.change_value
    @@value = 5
  end
end

Child.change_value
puts Parent.class_variable_get(:@@value)

Sample Program

This program counts all vehicles created, including cars and trucks, using a class variable.

Ruby

class Vehicle
  @@total_vehicles = 0

  def initialize
    @@total_vehicles += 1
  end

  def self.total_vehicles
    @@total_vehicles
  end
end

class Car < Vehicle
end

class Truck < Vehicle
end

Car.new
Car.new
Truck.new

puts Vehicle.total_vehicles

Important Notes

Class variables can cause unexpected bugs because subclasses share the same variable.

Changing a class variable in one subclass affects all other subclasses and the parent class.

Consider using class instance variables or class methods for safer, clearer sharing of data.

Summary

Class variables (@@) share data across a class and all its subclasses.

They can cause tricky bugs because all classes share the same variable.

Use them carefully or prefer safer alternatives like class instance variables.

Practice

1. What is a key characteristic of Ruby class variables (@@)?

easy

A. They are unique to each instance of a class.

B. They are shared among a class and all its subclasses.

C. They are only accessible inside instance methods.

D. They behave like local variables inside methods.

Solution

1. Step 1: Understand class variable scope

   Class variables (@@) are shared across a class and all its subclasses, meaning they hold the same value for all related classes.

2. Step 2: Compare with other variable types

   Instance variables are unique per object, local variables are method-specific, so they don't share data like class variables do.

3. Final Answer:

   They are shared among a class and all its subclasses. -> Option B

4. Quick Check:

   Class variables share data across class hierarchy [OK]

Hint: Remember @@ means shared across class and subclasses [OK]

Common Mistakes:

• Confusing class variables with instance variables
• Thinking @@ variables are local to instances
• Assuming @@ variables are private to one class

2. Which of the following is the correct syntax to define and use a class variable in Ruby?

easy

A. class MyClass
@@count = 0
end

B. class MyClass
@count = 0
end

C. class MyClass
$count = 0
end

D. class MyClass
count = 0
end

Solution

1. Step 1: Identify class variable syntax

   Class variables start with @@, so @@count = 0 is correct for defining a class variable.

2. Step 2: Differentiate other variable types

   @count is an instance variable, $count is a global variable, and count alone is a local variable.

3. Final Answer:

   class MyClass @@count = 0 end -> Option A

4. Quick Check:

   Class variable syntax uses @@ [OK]

Hint: Class variables always start with @@ [OK]

Common Mistakes:

• Using @ instead of @@ for class variables
• Confusing global variables ($) with class variables
• Defining variables without any prefix

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

class Parent
  @@value = 1
  def self.value
    @@value
  end
  def self.value=(v)
    @@value = v
  end
end

class Child < Parent
end

Parent.value = 5
puts Child.value

medium

A. 5

B. Error

C. nil

D. 1

Solution

1. Step 1: Understand class variable sharing

   The class variable @@value is shared between Parent and Child classes.

2. Step 2: Trace the assignment and output

   Setting Parent.value = 5 changes @@value to 5 for both classes. So, Child.value returns 5.

3. Final Answer:

   5 -> Option A

4. Quick Check:

   Class variables shared, so Child.value = 5 [OK]

Hint: Class variables share values across subclasses [OK]

Common Mistakes:

• Assuming Child has its own separate @@value
• Expecting default value 1 after change
• Confusing class variables with instance variables

4. Identify the problem in this Ruby code using class variables:

class A
  @@count = 0
  def initialize
    @@count += 1
  end
  def self.count
    @@count
  end
end

class B < A
  def initialize
    @@count += 10
  end
end

A.new
B.new
puts A.count

medium

A. The code has a syntax error in class B definition.

B. The class variable @@count is not initialized properly.

C. The class variable @@count is shared and modified differently causing unexpected count.

D. The method self.count is missing a return statement.

Solution

1. Step 1: Analyze class variable usage in inheritance

   Both classes A and B share the same @@count. A#initialize adds 1, B#initialize adds 10.

2. Step 2: Understand the effect on count

   Creating A.new adds 1, then B.new adds 10, so total @@count becomes 11, which may be unexpected if counting instances separately.

3. Final Answer:

   The class variable @@count is shared and modified differently causing unexpected count. -> Option C

4. Quick Check:

   Shared @@count causes tricky bugs [OK]

Hint: Shared @@ variables cause unexpected cross-class changes [OK]

Common Mistakes:

• Thinking @@count is separate per class
• Ignoring inheritance effect on @@ variables
• Assuming initialize methods don't affect shared vars

5. You want to track the number of instances created separately for two subclasses without interference. Which approach avoids the dangers of class variables (@@)?

hard

A. Use a local variable inside the initialize method to count instances.

B. Use a global variable ($count) shared by all classes.

C. Use class variables (@@count) but reset them in each subclass initialize.

D. Use class instance variables (@count) in each subclass instead of @@count.

Solution

1. Step 1: Understand the problem with class variables

   Class variables (@@count) are shared across subclasses, causing counts to mix and produce wrong totals.

2. Step 2: Use class instance variables for separate counts

   Class instance variables (@count) belong to each class separately, so each subclass can track its own count safely.

3. Final Answer:

   Use class instance variables (@count) in each subclass instead of @@count. -> Option D

4. Quick Check:

   Class instance vars avoid shared @@ dangers [OK]

Hint: Use @count per class to avoid shared @@count bugs [OK]

Common Mistakes:

• Using global variables which mix counts globally
• Trying to reset @@count which is error-prone
• Using local variables which don't persist counts