# バッチ設計書 5-rename

## 概要

本ドキュメントは、clojure-lspのrenameコマンド（シンボルリネーム機能）のバッチ設計を記載する。

### 本バッチの処理概要

Clojure/ClojureScriptプロジェクト内の特定のシンボル（変数、関数、名前空間等）をプロジェクト全体で一括してリネームする機能を提供する。シンボルの定義箇所だけでなく、全ての参照箇所も自動的に更新し、ファイル名の変更（名前空間リネーム時）も含めて処理する。

**業務上の目的・背景**：リファクタリング作業において、シンボル名の変更は頻繁に発生する。手動でのリネームは漏れやミスが発生しやすく、大規模なコードベースでは非常に困難。本コマンドにより、安全かつ確実にプロジェクト全体のシンボル名を変更できる。

**バッチの実行タイミング**：開発者が手動で実行。リファクタリング作業時に使用される。

**主要な処理内容**：
1. プロジェクトの解析と依存関係の収集
2. 対象シンボルの検索（--fromで指定）
3. シンボルの全参照箇所の特定
4. 新しい名前（--toで指定）への置換処理
5. 名前空間リネームの場合はファイル名も変更
6. 変更の適用（--dryの場合はdiff表示のみ）

**前後の処理との関連**：他のコマンドの前提条件ではない。独立して動作するリファクタリングツール。

**影響範囲**：指定されたシンボルを参照する全てのファイル。名前空間リネームの場合はファイル名も変更される。

## バッチ種別

リファクタリング処理

## 実行スケジュール

| 項目 | 内容 |
|-----|------|
| 実行頻度 | 随時（手動） |
| 実行時刻 | 該当なし |
| 実行曜日 | 該当なし |
| 実行日 | 該当なし |
| トリガー | 手動実行 |

## 実行条件

### 前提条件

| 条件 | 説明 |
|-----|------|
| プロジェクト存在 | deps.edn/project.clj等のプロジェクトファイルが存在すること |
| 対象シンボル存在 | --fromで指定したシンボルがプロジェクト内に存在すること |

### 実行可否判定

指定されたシンボルがプロジェクト内で見つかること。見つからない場合はエラーを返す。

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | デフォルト値 | 説明 |
|-------------|-----|-----|-------------|------|
| --from | Symbol | Yes | - | リネーム対象の完全修飾シンボル（例: my-ns/my-var） |
| --to | Symbol | Yes | - | 新しい完全修飾シンボル名 |
| --dry | Boolean | No | false | 変更を適用せず差分のみ表示 |
| --project-root | Path | No | カレントディレクトリ | プロジェクトルートパス |
| --settings / -s | EDN | No | {} | 追加設定をEDN形式で指定 |
| --raw | Boolean | No | false | 出力を最小限にする |

### 入力データソース

| データソース | 形式 | 説明 |
|-------------|------|------|
| Clojureソースファイル | .clj/.cljs/.cljc | 解析対象のソースコード |
| プロジェクトファイル | deps.edn等 | classpathとsource-paths取得用 |
| .lsp/config.edn | EDN | clojure-lsp設定ファイル |

## 出力仕様

### 出力データ

| 出力先 | 形式 | 説明 |
|-------|------|------|
| ソースファイル | .clj/.cljs/.cljc | 更新されたソースコード（--dryなしの場合） |
| 標準出力 | テキスト | 処理結果メッセージ/diff |
| 標準エラー出力 | テキスト | 進捗情報、ログ |

### 出力ファイル仕様

| 項目 | 内容 |
|-----|------|
| ファイル名 | 元のファイル名を維持（名前空間リネーム時は変更） |
| 出力先 | 元のファイルを上書き |
| 文字コード | 元のファイルのエンコーディングを維持 |
| 区切り文字 | 該当なし |

## 処理フロー

### 処理シーケンス

