Difference between 'self.method_name' and 'class << self' in Ruby

Question

I was trying to limit the instantiation of a class to just a single one(without using singleton) but i couldn't. I tried with class variables (@@) but without luck. I googled it and came across this:

class A 
  @count = 0 

  class << self 
    attr_accessor :count 
  end

  def initialize val 
    @a = val 
    self.class.count += 1 
  end 
end 

a=A.new 42 
b=A.new 43

I searched for the 'class << self' explanation hoping to find a better(or just a more simple and clean) but againt, no luck. Finally, after some tests i concluded that 'class << self' is just a block wrapper where you can define class methods. So, is this the correct?

Regards!

Answer 1

The class << self notation opens up the eigenclass of an object. An eigenclass is an anonymous class that stores instance-specific behaviour. In the case of a class an eigenclass is sometimes called a metaclass.

Ruby uses eigenclasses to implement so called 'class methods' (also called static methods).

A Class (as moritz stated) is also an Object in Ruby and in so far as it is an object it also has a class. The class of a class in Ruby is called Class.

A 'class method' in any language is a method in which a class is the receiver - that is the method is directly invoked on the class itself.

However in order for a method to be invoked on a receiver that method must be defined on the class of that receiver. In the case of classes a 'class method' could be implemented as an instance method on the Class class.

But defining an instance method on Class would mean that ALL classes get access to that class method which is not ideal.

Enter the eigenclass, as stated before, the eigenclass for an object is a special class that stores the methods unique to that object. In the case of classes the eigenclass subclasses the Class class and is the direct class of the class.

'class methods' in Ruby therefore are just 'instance methods' defined on the class's eigenclass.

The def MyClass.my_method notation actually defines my_method on the eigenclass of MyClass. If you use this notation you can get by (for a while) without actually understanding eigenclasses since you can trick yourself into thinking it is just Ruby's way of defining 'static methods' and continue thinking Ruby's class model is similar to Java's. However, the class << self notation allows no such interpretation and you must come to terms with the reality of eigenclasses.

In summary, 'class methods' are actually 'instance methods' defined on the eigenclass and the class << self gives you access to the eigenclass.

For more reading check out these links:

http://banisterfiend.wordpress.com/2008/11/25/a-complete-ruby-class-diagram/

http://banisterfiend.wordpress.com/2008/10/25/the-secret-life-of-singletons/

http://www.klankboomklang.com/2007/09/21/the-singleton-class/

Answer 2

Technically, you're defining a method on the metaclass of the class, rather than the class itself. Yehuda Katz has a great explanation of metaclasses in Ruby here: http://yehudakatz.com/2009/11/15/metaprogramming-in-ruby-its-all-about-the-self/

Answer 3

Your conclusion is right. Basically, you have to keep in mind that even classes are objects in ruby, and therefore, have instances. And with the class << self statement you are just altering that class instance of your object.

Answer 4

The subject line doesn't quite match the body of the question. I'm going to address the question expressed in the subject line:

They are synonymous.

def self.foo
    ...
end

is just shorthand for

class << self
    def foo
        ...
    end
end