Share
Embed
Rails 1.0 のコードで学ぶ find_by* と method_missing の仕組み / Learn how find_by_* and method_missing work in Rails 1.0 code
maimu
March 01, 2025
Transcript
55 slides
-
準備 1. https://github.com/rails/rails をローカルにclone 2. $ cd rails 3. $
git checkout refs/tags/v1.0.0 -
準備 1. $ curl https://gist.githubusercontent.com/en30/d4fff101aec19c546da6b0b415c6cde6/ra w/26c845254a3649b84c101ea09b5a8277ec14cc16/gistfile1.txt | patch -p1 2.
$ cd activerecord 3. $ rake rdoc 4. $ open doc/ActiveRecord/Base.html -
例を見ながら find メソッドの使い方を確認 id name email active 1 Alice [email protected]
true 2 Bob [email protected] false 3 Carol [email protected] false -
name が Alice のレコードを1件取得したい場合 ⬇Rails 1.0 の時はこのように書いていた User.find(:first, :conditions =>
"name = ?", "Alice") # => #<User id: 1, name: "Alice", email: "[email protected]", active: true> ⬇今だと find_by で書くことができる User.find_by(name: "Alice") # => #<User id: 1, name: "Alice", email: "[email protected]", active: true> -
active が false の user を取得したい場合 ⬇Rails 1.0 の時はこのように書いていた User.find(:all,
:conditions => "active = ?", false) # => [#<User id: 2, name: "Bob", email: "[email protected]", active: false>, #<User id: 3, name: "Carol", email: "[email protected]", active: false>] ⬇今だと where で書くことができる User.where(active: false) # => [#<User id: 2, name: "Bob", email: "[email protected]", active: false>, #<User id: 3, name: "Carol", email: "[email protected]", active: false>] -
findメソッドまとめ • find メソッドの役割の範囲が今よりも広い • :first, id, :all, :conditionsなどの引数の指定が可能だった •
:conditions などで指定された条件に応じてSQLを組み立ててデータを検索して返し ていた ◦ Rails 1.0 の find メソッドの実装もおもしろいです!! -
Userの名前とメールアドレスを条件に検索したい場合 User.find(:first, [:conditions => “name = ? AND email
= ?” "Alice", "[email protected]"]) は以下のように書くことができる User.find_by_name_and_email("Alice", "[email protected]") # => #<User id: 1, name: "Alice", email: "[email protected]", active: true> User.find_by_name_and_email_and_acitve… のように属性名は and で繋いでいくことできるらしい -
def method_missing(method_id, *arguments) if match = /find_(all_by|by)_([_a-zA-Z]\w*)/.match(method_id.to_s) finder = determine_finder(match)
attribute_names = extract_attribute_names_from_match(match) super unless all_attributes_exists?(attribute_names) conditions = construct_conditions_from_arguments(attribute_names, arguments) if arguments[attribute_names.length].is_a?(Hash) find(finder, { :conditions => conditions }.update(arguments[attribute_names.length])) else send("find_#{finder}", conditions, *arguments[attribute_names.length..-1]) # deprecated API end # … end method_missing を探してみる activerecord/lib/active_record/base.rb:970 BasicObject#method_missingをオーバーライドしている!! -
method_missing の実装を見ていく def method_missing(method_id, *arguments) if match = /find_(all_by|by)_([_a-zA-Z]\w*)/.match(method_id.to_s) finder
= determine_finder(match) (all_by|by) で、find_all_by_ と find_by_ のどちらであるかを判定 ([_a-zA-Z]\w*) で、属性名(例:name、name_and_email)を取得 -
def determine_finder(match) match.captures.first == 'all_by' ? :all : :first end
method_missing の実装を見ていく activerecord/lib/active_record/base.rb:995 def method_missing(method_id, *arguments) if match = /find_(all_by|by)_([_a-zA-Z]\w*)/.match(method_id.to_s) finder = determine_finder(match) # … 変数 match をcaptures した最初の要素をチェックして :all または :firstを 返している -
def extract_attribute_names_from_match(match) match.captures.last.split('_and_') end method_missing の実装を見ていく activerecord/lib/active_record/base.rb:999 attribute_names =
extract_attribute_names_from_match(match) super unless all_attributes_exists?(attribute_names) 変数 match を captures した最後の要素に対して split で属性名の配列 (例:[“name”] や [“name”, “email”]) を返している 属性名が存在しない場合は super で通常の method_missing に処理を任せ ている -
method_missing の実装を見ていく activerecord/lib/active_record/base.rb:1003 conditions = construct_conditions_from_arguments(attribute_names, arguments) def construct_conditions_from_arguments(attribute_names,
arguments) conditions = [] attribute_names.each_with_index { |name, idx| conditions << "#{table_name}.#{connection.quote_column_name(name)} / # 本来は1行 #{attribute_condition(arguments[idx])} " } [ conditions.join(" AND "), *arguments[0...attribute_names.length] ] end find_by_name("Alice") の場合、 ["users.name = ?", "Alice"] となるように属性名と指 定された値を組み立てている -
method_missing の実装を見ていく activerecord/lib/active_record/base.rb:979 if arguments[attribute_names.length].is_a?(Hash) find(finder, { :conditions =>
conditions }. # 本来は1行 update(arguments[attribute_names.length])) else # deprecated API send("find_#{finder}", conditions, *arguments[attribute_names.length..-1]) end 引数の最後に :order や :limit などのオプションが存在する場合は :conditions のハッシュ にマージして組み立てた条件を find メソッドに渡している else の場合は deperecated API とコメントされているが、ここでは send で find_first を実 行している -
find_first 定義箇所を見てみる activerecord/lib/active_record/deprecated_finders.rb:21 module ActiveRecord class Base class <<
self # … def find_first(conditions = nil, orderings = nil, joins = nil) # :nodoc: find(:first, :conditions => conditions, :order => orderings, :joins => joins) end # … end end method_missing の send() はここを呼び出している さらに古いRailsのバージョンで使われていたらしい? -
method_missing の実装を見ていく activerecord/lib/active_record/base.rb:979 if arguments[attribute_names.length].is_a?(Hash) find(finder, { :conditions =>
conditions }. # 本来は1行 update(arguments[attribute_names.length])) else # deprecated API send("find_#{finder}", conditions, *arguments[attribute_names.length..-1]) end スライド上で例に使用したサンプルコードでは else 節が実行されてsend が find_first を呼び出して最終的に find メソッドが実行される deprecated API となっているのは互換性を維持するためだろうと推測 -
find_by_* とmethod_missing まとめ • find メソッドに:first, :all, options などを指定する代わりに使用する •
find_by_* はメソッドとして個別に定義されているわけではなく method_missing を オーバーライドして動的に実現されている • method_missing の処理としては最終的に find メソッドが実行される ◦ 条件分岐で偽の場合は send メソッド で find_first メソッドを経由していた -
Rails 8.0 の find_by_* の実装箇所 activerecord/lib/active_record/dynamic_matchers.rb module ActiveRecord module
DynamicMatchers # :nodoc: private def respond_to_missing?(name, _) if self == Base super else match = Method.match(self, name) match && match.valid? || super end end def method_missing module として切り出されていて、 内容も Rails 1.0 の頃とはかなり違う!