rails-dev

コミュニティの Ruby on Rails 開発ベストプラクティス

Ruby on Rails アプリケーションのパフォーマンスと保守性を最適化するための包括的なガイドです。コミュニティによって保守されており、影響度に応じて優先順位付けされた 8 カテゴリー、45 のルールが含まれています。自動リファクタリングやコード生成の指針としてご利用ください。

適用する場面

次の場合に、これらのガイドラインを参照してください。

• Rails のコントローラー、モデル、ビューを新規作成する
• ActiveRecord クエリやデータベースアクセスパターンを最適化する
• キャッシュ戦略（フラグメント、ロシア人形、低レベル）を実装する
• API エンドポイントを構築またはリファクタリングする
• インタラクティブな UI に Turbo Frames と Streams を追加する
• N+1 クエリやセキュリティ上の脆弱性がないかコードをレビューする
• Sidekiq または Active Job でバックグラウンドジョブを設計する
• データベースマイグレーションを作成またはレビューする

優先度別のルールカテゴリー

優先度	カテゴリー	影響度	プレフィックス
1	データベースと ActiveRecord	重大	db-
2	コントローラーとルーティング	重大	ctrl-
3	セキュリティ	高	sec-
4	モデルとビジネスロジック	高	model-
5	キャッシュとパフォーマンス	高	cache-
6	ビューとフロントエンド	中〜高	view-
7	API 設計	中	api-
8	バックグラウンドジョブと非同期処理	低〜中	job-

クイックリファレンス

1. データベースと ActiveRecord（重大）

• db-eager-load-associations - N+1 クエリをなくすために関連付けを事前読み込みする
• db-add-database-indexes - クエリ対象のカラムにデータベースインデックスを追加する
• db-select-specific-columns - 必要なカラムのみを選択する
• db-batch-processing - 大規模なデータセットの反復処理には find_each を使用する
• db-avoid-queries-in-loops - ループ内でのデータベースクエリを避ける
• db-use-scopes - モデルに再利用可能なクエリスコープを定義する
• db-safe-migrations - 可逆でダウンタイムが発生しないマイグレーションを作成する
• db-exists-over-count - 存在確認には count ではなく exists? を使用する

2. コントローラーとルーティング（重大）

• ctrl-thin-controllers - モデルやサービスに処理を委譲して、コントローラーを薄く保つ
• ctrl-strong-params - マスアサインメントには必ず Strong Parameters を使用する
• ctrl-restful-routes - RESTful なルーティング規約に従う
• ctrl-before-action-scoping - only/except を使って before_action コールバックの適用範囲を限定する
• ctrl-respond-to-format - 複数フォーマットのレスポンスには respond_to を使用する
• ctrl-rescue-from - コントローラーでは rescue_from でエラーを処理する

3. セキュリティ（高）

• sec-parameterized-queries - SQL にユーザー入力を決して埋め込まない
• sec-strong-params-whitelist - 許可する params をホワイトリストで指定し、ブラックリストは使用しない
• sec-authenticate-before-authorize - すべてのリクエストで、認可の前に必ず認証する
• sec-csrf-protection - すべてのフォーム送信で CSRF 保護を有効にする
• sec-scope-queries-to-user - 認可のために、クエリの対象を現在のユーザーに限定する

4. モデルとビジネスロジック（高）

• model-validate-at-model-level - モデルレベルでデータを検証する
• model-avoid-callback-side-effects - モデルのコールバックで副作用を避ける
• model-use-service-objects - 複雑なロジックをサービスオブジェクトに切り出す
• model-scope-over-class-methods - クエリを組み立てるには、クラスメソッドではなくスコープを使う
• model-use-enums - 有限状態のフィールドには列挙型を使う
• model-concerns-for-shared-behavior - モデル間で共有する動作にはConcernを使う
• model-query-objects - 複雑なクエリをクエリオブジェクトに切り出す

5. キャッシュとパフォーマンス（高）

• cache-fragment-caching - コストの高いビューのパーシャルにはフラグメントキャッシュを使う
• cache-russian-doll - 入れ子になったコレクションにはロシア人形キャッシュを使う
• cache-low-level - 計算済みデータにはRails.cache.fetchを使う
• cache-counter-cache - 関連レコード数にはカウンターキャッシュを使う
• cache-conditional-get - HTTPキャッシュにはstale?を使った条件付きGETを使う

6. ビューとフロントエンド（中〜高）

• view-collection-rendering - ループ内のパーシャルではなく、コレクションのレンダリングを使う
• view-turbo-frames - ページの一部を更新するにはTurbo Framesを使う
• view-turbo-streams - リアルタイムのページ変更にはTurbo Streamsを使う
• view-form-with - form_tagやform_forではなくform_withを使う
• view-avoid-logic-in-views - 表示ロジックをヘルパーまたはプレゼンターに移す

7. API設計（中）

• api-serializers - 一貫性のあるJSONレスポンスにはシリアライザーを使う
• api-pagination - コレクションのエンドポイントでは必ずページネーションを行う
• api-versioning - APIは最初からバージョン管理する
• api-error-responses - 構造化されたエラーレスポンスを返す
• api-avoid-jbuilder-hot-paths - トラフィックの多いエンドポイントではJbuilderを避ける

8. バックグラウンドジョブと非同期処理（低〜中）

• job-idempotent-design - ジョブを冪等になるよう設計する
• job-small-payloads - シリアライズされたオブジェクトではなく、IDをジョブに渡す
• job-error-handling - ジョブのリトライとエラー処理を設定する
• job-unique-jobs - ジョブの重複登録を防ぐ

使用方法

詳しい説明とコード例については、各リファレンスファイルをお読みください。

• セクションの定義 - カテゴリー構成と影響度レベル
• ルールのテンプレート - 新しいルールを追加するためのテンプレート

リファレンスファイル

ファイル	説明
references/_sections.md	カテゴリーの定義と順序
assets/templates/_template.md	新しいルール用のテンプレート
metadata.json	バージョンとリファレンス情報