Rails SourceCode Reading #1

ActiveRecord

app/models/page.rb を見てみると...

# app/models/page.rb
class Page < ActiveRecord::Base
end

activerecord の lib 以下を見てみるが、(当然) title らしきメソッドはみつからない。

ところが、lib/activerecord/base.rb を下の方まで見ていくと...

# lib/activerecord/base.rb
....
include ActiveRecord::Persistence
extend ActiveModel::Naming
extend QueryCache::ClassMethods
extend ActiveSupport::Benchmarkable
....

てなかんじの 大量の include と extend が!!

includeをしらみつぶしにみていくと

include AttributeMethods

があやしい。。。

さて、lib/activerecord/attribute_methods.rb を見てみると、138行目に method_missing が定義されています。

# module ActiveRecord::AttributeMethods
def method_missing(method, *args, &block)
  unless self.class.attribute_methods_generated?
    self.class.define_attribute_methods

    if respond_to_without_attributes?(method)
      send(method, *args, &block)
    else
      super
    end
  else
    super
  end
end

self.class.define_attributes_methodsに注目。

この場合、AttributeMethod を include しているのは ActiveRecord::Base。

したがって、self は ActiveRecord (の派生クラス) のインスタンス。

self.class は ActiveRecord (の派生クラス) 自身。

したがって、self.class.define_attributes_method はActiveRecord (の派生クラス) の特異メソッド。

define_attributes_method を探していくと

同じファイル(lib/activerecord/attribute_methods.rb) の38行目に発見。

ActiveRecord::AttributeMethods::ClassMethods#define_attributes_method

ところが、define_attributes_method はサブモジュール ClassMethod のメソッドなので、直接はインクルードされないはず...

と思ってたら、こんなページを発見: http://d.hatena.ne.jp/kitokitoki/20110301/p1

というわけで、ActiveRecord::AttributeMethods::ClassMethods
#define_attributes_method の定義を見ていく。

大事なのはこの辺:

    @attribute_methods_mutex.synchronize do
      return if attribute_methods_generated?
      superclass.define_attribute_methods unless self == base_class
      super(column_names)
      @attribute_methods_generated = true
    end

まずは、base_classの定義を探してみる。

# base.rb:696
    include Inheritance

# inheritance.rb:42
# ActiveRecord::Inheritance::ClassMethods
  def base_class
    class_of_active_record_descendant(self)
  end

# inheritance.rb:86
  def class_of_active_record_descendant(klass)
    if klass == Base || klass.superclass == Base || klass.superclass.abstract_class?
      klass
    elsif klass.superclass.nil?
      raise ActiveRecordError, "#{name} doesn't belong in a hierarchy descending from ActiveRecord"
    else
      class_of_active_record_descendant(klass.superclass)
    end
  end

もう1度 attribute_methods.rb を見ていくと

module ClassMethods
  def define_attribute_methods

のちょっと前にこんな記述が...

include ActiveModel::AttributeMethods

ActiveModel のソースをとってきて中を見てみると、

activemodel-3.2.3/lib/active_model/attribute_methods.rb の255行目に define_attribute_methods の定義発見。

# ActiveRecord::AttributeMethods::ClassMethods#define_attributes_method
  def define_attribute_methods(attr_names)
    attr_names.each { |attr_name| define_attribute_method(attr_name) }
  end

  def define_attribute_method(attr_name)
    attribute_method_matchers.each do |matcher|
      method_name = matcher.method_name(attr_name)
      unless instance_method_already_implemented?(method_name)
        generate_method = "define_method_#{matcher.method_missing_target}"

        if respond_to?(generate_method, true)
          send(generate_method, attr_name)
        else
          define_optimized_call generated_attribute_methods, method_name, matcher.method_missing_target, attr_name.to_s
        end
      end
    end
    attribute_method_matchers_cache.clear
  end

以下、素直に追っていくと、ActiveRecord::MethodAttributes の定義内の

included do
  include Read
  include Write
  include Query
  include TimeZoneConversion

が肝であることがわかる。

例えば、lib/activerecord/method_attributes/read.rb を見てみると、

      def define_method_attribute(attr_name)
        cast_code = attribute_cast_code(attr_name)

        generated_attribute_methods.module_eval <<-STR, __FILE__, __LINE__ + 1
          def __temp__
            #{internal_attribute_access_code(attr_name, cast_code)}
          end
          alias_method '#{attr_name}', :__temp__
          undef_method :__temp__
        STR

        generated_external_attribute_methods.module_eval <<-STR, __FILE__, __LINE__ + 1
          def __temp__(v, attributes, attributes_cache, attr_name)
            #{external_attribute_access_code(attr_name, cast_code)}
          end
          alias_method '#{attr_name}', :__temp__
          undef_method :__temp__
        STR
      end

attribute_cast_code は 「attr_name に相当するデータベースのコラムからデータをとりだし、適当な型に変換するためのコード」を返す。

    case type
    when :string, :text        then var_name
    when :integer              then "(#{var_name}.to_i rescue #{var_name} ? 1 : 0)"
    when :float                then "#{var_name}.to_f"
    ....

generated_attribute_methods はモジュールオブジェクト。このモジュールの中に、各attributeにアクセスするためのメソッドを定義する

# activemodel/lib/active-model/attribute_methods.rb:285
  def generated_attribute_methods #:nodoc:
    @generated_attribute_methods ||= begin
      mod = Module.new
      include mod
      mod
    end
  end

即座に include されているので、このモジュールの中に定義されたメソッドも普通のメソッドと同様にアクセスできる。

internal_attribute_access_code は実際に定義しようとしているメソッドの中身を記述するコードを返しす。

activerecord/lib/active_record/attribute_methods/read.rb:94 で定義されています。

例えば次のような文字列を返します。

attr_name = '#{attr_name}';
@attributes_cache[attr_name] ||=
  ((v=@attributes[attr_name]) && (v.to_i rescue #{var_name} ? 1 : 0)

generated_external_attribute_methods は generated_attribute_methods と同様、モジュールです。

しかし、generated_external_attribute_methods はパブリックメッソドとして定義されており、ActiveRecord内から使われることはありません。

というわけで、自分で定義してないメソッドが呼べるのは module_eval のおかげでした!!

method_missing を利用して、そのメソッドが初めて呼ばれたタイミングで定義しているというわけでした。