Методы

Методы реализуют функциональность вашей программы. Вот простое определение метода:

def one_plus_one
  1 + 1
end

Определение метода состоит из ключевого слова def, имени метода, тела метода, return значения и ключевого слова end. При вызове метод выполнит тело метода. Этот метод возвращает 2.

Этот раздел посвящен только определению методов. См. также документацию по синтаксису вызова методов.

Имена методов

Имена методов могут быть одним из операторов или должны начинаться с буквы или символа с установленным восьмым битом. Они могут содержать буквы, цифры, символ _ (подчеркивание) или символ с установленным восьмым битом. Принято использовать подчеркивания для разделения слов в имени многословного метода:

def method_name
  puts "use underscores to separate words"
end

Программы Ruby должны быть написаны в совместимом с US-ASCII наборе символов, таком как UTF-8, ISO-8859-1 и т.д. В таких наборах символов, если восьмой бит установлен, это означает расширенный символ. Ruby позволяет именам методов и другим идентификаторам содержать такие символы. Программы Ruby не могут содержать некоторые символы, такие как ASCII NUL (\x00).

Вот примеры допустимых методов Ruby:

def hello
  "hello"
end

def こんにちは
  puts "means hello in Japanese"
end

Обычно имена методов совместимы с US-ASCII, поскольку клавиши для их ввода есть на всех клавиатурах.

Имена методов могут оканчиваться на ! (восклицательный знак), ? (вопросительный знак) или = (знак равенства).

Методы с восклицательным знаком (! в конце имени метода) вызываются и выполняются так же, как и другие методы. Однако, по соглашению, метод с восклицательным знаком считается опасным. В стандартной библиотеке Ruby опасный метод подразумевает, что, в отличие от своего аналога без восклицательного знака, метод, заканчивающийся восклицательным знаком (!), изменяет свой получатель. Почти всегда стандартная библиотека Ruby будет иметь метод без восклицательного знака (имя метода, не заканчивающееся на !) для каждого метода с восклицательным знаком (имя метода, заканчивающееся на !), который не изменяет получателя. Это соглашение обычно выполняется для стандартной библиотеки Ruby, но может или не может выполняться для других библиотек Ruby.

Методы, заканчивающиеся вопросительным знаком, по соглашению возвращают логическое значение, но они не всегда возвращают только true или false. Часто они возвращают объект для указания истинного значения (или «истинного» значения).

Методы, заканчивающиеся знаком равенства, обозначают метод присваивания. Для методов присваивания возвращаемое значение игнорируется, а вместо него возвращаются аргументы.

Это имена методов для различных операторов Ruby. Каждый из этих операторов принимает только один аргумент. После оператора следует типичное использование или имя оператора. Создание альтернативного значения для оператора может привести к путанице, так как пользователь ожидает, что плюс будет добавлять, минус — вычитать и т. д. Кроме того, вы не можете изменить приоритет операторов.

+

сложение

-

вычитание

*

умножение

**

возведение в степень

/

деление

%

деление по модулю, String#%

&

И

^

Исключающее ИЛИ

>>

сдвиг вправо

<<

сдвиг влево, добавление

==

равно

!=

не равно

===

равенство по случаям. См. Object#===

=~

сопоставление шаблонов. (Не только для регулярных выражений)

!~

не совпадает

<=>

сравнение (оператор корабля). См. Comparable

<

меньше

<=

меньше или равно

>

больше

>=

больше или равно

Для определения унарных методов минус, плюс, тильда и не (!) следует после оператора написать @ как в +@ или !@.

class C
  def -@
    puts "you inverted this object"
  end
end

obj = C.new

-obj # prints "you inverted this object"

Унарные методы принимают ноль аргументов.

Кроме того, могут быть определены методы для ссылки на элемент и присваивания: [] и []= соответственно. Оба могут принимать один или несколько аргументов, а ссылка на элемент может принимать и ни одного.

class C
  def [](a, b)
    puts a + b
  end

  def []=(a, b, c)
    puts a * b + c
  end
end

obj = C.new

