# 機能設計書 40-タグ付け

## 概要

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

### 本機能の処理概要

**業務上の目的・背景**：カンバンボードで多数のカードを管理する際、カードをカテゴリーや特性で分類する必要がある。タグ付け機能は、カードに任意のラベル（タグ）を付与することで、横断的な分類や検索を可能にする。例えば「バグ」「改善」「緊急」「顧客A向け」などのタグを付けることで、ボードやカラムを超えた視点でカードをグルーピングできる。これにより、プロジェクト管理の柔軟性と可視性が向上する。

**機能の利用シーン**：カードを作成または編集する際に、関連するタグを付与する。既存のタグから選択することも、新しいタグを作成して付与することも可能。タグはアカウント全体で共有されるため、一度作成したタグは他のボードのカードにも使用できる。タグ付け画面では、入力によるフィルタリングで素早くタグを見つけられる。

**主要な処理内容**：
1. ユーザーがタグ付け画面を開き、タグ名を入力または選択
2. toggle_tag_withでタグ付け状態を切り替え
3. タグが存在しない場合は新規作成
4. タグ付け済みの場合は解除、未付与の場合は付与

**関連システム・外部連携**：検索機能と連携。タグによるカード絞り込みが可能。

**権限による制御**：カードへのアクセス権を持つユーザーがタグ付けを実行できる。タグはアカウントレベルで管理されるため、同一アカウント内の全ユーザーが同じタグセットを使用できる。

## 関連画面

| 画面No | 画面名 | 関連種別 | 関連する操作・処理 |
|--------|--------|----------|------------------|
| 25 | カードタグ付け画面 | 主画面 | タグの選択・追加・削除 |
| 19 | カード詳細画面 | 参照画面 | タグ付けボタンからタグ付け画面への遷移 |
| 59 | タグ一覧画面 | 参照画面 | すべてのタグと関連カードを一覧表示 |

## 機能種別

CRUD操作（CREATE / DELETE トグル）+ タグ自動生成

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | 説明 | バリデーション |
|-------------|-----|-----|------|---------------|
| card_id | String | Yes | 対象カードの番号（number） | Current.userがアクセス可能なカードであること |
| tag_title | String | Yes | タグのタイトル | 空白でないこと、先頭の#は除去 |

### 入力データソース

- URLパスパラメータ: card_idはルーティングから取得
- リクエストパラメータ: tag_titleはPOSTボディから取得
- 認証情報: 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/taggings

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. タグタイトルのサニタイズ
   └─ 先頭の#を除去、空白をトリム

6. タグ付け処理（Card::Taggable#toggle_tag_with）
   └─ account.tags.find_or_create_by!(title:) でタグ取得/作成
   └─ トグル: 付与済みなら解除、未付与なら付与

7. レスポンス生成
   └─ turbo_stream: カードのタグ表示を差し替え
   └─ json: 204 No Content
```

### フローチャート

```mermaid
flowchart TD
    A[POST /cards/:card_id/taggings] --> B[認証チェック]
    B --> C{ログイン済み?}
    C -->|No| D[401 Unauthorized]
    C -->|Yes| E[カード取得]
    E --> F{アクセス権あり?}
    F -->|No| G[404 Not Found]
    F -->|Yes| H[タグタイトルサニタイズ]
    H --> I[toggle_tag_with実行]
    I --> J[find_or_create_by!でタグ取得]
    J --> K{タグ付け済み?}
    K -->|Yes| L[Tagging削除]
    K -->|No| M[Tagging作成]
    L --> N[レスポンス生成]
    M --> N
    N --> O{リクエスト形式}
    O -->|turbo_stream| P[タグ表示差し替え]
    O -->|json| Q[204 No Content]
