はじめに
- 【AI自動化】Rails 7.1 → 7.2 のアップデート修正をAIに任せる で作成した設計プロンプトをブラッシュアップし、AI に任せる形で Rails 7.2.2.2 から Rails 8.1.1(本記事執筆時点での最新)まで上げる取り組みを実施しました
- 本記事では、その際に使用した設計プロンプトの中身や、実際に適用した差分などをまとめます
- Railsのアップデート実施を考えている方へ、少しでも参考になれば幸いです
-
Rails8.0.4→8.1.1に関しては、文字数の関係で後日に別で記事を出します - 本記事は、
Rails7.2→8.0をメインに記載しています
環境
- バックエンド:Rails7.2.2.2(APIモード)
- インフラ:AWS
- 開発環境:Docker(リモートLinuxホスト / 例:AWS EC2)
- エディタ:Visual Studio Code(Remote - SSH)
- AIツール1:GitHub Copilot Pro(AIモデル:Claude Sonnet 4.5)
- AIツール2:Google Gemini(AIモデル:Gemini 3 Pro)
- ホストPC:MacBook Pro (Apple M3 Pro / macOS 26.0.1)
プロンプト設計とは
プロンプト設計は、公式ドキュメント・仕様・運用規約・ログなどの一次情報を根拠に、作業手順・評価基準・失敗時の対応を事前に構造化し、その設計に沿ってAIに実行させることです。
設計に入る前に
- プロンプト設計に入る前に、事前に簡単な調査を実施しました
- 各バージョンのReleaseNote、Changelogのリンクを確認し、主な変更点をまとめる
- アップグレード事例を確認
- 同じ社内の中にある別チームのアップグレード事例を確認
注意点
- 今回、バージョンを一気に
7.2から8.1に上げるのではなく、7.2系の最新→8.0系の最新→8.1系の最新と、順を追って対応しました -
8.x系の最新にする理由は、バグ修正が反映されている可能性が高く、最も安定した状態を確保できるためです - また、Railsのリリースノートにも以下のように記載されています
アプリケーションがRails 8.0までアップグレードされていない場合は先にそれを完了し、アプリケーションが正常に動作することを十分確認してからRails 8.1にアップデートしてください。
Rails7.2.2.2 → 7.2.3
詳細
Rails8系へのアップデート前にRails7.2.3へのアップデートを挟む理由
-
7.2.3に上げることで、Rails 7系の最も安定した(バグ修正が反映された)状態を確保できるため -
7.2.3をスキップして8.0へ上げた場合に発生した不具合の原因を、「8.0の変更」なのか「7.2.3相当の変更」なのかで明確に切り分けしやすい -
7.2.2.2→7.2.3の差分はバグフィックス中心のため、プロンプト設計のブラッシュアップにも最適-
7.2.2.2で作成したプロンプトを微修正すれば7.2.3でも流用でき、ブラッシュアップ版との比較検証もしやすい - Rails8へのアップデートや、今後のアップデートの際にも設計プロンプトを使用することを想定
-
設計プロンプト
Rails7.2.2.2からRails7.2.3への変更は、主にバグフィックスのため、設計プロンプトの記載は割愛します。※8.0.4、8.1.1と対応していく度にブラッシュアップも行っているため
実際に適用された主な差分
- 変更が加わった箇所は、
GemfileとGemfile.lockのみです
ruby "3.2.2"
# Bundle edge Rails instead: gem 'rails', github: 'rails/rails'
- gem "rails", "~> 7.2.0"
+ gem "rails", "~> 7.2.3"
# Use postgresql as the database for Active Record
gem "pg", "~> 1.5"
# Use Puma as the app server
省略
Rails7.2.3 → 8.0.4
事前準備
- Gem
annotateを使っている場合には、Rails8に対応していないのでannotaterbに置き換える必要があります - この対応を怠ると、Rails8.0.4へのアップデート時に以下のような事象が発生します
-
activerecordは「8.0.4 じゃないとダメ」(railsの要求) -
activerecordは「8.0 未満じゃないとダメ」(annotateの要求)
-
- こちらは、プルリクエスト(マージリクエスト)を切り分けて対応しました
- 公式のマイグレーションガイド通りに実施可能です
- Gemの更新についてもプロンプト設計を行うことは可能ですが、工数に見合わないので手動で実施しました
前提補足
Rubyバージョン確認
-
Rails8.0以降は、Ruby3.2以上が必須です
- 先にRubyのバージョンを上げてからRailsを更新するのが安全なので、未対応の場合は実施しましょう
- 今回は既にRuby3.2であったため、対応不要でした(わいわい)
enum の定義
- enum の定義が『キーワード引数形式』から『位置引数形式』にする対応も、Rails 7.1 → 7.2のタイミングで既に実施完了しています
設計プロンプト(実体)
annotateをannotaterbに置き換える対応をデプロイしたら、いよいよRails8へのアップグレード対応を開始します。
これまで使っていた単一設計プロンプトを適度な粒度に分け、ひとつひとつのプロンプトの精度がより上がるようにブラッシュアップを実施しました。
プロンプト1(Rails本体のバージョンアップ)
-
Rails 7.2.3からRails 8.0.4へのバージョンアップ作業- 目的
- Gemfile の
rails行を書き換え、必要な Rails コアコンポーネントの依存関係をbundle updateで更新し、Docker イメージのビルドと簡易起動スモークまでを自動で行う
- Gemfile の
- 概要
- Step1:事前確認
- Step2:Gemfile 編集
- Step3:コンポーネント更新
- Step4:Rails 本体更新
- Step5:失敗時の調査(必要な場合)
- Step6:ビルドとバージョン確認
- Step7:起動スモーク
- 目的
rails-7.2.3_to-8.0.4_update_prompt1.md
# 依頼
あなたは {# 役割} です。
{# ルール} を必ず守り、{# 実行シナリオ} に従って、対象プロジェクトの Rails を **7.2.3 → 8.0.4** にアップデートしてください。
作業の結果は、最後に {# 出力形式} に示す **JSON 形式** でのみ出力してください。
---
# 役割
- Docker 環境上で動作する Rails アプリケーションの **Rails 本体のバージョンアップ専用エージェント**
- 対象タスクは「Rails 本体とそのコア依存のアップデート」「起動スモーク確認」のみ
- テスト実行(`rails test`)、Lint(`rubocop`)、`config/initializers/new_framework_defaults_*` の変更などは **担当外**(別プロンプトが実施)
---
# 環境
- リポジトリ直下(プロジェクトルート)で実行されることを前提とする
- フロントエンド: Nuxt3(関与しない)
- バックエンド: 現状は `Rails 7.2.3` を想定するが、**実際のバージョンは Step1 で必ずコマンドから取得して記録する**
- インフラ: Docker Compose / サービス名 `web`
- `Gemfile` と `Gemfile.lock` はプロジェクトルートに存在する
---
# ルール
1. **対話禁止**
- ユーザーへの質問・確認・追加入力依頼を一切行わない
2. **次の Git 操作禁止 / 許可**
- 禁止: `git add`, `git commit`, `git push`
- 許可: 確認のための `git status`, `git diff`
- これらはあくまで **状態確認のみ** に使い、ファイル内容はこのプロンプトの指示の範囲外で変更しない
3. **変更対象の制限**
- 直接編集してよいファイルは **`Gemfile` のみ**
- `Gemfile.lock` は **Bundler が生成・更新する** 以外の変更を行ってはいけない(手動編集禁止)
- `Gemfile`・`Gemfile.lock` 以外のファイルについては、**新規作成・削除・リネーム・内容変更を一切行ってはいけない**
4. **使用コマンドの制限**
- {# 使用可能コマンド} に列挙されたコマンド **と** ルール2で許可した Git コマンド **のみ** 実行してよい
- 列挙されたコマンドに対して **オプションや引数を追加・変更してはいけない**
5. **タスク範囲の制限**
- Rails バージョンの更新と依存解決、ビルド、起動スモークのみを行う
- `rails test`, `rubocop`, その他のメンテ系コマンドは一切実行しない
- Bundler から Ruby バージョン変更などの提案が出ても、**このプロンプト内では Ruby バージョンを変更しない**
6. **コマンド実行回数と順序**
- {# 実行シナリオ} に記載された順序を基本とし、**不要なリトライや無限ループは行わない**
- 各コマンドは、必要になったときに **高々 1 回** 実行する(precheck の再確認など、明確な理由がある一時的な再実行を除く)
7. **ログの扱い**
- エラー内容は `error_summary` として **1〜3 文に要約** し、ログ全文を JSON に埋め込まない
- `blocking_gems.reason` やその他のフィールドにも、長大なログをそのまま貼り付けず、意味のある要約のみを記載する
8. **プレースホルダの扱い**
- `<問題のgem名>` / `<gem名>` は、実行時には必ず **具体的な gem 名** に置き換える
- プレースホルダ文字列のままコマンドを実行してはいけない
9. **調査コマンド失敗時の扱い**
- Step5 で実行する調査用コマンド(`bundle info <gem名>`)は **補助情報取得のためのベストエフォート** とする。
- これらのコマンドが Gemfile の依存不整合などで失敗しても、**その失敗自体を `failed_step` の原因とはせず**、
直前の `bundle update` のエラーログから分かる範囲で `blocking_gems` を整理すればよい。
10. **終了条件**
- {# 成功条件} を満たした場合のみ `status: "success"` として終了する
- 条件を満たせなかった場合は `status: "failed"` とし、{# 失敗時の扱い} に従い原因を整理して終了する
---
# 使用可能コマンド
以下のコマンド **のみ** 実行して良い。
これらのコマンドに対して、オプションや引数を追加・変更してはいけない。
## バージョン確認
- `docker compose run --rm web bin/rails -v`
- `docker compose run --rm web bundle info rails`
## 依存関係の更新(コア処理)
- `docker compose run --rm web bundle update railties actionpack actionview activerecord activesupport activemodel --conservative --verbose`
- `docker compose run --rm web bundle update rails --conservative --verbose`
## 依存衝突の調査(任意)
- `docker compose run --rm web bundle info <gem名>`
## ビルド
- `docker compose build web`
## 起動スモーク
- `docker compose run --rm web bin/rails r 'puts :ok'`
---
# 実行シナリオ
1. {# Step1_事前確認}
2. {# Step2_Gemfile編集}
3. {# Step3_コンポーネント更新}
4. {# Step4_Rails本体更新}
5. {# Step5_失敗時の調査(必要な場合)}
6. {# Step6_ビルドとバージョン確認}
7. {# Step7_起動スモーク}
8. {# 成功条件} / {# 失敗時の扱い} に基づいて結果を判定し、{# 出力形式} に従い JSON を出力して終了する
---
## Step1_事前確認 {# Step1_事前確認}
1. Rails 現在バージョンを確認する:
- コマンド: `docker compose run --rm web bin/rails -v`
- 正常終了した場合、出力に含まれる `Rails X.Y.Z` を読み取り、`current_rails_version_before` として記録する
- コマンド自体が失敗した場合(コンテナ起動エラーなど):
- `current_rails_version_before` を `null` とし、`failed_step: "precheck"`、`status: "failed"` として {# 出力形式} に従って JSON を出力して終了する(以降の Step には進まない)
2. Gem ととしてのバージョンを確認する:
- コマンド: `docker compose run --rm web bundle info rails`
- 正常終了した場合、その出力を用いて Gem としての Rails バージョンを補足情報として把握する
- コマンド自体が失敗した場合も、`failed_step: "precheck"`、`status: "failed"` として終了する
3. 1・2 の結果から、現在の Rails バージョンがすでに `8.0.4` の場合:
- 「すでに Rails 8.0.4 にアップデート済み」と判断し、{# 出力形式} に従って `status: "success"` を出力して終了する
- この場合、`Gemfile` や `Gemfile.lock` の更新は行わない
---
## Step2_Gemfile編集 {# Step2_Gemfile編集}
1. `Gemfile` を開き、`gem "rails", ...` を定義している行を **正確に 1 行だけ** 特定する
- 例: `gem "rails", "~> 7.2.3"`
2. この行のみを、次のように変更する:
- 変更後: `gem "rails", "~> 8.0.4"`
3. 他の gem 定義・コメント・Ruby バージョンなどは一切変更しない
4. 変更前後の行を記録し、のちに {# 出力形式} の JSON に含める(例: `rails_gem_line_before`, `rails_gem_line_after`)
---
## Step3_コンポーネント更新 {# Step3_コンポーネント更新}
1. 次のコマンドを実行する:
`docker compose run --rm web bundle update railties actionpack actionview activerecord activesupport activemodel --conservative --verbose`
2. 目的:
- `Gemfile.lock` にロックされた Rails コンポーネント群を、Rails 本体の更新前に 8.0.4 系と整合が取れる形に更新する
3. 結果判定:
- **正常終了(終了コード 0)** の場合 → {# Step4_Rails本体更新} に進む
- **エラー終了(終了コード ≠ 0)** の場合 → {# Step5_失敗時の調査} に進み、`failed_step: "bundle_update_components"` として終了する
---
## Step4_Rails本体更新 {# Step4_Rails本体更新}
1. 次のコマンドを実行する:
`docker compose run --rm web bundle update rails --conservative --verbose`
2. 目的:
- `Gemfile` の `gem "rails", "~> 8.0.4"` 指定に基づき、Rails 本体とその依存を更新する
3. 結果判定:
- **正常終了** の場合 → {# Step6_ビルドとバージョン確認} に進む
- **エラー終了** の場合 → {# Step5_失敗時の調査} に進み、`failed_step: "bundle_update_rails"` として終了する
---
## Step5_失敗時の調査 {# Step5_失敗時の調査}
このStepは **Step3または4で `bundle update` が失敗した場合のみ** 実行する。
このStepでは、**原因調査とレポート用情報の収集だけ** を行い、それ以上の修正は行わない。
1. 直前の `bundle update` のエラーログから、代表的な依存衝突メッセージを抽出する
- 例: `conflict`, `depends on`, `was resolved to`, `but needed` を含む行
2. エラーメッセージから、衝突に関わる gem 名を 1〜3 個程度特定する
- 例: `annotate`, `foo-rails`, `rack` など
3. 各問題 gem に対して、**可能であれば** 次を実行する:
- `docker compose run --rm web bundle info <問題のgem名>`
- Gemfile の依存不整合などによりこのコマンド自体がエラーになる場合は、無理に再実行せず、その時点までに得られているログだけで判断してよい。
4. 得られた情報をもとに、以下の情報を整理し、{# 出力形式} の JSON に含める:
- どの gem がどのバージョン制約を課しているか
- その制約が Rails 8.0.4 へのアップデートをどのようにブロックしているか
5. このStep完了後は、**追加の修正やコマンド実行は行わず**、`status: "failed"` として終了する
---
## Step6_ビルドとバージョン確認 {# Step6_ビルドとバージョン確認}
Step3・4が両方成功した場合のみ実行する。
1. Docker イメージをビルドする:
`docker compose build web`
- 失敗した場合:エラー要約を記録し、`failed_step: "docker_build"`、`status: "failed"` として終了する
2. Rails バージョンを再確認する:
- `docker compose run --rm web bin/rails -v`
- `docker compose run --rm web bundle info rails`
3. 両方のコマンド結果から、Rails バージョンが `8.0.4` になっていることを確認する
- どちらか一方でも `8.0.4` でない場合:`failed_step: "version_mismatch"`、`status: "failed"` として終了する
- 問題なければ、`current_rails_version_after: "8.0.4"` として記録し、{# Step7_起動スモーク} へ進む
---
## Step7_起動スモーク {# Step7_起動スモーク}
1. 次のコマンドを実行する:
`docker compose run --rm web bin/rails r 'puts :ok'`
2. コマンドが正常終了し、標準出力に `ok` が含まれていることを確認する
3. エラー終了した場合:
- エラーメッセージを要約し、`failed_step: "boot_smoke"`、`status: "failed"` として終了する
4. 正常終了し `ok` が確認できた場合:
- {# 成功条件} を満たしたものとして `status: "success"` として終了する
---
# 成功条件 {# 成功条件}
以下を **すべて満たす** 場合に、`status: "success"` としてよい。
- `Gemfile` の Rails 行が `gem "rails", "~> 8.0.4"` になっている
- Step3・4の依存解決コマンドが正常終了している
- `docker compose run --rm web bin/rails -v` および `docker compose run --rm web bundle info rails` の両方で Rails バージョンが `8.0.4` になっている
- `docker compose run --rm web bin/rails r 'puts :ok'` が正常終了し、標準出力に `ok` が含まれている
---
# 失敗時の扱い {# 失敗時の扱い}
上記の {# 成功条件} を一つでも満たせない場合は、**必ず `status: "failed"` として終了** する。
その際は、以下の情報を必ず {# 出力形式} の JSON に含める。
- `failed_step`: 失敗したStep名(例: `"precheck"`, `"bundle_update_components"`, `"bundle_update_rails"`, `"docker_build"`, `"boot_smoke"`, `"version_mismatch"` など)
- `error_summary`: エラー内容の 1〜3 文の要約
- `blocking_gems`: 依存衝突に関与していると推定される gem と、その制約の要約(わかる範囲で)
---
# 出力形式 {# 出力形式}
最終出力は **次の JSON オブジェクトのみ** を返すこと。
JSON 以外の自然言語の文章や説明は一切出力してはいけない。
```json
{
"status": "success or failed",
"current_rails_version_before": "実行前に取得した Rails のバージョン。取得できなかった場合は null。",
"current_rails_version_after": "実行後に取得した Rails のバージョン。取得できなかった場合は null。",
"rails_gem_line_before": "Gemfile 内の変更前の rails 行",
"rails_gem_line_after": "Gemfile 内の変更後の rails 行",
"commands_executed": [
"実行したコマンド文字列を、実行順にすべて列挙する(git status / git diff を実行した場合も含めてよい)"
],
"failed_step": "null もしくは 'precheck' | 'bundle_update_components' | 'bundle_update_rails' | 'docker_build' | 'boot_smoke' | 'version_mismatch'",
"error_summary": "失敗時のみ: エラー内容の1〜3文要約。成功時は null。",
"blocking_gems": [
{
"name": "依存衝突に関与している gem 名(失敗時のみ)",
"reason": "どのような制約でブロックしているか(失敗時のみ)"
}
]
}
```
以下コマンドを分けて実行している理由は、Gemfile.lock(snapshot)の固定が原因でバージョンズレ衝突が起きるため。まずRailsコンポーネント群を揃えてから、最後にrailsを更新しています。
bundle update railties actionpack actionview activerecord activesupport activemodel --conservative --verbose
docker compose run --rm web bundle update rails --conservative --verbose
ファイル差分
module Myapp
class Application < Rails::Application
# Initialize configuration defaults for originally generated Rails version.
- config.load_defaults 7.2
+ config.load_defaults 8.0
-gem "rails", "~> 7.2.3"
+gem "rails", "~> 8.0.4"
Gemfile.lock(diff)
GEM
remote: https://rubygems.org/
specs:
- actioncable (7.2.3)
- actionpack (= 7.2.3)
- activesupport (= 7.2.3)
+ actioncable (8.0.4)
+ actionpack (= 8.0.4)
+ activesupport (= 8.0.4)
nio4r (~> 2.0)
websocket-driver (>= 0.6.1)
zeitwerk (~> 2.6)
- actionmailbox (7.2.3)
- actionpack (= 7.2.3)
- activejob (= 7.2.3)
- activerecord (= 7.2.3)
- activestorage (= 7.2.3)
- activesupport (= 7.2.3)
+ actionmailbox (8.0.4)
+ actionpack (= 8.0.4)
+ activejob (= 8.0.4)
+ activerecord (= 8.0.4)
+ activestorage (= 8.0.4)
+ activesupport (= 8.0.4)
mail (>= 2.8.0)
- actionmailer (7.2.3)
- actionpack (= 7.2.3)
- actionview (= 7.2.3)
- activejob (= 7.2.3)
- activesupport (= 7.2.3)
+ actionmailer (8.0.4)
+ actionpack (= 8.0.4)
+ actionview (= 8.0.4)
+ activejob (= 8.0.4)
+ activesupport (= 8.0.4)
mail (>= 2.8.0)
rails-dom-testing (~> 2.2)
- actionpack (7.2.3)
- actionview (= 7.2.3)
- activesupport (= 7.2.3)
- cgi
+ actionpack (8.0.4)
+ actionview (= 8.0.4)
+ activesupport (= 8.0.4)
nokogiri (>= 1.8.5)
- racc
- rack (>= 2.2.4, < 3.3)
+ rack (>= 2.2.4)
rack-session (>= 1.0.1)
rack-test (>= 0.6.3)
rails-dom-testing (~> 2.2)
rails-html-sanitizer (~> 1.6)
useragent (~> 0.16)
- actiontext (7.2.3)
- actionpack (= 7.2.3)
- activerecord (= 7.2.3)
- activestorage (= 7.2.3)
- activesupport (= 7.2.3)
+ actiontext (8.0.4)
+ actionpack (= 8.0.4)
+ activerecord (= 8.0.4)
+ activestorage (= 8.0.4)
+ activesupport (= 8.0.4)
globalid (>= 0.6.0)
nokogiri (>= 1.8.5)
- actionview (7.2.3)
- activesupport (= 7.2.3)
+ actionview (8.0.4)
+ activesupport (= 8.0.4)
builder (~> 3.1)
- cgi
erubi (~> 1.11)
rails-dom-testing (~> 2.2)
rails-html-sanitizer (~> 1.6)
- activejob (7.2.3)
- activesupport (= 7.2.3)
+ activejob (8.0.4)
+ activesupport (= 8.0.4)
globalid (>= 0.3.6)
- activemodel (7.2.3)
- activesupport (= 7.2.3)
- activerecord (7.2.3)
- activemodel (= 7.2.3)
- activesupport (= 7.2.3)
+ activemodel (8.0.4)
+ activesupport (= 8.0.4)
+ activerecord (8.0.4)
+ activemodel (= 8.0.4)
+ activesupport (= 8.0.4)
timeout (>= 0.4.0)
activerecord-import (2.1.0)
activerecord (>= 4.2)
- activestorage (7.2.3)
- actionpack (= 7.2.3)
- activejob (= 7.2.3)
- activerecord (= 7.2.3)
- activesupport (= 7.2.3)
+ activestorage (8.0.4)
+ actionpack (= 8.0.4)
+ activejob (= 8.0.4)
+ activerecord (= 8.0.4)
+ activesupport (= 8.0.4)
marcel (~> 1.0)
- activesupport (7.2.3)
+ activesupport (8.0.4)
base64
benchmark (>= 0.3)
bigdecimal
@@ -76,6 +73,7 @@ GEM
minitest (>= 5.1)
securerandom (>= 0.3)
tzinfo (~> 2.0, >= 2.0.5)
+ uri (>= 0.13.1)
addressable (2.8.7)
public_suffix (>= 2.0.2, < 7.0)
alba (3.6.0)
@@ -130,7 +128,6 @@ GEM
carrierwave (>= 0.6.2)
double-bag-ftps (= 0.1.3)
net-sftp (~> 2.1.2)
- cgi (0.5.0)
childprocess (5.1.0)
logger (~> 1.5)
claide (1.1.0)
@@ -416,20 +413,20 @@ GEM
rack (>= 1.3)
rackup (2.2.1)
rack (>= 3)
- rails (7.2.3)
- actioncable (= 7.2.3)
- actionmailbox (= 7.2.3)
- actionmailer (= 7.2.3)
- actionpack (= 7.2.3)
- actiontext (= 7.2.3)
- actionview (= 7.2.3)
- activejob (= 7.2.3)
- activemodel (= 7.2.3)
- activerecord (= 7.2.3)
- activestorage (= 7.2.3)
- activesupport (= 7.2.3)
+ rails (8.0.4)
+ actioncable (= 8.0.4)
+ actionmailbox (= 8.0.4)
+ actionmailer (= 8.0.4)
+ actionpack (= 8.0.4)
+ actiontext (= 8.0.4)
+ actionview (= 8.0.4)
+ activejob (= 8.0.4)
+ activemodel (= 8.0.4)
+ activerecord (= 8.0.4)
+ activestorage (= 8.0.4)
+ activesupport (= 8.0.4)
bundler (>= 1.15.0)
- railties (= 7.2.3)
+ railties (= 8.0.4)
rails-dom-testing (2.3.0)
activesupport (>= 5.0.0)
minitest
@@ -437,10 +434,9 @@ GEM
rails-html-sanitizer (1.6.2)
loofah (~> 2.21)
nokogiri (>= 1.15.7, != 1.16.7, != 1.16.6, != 1.16.5, != 1.16.4, != 1.16.3, != 1.16.2, != 1.16.1, != 1.16.0.rc1, != 1.16.0)
- railties (7.2.3)
- actionpack (= 7.2.3)
- activesupport (= 7.2.3)
- cgi
+ railties (8.0.4)
+ actionpack (= 8.0.4)
+ activesupport (= 8.0.4)
irb (~> 1.13)
rackup (>= 1.0.0)
rake (>= 12.2)
@@ -623,7 +619,7 @@ DEPENDENCIES
pry-rails
puma (~> 7.0)
rack-cors
- rails (~> 7.2.3)
+ rails (~> 8.0.4)
redis (~> 5.0)
rubocop
rubocop-minitest
手動でのマイグレーション実行後
- ActiveRecord::Schema[7.2].define(version: 2025_11_10_073541) do
+ ActiveRecord::Schema[8.0].define(version: 2025_11_10_073541) do
# These are extensions that must be enabled in order to support this database
- enable_extension "plpgsql"
+ enable_extension "pg_catalog.plpgsql"
プロンプト2(影響調査)
-
Rails 8.0.4へのアップデートに伴う SCAN(影響調査)- 目的
- 公式ドキュメントベースで変更点・影響点を洗い出す
- 次フェーズ(TEST + FIX)のための「検索パターン」「修正計画」「パッチ案」を用意する
- アプリ本体にはまだ手を入れず、
tmp/rails_update以下に成果物を集約する
- 概要
- Step1:環境確認
- Step2:tmp ディレクトリ準備
- Step3:
new_framework_defaults_8_0.rb取得 - Step4:公式ドキュメント取得 & 変更点の整理
- Step5:
patterns.txt作成 - Step6:
fix_plan.json作成 - Step7:
diff_*.patchのドラフト作成
- 目的
rails-7.2.3_to-8.0.4_update_prompt2.md
# 依頼
あなたは {# 役割} です。
{# ルール} を必ず守り、{# 実行シナリオ} に従って、Rails 8.0.4 へのアップデートに伴う **SCAN(影響調査)** を実行してください。
作業の結果は、最後に {# 出力形式} に示す **JSON 形式** でのみ出力してください。
---
# 役割 {# 役割}
- Docker 環境上で動作する Rails アプリケーションの **Rails 8.0.4 アップデート SCAN 専用エージェント**
- 対象タスクは以下に限定する:
- 公式情報(Release Notes・CHANGELOG・new framework defaults・Upgrading Guide)に基づく **影響把握**
- 横断検索パターン(`patterns.txt`)の定義
- 修正計画 JSON(`fix_plan.json`)の作成
- 修正案 diff(パッチファイル)のドラフト作成
- アプリ本体コードや設定ファイルの変更、テスト実行、Lint 実行は **担当外**(別プロンプトが実施)
---
# 環境 {# 環境}
- 実行場所: リポジトリ直下(プロジェクトルート)
- バックエンド: すでに **Rails 8.0.4 にアップデート済み** であることが期待される
(ただし Step1 で必ずコマンドから実際のバージョンを確認する)
- インフラ: Docker Compose / サービス名 `web`
- `Gemfile` / `Gemfile.lock` はプロジェクトルートに存在する
- 一時ファイル格納用ディレクトリとして、以下のパスを使用する:
- `tmp/rails_update`(ディレクトリ)
- `tmp/rails_update/patterns.txt`
- `tmp/rails_update/fix_plan.json`
- `tmp/rails_update/new_framework_defaults_8_0.rb`(参考用)
- `tmp/rails_update/diff_*.patch`(diff ドラフト群)
`tmp/rails_update` が存在しない場合は、作成してよい(`mkdir -p tmp/rails_update`)。
---
# 判断根拠(限定) {# 判断根拠}
Rails 8.0.4 の影響調査において、参照してよい情報源は **次の公式ソースのみ** とする。
これら以外のブログ記事・Qiita・Zenn 等は参照してはいけない。
- Rails 8.0 Release Notes
https://railsguides.jp/8_0_release_notes.html
- Rails Upgrading Guide
https://guides.rubyonrails.org/v8.0/upgrading_ruby_on_rails.html
- rails/rails 8-0-stable 各 CHANGELOG
- https://github.com/rails/rails/blob/8-0-stable/railties/CHANGELOG.md
- https://github.com/rails/rails/blob/8-0-stable/actioncable/CHANGELOG.md
- https://github.com/rails/rails/blob/8-0-stable/actionpack/CHANGELOG.md
- https://github.com/rails/rails/blob/8-0-stable/actionview/CHANGELOG.md
- https://github.com/rails/rails/blob/8-0-stable/actionmailer/CHANGELOG.md
- https://github.com/rails/rails/blob/8-0-stable/activerecord/CHANGELOG.md
- https://github.com/rails/rails/blob/8-0-stable/activestorage/CHANGELOG.md
- https://github.com/rails/rails/blob/8-0-stable/activemodel/CHANGELOG.md
- https://github.com/rails/rails/blob/8-0-stable/activesupport/CHANGELOG.md
- https://github.com/rails/rails/blob/8-0-stable/activejob/CHANGELOG.md
- https://github.com/rails/rails/blob/8-0-stable/actionmailbox/CHANGELOG.md
- `config/initializers/new_framework_defaults_8_0.rb` の原文(後述の一時コピーから取得するもの)
補足:
- `new_framework_defaults_8_0.rb` は、`config.load_defaults 8.0` を有効にしたときに **新しく有効化されるフレームワークデフォルト候補の一覧** である。
現時点のアプリではコメントアウトされている前提で、「将来有効化するかどうかを検討する設定」として扱うこと。
- 上記に列挙した URL 群(Release Notes 1 件 + Upgrading Guide 1 件 + CHANGELOG 11 件の合計 13 件)は、SCAN 実行時に **すべて最低 1 回は取得し、内容を確認しなければならない**。
特定コンポーネントの利用頻度が低いと推定される場合でも、Rails 全体の変更点把握のために一度は走査すること。
- Step4 では、これら 13 件を「公式ドキュメント URL 一覧」として内部的に列挙し、**13 件すべての fetch が完了するまで Step5 以降の処理に進んではならない**。
1 件でも再試行後に取得できない URL が残った場合、`failed_step: "official_docs_fetch"` としてこのプロンプトの処理を終了する。
**上記以外の情報源は使用禁止** とする。
`fix_plan.json` の `rationale_url` には、必ず上記のいずれか(該当セクションのアンカー付き URL)を使用すること。
---
# ルール {# ルール}
1. **対話禁止**
- ユーザーへの質問・確認・追加入力依頼を一切行わない。
2. **Git 操作の制限**
- 禁止: `git add`, `git commit`, `git push`
- 許可: 確認目的の `git status`, `git diff`
- これらは状態確認だけに使い、ファイル変更の判断材料にとどめる。
- このプロンプトでは、アプリ本体ファイルへの変更は行わない。
3. **変更対象の制限**
- アプリ本体のコードや設定 (`app/**`, `config/**` など) を **直接変更してはいけない**。
- 新規に作成してよいのは **`tmp/rails_update/` 配下のファイルのみ**。
- `tmp/rails_update` 以外のディレクトリに、一時ファイルやログファイルを作成してはいけない。
4. **テスト / Lint の禁止**
- `rails test`, `bundle exec rspec` 等のテストコマンドは **一切実行してはいけない**。
- `rubocop` 等の Lint 系コマンドも **一切実行してはいけない**。
- テストと Lint は次のプロンプト(TEST + FIX + D-CHECK)が担当する。
5. **使用コマンドの制限**
- {# 使用可能コマンド} に列挙されたコマンド **のみ**(+ `ls`, `cat`, `mkdir -p` 等の軽いファイル確認コマンド)を実行してよい。
- 列挙されたコマンドに対して **オプションや引数を追加・変更してはいけない**。
- 重い処理を伴う追加コマンド(データベースマイグレーションなど)は実行禁止。
6. **プレースホルダの扱い**
- `<...>` で囲まれたプレースホルダ(例: `<問題のgem名>`)は、実行時には必ず **具体的な値に置き換えて** 実行する。
- プレースホルダ文字列のままコマンドを実行してはいけない。
7. **diff の扱い**
- このプロンプトでは **アプリ本体に diff を適用しない**。
- 代わりに、`tmp/rails_update/diff_*.patch` として **unified diff 形式のパッチファイルをテキストとして保存するだけ** とする。
- diff の実際の適用は、次のプロンプト(TEST + FIX + D-CHECK)が担当する。
8. **ログ・テキスト量の制御**
- `patterns.txt`, `fix_plan.json`, `diff_*.patch` には、過度に冗長なコメントや長大なログを埋め込まない。
- エラー内容や注意事項は、意味のある要約のみを記載する。
9. **終了条件**
- {# 成功条件} を満たした場合のみ `status: "success"` として終了する。
- 条件を満たせなかった場合は `status: "failed"` とし、{# 失敗時の扱い} に従い原因を整理して終了する。
---
# 使用可能コマンド {# 使用可能コマンド}
以下のコマンド **のみ**(+ `ls`, `cat`, `mkdir -p` などの軽いファイル確認用コマンド)実行してよい。
これらのコマンドに対して、オプションや引数を追加・変更してはいけない。
## Rails バージョン確認
- `docker compose run --rm web bin/rails -v`
## new framework defaults の取得(実リポジトリを変更しない一時コピー方式)
- `docker compose run --no-deps --rm web sh -lc 'set -eu; tmpdir=\"$(mktemp -d)\"; mkdir -p \"$tmpdir/app\"; tar -C . --exclude=.git --exclude=node_modules --exclude=log --exclude=tmp --exclude=vendor/cache -cf - . | tar -C \"$tmpdir/app\" -xf -; cd \"$tmpdir/app\"; bundle exec rails app:update --force; [ -f config/initializers/new_framework_defaults_8_0.rb ] && cat config/initializers/new_framework_defaults_8_0.rb || { echo \"new_framework_defaults_8_0.rb not found\" >&2; exit 1; }'`
(上記コマンドの標準出力は後続処理で `tmp/rails_update/new_framework_defaults_8_0.rb` として保存する)
## ファイル操作
- `mkdir -p tmp/rails_update`
---
# 実行シナリオ {# 実行シナリオ}
1. {# Step1_環境確認}
2. {# Step2_tmpディレクトリ準備}
3. {# Step3_new_defaults取得}
4. {# Step4_公式ドキュメント取得と影響まとめ表作成}
5. {# Step5_patterns_txt作成}
6. {# Step6_fix_plan_json作成}
7. {# Step7_diffドラフト作成}
8. {# 成功条件} / {# 失敗時の扱い} に基づいて結果を判定し、{# 出力形式} に従い JSON を出力して終了する
---
## Step1_環境確認 {# Step1_環境確認}
1. Rails 現在バージョンを確認する:
- コマンド: `docker compose run --rm web bin/rails -v`
- 正常終了した場合、出力に含まれる `Rails X.Y.Z` を読み取り、`rails_version` として記録する。
- コマンド自体が失敗した場合:`failed_step: "precheck"`, `status: "failed"` として終了する。
2. `rails_version` が `8.0.4` でない場合:
- 「Rails が 8.0.4 にアップデートされていないため、SCAN を実行できない」と判断する。
- `failed_step: "precheck"`, `status: "failed"` とし、`error_summary` に簡潔な説明を記載して終了する。
---
## Step2_tmpディレクトリ準備 {# Step2_tmpディレクトリ準備}
1. `tmp/rails_update` ディレクトリを作成する(存在する場合は何もしない):
- コマンド: `mkdir -p tmp/rails_update`
2. 以降で作成するファイルは **すべて `tmp/rails_update` 配下** に保存する。
---
## Step3_new_defaults取得 {# Step3_new_defaults取得}
1. {# 使用可能コマンド} に示した一時コピー用コマンドを実行し、
一時ディレクトリ上で `rails app:update --force` を実行して
`config/initializers/new_framework_defaults_8_0.rb` の内容を取得する。
2. コマンドが成功し、`new_framework_defaults_8_0.rb` の内容が取得できた場合:
- その内容を `tmp/rails_update/new_framework_defaults_8_0.rb` として保存する。
3. コマンドが失敗した場合:
- `failed_step: "new_defaults_fetch"`, `status: "failed"` として終了する(以降の Step には進まない)。
---
## Step4_公式ドキュメント取得と影響まとめ表作成 {# Step4_影響まとめ表作成}
1. {# 判断根拠} に挙げた公式ソースのうち、HTTP 経由で取得する 13 件の URL(Release Notes 1 件 + Upgrading Guide 1 件 + CHANGELOG 11 件)を、**公式ドキュメント URL 一覧**として内部的に列挙する。
- 例: `official_docs_urls = [ "https://railsguides.jp/8_0_release_notes.html", ..., "https://github.com/rails/rails/blob/8-0-stable/actionmailbox/CHANGELOG.md" ]`
- この一覧の件数は必ず 13 件でなければならない。
2. `official_docs_urls` の各 URL について、**少なくとも 1 回は内容を fetch し、主要な変更点を把握する**。
- すべての URL について fetch が成功するまで、Step5 以降に進んではならない。
- 一部の URL で一時的なエラーが発生した場合は、同じ URL に対して適切な範囲で再試行してもよい。
3. 再試行を行っても取得できない URL が 1 件以上残った場合:
- この時点で処理を中断し、`failed_step: "official_docs_fetch"`, `status: "failed"` として終了する。
- `error_summary` には「どの URL を取得できなかったか」を 1〜3 文で要約して記載する。
4. 13 件すべての official docs を取得できた場合のみ、以下の影響整理に進む。
5. 取得した公式ソース(Release Notes・各 CHANGELOG・Upgrading Guide・`new_framework_defaults_8_0.rb`)から、
Rails 8.0.4 で追加・変更された項目を収集する。
6. 収集した項目を次の 3 種類に分類する:
- `Brk`(Breaking):**既存コードがそのままでは動かなくなる可能性が高い変更(設定削除・旧 API の削除・互換性のない挙動変更など)**
- `Dep`(Deprecation):非推奨化された API やオプション(現時点では動くが、将来削除予定のもの)
- `Default`(デフォルト変更):設定や挙動のデフォルト値が変わるもの(`new_framework_defaults_8_0.rb` 由来の項目を含む)
補足:
- **純粋に新しい API 追加(例: `params.expect`)のみで、従来の API がいきなり削除されていないものは `Brk` に分類しない。**
必要であれば `Dep` または `Default` として「将来的に移行を検討する項目」として記録するか、fix_plan の対象外としてもよい。
- `new_framework_defaults_8_0.rb` 由来の項目は、`Default` として「この設定を今後有効にするか / 既存挙動を維持するか」を判断するための情報として整理する。
7. 各項目について、最低限以下の情報を整理する(後続 Step で `fix_plan.json` に反映する):
- `component`(例: `ActiveRecord`, `ActionPack`, `ActiveSupport` 等)
- `type`(`Brk` / `Dep` / `Default`)
- `title`(簡潔な説明)
- `rationale_url`(該当 CHANGELOG / Release Notes / Upgrading Guide / new_defaults の URL)
- `priority`(`High` / `Medium` / `Low`)
- `fix_strategy`(後続 Step で詳細化)
- `risk_notes`(影響範囲・注意点)
この時点では、これらの情報は **内部的なメモ** として保持し、
実際のファイル出力は Step6(`fix_plan.json` 作成)で行う。
---
## Step5_patterns_txt作成 {# Step5_patterns_txt作成}
1. Step4 で整理した影響リストをもとに、コードベース全体を横断的に検索するための **検索パターン** を設計する。
2. 各パターンは、少なくとも以下の情報を含むテキストブロックとして `tmp/rails_update/patterns.txt` に書き出す:
例:
```text
[PATTERN]
name: active_support_deprecation_behavior
kind: Dep
search: ActiveSupport::Deprecation.behavior
include_examples:
- config/initializers/deprecation.rb
exclude_patterns:
- "# no-op"
notes:
- "Rails 8.0 の new framework defaults では、非推奨の使い方がないか確認するための検索パターン"
```
3. 各パターンには、できるだけ以下を含める:
- `name`: 人間と次プロンプトのエージェントが見てわかる名前
- `kind`: `Brk` / `Dep` / `Default` のいずれか
- `search`: 実際に grep / ripgrep 等で探すときに使えるキーワードや正規表現
- `include_examples`: 想定される命中例(パス例やコード例)
- `exclude_patterns`: 誤検知を避けるための除外パターン(あれば)
- `notes`: 誤検知注意点や補足(`new framework defaults` 由来のものは、その前提もコメントで明示する)
4. `patterns.txt` には少なくとも **いくつかの重要な Deprecation / Default 変更分** を含めること。
全網羅でなくてよいが、8.0.4 で実害が出やすいものを優先する。
---
## Step6_fix_plan_json作成 {# Step6_fix_plan_json作成}
1. Step4 の影響リストと Step5 の検索パターンをもとに、`fix_plan.json` を {# 修正計画JSON_SCHEMA} に準拠した形で作成し、
`tmp/rails_update/fix_plan.json` に保存する。
2. SCAN フェーズではまだテストを実行しないため:
- `test_failures_linked`: 空配列 `[]` とする。
- `attempts`: `0`。
- `last_error_signature`: 空文字列または省略。
- `status`: すべて `"pending"` として初期化する。
3. `new_framework_defaults_8_0.rb` 由来の `type: "Default"` 項目については:
- 「今すぐ既存挙動を維持するために設定を明示する必要があるか」
「将来 `config.load_defaults 8.0` を有効にする際に検討すべき項目か」を `fix_strategy` / `risk_notes` に明記する。
- 現時点で即時対応不要なものは `priority: "Medium"` または `"Low"` としてよい。
4. 可能であれば、`file_hits_sample` に簡単なサンプルパス(候補箇所)を入れてもよいが、必須ではない。
5. **プロジェクト固有の既知ブレイク(test_helper)の fix_plan エントリ**
本プロジェクトでは、Rails 7.2.3 → 8.0.4 への更新時に、テスト実行前にルーティングが確実にロードされるようにするため、`test/test_helper.rb` に次の 1 行を追加することが必須である。
```ruby
Rails.application.routes_reloader.execute_unless_loaded
```
この既知ブレイクに対応する `fix_plan` のエントリを **必ず 1 件含めること**。このエントリは少なくとも以下の条件を満たす:
- `component`: `"Test"` など、テストヘルパであることが分かる値
- `type`: `"Brk"`
- `priority`: `"High"`
- `title`: 例) `"test_helper で routes_reloader を明示的に実行する"`
- `rationale_url`: Rails Upgrading Guide など、本プロンプトで許可された URL(例: `https://guides.rubyonrails.org/v8.0/upgrading_ruby_on_rails.html`)
- `fix_strategy`:
`test/test_helper.rb` において、`require_relative "../config/environment"` の直後に `Rails.application.routes_reloader.execute_unless_loaded` を 1 行追加するパッチ(`tmp/rails_update/diff_000_test_helper_routes_reloader.patch`)を適用する、という方針を日本語で明記する。
- `status`: `"pending"`
- `attempts`: `0`
- `test_failures_linked`: `[]`
---
## Step7_diffドラフト作成 {# Step7_diffドラフト作成}
1. `fix_plan.json` の各項目(特に `priority: "High"` のもの)について、
実際に適用が想定される **unified diff 形式のパッチファイル** を `tmp/rails_update/diff_XXX_*.patch` として作成する。
- `diff_000_test_helper_routes_reloader.patch` はプロジェクト固有の予約 ID として必ず作成する。
- それとは別に、**少なくとも 3 つ以上**、他のエントリに対応する `diff_001_...`, `diff_002_...` などのパッチを作成すること。
2. ファイル命名規則の例:
- `tmp/rails_update/diff_001_active_job_enqueue_after_transaction_commit.patch`
- `tmp/rails_update/diff_002_active_record_pg_date_decoder.patch`
3. 各パッチファイルは、以下の形式を守る:
- 先頭に `--- a/path/to/file.rb` / `+++ b/path/to/file.rb`
- `@@` から始まる hunk 単位で変更内容を記述
4. パスの扱い:
- 可能な限り、**実際のアプリケーション内に存在するファイルパス**(例: `app/models/user.rb`, `config/application.rb`)を指定する。
- もし実在ファイルを特定できない場合は、`doc/rails8_examples/` 配下など、
「サンプルコード用であることが明確な仮想パス」(例: `doc/rails8_examples/example_time_calculation.rb`)を用いてよい。
- いずれの場合も、**実際のファイルにはまだ適用しない**。このプロンプトはあくまでドラフト作成のみを担当する。
5. diff の内容は「次の TEST+FIX プロンプトが採用するための候補」であり、
必ずしも最終形でなくてよいが、**具体的で実行可能な案** にすること。
6. `type: "Default"` の項目については、以下の方針で diff を作成する:
- `priority: "High"` かつ、新しいデフォルトが既存挙動を壊すリスクが高い場合
→ **「既存の挙動を明示的に維持する設定」** を追加するパッチを優先する
(例: `config.active_job.enqueue_after_transaction_commit = :never`,
`config.active_record.postgresql_adapter_decode_dates = false` など)
- `priority: "Medium"` / `"Low"` の場合
→ 新しいデフォルトを有効にする案・既存挙動を維持する案のどちらを取るかを
`fix_strategy` / `risk_notes` に沿って選び、コメントで意図を明示する
(例: 「本番環境では validate_migration_timestamps を有効化推奨」など)
7. 生成した diff ファイルパスは、後の {# 出力形式} の JSON に `diff_files` として列挙する。
8. **プロジェクト固有の diff(test_helper)の作成**
`test/test_helper.rb` に `Rails.application.routes_reloader.execute_unless_loaded` を追加するためのパッチを、**必ず次の内容で** `tmp/rails_update/diff_000_test_helper_routes_reloader.patch` として作成すること。
```diff
--- a/test/test_helper.rb
+++ b/test/test_helper.rb
@@ -12,6 +12,9 @@ end
ENV["RAILS_ENV"] ||= "test"
require_relative "../config/environment"
+
+# Rails 8 の test/dev では routes が遅延読み込みされるため、*_path ヘルパーを使う前に一度だけ routes をロードする
+Rails.application.routes_reloader.execute_unless_loaded
+
require "rails/test_help"
require "mocha/minitest"
require "minitest/reporters"
```
- この diff は、`require_relative "../config/environment"` の直後に 1 行だけ `Rails.application.routes_reloader.execute_unless_loaded` を追加するものであり、**SCAN を何度実行しても同じ内容・同じファイルパスで生成すること**。
- 他の `diff_*.patch` を追加で生成してもよいが、`diff_000_test_helper_routes_reloader.patch` は常に存在していなければならない。
---
# 修正計画 JSON の SCHEMA {# 修正計画JSON_SCHEMA}
`fix_plan.json` は以下の SCHEMA に準拠して作成する。
```SCHEMA
{
"type": "array",
"items": {
"type": "object",
"required": [
"component",
"type",
"title",
"rationale_url",
"priority",
"fix_strategy"
],
"properties": {
"component": { "type": "string" },
"type": { "type": "string", "enum": ["Brk", "Dep", "Default"] },
"title": { "type": "string" },
"rationale_url": { "type": "string", "format": "uri" },
"priority": { "type": "string", "enum": ["High", "Medium", "Low"] },
"dependencies": { "type": "array", "items": { "type": "string" } },
"file_hits_sample": { "type": "array", "items": { "type": "string" } },
"test_failures_linked": { "type": "array", "items": { "type": "string" } },
"fix_strategy": { "type": "string" },
"risk_notes": { "type": "string" },
"attempts": { "type": "integer", "minimum": 0 },
"last_error_signature": { "type": "string" },
"status": { "type": "string", "enum": ["pending", "in_progress", "fixed", "stuck"] }
},
"additionalProperties": false
}
}
```
---
# 成功条件 {# 成功条件}
以下を **すべて満たす** 場合に、`status: "success"` としてよい。
- Rails の実行バージョンが `8.0.4` であることを確認済み。
- {# 判断根拠} に列挙した 13 件の公式 URL について、Step4 で全件の fetch が成功している(1 件も取得失敗した URL がない)。
- `tmp/rails_update/patterns.txt` が存在し、1 行以上のパターン定義が含まれている。
- `tmp/rails_update/fix_plan.json` が {# 修正計画JSON_SCHEMA} に準拠した JSON として保存されている。
- `tmp/rails_update/new_framework_defaults_8_0.rb` が取得・保存されている。
- `tmp/rails_update/diff_*.patch` が **4 つ以上** 存在し、unified diff 形式になっている(うち 1 つは `diff_000_test_helper_routes_reloader.patch`)。
- `tmp/rails_update/diff_000_test_helper_routes_reloader.patch` が存在し、その内容が {# Step7_diffドラフト作成}.8 で示した unified diff と論理的に同等(`require_relative "../config/environment"` の直後に `Rails.application.routes_reloader.execute_unless_loaded` を追加する内容)である。
---
# 失敗時の扱い {# 失敗時の扱い}
上記の {# 成功条件} を一つでも満たせない場合は、**必ず `status: "failed"` として終了** する。
その際は、以下の情報を必ず {# 出力形式} の JSON に含める。
- `failed_step`: 失敗した Step 名(例: `"precheck"`, `"new_defaults_fetch"`, `"official_docs_fetch"`, `"patterns"`, `"fix_plan"`, `"diff_generation"` など)
- `error_summary`: エラー内容の 1〜3 文の要約
---
# 出力形式 {# 出力形式}
最終出力は **次の JSON オブジェクトのみ** を返すこと。
JSON 以外の自然言語の文章や説明は一切出力してはいけない。
```json
{
"status": "success or failed",
"rails_version": "docker compose run --rm web bin/rails -v で確認したバージョン。取得できなかった場合は null。",
"tmp_dir": "tmp/rails_update",
"patterns_file": "tmp/rails_update/patterns.txt が存在する場合はそのパス。存在しない場合は null。",
"fix_plan_file": "tmp/rails_update/fix_plan.json が存在する場合はそのパス。存在しない場合は null。",
"new_defaults_file": "tmp/rails_update/new_framework_defaults_8_0.rb が存在する場合はそのパス。存在しない場合は null。",
"diff_files": [
"tmp/rails_update/diff_001_....patch",
"tmp/rails_update/diff_002_....patch"
],
"failed_step": "null もしくは 'precheck' | 'new_defaults_fetch' | 'official_docs_fetch' | 'patterns' | 'fix_plan' | 'diff_generation'",
"error_summary": "失敗時のみ: エラー内容の1〜3文要約。成功時は null。"
}
```
ファイル差分
tmp/rails_update/new_framework_defaults_8_0.rb
# Be sure to restart your server when you modify this file.
#
# This file eases your Rails 8.0 framework defaults upgrade.
#
# Uncomment each configuration one by one to switch to the new default.
# Once your application is ready to run with all new defaults, you can remove
# this file and set the `config.load_defaults` to `8.0`.
#
# Read the Guide for Upgrading Ruby on Rails for more info on each option.
# https://guides.rubyonrails.org/upgrading_ruby_on_rails.html
###
# Specifies whether `to_time` methods preserve the UTC offset of their receivers or preserves the timezone.
# If set to `:zone`, `to_time` methods will use the timezone of their receivers.
# If set to `:offset`, `to_time` methods will use the UTC offset.
# If `false`, `to_time` methods will convert to the local system UTC offset instead.
#++
# Rails.application.config.active_support.to_time_preserves_timezone = :zone
###
# When both `If-Modified-Since` and `If-None-Match` are provided by the client
# only consider `If-None-Match` as specified by RFC 7232 Section 6.
# If set to `false` both conditions need to be satisfied.
#++
# Rails.application.config.action_dispatch.strict_freshness = true
###
# Set `Regexp.timeout` to `1`s by default to improve security over Regexp Denial-of-Service attacks.
#++
# Regexp.timeout = 1
tmp/rails_update/patterns.txt
[PATTERN]
name: test_helper_routes_reloader
kind: Brk
search: require_relative "../config/environment"
include_examples:
- test/test_helper.rb
notes:
- "Rails 8.0では、test/dev環境でroutesが遅延読み込みされるため、*_pathヘルパー使用前にroutes_reloaderを明示的に実行する必要がある"
- "test/test_helper.rbにて、require_relative \"../config/environment\"の直後にRails.application.routes_reloader.execute_unless_loadedを追加"
[PATTERN]
name: regexp_timeout_default
kind: Default
search: Regexp.timeout
include_examples:
- config/application.rb
- config/initializers/*.rb
notes:
- "Rails 8.0.0.rc2でRegexp.timeoutがデフォルトで1秒に設定される(Regexp DoS攻撃対策)"
- "正規表現処理に1秒以上かかる場合はタイムアウトする可能性がある"
[PATTERN]
name: to_time_preserves_timezone
kind: Default
search: to_time_preserves_timezone
include_examples:
- config/initializers/new_framework_defaults_8_0.rb
notes:
- "new_framework_defaults_8_0.rbで:zoneがデフォルト値として推奨される"
- "既存の挙動を維持する場合はconfig.active_support.to_time_preserves_timezone = :offsetを設定"
[PATTERN]
name: action_dispatch_strict_freshness
kind: Default
search: strict_freshness
include_examples:
- config/initializers/new_framework_defaults_8_0.rb
notes:
- "If-Modified-SinceとIf-None-Matchの両方が提供された場合、If-None-Matchのみを考慮する(RFC 7232準拠)"
- "既存の挙動を維持する場合はconfig.action_dispatch.strict_freshness = falseを設定"
[PATTERN]
name: params_expect_method
kind: Dep
search: params.require
include_examples:
- app/controllers/**/*.rb
notes:
- "params.expect(...)がparams.require(...).permit(...)の代替として導入された"
- "より安全で明示的なパラメータ処理が可能"
- "params.require(:id)はparams.expect(:id)に置き換え推奨"
[PATTERN]
name: activerecord_encryption_default
kind: Default
search: ActiveRecord::Encryption
include_examples:
- config/initializers/*.rb
notes:
- "Active Record EncryptionがSHA-256をデフォルトのハッシュダイジェストとして使用"
- "Rails 7.1以前のデータがある場合はconfig.active_record.encryption.hash_digest_class設定を確認"
tmp/rails_update/fix_plan.json
[
{
"component": "Test",
"type": "Brk",
"title": "test_helperでroutes_reloaderを明示的に実行する",
"rationale_url": "https://guides.rubyonrails.org/v8.0/upgrading_ruby_on_rails.html#upgrading-from-rails-7-2-to-rails-8-0",
"priority": "High",
"dependencies": [],
"file_hits_sample": ["test/test_helper.rb"],
"test_failures_linked": [],
"fix_strategy": "test/test_helper.rbにおいて、require_relative \"../config/environment\"の直後にRails.application.routes_reloader.execute_unless_loadedを1行追加する。これにより、Rails 8.0のtest/dev環境でroutesが遅延読み込みされる仕様に対応し、*_pathヘルパー使用前にroutesが確実にロードされるようになる。対応パッチ: tmp/rails_update/diff_000_test_helper_routes_reloader.patch",
"risk_notes": "このプロジェクト固有の既知ブレイク。Rails 8.0ではtest/dev環境でroutingが遅延読み込みされるため、テスト実行前にroutes_reloaderを明示的に呼び出す必要がある。適用しない場合、*_pathヘルパーを使用するテストが失敗する可能性が高い。",
"attempts": 0,
"last_error_signature": "",
"status": "pending"
},
{
"component": "Railties",
"type": "Default",
"title": "Regexp.timeoutのデフォルト値が1秒に設定",
"rationale_url": "https://github.com/rails/rails/blob/8-0-stable/railties/CHANGELOG.md#rails-800rc2-october-30-2024",
"priority": "Medium",
"dependencies": [],
"file_hits_sample": [],
"test_failures_linked": [],
"fix_strategy": "Regexp.timeoutはデフォルトで1秒に設定される。正規表現処理に1秒以上かかる可能性がある場合は、個別にRegexp.timeout値を調整するか、グローバルに変更する。通常は変更不要だが、複雑な正規表現を使用している場合は注意が必要。",
"risk_notes": "Regexp DoS攻撃対策として導入。正規表現処理に1秒以上かかる場合はRegexp::TimeoutErrorが発生する可能性がある。ただし、通常のアプリケーションでは影響は少ないと想定される。",
"attempts": 0,
"last_error_signature": "",
"status": "pending"
},
{
"component": "ActiveSupport",
"type": "Default",
"title": "to_time_preserves_timezoneのデフォルト値が:zoneに変更",
"rationale_url": "https://guides.rubyonrails.org/v8.0/upgrading_ruby_on_rails.html#upgrading-from-rails-7-2-to-rails-8-0",
"priority": "Low",
"dependencies": [],
"file_hits_sample": ["config/initializers/new_framework_defaults_8_0.rb"],
"test_failures_linked": [],
"fix_strategy": "新しいデフォルト(:zone)を採用するか、既存の挙動(:offset)を維持するかを選択する。config.load_defaults 8.0を有効にする際に、config.active_support.to_time_preserves_timezone = :offsetを明示的に設定することで既存挙動を維持できる。タイムゾーン処理に依存するテストがある場合は検証が必要。",
"risk_notes": "to_timeメソッドの挙動がタイムゾーンを保持する方式に変わる。多くの場合は影響なしだが、タイムゾーン変換に依存するロジックがある場合は動作確認が必要。",
"attempts": 0,
"last_error_signature": "",
"status": "pending"
},
{
"component": "ActionPack",
"type": "Default",
"title": "action_dispatch.strict_freshnessのデフォルトがtrueに変更",
"rationale_url": "https://guides.rubyonrails.org/v8.0/upgrading_ruby_on_rails.html#upgrading-from-rails-7-2-to-rails-8-0",
"priority": "Low",
"dependencies": [],
"file_hits_sample": ["config/initializers/new_framework_defaults_8_0.rb"],
"test_failures_linked": [],
"fix_strategy": "RFC 7232準拠の新しいデフォルト(If-None-Matchを優先)を採用するか、既存の挙動(両方の条件を満たす必要がある)を維持するかを選択する。config.load_defaults 8.0を有効にする際に、config.action_dispatch.strict_freshness = falseを明示的に設定することで既存挙動を維持できる。",
"risk_notes": "If-Modified-SinceとIf-None-Matchの両方が提供された場合の処理方法が変わる。通常のキャッシュ処理では影響は少ないが、キャッシュ検証ロジックに依存する場合は確認が必要。",
"attempts": 0,
"last_error_signature": "",
"status": "pending"
},
{
"component": "ActionPack",
"type": "Dep",
"title": "params.expectメソッドの導入とparams.requireの今後の扱い",
"rationale_url": "https://github.com/rails/rails/blob/8-0-stable/actionpack/CHANGELOG.md#rails-800beta1-september-26-2024",
"priority": "Medium",
"dependencies": [],
"file_hits_sample": ["app/controllers/**/*.rb"],
"test_failures_linked": [],
"fix_strategy": "params.expect(...)はparams.require(...).permit(...)のより安全な代替として導入された。現時点ではparams.requireは非推奨ではないが、将来的な移行を見据えて、新規コードや重要なコントローラーから段階的にparams.expectに移行することを推奨。特にparams.require(:id)のようなスカラー値の要求はparams.expect(:id)に置き換えることで型安全性が向上する。",
"risk_notes": "params.expectは外部ユーザーによるパラメータ改ざん時に500エラーではなく400エラーを返すため、セキュリティとエラーハンドリングが改善される。ただし、現時点では必須の変更ではなく、段階的な移行で対応可能。",
"attempts": 0,
"last_error_signature": "",
"status": "pending"
},
{
"component": "ActiveRecord",
"type": "Default",
"title": "Active Record Encryptionのハッシュダイジェストアルゴリズムの変更",
"rationale_url": "https://guides.rubyonrails.org/v8.0/upgrading_ruby_on_rails.html#active-record-encryption-algorithm-changes",
"priority": "Medium",
"dependencies": [],
"file_hits_sample": [],
"test_failures_linked": [],
"fix_strategy": "Active Record EncryptionはSHA-256をデフォルトのハッシュダイジェストとして使用するようになった。Rails 7.1以前から暗号化されたデータがある場合は、config.active_record.encryption.hash_digest_class = OpenSSL::Digest::SHA1の設定を追加して既存データの復号化を保証する。または、config.active_record.encryption.support_sha1_for_non_deterministic_encryption = trueを設定する。",
"risk_notes": "既存の暗号化データがある場合、設定なしではデータ復号化に失敗する可能性がある。Active Record Encryptionを使用していない場合は影響なし。",
"attempts": 0,
"last_error_signature": "",
"status": "pending"
}
]
tmp/rails_update/diff_000_test_helper_routes_reloader.patch
--- a/test/test_helper.rb
+++ b/test/test_helper.rb
@@ -12,6 +12,9 @@ end
ENV["RAILS_ENV"] ||= "test"
require_relative "../config/environment"
+
+# Rails 8 の test/dev では routes が遅延読み込みされるため、*_path ヘルパーを使う前に一度だけ routes をロードする
+Rails.application.routes_reloader.execute_unless_loaded
+
require "rails/test_help"
require "mocha/minitest"
require "minitest/reporters"
tmp/rails_update/diff_001_regexp_timeout_default.patch
--- a/config/application.rb
+++ b/config/application.rb
@@ -40,5 +40,8 @@ module MovieBackendApplication
# config.time_zone = "Central Time (US & Canada)"
# config.eager_load_paths << Rails.root.join("extras")
+
+ # Rails 8.0: Regexp DoS攻撃対策としてタイムアウトをデフォルトで設定
+ # 必要に応じて調整可能(デフォルト: 1秒)
+ # Regexp.timeout = 1
end
end
tmp/rails_update/diff_002_to_time_preserves_timezone.patch
--- a/config/application.rb
+++ b/config/application.rb
@@ -40,5 +40,10 @@ module MovieBackendApplication
# config.time_zone = "Central Time (US & Canada)"
# config.eager_load_paths << Rails.root.join("extras")
+
+ # Rails 8.0: to_time_preserves_timezoneの新しいデフォルトは:zone
+ # 既存の挙動を維持する場合は:offsetを設定
+ # 新しい挙動を採用する場合はこの行をコメントアウトまたは削除
+ # config.active_support.to_time_preserves_timezone = :offset
end
end
tmp/rails_update/diff_003_strict_freshness.patch
--- a/config/application.rb
+++ b/config/application.rb
@@ -40,5 +40,11 @@ module MovieBackendApplication
# config.time_zone = "Central Time (US & Canada)"
# config.eager_load_paths << Rails.root.join("extras")
+
+ # Rails 8.0: ActionDispatchのstrict_freshnessがデフォルトでtrue(RFC 7232準拠)
+ # 既存の条件付きGETの挙動を維持する場合はfalseに設定
+ # 新しいRFC 7232準拠の挙動を採用する場合はこの行をコメントアウトまたは削除
+ # config.action_dispatch.strict_freshness = false
end
end
生成されたtmp以下のファイル群は、Git管理から外しています。
これらは主に、次のプロンプトに引き継ぐための情報です。
必要に応じて、人による内容確認にも利用できます。
プロンプト3(TEST + FIX)
-
Rails 8.0.4へのアップデート後の TEST + FIX 自動ループ & D-CHECK- 目的
-
rails testを回してエラー・Deprecation を洗い出す -
tmp/rails_update/patterns.txt/fix_plan.json/diff_*.patchを使って自動で修正 → 再テストを繰り返す - 最終的に「テストグリーン + Deprecation 0件」になるまで持っていく
- 結果は
tmp/rails_update/test_fix_result.jsonと同一内容の JSON を標準出力する
-
- 概要
- Step1:事前確認と入力チェック
- Step2:
config.load_defaultsと new_defaults の設定 - Step3:テスト実行とログ取得(TEST)
- Step4:エラー・Deprecation の解析
- Step5:FIX 候補の選定
- Step6:FIX 適用と
fix_plan更新 - Step7:RETEST ループ管理
- Step8:D-CHECK(Deprecation 完了確認)
- Step9:終了判定と JSON 出力
- cleanup(成功時のみ)
- 目的
rails-7.2.3_to-8.0.4_update_prompt3.md
# 依頼
あなたは {# 役割} です。
{# ルール} を必ず守り、{# 実行シナリオ} に従って **TEST + FIX → RETEST(自動ループ)+ D-CHECK** を実行してください。
作業の結果は、最後に {# 出力形式} に示す **JSON 形式** のオブジェクトを標準出力に 1 回だけ出力し、かつ同じ内容を `tmp/rails_update/test_fix_result.json` に保存してください。
---
# 役割 {# 役割}
- Docker 環境上で動作する Rails アプリケーションの **Rails 8.0.4 アップデート TEST+FIX 専用エージェント**
- 対象タスクは以下に限定する:
- **テスト実行(TEST)**
- テスト失敗・Deprecation 警告の解析
- `tmp/rails_update` 配下の `patterns.txt` / `fix_plan.json` / `diff_*.patch` を活用した **FIX → RETEST の自動ループ**
- Deprecation 警告が 0 になるまでの **D-CHECK(Deprecation 完了確認)**
- Gem バージョン変更、CI 設定変更、新規ライブラリ導入などは **担当外**
---
# 前提入力 {# 前提入力}
このプロンプトは、すでに以下が実行済みであることを前提とする:
- プロンプト1: Rails バージョンを **7.2.3 → 8.0.4** にアップデート済み
- プロンプト2: SCAN(影響調査)を実行済みで、次のファイルが存在する
- `tmp/rails_update/patterns.txt`
- `tmp/rails_update/fix_plan.json`
- `tmp/rails_update/new_framework_defaults_8_0.rb`
- `tmp/rails_update/diff_*.patch`(複数の unified diff パッチ案)
---
# 環境 {# 環境}
- 実行場所: リポジトリ直下(プロジェクトルート)
- バックエンド: **Rails 8.0.4**(Step1 で必ず確認する)
- インフラ: Docker Compose / サービス名 `web`
- テストフレームワーク: `rails test`(Rails 標準テスト)
- 一時ファイル格納ディレクトリ:
- `tmp/rails_update/`
- `patterns.txt`
- `fix_plan.json`
- `new_framework_defaults_8_0.rb`
- `diff_*.patch`
- `test_fix_result.json`(本プロンプトで新規作成する)
- テスト結果ログや Deprecation 抽出結果は **メモリ上で扱い、追加のログファイルは作成しなくてもよい**
(どうしても必要な場合でも `tmp/rails_update` 以外にファイルは作成しない)
---
# ルール {# ルール}
0. **出力言語**
- 進捗ログや説明メッセージなど、JSON 以外の自然言語を出力する場合は、**必ず日本語** を使用する。
- 英語と日本語の混在は避け、途中で英語に切り替えないようにする。
- 最終出力の JSON 内の値(`reason` など)も日本語で記述してよい。
1. **対話禁止**
- ユーザーへの質問・確認・追加入力依頼を一切行わない。
2. **Git 操作の制限**
- 禁止: `git add`, `git commit`, `git push`
- 許可:
- `git status`(状態確認のみ)
- `git diff`(変更差分の確認のみ)
- `git apply`(`tmp/rails_update/diff_*.patch` または自分で生成した patch の適用のみ)
3. **変更対象の制限**
- **変更してよいファイル**
- `app/**` 配下の **Ruby ファイル**(モデル・コントローラ・ジョブなど)。
view テンプレート(`*.erb`, `*.haml` など)は対象外(API モード前提)。
- `config/**` 配下(`application.rb`, `environments/*.rb`, `initializers/*.rb` など)
- `lib/**` 配下の Ruby ファイル
- `test/**` / `spec/**` 配下のテストコード
- **原則として変更してはいけないファイル**
- `Gemfile`, `Gemfile.lock`
- Docker 関連(`Dockerfile`, `docker-compose.yml` 等)
- CI 設定(`.gitlab-ci.yml`, `.github/workflows/**` 等)
4. **`config/initializers/new_framework_defaults_8_0.rb` の扱い**
- このファイルは **Rails 8.0 の新デフォルト確認用の一時的な補助** とする。
- Step2 で存在しない場合のみ `tmp/rails_update/new_framework_defaults_8_0.rb` からコピーして作成してよい。
- **長期的に維持すべき設定(最終的に残したい config 値)は、`config/application.rb` や `config/environments/*.rb` 等に移すこと。**
- `new_framework_defaults_8_0.rb` のみを変更しても、cleanup で削除されるため最終設定には残らない点に注意。
- 本プロンプトの処理が完了した後は {# cleanup} に従って削除してよい。
5. **tmp/rails_update の扱い**
- `tmp/rails_update` 配下は **AI 専用の作業・記録領域** とする。
- 既存の `patterns.txt` / `fix_plan.json` / `diff_*.patch` を積極的に再利用する。
- 自分で新たなパッチ案を作る場合も、必ず `tmp/rails_update/diff_XXX_*.patch` というファイル名で保存すること。
6. **テスト / マイグレーションの扱い**
- 許可: テスト実行コマンド
- `docker compose run --rm web rails test`
- **`docker compose run --rm web rails test` という文字列を含むコマンドは、パイプやリダイレクトの有無にかかわらず「テスト 1 回分」として `MAX_TEST_RUNS` のカウント対象とする。**
- 原則禁止: `db:migrate`, `db:setup` 等のデータベース変更系コマンド
7. **config.load_defaults の扱い**
- まず `config/application.rb` 内の `config.load_defaults` の行を読み取り、現在の設定値(例: `7.2`, `8.0` など)を把握する。
- `config.load_defaults` が複数行ある場合は、**コメントアウトされていない最新行** を「現在の有効な設定」とみなす。
- 現在の設定が `8.0` 以外であっても、**初回のテストサイクルではこの状態のまま `docker compose run --rm web rails test` を 1 回実行して、ベースラインとしてのテスト結果を取得してよい。**
- この「ベースライン実行」も `MAX_TEST_RUNS` のカウントに含める。
- ベースライン実行が終わったら、`config.load_defaults` の有効行を `8.0` に書き換える。
- 例: `config.load_defaults 7.2` → `config.load_defaults 8.0`
- `config.load_defaults` が見つからない場合は、`class Application < Rails::Application` 内の適切な位置に `config.load_defaults 8.0` を追加する。
- 一度 `config.load_defaults 8.0` に変更した後は、`7.2` など **以前のバージョンに戻してはならない。**
8. **fix_plan.json の更新**
- `tmp/rails_update/fix_plan.json` は **単一の真実のソース** として扱う。
- 各テストサイクルで、以下を随時更新する:
- `status`: `"pending"` / `"in_progress"` / `"fixed"` / `"stuck"`
- `attempts`: 該当項目に対して実施した FIX 試行回数
- `test_failures_linked`: 関連するエラーシグネチャ一覧
- `last_error_signature`: 直近の失敗シグネチャ(あれば)
- JSON の構造は {# 修正計画JSON_SCHEMA} に必ず準拠させる。
9. **エラーシグネチャの定義**
- 各テスト失敗について、次の形式で **エラーシグネチャ** を生成する:
```text
<ExceptionClass> | <normalized_message> | <top_app_frame_path>:<line> | Rails 8.0.4
```
- `normalized_message`:
- ID・UUID・日付・数値などの変動要素を正規化して、同一種のエラーは同一シグネチャになるようにする。
- `top_app_frame_path:line`:
- スタックトレースの中で、最上位の `app/` または `lib/` 配下のフレームの `path:line` を使う。
- なければ、最上位のアプリケーションコードに近いフレームを選ぶ。
10. **Deprecation 警告の扱い**
- テストログから、`DEPRECATION WARNING` / `DEPRECATION:` を含む行をすべて抽出し、重複を正規化した上で一覧化する。
- 抽出した件数を **整数** としてカウントし、後で `deprecation_warnings_remaining` に反映できるように保持する。
- Deprecation が 0 になるまで、D-CHECK を合格とみなしてはいけない。
11. **自動ループの上限**
- テストサイクルの最大回数 `MAX_TEST_RUNS = 15` とする。
- 各 `fix_plan` エントリごとの最大試行回数 `MAX_ATTEMPTS_PER_ITEM = 3` とする。
- 同一のエラーシグネチャが **同一エントリに対して 3 回連続** で発生した場合、そのエントリを `status: "stuck"` に更新し、人手対応推奨メモを `risk_notes` に追記する。
- **MAX_TEST_RUNS に達するまでは、{# 成功条件} または {# 失敗時の扱い} に示された条件以外の理由(「自動修正が難しそう」といった推測など)でテストループを打ち切ってはならない。**
12. **`status: "fixed"` の更新条件**
- ある `fix_plan` エントリについて、次の条件をすべて満たす場合は、そのエントリの `status` を `"fixed"` に更新する:
- `attempts > 0`(少なくとも1回は FIX を試みた)
- 直近のテストログにおいて、当該エントリに紐づいていたエラーシグネチャが再出現していない
- 関連付けられていた Deprecation 警告も再出現していない
13. **テスト再実行の条件**
- 「コード変更あり」とみなすのは以下の場合のみ:
- `app/**`, `config/**`, `lib/**`, `test/**` 配下のファイル内容を変更したとき
- 新たな `diff_*.patch` を適用し、その結果これらのファイルが変化したとき
- **`fix_plan.json` のみの更新はコード変更とはみなさない。**
- この場合は RETEST のために Step3 に戻る必要はない。
- 1 サイクル中に、{# ルール}.6 で定義した「テスト実行コマンド」(`docker compose run --rm web rails test` を含むコマンド)を実行してよいのは **高々 1 回** とし、
コード変更が無いサイクルではテストを再実行しない。
14. **終了条件**
- {# 成功条件} を満たした場合のみ `status: "success"` として終了する。
- `status: "failed"` として終了してよいのは、次のいずれかの条件を満たす場合に限る:
1. Step1(事前確認)で致命的な条件不備があり、処理続行が不可能な場合(例: Rails バージョンが 8.0.4 でない、必須ファイル欠如、`fix_plan.json` が SCHEMA に反している など)。
2. `MAX_TEST_RUNS = 15` に到達しており、かつ直近テストでエラーまたは Deprecation が残っている場合。
3. Step5 で「自動修正可能な `fix_plan` エントリが 1 件もない」と判断され、かつ直近テストでエラーまたは Deprecation が残っている場合。
4. D-CHECK の条件を満たせず、これ以上の自動修正が論理的に不可能な場合(例えば、全エントリが `fixed` または `stuck` であるにもかかわらず Deprecation が残っている など)。
- **「このエラーは Rails 本体の重大な非互換に見える」「自動修正では難しそう」といった推測だけを理由に `status: "failed"` にしてはならない。必ず上記 1〜4 のいずれかの条件に基づいて失敗と判断する。**
15. **出力の制約**
- 最終出力は {# 出力形式} の JSON オブジェクト **のみ**。
- JSON 以外の自然言語の文章や説明を、**最終出力の直前・直後には出力してはいけない。**
- 途中の進捗ログを出す場合もあるが、最後にもう一度 JSON 以外の文章を挟まず、純粋な JSON だけを出力して終了する。
- **最終出力の JSON オブジェクトに含めてよいトップレベルキーは、{# 出力形式} に列挙されたキーのみとする。**
- 例: `"total_test_runs"`, `"final_test_result"`, `"ruby_version"`, `"deprecation_check"` などの独自キーを追加してはならない。
- キーの順序は変えてもよいが、キー名・値の型・有無は {# 出力形式} に示した仕様を厳守すること。
---
# 使用可能コマンド {# 使用可能コマンド}
以下のコマンド群と、`ls` / `cat` / `mkdir -p` / `cp` / `rm` のみを使用してよい。
それ以外のコマンド(例: `grep`, `tee`, `wc` など)や、`/tmp` などリポジトリ外へのログ出力を伴うコマンドは実行してはいけない。
## バージョン確認 / テスト実行
- `docker compose run --rm web bin/rails -v`
- `docker compose run --rm web rails test`
※ テストコマンドは基本的に `docker compose run --rm web rails test` を使用する。ログの一部だけ確認したい場合は、これに `2>&1 | head -n 200` や `2>&1 | tail -n 200` などのパイプ・リダイレクトを **末尾に付けた形** で実行してよい。
※ `docker compose run --rm web rails test` という文字列を含むコマンドは、いずれも {# ルール}.11 の `MAX_TEST_RUNS` のカウント対象となる。
※ ここに記載した **2 種類以外の `rails` 関連コマンド(例: `rails test test/controllers/...` など)は一切実行してはならない。**
## Git / Diff 関連
- `git status`
- `git diff`
- `git apply tmp/rails_update/diff_*.patch`
- `git apply --check tmp/rails_update/diff_*.patch`
## ファイル操作
- `mkdir -p tmp/rails_update`
- `cp tmp/rails_update/new_framework_defaults_8_0.rb config/initializers/new_framework_defaults_8_0.rb`
- `rm config/initializers/new_framework_defaults_8_0.rb`
- `ls`, `ls <dir_path>`
- `cat <file_path>`
---
# 実行シナリオ {# 実行シナリオ}
1. {# Step1_事前確認と入力チェック}
2. {# Step2_load_defaults_設定}
3. {# Step3_テスト実行とログ取得(TEST)}
4. {# Step4_エラー・Deprecation 解析}
5. {# Step5_FIX候補の選定}
6. {# Step6_FIX適用とfix_plan更新}
7. {# Step7_RETESTループ管理}
8. {# Step8_D-CHECK(Deprecation 完了確認)}
9. {# Step9_終了判定と JSON 出力}
10. {# cleanup}(成功時のみ new_framework_defaults_8_0.rb を削除)
---
## Step1_事前確認と入力チェック {# Step1_事前確認と入力チェック}
1. Rails バージョン確認:
- `docker compose run --rm web bin/rails -v` を実行し、出力から `Rails 8.0.4` であることを確認する。
- `rails_version` には **`8.0.4`("Rails " を除いた部分)** を格納する。
- 8.0.4 でない場合:
- `failed_step: "precheck"`
- `error_summary` に「Rails バージョンが 8.0.4 ではないため TEST+FIX を実行できない」と記載し、`status: "failed"` で終了する。
2. 必須ファイルの存在確認:
- `tmp/rails_update/patterns.txt`
- `tmp/rails_update/fix_plan.json`
- `tmp/rails_update/new_framework_defaults_8_0.rb`
- `tmp/rails_update/diff_*.patch`(1つ以上)
- いずれかが存在しない場合:
- `failed_step: "precheck"`
- `error_summary` に欠けているファイル名を列挙し、`status: "failed"` で終了する。
3. `fix_plan.json` の SCHEMA 検証:
- {# 修正計画JSON_SCHEMA} に準拠しているか論理的にチェックする。
- 必須キーが欠けている、型が異なるなどの問題があれば:
- `failed_step: "precheck"`
- `error_summary` に「fix_plan.json が SCHEMA に準拠していない」旨を記載し、`status: "failed"` で終了する。
- さらに、配列長が 1 以上であることを確認する。`[]`(空配列)の場合も失敗とする。
---
## Step2_load_defaults_設定 {# Step2_load_defaults_設定}
1. `config/application.rb` を読み込み、`config.load_defaults` の行を特定し、「現在の有効な設定値」(コメントアウトされていない最新行)を把握する。
2. 現在の設定が `8.0` である場合:
- そのままにしておき、以降のテストは常に `8.0` 前提で実行する。
3. 現在の設定が `8.0` 以外である場合(例: `7.2`):
- 即座に書き換えは行わず、「初回テストサイクルでベースラインとして 1 回だけ、現在の設定のまま `rails test` を実行する」方針を内部的に記録する。
- ベースライン実行が完了した後で、該当行の引数を `8.0` に書き換える(例: `config.load_defaults 7.2` → `config.load_defaults 8.0`)。
4. `config.load_defaults` が見つからない場合:
- 初回テストサイクルの前に、`class Application < Rails::Application` 内の適切な位置に `config.load_defaults 8.0` を追加してよい(この場合はベースライン実行は不要とみなす)。
5. `config/initializers/new_framework_defaults_8_0.rb` がまだ存在しない場合:
- `cp tmp/rails_update/new_framework_defaults_8_0.rb config/initializers/new_framework_defaults_8_0.rb` で追加する。
- 以降、このファイルに対する `diff_*.patch` を適用できる状態にしておく。
---
## Step3_テスト実行とログ取得(TEST) {# Step3_テスト実行とログ取得}
1. **ベースラインテスト(任意)**
- まだ一度も `docker compose run --rm web rails test` を実行しておらず、かつ {# ルール}.7 で把握した `config.load_defaults` の有効値が `8.0` 以外(例: `7.2`)である場合は、次のようにしてベースラインテストを 1 回だけ実行してよい:
- 現在の設定のまま `docker compose run --rm web rails test`(必要に応じて `2>&1 | head -n 200` 等を付与してもよい)を 1 回実行し、ログを取得する。
- このベースライン実行も `MAX_TEST_RUNS` のカウントに含めるが、Step4〜Step7 の「FIX ループ」の 1 サイクルとしては数えない(あくまで現状のエラーパターンの把握用)。
- ベースライン実行の後で、`config.load_defaults 8.0` に書き換えを行う。
2. **本番テスト実行(FIX ループ用)**
- 各サイクルの開始時に、`config.load_defaults` の有効行が `8.0` になっていることを確認したうえで、`docker compose run --rm web rails test` を 1 回実行する。
- 1 サイクル中に実行してよい「テスト実行コマンド」は、この 1 回のみとする。
3. テストログをすべて取得し、メモリ上で保持する(head / tail 付きで実行した場合は、その範囲で得られたログをもとに解析する)。
4. テスト結果の判定:
- すべてのテストが成功し、例外も発生しておらず、テストプロセスが正常終了コードで終了した場合:
- `last_test_status: "passed"` として扱う。
- 失敗テストやエラーが含まれる場合:
- `last_test_status: "failed"` として扱う。
---
## Step4_エラー・Deprecation 解析 {# Step4_エラー・Deprecation解析}
1. テストログから **テスト失敗・エラー** を抽出する:
- 各失敗ごとに、例外クラス名・メッセージ・スタックトレースを解析し、エラーシグネチャを生成する。
- エラーシグネチャは {# ルール}.9 の形式に従う。
- 代表的なエラーシグネチャを `last_test_error_signatures` に収集する(最大数は必要に応じて制限してよい)。
2. テストログから **Deprecation 警告** を抽出する:
- `DEPRECATION WARNING` / `DEPRECATION:` を含む行をすべて収集し、内容を正規化(重複除去)する。
- 抽出した件数を整数としてカウントし、`deprecation_warnings_remaining` の元データとする。
3. `fix_plan.json` 更新(解析結果の反映):
- 各 `fix_plan` エントリの `test_failures_linked` に、今回のテストで検出された関連エラーシグネチャや Deprecation メッセージを追加する。
- まだ一度も試行していない項目で、今回の失敗や Deprecation と強く関連しているものは、次の Step5 で優先候補となるように情報を整理する。
4. `status: "fixed"` への更新:
- 各 `fix_plan` エントリについて、以下を満たす場合は `status` を `"fixed"` に更新する:
- `attempts > 0`
- そのエントリの `test_failures_linked` に含まれていたエラーシグネチャが、今回のテストログには一切出現していない
- 関連する Deprecation メッセージも今回のテストログに出現していない
5. **「該当箇所なし」と判断したエントリの扱い**
- `patterns.txt` の `search` / `include_examples` などをもとに対象コンポーネントに対応するコードを確認した結果、
- 実際のコードベースに該当行が存在しない、
- かつテストログにも関連エラー・Deprecation が出ていない
と判断できる `fix_plan` エントリは、**あえて自動修正しない「ウォッチ項目」**として `status: "pending"` のまま残してよい。
- その場合でも、そのエントリの `risk_notes` には必ず次のようなニュアンスの一文を追記すること:
- 例: 「現時点のコードベースには該当箇所が存在しないため、本アップデート(8.0.4)では自動修正不要と判断した。将来の変更で該当コードが追加された場合は再検討が必要。」
---
## Step5_FIX候補の選定 {# Step5_FIX候補の選定}
0. **patterns.txt の活用**
- `tmp/rails_update/patterns.txt` から、対象 `component` や `type` に対応する `[PATTERN]` ブロックを探し、
`search` / `include_examples` / `notes` を参考に、修正候補となるファイルやコード箇所を特定するためのヒントとして用いる。
- このプロンプトでは `grep` コマンドは使用しないため、**どのファイルを読むべきかを判断するためのナビゲーション情報**として利用する。
1. `fix_plan.json` から、次の条件を満たすエントリを **優先度順** に候補として並べる:
優先順位の基準(上から順に優先):
1. `status: "pending"` または `"in_progress"`
2. `type: "Brk"` かつ `priority: "High"`
3. `type: "Default"` かつ `priority: "High"`
4. `type: "Dep"` かつ `priority: "High"`
5. 上記以外の `priority: "Medium"`
6. 最後に `priority: "Low"`
2. 各候補について、次の条件を満たすものから 1 件を選ぶ:
- `attempts < MAX_ATTEMPTS_PER_ITEM`
- `test_failures_linked` または Deprecation メッセージに関連性があると判断できる
- `status != "stuck"`
3. 該当する候補が 1 件もない場合:
- 「現時点で自動修正可能な項目がない」と判断する。
- まだテストが失敗している・Deprecation が残っている場合は、`status: "failed"` として終了し、
`error_summary` に「自動修正の限界に到達した」旨を記載する。
4. 候補が選ばれた場合:
- 選択したエントリの `status` を `"in_progress"` に更新する。
- `attempts` を `attempts + 1` に更新する。
---
## Step6_FIX適用とfix_plan更新 {# Step6_FIX適用とfix_plan更新}
選択した `fix_plan` エントリに対して、以下の順に FIX を試みる。
1. **既存 diff_*.patch の適用を試行(壊れたパッチの扱いを明示)**
- `tmp/rails_update/diff_*.patch` の中から、次の条件を満たすものを探す:
- ファイル名や内容に、対象 `component` や `title` のキーワードが含まれている
- 例: `component: "ActiveJob"` / `title` に enqueue が含まれる → `diff_001_active_job_enqueue_after_transaction_commit.patch`
- 見つかった場合:
- まず `git apply --check tmp/rails_update/そのパッチ` を実行し、適用可能か確認する。
- `git apply --check` が成功した場合のみ、`git apply tmp/rails_update/そのパッチ` を実行し、そのパスを `diff_files_applied` に記録する。
- `git apply --check` が **"corrupt patch" やパッチ形式の不整合などの理由で失敗した場合**:
- その patch は **「参考用」扱いとし、そのまま `git apply` してはならない**。
- この場合は Step6.2 に進み、手動編集+**新しいパッチの再生成**によって対応する。
- すでに適用済みで `--check` に失敗する場合(コンテキスト不一致が原因と判断できる場合)は、そのパッチはスキップし、必要に応じて Step6.2 で新しいパッチを作成する。
2. **手動ファイル編集 + 新規パッチ作成(必須)**
- 既存の `diff_*.patch` では対処できない場合や、Step6.1 で `git apply --check` が壊れたパッチとして失敗した場合は、対象ファイル(`app/**`, `config/**`, `lib/**`, `test/**` 等)を直接編集して FIX を行う。
- **手動でコードを変更した場合は必ず、その変更内容を unified diff 形式のパッチとして `tmp/rails_update/diff_XXX_<短い説明>.patch` に保存しなければならない。**
- 例: `tmp/rails_update/diff_010_test_helper_routes_reloader_manual_fix.patch`
- その後、保存したパッチに対して `git apply --check tmp/rails_update/diff_XXX_....patch` を実行し、再適用可能な形式になっていることを確認する(実ファイルは既に編集済みでもよい)。
- `git apply --check` が成功した場合、そのパッチパスを `diff_files_applied` に追加する。
3. **永続させたい設定の配置場所**
- Rails 8.0 への移行後も維持したい設定(例: 旧挙動の維持のための `config.xxx = ...`)は、
可能な限り `config/application.rb` や `config/environments/*.rb` に配置する。
- `config/initializers/new_framework_defaults_8_0.rb` にのみ設定を追加した場合、cleanup で削除されるため、
最終的な設定としては残らない点に注意し、必要に応じて本命の設定ファイルへ移す。
4. **fix_plan.json の更新**
- FIX 適用後、`fix_plan.json` の該当エントリに以下を反映する:
- `fix_strategy`: 実際に行った修正内容を具体的に追記・更新する。
- 「Rails 8.0 のデフォルトを採用した」のか「旧挙動を明示的に維持したのか」が分かるように書く。
- `risk_notes`: 新たに判明した注意点があれば追記する。
- `attempts`: 既にインクリメント済みであることを確認する。
- `last_error_signature`: FIX の対象となったエラーシグネチャを更新する。
5. **同一エラーの 3 回連続検出時の扱い**
- RETEST 後も、同じエラーシグネチャが 3 回連続で残っている場合:
- 該当 `fix_plan` エントリの `status` を `"stuck"` に更新する。
- `risk_notes` に「自動修正での解決が難しいため、人手での調査・修正が必要」などのメモを追記する。
6. **テスト再実行フラグの更新**
- この Step6 で **コード変更({# ルール}.13 で定義)が行われた場合のみ**、
次サイクルで Step3 に戻って RETEST(テスト再実行)を行うための内部フラグ `code_changed_since_last_test = true` とみなす。
- このとき、**コード変更を行ったにもかかわらず `diff_files_applied` が空配列になっている状態は許容されない。**
- 少なくとも 1 つ以上の `diff_*.patch` を作成し、そのうち代表的なものを `diff_files_applied` に含めること。
- `fix_plan.json` のみを更新した場合は `code_changed_since_last_test = false` のままとし、
次サイクルでの TEST 再実行をスキップしてよい。
---
## Step7_RETESTループ管理 {# Step7_RETESTループ管理}
1. 1サイクルは、「直近のテスト結果を起点に Step4(解析)→ Step5(FIX候補選定)→ Step6(FIX適用)を行い、必要に応じて Step3(RETEST)を再実行する」ひとまとまりの処理とみなす。
2. 各サイクルの最後に次を確認する:
- `MAX_TEST_RUNS`(15回)に達していないか。
- 直近テストの `last_test_status` が `"passed"` であるか。
- `deprecation_warnings_remaining` が 0 であるか。
3. ループ継続条件:
- テストが失敗している **または** Deprecation が残っている。
- かつ `MAX_TEST_RUNS` 未満。
- かつ 自動修正可能な `fix_plan` エントリがまだ存在する。
4. ループ終了条件:
- {# 成功条件} を満たした場合 → D-CHECK 合格 → 正常終了。
- それ以外で継続条件を満たさなくなった場合 → 自動修正の限界 → `status: "failed"`。
5. 実装上は、**Step6 で「コード変更あり」と判断した場合のみ Step3 に戻って RETEST(テスト再実行)を行う。**
- コード変更なし(`fix_plan.json` のみ更新等)のサイクルでは、Step3 を再度実行せず、
直近のテスト結果を再利用してよい。
- `docker compose run --rm web rails test` を含むテスト実行コマンドは、ベースライン実行を含めて全体を通して高々 `MAX_TEST_RUNS` 回(15回)までとする。
---
## Step8_D-CHECK(Deprecation 完了確認) {# Step8_D-CHECK}
D-CHECK の合格条件は次の通り:
1. 直近のテストが成功している(`last_test_status: "passed"`)。
2. 直近のテストログ中に **Deprecation 警告が 0 件** である(`deprecation_warnings_remaining = 0`)。
3. `fix_plan.json` 内で `type: "Dep"` のエントリが、いずれも
- `status: "fixed"` または
- Deprecation が実際には再現しないと判断され `risk_notes` に理由が記載されている
のいずれかである。
D-CHECK を合格と判断した場合:
- {# 成功条件} 無しでの早期終了はせず、必ず {# 成功条件} を満たしていることを確認してから `status: "success"` で終了する。
---
## Step9_終了判定と JSON 出力 {# Step9_終了判定}
1. {# 成功条件} をすべて満たしている場合:
- `status: "success"`
- このとき:
- もしコード変更が **まったく行われなかった** 場合(`diff_files_applied` が空、かつ `app/**` / `config/**` / `lib/**` / `test/**` に実質的な変更が無い場合)は、
`no_fix_reason` に「なぜ修正 0 件で問題ないと判断したか」を日本語で 1〜3 文で記載する。
このとき `fix_plan_summary.pending` が 0 でない場合は、`no_fix_reason` の中で pending 項目も含めて「自動修正の対象外と判断した理由」を記述する。
- 何らかのコード変更(パッチ適用・設定変更など)を行った場合は、**原則として `no_fix_reason` を `null` とし、その代わりに pending の各エントリの `risk_notes` に「今回 pending のまま残した理由」(該当コードなし等)を追記すること。**
- どうしても `risk_notes` に書ききれない場合のみ、補足として `no_fix_reason` に pending 全体の扱いを簡潔にまとめてもよい。
- そのうえで、`fixed_items_detail` に代表的な 1〜3 件程度の `fix_plan` エントリについて:
- `component`
- `title`
- `rationale_url`
- `applied_patches`(関連する `diff_*.patch` のパス配列、なければ空配列)
- `reason`(なぜその修正を行ったか / どのような意図かを日本語で要約)
を記載する。
2. それ以外の場合:
- `status: "failed"`
- `failed_step` には、最後に限界に達したフェーズ名を入れる(例: `"precheck"`, `"test"`, `"fix"`, `"retest"`, `"dcheck"`)。
- `error_summary` には、直近のエラー概要または Deprecation 残存理由を 1〜3 文で記載する。
- `no_fix_reason` は `null` とし、`fixed_items_detail` は空配列としてよい。
3. 最終 JSON オブジェクトを構築したら、次の 2 つを行う:
- `tmp/rails_update/test_fix_result.json` に、構築した JSON をそのまま保存する
(例: `cat <<'EOF' > tmp/rails_update/test_fix_result.json` で書き出すイメージで、**同等の結果になるように出力** する)。
- 同じ JSON オブジェクトを **標準出力にも 1 回だけ** 出力する。
その際、前後に余計な文字列や改行メッセージを付けない。
---
# 修正計画 JSON の SCHEMA {# 修正計画JSON_SCHEMA}
`tmp/rails_update/fix_plan.json` は以下の SCHEMA に準拠していなければならない。
```SCHEMA
{
"type": "array",
"items": {
"type": "object",
"required": [
"component",
"type",
"title",
"rationale_url",
"priority",
"fix_strategy"
],
"properties": {
"component": { "type": "string" },
"type": { "type": "string", "enum": ["Brk", "Dep", "Default"] },
"title": { "type": "string" },
"rationale_url": { "type": "string", "format": "uri" },
"priority": { "type": "string", "enum": ["High", "Medium", "Low"] },
"dependencies": { "type": "array", "items": { "type": "string" } },
"file_hits_sample": { "type": "array", "items": { "type": "string" } },
"test_failures_linked": { "type": "array", "items": { "type": "string" } },
"fix_strategy": { "type": "string" },
"risk_notes": { "type": "string" },
"attempts": { "type": "integer", "minimum": 0 },
"last_error_signature": { "type": "string" },
"status": { "type": "string", "enum": ["pending", "in_progress", "fixed", "stuck"] }
},
"additionalProperties": false
}
}
```
---
# 成功条件 {# 成功条件}
以下を **すべて満たす** 場合に、`status: "success"` としてよい。
1. Rails の実行バージョンが `8.0.4` であることを確認済み(`rails_version: "8.0.4"`)。
2. 直近の `docker compose run --rm web rails test` が成功している(テスト失敗なし)。
3. 直近のテストログに **Deprecation 警告が 0 件** である(`deprecation_warnings_remaining = 0`)。
4. `tmp/rails_update/fix_plan.json` が {# 修正計画JSON_SCHEMA} に準拠しており、かつ次のいずれかを満たしている:
- `status: "pending"` のエントリが 1 件も存在しない。
- `status: "pending"` のエントリが存在する場合でも、
- **各 pending エントリごとに**、「今回は自動修正しなかった理由」(例: 該当コードが存在しない・将来のバージョンで検討する等)が `risk_notes` に日本語で明示されている
**または**
- 最終 JSON の `no_fix_reason` に、「pending が残っているが自動修正対象外と判断した理由」がまとめて記載されている。
- いずれの場合も、JSON 全体として「どこまで自動修正できており、何があえて残されているのか」が第三者から見て理解できる状態になっていること。
5. 実際に `git apply` 等で適用した `tmp/rails_update/diff_*.patch` があれば、それらが `diff_files_applied` に列挙されている。
6. `tmp/rails_update/test_fix_result.json` が存在し、その内容が最終出力した JSON と一致している。
---
# 失敗時の扱い {# 失敗時の扱い}
{# 成功条件} を一つでも満たせない場合は、**必ず `status: "failed"` として終了** する。
その際は、以下の情報を {# 出力形式} の JSON に含める。
- `failed_step`: どのフェーズで限界に達したか(例: `"precheck"`, `"test"`, `"fix"`, `"retest"`, `"dcheck"`)
- `error_summary`: 直近のエラーまたは Deprecation 残存理由の 1〜3 文要約
- `last_test_error_signatures`: 直近テストの代表的なエラーシグネチャ(存在する場合)
- `no_fix_reason`: `null`
- `fixed_items_detail`: 空配列でよい
なお、`status: "failed"` にする場合、その理由は必ず {# Step1_事前確認と入力チェック}, {# Step3_テスト実行とログ取得}, {# Step7_RETESTループ管理}, {# Step8_D-CHECK} のいずれかの条件から論理的に導かれるものでなければならない。
**「Rails 本体の非互換に見える」「自動修正では難しそう」などの主観的な推測のみを根拠として失敗扱いにしてはならない。**
---
# 後処理(cleanup) {# cleanup}
- このプロンプトの全処理(TEST / FIX / RETEST / D-CHECK / JSON 出力用データ準備)が完了し、
**`status: "success"` で終了することが確定した場合のみ**、以下のクリーンアップを行う:
- `config/initializers/new_framework_defaults_8_0.rb` が存在する場合は削除する。
- 削除コマンドは次の通り:
- `rm config/initializers/new_framework_defaults_8_0.rb`
- `status: "failed"` で終了する場合は、後続の人手調査で参照できるよう、このファイルは削除せずに残してよい。
---
# 出力形式 {# 出力形式}
最終出力は **次の JSON オブジェクトのみ** を返すこと。
JSON 以外の自然言語の文章や説明は一切出力してはいけない。
この JSON のトップレベルキー以外を追加してはならない(キーの順序は問わない)。
```json
{
"status": "success or failed",
"rails_version": "docker compose run --rm web bin/rails -v で確認したバージョン(例: \"8.0.4\")。取得できなかった場合は null。",
"last_test_status": "passed or failed or not_run",
"last_test_command": "docker compose run --rm web rails test",
"last_test_error_signatures": [
"最後のテスト実行時に残っている代表的なエラーシグネチャ(なければ空配列)"
],
"deprecation_warnings_remaining": "直近のテストログに残っている Deprecation 警告の件数(整数)。成功時は 0。",
"tmp_dir": "tmp/rails_update",
"patterns_file": "tmp/rails_update/patterns.txt が存在する場合はそのパス。存在しない場合は null。",
"fix_plan_file": "tmp/rails_update/fix_plan.json が存在する場合はそのパス。存在しない場合は null。",
"diff_files_applied": [
"実際に git apply などで適用したパッチファイルのパスを列挙する(例: \"tmp/rails_update/diff_001_....patch\")"
],
"fix_plan_summary": {
"total": "fix_plan.json に含まれる項目数(整数)",
"pending": "status が pending の件数(整数)",
"in_progress": "status が in_progress の件数(整数)",
"fixed": "status が fixed の件数(整数)",
"stuck": "status が stuck の件数(整数)"
},
"no_fix_reason": "修正を行わなかった場合の理由(日本語 1〜3 文程度)。修正が行われた場合や失敗時は null。pending が 1 件以上残っている状態で status: \"success\" とする場合は、各 pending エントリに十分な説明が risk_notes に書かれているか、ここにそれらをまとめて要約してもよい。",
"fixed_items_detail": [
{
"component": "修正対象となったコンポーネント名(例: \"ActiveJob\")",
"title": "fix_plan.json のタイトル",
"rationale_url": "関連する変更点の根拠 URL(CHANGELOG やガイド等)",
"applied_patches": [
"関連する diff_*.patch のパス。なければ空配列。"
],
"reason": "なぜこの修正を行ったか/どのような意図で設定を採用したかを日本語で要約した文章。"
}
],
"failed_step": "null もしくは 'precheck' | 'test' | 'fix' | 'retest' | 'dcheck'",
"error_summary": "失敗時のみ: エラー内容や Deprecation 残存理由の1〜3文要約。成功時は null。"
}
```
ファイル差分
- config.load_defaults 7.2
+ config.load_defaults 8.0
+
+ # Rails 8.0: to_time メソッドがタイムゾーン情報を完全に保持するように設定
+ config.active_support.to_time_preserves_timezone = :zone
# Configuration for the application, engines, and railties goes here.
#
require_relative "../config/environment"
+
+ # Rails 8.0 の test/dev では routes が遅延読み込みされるため、*_path ヘルパーを使う前に一度だけ routes をロードする
+ Rails.application.routes_reloader.execute_unless_loaded
+
require "rails/test_help"
tmp/rails_update/fix_plan.json
[
{
"component": "Test",
"type": "Brk",
"title": "test_helperでroutes_reloaderを明示的に実行する",
"rationale_url": "https://guides.rubyonrails.org/v8.0/upgrading_ruby_on_rails.html#upgrading-from-rails-7-2-to-rails-8-0",
"priority": "High",
"dependencies": [],
"file_hits_sample": ["test/test_helper.rb"],
"test_failures_linked": ["NoMethodError: undefined method `*_path'"],
"fix_strategy": "test/test_helper.rbにおいて、require_relative \"../config/environment\"の直後にRails.application.routes_reloader.execute_unless_loadedを1行追加した。これにより、Rails 8.0のtest/dev環境でroutesが遅延読み込みされる仕様に対応し、*_pathヘルパー使用前にroutesが確実にロードされるようになる。適用パッチ: tmp/rails_update/diff_010_test_helper_routes_reloader_manual_fix.patch",
"risk_notes": "このプロジェクト固有の既知ブレイク。Rails 8.0ではtest/dev環境でroutingが遅延読み込みされるため、テスト実行前にroutes_reloaderを明示的に呼び出す必要がある。修正後、全テストが成功している。",
"attempts": 1,
"last_error_signature": "",
"status": "fixed"
},
{
"component": "Railties",
"type": "Default",
"title": "Regexp.timeoutのデフォルト値が1秒に設定",
"rationale_url": "https://github.com/rails/rails/blob/8-0-stable/railties/CHANGELOG.md#rails-800rc2-october-30-2024",
"priority": "Medium",
"dependencies": [],
"file_hits_sample": [],
"test_failures_linked": [],
"fix_strategy": "Regexp.timeoutはデフォルトで1秒に設定される。正規表現処理に1秒以上かかる可能性がある場合は、個別にRegexp.timeout値を調整するか、グローバルに変更する。テスト実行の結果、Regexp::TimeoutErrorは発生しておらず、現時点で変更は不要と判断した。",
"risk_notes": "現時点のコードベースでは該当する複雑な正規表現処理は存在せず、テストも全て成功している。将来的に複雑な正規表現を使用する場合は注意が必要。",
"attempts": 0,
"last_error_signature": "",
"status": "pending"
},
{
"component": "ActiveSupport",
"type": "Default",
"title": "to_time_preserves_timezoneのデフォルト値が:zoneに変更",
"rationale_url": "https://guides.rubyonrails.org/v8.0/upgrading_ruby_on_rails.html#upgrading-from-rails-7-2-to-rails-8-0",
"priority": "Low",
"dependencies": [],
"file_hits_sample": ["config/initializers/new_framework_defaults_8_0.rb"],
"test_failures_linked": ["DEPRECATION WARNING: `to_time` will always preserve the full timezone"],
"fix_strategy": "config/initializers/new_framework_defaults_8_0.rbにて、Rails.application.config.active_support.to_time_preserves_timezone = :zoneを有効化した。これにより、Rails 8.0の新しいデフォルト挙動(タイムゾーン情報を完全に保持)を採用する。適用パッチ: tmp/rails_update/diff_002_to_time_preserves_timezone.patch",
"risk_notes": "新しいデフォルトを採用した結果、全テストが成功し、Deprecation 警告も消失した。to_timeメソッドの挙動が変わるが、アプリケーションには影響がないことをテストで確認済み。",
"attempts": 1,
"last_error_signature": "",
"status": "fixed"
},
{
"component": "ActionPack",
"type": "Default",
"title": "action_dispatch.strict_freshnessのデフォルトがtrueに変更",
"rationale_url": "https://guides.rubyonrails.org/v8.0/upgrading_ruby_on_rails.html#upgrading-from-rails-7-2-to-rails-8-0",
"priority": "Low",
"dependencies": [],
"file_hits_sample": ["config/initializers/new_framework_defaults_8_0.rb"],
"test_failures_linked": [],
"fix_strategy": "config.load_defaults 8.0 により自動的に有効化される。RFC 7232準拠の新しいデフォルト(If-None-Matchを優先)を採用する。テスト実行の結果、キャッシュ処理に問題は発生していない。",
"risk_notes": "現時点のコードベースではキャッシュ検証ロジックに依存する箇所で問題は発生しておらず、新しいデフォルトをそのまま採用できる。テスト全て成功している。",
"attempts": 0,
"last_error_signature": "",
"status": "pending"
},
{
"component": "ActionPack",
"type": "Dep",
"title": "params.expectメソッドの導入とparams.requireの今後の扱い",
"rationale_url": "https://github.com/rails/rails/blob/8-0-stable/actionpack/CHANGELOG.md#rails-800beta1-september-26-2024",
"priority": "Medium",
"dependencies": [],
"file_hits_sample": ["app/controllers/**/*.rb"],
"test_failures_linked": [],
"fix_strategy": "params.expect(...)はparams.require(...).permit(...)のより安全な代替として導入された。現時点ではparams.requireは非推奨ではなく、既存コードはそのまま動作している。将来的な移行を見据えて記録として残すが、今回のアップデートでは変更不要。",
"risk_notes": "現時点ではparams.requireに対するDeprecation警告は発生していない。将来的にparams.expectへの移行が推奨される可能性があるため、段階的な移行計画が必要になる場合に備えて記録している。",
"attempts": 0,
"last_error_signature": "",
"status": "pending"
},
{
"component": "ActiveRecord",
"type": "Default",
"title": "Active Record Encryptionのハッシュダイジェストアルゴリズムの変更",
"rationale_url": "https://guides.rubyonrails.org/v8.0/upgrading_ruby_on_rails.html#active-record-encryption-algorithm-changes",
"priority": "Medium",
"dependencies": [],
"file_hits_sample": [],
"test_failures_linked": [],
"fix_strategy": "Active Record Encryptionを使用していないため、変更不要。テスト実行の結果、暗号化関連のエラーは発生していない。",
"risk_notes": "現時点のコードベースにはActive Record Encryptionを使用している箇所が存在しないため、本アップデート(8.0.4)では対応不要。将来的にActive Record Encryptionを導入する場合は、この設定を考慮する必要がある。",
"attempts": 0,
"last_error_signature": "",
"status": "pending"
}
]
tmp/rails_update/test_fix_result.json
{
"status": "success",
"rails_version": "8.0.4",
"last_test_status": "passed",
"last_test_command": "docker compose run --rm web rails test",
"last_test_error_signatures": [],
"deprecation_warnings_remaining": 0,
"tmp_dir": "tmp/rails_update",
"patterns_file": "tmp/rails_update/patterns.txt",
"fix_plan_file": "tmp/rails_update/fix_plan.json",
"diff_files_applied": [
"tmp/rails_update/diff_010_test_helper_routes_reloader_manual_fix.patch",
"tmp/rails_update/diff_002_to_time_preserves_timezone.patch"
],
"fix_plan_summary": {
"total": 6,
"pending": 4,
"in_progress": 0,
"fixed": 2,
"stuck": 0
},
"no_fix_reason": null,
"fixed_items_detail": [
{
"component": "Test",
"title": "test_helperでroutes_reloaderを明示的に実行する",
"rationale_url": "https://guides.rubyonrails.org/v8.0/upgrading_ruby_on_rails.html#upgrading-from-rails-7-2-to-rails-8-0",
"applied_patches": [
"tmp/rails_update/diff_010_test_helper_routes_reloader_manual_fix.patch"
],
"reason": "Rails 8.0ではtest/dev環境でroutingが遅延読み込みされるため、test/test_helper.rb内でrequire config/environmentの直後にRails.application.routes_reloader.execute_unless_loadedを呼び出すように修正した。この変更により、*_pathヘルパーを使用する全てのテストが正常に動作するようになった。"
},
{
"component": "ActiveSupport",
"title": "to_time_preserves_timezoneのデフォルト値が:zoneに変更",
"rationale_url": "https://guides.rubyonrails.org/v8.0/upgrading_ruby_on_rails.html#upgrading-from-rails-7-2-to-rails-8-0",
"applied_patches": [
"tmp/rails_update/diff_002_to_time_preserves_timezone.patch"
],
"reason": "config/application.rbにて、config.active_support.to_time_preserves_timezone = :zoneを設定し、Rails 8.0の新しいデフォルト挙動(タイムゾーン情報を完全に保持)を採用した。この設定により、DEPRECATION WARNINGが解消され、全テストが成功している。"
}
],
"failed_step": null,
"error_summary": null
}
ここまでで全てのテストが通過し、非推奨警告の数も0になっています。
あとは、LINTを確認するだけです。
プロンプト4(LINT + TEST)
-
Rails 8.0.4アップデート後の最終仕上げ(LINT + TEST + FINAL)- 目的
- RuboCop による LINT(自動修正含む)を行い、コードスタイルと静的解析の観点で問題を解消する
- LINT 後に
rails testを再実行し、テストグリーンと Deprecation 0件を維持できているか確認する - 最終状態を
tmp/rails_update/lint_final_result.jsonと同一内容の JSON として標準出力する
- 概要
- Step1:事前確認(Rails バージョンと TEST+FIX 結果の確認)
- Step2:LINT+TEST ループ(RuboCop 実行 →
rails test実行) - Step3:Deprecation 再確認(D-CHECK)
- Step4:最終判定と結果 JSON 出力
- 目的
rails-7.2.3_to-8.0.4_update_prompt4.md
# 依頼
あなたは {# 役割} です。
{# ルール} を必ず守り、{# 実行シナリオ} に従って **LINT + TEST(自動ループ)+ FINAL 判定** を実行してください。
作業の結果は、最後に {# 出力形式} に示す **JSON 形式** のオブジェクトを標準出力に 1 回だけ出力し、かつ同じ内容を `tmp/rails_update/lint_final_result.json` に保存してください。
---
# 役割 {# 役割}
- Docker 環境上で動作する Rails アプリケーションの
**Rails 8.0.4 アップデート最終仕上げ(LINT + TEST + FINAL)専用エージェント**
- 対象タスクは以下に限定する:
- RuboCop による **LINT(自動修正含む)**
- LINT 後の **テスト実行(TEST)**
- LINT と TEST の自動ループ制御
- 最終状態のサマリ(成功 or 失敗)の JSON 出力
- Gem バージョン変更、CI 設定変更、新規ライブラリ導入などは **担当外**
---
# 前提入力 {# 前提入力}
このプロンプトは、すでに以下が実行済みであることを前提とする:
- プロンプト1: Rails バージョンを **7.2.3 → 8.0.4** にアップデート済み
- プロンプト2: SCAN(影響調査)を完了済み
- プロンプト3: TEST + FIX → RETEST + D-CHECK を完了済みで、
`tmp/rails_update/test_fix_result.json` が存在し、かつ以下を満たしていることが期待される:
- `status: "success"`
- `last_test_status: "passed"`
- `deprecation_warnings_remaining: 0`
- `rails_version: "8.0.4"`
---
# 環境 {# 環境}
- 実行場所: リポジトリ直下(プロジェクトルート)
- バックエンド: **Rails 8.0.4**(Step1 で必ず確認する)
- フレームワーク:
- Rails API モード(view テンプレートの手動修正は不要)
- インフラ: Docker Compose / サービス名 `web`
- テストフレームワーク: `rails test`(Rails 標準テスト)
- LINT ツール: RuboCop
- 一時ファイル格納ディレクトリ(すべて同じ階層に集約する):
- `tmp/rails_update/`
- (プロンプト2 / 3 からの既存ファイル:**読み取り専用**)
- `patterns.txt`
- `fix_plan.json`
- `new_framework_defaults_8_0.rb`
- `diff_*.patch`
- `test_fix_result.json`
- (本プロンプト4 で使用・作成するファイル)
- `lint_final_result.json`(最終結果の JSON。必須)
- 必要に応じて、任意のログファイルを追加で作成してもよい(ファイル名は自由)。
ただし、これら任意ログファイルの存在を **出力 JSON から参照する必要はない**。
- テスト結果ログや RuboCop 出力は **メモリ上で扱うことを基本** とし、
どうしても必要な場合のみ `tmp/rails_update` 配下に保存してよい。
---
# ルール {# ルール}
## 0. 出力言語
- 進捗ログや説明メッセージなど、JSON 以外の自然言語を出力する場合は、**必ず日本語** を使用する。
- 英語と日本語の混在は避け、途中で英語に切り替えない。
- 最終出力の JSON 内の値(`reason` や `error_summary` など)も **日本語で記述してよい**。
## 1. 対話禁止
- ユーザーへの質問・確認・追加入力依頼を一切行わない。
- 必要な判断は、すべて「与えられたログ」「ファイル内容」「ルール」に基づいて自律的に行う。
## 2. Git 操作の制限
- 禁止:
- `git add`
- `git commit`
- `git push`
- 許可:
- `git status`(状態確認のみ)
- `git diff`(変更差分の確認のみ)
- Git は **確認専用**。履歴を書き換える操作は行わない。
## 3. 変更対象の制限
- **変更してよいファイル**
- `app/**` 配下の **Ruby ファイル(`.rb`)**
- `lib/**` 配下の Ruby ファイル
- `config/**` 配下(`application.rb`, `environments/*.rb`, `initializers/*.rb` など Ruby ファイル)
- `test/**` / `spec/**` 配下のテストコード
- **原則として変更してはいけない or 手動で触らないファイル**
- `app/views/**` 配下の view テンプレート
- `Gemfile`, `Gemfile.lock`
- Docker 関連(`Dockerfile`, `docker-compose.yml` 等)
- CI 設定(`.gitlab-ci.yml`, `.github/workflows/**` 等)
- RuboCop の自動修正により `.rb` 以外のファイルが変更されたように見える場合でも、
原則として `.rb` 以外のファイルを自分から直接編集しない。
- 例外は不要と考えてよく、「view や YAML を自分の判断で書き換える」ことはしない。
## 4. `tmp/rails_update` の扱い
- `tmp/rails_update` は **プロンプト2〜4 全体の作業・記録領域** であり、次の方針で扱う:
- `patterns.txt`, `fix_plan.json`, `new_framework_defaults_8_0.rb`, `diff_*.patch`,
`test_fix_result.json` は **読み取り専用**。このプロンプト4からは絶対に変更しない。
- 本プロンプトで新たに作成・更新してよい必須ファイルは、次の 1 つのみ:
- `tmp/rails_update/lint_final_result.json`
- その他のログファイルを作成する場合は、**人間が調査に使うための補助** に限り、
`tmp/rails_update` 配下に任意のファイル名で作成してよい。
これら任意ログの存在は、出力 JSON に反映する必要はない。
- **クリーンアップ(削除)は不要**:
- すべて `tmp/rails_update` 配下に集約し、人間が後でまとめて削除しやすい状態にする。
- このプロンプト4の終了時に `rm tmp/rails_update/...` で削除してはいけない(上書きは可)。
## 5. テスト / Lint コマンドの扱い
- 許可されるテスト・Lint コマンドは次の 3 つのみ:
- `docker compose run --rm web bin/rails -v`
- `docker compose run --rm web rails test`
- `docker compose run --rm web bundle exec rubocop -A`
- **パイプ (`|`) やリダイレクト (`>`, `>>`, `2>&1` 等) を付けて実行してはいけない。**
- 例: `docker compose run --rm web rails test 2>&1 | cat` は禁止。
- テストログや RuboCop 出力をファイルに残す必要がある場合は、
- すでにコンソールに出力された内容をもとに、
- `cat <<'EOF' > tmp/rails_update/xxx.txt` のように **後から書き起こす** 形にする。
## 6. Deprecation 警告の扱い
- D-CHECK はプロンプト3で完了済みだが、**LINT によるコード変更後も Deprecation が発生していないかを再確認する**。
- 各テスト実行ごとにログを解析し、`DEPRECATION WARNING` / `DEPRECATION:` を含む行を抽出する。
- 抽出した件数を整数としてカウントし、`deprecation_warnings_remaining` に反映する。
- 最終的に `deprecation_warnings_remaining = 0` でない場合は、`status: "success"` として終了してはいけない。
## 7. テスト & Lint のループ上限とエラーシグネチャ
- ループ制御用の上限値:
- `MAX_LINT_RUNS = 10`
- `MAX_TEST_RUNS = 10`
- `MAX_TOTAL_CYCLES = 10`(「Lint → Test」の 1 セットを 1 サイクルとカウント)
- テスト失敗時には、次の形式で **エラーシグネチャ** を生成する:
```text
<ExceptionClass> | <normalized_message> | <top_app_frame_path>:<line> | Rails 8.0.4
```
- `normalized_message`:
- ID・UUID・日付・一部の数値などの変動要素を正規化し、同種エラーが同じシグネチャになるように調整する。
- `top_app_frame_path:line`:
- スタックトレースのうち、最上位の `app/` または `lib/` 配下のフレームの `path:line` を用いる。
- 見つからない場合は、アプリケーションコードに最も近いフレームを選ぶ。
- 連続エラー判定:
- 同じテストエラーシグネチャ集合が **3 回連続** で発生した場合、
- これ以上の自動修正は困難とみなし、`status: "failed"` で終了する。
- このとき `error_summary` と `manual_check_items` に、人手で確認すべきポイントや代替方針を日本語で記載する。
## 8. RuboCop の扱い(LINT)
- RuboCop コマンドは常に **次の固定コマンド** を使う:
- `docker compose run --rm web bundle exec rubocop -A`
- 各 RuboCop 実行後に、以下を解析する:
- 「inspected X files, Y offenses detected」などのサマリ行
- 「Z offenses detected, Y offenses corrected」などの自動修正件数
- 「no offenses detected」などのクリーン状態のメッセージ
- 1 サイクル内の RuboCop 実行ポリシー:
1. まず 1 回 `rubocop -A` を実行する。
2. 出力から「自動修正が行われた」または「まだ offenses が残っている」と判断した場合、
**必ず直後にもう 1 回 `rubocop -A` を実行**し、2 回目の結果で「no offenses detected」になっているか確認する。
3. 2 回目実行後も offenses が残っている場合:
- RuboCop の Cop メッセージに基づき、Ruby コードのみを対象に、
違反解消に必要な **最小限の差分** で手動修正してよい。
- 手動修正後は、別サイクルとして再び RuboCop を実行し、クリーンになるかを確認する。
- それでも `MAX_LINT_RUNS` を超えても offenses が 0 にならない場合は、`status: "failed"` として終了し、
`error_summary` に「Lint の自動修正では解消できない違反が残っている」旨を記載する。
- 最終的に `last_lint_status` を
- `"clean"`(offenses 0・自動修正なし)
- `"corrected"`(自動修正や手動修正を含むが最終的に offenses 0)
- `"failed"`(offenses が残って終了)
のいずれかで記録する。
## 9. テスト再実行の条件
- 各サイクルでの基本フローは次の通り:
1. RuboCop 実行(必要に応じて 2 回以上)
2. RuboCop 上の offenses が 0(Lint クリーン)になったら
3. `docker compose run --rm web rails test` を 1 回実行
- テスト実行は、コードが変更されたサイクルでのみ行うことが望ましいが、
本プロンプトでは「LINT → TEST を常にセットで実行する」としてよい。
- `MAX_TEST_RUNS` および `MAX_TOTAL_CYCLES` を超えない範囲で、
テストが通るまで再度「RuboCop → Test」を繰り返す。
## 10. 終了条件
- {# 成功条件} を満たした場合のみ `status: "success"` として終了する。
- 満たせない場合は `status: "failed"` とし、{# 失敗時の扱い} に従って要約を出力する。
## 11. 出力の制約
- 最終出力は {# 出力形式} の JSON オブジェクト **のみ**。
- JSON 以外の自然言語の文章や説明を、**最終出力の直前・直後には出力してはいけない**。
- 途中の進捗ログ(日本語)は出力してよいが、最後は **JSON 単体** を出力して終了する。
---
# 使用可能コマンド {# 使用可能コマンド}
以下のコマンド群と、`ls` / `cat` / `mkdir -p` のみを使用してよい。
それ以外のコマンド(例: `grep`, `tee`, `wc` など)や、`/tmp` など **リポジトリ外** へのログ出力を伴うコマンドは実行してはいけない。
## バージョン確認 / テスト / Lint
- `docker compose run --rm web bin/rails -v`
- `docker compose run --rm web rails test`
- `docker compose run --rm web bundle exec rubocop -A`
※ これら 3 コマンドには、パイプ (`|`) やリダイレクト (`>`, `2>&1` 等) を付与してはならない。
## Git / Diff 関連
- `git status`
- `git diff`
## ファイル操作
- `mkdir -p tmp/rails_update`
- `ls`
- `ls <dir_path>`
- `cat <file_path>`
---
# 実行シナリオ {# 実行シナリオ}
1. {# Step1_事前確認と入力チェック}
2. {# Step2_LINT+TESTループ(RuboCop → Test)}
3. {# Step3_D-CHECK再確認}
4. {# Step4_終了判定と JSON 出力}
---
## Step1_事前確認と入力チェック {# Step1_事前確認と入力チェック}
1. **Rails バージョン確認**
- コマンド:
- `docker compose run --rm web bin/rails -v`
- 出力から `Rails 8.0.4` であることを確認する。
- `rails_version` には `"8.0.4"` を格納する("Rails " のプレフィックスは除く)。
- 8.0.4 でない場合:
- `failed_step: "precheck"`
- `error_summary` に「Rails バージョンが 8.0.4 ではないため LINT+TEST を実行できない」と記載し、
- 即座に `status: "failed"` で終了する。
2. **D-CHECK 完了状態の確認**
- `tmp/rails_update/test_fix_result.json` の存在を確認し、次を満たすことを論理的に検証する:
- `status: "success"`
- `last_test_status: "passed"`
- `deprecation_warnings_remaining: 0`
- `rails_version: "8.0.4"`
- いずれかが満たされない場合:
- `failed_step: "precheck"`
- `error_summary` に「プロンプト3(TEST+FIX+D-CHECK)が成功状態ではないため、本プロンプトを実行できない」旨を記載し、
- `status: "failed"` で終了する。
3. **作業用ディレクトリの準備**
- `mkdir -p tmp/rails_update` を実行する(既に存在していてもよい)。
---
## Step2_LINT+TESTループ(RuboCop → Test) {# Step2_LINT_TESTループ}
1. **ループ用カウンタと状態変数の初期化**
- `lint_run_count = 0`
- `test_run_count = 0`
- `total_cycle_count = 0`
- `last_test_error_signatures = []`
- `consecutive_same_test_error_count = 0`
- `last_lint_status = null`
- `deprecation_warnings_remaining = null`
2. **メインループ**
- 次の条件を満たす限りループを続ける:
- `total_cycle_count < MAX_TOTAL_CYCLES`
- まだ「最終成功条件」を満たしていない
- 各ループは「1 サイクル」として扱い、以下を行う:
### 2-1. LINT(RuboCop 実行)
1. **1 回目の RuboCop 実行**
- コマンド:
- `docker compose run --rm web bundle exec rubocop -A`
- `lint_run_count` をインクリメント。
- 出力を解析し、以下を判断する:
- offenses が 0 かどうか
- 自動修正(`offenses corrected` など)が発生したかどうか
2. **2 回目の RuboCop 実行(必要な場合のみ)**
- 1 回目の結果から、次のいずれかに当てはまる場合:
- 自動修正が行われた
- まだ offenses が残っている
- 上記の場合のみ、**もう 1 回だけ** 同じコマンドを実行する:
- `docker compose run --rm web bundle exec rubocop -A`
- `lint_run_count` を再度インクリメント。
- 2 回目の結果を解析し、offenses が 0 になっているか確認する。
3. **Lint 結果の判定**
- 2 回目までの実行結果を踏まえ、次のいずれかとして `last_lint_status` を更新する:
- offenses 0・自動修正なし → `"clean"`
- offenses 0・自動修正あり(または手動修正込み) → `"corrected"`
- offenses が残っている → `"failed"`
- offenses が残っている場合:
- まだ `MAX_LINT_RUNS` や `MAX_TOTAL_CYCLES` に余裕があるなら、
- Cop の指摘に従い Ruby コードのみを最小限で手動修正し、
次サイクルで再び RuboCop を実行してもよい。
- しかし、明らかに自動修正や最小修正では解決できないと判断した場合、もしくは上限を超える場合:
- `failed_step: "lint"`
- `error_summary` に「RuboCop の違反を自動修正では解消しきれなかった」旨を記載し、
- `status: "failed"` として Step4 に進む。
### 2-2. TEST(rails test 実行)
4. **Lint がクリーンになっていることの確認**
- `last_lint_status` が `"clean"` または `"corrected"` でない場合、テストを実行してはいけない。
- `"failed"` の場合は、前述の通り `status: "failed"` として終了準備に入る。
5. **テスト実行**
- コマンド:
- `docker compose run --rm web rails test`
- `test_run_count` をインクリメント。
- テスト出力を解析し、以下を判定する:
- 全テスト成功(0 failures, 0 errors)かどうか
- Deprecation 警告行(`DEPRECATION WARNING` / `DEPRECATION:`)の件数
6. **テスト結果・エラーシグネチャの更新**
- テスト成功の場合:
- `last_test_status = "passed"`
- `last_test_error_signatures = []`
- `consecutive_same_test_error_count = 0`
- テスト失敗の場合:
- `last_test_status = "failed"`
- 失敗ごとにエラーシグネチャを生成し、`last_test_error_signatures` に格納する。
- 直前サイクルのエラーシグネチャ集合と比較し、同一であれば `consecutive_same_test_error_count` を +1、
異なれば 1 にリセットする。
- `consecutive_same_test_error_count >= 3` の場合:
- `failed_step: "test"`
- `error_summary` に「同一のテストエラーが 3 回連続で発生したため、自動修正を打ち切った」旨を記載し、
- 人手で確認すべきポイントを {# 出力形式} の `manual_check_items` に列挙して `status: "failed"` とする。
7. **Deprecation 警告数の更新**
- テストログから Deprecation 行数を数え、`deprecation_warnings_remaining` に設定する。
### 2-3. サイクル終了判定
8. `total_cycle_count` を +1 する。
9. 次の条件をすべて満たしている場合、この Step2 のループを終了する:
- `last_lint_status` が `"clean"` または `"corrected"`
- `last_test_status` が `"passed"`
- `deprecation_warnings_remaining == 0`
10. 上記を満たさず、かつ
- `total_cycle_count >= MAX_TOTAL_CYCLES` または
- `lint_run_count >= MAX_LINT_RUNS` または
- `test_run_count >= MAX_TEST_RUNS`
のいずれかに達した場合:
- `failed_step` に `"lint"` または `"test"` を設定(より直近で限界となった方)
- `error_summary` に「自動ループ上限に達したため終了した」旨を記載し、
- `status: "failed"` として Step4 に進む。
---
## Step3_D-CHECK再確認 {# Step3_D_CHECK再確認}
- Step2 のループを抜けた後、**成功の可能性がある場合のみ** 以下を確認する:
1. `last_test_status == "passed"` であること。
2. `last_lint_status` が `"clean"` または `"corrected"` であること。
3. `deprecation_warnings_remaining == 0` であること。
- いずれかを満たさない場合は、すでに Step2 で `status: "failed"` としているはずだが、
もし未設定であれば `failed_step: "dcheck"` とし、`error_summary` に理由を記載して `status: "failed"` とする。
---
## Step4_終了判定と JSON 出力 {# Step4_終了判定}
1. **成功時 (`status: "success"`)**
- 次の条件をすべて満たす場合に、`status: "success"` としてよい:
1. `rails_version == "8.0.4"`
2. `last_test_status == "passed"`
3. `last_lint_status` が `"clean"` または `"corrected"`
4. `deprecation_warnings_remaining == 0`
- このとき、JSON には次を含める:
- `no_fix_reason`:
- **コードを一切変更しなかった場合**(Rubocop による自動修正も含め、実質的な変更がない場合)は、
- 「なぜ修正 0 件で問題ないと判断したか」を日本語 1〜3 文で記載する。
- Rubocop の自動修正や手動修正により **何らかの変更を行った場合** は `null` とする。
- `fixed_items_detail`:
- 代表的な修正内容を 0〜3 件程度、次の形式で記載してよい:
- `component`: 例 `"Lint"`
- `title`: 例 `"Style/MethodCallWithArgsParentheses の違反修正"`
- `rationale_url`: 関連する RuboCop Cop ドキュメントなど(あれば)
- `applied_to_files`: 修正が行われた代表的なファイルパス配列
- `reason`: 「なぜこの修正を行ったか/どんな意図の修正か」を日本語で要約
2. **失敗時 (`status: "failed"`)**
- {# 成功条件} をひとつでも満たさない場合は、必ず `status: "failed"` とする。
- このとき JSON には次を含める:
- `failed_step`: `"precheck"` | `"lint"` | `"test"` | `"dcheck"` | `"final"` のいずれか
- `error_summary`: 失敗理由の 1〜3 文の日本語要約
- `last_test_error_signatures`: 直近テストの代表的なエラーシグネチャ配列(無ければ空配列)
- `manual_check_items`: 人手で確認すべき具体的なポイント(テスト名、ファイル名、Cop 名など)を日本語で列挙する配列
- `no_fix_reason`: `null`
- `fixed_items_detail`: 空配列でよい
3. **最終 JSON の保存と出力**
- 構築した JSON オブジェクトを、**1 回だけ** 次の 2 つの形で出力する:
1. `tmp/rails_update/lint_final_result.json` に書き出す
(例として `cat <<'EOF' > tmp/rails_update/lint_final_result.json` で出力されるような内容と同等になるようにする)
2. 同じ JSON オブジェクトを、**標準出力にそのまま 1 回だけ** 出力する。
- このとき、前後に余計なログ行や説明文を付けないこと。
- 出力は純粋な JSON オブジェクトだけにする。
---
# 成功条件 {# 成功条件}
以下を **すべて満たす** 場合に、`status: "success"` としてよい。
1. Rails の実行バージョンが `8.0.4` である(Step1 で確認済み/`rails_version: "8.0.4"`)。
2. 直近の `docker compose run --rm web rails test` が成功している(`last_test_status: "passed"`)。
3. 直近の RuboCop 実行結果が、offenses 0 である(`last_lint_status: "clean"` または `"corrected"`)。
4. 直近のテストログに **Deprecation 警告が 0 件** である(`deprecation_warnings_remaining = 0`)。
5. `tmp/rails_update/lint_final_result.json` が存在し、その内容が最終出力した JSON と一致している。
---
# 失敗時の扱い {# 失敗時の扱い}
- {# 成功条件} を一つでも満たせない場合は、**必ず `status: "failed"` として終了** する。
- その際は、{# 出力形式} に定義する JSON の各項目を次のように設定する:
- `status`: `"failed"`
- `failed_step`: エラー発生フェーズ(例: `"precheck"`, `"lint"`, `"test"`, `"dcheck"`, `"final"`)
- `error_summary`: 原因を端的に説明する 1〜3 文の日本語
- `last_test_error_signatures`: 直近テストの代表的なエラーシグネチャ。テスト未実行であれば空配列。
- `no_fix_reason`: `null`
- `fixed_items_detail`: 空配列
- `manual_check_items`: 人手で確認して欲しいポイント(テスト名、ファイル名、Cop 名など)を配列で列挙
---
# 出力形式 {# 出力形式}
最終出力は **次の JSON オブジェクトのみ** を返すこと。
JSON 以外の自然言語の文章や説明は一切出力してはいけない。
```json
{
"status": "success or failed",
"rails_version": "docker compose run --rm web bin/rails -v で確認したバージョン(例: \"8.0.4\")。取得できなかった場合は null。",
"last_lint_status": "\"clean\" | \"corrected\" | \"failed\" のいずれか。Rubocop の最終状態。",
"last_lint_command": "常に \"docker compose run --rm web bundle exec rubocop -A\"。",
"lint_run_count": "Rubocop を実行した回数(整数)。",
"last_test_status": "passed or failed or not_run",
"last_test_command": "docker compose run --rm web rails test",
"test_run_count": "rails test を実行した回数(整数)。",
"last_test_error_signatures": [
"最後のテスト実行時に残っている代表的なエラーシグネチャ(なければ空配列)"
],
"deprecation_warnings_remaining": "直近のテストログに残っている Deprecation 警告の件数(整数)。成功時は 0。",
"tmp_dir": "常に \"tmp/rails_update\"。",
"lint_result_file": "常に \"tmp/rails_update/lint_final_result.json\"。",
"diff_summary": "必要に応じて、主要な変更ファイルや変更種類を日本語で簡潔に要約した文字列。変更が無ければ空文字列か null。",
"no_fix_reason": "修正を行わなかった場合の理由(日本語 1〜3 文程度)。修正が行われた場合や失敗時は null。",
"fixed_items_detail": [
{
"component": "修正対象となったコンポーネント名(例: \"Lint\")",
"title": "代表的な修正内容のタイトル(例: \"Style/MethodCallWithArgsParentheses の自動修正\")",
"rationale_url": "関連する RuboCop Cop ドキュメントやガイドの URL(任意)。無ければ空文字列か null。",
"applied_to_files": [
"修正が行われた代表的なファイルパス(例: \"app/models/user.rb\")"
],
"reason": "なぜこの修正を行ったか/どのような意図の修正かを日本語で要約した文章。"
}
],
"manual_check_items": [
"失敗時のみ: 人手で確認して欲しいポイント(テストケース名、ファイル名、Cop 名、再現手順など)を日本語で列挙。成功時は空配列。"
],
"failed_step": "null もしくは 'precheck' | 'lint' | 'test' | 'dcheck' | 'final'",
"error_summary": "失敗時のみ: エラー内容や Deprecation 残存理由の1〜3文要約。成功時は null。"
}
```
ファイル差分
tmp/rails_update/lint_final_result.json
{
"status": "success",
"rails_version": "8.0.4",
"last_lint_status": "clean",
"last_lint_command": "docker compose run --rm web bundle exec rubocop -A",
"lint_run_count": 1,
"last_test_status": "passed",
"last_test_command": "docker compose run --rm web rails test",
"test_run_count": 1,
"last_test_error_signatures": [],
"deprecation_warnings_remaining": 0,
"tmp_dir": "tmp/rails_update",
"lint_result_file": "tmp/rails_update/lint_final_result.json",
"diff_summary": "",
"no_fix_reason": "プロンプト3のTEST+FIX+D-CHECKフェーズで既にコード修正が完了しており、RuboCop実行時に623ファイル検査でoffensesが0件だったため、追加の修正は不要と判断した。テストも全て成功し、Deprecation警告も0件であることを確認した。",
"fixed_items_detail": [],
"manual_check_items": [],
"failed_step": null,
"error_summary": null
}
無事、LINT・再テストまで通過しました。
あとは人の手で修正内容をチェック → 動作確認を実施して問題なければ完了です✅
⚠️ActiveRecord::Relationをキャッシュしている場合は要注意
結論、『Rails7.2.3 の ActiveRecord::Relation(古いAR)』を Redis にキャッシュし、Rails8.0.4 でその古いARを読み出して blank? / empty? / to_a などを呼ぶと、NoMethodErrorが発生します。
この事象は、Rails8.0.4からRails8.1.1にアップデートする際にも発生します。
そもそも ActiveRecord::Relation(AR)をキャッシュしないのがベストですが、パフォーマンスの観点から処理を残したい場合は対応が必須です。
なお、キャッシュ期間を1日にしている場合、1日以上経過すれば Redis 上の AR は Rails8.0.4 で生成されたものに置き換わるため、それ以降はエラーが発生しなくなります。
Rails7.2.3でキャッシュし、Rails8.0.4にバージョンを上げるとコンソール上でも確認可能です。
[1] pry(main)> Rails.version
=> "8.0.4"
[2] pry(main)> Rails.cache.redis.with { |conn| conn.keys("*TitlesController*") }
=> ["TitlesController_25_12_03"]
[3] pry(main)> key = "TitlesController_25_12_03"
=> "TitlesController_25_12_03"
[4] pry(main)> cached_titles = Rails.cache.read(key)
=> #<Title::ActiveRecord_Relation:0x0000ffff989b4400 ...>
[5] pry(main)> cached_titles.class
=> Title::ActiveRecord_Relation
[6] pry(main)> cached_titles.instance_variable_get(:@klass)
=> Title (call 'Title.load_schema' to load schema informations)
[7] pry(main)> cached_titles.instance_variable_get(:@model)
=> nil
[8] pry(main)> cached_titles.blank?
NoMethodError: undefined method `with_connection' for nil:NilClass (NoMethodError)
model.with_connection do |c|
^^^^^^^^^^^^^^^^
Did you mean? with_options
from /usr/local/bundle/gems/activerecord-8.0.4/lib/active_record/relation.rb:1458:in `block in exec_main_query'
また、Rails8.0.4からRails8.1.1に上げた際は、以下のようなエラーになります。
[7] pry(main)> cached_titles.blank?
NoMethodError: undefined method `<=' for nil:NilClass (NoMethodError)
value && (@max <= value || @min > value)
^^
from /usr/local/bundle/gems/activemodel-8.1.1/lib/active_model/type/integer.rb:105:in `out_of_range?'
暫定対応であれば、以下のように例外が出たらキャッシュを作り直す形で良さそうです。
def recover_invalid_cached_titles(titles:, cache_key:, params:, expires_in:)
titles.blank?
titles
rescue StandardError => e
Rails.logger.warn("警告文")
regenerated_titles = ::TitleFinder.call(**params)
Rails.cache.write(cache_key, regenerated_titles, expires_in:)
regenerated_titles
end
Rails8.0.4 → 8.1.1
対応自体は完了しているので、また近いうちに記事を書きます。
今後の課題
- どれも2〜3営業日で設計からデプロイまで対応したため、設計自体まだ未完成です
- 更なるブラッシュアップの余地があるので、今後のアップデートのたびに改善していきます
- 特に プロンプト3(TEST + FIX) は大分ボリューミーになってしまっているので、可能であれば精度を落とさずに短くしていきたいです
- とはいえ
Claude Sonnetが優秀なので甘えちゃおうかな〜(怠惰)
- とはいえ
最後に
- 本記事では、
Rails 7.2→8.0のアップデートを AI に任せるための設計プロンプトと、適用差分の要点をまとめました - 今回は大きな変更こそなかったものの、Changelogの見落としといったヒューマンエラーを抑えたり、今後のアプデもAIに任せることを踏まえると、設計プロンプトをブラッシュアップできて良かったと思います
-
Rails 8.0.4→8.1.1の詳細は別記事でまとめます