obj[2, 3]     # prints "5"
obj[2, 3] = 4 # prints "10"

Возвращаемые значения

По умолчанию метод возвращает последнее выражение, которое было вычислено в теле метода. В приведенном выше примере последним (и единственным) вычисленным выражением было простое сложение 1 + 1. Ключевое слово return может быть использовано для явного указания того, что метод возвращает значение.

def one_plus_one
  return 1 + 1
end

Его также можно использовать, чтобы сделать метод возвращаемым до того, как будет вычислено последнее выражение.

def two_plus_two
  return 2 + 2
  1 + 1  # this expression is never evaluated
end

Обратите внимание, что для методов присваивания возвращаемое значение будет проигнорировано при использовании синтаксиса присваивания. Вместо этого будет возвращен аргумент:

def a=(value)
  return 1 + value
end

p(self.a = 5) # prints 5

Фактическое возвращаемое значение будет возвращено при прямом вызове метода:

p send(:a=, 5) # prints 6

Область видимости

Стандартный синтаксис для определения метода:

def my_method
  # ...
end

добавляет метод в класс. Вы можете определить метод экземпляра для определенного класса с помощью ключевого слова class:

class C
  def my_method
    # ...
  end
end

Метод может быть определен для другого объекта. Вы можете определить «метод класса» (метод, определенный в классе, а не в экземпляре класса) следующим образом:

class C
  def self.my_method
    # ...
  end
end

Однако это просто частный случай большей синтаксической мощности в Ruby — возможности добавления методов к любому объекту. Классы являются объектами, поэтому добавление методов класса — это просто добавление методов к объекту Class.

Синтаксис добавления метода к объекту:

greeting = "Hello"

def greeting.broaden
  self + ", world!"
end

greeting.broaden # returns "Hello, world!"

self — это ключевое слово, обозначающее текущий рассматриваемый компилятором объект, что может прояснить использование self при определении метода класса выше. Действительно, пример добавления метода hello к классу String можно переписать следующим образом:

def String.hello
  "Hello, world!"
end

Метод, определенный таким образом, называется «методом-синглтоном». broaden будет существовать только для экземпляра строки greeting. Другие строки не будут иметь broaden.

Переопределение

Когда Ruby встречает ключевое слово def, он не считает это ошибкой, если метод уже существует: он просто переопределяет его. Это называется переопределением. Подобно расширению базовых классов, эта потенциально опасная возможность должна использоваться с осторожностью, так как может привести к непредсказуемым результатам. Например, рассмотрим эту сессию irb:

>> "43".to_i
=> 43
>> class String
>>   def to_i
>>     42
>>   end
>> end
=> nil
>> "43".to_i
=> 42

Это фактически сорвет любую программу, которая использует метод String#to_i для преобразования чисел из строк.

Аргументы

Метод может принимать аргументы. Список аргументов следует за именем метода:

def add_one(value)
  value + 1
end

При вызове пользователем метода add_one должен быть предоставлен аргумент. Аргумент является локальной переменной в теле метода. Метод затем добавит к этому аргументу единицу и вернет значение. Если задан 1, этот метод вернет 2.

Скобки вокруг аргументов необязательны:

def add_one value
  value + 1
end

Несколько аргументов разделяются запятой:

def add_values(a, b)
  a + b
end

При вызове аргументы должны быть предоставлены в точном порядке. Другими словами, аргументы позиционные.

Значения по умолчанию

Аргументы могут иметь значения по умолчанию:

def add_values(a, b = 1)
  a + b
end

Значение по умолчанию не обязательно должно стоять первым, но аргументы со значениями по умолчанию должны быть сгруппированы вместе. Это нормально:

def add_values(a = 1, b = 2, c)
  a + b + c
end

Это вызовет ошибку SyntaxError:

def add_values(a = 1, b, c = 1)
  a + b + c
end

Разделение массивов

Вы можете разделить массив (распаковать или извлечь значения из) с помощью дополнительных скобок в аргументах:

def my_method((a, b))
  p a: a, b: b
end

my_method([1, 2])

Это выведет:

{:a=>1, :b=>2}

