Gdzie umieścić prywatne metody w Rubim?

Większość blogów, samouczków lub książek ma prywatne metody na dole każdej klasy / modułu. Czy to najlepsza praktyka?

Uważam, że korzystanie z prywatnych metod jest dla mnie wygodniejsze. Na przykład:

public
def my_method
  # do something
  minion_method
end

private
def minion_method
  # do something
end

public
def next_method
end

W ten sposób uważam, że kod jest bardziej czytelny, zamiast ciągłego przewijania w górę iw dół, co jest bardzo irytujące.

Czy w tym podejściu jest coś strasznego? Czy posiadanie prywatnych metod na dole to nie tylko najlepsza praktyka i coś innego?

Moim zdaniem najlepszą praktyką jest pójście sekwencyjnie i deklarowanie swoich metod bez zachowania tajemnicy z punktu widzenia.

Na koniec możesz ustawić dowolną metodę jako prywatną, dodając po prostu: private :xmethod

Przykład:

class Example
 def xmethod
 end

 def ymethod
 end

 def zmethod 
 end

 private :xmethod, :zmethod

end

Czy to uzasadnia twoje pytanie?

Istnieje również opcja dodania privateprzed definicją metody od Ruby 2.1.

class Example

 def xmethod
 end

 private def ymethod
 end

 private def zmethod 
 end

end

Patrząc na definicję, od razu wiesz, czy metoda jest prywatna, bez względu na to, gdzie w pliku jest zdefiniowana. To trochę więcej pisania (jeśli nie uzupełniasz autouzupełniania) i nie wszystkie twoje defbędą ładnie wyrównane.

Jak inni już zauważyli, konwencja polega na umieszczeniu metod prywatnych na samym dole, w ramach jednej klasy prywatnej. Jednak prawdopodobnie powinieneś również wiedzieć, że wielu programistów używa do tego metody z podwójnym wcięciem (4 spacje zamiast 2). Powodem jest to, że często nie widzisz słowa „prywatne” w swoim edytorze tekstu i zakładasz, że mogą one być publiczne. Poniżej znajduje się ilustracja:

class FooBar

  def some_public_method
  end

  def another_public_method
  end

private

    def some_private_method
    end

    def another_private method
    end

end

Ta metoda powinna zapobiec konieczności przewijania w górę iw dół i sprawi, że inni programiści będą wygodniejsi w kodzie.

Myślę, że metody publiczne są pewnego rodzaju interfejsem obiektu i logiczne jest umieszczenie ich w najbardziej widocznym miejscu, tj. Na górze pliku.

Nie musisz umieszczać publicani privatepowyżej każdej metody. Zwykle wszystkie moje metody prywatne umieszczam na końcu moich zajęć. Nie musisz też wyraźnie mówić, publicponieważ metody są domyślnie publiczne. Na przykład:

class FooBar

  def some_public_method
  end

  def another_public_method
  end

private

  def some_private_method
  end

  def another_private method
  end

end

Pochodzę z tła Java i nienawidzę przewijania, aby zobaczyć typ metody. Myślę, że to szaleństwo, że nie można określić widoczności poszczególnych metod bez brzydoty. Skończyło się na umieszczeniu komentarza #privateprzed każdą metodą ssania, a następnie zadeklarowaniu private :....

Nie podoba mi się konieczność określania publicznego lub prywatnego dla każdej metody. Umieszczenie wszystkich metod prywatnych na dole pozwala mi mieć pojedyncze wystąpienie „prywatnego” na plik. Myślę, że to kwestia gustu.

Jeden styl polega na grupowaniu metod razem, tak aby można było używać tylko privatei protectedmaksymalnie raz na klasę. Innym stylem jest określenie widoczności zaraz po definicji metody:

class Example
  def my_private_method
  end
  private :my_private_method

  def my_public_method
  end
end

Począwszy od Ruby 2.1.0 defzwraca nazwę metody jako symbol, więc możliwy jest bardziej uproszczony styl:

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

(Zauważ, że używamy private_class_methoddla metod klasowych - w przeciwnym razie otrzymalibyśmy NameError: undefined methododprivate oczekuje metody instancji. Nawet jeśli używamy jej jako makra, jak w oryginalnym przykładzie, wpływa to tylko na widoczność metod instancji.)

Najbardziej podoba mi się ten styl widoczności w wierszu, ponieważ pozwala on na dowolną organizację metod. Zmniejsza ryzyko dodania nowej metody w niewłaściwym miejscu i nieumyślnego uczynienia jej prywatną.

Jeśli chodzi o składnię metody klas, możesz to obsłużyć w ten sposób:

class Example
  private def my_private_method
  end

  class << self
    private def my_private_class_method
    end
  end
end

Dennis miał idealną odpowiedź, to znaczy, używając ruby> = 2.1, po prostu przedrostek def z private (lub protected, public)

Ale uważam, że teraz można również używać prywatnego jako bloku, jak w:

private begin
   def foo
   end
   def bar
   end
end

def zip
end

Generalnie moje metody zamawiam w następujący sposób:

1. Konstruktor
2. Inne metody publiczne, w porządku alfabetycznym
3. private, napisane tylko raz
4. Metody prywatne w kolejności alfabetycznej

Używam funkcji „przejdź do definicji” w moim edytorze, aby nie wymagało to dużego przewijania. W każdym razie, jeśli klasa jest na tyle duża, że ​​przewijanie staje się problematyczne, prawdopodobnie należy ją podzielić na kilka klas.