```
1. CLI引数パース
   └─ --from、--toオプションの検証（必須チェック）
2. コンポーネント構築
   └─ CLILogger、APIProducerの初期化
3. プロジェクト解析
   └─ setup-project-only-analysis!実行
4. シンボル検索
   └─ q/find-element-from-symで対象シンボルを検索
5. リネーム実行
   └─ f.rename/rename-from-positionで変更内容を計算
6. 変更適用
   └─ --dryの場合はdiff表示、そうでなければファイル書き込み
7. 終了
   └─ 結果コードとメッセージの返却
```

### フローチャート

```mermaid
flowchart TD
    A[バッチ開始] --> B[CLI引数パース]
    B --> C{--from, --to必須チェック}
    C -->|不足| D[エラー: Missing required option]
    C -->|OK| E[コンポーネント構築]
    E --> F[プロジェクト解析]
    F --> G[シンボル検索]
    G --> H{シンボル発見?}
    H -->|No| I[Symbol not found in project]
    H -->|Yes| J[リネーム実行]
    J --> K{edits存在?}
    K -->|なし| L[Nothing to rename]
    K -->|あり| M{--dry?}
    M -->|Yes| N[diff表示]
    N --> O[終了コード0]
    M -->|No| P[ファイル書き込み]
    P --> Q[Renamed X to Y]
    Q --> O
    D --> R[終了コード1]
    I --> R
    L --> R
    O --> S[バッチ終了]
    R --> S
```

## データベース操作仕様

### 操作別データベース影響一覧

| 処理 | 対象テーブル | 操作種別 | 概要 |
|-----|-------------|---------|------|
| 該当なし | - | - | 外部DBは使用しない |

### テーブル別操作詳細

本バッチは外部データベースを使用しない。内部的にAtom（db*）を使用してプロジェクト解析結果を管理する。

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| 1 | 必須オプション不足 | --fromまたは--toが未指定 | オプションを指定して再実行 |
| 1 | シンボル未発見 | --fromで指定したシンボルが見つからない | シンボル名を確認 |
| 1 | リネーム失敗 | リネーム処理でエラー発生 | エラーメッセージを確認 |
| 1 | 変更なし | リネーム対象がない | 対象シンボルの使用箇所を確認 |

### リトライ仕様

| 項目 | 内容 |
|-----|------|
| リトライ回数 | 0（リトライなし） |
| リトライ間隔 | 該当なし |
| リトライ対象エラー | 該当なし |

### 障害時対応

ファイル書き込みエラーが発生した場合、処理を中断する。--dryモードで事前確認することを推奨。一部のファイルのみ更新された場合は、Gitなどのバージョン管理システムで復旧可能。

## トランザクション仕様

| 項目 | 内容 |
|-----|------|
| トランザクション範囲 | ファイル単位 |
| コミットタイミング | 各ファイル処理完了時 |
| ロールバック条件 | 該当なし（ファイル単位で書き込み） |

## パフォーマンス要件

| 項目 | 内容 |
|-----|------|
| 想定処理件数 | 参照箇所の数に依存 |
| 目標処理時間 | 初回解析含め数秒〜数十秒 |
| メモリ使用量上限 | JVMヒープに依存 |

## 排他制御

同時に複数のrename実行は推奨しない。複数のリネームを連続実行する場合は順次実行すること。

## ログ出力

| ログ種別 | 出力タイミング | 出力内容 |
|---------|--------------|---------|
| 進捗ログ | 解析中 | 解析進捗率 |
| 結果ログ | 処理完了時 | "Renamed X to Y" |
| エラーログ | エラー発生時 | "Symbol X not found in project" |

## 監視・アラート

| 監視項目 | 閾値 | アラート先 |
|---------|-----|----------|
| 終了コード | 0以外 | 該当なし（インタラクティブ実行） |

## 備考

- --fromには完全修飾シンボル（namespace/name）または名前空間のみ（namespace）を指定可能
- 名前空間のみの場合（simple-symbol?がtrue）、名前空間自体のリネームとなる
- 名前空間リネームの場合、ファイル名も自動的に変更される（:kindが:renameの編集）
- f.rename/rename-from-positionで変更内容を計算
- document-changesにはテキスト変更とファイルリネームの両方が含まれる可能性がある
- pmapによる並列処理でパフォーマンス最適化されている
