Общие рубиновые идиомы

Question

Одна вещь, которая мне нравится в ruby, это то, что в основном это очень читаемый язык (который отлично подходит для самодокументируемого кода)

Однако, вдохновленный этим вопросом: Ruby Code объяснил и описание того, как ||= работает в ruby, я думал о рубиновых идиомах, которые я не использую, и, честно говоря, я их не совсем понимаю.

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

Кстати, из упомянутого вопроса

a ||= b 

эквивалентно

if a == nil || a == false
  a = b
end

(Спасибо Иану Терреллу за исправление)

Редактировать: Оказывается, этот пункт не является абсолютно спорным. Правильное расширение на самом деле

(a || (a = (b))) 

Смотрите эти ссылки, чтобы узнать, почему:

• http://DABlog.RubyPAL.Com/2008/3/25/a-short-circuit-edge-case/
• http://DABlog.RubyPAL.Com/2008/3/26/short-circuit-post-correction/
• http://ProcNew.Com/ruby-short-circuit-edge-case-response.html

Спасибо Jörg W Mittag за указание на это.

Answer 1

Волшебное условие if, которое позволяет одному и тому же файлу служить библиотекой или скриптом:

if __FILE__ == $0
  # this library may be run as a standalone script
end

Упаковка и распаковка массивов:

# put the first two words in a and b and the rest in arr
a,b,*arr = *%w{a dog was following me, but then he decided to chase bob}
# this holds for method definitions to
def catall(first, *rest)
  rest.map { |word| first + word }
end
catall( 'franken', 'stein', 'berry', 'sense' ) #=> [ 'frankenstein', 'frankenberry', 'frankensense' ]

Синтетический сахар для хэшей в качестве аргументов метода

this(:is => :the, :same => :as)
this({:is => :the, :same => :as})

Хеш-инициализаторы:

# this
animals = Hash.new { [] }
animals[:dogs] << :Scooby
animals[:dogs] << :Scrappy
animals[:dogs] << :DynoMutt
animals[:squirrels] << :Rocket
animals[:squirrels] << :Secret
animals #=> {}
# is not the same as this
animals = Hash.new { |_animals, type| _animals[type] = [] }
animals[:dogs] << :Scooby
animals[:dogs] << :Scrappy
animals[:dogs] << :DynoMutt
animals[:squirrels] << :Rocket
animals[:squirrels] << :Secret
animals #=> {:squirrels=>[:Rocket, :Secret], :dogs=>[:Scooby, :Scrappy, :DynoMutt]}

синтаксис метакласса

x = Array.new
y = Array.new
class << x
  # this acts like a class definition, but only applies to x
  def custom_method
     :pow
  end
end
x.custom_method #=> :pow
y.custom_method # raises NoMethodError

переменные экземпляра класса

class Ticket
  @remaining = 3
  def self.new
    if @remaining > 0
      @remaining -= 1
      super
    else
      "IOU"
    end
  end
end
Ticket.new #=> Ticket
Ticket.new #=> Ticket
Ticket.new #=> Ticket
Ticket.new #=> "IOU"

Блоки, процы и лямбды. Живи и дыши ими.

 # know how to pack them into an object
 block = lambda { |e| puts e }
 # unpack them for a method
 %w{ and then what? }.each(&block)
 # create them as needed
 %w{ I saw a ghost! }.each { |w| puts w.upcase }
 # and from the method side, how to call them
 def ok
   yield :ok
 end
 # or pack them into a block to give to someone else
 def ok_dokey_ok(&block)
    ok(&block)
    block[:dokey] # same as block.call(:dokey)
    ok(&block)
 end
 # know where the parentheses go when a method takes arguments and a block.
 %w{ a bunch of words }.inject(0) { |size,w| size + 1 } #=> 4
 pusher = lambda { |array, word| array.unshift(word) }
 %w{ eat more fish }.inject([], &pusher) #=> ['fish', 'more', 'eat' ]

Answer 2

Это слайд-шоу довольно полно для основных идиом Ruby, например:

• Поменяйте местами два значения:

  x, y = y, x

• Параметры, которые, если не указаны, принимают значение по умолчанию

  def somemethod(x, y=nil)

• Пакетирует посторонние параметры в массив

  def substitute(re, str, *rest)

И так далее ...

Answer 3

Еще несколько идиом:

