Sinatraの実装を読む

対象読者

• Ruby初心者を抜け出したい人
• あまり人のコードとか読まないけどそろそろ読む練習したい人

コードリーディングに慣れてる人だと30分もかからないので，対象読者じゃないかも．

前提知識

• Rackアプリケーションの実装に関する基本的な事項
  • Rack解説 - Rackの構造とRack DSL - Qiitaを流し読みしたくらいでも大丈夫
• Sinatraを利用したアプリのつくりかた
  • ここではget '/' do ... endで実装するClassicアプリケーションを見ていく

Rack内部の実装については触れず，I/Fだけ知ってる状態という体ですすめる． あくまでSinatraが「どうやって起動するか」「どうやってルーティングを定義してるか」「どうやってリクエストを捌くか」「どうやってDSLを定義しているか」等に着目する．

実装を読む

ここでは2017年1月末時点での最新安定版であるv1.4.7を読む． sinatra/base.rbにほとんどの実装が集中しており，頭から読み進めたり秩序なく読んだりは非常にしんどい（そもそもコードリーディングを頭から進めることはないけど）．

なので，ここでは以下の3実装に分けて読み進める．

• Rack middlewareの実装
  • リクエストを受け取って，どうやって定義されたルーティングに流していくか
• Classic appの実装
  • 起動
    • rackupしてrun Sinatra::Applicationしなくても，ruby app.rb -p $PORT -o $IPで起動するのはどういう仕組みか
  • DSL定義
    • どのようにしてDSLを定義しているか
• ルーティング実装
  • DSLにより定義されたルーティングをどのように保持し，受け取ったリクエストをどのようにdispatchしていくか

以下は読んだコードの順番とちょっとしたメモの記録． メタプロや闇のコードはほとんどない，非常にシンプルな実装なのでそんなにメモることもないという感じ． あとで参照しやすいようにリンクだけ残してある．

注意点として，いま自分がクラスを見ているのか特異クラス（class << self ... end）を見ているのかを意識しておいたほうがいいかも．

Rack middlewareの実装

• config.ruにrun Sinatra::Applicationを記述すれば動く
  • Sinatra::ApplicationはSinatra::Baseのサブクラス https://github.com/sinatra/sinatra/blob/v1.4.7/lib/sinatra/base.rb#L1959
  • Sinatra::Base.callが起点 https://github.com/sinatra/sinatra/blob/v1.4.7/lib/sinatra/base.rb#L1486-L1488
    • prototypeにはSinatra::Application::Base.new`が入る https://github.com/sinatra/sinatra/blob/v1.4.7/lib/sinatra/base.rb#L1486-L148
    • 呼ばれるのはSinatra::Base#callおよびSinatra::Base#call! https://github.com/sinatra/sinatra/blob/v1.4.7/lib/sinatra/base.rb#L894-L919
    • Sinatra::Base#dispatch! https://github.com/sinatra/sinatra/blob/v1.4.7/lib/sinatra/base.rb#L1081-L109
      • Sinatra::Base#invokeはブロックの返り値をいい感じに整形するやつ https://github.com/sinatra/sinatra/blob/v1.4.7/lib/sinatra/base.rb#L1066-L1078
      • Sinatra::Base#filter!はbeforeやafterを呼んでる？ https://github.com/sinatra/sinatra/blob/v1.4.7/lib/sinatra/base.rb#L964-L967
        • この内部でSinatra::Base#process_routeが呼ばれてるけどよくわからん
      • Sinatra::Base#route! でマッチするルーティング定義を探す https://github.com/sinatra/sinatra/blob/v1.4.7/lib/sinatra/base.rb#L970-L990
        • パラメータ詰めるのはSinatra::Base#process_route？ https://github.com/sinatra/sinatra/blob/v1.4.7/lib/sinatra/base.rb#L1002-L1019
        • マッチするやつあったら:haltをthrowして抜ける
        • :haltはSinatra::Base#invokeがcatchする

Classic appの実装

• sinatra/mainをrequireしてenable :inline_templates https://github.com/sinatra/sinatra/blob/v1.4.7/lib/sinatra.rb

起動

• sinatra/mainでSinatra::Applicationつくってrun!する https://github.com/sinatra/sinatra/blob/v1.4.7/lib/sinatra/main.rb#L25
  • at_exitはKernel#at_exitのこと
  • Sinatra::Base.run! https://github.com/sinatra/sinatra/blob/v1.4.7/lib/sinatra/base.rb#L1435-L1451
    • Sinatra::Base.detect_rack_handler https://github.com/sinatra/sinatra/blob/v1.4.7/lib/sinatra/base.rb#L1763-L1774
    • Sinatra::Base.start_serverでhandlerをrunする https://github.com/sinatra/sinatra/blob/v1.4.7/lib/sinatra/base.rb#L1505-L1518

DSL定義

• Sinatra::Delegatorをmainにextend https://github.com/sinatra/sinatra/blob/v1.4.7/lib/sinatra/main.rb#L30
• getやpostのようなメソッド群をdefine_methodで定義するdelegateメソッドを作って呼び出し https://github.com/sinatra/sinatra/blob/v1.4.7/lib/sinatra/base.rb#L1979-L1982
  • それぞれのメソッドはDelegator.target（= Sinatra::Application）の当該メソッドに移譲するだけ

ルーティング実装

• だいたいSinatra::Base.routeになげてるだけ https://github.com/sinatra/sinatra/blob/v1.4.7/lib/sinatra/base.rb#L1369-L1384
  • @routesにメソッドをキーにした配列が入っていて，そこに追加されるhttps://github.com/sinatra/sinatra/blob/v1.4.7/lib/sinatra/base.rb#L1580-L1588
    • 追加されるのはよくわからない闇の配列 https://github.com/sinatra/sinatra/blob/v1.4.7/lib/sinatra/base.rb#L1602-L1615
  • この@routesにいれたルーティングの定義はすべて先に出てきたSinatra::Base#route!で捌かれる https://github.com/sinatra/sinatra/blob/v1.4.7/lib/sinatra/base.rb#L970-L990
    • base.routesが@routesを指す
    • base = settingsのsettingsはSinatra::Base自身 https://github.com/sinatra/sinatra/blob/v1.4.7/lib/sinatra/base.rb#L922-L929
    • @routesはSinatra::BaseのインスタンスではなくSinatra::Base自身が持ってるので注意

感想

読み進めるに当たっての入り口はわかりやすいのと，そこまで複雑な処理がないということでコードリーディング入門としては悪くない気がする．sinatra/base.rbが分割されておらずそこそこ巨大なことを除けば．

sinatraの実装が1ファイルに集中してるのなんでなん
実装はシンプルなのにそこで複雑そうに見えて初学者のリーディングのハードル無駄に挙げかねない気がする

— izumin (@izumin5210) January 29, 2017

三時のおやつのお供にどうぞ，くらいの難易度．

（特異クラスまわりが若干ごちゃごちゃなので，メタプロRubyとか読んでると理解しやすいのかも）

Effective Ruby

メタプログラミングRuby 第2版