Module

モジュールのクラス。

メソッド:

self <=> other

self と other を比較して、 self が other の子孫であるとき -1、同一のクラス／モジュールのとき 0、 self が other の先祖であるとき 1 を返します。

親子関係にないクラス同士の比較ではその動作は不定です。 ^*1

other がクラスやモジュールでなければ例外 TypeError が発生します。 ^*2

module Foo
end
class Bar
  include Foo
end
class Baz < Bar
end
class Qux
end
p Bar <=> Foo     # => -1
p Baz <=> Bar     # => -1
p Baz <=> Foo     # => -1
p Baz <=> Qux     # => 1   (version 1.7 では nil, 1.8 では -1)
p Qux <=> Baz     # => 1   (version 1.7 では nil, 1.8 では -1)

p Baz <=> Object.new  # => :in `<=>': <=> requires Class or Module (Object given) (TypeError)
                      # (version 1.8 では nil)

self < other

self <= other

self > other

self >= other

比較演算子。self が other の子孫である時、 self < other が成立します。

親子関係にないクラス同士の比較ではいずれの関係も false を返します。 ^*3

other がクラスやモジュールでなければ例外 TypeError が発生します。

module Foo
end
class Bar
  include Foo
end
class Baz < Bar
end
class Qux
end
p Bar < Foo     # => true
p Baz < Bar     # => true
p Baz < Foo     # => true
p Baz < Qux     # => false (version 1.8 では nil)
p Baz > Qux     # => false (version 1.8 では nil)

p Foo < Object.new # => in `<': compared with non class/module (TypeError)

self === obj

このメソッドは主に case 文での比較に用いられます。 obj が self と Object#kind_of? の関係がある時、真になります。つまり、case ではクラス、モジュールの所属関係をチェックすることになります。

str = String.new
case str
when String     # String === str を評価する
  p true        # => true
end

ancestors

クラス、モジュールのスーパークラスとインクルードしているモジュールを優先順位順に配列に格納して返します。

module Foo
end
class Bar
  include Foo
end
class Baz < Bar
  p ancestors
  p included_modules
  p superclass
end
# => [Baz, Bar, Foo, Object, Kernel]
# => [Foo, Kernel]
# => Bar

autoload(const_name, feature)

autoload?(const_name)

ruby 1.8 feature

autoload を参照。

class_eval(src[,fname[,lineno]])

class_eval { ... }

Module#module_eval の別名。

class_variables

クラス／モジュールに定義されているクラス変数名の配列を返します。スーパークラスやインクルードしているモジュールのクラス変数も含みます。

local_variables, global_variables, Object#instance_variables, Module.constants, Module#constants も参照してください。

const_defined?(name)

モジュールに name で指定される名前の定数が定義されている時真を返します。name は Symbol か文字列で指定します。

スーパークラスやインクルードしたモジュールで定義された定数は対象にはなりません。(ただし、Object だけは例外 ^*4)

module Kernel
  FOO = 1
end

# Object は include したモジュールの定数に対しても
# true を返す
p Object.const_defined?(:FOO)   # => true

module Bar
  BAR = 1
end
class Object
  include Bar
end
# ユーザ定義のモジュールに対しても同様
p Object.const_defined?(:BAR)   # => true

class Baz
  include Bar
end
# Object以外では自身の定数だけがチェック対象
p Baz.const_defined?(:BAR)      # => false

const_get(name)

モジュールに定義されている name で指定される名前の定数の値を取り出します。定数が定義されていない時には例外 NameError が発生します。 name は Symbol か文字列で指定します。

const_missing(name) ((<ruby 1.8 feature>))

定義されていない定数を参照したときに Ruby がこのメソッドを呼びます。参照した定数名の Symbol が引数に渡されます。

デフォルトではこのメソッドは例外 NameError を発生させます。

class Foo
  def Foo.const_missing(id)
    warn "undefined constant #{id.inspect}"
  end

  Bar
end
Foo::Bar

# => undefined constant :Bar
     undefined constant :Bar

const_set(name, value)

モジュールに name で指定された名前の定数を value という値として定義し、value を返します。そのモジュールにおいてすでにその名前の定数が定義されている場合、警告メッセージが出力されます。name は Symbol か文字列で指定します。

constants

そのモジュール(またはクラス)で定義されている定数名の配列を返します。スーパークラスやインクルードしているモジュールの定数も含みます。

Module.constants や local_variables, global_variables, Object#instance_variables, Module#class_variables も参照してください。

例: Module.constnats と Module#constnats の違い

# 出力の簡略化のため起動時の定数一覧を取得して後で差し引く
$clist = Module.constants

class Foo
  FOO = 1
end
class Bar
  BAR = 1

  # Bar は BAR を含む
  p constants - $clist                # => ["BAR"]
  # 出力に FOO は含まれない
  p Module.constants - $clist         # => ["BAR", "Bar", "Foo"]
  class Baz
    # Baz は定数を含まない
    p constants - $clist              # => []

    # ネストしたクラスでは、外側のクラスで定義した定数は
    # 参照可能なので、BAR は、Module.constants には含まれる
    # (クラス Baz も Bar の定数なので同様)
    p Module.constants - $clist       # => ["BAR", "Baz", "Bar", "Foo"]
  end
end

include?(mod) ((<ruby 1.7 feature>))

