Metaprogramming Ruby: class_eval and instance_eval
October 25, 2010I am currently reading a great book called Metaprogramming Ruby, an in-depth guide to dynamic code and code generation in Ruby. There have been a lot of light bulb moments for me while reading. Sometimes when the book explains a concept or Ruby feature, it sheds light on things I've seen in other people's code – things I've always wondered about. One such example is class_eval
and instance_eval
. These methods allow you to evaluate arbitrary code in the context of a particular class or object. They're slightly similar to call
, apply
and bind
in JavaScript, in that you are altering the value of self
(this
in JavaScript) when you use them. Let's take a look at some examples to demonstrate their usage.
class Person
end
Person.class_eval do
def say_hello
"Hello!"
end
end
jimmy = Person.new
jimmy.say_hello # "Hello!"
In this example, class_eval
allows us to define a method within the Person
class outside of its original definition and without reopening the class with the standard syntax. This could be useful when the class you want to add this method to is not known until runtime.
class Person
end
Person.instance_eval do
def human?
true
end
end
Person.human? # true
This example of instance_eval
is similar, but evaluates the code in the context of an instance instead of a class. This is confusing at first, because in these examples class_eval
creates instance methods and instance_eval
creates class methods. There is reason behind the madness, however.
class_eval
is a method of the Module
class, meaning that the receiver will be a module or a class. The block you pass to class_eval
is evaluated in the context of that class. Defining a method with the standard def
keyword within a class defines an instance method, and that's exactly what happens here.
instance_eval
, on the other hand, is a method of the Object
class, meaning that the receiver will be an object. The block you pass to instance_eval
is evaluated in the context of that object. That means that Person.instance_eval
is evaluated in the context of the Person
object. Remember that a class name is simply a constant which points to an instance of the class Class
. Because of this fact, defining a method in the context of Class
instance referenced by Person
creates a class method for Person
class.
It may be difficult to wrap your mind around that if you're not familiar with the Ruby object model, but it's still easy to remember how these methods behave with a simple mnemonic device: when called on a class name constant, these two methods will allow you to create methods of the opposite type from their names. MyClass.class_eval
will create instance methods and MyClass.instance_eval
will create class methods.
If you're interested in metaprogramming or understanding the Ruby object model, I'd definitely recommend the book. It's helped me out tremendously.