# バッチ設計書 48-active_storage:install

## 概要

本ドキュメントは、Active Storageに必要なマイグレーションをアプリケーションにコピーするRakeタスク `active_storage:install` の設計仕様を定義する。

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

`active_storage:install` タスクは、Active Storage（ファイルアップロード・添付機能）をRailsアプリケーションに導入するためのマイグレーションファイルをコピーするインストーラタスクである。

**業務上の目的・背景**：Active Storageは、Rails 5.2で導入されたファイルアップロード・添付機能を提供するフレームワークである。クラウドストレージサービス（Amazon S3、Google Cloud Storage、Microsoft Azure Storage）やローカルディスクへのファイル保存を統一的なAPIで扱えるようにする。本タスクは、この機能を使用するために必要なデータベーステーブル（active_storage_blobs、active_storage_attachments、active_storage_variant_records）を作成するマイグレーションファイルをアプリケーションにコピーする。

**バッチの実行タイミング**：手動実行が主体であり、以下のような場面で使用される。
- Railsアプリケーションへの Active Storage 初回導入時
- 新規プロジェクトでファイルアップロード機能が必要な場合

**主要な処理内容**：
1. active_storage:install:migrations タスクが定義されているか確認
2. 定義されている場合は active_storage:install:migrations を実行
3. 定義されていない場合は app:active_storage:install:migrations を実行
4. Active Storageのマイグレーションファイルをdb/migrateにコピー

**前後の処理との関連**：本タスクはマイグレーションファイルをコピーするのみ。インストール後は `db:migrate` を実行してマイグレーションを適用する必要がある。Action Text や Action Mailbox を使用する場合は、それぞれのインストールタスクが本タスクを内部で呼び出す。

**影響範囲**：db/migrateディレクトリにマイグレーションファイルを追加する。既存のファイルへの変更は行わない。

## バッチ種別

インストール / セットアップ

## 実行スケジュール

| 項目 | 内容 |
|-----|------|
| 実行頻度 | 1回（初回導入時） |
| 実行時刻 | 任意 |
| 実行曜日 | 任意 |
| 実行日 | 任意 |
| トリガー | 手動（bin/rails active_storage:install） |

## 実行条件

### 前提条件

| 条件 | 説明 |
|-----|------|
| Rails環境 | Rails 5.2以上のアプリケーションであること |
| データベース設定 | database.ymlが設定されていること |

### 実行可否判定

Railsアプリケーションであれば実行可能。既に同名のマイグレーションが存在する場合はスキップされる。

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | デフォルト値 | 説明 |
|-------------|-----|-----|-------------|------|
| なし | - | - | - | 入力パラメータは不要 |

### 入力データソース

| データソース | 形式 | 説明 |
|-------------|------|------|
| activestorage gemのマイグレーション | Ruby | コピー元のマイグレーションファイル |

## 出力仕様

### 出力データ

| 出力先 | 形式 | 説明 |
|-------|------|------|
| 標準出力 | テキスト | コピー結果のメッセージ |

### 出力ファイル仕様

| 項目 | 内容 |
|-----|------|
| ファイル名 | *_create_active_storage_tables.rb |
| 出力先 | db/migrate/ |
| 内容 | active_storage_blobs, active_storage_attachments, active_storage_variant_records テーブル作成 |

## 処理フロー

### 処理シーケンス

```
1. 環境のロード
   └─ :environment 依存でRails環境をロード
2. タスク存在確認
   └─ Rake::Task.task_defined?("active_storage:install:migrations") を確認
3. マイグレーションコピー実行
   └─ 該当するinstall:migrations タスクを invoke
4. 結果メッセージの出力
   └─ コピーされたファイルまたはスキップされたファイルを表示
```

### フローチャート

```mermaid
flowchart TD
    A[バッチ開始] --> B[:environment でRails環境ロード]
    B --> C{active_storage:install:migrations 定義あり？}
    C -->|Yes| D[active_storage:install:migrations 実行]
    C -->|No| E[app:active_storage:install:migrations 実行]
    D --> F[マイグレーションファイルをdb/migrateにコピー]
    E --> F
    F --> G{同名ファイル存在？}
    G -->|Yes| H[スキップメッセージ出力]
    G -->|No| I[コピー完了メッセージ出力]
    H --> J[バッチ終了]
    I --> J
```

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

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

| 処理 | 対象テーブル | 操作種別 | 概要 |
|-----|-------------|---------|------|
| なし | - | - | 本タスク自体はDB操作なし |

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

本タスクはマイグレーションファイルのコピーのみ。`db:migrate` 実行後に以下のテーブルが作成される。

| テーブル名 | 説明 |
|-----------|------|
| active_storage_blobs | アップロードファイルのメタデータ |
| active_storage_attachments | モデルとBlobの関連付け |
| active_storage_variant_records | 画像バリアントのキャッシュ |

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| - | ファイル書き込みエラー | 権限不足 | db/migrateの権限を確認 |

### リトライ仕様

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

### 障害時対応

権限エラーの場合は、db/migrateディレクトリの書き込み権限を確認する。

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

| 項目 | 内容 |
|-----|------|
| トランザクション範囲 | なし（ファイル操作のみ） |
| コミットタイミング | なし |
| ロールバック条件 | なし |

## パフォーマンス要件

| 項目 | 内容 |
|-----|------|
| 想定処理件数 | 1回 |
| 目標処理時間 | 即時（数秒以内） |
| メモリ使用量上限 | 最小限 |

## 排他制御

同時実行は推奨されない。ただし、同名ファイルはスキップされるため競合は発生しにくい。

## ログ出力

| ログ種別 | 出力タイミング | 出力内容 |
|---------|--------------|---------|
| 標準出力 | コピー時 | "Copied migration xxx from active_storage" |
| 標準出力 | スキップ時 | "NOTE: Migration xxx has been skipped..." |

## 監視・アラート

| 監視項目 | 閾値 | アラート先 |
|---------|-----|----------|
| - | - | - |

本タスクは1回限りの実行が主であり、監視は不要。

## 備考

- インストール後は `bin/rails db:migrate` を実行してマイグレーションを適用する
- config/storage.yml でストレージサービスを設定する必要がある
- ローカルディスクストレージがデフォルトで使用可能
- 本番環境ではクラウドストレージの設定を推奨
- install:migrationsタスクのコメントがclearされているのは、タスク一覧での重複表示を防ぐため
