# 機能設計書 35-カードをウォッチ

## 概要

本ドキュメントは、Fizzyアプリケーションにおけるカードの「ウォッチ」機能について、その処理内容、入出力仕様、データベース操作を詳細に記述した機能設計書である。

### 本機能の処理概要

**業務上の目的・背景**：カンバンボードで共同作業を行う際、自分が直接担当していなくても特定のカードの進捗や更新に関心がある場合がある。ウォッチ機能は、カードに対する更新（コメント、ステータス変更、担当者変更等）があった際に通知を受け取れるようにする機能である。これにより、プロジェクトの重要な動きを見逃さず、適切なタイミングでフォローアップやアクションを取ることが可能になる。

**機能の利用シーン**：マネージャーが部下の担当カードの進捗を追跡したい場合、レビュアーがレビュー依頼されたカードの議論を追いたい場合、またはチームメンバーが関連するタスクの状況を把握したい場合に使用する。カード詳細画面からウォッチボタンをクリック、またはショートカットキー（Shift+N）で設定可能。

**主要な処理内容**：
1. ユーザーがカードに対してウォッチ設定をリクエスト
2. 対象カードのアクセス権を確認
3. Watchレコードを作成または更新してウォッチ状態を有効化
4. ウォッチボタンの表示を更新

**関連システム・外部連携**：通知システムと連携。カードの更新イベント発生時に、ウォッチ中のユーザーに通知が送信される（別機能で処理）。

**権限による制御**：カードへのアクセス権を持つすべてのユーザーがウォッチ設定可能。なお、カード作成者は自動的にウォッチ状態になる。

## 関連画面

| 画面No | 画面名 | 関連種別 | 関連する操作・処理 |
|--------|--------|----------|------------------|
| 19 | カード詳細画面 | 主画面 | ウォッチボタンのクリック、Shift+Nショートカット |
| 27 | カードウォッチ画面 | 主画面 | ウォッチ状態の表示 |

## 機能種別

CRUD操作（CREATE / UPDATE）

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | 説明 | バリデーション |
|-------------|-----|-----|------|---------------|
| card_id | String | Yes | 対象カードの番号（number） | Current.userがアクセス可能なカードであること |

### 入力データソース

- URLパスパラメータ: card_idはルーティングから取得
- 認証情報: Current.userから現在のログインユーザーを取得

## 出力仕様

### 出力データ

| 項目名 | 型 | 説明 |
|--------|-----|------|
| turbo_stream | HTML | ウォッチボタンの差し替え用HTML（Turbo Stream形式） |
| HTTP Status | Integer | 成功時: 200 OK（turbo_stream）/ 204 No Content（JSON） |

### 出力先

- 画面表示: Turbo Streamによるウォッチボタンの部分置換
- JSON API: no_content（ボディなし）

## 処理フロー

### 処理シーケンス

```
1. リクエスト受信
   └─ POST /cards/:card_id/watch

2. 認証・認可チェック（ApplicationController）
   └─ Current.userの設定、ログイン状態確認

3. カード取得（CardScoped#set_card）
   └─ Current.user.accessible_cards.find_by!(number: params[:card_id])
   └─ アクセス権がない場合は404エラー

4. ボード設定（CardScoped#set_board）
   └─ @board = @card.board

5. ウォッチ設定（Card::Watchable#watch_by）
   └─ watches.where(user:).first_or_create
   └─ update!(watching: true)

6. レスポンス生成
   └─ turbo_stream: ウォッチボタンを差し替え
   └─ json: 204 No Content
```

### フローチャート

```mermaid
flowchart TD
    A[POST /cards/:card_id/watch] --> B[認証チェック]
    B --> C{ログイン済み?}
    C -->|No| D[401 Unauthorized]
    C -->|Yes| E[カード取得]
    E --> F{アクセス権あり?}
    F -->|No| G[404 Not Found]
    F -->|Yes| H[watch_by実行]
    H --> I{Watchレコード存在?}
    I -->|No| J[Watchレコード作成]
    I -->|Yes| K[既存レコード取得]
    J --> L[watching = trueに更新]
    K --> L
    L --> M[レスポンス生成]
    M --> N{リクエスト形式}
    N -->|turbo_stream| O[ウォッチボタン差し替え]
    N -->|json| P[204 No Content]
```

## ビジネスルール

### 業務ルール

| ルールNo | ルール名 | 内容 | 適用条件 |
|---------|---------|------|---------|
| BR-35-01 | 自動購読 | カード作成者は自動的にウォッチ状態になる | after_create :subscribe_creator |
| BR-35-02 | 状態トグル | 同一レコードのwatchingフラグを切り替える | first_or_create + update! |
| BR-35-03 | アクセス権制御 | ユーザーがアクセス可能なカードのみウォッチ可能 | accessible_cardsスコープで制御 |
| BR-35-04 | 通知連携 | ウォッチ中のカードの更新時に通知を受け取る | 通知システムで処理 |

### 計算ロジック

特になし。

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

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

| 操作 | 対象テーブル | 操作種別 | 概要 |
|-----|-------------|---------|------|
| ウォッチ設定 | watches | INSERT or UPDATE | ウォッチ状態を記録または更新 |
| カードタッチ | cards | UPDATE | updated_atの更新（touch: true） |

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

#### watches

