# 機能設計書 43-通貨設定

## 概要

本ドキュメントは、Actualの「通貨設定」機能の設計内容を記載する。デフォルト通貨の選択、通貨記号の表示位置、金額と記号間のスペース設定について、処理内容とUIコンポーネントの仕様を定義する。

### 本機能の処理概要

通貨設定機能は、アプリケーション全体で使用される通貨の表示方法を制御する実験的機能である。通貨を選択すると、その通貨に適した数値フォーマット、小数点表示、記号位置が自動的に設定される。

**業務上の目的・背景**：ユーザーの居住国や使用通貨に応じた適切な金額表示を提供することで、予算管理のしやすさを向上させる。各国の通貨表記規約（記号の前後位置、小数点の有無など）を自動的に適用し、設定の手間を軽減する。

**機能の利用シーン**：初期セットアップ時に使用通貨を選択する場合、海外移住や転職で使用通貨が変わった場合、記号位置のカスタマイズが必要な場合に利用される。

**主要な処理内容**：
1. デフォルト通貨の選択（40種類以上の通貨をサポート）
2. 通貨選択時の自動設定（数値フォーマット、小数点表示、記号位置）
3. 記号位置の手動調整（金額の前/後）
4. 金額と記号間のスペース有無設定
5. 同期設定への保存

**関連システム・外部連携**：なし

**権限による制御**：特になし（全ユーザーが利用可能）。ただし実験的機能フラグ「currency」による制御がある。

## 関連画面

| 画面No | 画面名 | 関連種別 | 関連する操作・処理 |
|--------|--------|----------|------------------|
| 40 | 設定画面 | 主機能 | 使用通貨の設定（実験的機能） |

## 機能種別

設定・表示フォーマット処理

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | 説明 | バリデーション |
|-------------|-----|-----|------|---------------|
| defaultCurrencyCode | string | No | 通貨コード（ISO 4217） | 空文字または有効な通貨コード |
| currencySymbolPosition | string | No | 記号の位置 | 'before' / 'after' |
| currencySpaceBetweenAmountAndSymbol | string | No | スペース有無 | 'true' / 'false' |

### 入力データソース

- 画面入力（ドロップダウン選択、チェックボックス）

## 出力仕様

### 出力データ

| 項目名 | 型 | 説明 |
|--------|-----|------|
| defaultCurrencyCode | string | 選択された通貨コード |
| currencySymbolPosition | string | 記号位置設定 |
| currencySpaceBetweenAmountAndSymbol | string | スペース設定 |
| numberFormat | string | 通貨に連動して設定される数値フォーマット |
| hideFraction | string | 通貨に連動して設定される小数点表示 |

### 出力先

- 同期設定（SyncedPrefs）- デバイス間で同期される

## 処理フロー

### 処理シーケンス

```
1. 設定画面のCurrencySettingsコンポーネント表示
   └─ useSyncedPrefフックで現在の設定値を取得

2. 通貨選択
   ├─ Selectコンポーネントで通貨を選択
   ├─ handleCurrencyChange関数呼び出し
   ├─ getCurrency関数で通貨情報を取得
   └─ 関連設定を一括更新
       ├─ numberFormat: 通貨のnumberFormat
       ├─ hideFraction: decimalPlaces === 0 の場合 'true'
       ├─ currencySpaceBetweenAmountAndSymbol: symbolFirst ? 'false' : 'true'
       └─ currencySymbolPosition: symbolFirst ? 'before' : 'after'

3. 記号位置変更
   ├─ Selectコンポーネントで変更
   └─ setSymbolPositionPref呼び出し

4. スペース設定変更
   ├─ Checkboxの変更検知
   └─ setSpaceEnabledPref呼び出し
```

### フローチャート

