# 機能設計書 31-カードをゴールデン設定

## 概要

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

### 本機能の処理概要

**業務上の目的・背景**：カンバンボードで多数のカードを管理する際、特に重要または優先度の高いカードを視覚的に識別できるようにする必要がある。ゴールデン設定機能は、カードに「ゴールデン」マーク（星印等）を付与することで、他のカードと区別して目立たせ、チームメンバー全員が重要なカードを素早く認識できるようにする。これにより、プロジェクト管理における優先順位付けが容易になり、重要なタスクの見落としを防ぐことができる。

**機能の利用シーン**：プロジェクトマネージャーやチームリーダーが、締め切りが迫ったタスク、ブロッカーとなる課題、または戦略的に重要な項目を強調したい場合に使用する。カード詳細画面やカード一覧からワンクリックでゴールデン設定が可能であり、設定されたカードはボード上で優先的に表示される。

**主要な処理内容**：
1. ユーザーがカードに対してゴールデン設定をリクエスト
2. 対象カードのアクセス権を確認
3. Card::Goldnessレコードを作成してゴールデン状態を永続化
4. カードの表示を更新してゴールデンマークを反映

**関連システム・外部連携**：外部システムとの連携なし。Turbo Streamsによるリアルタイムな画面更新に対応している。

**権限による制御**：カードへのアクセス権を持つすべてのユーザーがゴールデン設定を実行可能。ボードのアクセス権限（all_access / involved / creator）に基づいてカードへのアクセス可否が判定される。

## 関連画面

| 画面No | 画面名 | 関連種別 | 関連する操作・処理 |
|--------|--------|----------|------------------|
| 19 | カード詳細画面 | 主画面 | カードメニューからゴールデン設定ボタンをクリック |

## 機能種別

CRUD操作（CREATE）

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | 説明 | バリデーション |
|-------------|-----|-----|------|---------------|
| 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/goldness

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::Golden#gild）
   └─ goldness.present?をチェック
   └─ 未設定の場合のみCard::Goldnessレコードを作成

6. レスポンス生成
   └─ turbo_stream: カードコンテナを差し替え
   └─ json: 204 No Content
```

### フローチャート

```mermaid
flowchart TD
    A[POST /cards/:card_id/goldness] --> B[認証チェック]
    B --> C{ログイン済み?}
    C -->|No| D[401 Unauthorized]
    C -->|Yes| E[カード取得]
    E --> F{アクセス権あり?}
    F -->|No| G[404 Not Found]
    F -->|Yes| H{既にゴールデン?}
    H -->|Yes| I[何もしない]
    H -->|No| J[Card::Goldness作成]
    I --> K[レスポンス生成]
    J --> K
    K --> L{リクエスト形式}
    L -->|turbo_stream| M[カードコンテナ差し替え]
    L -->|json| N[204 No Content]
