Où placer les méthodes privées dans Ruby?

La plupart des blogs ou tutoriels ou livres ont des méthodes privées au bas de n'importe quelle classe / module. Est-ce la meilleure pratique?

Je trouve plus pratique d'avoir des méthodes privées au besoin. Par exemple:

public
def my_method
  # do something
  minion_method
end

private
def minion_method
  # do something
end

public
def next_method
end

De cette façon, je trouve le code plus lisible au lieu de faire défiler de haut en bas en continu, ce qui est très irritant.

Y a-t-il quelque chose qui ne va pas dans cette approche? Avoir des méthodes privées à la base n'est-il pas seulement une meilleure pratique et autre chose?

La meilleure pratique à mon avis est d'aller de manière séquentielle et de déclarer vos méthodes sans garder un point de vue privé.

À la fin, vous pouvez rendre toute méthode privée en ajoutant simplement: private :xmethod

Exemple:

class Example
 def xmethod
 end

 def ymethod
 end

 def zmethod 
 end

 private :xmethod, :zmethod

end

Cela justifie-t-il votre question?

Il existe également la possibilité d'ajouter un préfixe privateà la définition de méthode depuis Ruby 2.1.

class Example

 def xmethod
 end

 private def ymethod
 end

 private def zmethod 
 end

end

En regardant la définition, vous savez instantanément si une méthode est privée, peu importe où dans le fichier elle est définie. C'est un peu plus de frappe (si vous ne la complétez pas automatiquement) et tous vos defs ne seront pas bien alignés.

Comme d'autres l'ont déjà souligné, la convention consiste à placer les méthodes privées en bas, sous une classe privée. Cependant, vous devriez probablement aussi savoir que de nombreux programmeurs utilisent une méthode à double retrait (4 espaces au lieu de 2) pour cela. La raison en est que souvent, vous ne verrez pas «privé» dans votre éditeur de texte et supposez qu'ils pourraient être publics. Voir ci-dessous pour une illustration:

class FooBar

  def some_public_method
  end

  def another_public_method
  end

private

    def some_private_method
    end

    def another_private method
    end

end

Cette méthode devrait vous éviter d'avoir à faire défiler vers le haut et le bas et rendra les autres programmeurs plus à l'aise dans votre code.

Je pense que les méthodes publiques sont une sorte d'interface de l'objet, et il est logique de les placer à l'endroit le plus proéminent, c'est-à-dire en haut du fichier.

Vous n'avez pas besoin de mettre publicou privateau - dessus de chaque méthode. Je mets généralement toutes mes méthodes privées au bas de ma classe. De plus, il n'est pas nécessaire de le dire explicitement publiccar les méthodes sont publiques par défaut. Par exemple:

class FooBar

  def some_public_method
  end

  def another_public_method
  end

private

  def some_private_method
  end

  def another_private method
  end

end

Je viens de fond java et je déteste avoir à faire défiler pour voir le type de méthode. Je pense que c'est insensé qu'on ne puisse pas spécifier la visibilité des méthodes par méthode sans laideur. J'ai donc fini par mettre un commentaire #privateavant chaque méthode suck et ensuite déclarer private :....

Je n'aime pas avoir à spécifier public ou privé pour chaque méthode. Mettre toutes les méthodes privées en bas me permet d'avoir une seule instance de "privé" par fichier. Je suppose que c'est une question de goût.

Un style est aux méthodes de regrouper de sorte que vous utilisez uniquement privateet protectedune fois par classe au maximum. Un autre style consiste à spécifier la visibilité juste après la définition de la méthode:

class Example
  def my_private_method
  end
  private :my_private_method

  def my_public_method
  end
end

Depuis Ruby 2.1.0 defrenvoie le nom de la méthode sous forme de symbole, donc un style plus simplifié est possible:

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

(Notez que nous utilisons private_class_methodpour les méthodes de classe - sinon nous obtiendrions NameError: undefined methoddepuisprivate attend une méthode d'instance. Même si vous l'utilisez comme macro comme dans l'exemple d'origine, cela n'affecte que la visibilité des méthodes d'instance.)

J'aime mieux ce style de visibilité en ligne, car il vous permet d'organiser les méthodes comme vous le souhaitez. Cela réduit le risque d'ajouter une nouvelle méthode au mauvais endroit et de la rendre privée par inadvertance.

En ce qui concerne la syntaxe de la méthode de classe, vous pouvez la gérer de cette façon à la place:

class Example
  private def my_private_method
  end

  class << self
    private def my_private_class_method
    end
  end
end

Dennis avait la réponse parfaite, c'est-à-dire que lorsque vous utilisez ruby> = 2.1, préfixez simplement la définition avec private (ou protected, public)

Mais je pense qu'il est désormais également possible d'utiliser private comme bloc comme dans:

private begin
   def foo
   end
   def bar
   end
end

def zip
end

Je commande généralement mes méthodes comme suit:

1. Constructeur
2. Autres méthodes publiques, par ordre alphabétique
3. private, écrit une seule fois
4. Méthodes privées, par ordre alphabétique

J'utilise les fonctionnalités «aller à la définition» dans mon éditeur pour que cela n'implique pas beaucoup de défilement, et dans tous les cas, si la classe est suffisamment grande pour que le défilement devienne problématique, elle devrait probablement être divisée en plusieurs classes.