# 機能設計書 43-ステップ編集

## 概要

本ドキュメントは、カードに追加されたステップの内容や完了状態を編集する機能の設計を定義するものである。

### 本機能の処理概要

**業務上の目的・背景**：タスク管理において、サブタスク（ステップ）の内容変更や進捗状況の更新は日常的に発生する。ステップ編集機能は、作成済みのステップの内容を修正したり、完了/未完了の状態を切り替えたりすることで、タスクの進捗を正確に管理できるようにする。特に、チェックボックスによる完了状態の切り替えは、直感的な操作で進捗管理を可能にする。

**機能の利用シーン**：
- ステップの内容を修正したいとき
- ステップを完了としてマークしたいとき
- 完了したステップを未完了に戻したいとき
- タスクの進捗状況を更新したいとき

**主要な処理内容**：
1. PATCHリクエストでステップの更新内容を受け取る
2. 対象カードおよびステップへのアクセス権限を確認する
3. ステップの内容または完了状態を更新する
4. Turbo StreamまたはJSONレスポンスで結果を返却する

**関連システム・外部連携**：特になし（内部処理のみ）

**権限による制御**：カードへのアクセス権限を持つユーザーのみがステップを編集可能。CardScopedモジュールにより、`Current.user.accessible_cards`でアクセス可能なカードのみ操作対象となる。

## 関連画面

| 画面No | 画面名 | 関連種別 | 関連する操作・処理 |
|--------|--------|----------|------------------|
| 28 | カードステップ詳細画面 | 参照画面 | ステップの内容や完了状態を編集 |
| 29 | カードステップ編集画面 | 主機能 | ステップの内容や完了状態を編集 |
| 19 | カード詳細画面 | 参照画面 | チェックボックスで完了状態を変更 |

## 機能種別

CRUD操作（Update）

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | 説明 | バリデーション |
|-------------|-----|-----|------|---------------|
| card_id | Integer | Yes | 対象カードのID（URLパラメータ） | 存在確認、アクセス権限確認 |
| id | UUID | Yes | 対象ステップのID（URLパラメータ） | 存在確認 |
| step[content] | String | No | ステップの内容 | presence: true（更新時） |
| step[completed] | Boolean | No | 完了状態 | - |

### 入力データソース

- URLパラメータからカードIDとステップID
- フォームデータまたはJSONからステップの更新内容

## 出力仕様

### 出力データ

| 項目名 | 型 | 説明 |
|--------|-----|------|
| @step | Step | 更新されたステップオブジェクト |

### 出力先

- Turbo Stream: 画面の動的更新（既存要素の置換）
- JSON: API利用時のレスポンス（showアクションをレンダリング）

## 処理フロー

### 処理シーケンス

```
1. リクエスト受信
   └─ PATCH /cards/:card_id/steps/:id へのリクエストを受信

2. 認証・認可確認
   └─ CardScopedモジュールのset_cardでカードアクセス権限を確認

3. ステップ取得
   └─ set_stepでカードに紐づくステップを取得

4. ステップ更新
   └─ @step.update!(step_params) でステップを更新

5. レスポンス生成
   ├─ Turbo Stream: update.turbo_stream.erb をレンダリング
   └─ JSON: showアクションをレンダリング
```

### フローチャート

```mermaid
flowchart TD
    A[PATCH /cards/:card_id/steps/:id] --> B{認証済み?}
    B -->|No| C[401 Unauthorized]
    B -->|Yes| D[set_card: カード取得]
    D --> E{カードアクセス可能?}
    E -->|No| F[404 Not Found]
    E -->|Yes| G[set_step: ステップ取得]
    G --> H{ステップ存在?}
    H -->|No| I[404 Not Found]
    H -->|Yes| J[step_paramsでパラメータ抽出]
    J --> K[@step.update!でステップ更新]
    K --> L{更新成功?}
    L -->|No| M[422 Unprocessable Entity]
    L -->|Yes| N{リクエスト形式}
    N -->|Turbo Stream| O[update.turbo_stream.erb]
    N -->|JSON| P[render :show]
```

## ビジネスルール

### 業務ルール

| ルールNo | ルール名 | 内容 | 適用条件 |
|---------|---------|------|---------|
| BR-43-01 | カードスコープ | カードに紐づくステップのみ更新可能 | 常時 |
| BR-43-02 | 内容必須 | contentを更新する場合は空文字不可 | content更新時 |
| BR-43-03 | 完了状態切替 | completedフラグをtrue/falseで切り替え可能 | 常時 |
| BR-43-04 | カード更新日時 | ステップ更新時にカードのupdated_atが更新される | touch: trueにより |

### 計算ロジック

特になし

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

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

| 操作 | 対象テーブル | 操作種別 | 概要 |
|-----|-------------|---------|------|
| カード取得 | cards | SELECT | 対象カードの存在確認とアクセス権限確認 |
| ステップ取得 | steps | SELECT | 対象ステップの存在確認 |
| ステップ更新 | steps | UPDATE | ステップの内容/完了状態を更新 |
| カード更新 | cards | UPDATE | touch: trueによりupdated_atを更新 |

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

#### steps

| 操作 | 項目（カラム名） | 更新値・取得条件 | 備考 |
|-----|-----------------|-----------------|------|
| SELECT | * | WHERE card_id = @card.id AND id = params[:id] | ステップ取得 |
| UPDATE | content | params[:step][:content] | 指定時のみ更新 |
| UPDATE | completed | params[:step][:completed] | 指定時のみ更新 |
| UPDATE | updated_at | 現在時刻 | 自動設定 |

#### cards

