🐼

RBS実践導入時に遭遇した問題と解決法

2023/08/30に公開

ライフイズテックのサービス開発部 学校プロダクトグループに所属している程です。


Rubyの型定義言語、RBSの導入は、多くのRubyプロジェクトでの品質向上のキーとなりました。しかし、我々のチームがRBSを導入しようとしたとき、数々の課題に直面しました。前篇Rubyの型定義を実戦投入!RBSの導入と運用のポイントに続き、その具体的な問題と、我々が取ったアプローチをシェアします。

1. 既存メソッドの多重定義

課題:

我々のコードベースには、同名のメソッドが多数存在し、それぞれが異なる型の引数を取ることがありました。

解決策:

RBSにはオーバーロードの機能があります。この機能を利用して、一つのメソッド名に対して複数の型シグネチャを定義しました。

def process_data: (String) -> void
                | (Integer) -> void

これにより、同名のメソッドでも異なる引数型を持つことが許容されるようになりました。

2. 外部ライブラリの型情報の欠如

課題:

多くの依存しているgemがまだRBSのサポートを持っていないため、型定義が欠如していました。

解決策:

RBSのコミュニティで提供されている共有の型定義(Steepなどのリポジトリ)を利用することで、多くの人気gemの型情報を取り入れることができました。また、独自に型定義を書くことで、未サポートのgemに対応しました。

3. 抽象クラスと具象クラスの関係

課題:

我々のコードベースには多くの抽象クラスやモジュールが存在し、これらをどのようにRBSで表現するかが問題でした。

解決策:

RBSのinterfaceを利用して、抽象クラスやモジュールの型情報を定義しました。これにより、具象クラスがこれらのインターフェースを満たしているかを確認することができました。

4. 可変長の引数やブロック付きメソッド

課題:

Rubyの可変長引数やブロックを取るメソッドの型定義が難しかった。

解決策:

RBSの*args&blockの機能を利用して、これらの動的なメソッド呼び出しを型定義しました。

def dynamic_method: (*String) -> void

これにより、Rubyの柔軟なメソッド呼び出しも型情報として表現することができました。

まとめ

RBSの導入は確かに時間と努力が必要でしたが、その結果として、我々のコードの品質は大きく向上しました。上記の問題は一部に過ぎませんが、これらを通じて、RBSの導入の際のベストプラクティスや注意点を学ぶことができました。


ライフイズテック サービス開発部では、気軽にご参加いただけるカジュアルなイベントを実施しています。開催予定のイベントは、 connpass のグループからご確認ください。興味のあるイベントがあったらぜひ参加登録をお願いいたします。皆さんのご参加をお待ちしています!

Discussion