Rails新規開発時のディレクトリ構成
app下の構成を先に決定
Rails5でアプリ新規開発時にディレクトリの構成を先に決定しました。
その経緯と実際の構成です。
メリット
- 先にある程度ディレクトリ構成の方向性を決めておく事により実装フェーズでエンジニアが配置場所に悩む時間を減らす。
- PRが送られた時に新たな構成を作ってくる場合、コードレビューにより手戻りが発生する事を減らせる。
- 構成が決まっていないゆえに、チームにジョインしたてのエンジニアなどが振る舞いと一致しない場所にコードを増えていくことを防ぐことができる。
app構成(Rails既存のディレクトリは除く)
cells
decorators
forms
observers
services
validators
Directories
cells
viewの部分テンプレートとコンポーネントを独立させるcells用のクラス群を配置します
decorators
モデルに対応するデータの整形処理はhelperを廃止しdecoratorに移動させます
forms
独自formオブジェクト用のクラスを配置します
observers
Rails4から廃止されたrails-observerですが、モデルのcallbackやステータスチェンジ時の見通しを良くするためrails-observerを導入しディレクトリを配置します
services
モデルに紐付かない処理や振る舞いに対する処理用のクラスを配置します
validators
独自validationを作ることも多くなって来ると思いますがValidationクラスの共通化をし配置します
その他
プロジェクト全体で共通のライブラリはlib/直下に配置