はじめてのRailsの ソースコードリーディング

2025/4/26 RUNTEQ.rb

Transcript

1. はじめてのRails の ソースコードリーディング RUNTEQ.rb 2025-04-26 なかじ @nakayama__bird 1 / 85
2. 自己紹介 なかじ @nakayama__bird なかじ/ バード 2020/04-2024/03 公務員 2024/01-2024/10 RUNTEQ(53 期) 2024/12- エンジニア 先週RubyKaigi に初参加した テックブログ： https://tech.findy.co.jp/entry/2025/ 04/23/080000 2 / 85
3. アジェンダ 1. はじめに 2. Active Support core_ext について 3. Ruby について 4. empty?/present?/blank? からジャンル分け 5. ソースコードを読んでいく 6. パフォーマンス観点の再定義とその問題点 3 / 85
4. 1. はじめに 4 / 85
5. 今日のゴール・やること empty?/blank?/present? の違いが少しわかるようになる いずれのメソッドもオブジェクトが「空」かどうかを判定するために使われる 「空」かどうかの判定の仕方が異なる この答えのヒントを探すべくソースコード含めいろいろ深ぼっていこう 5 / 85
6. Rails のソースコードって どこで見れば良い？ 6 / 85
7. 皆さんが今アプリ開発やカリキュラムで 使っているRails のバージョンは？ 7 / 85
8. 皆さんが今アプリ開発やカリキュラムで使っている Rails のバージョンは？ Rails7.0 からRails8.0 あたりを使っている人が多そう 8 / 85
9. バージョンと聞かれてディレクトリの どのあたり見にいきましたか？ 9 / 85
10. バージョンと聞かれて見に行った場所 Gemfile やGemfile.lock のあたりを見た人が多そう？ 10 / 85
11. バージョンと聞かれて見に行った場所 # Gemfile # Bundle edge Rails instead: gem "rails", github: "rails/rails", branch: "main" gem "rails", "~> 7.1.3", ">= 7.1.3.4" #... gem 'sorcery' gem rails … ！ ファイル全体を見ると、カリキュラムで苦しんだsorcery と同じ並びにあるぞ… ！ 11 / 85
12. Rails はRuby のgem の一つに過ぎない 12 / 85
13. Gem ってなんだっけ？ 多くのプログラミング言語と同様に、Ruby にも幅広いサードパーティのライブラ リが提供されています。それらのほとんどは “gem” という形式で公開されていま す https://www.ruby-lang.org/ja/libraries/ “ “ 13 / 85
14. 【参考】bundler での管理 パッケージ管理にbundler を使っている（バージョン、依存関係など） Bundler provides a consistent environment for Ruby projects by tracking and installing the exact gems and versions that are needed.Bundler is an exit from dependency hell, and ensures that the gems you need are present in development, staging, and production. Starting work on a project is as simple as bundle install https://bundler.io/ “ “ 14 / 85
15. ホスティングサービスRubyGems.org で探す rails で検索してみる https://rubygems.org/search?query=rails 15 / 85
16. Rails のソースコード発見 https://github.com/rails/rails 16 / 85
17. 【Tips 】bundle open <gem 名> 1. $ which code で /usr/local/bin/code が返ってくることを確認 2. ↑が返ってこない場合はcode コマンドが使えるようにVScode で設定 https://code.visualstudio.com/docs/setup/mac#_launch-vs-code-from-the- command-line 17 / 85
18. 【Tips 】bundle open <gem 名> 3. $ vi ~/.zshrc で export BUNDLER_EDITOR="code --wait" を追加 4. パスを通す source ~/.zshrc 参考：https://scrapbox.io/nakayamabird/bundle_open_gem でgem のファイルを VScode 確認できるようにする 18 / 85
19. 2.Active Support core_ext について 19 / 85
20. Active Support core_ext の概要 activesupport/lib/active_support/core_ext core_ext = コア拡張機能（Core Extensions ） Rails でRuby を便利に使うための拡張機能が用意されているクラス群 20 / 85
21. Active Support core_ext のメソッド① blank? メソッド そのオブジェクトが空ならtrue, 空でないならfalse を返すメソッド # rails console irb(main):001> ['a','b','c'].blank? => false irb(main):001> [].blank? => true Rails 基礎まで進んでいる方だと確実に目にしているメソッド ちなみにRails 入門でも使っている箇所あった 業務内で触るコードでも見かけることが多い 21 / 85
22. Active Support core_ext のメソッド② present? メソッド present? メソッド： blank? メソッドの逆（否定） # rails console irb(main):001> ['a','b','c'].present? => true irb(main):001> [].present? => false # rails console(blank?) irb(main):001> ['a','b','c'].blank? => false irb(main):001> [].blank? => true 22 / 85
23. 【参考】? のついたメソッド 慣習的に、問い合わせ系のメソッドの最後には疑問符が使われます ( 例: レシーバ が空の場合にtrue を返すArray#empty?) 。 https://www.ruby-lang.org/ja/documentation/ruby-from-other-languages/ “ “ 23 / 85
24. 【参考】? のついたメソッド The names of predicate methods (methods that return a boolean value) should end in a question mark (i.e. Array#empty?). Methods that don’t return a boolean, shouldn’t end in a question mark. https://rubystyle.guide/#bool-methods-qmark “ “ 24 / 85
25. Active Support core_ext の中身 ここのディレクトリ内にあるの Integer String などのRuby でよ くみるな 25 / 85
26. 3.Ruby について 26 / 85
27. おさえるポイント 1. クラスとは何か？ 2. 継承とは何か？ 27 / 85
28. 1. クラスとは何か？ クラスは自身に所属するオブジェクトが反応できるメソッドを決定します。所属 するオブジェクトに対してあるメソッドを呼び出すことができるなら、そのメソ ッドが「クラスに定義されている」と言います https://docs.ruby-lang.org/ja/latest/doc/spec=2fobject.html “ “ 28 / 85
29. irb で試してみる これの結果は何になる？ # irb irb(main):001> 4.class irb(main):001> 'hoge'.class 29 / 85
30. 4 はInteger 、'hoge' はString # irb irb(main):001> 4.class => Integer 4 はInteger （整数）クラスのオブジェクト =>class Integer にあるメソッドが使える！ # irb irb(main):001> 'hoge'.class => String 'hoge' はString （文字列）クラスのオブジェクト =>class String にあるメソッドが使える！ 30 / 85
31. メソッドを使ってみる 偶数か判定する even? メソッド # irb irb(main):001 > 4.even? => true 4 がInteger クラスのオブジェクトだ から使える 4 が偶数である https://docs.ruby- lang.org/ja/latest/class/Integer.html 31 / 85
32. even? メソッドが使えないパターン 偶数か判定する even? メソッド # irb irb(main):001> 'hoge'.class => String irb(main):001> 'hoge'.even? (irb):12:in '<main>': undefined method 'even?' for an instance of String (NoMethodError) 32 / 85
33. 偶数か偶数じゃないかメソッド # irb irb(main):001* class Integer irb(main):002* def even_or_not_even? irb(main):003* if self % 2 == 0 || self % 2 == 1 irb(main):004* true irb(main):005* else irb(main):006* false irb(main):007* end irb(main):008* end irb(main):009> end => :even_or_not_even? irb(main):010> 5.even_or_not_even? => true 整数クラスのメソッドなので実態は全てtrue が返る 33 / 85
34. 2. 継承とは何か？ Ruby の標準ライブラリはObject クラスを継承している 継承元のメソッドを使用することができる 34 / 85
35. Object クラスにあるメソッド object_id メソッド # irb irb(main):001> 4.class => Integer irb(main):001> 4.object_id => 9 irb(main):001> 'hoge'.class => String irb(main):001> 'hoge'.object_id => 50920 各オブジェクトに対して一意な整数を返します。 https://docs.ruby-lang.org/ja/latest/method/Object/i/object_id.html “ “ 35 / 85
36. 4. empty?/present?/blank? 36 / 85
37. empty?/present?/blank? 今回見ていく、core_ext の present? ・ blank? メソッドはオブジェクトが空か どうか判定するためのメソッド 似たようなメソッドに empty? がある Rails における nil?, empty?, blank?, present? の使い分けとBetter Practice ポイント empty? :Ruby で定義 blank? , present? : Rails のActive Support core_ext で定義 37 / 85
38. empty?/present?/blank? の違い レシーバ empty? blank? present? nil NoMethodError true false true NoMethodError false true false NoMethodError true false [] true true false {} true true false "" true true false " " false true false 38 / 85
39. 1.nil/true/false レシーバ empty? blank? present? nil NoMethodError true false true NoMethodError false true false NoMethodError true false [] true true false {} true true false "" true true false " " false true false 39 / 85
40. 2. 空白文字列 レシーバ empty? blank? present? nil NoMethodError true false true NoMethodError false true false NoMethodError true false [] true true false {} true true false "" true true false " " false true false 40 / 85
41. 3. 同じ感じの箇所 レシーバ empty? blank? present? nil NoMethodError true false true NoMethodError false true false NoMethodError true false [] true true false {} true true false "" true true false " " false true false 41 / 85
42. 5. ソースコードを読んでいく 42 / 85
43. 実際見ていくファイル https://github.com/rails/rails/blob/main/activesupport/lib/active_support/core_ext/ object/blank.rb 43 / 85
44. 5. ソースコードを読んでいく 1.nil/true/false 2. 空白文字列 3. 同じ感じの箇所 4. 同じ感じの箇所（Object クラス編） 44 / 85
45. 前提 nil はNilClass の唯一のオブジェクト =>NilClass にあるメソッドが使える false はFalseClass の唯一のオブジェクト =>FalseClass にあるメソッドが使える true はTrueClass の唯一のオブジェクト =>TrueClass にあるメソッドが使える 45 / 85
46. NilClass # activesupport/lib/active_support/core_ext/object/blank.rb class NilClass # +nil+ is blank: # # nil.blank? # => true # # @return [true] def blank? true end def present? # :nodoc: false end end 46 / 85
47. FalseClass # activesupport/lib/active_support/core_ext/object/blank.rb class FalseClass # +false+ is blank: # # false.blank? # => true # # @return [true] def blank? true end def present? # :nodoc: false end end 47 / 85
48. blank def blank? true end ひたすらtrue がかえる irb(main):001> nil.blank? => true irb(main):001> false.blank? => true 48 / 85
49. present? def present? false end ひたすらfalse がかえる # rails console irb(main):007> false.present? => false irb(main):008> nil.present? => false 49 / 85
50. TrueClass # activesupport/lib/active_support/core_ext/object/blank.rb class TrueClass # +true+ is not blank: # # true.blank? # => false # # @return [false] def blank? false end def present? # :nodoc: true end end nil/false と逆の動きをする 50 / 85
51. 読めたぞ！！ でもなぜこのメソッドはあるのでしょう 51 / 85
52. irb でempty? メソッド irb(main):001> nil.empty? (irb):2:in `<main>': undefined method `empty?' for nil (NoMethodError) irb(main):001> false.empty? (irb):3:in `<main>': undefined method `empty?' for false (NoMethodError) irb(main):001> true.empty? (irb):4:in `<main>': undefined method `empty?' for true (NoMethodError) 52 / 85
53. empty? とblank? ・present? メソッド TrueClass,FalseClass,NilClass にはempty? メソッドがないため追加でいい感じに定 義している empty? メソッドだとエラーになるところ、blank? ・present? メソッドだとboolean で返りエラーにならない レシーバ empty? blank? present? nil NoMethodError true false true NoMethodError false true false NoMethodError true false 53 / 85
54. 上司にもらったコメント アプリケーション開発でnil にならないと思ってたが、意図せずnil が入り込んだ時 にエラーにならないのは良さそう これなのですが、場合によってはNoMethodError になる方が良いという考え方も できます Ruby は型がないこともあり、全然想定していない値が入っていてもよしなに動い ちゃうところが多いです。なので、厳しめに書いておいて想定外の値がきたら例 外発生する方が安全なことが多かったりしますねー “ “ 54 / 85
55. 5. ソースコードを読んでいく 1.nil/true/false 2. 空白文字列 3. 同じ感じの箇所 4. 同じ感じの箇所（Object クラス編） 55 / 85
56. 空文字列と空白文字列 空文字列: 長さが0 の文字列 空白文字列：文字列の中にスペースやタブ、改行などの空白だけが含まれている状 態の文字列 # irb irb(main):001> "".size # スペースなし=>空文字列 => 0 irb(main):001> " ".size # スペースあり=>空白文字列 => 1 56 / 85
57. empty メソッド empty メソッドでは空白文字列はfalse になる # rails console irb(main):001> " ".empty? => false blank? メソッドでは空白文字列はtrue になる # rails console irb(main):001> " ".blank? => true 57 / 85
58. String クラスのblank? メソッド # activesupport/lib/active_support/core_ext/object/blank.rb class String BLANK_RE = /\A[[:space:]]*\z/ ENCODED_BLANKS = Concurrent::Map.new do |h, enc| h[enc] = Regexp.new(BLANK_RE.source.encode(enc), BLANK_RE.options | Regexp::FIXEDENCODING) end # A string is blank if it's empty or contains whitespaces only: # # ''.blank? # => true # ' '.blank? # => true # "\t\n\r".blank? # => true # ' blah '.blank? # => false # # Unicode whitespace is supported: # # "\u00a0".blank? # => true # # @return [true, false] def blank? # The regexp that matches blank strings is expensive. For the case of empty # strings we can speed up this method (~3.5x) with an empty? call. The # penalty for the rest of strings is marginal. empty? || begin BLANK_RE.match?(self) rescue Encoding::CompatibilityError ENCODED_BLANKS[self.encoding].match?(self) end end def present? # :nodoc: !blank? end end 58 / 85
59. 一部抜粋 # activesupport/lib/active_support/core_ext/object/blank.rb class String BLANK_RE = /\A[[:space:]]*\z/ # 文字列が空白文字列のみで構成されているかどうかの正規表現 def blank? empty? || # empty?メソッドを呼び出し空文字列判定を行う # "".empty? => true # " ".empty? => false # =>ここでfalseなら以下の処理 begin BLANK_RE.match?(self) # どうやらここで空白文字列判定をしていそう rescue Encoding::CompatibilityError ENCODED_BLANKS[self.encoding].match?(self) end end end 59 / 85
60. 手元で動かす # irb/rails console irb(main):001> BLANK_RE = /\A[[:space:]]*\z/ => /\A[[:space:]]*\z/ irb(main):001> karamojiretsu = ' ' => " " irb(main):001> BLANK_RE.match?(karamojiretsu) => true 正規表現を利用して空白文字列の判定をしている 60 / 85
61. 5. ソースコードを読んでいく 1.nil/true/false 2. 空白文字列 3. 同じ感じの箇所（エイリアスメソッド編） 4. 同じ感じの箇所（Object クラス編） 61 / 85
62. Array クラス # activesupport/lib/active_support/core_ext/object/blank.rb class Array # An array is blank if it's empty: # # [].blank? # => true # [1,2,3].blank? # => false # # @return [true, false] alias_method :blank?, :empty? def present? # :nodoc: !empty? end end 62 / 85
63. Array のempty メソッド Ruby にあるArray クラスのempty メソッドを見ていく # irb/rails console irb(main):001> [].empty? => true irb(main):001> [ ].empty? => true irb(main):001> ['らんてくん', 'ロボらんてくん'].empty? => false 自身の要素の数が 0 の時に真を返します。そうでない場合に false を返します。 https://docs.ruby-lang.org/ja/latest/method/Array/i/empty=3f.html “ “ 63 / 85
64. alias_method とは？ # irb irb(main):001* module Kernel irb(main):002* alias_method :foo, :puts irb(main):003> end irb(main):004> foo "bar" bar => nil irb(main):005> method(:foo) => #<Method: Object(Kernel)#foo(puts)(*)> foo という名前のメソッドは puts と同じ メソッドの別名を定義します。 https://docs.ruby-lang.org/ja/latest/method/Module/i/alias_method.html “ “ 64 / 85
65. alias_method とは？ # rails console irb(main):001> array = [] => [] irb(main):002> array.method(:blank?) => #<Method: Array#blank?(empty?)()> Array クラスの blank? メソッドはArray クラスの empty? メソッドと同じ class Hash と class Symbol も同じでエイリアスメソッドとして定義されてい る 65 / 85
66. 5. ソースコードを読んでいく 1.nil/true/false 2. 空白文字列 3. 同じ感じの箇所（エイリアスメソッド編） 4. 同じ感じの箇所（Object クラス編） 66 / 85
67. Object クラスにblank? メソッドがある # activesupport/lib/active_support/core_ext/object/blank.rb class Object def blank? respond_to?(:empty?) ? !!empty? : false end # An object is present if it's not blank. # # @return [true, false] def present? !blank? end end このクラスのメソッドは基本的にどこのクラスからも呼び出せる 67 / 85
68. Object クラスのblank? メソッド def blank? respond_to?(:empty?) ? !!empty? : false end 三項演算子になっている respond_to?(:empty?) がtrue なら !!empty? が評価される respond_to?(:empty?) がfalse なら false が返る 68 / 85
69. respond_to? メソッド Ruby のObject クラスのメソッド # irb irb(main):001> 4.respond_to?(:even?) => true irb(main):001> 'hoge'.respond_to?(:even?) => false オブジェクトがメソッド name を持つとき真を返します。オブジェクトが メソッ ド name を持つというのは、オブジェクトが メソッド name に応答できることを いいます。 https://docs.ruby-lang.org/ja/latest/method/Object/i/respond_to=3f.html “ “ 69 / 85
70. !!empty? 確実に真偽値を返す irb(main):001> !!"hello" => true irb(main):001> !!nil => false irb(main):001> !!0 => true 70 / 85
71. Array クラスのメソッド # activesupport/lib/active_support/core_ext/object/blank.rb class Array # An array is blank if it's empty: # # [].blank? # => true # [1,2,3].blank? # => false # # @return [true, false] alias_method :blank?, :empty? #... end empty? メソッドを呼び出している 71 / 85
72. Object クラスのメソッド Array クラスはObject クラスを継承している class Object def blank? respond_to?(:empty?) ? !!empty? : false end # ... end Array クラスには empty? メソッドがある そのため結局のところempty? メソッドを呼び出している 72 / 85
73. どちらも使える Array クラスのオブジェクトに対して呼び出せるblank? メソッド Object クラスのblank? メソッド Array クラスのblank? メソッド => 同じことやるのに再定義する必要ある？ 73 / 85
74. 6. パフォーマンス観点の再定義と懸念点 74 / 85
75. benchmark ベンチマークを取るためのモジュールです。 https://docs.ruby-lang.org/ja/latest/class/Benchmark.html https://github.com/ruby/benchmark “ “ 75 / 85
76. 使ってみる 今から行う検証の前に下記を実行 irb(main):001> require 'benchmark' => true 76 / 85
77. require が必要な理由 benchmark は組み込みライブラリではないため 組み込みライブラリは Ruby 本体に組み込まれているライブラリです。このラ イブラリに含まれるクラスやモジュールは、 require を書かなくても使うこと ができます。 https://docs.ruby-lang.org/ja/latest/library/_builtin.html “ “ 77 / 85
78. Object クラスのメソッド irb(main):001> require 'benchmark' => true irb(main):002* class Object irb(main):003* def blank? irb(main):004* respond_to?(:empty?) ? !!empty? : false irb(main):005* end irb(main):006> end => :blank? irb(main):007> array = ['a', 'b', 'c'] => ["a", "b", "c"] irb(main):008> method_object = array.method(:blank?) => #<Method: Array(Object)#blank?() (irb):3> irb(main):009> method_object.owner => Object irb(main):010* result = Benchmark.realtime do irb(main):011* 1000000.times { array.blank? } irb(main):012> end => 0.06730700004845858 78 / 85
79. Array クラスのメソッド ❯ irb irb(main):001> require 'benchmark' => true irb(main):002* class Array irb(main):003* alias_method :blank?, :empty? irb(main):004> end => :blank? irb(main):005> array = ['a', 'b', 'c'] => ["a", "b", "c"] irb(main):006> method_object = array.method(:blank?) => #<Method: Array#blank?(empty?)()> irb(main):007> method_object.owner => Array irb(main):008* result = Benchmark.realtime do irb(main):009* 1000000.times { array.blank? } irb(main):010> end => 0.04001499991863966 79 / 85
80. パフォーマンスの観点から再定義している Object クラスのメソッド：0.06730 Array クラスのメソッド：0.04001 80 / 85
81. ここのパフォーマンス改善に関しては議論がある Code that calls present or blank in an active record instance is an anti-pattern, to not say wrong. Making it faster is to legitimate that anti-pattern. https://github.com/rails/rails/issues/35059 “ “ 意訳すると『ActiveRecord では、そもそもpresent? やblank? を使うことがアンチ パターンです。それを高速化するということはアンチパターンを正当化すること になります。 』とのことです。 https://qiita.com/ham0215/items/b156d8cc5547ec56c719 “ “ 81 / 85
82. 内容のまとめ① レシーバ empty? blank? present? nil NoMethodError true false true NoMethodError false true false NoMethodError true false [] true true false {} true true false "" true true false " " false true false 82 / 85
83. 内容のまとめ② Rails のpresent? とblank? メソッドは空白状態を判定するための拡張機能 基本的にRuby のempty メソッドを元に動いている 各クラスで再定義され、パフォーマンスや用途に応じた最適化が行われている ただし、使用にはアンチパターンとなる場合もあるので注意 83 / 85
84. まとめ・注意点など 意外と1 つのことを深掘りするのも面白い（と個人的に思う） irb やrails console を使って手元で試すとイメージ湧きやすい とはいえ全てのコードについてここまで向き合う必要はない core_ext もRails で初学者が読むのにおすすめと上司に教えてもらって読んだ 84 / 85
85. ご清聴ありがとうございました！！ 85 / 85