Method names in Ruby may contain upper-case and lower-case letters, numbers, underscores _ and the punctation signs !, ?, =.
A method name can’t begin with a number, and the characters !, ? and = can only appear at the end.
Non-ASCII characters can be used in a method name, but this can lead to very confusing situations and should not be common practice.
It’s good practice, while not mandatory, to start the method name with a lower-case character, because names that start with capital letters are constants in Ruby. It’s still possible to use a constant name for a method, but you won’t be able to invoke it without parentheses, because the interpeter will look-up for the name as a constant:
def Capital
nil
end
Capital # NameError: uninitialized constant Capital
Capital() # => nil
Some very widely and consistently used conventions when defining method names are:
-
Method names are full down-case, with underscores
_as separators for words into the name (e.g.Math::sqrt,Array#each_index, …). -
Predicates have a question mark
?as last character (e.g.Array#empty?,Hash#has_key?, …). While predicates usually return boolean values, this is not always the case: these methods just need to returnnilorfalseif the predicate evaluates to false, any other value otherwise (e.g.File::size?returnsnilif the file does not exist, the size of the file as anIntegerotherwise). -
Methods that modify the state of the object on which they are invoked, or that have an unusual behavior have an exclamation mark
!as last character; this methods are sometimes called mutators because they usually are destructive or in-place versions of other methods (e.g.Array#sort!,Array#slice!, …). -
Setters have an equal sign
=as last character (e.g.Array#[]=, …); the Ruby interpeter offers syntactic sugar for invokation of setter methods:a = [4, 5, 6] a[0] = 3 # Shorthand for a.[]=(0, 3)
Ruby also allows to define operators using the operator symbol as the method name:
╔═══════════════════════════╦═════════════════════════════════════════════╦═══════╗
║ Operators (by precedence) ║ Operations ║ Arity ║
╠═══════════════════════════╬═════════════════════════════════════════════╬═══════╣
║ ! ~ + ║ Boolean NOT, bitwise complement, unary plus ║ 1 ║
║ ║ (define with method name +@, Ruby 1.9+) ║ ║
║ ║ ║ ║
║ ** ║ Exponentiation ║ 2 ║
║ ║ ║ ║
║ - ║ Unary minus (define with method name -@) ║ 1 ║
║ ║ ║ ║
║ * / % ║ Multiplication, division, modulo ║ 2 ║
║ ║ ║ ║
║ + - ║ Addition, subtraction ║ 2 ║
║ ║ ║ ║
║ << >> ║ Bitwise shift ║ 2 ║
║ ║ ║ ║
║ & ║ Bitwise AND ║ 2 ║
║ ║ ║ ║
║ | ^ ║ Bitwise OR, Bitwise XOR ║ 2 ║
║ ║ ║ ║
║ < <= => > ║ Ordering ║ 2 ║
║ ║ ║ ║
║ == === != =~ !~ <=> ║ Equality, pattern matching, comparison ║ 2 ║
╚═══════════════════════════╩═════════════════════════════════════════════╩═══════╝
Unary operator methods are passed no arguments; binary operator methods are passed an argument, and operate on it and on self.
It’s important to adhere strictly to the arity of the operators; while it is possible to define operator methods with a different arity (e.g. a + method that takes two arguments), Ruby would not allow you to call the method with operator syntax (it would however work with dot syntax).
It’s good practice to adhere to the original semantics of the operators as much as possible: it should be intuitive to someone who knows the original meaning of the operator how it works with user defined classes.
The language also offers syntactic sugar for the special, non-operator ,[] method that is normally used for accessing array and hash values. The [] method can be defined with arbitrary arity.
For every binary operator in the table, except ordering, equality, comparison and pattern matching, Ruby also offers shorthand for abbreviated assignment (e.g. x += y expands to x = x + y); you can’t define them as methods, but you can alter their behavior defining the operators on which they’re based.
None of these characters can be used inside normal method names (e.g. do&print or start-up are not valid method names).