The most recommended way of naming methods in Ruby

[Edmond Kachale]

[Note: parts of this message were removed to make it a legal post.]

Rubists,

What is the most recommended (or the conventional) way of naming methods in
Ruby? Do they need to be verb-like or noun-like? In other language like C++,
methods are supposed to be verbs because they are dimmed as messages sent to
the object. I have asked this because methods in Ruby are also objects.

---
Edmond (ceekays)
Software Developer | Baobab Health Trust (http://www.baobabhealth.org/) |
Malawi

Cell: +265 999 465 137 | +265 881 234 717

*I wish you a Merry Christmas and a Prosperous New Year 2011!!**
*

 

[Ryan Davis]

What is the most recommended (or the conventional) way of naming = methods in
Ruby? Do they need to be verb-like or noun-like? In other language = like C++,
methods are supposed to be verbs because they are dimmed as messages = sent to
the object. I have asked this because methods in Ruby are also =

objects.

verbs_underscore_separated
predicate?
dangerous_mutator!

 

[Robert Klemme]

What is the most recommended (or the conventional) way of naming methods in
Ruby? Do they need to be verb-like or noun-like? In other language like C++,
methods are supposed to be verbs because they are dimmed as messages sent to
the object. I have asked this because methods in Ruby are also objects.

Not exactly. There was a lengthy discussion here about whether
methods are objects or not. Strictly speaking they are not, but you
can obtain an object representing a bound or unbound method.

*I wish you a Merry Christmas and a Prosperous New Year 2011!!**

ed.update_signature!

Cheers

robert

 

[Edmond Kachale]

[Note: parts of this message were removed to make it a legal post.]

ed.update_signature!

Lol!

*>> ed.updated?*
That's what happens when one is using offline mail clients. My offline mail
client for some reason is getting an old signature.

---
Edmond(ceekays)
Software Developer | Baobab Health Trust (http://www.baobabhealth.org/) |
Malawi

Cell: +265 999 465 137 | +265 881 234 717*
**
An old dog does not hunt because of speed, but his endurance of the heart.*
*
*

 

[Phillip Gawlowski]

Rubists,

What is the most recommended (or the conventional) way of naming methods in
Ruby? Do they need to be verb-like or noun-like? In other language like C++,
methods are supposed to be verbs because they are dimmed as messages sent to
the object. I have asked this because methods in Ruby are also objects.

Well, I can't speak for Rubyists in general, but I aim for the following:

- methods that do something should be verbs:
obj.calculate
obj.set_name
obj.get_date

- methods that are accessors (or behave like them) should be nouns:
foo = obj.name
puts obj.date
obj.calculation

- Interrogative methods get phrased as questions:
obj.date_today?
obj.name?
obj.calculation_done?

- methods that modify the object (or caller) itself, should be exclamations:
obj.truncate!
obj.remove_name!
obj.date! "Julian" # I wish I could do obj.date "Julian"!, instead. Ah, well.



--
Phillip Gawlowski

Though the folk I have met,
(Ah, how soon!) they forget
When I've moved on to some other place,
There may be one or two,
When I've played and passed through,
Who'll remember my song or my face.

 

[Shadowfirebird]

- Interrogative methods get phrased as questions:

obj.date_today?
obj.name?
obj.calculation_done?

As you said; but I would only use this interrogative form myself if the method returned true/false. That's how it works in core Ruby?

 

[Robert Klemme]

As you said; but I would only use this interrogative form myself if the m=

ethod returned true/false. =A0That's how it works in core Ruby?

It's more relaxed since you can use any object reference as boolean
value. For example, you may do

class X
attr_accessor :name
alias name? name
end

if the test should return a trueish value if the name is set (actually
not nil and not false).

Kind regards

robert


--=20
remember.guy do |as, often| as.you_can - without end
http://blog.rubybestpractices.com/

 

[Gary Wright]

- methods that modify the object (or caller) itself, should be exclamations:
obj.truncate!
obj.remove_name!
obj.date! "Julian" # I wish I could do obj.date "Julian"!, instead. Ah, well.

I think the conventional wisdom is that this should only be done only if there is a matching non-mutating method that has the name without the exclamation mark.

Gary Wright

 

[Edmond Kachale]

,
well.

I think the conventional wisdom is that this should only be done only if
there is a matching non-mutating method that has the name without the
exclamation mark.

Someone may give more info on why it should be like this:

---
Edmond
Software Developer | Baobab Health Trust (http://www.baobabhealth.org/) |
Malawi

Cell: +265 999 465 137 | +265 881 234 717*
**
An old dog does not hunt because of speed, but his endurance of the heart.*

 

[Shadowfirebird]

It's more relaxed since you can use any object reference as boolean

value. For example, you may do

class X
attr_accessor :name
alias name? name
end

if the test should return a trueish value if the name is set (actually
not nil and not false).

What, "classname = Myclass.name?"? Ew. Sorry, I wouldn't be comfortable with that. Where in the core Ruby classes does that happen?

 

[Robert Klemme]

What, "classname =3D Myclass.name?"? =A0 =A0Ew. =A0Sorry, I wouldn't be c=

omfortable with that. =A0Where in the core Ruby classes does that happen?

I am not sure what you are hinting at. Clarification - just in case:
I did *not* redefine the class's name in the example above.

Cheers

robert

--=20
remember.guy do |as, often| as.you_can - without end
http://blog.rubybestpractices.com/

 

[Gary Wright]

Le 18 janvier 2011 22:01:11 UTC+2, Gary Wright <[email protected]> a = =E9crit :
=20
=20
=20
Someone may give more info on why it should be like this:
=20

I think you left something off. Anyway...

Here is a great explanation of the '!' naming convention:

=
<http://dablog.rubypal.com/2007/8/15/bang-methods-or-danger-will-rubyist>

I was going to try to explain this but why bother when David Black has =
already done a great job?

Gary Wright

 

[Edmond Kachale]

rit

I think you left something off. Anyway...

Here is a great explanation of the '!' naming convention:

<http://dablog.rubypal.com/2007/8/15/bang-methods-or-danger-will-rubyist>

I was going to try to explain this but why bother when David Black has
already done a great job?

I like you on this.

---
Edmond
Software Developer | Baobab Health Trust (http://www.baobabhealth.org/) |
Malawi

Cell: +265 999 465 137 | +265 881 234 717*
**
An old dog does not hunt because of speed, but his endurance of the heart.*
*
*

 

[Adam Prescott]

[Note: parts of this message were removed to make it a legal post.]

On Tue, Jan 18, 2011 at 12:30 PM, Phillip Gawlowski <

obj.set_name
obj.get_date

What is this! Java?

obj.name # get!
obj.date = different_date # set!