Métodos de módulo privados em Ruby

Eu tenho uma pergunta de duas partes

Melhor prática

• Eu tenho um algoritmo que executa algumas operações em uma estrutura de dados usando a interface pública
• Atualmente, é um módulo com vários métodos estáticos, todos privados, exceto o método de interface pública.
• Existe uma variável de instância que precisa ser compartilhada entre todos os métodos.

Estas são as opções que consigo ver, qual é a melhor ?:

• Módulo com métodos estáticos ('módulo' em ruby)
• Classe com métodos estáticos
• Módulo Mixin para inclusão na estrutura de dados
• Refatore a parte do algoritmo que modifica essa estrutura de dados (muito pequena) e faça disso uma combinação que chama os métodos estáticos do módulo do algoritmo

Parte técnica

Existe alguma maneira de fazer um método de módulo privado ?

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

O privatein lá parece não ter nenhum efeito , ainda posso ligar Thing.privsem problemas.

Acho que a melhor maneira (e principalmente como as bibliotecas existentes são escritas) de fazer isso é criando uma classe dentro do módulo que lida com toda a lógica e o módulo fornece apenas um método conveniente, por exemplo

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

Há também Module.private_class_method, o que provavelmente expressa mais intenção.

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

Para o código em questão:

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 mais recente:

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)

Você pode usar o método "incluído" para fazer coisas fantasiosas quando um módulo é misturado. Isso faz o que você quiser, eu acho:

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

Infelizmente, privatesó se aplica a métodos de instância. A maneira geral de obter métodos "estáticos" privados em uma classe é fazer algo como:

class << self
  private

  def foo()
   ....
  end
end

Admito que não brinquei com isso em módulos.

Uma maneira legal é assim

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

Que tal armazenar métodos como lambdas em variáveis ​​/ constantes de classe?

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

Para teste:
UPD: grande atualização deste código após 6 anos mostra uma maneira mais limpa de declarar o método privadod

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

Aqui vemos 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) @@Lnão pode ser acessado de fora, mas é acessível de quase todos os lugares
2) class << self ; private ; deftorna o método dinacessível de fora e de dentro com sucesso, self.mas não sem ele - isso é estranho
3) private ; self.e private ; class << selfnão torna os métodos privados - eles são acessíveis ambos com e semself.

Faça um módulo ou classe privada

As constantes nunca são privadas. No entanto, é possível criar um módulo ou classe sem atribuí-lo a uma constante.

Portanto, uma alternativa :private_class_methodé criar um módulo ou classe privada e definir métodos públicos nele.

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

Uso:

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

Consulte os documentos de Module.new e Class.new .

Este método não permitirá o compartilhamento de dados com os métodos privados, a menos que você passe explicitamente os dados por parâmetros de método.

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)