Méthodes de module privé dans Ruby

J'ai une question en deux parties

Meilleur entrainement

• J'ai un algorithme qui effectue une opération sur une structure de données à l'aide de l'interface publique
• Il s'agit actuellement d'un module avec de nombreuses méthodes statiques, toutes privées à l'exception de la méthode d'interface publique unique.
• Il y a une variable d'instance qui doit être partagée entre toutes les méthodes.

Voici les options que je peux voir, quelle est la meilleure?:

• Module avec méthodes statiques ('module' en ruby)
• Classe avec méthodes statiques
• Module Mixin pour inclusion dans la structure de données
• Refactoriser la partie de l'algorithme qui modifie cette structure de données (très petite) et en faire un mixin qui appelle les méthodes statiques du module d'algorithme

Partie technique

Existe-t-il un moyen de créer une méthode Module privée ?

module Thing
  def self.pub; puts "Public method"; end
  private
  def self.priv; puts "Private method"; end
end

Le privatededans ne semble pas avoir d'effet , je peux toujours appeler Thing.privsans problème.

Je pense que la meilleure façon (et surtout la façon dont les bibliothèques existantes sont écrites) pour ce faire est de créer une classe dans le module qui traite toute la logique, et le module fournit simplement une méthode pratique, par exemple

module GTranslate
  class Translator
    def perform( text ); translate( text ); end

    private

    def translate( text )
      # do some private stuff here
    end
  end

  def self.translate( text )
    t = Translator.new
    t.perform( text )
  end
end

Il y a aussi Module.private_class_method, qui exprime sans doute plus d'intention.

module Foo
  def self.included(base)
    base.instance_eval do
      def method_name
        # ...
      end
      private_class_method :method_name
    end
  end
end

Pour le code de la question:

module Thing
  def self.pub; puts "Public method"; end
  def self.priv; puts "Private method"; end
  private_class_method :priv
end

Ruby 2.1 ou plus récent:

module Thing
  def self.pub; puts "Public method"; end
  private_class_method def self.priv; puts "Private method"; end
end

module Writer
  class << self
    def output(s)
      puts upcase(s)
    end

    private

    def upcase(s)
      s.upcase
    end
  end
end

Writer.output "Hello World"
# -> HELLO WORLD

Writer.upcase "Hello World"
# -> so.rb:16:in `<main>': private method `upcase' called for Writer:Module (NoMethodError)

Vous pouvez utiliser la méthode "inclus" pour faire des choses fantaisistes quand un module est mélangé. Cela fait ce que vous voulez, je pense:

module Foo
  def self.included(base)
    class << base 
      def public_method
        puts "public method"
      end
      def call_private
        private_method
      end
      private
      def private_method
        puts "private"
      end
    end
  end
end

class Bar
  include Foo
end

Bar.public_method

begin
  Bar.private_method
rescue
  puts "couldn't call private method"
end

Bar.call_private

Malheureusement, privatene s'applique qu'aux méthodes d'instance. La manière générale d'obtenir des méthodes "statiques" privées dans une classe est de faire quelque chose comme:

class << self
  private

  def foo()
   ....
  end
end

Certes, je n'ai pas joué avec cela dans les modules.

Une belle façon est comme ça

module MyModule
  class << self
    def public_method
      # you may call the private method here
      tmp = private_method
      :public
    end

    private def private_method
      :private
    end
  end
end

# calling from outside the module
puts MyModule::public_method

Qu'en est-il du stockage de méthodes en tant que lambdas dans des variables / constantes de classe?

module MyModule
  @@my_secret_method = lambda {
    # ...
  }
  # ...
end

Pour le test:
UPD: une énorme mise à jour de ce code après 6 ans montre un moyen plus propre de déclarer une méthode privéed

module A
  @@L = lambda{ "@@L" }
  def self.a ; @@L[] ; end
  def self.b ; a ; end

  class << self
    def c ; @@L[] ; end
    private
    def d ; @@L[] ; end
  end
  def self.e ; c ; end
  def self.f ; self.c ; end
  def self.g ; d ; end
  def self.h ; self.d ; end

  private
  def self.i ; @@L[] ; end
  class << self
    def j ; @@L[] ; end
  end

  public
  def self.k ; i ; end
  def self.l ; self.i ; end
  def self.m ; j ; end
  def self.n ; self.j ; end
end

for expr in %w{ A.a A.b A.c A.d A.e A.f A.g A.h A.i A.j A.k A.l A.m A.n }
  puts "#{expr} => #{begin ; eval expr ; rescue => e ; e ; end}"
end

Ici, nous voyons que:

A.a => @@L
A.b => @@L
A.c => @@L
A.d => private method `d' called for A:Module
A.e => @@L
A.f => @@L
A.g => @@L
A.h => private method `d' called for A:Module
A.i => @@L
A.j => @@L
A.k => @@L
A.l => @@L
A.m => @@L
A.n => @@L

1) @@Lne peut pas être accessible de l'extérieur mais est accessible de presque partout
2) class << self ; private ; defrend la méthode dinaccessible de l'extérieur et de l'intérieur avec self.mais pas sans - c'est bizarre
3) private ; self.et private ; class << selfne rend pas les méthodes privées - elles sont accessibles à la fois Avec et sansself.

Créer un module ou un cours privé

Les constantes ne sont jamais privées. Cependant, il est possible de créer un module ou une classe sans l'affecter à une constante.

Donc, une alternative à :private_class_methodest de créer un module ou une classe privée et de définir des méthodes publiques dessus.

module PublicModule
  def self.do_stuff(input)
    @private_implementation.do_stuff(input)
  end

  @private_implementation = Module.new do
    def self.do_stuff(input)
      input.upcase # or call other methods on module
    end
  end
end

Usage:

PublicModule.do_stuff("whatever") # => "WHATEVER"

Consultez la documentation pour Module.new et Class.new .

Cette méthode n'autorise pas le partage de données avec les méthodes privées, sauf si vous transmettez explicitement les données par des paramètres de méthode.

module Thing
  extend self

  def pub
    puts priv(123)
  end

  private
  
  def priv(value)
    puts "Private method with value #{value}"
  end
end

Thing.pub
# "Private method with value 123"

Thing.priv
# NoMethodError (private method `priv' called for Thing:Module)