```mermaid
flowchart TD
    A[通貨設定画面表示] --> B[現在の設定値読み込み]
    B --> C{ユーザー操作}

    C -->|通貨選択| D[handleCurrencyChange]
    C -->|記号位置変更| E[setSymbolPositionPref]
    C -->|スペース設定変更| F[setSpaceEnabledPref]

    D --> G[getCurrency で通貨情報取得]
    G --> H{通貨コードが有効?}

    H -->|Yes| I[関連設定を一括更新]
    H -->|No| J[通貨コードのみ更新]

    I --> K[setDefaultCurrencyCodePref]
    I --> L[setNumberFormatPref]
    I --> M[setHideFractionPref]
    I --> N[setSpaceEnabledPref]
    I --> O[setSymbolPositionPref]

    J --> K
    K --> P[同期設定に保存]
    L --> P
    M --> P
    N --> P
    O --> P
    E --> P
    F --> P

    P --> Q[UI即時反映]
```

## ビジネスルール

### 業務ルール

| ルールNo | ルール名 | 内容 | 適用条件 |
|---------|---------|------|---------|
| BR-43-01 | デフォルト通貨 | 初期状態では通貨未設定（空文字） | 未設定時 |
| BR-43-02 | 通貨連動設定 | 通貨選択時に数値フォーマット、小数点、記号位置を自動設定 | 通貨コードが有効な場合 |
| BR-43-03 | 小数点自動設定 | decimalPlaces === 0 の通貨（例：JPY）は小数点非表示 | 該当通貨選択時 |
| BR-43-04 | 記号位置自動設定 | 通貨のsymbolFirstプロパティに基づき記号位置を設定 | 通貨選択時 |
| BR-43-05 | 実験的機能 | 本機能は実験的機能フラグ「currency」で有効化される | flags.currency === true |

### サポート通貨一覧（主要）

| コード | 通貨名 | 記号 | 小数桁 | 数値フォーマット | 記号位置 |
|-------|--------|------|--------|----------------|---------|
| USD | US Dollar | $ | 2 | comma-dot | before |
| EUR | Euro | &#8364; | 2 | dot-comma | after |
| GBP | Pound Sterling | &#163; | 2 | comma-dot | before |
| JPY | Japanese Yen | &#165; | 0 | comma-dot | before |
| INR | Indian Rupee | &#8377; | 2 | comma-dot-in | before |
| BRL | Brazilian Real | R$ | 2 | dot-comma | before |
| CHF | Swiss Franc | Fr. | 2 | apostrophe-dot | before |

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

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

本機能はSyncedPrefsを通じて設定を保存する。

| 操作 | 対象テーブル | 操作種別 | 概要 |
|-----|-------------|---------|------|
| 通貨変更 | prefs | UPDATE | 通貨関連設定を一括更新 |

### 設定キー詳細

| キー | 型 | 説明 |
|-----|-----|------|
| defaultCurrencyCode | string | 通貨コード（ISO 4217） |
| currencySymbolPosition | string | 記号位置（before/after） |
| currencySpaceBetweenAmountAndSymbol | string | スペース有無（true/false） |

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| - | - | ドロップダウン選択のため通常発生しない | - |

### リトライ仕様

なし

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

通貨選択時は複数の設定が同時に更新されるが、それぞれ個別のdispatchで保存される。失敗時は部分的に設定が更新される可能性がある。

## パフォーマンス要件

- 設定変更: 即座に反映（100ms以内）

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

特になし（表示設定のみで、センシティブなデータを扱わない）

## 備考

- 本機能は実験的機能として提供されており、将来的に仕様が変更される可能性がある
- 通貨の追加は currencies.ts ファイルの編集と、Currency.tsx の翻訳マップ更新が必要
- 数値フォーマットと通貨設定は連動するが、通貨選択後に数値フォーマットのみ変更することも可能

---

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

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

### 推奨読解順序

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

通貨設定で使用されるデータ構造を理解する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | currencies.ts | `packages/loot-core/src/shared/currencies.ts` | Currency型定義と通貨一覧（1-67行目） |

**読解のコツ**: 各通貨はcode, symbol, name, decimalPlaces, numberFormat, symbolFirstの6プロパティを持つ。decimalPlacesが0の通貨（JPYなど）は小数点表示が不要。

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