| 操作 | 項目（カラム名） | 更新値・取得条件 | 備考 |
|-----|-----------------|-----------------|------|
| INSERT | id | UUIDを自動生成 | 主キー |
| INSERT | account_id | user.account_id | ユーザー経由で取得 |
| INSERT | card_id | 対象カードのID | 外部キー |
| INSERT | user_id | Current.user.id | ウォッチするユーザー |
| INSERT | watching | true | デフォルト値 |
| UPDATE | watching | true | 既存レコードの場合 |
| INSERT/UPDATE | updated_at | 現在時刻 | 自動設定 |

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| 401 | Unauthorized | 未ログイン状態でアクセス | ログイン画面へリダイレクト |
| 404 | Not Found | 存在しないカード番号、またはアクセス権なし | エラーページ表示 |

### リトライ仕様

リトライ処理は不要。first_or_createにより冪等性が保証されているため、重複リクエストは既存レコードを更新する。

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

Watch.first_or_create + update!は暗黙的なトランザクション内で実行される。明示的なトランザクション制御は行わない。

## パフォーマンス要件

- レスポンス時間: 200ms以内
- user_id, card_idに対するインデックスにより高速な検索を保証

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

- 認証: ApplicationControllerのbefore_actionでログイン状態を確認
- 認可: accessible_cardsスコープにより、ユーザーがアクセス権を持つカードのみに操作を限定
- CSRF対策: Railsの標準CSRF保護機構を使用
- プライバシー: ウォッチ状態は個人情報だが、watchersとして他のユーザーからも参照可能

## 備考

ウォッチは通知購読の仕組みであり、カードの状態やアクセス権には影響しない。カードへの担当者アサイン時にも自動的にウォッチ状態になる（Card::Assignable#assign）。

---

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

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

### 推奨読解順序

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

ウォッチは、Watchモデルでカードとユーザーの関連として実装されている。watchingフラグで状態を管理する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | watch.rb | `app/models/watch.rb` | Watchモデルの構造。watching booleanフラグに注目 |
| 1-2 | watchable.rb | `app/models/card/watchable.rb` | Cardモデルにincludeされるconcern。watch_byメソッドの定義 |

**読解のコツ**: `Watch`モデルには`watching`というbooleanカラムがあり、true/falseでウォッチ/アンウォッチを表現する。レコード削除ではなくフラグ更新方式を採用している点に注目。

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

コントローラのcreateアクションがエントリーポイントとなる。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | watches_controller.rb | `app/controllers/cards/watches_controller.rb` | createアクションの実装（8-14行目） |
| 2-2 | card_scoped.rb | `app/controllers/concerns/card_scoped.rb` | カード取得とボード設定のconcern |

**主要処理フロー**:
1. **9行目**: `@card.watch_by Current.user`でウォッチ設定を実行
2. **11-14行目**: レスポンス形式に応じてturbo_streamまたはJSONを返却

#### Step 3: ドメインロジックを理解する

Cardモデルに混入されたWatchableモジュールでビジネスロジックが定義されている。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | watchable.rb | `app/models/card/watchable.rb` | watch_byメソッドの実装（19-21行目） |

**主要処理フロー**:
- **5行目**: `has_many :watches`でカードとの関連を定義
- **6行目**: `has_many :watchers`でウォッチ中のユーザーへのスコープ付き関連
- **8行目**: `after_create :subscribe_creator`でカード作成時に自動ウォッチ
- **11-13行目**: `watched_by?`でウォッチ状態の判定
- **19-21行目**: `watch_by`メソッドでfirst_or_createを使用後、watching: trueに更新

#### Step 4: 自動購読を理解する

カード作成時の自動ウォッチ処理を理解する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 4-1 | watchable.rb | `app/models/card/watchable.rb` | subscribe_creator（27-33行目） |

**主要処理フロー**:
- **27-33行目**: `Card.no_touching`でカードのタッチを防ぎつつ、作成者をウォッチ状態にする

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

```
Cards::WatchesController#create
    │
    ├─ CardScoped#set_card
    │      └─ Current.user.accessible_cards.find_by!(number:)
    │
    ├─ CardScoped#set_board
    │      └─ @card.board
    │
    ├─ Card#watch_by (Card::Watchable)
    │      ├─ watches.where(user:).first_or_create
    │      └─ update!(watching: true)
    │             └─ Watch.save!
    │                    └─ belongs_to :card, touch: true
    │
    └─ turbo_stream (create.turbo_stream.erb)
           └─ render cards/watches/refresh
```

### データフロー図

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

card_id      ───▶ CardScoped#set_card    ───▶ @card
(URLパラメータ)       │
                     ▼
               Card::Watchable#watch_by
                     │
                     ├───────────────────────▶ watchesテーブル
                     │                         (INSERT or UPDATE)
                     ▼
               turbo_stream render     ───▶ Turbo Stream HTML
                                            (ボタン更新)
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| watches_controller.rb | `app/controllers/cards/watches_controller.rb` | コントローラ | HTTPリクエストの処理 |
| card_scoped.rb | `app/controllers/concerns/card_scoped.rb` | コントローラconcern | カード取得の共通処理 |
| watchable.rb | `app/models/card/watchable.rb` | モデルconcern | ウォッチのビジネスロジック |
| watch.rb | `app/models/watch.rb` | モデル | ウォッチ状態を表すActiveRecordモデル |
| card.rb | `app/models/card.rb` | モデル | カードの基底モデル |
| _watch_button.html.erb | `app/views/cards/watches/_watch_button.html.erb` | ビュー | ウォッチボタンのパーシャル |
| create.turbo_stream.erb | `app/views/cards/watches/create.turbo_stream.erb` | ビュー | ウォッチ設定時のTurbo Streamレスポンス |
| routes.rb | `config/routes.rb` | 設定 | ルーティング定義（89行目） |
| schema.rb | `db/schema.rb` | スキーマ | watchesテーブル定義（791-802行目） |
