なぜ Ruby のクラスメソッドは privateprivate にできないのか

Ruby では、private メソッドを

Ruby の Module クラスには private といふメソッド[1]がある。

が、このメソッドでクラスメソッドの可視性を private にすることはできない。次のコードを実行すると NameError が投げられる:

class A
  private def self.f; end
end

クラスメソッドの可視性を private にするには、代はりに private_class_method メソッドを使って、

class A
  private_class_method def self.f; end
end

とするか、特異クラスを使って、

class A
  class << self
    private def f; end
  end
end

とする。また、

class A
  private def _f; end

  def self.f
    self.new._f
  end
end

としても、ほゞ同じ結果が得られる。

この記事ではこの振る舞ひの理由を説明する。

特異メソッド

特定のオブジェクトに固有のメソッドをそのオブジェクトの特異メソッドと言ふ。特異メソッドは、メソッド定義と同じやうな構文で、

def nil.empty?
  true
end

といふゝうに定義する。このコードを実行すると、nil オブジェクトに :empty? といふ名前のメソッドが追加される。

クラスメソッド

特異メソッドのうち、レシーバーがクラスであるものをクラスメソッドと言ふ。例へば、

class A; end

def A.f(x)
  -x
end

A.f がこれに当たる。

他の多くのオブジェクト指向プログラミング言語と同様に、クラスメソッドは継承される。つまり、

class B < A; end

fail unless A.f(2) == B.f(2)

が成功する。

メソッド

メソッド定義構文も確認する。次のコードを実行すると、2–4行目で、クラス A:f といふ名前のメソッドが追加される[2]:

class A
  def f(x)
    -x
  end
end

この記事では、このやうなメソッドを参照するために A#f と書くことがある。

self

クラス定義やモジュール定義の中では、self はそのクラスやモジュール自身を指す。次の2つのコードは、どちらも A を印字する(モジュールについては以下扱はない。):

class A
  p self
end
module A
  p self
end

self を使ふと、クラスメソッド A.f は、

class A
  def self.f(x)
    -x
  end
end

と定義することもできる。

メソッド定義の中では、self は、そのメソッド呼び出しのレシーバーを指す。つまり、

class A
  def receiver
    self
  end

  def self.receiver
    self
  end
end

fail unless A.new.receiver.class == A
fail unless A.receiver == A

が成功する。

なぜ特異メソッド定義の def の右の部分ではこのやうにレシーバーを指さないのかといふと、

class A
  def self.f(x)
    -x
  end
end

は、

class A
  self.define_singleton_method(:f) do |x|
    -x
  end
end

と同等だからである。この self はクラス定義の中、メソッド定義のほんたいの外にあるので、そのクラスを指すことになる。

より一般的に言へば、self

現在のコンテキストにおいて、暗黙のレシーバーとなるオブジェクト。

である。(引用元は Ruby 用語集(Ruby 3.1 リファレンスマニュアル)。)

private

今、話題にしてゐる private は、Module クラスのメソッドで[3]、メソッド名を引数に取って、レシーバーが持つその名前のメソッドを明示的なレシーバーを使って呼び出せなくするものである[4]。例へば、

class A
  def f; end

  private :f
end

を実行すると、2行目でクラス A にメソッド f が追加され[2:1]4行目でそのメソッドの可視性が private になる。逆に言へば、Ruby では、明示的なレシーバーを使って呼び出せないメソッドを private メソッドと言ふ。そのため、他の多くの言語とは異なり、Ruby の private メソッドはサブクラスからも呼び出すことができる:

class A
  private def f
    42
  end
end

class B < A
  def g
    f # A#f
  end
end

b = B.new
p b.g # prints 42

Module クラスの private メソッドも private メソッドである。よって、

class A
  def f; end
end

A.private :f

のやうに、クラス定義の外でメソッドの可視性を変更することはできない。(リフレクション無しに)こんなことができてしまっては、定義を変更せずにクラスが破壊できてしまふので、当然の設計である。

そのため、このメソッドは、クラス定義の中で使はれるときも、private :f といふゝうに、レシーバーを明示せずに呼び出される。明示的なレシーバーが無ければ self が暗黙のレシーバーとして振る舞ふことゝ、クラス定義の中では self はそのクラス自身を指すことから、

class A
  def f; end

  private :f
end

のやうに呼び出された private :f は、そのクラス A をレシーバーとして実行される。

private_class_method

これに対して、private_class_methodpublic メソッドである。よって、冒頭のコードは、

class A
  def self.f; end
end

A.private_class_method(:f)

としてもうまく動作する。この設計も private の場合と同様に危険だが、クラスメソッド定義の中ではクラスが暗黙のレシーバーになる[5]ので、仮にこのメソッドの可視性が private だとしても、次のやうにすれば、クラス定義の外でクラスメソッドを private にすることができてしまふ:

class A
  def self.f; end
end

def A.private_class_method_of_A(name)
  private_class_method name
end

A.private_class_method_of_A(:f)

