Где разместить частные методы в Ruby?

В большинстве блогов, руководств или книг есть частные методы внизу любого класса / модуля. Это лучшая практика?

Я нахожу более удобными частные методы по мере необходимости. Например:

public
def my_method
  # do something
  minion_method
end

private
def minion_method
  # do something
end

public
def next_method
end

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

Что-то не так в этом подходе? Наличие частных методов внизу - это не просто лучшая практика и что-то еще?

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

В конце вы можете сделать любой метод приватным, просто добавив: private :xmethod

Пример:

class Example
 def xmethod
 end

 def ymethod
 end

 def zmethod 
 end

 private :xmethod, :zmethod

end

Это оправдывает ваш вопрос?

Также есть возможность добавить privateк определению метода начиная с Ruby 2.1.

class Example

 def xmethod
 end

 private def ymethod
 end

 private def zmethod 
 end

end

Глядя на определение, вы сразу узнаете, является ли метод закрытым, независимо от того, в каком месте файла он определен. Это немного больше набора текста (если вы не используете автозаполнение), и не все ваши defs будут хорошо выровнены.

Как уже отмечали другие, соглашение заключается в размещении частных методов внизу под одним частным классом. Однако вам, вероятно, также следует знать, что многие программисты используют для этого метод с двойным отступом (4 пробела вместо 2). Причина в том, что часто вы не видите «частные» в текстовом редакторе и предполагаете, что они могут быть общедоступными. См. Иллюстрацию ниже:

class FooBar

  def some_public_method
  end

  def another_public_method
  end

private

    def some_private_method
    end

    def another_private method
    end

end

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

Я считаю, что публичные методы - это своего рода интерфейс объекта, и логично разместить их на самом видном месте, то есть в верхней части файла.

Вам не нужно ставить publicили privateнад каждым методом. Обычно я помещаю все свои частные методы в конец своего класса. Кроме того, не нужно явно указывать, publicчто методы по умолчанию являются общедоступными. Например:

class FooBar

  def some_public_method
  end

  def another_public_method
  end

private

  def some_private_method
  end

  def another_private method
  end

end

Я исхожу из фона java, и мне не нравится прокручивать, чтобы увидеть тип метода. Я думаю, это безумие, что нельзя указать видимость метода для каждого метода без уродства. В итоге я оставил комментарий #privateперед каждым методом отстой и объявил private :....

Мне не нравится указывать публичный или частный для каждого метода. Размещение всех приватных методов внизу позволяет мне иметь единственный экземпляр «приватных» для каждого файла. Думаю, дело вкуса.

Один стиль для групповых методов вместе , так что вы используете только privateи protectedодин раз в классе максимум. Другой стиль - указать видимость сразу после определения метода:

class Example
  def my_private_method
  end
  private :my_private_method

  def my_public_method
  end
end

Начиная с Ruby 2.1.0, defимя метода возвращается в виде символа, поэтому возможен более упрощенный стиль:

class Example
  private def my_private_method
  end

  def my_public_method
  end

  protected def my_protected_method
  end

  private_class_method def self.my_private_class_method
  end
end

(Обратите внимание, что мы используем private_class_methodметоды класса - в противном случае мы получили бы, NameError: undefined methodпоскольку privateожидает метод экземпляра. Даже при использовании его в качестве макроса, как в исходном примере, он влияет только на видимость методов экземпляра.)

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

Что касается синтаксиса метода класса, вы можете справиться с этим следующим образом:

class Example
  private def my_private_method
  end

  class << self
    private def my_private_class_method
    end
  end
end

У Денниса был идеальный ответ, то есть при использовании ruby> = 2.1 просто префикс def с помощью private (или protected, public)

Но я считаю, что теперь также можно использовать private как блок, например:

private begin
   def foo
   end
   def bar
   end
end

def zip
end

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

1. Конструктор
2. Другие общедоступные методы в алфавитном порядке
3. private, написано только один раз
4. Частные методы в алфавитном порядке

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