| 操作 | 項目（カラム名） | 更新値・取得条件 | 備考 |
|-----|-----------------|-----------------|------|
| UPDATE | updated_at | 現在時刻 | touch: trueにより |

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| 401 | 認証エラー | 未認証状態でアクセス | ログイン画面へリダイレクト |
| 404 | Not Found | カードまたはステップが存在しない/アクセス権限なし | エラーメッセージ表示 |
| 422 | Unprocessable Entity | バリデーションエラー | エラーメッセージ表示 |

### リトライ仕様

特になし

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

- `update!` メソッドにより、ステップ更新とカードのtouch更新が同一トランザクション内で実行される
- 失敗時は自動的にロールバックされる

## パフォーマンス要件

- ステップ更新のレスポンス時間: 300ms以内

## セキュリティ考慮事項

- 認証必須: ログイン済みユーザーのみアクセス可能
- 認可: CardScopedモジュールにより、アクセス可能なカードのステップのみ操作可能
- Strong Parameters: `params.expect(step: [ :content, :completed ])` でパラメータをホワイトリスト制御
- XSS対策: ステップ内容表示時にエスケープ処理

## 備考

- チェックボックスの変更はform controllerのsubmitアクションで即座に送信される（`data-action="change->form#submit"`）
- 編集画面ではキャンセル操作も可能（ESCキーで`form#cancel`）

---

## コードリーディングガイド

本機能を理解するために参照すべきファイルと、推奨する読み解き順序を以下に示す。

### 推奨読解順序

#### Step 1: データ構造を理解する

まず、ステップのデータ構造を理解することが重要。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | step.rb | `app/models/step.rb` | Stepモデルの定義、belongs_to関連、バリデーション |
| 1-2 | schema.rb | `db/schema.rb` | stepsテーブルの構造（705-715行目） |

**読解のコツ**:
- `validates :content, presence: true` により、contentは空文字不可
- `belongs_to :card, touch: true` により、ステップ更新時にカードの更新日時も更新される

#### Step 2: エントリーポイントを理解する

処理の起点となるコントローラーを確認。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | steps_controller.rb | `app/controllers/cards/steps_controller.rb` | updateアクションの実装（21-28行目） |
| 2-2 | card_scoped.rb | `app/controllers/concerns/card_scoped.rb` | カードスコープの共通処理 |

**主要処理フロー**:
1. **4行目**: `before_action :set_step, only: %i[ show edit update destroy ]` でステップを事前取得
2. **21-28行目**: `update` アクションでステップを更新
3. **22行目**: `@step.update!(step_params)` で更新実行
4. **40-42行目**: `set_step` でカードに紐づくステップを取得

#### Step 3: ビューレンダリングを理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | edit.html.erb | `app/views/cards/steps/edit.html.erb` | ステップ編集フォーム |
| 3-2 | update.turbo_stream.erb | `app/views/cards/steps/update.turbo_stream.erb` | Turbo Streamレスポンス |
| 3-3 | _step.html.erb | `app/views/cards/steps/_step.html.erb` | ステップの部分テンプレート |

**主要処理フロー**:
- **edit.html.erb 3-12行目**: 編集フォーム、ESCキーでキャンセル可能
- **edit.html.erb 5-6行目**: text_fieldでcontent編集、autofocus有効
- **update.turbo_stream.erb 1-3行目**: `turbo_stream.replace` でステップを置換
- **_step.html.erb 3-5行目**: チェックボックスで完了状態を変更（change->form#submit）

### プログラム呼び出し階層図

```
PATCH /cards/:card_id/steps/:id
    │
    ├─ CardScoped#set_card
    │      └─ Current.user.accessible_cards.find_by!(number: params[:card_id])
    │
    ├─ Cards::StepsController#set_step
    │      └─ @step = @card.steps.find(params[:id])
    │
    └─ Cards::StepsController#update
           │
           ├─ @step.update!(step_params)
           │      └─ Step.update!
           │             ├─ validates :content, presence: true
           │             └─ belongs_to :card, touch: true
           │
           └─ respond_to
                  ├─ format.turbo_stream
                  │      └─ update.turbo_stream.erb
                  │             └─ _step.html.erb
                  │
                  └─ format.json
                         └─ render :show
```

### データフロー図

```
[入力]                     [処理]                         [出力]

PATCH リクエスト ──────▶ Cards::StepsController#update
  ├─ card_id                   │
  ├─ id (step_id)              ├─▶ set_card + set_step
  └─ step[content]             │      └─▶ @card, @step
     step[completed]           │
                               ├─▶ step_params
                               │      └─▶ { content:, completed: }
                               │
                               └─▶ @step.update!
                                      │
                                      ▼
                                   DB更新
                                   (steps + cards touch)
                                      │
                                      ▼
                           ┌──────────┴──────────┐
                           │                     │
                    Turbo Stream              JSON
                    (update.turbo_stream.erb) (render :show)
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| steps_controller.rb | `app/controllers/cards/steps_controller.rb` | コントローラー | ステップCRUD処理 |
| card_scoped.rb | `app/controllers/concerns/card_scoped.rb` | Concern | カードスコープ共通処理 |
| step.rb | `app/models/step.rb` | モデル | ステップのデータモデル定義 |
| edit.html.erb | `app/views/cards/steps/edit.html.erb` | ビュー | ステップ編集フォーム |
| update.turbo_stream.erb | `app/views/cards/steps/update.turbo_stream.erb` | ビュー | Turbo Streamレスポンス |
| _step.html.erb | `app/views/cards/steps/_step.html.erb` | ビュー | ステップ部分テンプレート |
| routes.rb | `config/routes.rb` | 設定 | ルーティング定義 |
| schema.rb | `db/schema.rb` | スキーマ | stepsテーブル定義 |
