Когда использовать аргументы ключевого слова, также известные как именованные параметры в Ruby

Аргументы с ключевыми словами имеют несколько явных преимуществ, которых никто не затронул.

Во-первых, вы не связаны с порядком аргументов. Таким образом, в случае, когда у вас иногда может быть нулевой аргумент, это выглядит намного чище:

def print_greeting(name, message = "Hello")
  puts "#{message}, #{name}"
end

print_greeting("John Connor", "Hasta la vista") 

Если вы используете аргументы ключевого слова:

def print_greeting(message: "Hello", name:)
  puts "#{message}, #{name}"
end

print_greeting(message: "Hasta la vista", name: "John Connor") 

или даже

print_greeting(name: "John Connor", message: "Goodbye")

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

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

def create_person(name:, age:, height:)
  # make yourself some friends
end

Что, если ваши системные требования теперь должны знать о любимом шоколадном батончике человека или о том, есть ли у него лишний вес (из-за того, что он потребляет слишком много своих любимых шоколадных батончиков). Как вы можете использовать аргументы ключевых слов для этого? Простой:

def create_person(name:, age:, height:, favorite_candy:, overweight: true)
  # make yourself some fat friends
end

Перед ключевыми аргументами всегда был хеш, но это привело к гораздо большему количеству стандартного кода для извлечения и назначения переменной. Стандартный код == больше печатать == больше потенциальных опечаток == меньше времени на написание потрясающего рубинового кода.

def old_way(name, opts={})
  age    = opts[:age]
  height = opts[:height]
  # all the benefits as before, more arthritis and headaches  
end

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

def say_full_name(first_name, last_name)
  puts "#{first_name} #{last_name}"
end

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

Поскольку KA — это инновация для всего Ruby, я вижу два основных преимущества:

• ограничить разрешенные аргументы предопределенным набором, как это делает Rails с assert_valid_keys;
• используйте функцию в блоках кода.

Подведение итогов:

a = lambda { |name: "Leonardo", age: 67| [name, age] }
a.call # ⇒ ["Leonardo", 67]
a.call name: "Michelangelo", age: 88 # ⇒ ["Michelangelo", 88]
a.call name: "Schwarzenegger", alive: true # ⇒ ArgumentError: unknown keyword: alive

Проблема неэффективности использования аргументов ключевого слова больше не кажется проблемой, начиная с ruby-2.2.0.

Функция №10440 устранила проблему со скоростью и была выпущена в ruby-2.2.0:

Пн Ноя 03 03:02:38 2014 Коити Сасада

• переписать логику подбора параметров метода/блока, чтобы оптимизировать аргументы/параметры ключевого слова и аргумент знака. Функция № 10440 (подробности описаны в этой заявке)

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

(08:04:%) rvm use ruby-2.0.0-p247
Using /Users/adam/.rvm/gems/ruby-2.0.0-p247

(08:04:%) ruby keyword_benchmarks.rb

       user     system      total        real
foo    1.390000   0.060000   1.450000 (  1.451284)
bar    0.130000   0.000000   0.130000 (  0.122344)

(08:04:%)   rvm use ruby-2.2.0
Using /Users/adam/.rvm/gems/ruby-2.2.0

(08:04:%) ruby keyword_benchmarks.rb

       user     system      total        real
foo    0.140000   0.000000   0.140000 (  0.136194)
bar    0.110000   0.000000   0.110000 (  0.116246)

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

Например

Функция

def welcome_message(message, options={})
  default_options = {name: 'hoge'}
  options = default_options.merge(options)

  "#{message}、#{options[:name]}"
end

может быть написано

def welcome_message(message, name: 'hoge')
  "#{message}、#{name}"
end