rbs-inlineを導入してYARDからRBSに移行する

RubyKaigi 2024 follow up での発表資料です。 w/ https://x.com/soutaro
https://rhc.connpass.com/event/320709/

元ネタ
https://speakerdeck.com/soutaro/embedding-it-into-ruby-code

## スライド内のリンク
前編：YARD から rbs-inline に移行しました
https://tech.timee.co.jp/entry/2024/08/22/183127

後編：YARD から rbs-inline に移行しました
https://tech.timee.co.jp/entry/2024/08/23/180201

Transcript

1. 2024/08/31　松本宗太郎/新谷哲平（株式会社タイミー） rbs-inlineを導入して YARDからRBSに移行する RubyKaigi 2024 follow up
2. 松本宗太郎 @soutaro タイミーでRuby/Steep/RBSの 開発に従事。 新谷哲平 @euglena1215 タイミーでバックエンドの テックリードを務める。
3. 1 rbs-inlineの近況報告
5. rbs-inlineの新機能 1. 構文の決定 2. singletonクラス定義 3. ブロックで暗黙に定義されるクラス 4. Data/Structのサポート 5. 今後の展望
6. 構文の変更 # @rbs (Integer id, group: Group) -> String? def foo(id, group:) end #: (Integer id, group: Group) -> String? def foo(id, group:) end # @rbs id: Integer # @rbs group: Group # @rbs return: String? def foo(id, group:) end
7. 構文の変更 attr_reader :id #: Integer path = nil #: Pathname? • Steepの構文と衝突するんだけど、Steepの方を直した ◦ attr_readerについている注釈は無視 [rbs-inline] idというattributeの型はInteger [Steep] attr_readerメソッドの返り値の型はInteger [Steep] nilという式の型はPathname?
8. singletonクラス、ブロックで定義されるクラス class Foo class <<self def foo end end end module Foo extend ActiveSupport::Concern class_methods do # 暗黙にClassMethodsモジュールを定義 def foo end end end
9. singletonクラス、ブロックで定義されるクラス class Foo class <<self def foo end end end module Foo extend ActiveSupport::Concern class_methods do # 暗黙にClassMethodsモジュールを定義 def foo end end end # module ClassMethods
10. Data/Structのサポート Account = Data.define( :id, #: Integer :email #: String ) class Account # @rbs () -> Integer def foo = 123 end class Account < Data attr_reader id(): Integer attr_reader email(): String def self.new: (Integer id, String email) -> instance | (id: Integer, email: String) -> instance end class Account def foo: () -> Integer end • 定数に代入するパターンで、ブロックがないものだけサポート • メソッドを追加したいときはclassを改めて書く
11. Data/Structのサポート Account = Data.define( :id, #: Integer :email #: String ) class Account # @rbs () -> Integer def foo = 123 end class Account < Data attr_reader id(): Integer attr_reader email(): String def self.new: (Integer id, String email) -> instance | (id: Integer, email: String) -> instance end class Account def foo: () -> Integer end • 定数に代入するパターンで、ブロックがないものだけサポート • メソッドを追加したいときはclassを改めて書く
12. Data/Structのサポート Account = Data.define( :id, #: Integer :email #: String ) class Account # @rbs () -> Integer def foo = 123 end class Account < Data attr_reader id(): Integer attr_reader email(): String def self.new: (Integer id, String email) -> instance | (id: Integer, email: String) -> instance end class Account def foo: () -> Integer end • 定数に代入するパターンで、ブロックがないものだけサポート • メソッドを追加したいときはclassを改めて書く
13. Data/Structのサポート Account = Data.define( :id, #: Integer :email #: String ) class Account # @rbs () -> Integer def foo = 123 end class Account < Data attr_reader id(): Integer attr_reader email(): String def self.new: (Integer id, String email) -> instance | (id: Integer, email: String) -> instance end class Account def foo: () -> Integer end • 定数に代入するパターンで、ブロックがないものだけサポート • メソッドを追加したいときはclassを改めて書く
14. Data/Structのサポート Account = Data.define( :id, #: Integer :email #: String ) class Account # @rbs () -> Integer def foo = 123 end class Account < Data attr_reader id(): Integer attr_reader email(): String def self.new: (Integer id, String email) -> instance | (id: Integer, email: String) -> instance end class Account def foo: () -> Integer end • 定数に代入するパターンで、ブロックがないものだけサポート • メソッドを追加したいときはclassを改めて書く class Account < Data.define( :id, #: Integer :email #: String ) def foo = 123 end
15. 今後の展望 1. rbs-gemとの統合 2. 各種エディタ連携の実装 3. 構文は確定
16. 今後の展望 1. rbs-gemとの統合 2. 各種エディタ連携の実装 3. 構文は確定 📣 もう使っていいよ！
17. 使ってみたよ！ 🙋
18. 2 YARDから rbs-inlineへの移行
19. YARDからrbs-inlineへの移行 1. 具体的な移行の流れ 2. 実践投入による rbs-inline へのフィードバック 3. 実際に移行してみてどうだったか
20. 1. 具体的な移行の流れ 時間が足りないので割愛。ブログにまとめているので見てね。 変換スクリプトも公開してます。 前編：YARD から rbs-inline に移行しました - Timee Product Team Blog 後編：YARD から rbs-inline に移行しました - Timee Product Team Blog
21. 1. 具体的な移行の流れ 時間が足りないので割愛。ブログにまとめているので見てね。 変換スクリプトも公開してます。 前編：YARD から rbs-inline に移行しました - Timee Product Team Blog 後編：YARD から rbs-inline に移行しました - Timee Product Team Blog ここで一番重要なのは タイミーは rbs-inline を本番で利用している ということ
22. 2. 実践投入による rbs-inline へのフィードバック 実際に移行を進めていく中で困ったことを soutaro さんにフィードバックした。 その結果、rbs-inline に取り込んでもらえた事例を紹介。
23. Data, Struct サポート YARD コメントから RBS を生成する sord gem を削除したところ、Data.define, Struct.new によって定義されたクラスの型定義が見つからないエラーが発生。
24. Data, Struct サポート YARD コメントから RBS を生成する sord gem を削除したところ、Data.define, Struct.new によって定義されたクラスの型定義が見つからないエラーが発生。 rbs-inline が untyped として生成していたことが原因。sord はきちんとクラス として生成していた。
25. Data, Struct サポート 対応： @rbs! を使って直接 RBS を手書きする。数十個くらい
26. Data, Struct サポート 対応： @rbs! を使って直接 RBS を手書きする。数十個くらい つらい！！！！
27. Data, Struct サポート 今後もずっと Data.define, Struct.new の型を手書きして いくのはちょっと辛いです。なんとかなりませんかね？
28. Data, Struct サポート 今後もずっと Data.define, Struct.new の型を手書きして いくのはちょっと辛いです。なんとかなりませんかね？ なんとかしましょう。
29. Data, Struct サポート rbs-inline 0.6.0 で Data, Struct がサポートされた 🎉
30. 2. 実戦投入による rbs-inline へのフィードバック rbs-inline はまだまだ実戦投入によって磨かれる時期。 今なら要望が通る可能性がそこそこ高いので使い始めるなら今！
31. 3. 実際に移行してみてどうだったか YARD から rbs-inline に移行してみてのユーザーの声を紹介。
32. 3. 実際に移行してみてどうだったか 「メソッドの型を意識するようになった」
33. 3. 実際に移行してみてどうだったか 「メソッドの型を意識するようになった」
34. 3. 実際に移行してみてどうだったか 「メソッドの型を意識するようになった」
35. 3. 実際に移行してみてどうだったか とはいえ、まだ型検査（steep check）が通せる状況にはなっていない。 型検査を通してからが本領発揮だと思うのでやっていきたい。
36. まとめ 1. rbs-inlineは安定してきているので、試してください a. 利用者がいないと進まない b. Data/Structのサポートは実戦投入からのフィードバック 2. YARDからの移行もまかせろ a. やればできる b. 詳しくは「yard rbs-inline」で検索
38. Q&A Q. rbs-inline の記法は YARD likeな記法と RBS likeな記法があるがどっちを 　 使っている？ルールはあるか？ A. YARDからの移行の都合でYARD likeが絶対数としては多い。既存のYARD likeを見ながら書いていくので、YARD likeが多い感じはある。 ルールは作っていない。将来的に策定する可能性はあるが、現状は様子を見 ている。