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