```

## ビジネスルール

### 業務ルール

| ルールNo | ルール名 | 内容 | 適用条件 |
|---------|---------|------|---------|
| BR-40-01 | トグル動作 | タグ付け済みの場合は解除、未付与の場合は付与 | toggle_tag_with |
| BR-40-02 | 自動タグ生成 | 存在しないタグ名の場合は新規作成 | find_or_create_by! |
| BR-40-03 | タイトル正規化 | タグタイトルは小文字に正規化 | normalizes :title |
| BR-40-04 | #除去 | 先頭の#は自動的に除去 | sanitized_tag_title_param |
| BR-40-05 | アカウント共有 | タグはアカウント全体で共有 | account.tags |
| BR-40-06 | 重複防止 | 同一カード・タグの組み合わせは一意 | UNIQUE制約（card_id, tag_id） |

### 計算ロジック

特になし。

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

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

| 操作 | 対象テーブル | 操作種別 | 概要 |
|-----|-------------|---------|------|
| タグ取得/作成 | tags | SELECT or INSERT | タグの存在確認または新規作成 |
| タグ付け | taggings | INSERT | カードとタグの関連付け |
| タグ解除 | taggings | DELETE | カードとタグの関連付け削除 |
| カードタッチ | cards | UPDATE | updated_atの更新（touch: true） |

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

#### tags

| 操作 | 項目（カラム名） | 更新値・取得条件 | 備考 |
|-----|-----------------|-----------------|------|
| SELECT/INSERT | id | UUIDを自動生成（新規の場合） | 主キー |
| SELECT/INSERT | account_id | Current.account.id | アカウントスコープ |
| SELECT/INSERT | title | 入力されたタグ名（小文字に正規化） | タイトル |

#### taggings

| 操作 | 項目（カラム名） | 更新値・取得条件 | 備考 |
|-----|-----------------|-----------------|------|
| INSERT | id | UUIDを自動生成 | 主キー |
| INSERT | account_id | card.account_id | カード経由で取得 |
| INSERT | card_id | 対象カードのID | 外部キー |
| INSERT | tag_id | タグのID | 外部キー |
| DELETE | - | card_id = 対象カード, tag_id = 対象タグ | 解除時 |

## エラー処理

### エラーケース一覧

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

### リトライ仕様

リトライ処理は不要。トグル動作のため、重複リクエストは逆操作になる点に注意。

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

toggle_tag_withメソッド内でトランザクションを使用。タグ検索とタグ付け/解除が一連の処理として実行される。

## パフォーマンス要件

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

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

- 認証: ApplicationControllerのbefore_actionでログイン状態を確認
- 認可: accessible_cardsとaccount.tagsにより、適切なスコープ内での操作を保証
- 入力検証: tag_titleは空白トリムと#除去でサニタイズ
- CSRF対策: Railsの標準CSRF保護機構を使用

## 備考

タグは#で始まるハッシュタグ形式で表示されるが、データベースには#なしで保存される。表示時にhashtag メソッドで#が付与される。

---

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

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

### 推奨読解順序

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

タグ付けは、Tag、Taggingモデルでカードとタグの多対多関連として実装されている。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | tag.rb | `app/models/tag.rb` | Tagモデルの構造。title正規化、has_many :taggings |
| 1-2 | tagging.rb | `app/models/tagging.rb` | Taggingモデル（中間テーブル）。touch: true |
| 1-3 | taggable.rb | `app/models/card/taggable.rb` | Cardモデルにincludeされるconcern。toggle_tag_withメソッドの定義 |

**読解のコツ**: `Tag`モデルは`normalizes :title`でタイトルを小文字に正規化する。`hashtag`メソッドで#付きの表示用文字列を取得できる。

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

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

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

**主要処理フロー**:
1. **11行目**: `sanitized_tag_title_param`でタグタイトルをサニタイズ
2. **11行目**: `@card.toggle_tag_with`でトグル処理を実行
3. **19-21行目**: `sanitized_tag_title_param`で空白トリムと#除去

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

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

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

**主要処理フロー**:
- **12行目**: `account.tags.find_or_create_by!(title:)`でタグを取得または作成
- **14-20行目**: トランザクション内でタグ付け/解除をトグル

#### Step 4: ビュー構造を理解する

タグ付け画面の構造を理解する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 4-1 | new.html.erb | `app/views/cards/taggings/new.html.erb` | タグ付け画面のテンプレート |
| 4-2 | _tag.html.erb | `app/views/cards/taggings/_tag.html.erb` | タグ一覧のパーシャル |

**主要処理フロー**:
- **12-18行目**: タグ入力フォーム（新規タグ作成も可能）
- **20-30行目**: 既存タグ一覧と「Create tag」ボタン

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

```
Cards::TaggingsController#create
    │
    ├─ CardScoped#set_card
    │      └─ Current.user.accessible_cards.find_by!(number:)
    │
    ├─ CardScoped#set_board
    │      └─ @card.board
    │
    ├─ sanitized_tag_title_param
    │      ├─ params.required(:tag_title)
    │      ├─ strip
    │      └─ gsub(/\A#/, "")
    │
    ├─ Card#toggle_tag_with (Card::Taggable)
    │      │
    │      ├─ account.tags.find_or_create_by!(title:)
    │      │      └─ Tag.create! (新規の場合)
    │      │
    │      └─ transaction do
    │             ├─ [タグ付け済みの場合] taggings.destroy_by(tag:)
    │             └─ [未付与の場合] taggings.create(tag:)
    │
    └─ turbo_stream (create.turbo_stream.erb)
           └─ turbo_stream.replace tags
```

### データフロー図

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

card_id      ───▶ CardScoped#set_card    ───▶ @card
tag_title    ───▶ sanitized_tag_title_param ─▶ title（サニタイズ済み）
                     │
                     ▼
               Card::Taggable#toggle_tag_with
                     │
                     ├─ find_or_create_by! ──▶ tagsテーブル
                     │                         (SELECT or INSERT)
                     │
                     └─ transaction ─────────▶ taggingsテーブル
                            │                  (INSERT or DELETE)
                            │
                            └───────────────▶ cardsテーブル
                                              (UPDATE: touch)
                     │
                     ▼
               turbo_stream render     ───▶ Turbo Stream HTML
                                            (タグ表示更新)
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| taggings_controller.rb | `app/controllers/cards/taggings_controller.rb` | コントローラ | HTTPリクエストの処理 |
| card_scoped.rb | `app/controllers/concerns/card_scoped.rb` | コントローラconcern | カード取得の共通処理 |
| taggable.rb | `app/models/card/taggable.rb` | モデルconcern | タグ付けのビジネスロジック |
| tag.rb | `app/models/tag.rb` | モデル | タグを表すActiveRecordモデル |
| tagging.rb | `app/models/tagging.rb` | モデル | タグ付け関連を表すActiveRecordモデル |
| card.rb | `app/models/card.rb` | モデル | カードの基底モデル |
| new.html.erb | `app/views/cards/taggings/new.html.erb` | ビュー | タグ付け画面 |
| _tag.html.erb | `app/views/cards/taggings/_tag.html.erb` | ビュー | タグ一覧パーシャル |
| create.turbo_stream.erb | `app/views/cards/taggings/create.turbo_stream.erb` | ビュー | タグ付け時のTurbo Streamレスポンス |
| routes.rb | `config/routes.rb` | 設定 | ルーティング定義（97行目） |
| schema.rb | `db/schema.rb` | スキーマ | tags（757-763行）, taggings（746-755行）テーブル定義 |
