更新日: 2014年2月8日
Ruby

Ruby の Object#methods, Module#instance_methods, Object#singleton_methods でメソッドを取得

Rails やってて Ruby で親クラスを除いて、そのクラス自身で定義されたメソッドを取得したいことがあって調べました。基本、Object#methods, Module#instance_methods, Object#singleton_methods の3つで、methods, instance_methods には、各々アクセス制御の public_, protected_, private_ の接頭辞がついたメソッドがあります。

【お知らせ】英単語を画像イメージで楽に暗記できる辞書サイトを作りました。英語学習中の方は、ぜひご利用ください！

画像付き英語辞書 Imagict | 英単語をイメージで暗記
【開発記録】
英単語を画像イメージで暗記できる英語辞書サービスを作って公開しました

— 環境 —
ruby 2.0.0
rails 4.0.1
pry 0.9.12.6

サンプルクラス定義とインスタンス作成

以下のクラスを定義しインスタンス作成して、pry で実行して試しました。rails 環境の pry で試しましたので、rails 独自のクラス、メソッドも含まれてます。

class Myarr < Array
  def self.foo
    puts "foo"
  end

  def bar
    puts "bar"
  end

  def baz
    puts "baz"
  end
end

class Myarr < Array

def self.foo

puts "foo"

end

def bar

puts "bar"

end

def baz

puts "baz"

end

ここから pry。頭の行数は削除してます。


$ bundle exec rails c
pry(main)> class Myarr < Array
pry(main)*   def self.foo
pry(main)*     puts "foo"
pry(main)*   end
pry(main)*
pry(main)*   def bar
pry(main)*     puts "bar"
pry(main)*   end
pry(main)*
pry(main)*   def baz
pry(main)*     puts "baz"
pry(main)*   end
pry(main)* end
=> nil
pry(main)>
=> nil
pry(main)> myarr = Myarr.new
=> []
pry(main)> arr = Array.new
=> []

$ bundle exec rails c

pry(main)> class Myarr < Array

pry(main)* def self.foo

pry(main)* puts "foo"

pry(main)* end

pry(main)*

pry(main)* def bar

pry(main)* puts "bar"

pry(main)* end

pry(main)*

pry(main)* def baz

pry(main)* puts "baz"

pry(main)* end

=> nil

pry(main)>

=> nil

pry(main)> myarr = Myarr.new

=> []

pry(main)> arr = Array.new

=> []

各インスタンスのメソッド、メソッド数を確認


pry(main)> myarr.methods
=> [:bar,
 :baz,
 :inspect,
 :to_s,
 :to_a,
 :to_ary,
 ...
pry(main)> myarr.methods(false)
=> []
pry(main)> myarr.methods.size
=> 253
pry(main)> arr.methods.size
=> 251

pry(main)> myarr.methods

=> [:bar,

:baz,

:inspect,

:to_s,

:to_a,

:to_ary,

...

pry(main)> myarr.methods(false)

=> []

pry(main)> myarr.methods.size

=> 253

pry(main)> arr.methods.size

=> 251

Object#methods の引数が偽(false)の時は Object#singleton_methods(false) と同じになるそうです。myarr には特異メソッドを何も定義してないので、myarr.methods(false) は空の配列を返します。

myarr に対して呼び出せる Myarr で定義されたメソッドのみを取得

配列の引き算（減算）を用いて取得。


pry(main)> myarr.methods - arr.methods
=> [:bar, :baz]
 pry(main)> myarr.methods - myarr.class.superclass.new.methods
=> [:bar, :baz]
pry(main)> myarr.methods - myarr.class.superclass.instance_methods
=> [:bar, :baz]

pry(main)> myarr.methods - arr.methods

=> [:bar, :baz]

pry(main)> myarr.methods - myarr.class.superclass.new.methods

=> [:bar, :baz]

pry(main)> myarr.methods - myarr.class.superclass.instance_methods

=> [:bar, :baz]

myarr.methods で取得できるのは、あくまでも myarr に対して呼び出せるメソッドのみ。なので、myarr のクラスである Myarr クラスのクラスメソッド（Myarr.foo）は取得されません。myarr（Myarrクラスのインスタンス）に対して foo は呼び出せないため。

続いて、Module#instance_methods を用いて取得。


pry(main)> myarr.class.instance_methods
=> [:bar,
 :baz,
 :inspect,
 :to_s,
 :to_a,
 ...
pry(main)> myarr.class.instance_methods(false)
=> [:bar, :baz]
pry(main)> myarr.class.instance_methods.size
=> 253

pry(main)> myarr.class.instance_methods

=> [:bar,

:baz,

:inspect,

:to_s,

:to_a,

...

pry(main)> myarr.class.instance_methods(false)

=> [:bar, :baz]

pry(main)> myarr.class.instance_methods.size

=> 253

Module#instance_methods を使うと、定義したクラスのインスタンスメソッドを取得できます。引数で false を渡すと、親クラスのインスタンスメソッドを除きます。myarr.class はすなわち Myarr クラスのことなので以上の結果となる。

Myarr のクラスメソッドを取得

Classクラスのインスタンス（ここでは Myarr クラス）に対して、methods を呼び出す方法。


pry(main)> myarr.class.methods
=> [:foo,
 :[],
 :try_convert,
 :wrap,
 :yaml_tag,
 :allocate,
 :new,
 :superclass,
 ...
pry(main)> myarr.class.methods(false)
=> [:foo]

pry(main)> myarr.class.methods

=> [:foo,

:[],

:try_convert,

:wrap,

:yaml_tag,

:allocate,

:new,

:superclass,

...

pry(main)> myarr.class.methods(false)

=> [:foo]

また、クラスメソッドとはクラス（Classクラスのインスタンス: Myarr クラス）の特異メソッドであるので、Myarr クラスに対する singleton_methods で取得できる。


pry(main)> myarr.class.singleton_methods
=> [:foo, :[], :try_convert, :wrap, :yaml_tag]
pry(main)> myarr.class.singleton_methods(false)
=> [:foo]

pry(main)> myarr.class.singleton_methods

=> [:foo, :[], :try_convert, :wrap, :yaml_tag]

pry(main)> myarr.class.singleton_methods(false)

=> [:foo]

myarr.class.methods では、継承ツリーの途中のクラスで定義されている、Myarr クラスが反応できるメソッドが含まれるのに対し、myarr.class.singleton_methods では、親クラスと子クラスの特異メソッドのみが含まれています。


pry(main)> arr.class.singleton_methods
=> [:[], :try_convert, :wrap, :yaml_tag]

pry(main)> arr.class.singleton_methods

=> [:[], :try_convert, :wrap, :yaml_tag]

:[], :try_convert, :wrap, :yaml_tag らのメソッドは、Array クラスの特異メソッドだろうと予測したらその通りでした。

myarr に特異メソッドを定義


pry(main)> def myarr.hoge
pry(main)*   puts "hoge"
pry(main)* end
pry(main)> myarr.methods(false)
=> [:hoge]
pry(main)> myarr.singleton_methods(false)
=> [:hoge]