Использование разделителей %w, %r и %(

%w{ An array of strings %}
%r{ ^http:// }
%{ I don't care if the string has 'single' or "double" strings }

Сравнение типов в регистрационных выражениях

def something(x)
  case x
    when Array
      # Do something with array
    when String
      # Do something with string
    else
      # You should really teach your objects how to 'quack', don't you?
  end
end

... и общее злоупотребление методом === в выписках case

case x
  when 'something concrete' then ...
  when SomeClass then ...
  when /matches this/ then ...
  when (10...20) then ...
  when some_condition >= some_value then ...
  else ...
end

Что-то, что должно выглядеть естественно для Rubyists, но, возможно, не так для людей, пришедших с других языков: использование each в пользу for .. in

some_iterable_object.each{|item| ... }

В Ruby 1.9+, Rails или путем исправления метода Symbol # to_proc этот становится все более популярной идиомой:

strings.map(&:upcase)

Условный метод / определение константы

SOME_CONSTANT = "value" unless defined?(SOME_CONSTANT)

Методы запросов и деструктивные (bang) методы

def is_awesome?
  # Return some state of the object, usually a boolean
end

def make_awesome!
  # Modify the state of the object
end

Неявные параметры сплата

[[1, 2], [3, 4], [5, 6]].each{ |first, second| puts "(#{first}, #{second})" }

Answer 4

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

Некоторые примеры, с которыми я столкнулся:

if params[:controller] == 'discussions' or params[:controller] == 'account'
  # do something here
end

соответствует

if ['account', 'discussions'].include? params[:controller]
  # do something here
end

, который позже будет изменен на

if ALLOWED_CONTROLLERS.include? params[:controller]
  # do something here
end

Answer 5

Мне нравится это:

str = "Something evil this way comes!"
regexp = /(\w[aeiou])/

str[regexp, 1] # <- This

Что (примерно) эквивалентно:

str_match = str.match(regexp)
str_match[1] unless str_match.nil?

Или, по крайней мере, это то, что я использовал для замены таких блоков.

Answer 6

Кстати, из упомянутых вопрос

a ||= b 

эквивалентно

if a == nil   
  a = b 
end

Это немного неверно и является источником ошибок в новых приложениях Ruby.

Поскольку оба (и только) nil и false имеют логическое значение false, a ||= b фактически (почти *) эквивалентно:

if a == nil || a == false
  a = b
end

Или переписать его с другой идиомой Ruby:

a = b unless a

(* Поскольку каждое утверждение имеет значение, оно технически не эквивалентно a ||= b. Но если вы не полагаетесь на значение оператора, вы не увидите разницы.)

Answer 7

Вот несколько, отобранных из разных источников:

используйте «если» и «до» вместо «если нет» и «пока нет». Старайтесь не использовать «разве что», когда существует условие «еще».

Помните, что вы можете назначить несколько переменных одновременно:

a,b,c = 1,2,3

и даже переменная подкачки без температуры:

a,b = b,a

При необходимости используйте конечные условия, например,

.

do_something_interesting unless want_to_be_bored?

Помните о широко используемом, но не сразу очевидном (по крайней мере для меня) способе определения методов класса:

class Animal
  class<<self
    def class_method
      puts "call me using Animal.class_method"
    end
  end
end

Некоторые ссылки:

• http://cbcg.net/talks/rubyidioms/index.html
• http://www.therailsway.com/2006/12/8/idiomatic-ruby
• http://www.therailsway.com/2007/1/21/more-idiomatic-ruby
• http://www.caliban.org/ruby/rubyguide.shtml

Answer 8

Я поддерживаю вики-страницу, которая охватывает некоторые идиомы и форматирование Ruby:

https://github.com/tokland/tokland/wiki/RubyIdioms

Answer 9

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

refactor < 3 ? puts("No need to refactor YET") : puts("You need to refactor this into a  method")

расширяется до

if refactor < 3
  puts("No need to refactor YET")
else
  puts("You need to refactor this into a  method")
end

обновление

называется троичным оператором:

вернуть myvar? myvar.size: 0

Answer 10

Мне нравится, как If-then-elses или case-when можно сократить, потому что они возвращают значение:

if test>0
  result = "positive"
elsif test==0
  result = "zero"
else
  result = "negative"
end

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

result = if test>0
  "positive"
elsif test==0
  "zero"
else
  "negative"
end

То же самое можно применить к случаю, когда:

result = case test
when test>0 ; "positive"
when test==0 ; "zero"
else "negative"
end