Если в массиве есть дополнительные элементы, они будут проигнорированы:

def my_method((a, b))
  p a: a, b: b
end

my_method([1, 2, 3])

Это имеет тот же вывод, что и выше.

Вы можете использовать * для сбора оставшихся аргументов. Это разделяет массив на первый элемент и остальные:

def my_method((a, *b))
  p a: a, b: b
end

my_method([1, 2, 3])

Это выведет:

{:a=>1, :b=>[2, 3]}

Аргумент будет разложен, если он отвечает методу to_ary. Вы должны определять to_ary только в том случае, если вы можете использовать свой объект вместо массива.

Использование внутренних скобок использует только один из переданных аргументов. Если аргумент не является массивом, он будет присвоен первому аргументу в разбиении, а оставшиеся аргументы в разбиении будут nil:

def my_method(a, (b, c), d)
  p a: a, b: b, c: c, d: d
end

my_method(1, 2, 3)

Это выведет:

{:a=>1, :b=>2, :c=>nil, :d=>3}

Вы можете произвольно вкладывать разделение:

def my_method(((a, b), c))
  # ...
end

Массив/Словарь аргумент

Префикс * заставляет все оставшиеся аргументы преобразовываться в массив:

def gather_arguments(*arguments)
  p arguments
end

gather_arguments 1, 2, 3 # prints [1, 2, 3]

Аргумент-массив должен быть последним позиционным аргументом, он должен стоять перед любыми ключевыми аргументами.

Аргумент-массив захватит словарь как последний элемент, если вызывающий передал словарь после всех позиционных аргументов.

gather_arguments 1, a: 2 # prints [1, {:a=>2}]

Однако это происходит только в том случае, если метод не объявляет никаких ключевых аргументов.

def gather_arguments_keyword(*positional, keyword: nil)
 p positional: positional, keyword: keyword
end

gather_arguments_keyword 1, 2, three: 3
#=> raises: unknown keyword: three (ArgumentError)

Также обратите внимание, что «голое» * может использоваться для игнорирования аргументов:

def ignore_arguments(*)
end

Ключевые аргументы

Ключевые аргументы похожи на позиционные аргументы со значениями по умолчанию:

def add_values(first: 1, second: 2)
  first + second
end

Произвольные ключевые аргументы будут приниматься с **:

def gather_arguments(first: nil, **rest)
  p first, rest
end

gather_arguments first: 1, second: 2, third: 3
# prints 1 then {:second=>2, :third=>3}

При вызове метода с ключевыми аргументами аргументы могут появляться в любом порядке. Если вызывающий передаст неизвестный ключевой аргумент, будет поднято исключение ArgumentError.

При смешивании ключевых и позиционных аргументов все позиционные аргументы должны предшествовать любым ключевым аргументам.

Блок-аргумент

Аргумент блока обозначается & и должен стоять последним:

def my_method(&my_block)
  my_block.call(self)
end

Чаще всего аргумент блока используется для передачи блока в другой метод:

def each_item(&block)
  @items.each(&block)
end

Если вы собираетесь только вызвать блок и не будете иначе его обрабатывать или передавать в другой метод, используя yield, предпочтительнее без явного параметра блока. Этот метод эквивалентен первому методу в этом разделе:

def my_method
  yield self
end

Также есть выгода в производительности использования yield вместо вызова параметра блока. Когда аргумент блока присваивается переменной, создается объект Proc, который содержит блок. При использовании yield этот объект Proc не создается.

Если вам нужно использовать блок только иногда, вы можете использовать Proc.new для создания проксокси из блока, переданного вашему методу. Подробности см. в Proc.new.

Обработка исключений

Методы имеют неявный блок обработки исключений, поэтому вам не нужно использовать begin или end для обработки исключений. Это:

def my_method
  begin
    # code that may raise an exception
  rescue
    # handle exception
  end
end

Можно записать как:

def my_method
  # code that may raise an exception
rescue
  # handle exception
end

Если вы хотите перехватить исключение только для части вашего метода, используйте begin и end. Дополнительные сведения см. на странице по обработке исключений.