クラスメソッドが全てクラス定義の外で定義されてゐれば、クラス定義では、そのクラスのオブジェクトがどのやうなデータを持ち、どのやうに振る舞ふかだけを記述することができる[6]

オープンクラス

Ruby のクラスにはオープンクラスといふ性質があり、定義済みのクラスと同じ名前のクラスを再度定義して、元のクラスを変更することができる。例へば、

class NilClass
  def empty?
    true
  end
end

を実行すると、nil.empty?true を返すやうになる。これを使ふと、

class A
  def f; end
end

class A
  private :f
end

のやうにして、元のクラス定義の外でメソッドの可視性を変更することもできる。

これを回避するための簡単な方法として、private メソッドは private def .. end の形式で使ふといふものがある[7]

なぜこの書き方がうまくいくのかといふと、メソッド定義は、成功すると、定義されたメソッドの名前を返すからである。例へば、

class A
  p def f; end
end

:f を印字する。メソッド呼び出しよりもメソッド定義構文の方が優先順位が高いので、このコードの2行目は p (def f; end) に等しい。また、特異メソッド定義も同様に、定義されたメソッドの名前を返す。名前だけを返すことに注意。次のコードも :f を印字する:

class A
  p def self.f; end
end

解決篇

といふわけで、冒頭の

class A
  private def self.f; end
end

が実行されると、クラス A が定義された後、まづ、def self.f; end が呼び出され、特異メソッド A.f が定義される。次に、この部分はメソッド名、つまり :f を返すので、private :f が呼び出される。private メソッドは、対象のメソッド、つまり A#f が存在しない場合、NameError を投げるので、このコードは失敗する。また、

class A
  def f; end

  private def self.f; end
end

とすると、クラス A が定義された後、まづ、def f; end が呼び出されて、メソッド A#f が定義され、その後は同じやうに動作する。private :f の対象のメソッドが存在するので、このコードは成功するが、private はメソッドの可視性を変更するメソッドなので、特異メソッド A.f ではなくメソッド A#fprivate になってしまふ。めでたし。

補遺

なほ、冒頭の

class A
  class << self
    private def f; end
  end
end

class A
  private def _f; end

  def self.f
    A.new._f
  end
end

がうまくいくのは、これらのコードの private が(特異メソッド定義ではなく)メソッド定義を引数に取ってゐるからである。これらのトリックはいづれも、実質的には、一度メソッドとして定義したものをクラスメソッドに置き換へるものである。

前者の class << expr 形式は、特異クラスを定義する構文である。特異クラスは、Ruby 用語集(Ruby 3.1 リファレンスマニュアル)では、

すべてのオブジェクトには自身が属すクラスとは別に、オブジェクト固有のクラスがあり、特異クラスと呼ばれる。

と説明されてゐる。class << expr は、expr の特異クラスを定義する。あるオブジェクトの特異クラスのメソッドは、そのオブジェクトの特異メソッドである。つまり、expr の特異クラスの定義の中で定義されたメソッドは、expr の特異メソッドとなる。クラス定義の中では self はそのクラス自身を指すので、このコードの self はクラス A を指し、class << selfA の特異クラスを定義する。その中で定義されるメソッドは A の特異メソッドとなる。そのため、特異クラスの定義をクラス定義から追ひ出して、

class A; end

class << A
  private def f; end
end

としても同じ結果が得られる。


  1. これがメソッドだといふ認識が無い人も少なくないと思ふ。本文ですぐに説明する。 ↩︎

  2. class A が処理され、クラス定義の中に入った時点で、すでにクラス A は存在する。

    class A
      p A.new.class
    end
    

    A を印字する。対応する end は、単に def (Module#define_method) の self を変更する。 ↩︎ ↩︎

  3. クラスは Class クラスのインスタンス、ClassModule のサブクラスであり、クラス定義の中では self はそのクラス自身を指し、private メソッドはサブクラスからも呼び出せるので、クラス定義の中でも、private :f みたいな文がうまく動作する。 ↩︎

  4. 明示的なレシーバーを使った呼び出しとは、a.f(x) のやうな式を言ふ。Method オブジェクトを call することはできる。その場合、レシーバーを明示的に bind してもよい。つまり、

    class A
      attr_reader :value
    
      def initialize value
        @value = value
      end
    
      private def f
        self.value
      end
    end
    
    a = A.new 6 * 9
    b = A.new 42
    p A.instance_method(:f).bind(b).call
    

    は成功し、42 を印字する。 ↩︎

  5. メソッド定義の中の self はレシーバーを指し、クラスメソッドのレシーバーはクラスであるため。 ↩︎

  6. クラスインスタンス変数のアクセサーはクラスメソッドなので、自然にクラス定義の外で定義される。attr_accessor は特異クラスで使ふ。初期化は、アクセサーを定義した後で、

    A.a = 0
    

    のやうにする。 ↩︎

  7. 世間のほとんどのスタイルガイドは

    class A
      def f; end
    
      private
    
      def g; end
      def h; end
    end
    

    みたいな書き方を推奨してゐると思ふ。メソッド名をリテラルで取らないといふ点で、この形式と private def .. end 形式とは同じである。 ↩︎