web-dev-qa-db-ja.com

Rubyのプライベートモジュールメソッド

2つの部分からなる質問があります

ベストプラクティス

  • パブリックインターフェイスを使用してデータ構造に対して何らかの操作を実行するアルゴリズムがあります
  • 現在、多数の静的メソッドを備えたモジュールであり、1つのパブリックインターフェイスメソッドを除き、すべてプライベートです。
  • すべてのメソッドで共有する必要があるインスタンス変数が1つあります。

これらは私が見ることができるオプションで、どれが最良ですか?:

  • モジュール静的(Rubyの「モジュール」)メソッド
  • クラス静的メソッドを使用
  • Mixinデータ構造に含めるためのモジュール
  • リファクタリングそのデータ構造を変更するアルゴリズムの一部(非常に小さい)を削除し、アルゴリズムモジュールの静的メソッドを呼び出すmixinを作成する

技術部分

プライベートモジュールメソッドを作成する方法はありますか?

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

そこのprivateは効果がないようですThing.privを問題なく呼び出すことができます。

96

私は、すべてのロジックを処理するモジュール内にクラスを作成することでこれを行う最善の方法(およびほとんどの場合、既存のライブラリが作成される方法)を考えると、モジュールは便利なメソッドを提供するだけです。

module GTranslate
  class Translator
    def perform( text ); 'hola munda'; end
  end

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

Module.private_class_methodもあり、これは間違いなくより多くの意図を表します。

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

質問のコードの場合:

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

Ruby 2.1以降:

module Thing
  def self.pub; puts "Public method"; end
  private_class_method def self.priv; puts "Private method"; end
end
72
jfrench
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)
44
cdrev

「included」メソッドを使用して、モジュールが混在しているときに凝った作業を行うことができます。これは、あなたが望むことについて行います:

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
28
Cameron Price

残念ながら、privateはインスタンスメソッドにのみ適用されます。クラスでプライベートな「静的」メソッドを取得する一般的な方法は、次のようなことです。

class << self
  private

  def foo()
   ....
  end
end

確かに、私はモジュールでこれをやったことがありません。

12
J Cooper

いい方法はこんな感じ

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
2
Tallak Tveide

Railsでこれを行うことで見つけた最良のパターンは、プライベートメソッドを持ち、代わりにシングルトンクラスを使用するモジュールを放棄することです。動作し、この質問で私が見た他の例よりもきれいです。

これに関する他の意見を聞きたいです。

例:

ErrorService.notify("Something bad happened")

class ErrorService
  include Singleton

  class << self
    delegate :notify, to: :instance
  end

  def notify(message, severity: :error)
    send_exception_notification(message)
    log_message(message, severity)
  end

  private

  def send_exception_notification(message)
    # ...
  end

  def log_message(message, severity)
    # ...
  end
end
2
Gerry Shaw

クラス変数/定数内にラムダとしてメソッドを保存するのはどうですか?

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

テスト用:
PD:6年後のこのコードの大規模な更新は、プライベートメソッドdを宣言するよりクリーンな方法を示しています

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

ここにそれを見る:

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)@@Lは外部からはアクセスできませんが、ほとんどどこからでもアクセスできます
2)class << self ; private ; defは、self.を使用して外部および内部からメソッドdに正常にアクセスできますが、それなしではできません-これは奇妙です
3)private ; self.およびprivate ; class << selfはメソッドをプライベートにしません。self.の有無にかかわらずアクセス可能です

1
Nakilon

プライベートモジュールまたはクラスを作成する

定数は決してプライベートではありません。ただし、定数に割り当てずにモジュールまたはクラスを作成することは可能です。

したがって、:private_class_methodに代わる方法は、プライベートモジュールまたはクラスを作成し、パブリックメソッドまたはパブリックメソッドを定義することです。

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

使用法:

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

Module.new および Class.new のドキュメントを参照してください。

0
Nathan Long