```

## ビジネスルール

### 業務ルール

| ルールNo | ルール名 | 内容 | 適用条件 |
|---------|---------|------|---------|
| BR-31-01 | 重複防止 | 既にゴールデン設定済みのカードに対しては新規レコードを作成しない | golden?がtrueの場合 |
| BR-31-02 | アクセス権制御 | ユーザーがアクセス可能なカードに対してのみ設定可能 | accessible_cardsスコープで制御 |
| BR-31-03 | 表示順序優先 | ゴールデンカードはストリーム表示時に優先表示される | with_golden_firstスコープ適用時 |

### 計算ロジック

特になし。

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

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

| 操作 | 対象テーブル | 操作種別 | 概要 |
|-----|-------------|---------|------|
| ゴールデン設定 | card_goldnesses | INSERT | カードのゴールデン状態を記録 |
| カードタッチ | cards | UPDATE | updated_atの更新（touch: true） |

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

#### card_goldnesses

| 操作 | 項目（カラム名） | 更新値・取得条件 | 備考 |
|-----|-----------------|-----------------|------|
| INSERT | id | UUIDを自動生成 | 主キー |
| INSERT | account_id | card.account_id | カード経由で取得 |
| INSERT | card_id | 対象カードのID | 外部キー、UNIQUE制約あり |
| INSERT | created_at | 現在時刻 | 自動設定 |
| INSERT | updated_at | 現在時刻 | 自動設定 |

## エラー処理

### エラーケース一覧

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

### リトライ仕様

リトライ処理は不要。冪等性が保証されているため、重複リクエストは無視される。

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

Card::Goldness.create!は単一のINSERT操作であり、明示的なトランザクション制御は行わない。ActiveRecordのデフォルトトランザクション動作に依存する。

## パフォーマンス要件

- レスポンス時間: 200ms以内
- 同時アクセス: card_idに対するUNIQUE制約により整合性を保証

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

- 認証: ApplicationControllerのbefore_actionでログイン状態を確認
- 認可: accessible_cardsスコープにより、ユーザーがアクセス権を持つカードのみに操作を限定
- CSRF対策: Railsの標準CSRF保護機構を使用

## 備考

ゴールデン設定は視覚的な優先度マーカーであり、カードの状態（オープン/クローズ等）には影響しない。

---

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

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

### 推奨読解順序

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

ゴールデン設定は、Card::Goldnessモデルでカードとの1対1関連として実装されている。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | goldness.rb | `app/models/card/goldness.rb` | Card::Goldnessモデルの構造。belongs_to :cardでカードと関連付け |
| 1-2 | golden.rb | `app/models/card/golden.rb` | Cardモデルにincludeされるconcern。gild/ungildメソッドの定義 |

**読解のコツ**: `Card::Goldness`は`Card`の名前空間配下のモデルで、`card_goldnesses`テーブルに対応する。`touch: true`オプションにより、Goldness作成時にカードのupdated_atも更新される。

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

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

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

**主要処理フロー**:
1. **4-5行目**: `@card.gild`でゴールデン設定を実行
2. **7-10行目**: レスポンス形式に応じてturbo_streamまたはJSONを返却

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

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

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

**主要処理フロー**:
- **5行目**: `has_one :goldness`でカードとの関連を定義
- **7行目**: `scope :golden`でゴールデンカードの抽出クエリを定義
- **8行目**: `scope :with_golden_first`でゴールデンカードを優先表示するソート
- **11-13行目**: `golden?`でゴールデン状態の判定
- **15-17行目**: `gild`メソッドで既存チェック後にGoldnessを作成

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

```
Cards::GoldnessesController#create
    │
    ├─ CardScoped#set_card
    │      └─ Current.user.accessible_cards.find_by!(number:)
    │
    ├─ CardScoped#set_board
    │      └─ @card.board
    │
    ├─ Card#gild (Card::Golden)
    │      ├─ golden? → goldness.present?
    │      └─ create_goldness! (Card::Goldness.create!)
    │             └─ belongs_to :card, touch: true
    │
    └─ CardScoped#render_card_replacement
           └─ turbo_stream.replace
```

### データフロー図

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

card_id      ───▶ CardScoped#set_card    ───▶ @card
(URLパラメータ)       │
                     ▼
               Card::Golden#gild
                     │
                     ▼
               Card::Goldness.create!   ───▶ card_goldnessesテーブル
                     │                        (INSERT)
                     ▼
               render_card_replacement  ───▶ Turbo Stream HTML
                                             (画面更新)
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| goldnesses_controller.rb | `app/controllers/cards/goldnesses_controller.rb` | コントローラ | HTTPリクエストの処理 |
| card_scoped.rb | `app/controllers/concerns/card_scoped.rb` | コントローラconcern | カード取得の共通処理 |
| golden.rb | `app/models/card/golden.rb` | モデルconcern | ゴールデン設定のビジネスロジック |
| goldness.rb | `app/models/card/goldness.rb` | モデル | ゴールデン状態を表すActiveRecordモデル |
| card.rb | `app/models/card.rb` | モデル | カードの基底モデル |
| routes.rb | `config/routes.rb` | 設定 | ルーティング定義（82行目） |
| schema.rb | `db/schema.rb` | スキーマ | card_goldnessesテーブル定義（182-188行目） |
