What would a default getter and setter look like in rails?

jay picture jay · Jan 8, 2012 · Viewed 30.4k times · Source

I know that I can write attr_accessor :tag_list to make a virtual attribute tag_list for an object in Rails. This allows there to be a tag_list attribute in forms for the object.

If I use attr_accessor :tag_list I can, in the model, perform actions on tag_list to pull and manipulate data from the form.

What I want to know is, instead of writing attr_accessor, how would I write a getter and setter that would replicate completely the default functionality of attr_accessor. EG:

def tag_list
    #what goes here
end

FYI I have tried

 def tag_list
     @tag_list
 end

This does NOT work.

Answer

Niklas B. picture Niklas B. · Jan 8, 2012

attr_accessor is a built-in Ruby method and has no special meaning in the context ActiveRecord. attr_accessor :tag_list is basically equivalent to this code:

# getter
def tag_list
  @tag_list
end

# setter
def tag_list=(val)
  @tag_list = val
end

In ActiveRecord models, however, it could be that you want something like this:

def tag_list
  self[:tag_list]
end

def tag_list=(val)
  self[:tag_list] = val
end

There is a slight difference: With the first method, obj[:tag_list] doesn't use the same storage as your getter and setter. With the latter, it does.

Explanation of the getter/setter concept

In Ruby, the following two lines of code are equivalent

thing.blabla
thing.blabla()

Both call the method blabla of the object thing and evaluate to the last expression evaluated within that method. This means, you also don't need a return statement in the case of the above getter method, because the method simply returns the last expression in the method (@tag_list, the value of the instance variable).

Also, those two lines of code are equivalent:

thing.blabla=("abc")
thing.blabla = "abc"

Both call the method blabla= of the object thing. The special name with the = character can be used like any other method name.

The fact that attributes, as they are sometimes called, are in fact plain methods, you can also use some special logic transformed on the values before returning or accepting them. Example:

def price_in_dollar
  @price_in_euro * 0.78597815
end

def price_in_dollar=(val)
  @price_in_euro = val / 0.78597815
end