ruby-optimise

Ruby コミュニティのベストプラクティス

コミュニティが管理する、Ruby アプリケーション向けの包括的なパフォーマンス最適化ガイドです。8 つのカテゴリにわたる 42 のルールを収録し、自動リファクタリングとコード生成の指針となるよう、影響度順に優先順位を付けています。

適用する場面

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

• 新しい Ruby コードや gem を作成するとき
• ActiveRecord のクエリやデータベースアクセスパターンを最適化するとき
• 大規模なコレクションを処理するときや、データパイプラインを構築するとき
• メモリの肥大化や GC への負荷がないかコードをレビューするとき
• 本番環境向けに Ruby のランタイム設定を行うとき

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

優先度	カテゴリ	影響度	接頭辞
1	オブジェクト割り当て	CRITICAL	alloc-
2	コレクションと列挙	CRITICAL	enum-
3	I/O とデータベース	HIGH	io-
4	文字列処理	HIGH	str-
5	メソッドとディスパッチ	MEDIUM-HIGH	meth-
6	データ構造	MEDIUM	ds-
7	並行処理	MEDIUM	conc-
8	ランタイムと設定	LOW-MEDIUM	runtime-

クイックリファレンス

1. オブジェクト割り当て（CRITICAL）

• alloc-avoid-unnecessary-dup - 不要なオブジェクトの複製を避ける
• alloc-freeze-constants - 定数コレクションを凍結する
• alloc-lazy-initialization - コストの高いオブジェクトには遅延初期化を使う
• alloc-avoid-temp-arrays - 一時的な配列の生成を避ける
• alloc-reuse-buffers - ループ内でバッファーを再利用する
• alloc-avoid-implicit-conversions - 処理頻度の高い箇所での繰り返し計算を避ける

2. コレクションと列挙（CRITICAL）

• enum-single-pass - コレクションの変換には単一パスを使う
• enum-lazy-large-collections - 大規模なコレクションには遅延列挙子を使う
• enum-flat-map - map.flatten の代わりに flat_map を使う
• enum-each-with-object - コレクションの構築には inject より each_with_object を使う
• enum-avoid-count-in-loops - 条件式でコレクションのサイズを再計算しない
• enum-chunk-batch-processing - バッチ処理には each_slice を使う

3. I/O とデータベース（HIGH）

• io-eager-load-associations - ActiveRecord の関連を事前読み込みする
• io-select-only-needed-columns - 必要なカラムのみを選択する
• io-batch-find-each - 大量のレコードには find_each を使う
• io-avoid-queries-in-loops - ループ内でデータベースクエリを実行しない
• io-stream-large-files - 大きなファイルは1行ずつストリーム処理する
• io-connection-pool-sizing - スレッド数に合わせてコネクションプールのサイズを調整する
• io-cache-expensive-queries - コストの高いデータベースクエリの結果をキャッシュする

4. 文字列処理（HIGH）

• str-frozen-literals - 文字列リテラルの凍結を有効にする
• str-shovel-over-plus - 文字列の組み立てにはショベル演算子を使う
• str-interpolation-over-concatenation - 文字列の連結より文字列補間を使う
• str-avoid-repeated-gsub - 複数の gsub 呼び出しを1回の置換にまとめる
• str-symbol-for-identifiers - 識別子やハッシュキーにはシンボルを使う

5. メソッドとディスパッチ（中〜高）

• meth-avoid-method-missing-hot-paths - ホットパスでの method_missing の使用を避ける
• meth-cache-method-references - 繰り返し呼び出すメソッド参照をキャッシュする
• meth-block-vs-proc - ブロックを Proc に変換せず、そのまま渡す
• meth-avoid-dynamic-send - パフォーマンスが重要なコードで動的な send を避ける
• meth-reduce-method-chain-depth - ホットループでのメソッドチェーンの深さを減らす

6. データ構造（中）

• ds-set-for-membership - メンバーシップテストに Set を使用する
• ds-struct-over-openstruct - OpenStruct より Struct を使用する
• ds-sort-by-over-sort - ブロック付きの sort ではなく sort_by を使用する
• ds-array-preallocation - サイズがわかっている場合は配列を事前に確保する
• ds-hash-default-value - 条件付き代入ではなく Hash のデフォルト値を使用する

7. 並行処理（中）

• conc-fiber-for-io - I/O バウンドの並行処理に Fiber を使用する
• conc-thread-pool-sizing - ワークロードに合わせてスレッドプールのサイズを設定する
• conc-ractor-cpu-bound - CPU バウンドの並列処理に Ractor を使用する
• conc-avoid-shared-mutable-state - スレッド間での共有可変状態を避ける

8. ランタイムと設定（低〜中）

• runtime-enable-yjit - 本番環境で YJIT を有効にする
• runtime-tune-gc-parameters - ワークロードに合わせて GC パラメーターを調整する
• runtime-frozen-string-literal-default - プロジェクトのデフォルトとして Frozen String Literal を設定する
• runtime-optimize-require - require の読み込み順序を最適化する

使用方法

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

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

リファレンスファイル

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