# バッチ設計書 4-translate

## 概要

本ドキュメントは、InvenTreeモバイルアプリの翻訳ファイルを更新するPythonビルドタスク「translate」の設計仕様を記載します。

### 本バッチの処理概要

本バッチは、lib/l10n/collect_translations.pyスクリプトを実行して、Crowdinから取得した多言語翻訳ファイル（.arb）を収集・統合し、Flutterの国際化（i18n）ライブラリが利用できる形式に変換する処理を実行します。

**業務上の目的・背景**：InvenTreeモバイルアプリは多言語対応しており、翻訳データはCrowdinというクラウド翻訳プラットフォームで管理されています。Crowdinから取得した翻訳ファイルはサブディレクトリに配置されますが、Flutterのi18nライブラリはトップレベルディレクトリの.arbファイルを参照するため、本バッチでファイルの収集・変換を行います。

**バッチの実行タイミング**：開発者が手動でinvoke translateコマンドを実行した際に随時実行されます。また、ios/androidビルドタスクの前提タスクとして、CIパイプラインでも自動実行されます。

**主要な処理内容**：
1. 出力ディレクトリ（collected）の初期化
2. 各ロケールディレクトリから.arbファイルを収集
3. @@localeフィールドの修正
4. フォールバックロケールファイルの生成
5. supported_locales.dartファイルの自動生成

**前後の処理との関連**：本バッチはios/androidビルドタスクの前提タスク（pre=[clean, update, translate]）としてupdateの次に実行されます。ビルド前に最新の翻訳が組み込まれます。

**影響範囲**：lib/l10n/collected/ディレクトリの.arbファイル、lib/l10n/supported_locales.dartファイルが更新されます。

## バッチ種別

翻訳ファイル収集・変換処理（ビルドサポートタスク）

## 実行スケジュール

| 項目 | 内容 |
|-----|------|
| 実行頻度 | 随時 |
| 実行時刻 | なし（手動実行または前提タスクとして自動実行） |
| 実行曜日 | なし |
| 実行日 | なし |
| トリガー | 手動（invoke translateコマンド）/ ios・androidタスクの前提タスク / CI |

## 実行条件

### 前提条件

| 条件 | 説明 |
|-----|------|
| Python 3インストール済み | python3（macOS）またはpython（その他）が利用可能であること |
| lib/l10nディレクトリ存在 | 翻訳ファイルディレクトリが存在すること |
| app_en.arb存在 | 英語のソース翻訳ファイルが存在すること |

### 実行可否判定

lib/l10nディレクトリにapp_en.arbファイルが存在する場合に実行可能です。

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | デフォルト値 | 説明 |
|-------------|-----|-----|-------------|------|
| なし | - | - | - | パラメータ不要 |

### 入力データソース

| データソース | 形式 | 説明 |
|-------------|------|------|
| lib/l10n/{locale}/*.arb | ARB（JSON） | 各言語のCrowdin翻訳ファイル |
| lib/l10n/app_en.arb | ARB（JSON） | 英語ソース翻訳ファイル |

## 出力仕様

### 出力データ

| 出力先 | 形式 | 説明 |
|-------|------|------|
| lib/l10n/collected/*.arb | ARB（JSON） | 収集・変換された翻訳ファイル |
| lib/l10n/supported_locales.dart | Dart | サポートロケール一覧ファイル |

### 出力ファイル仕様

| 項目 | 内容 |
|-----|------|
| ファイル名 | app_{locale}.arb / supported_locales.dart |
| 出力先 | lib/l10n/collected/ / lib/l10n/ |
| 文字コード | UTF-8 |
| 区切り文字 | JSON形式（.arb）/ Dart形式（.dart） |

## 処理フロー

### 処理シーケンス

```
1. invokeコマンド実行
   └─ tasks.pyのtranslate関数が呼び出される
2. collect_translations.pyスクリプト実行
   └─ Python3でスクリプトが実行される
3. 出力ディレクトリ初期化
   └─ collected/ディレクトリを作成し、既存.arbを削除
4. ロケールディレクトリ走査
   └─ 各ロケールサブディレクトリから.arbファイルを収集
5. ファイルコピーと変換
   └─ @@localeフィールドを修正、フォールバックファイル生成
6. ソース翻訳ファイルコピー
   └─ app_en.arbをcollected/にコピー
7. supported_locales.dart生成
   └─ サポートロケール一覧のDartファイルを生成
```

### フローチャート

```mermaid
flowchart TD
    A[バッチ開始] --> B[collect_translations.py 実行]
    B --> C[collected/ ディレクトリ初期化]
    C --> D[ロケールディレクトリ走査]
    D --> E{.arb ファイル存在?}
    E -->|あり| F[ファイルコピー]
    E -->|なし| G[次のロケールへ]
    F --> H[@@locale フィールド修正]
    H --> I[フォールバックファイル生成]
    I --> G
    G --> J{全ロケール処理完了?}
    J -->|いいえ| D
    J -->|はい| K[app_en.arb コピー]
    K --> L[supported_locales.dart 生成]
    L --> M[バッチ終了]
```

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

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

| 処理 | 対象テーブル | 操作種別 | 概要 |
|-----|-------------|---------|------|
| なし | - | - | データベース操作なし |

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

データベース操作は行いません。

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| - | Python未インストール | pythonコマンドが見つからない | Python 3をインストールする |
| - | ディレクトリ不存在 | lib/l10nディレクトリがない | ディレクトリを作成する |
| - | ファイル不存在 | app_en.arbが存在しない | ソース翻訳ファイルを配置する |
| - | 権限エラー | ファイル書き込み権限がない | 適切な権限を設定する |

### リトライ仕様

| 項目 | 内容 |
|-----|------|
| リトライ回数 | なし |
| リトライ間隔 | - |
| リトライ対象エラー | - |

### 障害時対応

エラー発生時はコンソール出力を確認し、該当するファイルやディレクトリの状態を確認してください。

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

| 項目 | 内容 |
|-----|------|
| トランザクション範囲 | なし（ファイルシステム操作） |
| コミットタイミング | 各ファイル処理完了時 |
| ロールバック条件 | なし |

## パフォーマンス要件

| 項目 | 内容 |
|-----|------|
| 想定処理件数 | 数十ロケール |
| 目標処理時間 | 数秒 |
| メモリ使用量上限 | 特に制限なし |

## 排他制御

同時実行に対する排他制御はありません。

## ログ出力

| ログ種別 | 出力タイミング | 出力内容 |
|---------|--------------|---------|
| 標準出力 | ファイルコピー時 | "Copied file '{filename}'" |
| 標準出力 | フォールバック生成時 | "Creating fallback file: {path}" |
| 標準出力 | 処理完了時 | "Updated translations for {count} locales." |

## 監視・アラート

| 監視項目 | 閾値 | アラート先 |
|---------|-----|----------|
| なし | - | - |

## 備考

- 本バッチはプラットフォームに応じてPythonコマンドを切り替えます（macOS: python3、その他: python）
- フォールバックロケールファイル（例：app_ja.arb）は、国コード付きロケール（例：app_ja_JP.arb）が存在しない場合に自動生成されます
- supported_locales.dartファイルは自動生成されるため、直接編集しないでください
