ruby-refactor

コミュニティによる Ruby リファクタリングのベストプラクティス

コミュニティがメンテナンスする、Ruby アプリケーション向けの包括的なリファクタリングガイドです。影響度順に優先順位付けされた 8 カテゴリ、45 個のルールを収録し、自動リファクタリングとコード生成を支援します。

適用するタイミング

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

• Ruby コードをリファクタリングして、複雑さを減らし、設計を改善する場合
• 大きな単位からメソッド、クラス、または値オブジェクトを抽出する場合
• 複雑な条件式や深いネストを簡素化する場合
• クラスやモジュール間の結合度を下げる場合
• 慣用的な Ruby のパターンや最新の Ruby 3.x の機能を取り入れる場合

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

優先度	カテゴリ	影響度	プレフィックス
1	構造と分解	CRITICAL	struct-
2	条件式の簡素化	CRITICAL	cond-
3	結合度と依存関係	HIGH	couple-
4	Ruby の慣用表現	HIGH	idiom-
5	データと値オブジェクト	MEDIUM-HIGH	data-
6	デザインパターン	MEDIUM	pattern-
7	最新の Ruby 3.x	MEDIUM	modern-
8	命名と可読性	LOW-MEDIUM	name-

クイックリファレンス

1. 構造と分解（CRITICAL）

• struct-extract-method - 長いメソッドを役割に特化した単位に抽出する
• struct-extract-class - 単一責任を担うクラスを抽出する
• struct-parameter-object - 引数が多いシグネチャにパラメーターオブジェクトを導入する
• struct-compose-method - 同じ抽象度のメソッドを組み立てる
• struct-replace-method-with-object - 複雑なメソッドをメソッドオブジェクトに置き換える
• struct-single-responsibility - クラスごとに変更理由を 1 つにする
• struct-flatten-deep-nesting - 早期抽出によって深いネストを解消する

2. 条件式の簡素化（CRITICAL）

• cond-guard-clauses - ネストした条件式をガード節に置き換える
• cond-decompose-conditional - 複雑な真偽値式を名前付き述語に抽出する
• cond-replace-with-polymorphism - case/when をポリモーフィズムに置き換える
• cond-null-object - nil チェックを Null Object に置き換える
• cond-pattern-matching - 構造的な条件にパターンマッチングを使う
• cond-consolidate-duplicates - 重複する条件式の断片をまとめる

3. 結合度と依存関係（HIGH）

• couple-law-of-demeter - 委譲を使ってデメテルの法則を適用する
• couple-feature-envy - メソッドを移動してフィーチャー・エンヴィーを解消する
• couple-dependency-injection - コンストラクターのデフォルト値を使って依存関係を注入する
• couple-composition-over-inheritance - Mixin を合成されたオブジェクトに置き換える
• couple-tell-dont-ask - オブジェクトに状態を問い合わせず、何をするか伝える
• couple-avoid-class-methods-domain - ドメインロジックでクラスメソッドを避ける

4. Ruby のイディオム（高）

• idiom-prefer-enumerable - アキュムレーターを使った each より map/select/reject を使う
• idiom-keyword-arguments - 明確さのためにキーワード引数を使う
• idiom-duck-typing - 型チェックには is_a? より respond_to? を使う
• idiom-predicate-methods - 真偽値を返すメソッド名には ? を付ける
• idiom-respond-to-missing - method_missing と respond_to_missing? は必ず組み合わせる
• idiom-block-yield - 単純なブロックには block.call より yield を使う
• idiom-implicit-return - 最後の式では明示的な return を省略する

5. データと値オブジェクト（中〜高）

• data-value-object - プリミティブ型への執着を値オブジェクトで置き換える
• data-define-immutable - 不変の値オブジェクトには Data.define を使う
• data-encapsulate-collection - コレクションをドメインメソッドの背後にカプセル化する
• data-replace-data-clump - データの塊をグループ化したオブジェクトで置き換える
• data-separate-query-command - クエリメソッドとコマンドメソッドを分離する

6. デザインパターン（中）

• pattern-strategy - アルゴリズムのバリエーションをストラテジーオブジェクトに切り出す
• pattern-factory - オブジェクト生成を抽象化するためにファクトリーメソッドを使う
• pattern-template-method - テンプレートメソッドでアルゴリズムの骨格を定義する
• pattern-decorator - デコレーターでオブジェクトをラップし、振る舞いを追加する
• pattern-null-object-protocol - 完全なプロトコルを備えたヌルオブジェクトを実装する

7. モダンな Ruby 3.x（中）

• modern-pattern-matching - 構造的パターンマッチングには case/in を使う
• modern-deconstruct-keys - カスタムのパターンマッチング用に deconstruct_keys を実装する
• modern-endless-methods - 単純なメソッドにはエンドレスメソッド定義を使う
• modern-hash-pattern-guard - ガード節とパターンマッチングを組み合わせる
• modern-rightward-assignment - パイプライン式には右辺代入を使う

8. 命名と可読性（低〜中）

• name-intention-revealing - 意図が伝わる名前を使う
• name-consistent-vocabulary - コードベース全体で概念ごとに一つの単語を使う
• name-avoid-abbreviations - 一般的な略語を除き、名前は省略せずに書く
• name-rename-to-remove-comments - コメントが不要になるように名前を変更する

使い方

詳しい説明とコード例については、個々のリファレンスファイルを参照してください。

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

リファレンスファイル

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