通貨設定UIのエントリーポイントを確認する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | Currency.tsx | `packages/desktop-client/src/components/settings/Currency.tsx` | CurrencySettingsコンポーネント全体の構造（17-203行目） |

**主要処理フロー**:
1. **20-65行目**: currencyTranslationsマップで通貨名の翻訳を定義
2. **67-79行目**: useSyncedPrefフックで各設定値を取得
3. **87-97行目**: currencyOptions配列を構築
4. **99-108行目**: handleCurrencyChange関数で通貨選択時の一括設定
5. **110-125行目**: symbolPositionOptions配列を動的に構築

#### Step 3: 通貨データの取得を理解する

通貨データの取得処理を理解する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | currencies.ts | `packages/loot-core/src/shared/currencies.ts` | getCurrency関数の実装（65-67行目） |

**主要処理フロー**:
- **65-67行目**: コードで通貨を検索、見つからない場合はデフォルト（currencies[0]、Noneを返す）

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

```
CurrencySettings (Currency.tsx)
    │
    ├─ useSyncedPref('defaultCurrencyCode')
    │      └─ useSelector(state.prefs.synced.defaultCurrencyCode)
    │
    ├─ useSyncedPref('currencySymbolPosition')
    │
    ├─ useSyncedPref('currencySpaceBetweenAmountAndSymbol')
    │
    ├─ useSyncedPref('numberFormat')
    │
    ├─ useSyncedPref('hideFraction')
    │
    ├─ handleCurrencyChange()
    │      ├─ setDefaultCurrencyCodePref()
    │      ├─ getCurrency(code) → Currency オブジェクト取得
    │      ├─ setNumberFormatPref(cur.numberFormat)
    │      ├─ setHideFractionPref(cur.decimalPlaces === 0 ? 'true' : 'false')
    │      ├─ setSpaceEnabledPref(cur.symbolFirst ? 'false' : 'true')
    │      └─ setSymbolPositionPref(cur.symbolFirst ? 'before' : 'after')
    │
    ├─ setSymbolPositionPref()
    │      └─ dispatch(saveSyncedPrefs({prefs: {currencySymbolPosition: value}}))
    │
    └─ setSpaceEnabledPref()
           └─ dispatch(saveSyncedPrefs({prefs: {currencySpaceBetweenAmountAndSymbol: value}}))
```

### データフロー図

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

通貨選択 ────────────────▶ handleCurrencyChange()
                          │
                          ├─ getCurrency() ──────────▶ Currency オブジェクト
                          │
                          ├─ setDefaultCurrencyCodePref()
                          │                            ▼
                          ├─ setNumberFormatPref() ──▶ SyncedPrefs
                          │                            (numberFormat)
                          ├─ setHideFractionPref() ──▶ SyncedPrefs
                          │                            (hideFraction)
                          ├─ setSpaceEnabledPref() ──▶ SyncedPrefs
                          │                            (currencySpaceBetweenAmountAndSymbol)
                          └─ setSymbolPositionPref() ▶ SyncedPrefs
                                                       (currencySymbolPosition)

記号位置選択 ────────────▶ setSymbolPositionPref() ──▶ SyncedPrefs
                                                       (currencySymbolPosition)

スペース設定 ────────────▶ setSpaceEnabledPref() ────▶ SyncedPrefs
チェック                                               (currencySpaceBetweenAmountAndSymbol)
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| Currency.tsx | `packages/desktop-client/src/components/settings/Currency.tsx` | ソース | 通貨設定UIコンポーネント |
| currencies.ts | `packages/loot-core/src/shared/currencies.ts` | ソース | 通貨定義とユーティリティ |
| useSyncedPref.ts | `packages/desktop-client/src/hooks/useSyncedPref.ts` | ソース | 同期設定読み書きフック |
| UI.tsx | `packages/desktop-client/src/components/settings/UI.tsx` | ソース | 設定画面共通UIコンポーネント |
| Checkbox.tsx | `packages/desktop-client/src/components/forms.tsx` | ソース | チェックボックスコンポーネント |