self がモジュール mod をインクルードしていれば真を返します。

Foo = Module.new
class Bar
  include Foo
end
class Baz < Bar
end

p Bar.include? Foo #=> true
p Baz.include? Foo #=> true

included_modules

インクルードされているモジュールの配列を返します。 Module#ancestors の例も参照してください

instance_method(name)

self のインスタンスメソッドをオブジェクト化した UnboundMethod を返します。name は Symbol か文字列です。

Object#method も参照してください。

method_defined?(name)

モジュールにインスタンスメソッド name が定義されているとき真を返します。name は Symbol か文字列です。

Module#public_method_defined?, Module#private_method_defined?, Module#protected_method_defined? も参照してください。

module_eval(expr, [fname, [lineno=1]])

module_eval {|mod| .... }

モジュールのコンテキストで文字列 expr を評価してその結果を返します。 fname、lineno が与えられた場合は、ファイル fname、行番号 lineno にその文字列があるかのようにコンパイルされ、スタックトレース表示などのファイル名／行番号を差し替えることができます。

ブロックが与えられた場合にはそのブロックをモジュールのコンテキストで評価してその結果を返します。ブロックの引数 mod には self が渡されます。

モジュールのコンテキストで評価するとは、実行中そのモジュールが self になるということです。つまり、そのモジュールの定義文の中にあるかのように実行されます。

ただし、ローカル変数は module_eval の外側のスコープと共有します。ruby 1.6 feature: version 1.6.8 以降でブロックが与えられた場合は、定数とクラス変数のスコープも外側のスコープになります。

注: module_eval のブロック中でメソッドを定義する場合、 instance_eval と同様の制限があります。詳細はそちらの説明を参照してください。

Object#instance_eval, Module#class_eval Module.new も参照してください。

name

to_s

クラス、モジュールの名前を返します。名前のないクラス、モジュールについては空文字列を返します(Module.new の例を参照)。

クラス、モジュールがネストしている場合は、親クラス、親モジュールも合わせて表示されます^*5。

module A
  module B
  end
  p B.name  #=> "A::B"

  class C
  end
end
p A.name    #=> "A"
p A::B.name #=> "A::B"
p A::C.name #=> "A::C"

instance_methods([inherited_too])

public_instance_methods([inherited_too])

private_instance_methods([inherited_too])

protected_instance_methods([inherited_too])

そのモジュールで定義されている public/private/protected メソッド名の一覧を配列で返します。

instance_methods は、public_instance_methods と同じです。 ruby 1.7 feature: instance_methods は、public および protected メソッド名の一覧を配列で返します。

inherited_too が真であれば、スーパークラスのメソッドも探索します。デフォルトは偽です。 (ruby 1.8 feature: 引数のデフォルトは真に変わる予定です。引数を省略すると警告が出るので、変更までは引数を明示することが望まれます)

Object#methods, Object#public_methods, Object#private_methods, Object#protected_methods も参照してください。

例:

class Foo
  private;   def private_foo()   end
  protected; def protected_foo() end
  public;    def public_foo()    end
end

# あるクラスのインスタンスメソッドの一覧を得る
puts "例1:"
p Foo.instance_methods(false)
p Foo.public_instance_methods(false)
p Foo.private_instance_methods(false)
p Foo.protected_instance_methods(false)

class Bar < Foo
end

# あるクラスのインスタンスメソッドの一覧を得る。
# 親のクラスのインスタンスメソッドも含めるため true を指定して
# いるが、Object のインスタンスメソッドは一覧から排除している。

puts "例2:"
p Bar.instance_methods(true)           - Object.instance_methods(true)
p Bar.public_instance_methods(true)    - Object.public_instance_methods(true)
p Bar.private_instance_methods(true)   - Object.private_instance_methods(true)
p Bar.protected_instance_methods(true) - Object.protected_instance_methods(true)

=> 例1:
   ["public_foo"]    # version 1.7 以降、["protected_foo", "public_foo"]
   ["public_foo"]
   ["private_foo"]
   ["protected_foo"]
   例2:
   ["protected_foo"] # version 1.7 以降、["protected_foo", "public_foo"]
   ["public_foo"]
   ["private_foo"]
   ["protected_foo"]

private_class_method(name, ... )

public_class_method(name, ... )

name で指定したクラスメソッド(クラスの特異メソッド) の可視性を変更します。

self を返します。

private_method_defined?(name)

protected_method_defined?(name)

public_method_defined?(name)

ruby 1.7 feature

それぞれ、private, protected, public であるインスタンスメソッド name がモジュールに定義されているとき真を返します。name は Symbol か文字列です。

Module#method_defined? も参照してください。

^*1ruby 1.7 feature: version 1.7 では nil を返します
^*2ruby 1.8 feature: version 1.8 ではnil を返します
^*3ruby 1.8 feature: version 1.8 では nil を返します
^*4あらい 2002-04-10: バグ?制限?
^*5 これは昔から?
^*6あらい 2002-03-03: ruby 1.7 feature では、include を実行する順序が変わったので each の代わりに reverse_each を使う
^*7あらい 2002-03-16: ruby 1.7 feature では、extend を実行する順序が変わったので each の代わりに reverse_each を使う

Module

スーパークラス:

クラスメソッド:

メソッド:

プライベートメソッド: