# バッチ設計書 29-rake checkupdate

## 概要

本ドキュメントは、mrubyプロジェクトにおける `rake checkupdate` タスクのバッチ設計書である。prek（pre-commitフレームワーク）のフック定義の更新を確認し、自動更新する処理を定義する。

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

`rake checkupdate` は、prek（pre-commitツール）の `autoupdate` コマンドを実行して、`.pre-commit-config.yaml` に定義されたフックリポジトリの最新バージョンを確認し、設定ファイルを自動更新するRakeタスクである。

**業務上の目的・背景**：pre-commitフックは外部リポジトリから取得されるため、定期的にバージョンの更新が必要である。本タスクは、フック定義のバージョンを最新に更新することで、最新のコード品質チェックルールを適用し、セキュリティ修正やバグ修正を取り込むために使用される。

**バッチの実行タイミング**：手動実行。フックの更新確認が必要な場合に随時実行する。定期的なメンテナンス作業の一環として実行することが推奨される。

**主要な処理内容**：
1. `prek autoupdate` コマンドを実行
2. .pre-commit-config.yaml に定義された各フックリポジトリの最新バージョンを確認
3. 新しいバージョンが利用可能な場合、.pre-commit-config.yaml のrev値を自動更新

**前後の処理との関連**：`rake checkinstall` でフックがインストール済みであることが前提。更新後は `rake check` で全ファイルに対してチェックを実行し、新しいバージョンのフックで問題がないか確認することが推奨される。

**影響範囲**：`.pre-commit-config.yaml` ファイルのrev（バージョン）指定が更新される可能性がある。

## バッチ種別

環境設定（フック更新確認）

## 実行スケジュール

| 項目 | 内容 |
|-----|------|
| 実行頻度 | 随時（定期メンテナンス推奨） |
| 実行時刻 | 任意 |
| 実行曜日 | N/A |
| 実行日 | N/A |
| トリガー | 手動（`rake checkupdate` コマンド実行） |

## 実行条件

### 前提条件

| 条件 | 説明 |
|-----|------|
| prek インストール済み | `prek` コマンドが実行可能であること |
| pre-commit設定 | `.pre-commit-config.yaml` がリポジトリルートに存在すること |
| ネットワーク接続 | フックリポジトリの最新バージョンを確認するためにインターネット接続が必要 |
| Ruby環境 | Rakeが実行可能なRuby環境がセットアップされていること |

### 実行可否判定

`prek` コマンドがPATH上に存在し、`.pre-commit-config.yaml` が存在し、ネットワーク接続が利用可能な場合に実行可能。

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | デフォルト値 | 説明 |
|-------------|-----|-----|-------------|------|
| N/A | N/A | N/A | N/A | コマンドライン引数は受け取らない |

### 入力データソース

| データソース | 形式 | 説明 |
|-------------|------|------|
| .pre-commit-config.yaml | YAML | pre-commitフック設定ファイル |
| 外部リポジトリ | Git | 各フックの最新バージョン情報 |

## 出力仕様

### 出力データ

| 出力先 | 形式 | 説明 |
|-------|------|------|
| .pre-commit-config.yaml | YAML | 更新されたフック設定ファイル（バージョン更新がある場合） |
| 標準出力 | テキスト | 更新結果 |

### 出力ファイル仕様

| 項目 | 内容 |
|-----|------|
| ファイル名 | .pre-commit-config.yaml |
| 出力先 | リポジトリルート |
| 文字コード | UTF-8 |
| 区切り文字 | N/A（YAML形式） |

## 処理フロー

### 処理シーケンス

```
1. rake checkupdate タスク開始
2. sh "prek autoupdate" を実行
   └─ .pre-commit-config.yaml を読み込み
   └─ 各フックリポジトリの最新バージョンを確認
   └─ 新しいバージョンがある場合、.pre-commit-config.yaml のrevを更新
   └─ 更新結果をコンソールに出力
3. rake checkupdate タスク完了
```

### フローチャート

```mermaid
flowchart TD
    A[rake checkupdate 開始] --> B[prek autoupdate 実行]
    B --> C[各フックリポジトリの最新バージョン確認]
    C --> D{更新あり?}
    D -->|Yes| E[.pre-commit-config.yaml を更新]
    D -->|No| F[変更なし]
    E --> G[正常終了]
    F --> G
```

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

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

本バッチはデータベース操作を行わない。

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| N/A | コマンド未検出 | prek がインストールされていない | pip/pipx等でprekをインストール |
| N/A | ネットワークエラー | インターネット接続が利用できない | ネットワーク接続を確認して再実行 |
| N/A | 設定ファイル不在 | .pre-commit-config.yaml が存在しない | 設定ファイルを作成 |

### リトライ仕様

| 項目 | 内容 |
|-----|------|
| リトライ回数 | なし（手動で再実行） |
| リトライ間隔 | N/A |
| リトライ対象エラー | N/A |

### 障害時対応

ネットワークエラーの場合は接続を確認して再実行する。

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

| 項目 | 内容 |
|-----|------|
| トランザクション範囲 | N/A |
| コミットタイミング | N/A |
| ロールバック条件 | Gitで .pre-commit-config.yaml の変更を revert 可能 |

## パフォーマンス要件

| 項目 | 内容 |
|-----|------|
| 想定処理件数 | フック定義数分のバージョン確認 |
| 目標処理時間 | ネットワーク速度に依存（数秒〜数十秒） |
| メモリ使用量上限 | prek プロセスの標準的なメモリ使用量 |

## 排他制御

同時実行は特に制限されないが、.pre-commit-config.yaml の同時更新は避けるべき。

## ログ出力

| ログ種別 | 出力タイミング | 出力内容 |
|---------|--------------|---------|
| 進捗ログ | 各フックの確認時 | フック名と更新状況 |
| 結果ログ | 処理完了時 | 更新されたフックの一覧 |

## 監視・アラート

| 監視項目 | 閾値 | アラート先 |
|---------|-----|----------|
| N/A | N/A | N/A（手動実行タスクのため監視対象外） |

## 備考

- `prek autoupdate` は .pre-commit-config.yaml を直接編集するため、更新後にGitの差分確認を推奨
- 更新された .pre-commit-config.yaml はコミットしてリポジトリに反映する必要がある
- `sh` メソッドを使用しているため、コマンドが非0で終了した場合はRakeタスクも失敗する
- ネットワーク接続が必要なため、オフライン環境では実行不可
