# バッチ設計書 47-action_text:install

## 概要

本ドキュメントは、Action Textのマイグレーション、スタイルシート、JavaScriptファイルをコピーするRakeタスク `action_text:install` の設計仕様を定義する。

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

`action_text:install` タスクは、Action Text（リッチテキストエディタ機能）をRailsアプリケーションに導入するためのセットアップを実行するインストーラタスクである。必要なマイグレーション、スタイルシート、ビューテンプレート、JavaScript依存関係を自動的に設定する。

**業務上の目的・背景**：Action Textは、Rails 6.0で導入されたリッチテキスト編集機能を提供するフレームワークである。Trixエディタを使用して、ユーザーがブログ記事やコメントなどのリッチテキストコンテンツを作成・編集できるようにする。本タスクは、この機能を使用するために必要なファイルやマイグレーションを自動的にセットアップし、開発者の初期設定の手間を軽減する。

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

**主要な処理内容**：
1. Rails::Command.invokeを使用してaction_text:installジェネレータを呼び出し
2. Trixエディタ（またはオプションで指定したエディタ）のJavaScript依存関係をインストール
3. app/javascript/application.jsにエディタのインポート文を追加
4. config/importmap.rbにエディタのピン設定を追加
5. @rails/actiontextのJavaScript依存関係をインストール
6. app/javascript/application.jsに@rails/actiontextのインポート文を追加
7. config/importmap.rbにactiontext.esm.jsのピン設定を追加
8. app/assets/stylesheets/actiontext.cssをコピー
9. app/views/active_storage/blobs/_blob.html.erbをコピー
10. app/views/layouts/action_text/contents/_content.html.erbをコピー
11. railties:install:migrations FROM=active_storage,action_textでマイグレーションをコピー

**前後の処理との関連**：本タスクは Active Storage のマイグレーションも含めてインストールする。Action Text は Active Storage に依存しているため、両方のマイグレーションが必要。インストール後は `db:migrate` を実行してマイグレーションを適用する必要がある。

**影響範囲**：アプリケーションのファイルシステムに以下の変更を加える。
- app/views配下にビューテンプレートを追加
- app/assets/stylesheets配下にCSSファイルを追加
- app/javascript/application.jsにインポート文を追加
- config/importmap.rbにピン設定を追加
- db/migrateにマイグレーションファイルを追加

## バッチ種別

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

## 実行スケジュール

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

## 実行条件

### 前提条件

| 条件 | 説明 |
|-----|------|
| Rails環境 | Rails 6.0以上のアプリケーションであること |
| Node.js | npm/yarn使用時はNode.js環境が必要 |

### 実行可否判定

Railsアプリケーションであれば実行可能。既にインストール済みの場合でも実行できるが、ファイルの上書きが発生する可能性がある。

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | デフォルト値 | 説明 |
|-------------|-----|-----|-------------|------|
| --editor | String | No | trix | 使用するエディタ（デフォルトはTrix） |

### 入力データソース

| データソース | 形式 | 説明 |
|-------------|------|------|
| action_text gemのテンプレート | ERB/CSS | コピー元のファイル群 |

## 出力仕様

### 出力データ

| 出力先 | 形式 | 説明 |
|-------|------|------|
| 標準出力 | テキスト | 処理進捗メッセージ |

### 出力ファイル仕様

| 項目 | 内容 |
|-----|------|
| app/assets/stylesheets/actiontext.css | CSSスタイルシート |
| app/views/active_storage/blobs/_blob.html.erb | Blobパーシャル |
| app/views/layouts/action_text/contents/_content.html.erb | コンテンツレイアウト |
| db/migrate/*_create_action_text_tables.rb | マイグレーションファイル |
| db/migrate/*_create_active_storage_tables.rb | Active Storageマイグレーション |

## 処理フロー

### 処理シーケンス

```
1. Rails::Command.invoke でジェネレータ呼び出し
   └─ generate action_text:install を実行
2. エディタのインストール
   └─ npm/yarn で trix をインストール（JS runtime使用時）
3. エディタのJSインポート追加
   └─ app/javascript/application.js に追記
4. importmap設定追加
   └─ config/importmap.rb に追記
5. @rails/actiontext のインストール
   └─ npm/yarn で依存関係をインストール
6. actiontext のJSインポート追加
   └─ app/javascript/application.js に追記
7. スタイルシートのコピー
   └─ actiontext.css を app/assets/stylesheets にコピー
8. ビューテンプレートのコピー
   └─ _blob.html.erb と _content.html.erb をコピー
9. マイグレーションのコピー
   └─ railties:install:migrations を実行
```

### フローチャート

```mermaid
flowchart TD
    A[バッチ開始] --> B{JS runtime使用？}
    B -->|Yes| C[trix インストール]
    B -->|No| D[インストールスキップ]
    C --> E[application.js に import 追加]
    D --> F[手動設定の案内出力]
    E --> G[importmap.rb に pin 追加]
    F --> G
    G --> H{JS runtime使用？}
    H -->|Yes| I[@rails/actiontext インストール]
    H -->|No| J[インストールスキップ]
    I --> K[application.js に import 追加]
    J --> L[手動設定の案内出力]
    K --> M[CSS ファイルコピー]
    L --> M
    M --> N[ビューテンプレートコピー]
    N --> O[マイグレーションコピー]
    O --> P[バッチ終了]
```

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

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

| 処理 | 対象テーブル | 操作種別 | 概要 |
|-----|-------------|---------|------|
| マイグレーション適用後 | action_text_rich_texts | CREATE TABLE | リッチテキスト格納テーブル |
| マイグレーション適用後 | active_storage_blobs | CREATE TABLE | Active Storage Blob |
| マイグレーション適用後 | active_storage_attachments | CREATE TABLE | Active Storage 添付 |

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

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

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| - | ファイル書き込みエラー | 権限不足 | ディレクトリの権限を確認 |
| - | npm/yarnエラー | パッケージインストール失敗 | Node.js環境を確認 |

### リトライ仕様

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

### 障害時対応

エラー発生時は、出力されたエラーメッセージを確認し、手動でファイルをコピーするか、環境を整備して再実行する。

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

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

## パフォーマンス要件

| 項目 | 内容 |
|-----|------|
| 想定処理件数 | 1回 |
| 目標処理時間 | 数秒〜数分（npm/yarnインストール時間に依存） |
| メモリ使用量上限 | 最小限 |

## 排他制御

同時実行は推奨されない。ファイル競合が発生する可能性がある。

## ログ出力

| ログ種別 | 出力タイミング | 出力内容 |
|---------|--------------|---------|
| 標準出力 | 各処理ステップ | 処理内容と結果 |

## 監視・アラート

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

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

## 備考

- インストール後は `bin/rails db:migrate` を実行してマイグレーションを適用する
- Trix以外のエディタを使用する場合は `--editor` オプションを指定
- importmapを使用しない場合（webpacker等）は、手動でJavaScript設定が必要
- Action TextはActive Storageに依存するため、両方のマイグレーションが必要
- モデルでリッチテキストを使用するには `has_rich_text :content` を追加する
