# バッチ設計書 15-process-icons

## 概要

本ドキュメントは、Wikipedia iOSアプリのアプリアイコンにビルド情報をオーバーレイするシェルスクリプト「process-icons.sh」のバッチ設計書です。

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

このバッチは開発・テスト用ビルドにおいて、アプリアイコンにビルド番号や設定名（Configuration）を視覚的にオーバーレイします。これにより、テスターや開発者がインストールされているアプリのバージョンを一目で識別できるようになります。ImageMagickとGhostscriptを使用して画像処理を行い、アイコンの下部にビルド情報を半透明のバナーとして重ねます。

**業務上の目的・背景**：開発チームやQAチームが複数のビルドバージョンを同時にテストする際、どのビルドがどのバージョンかを迅速に識別する必要があります。特にTestFlightでのベータテストや社内配布では、異なるビルド番号のアプリが混在することがあります。アイコンにビルド情報を表示することで、スクリーンショットの報告時やバグレポート時に、どのバージョンで問題が発生したかを明確にできます。Releaseビルドではこの処理はスキップされ、クリーンなアイコンが使用されます。

**バッチの実行タイミング**：Xcodeビルドプロセス中のRun Scriptフェーズで自動実行されます。

**主要な処理内容**：
1. Ghostscript（gs）とImageMagick（convert、identify）の存在確認
2. Info.plistからビルド番号（CFBundleVersion）を取得
3. 設定名（CONFIGURATION）とビルド番号でキャプション文字列を生成
4. AppIconSourceからAppIconへアイコンをコピー（Release時は処理なし）
5. Release以外：ImageMagickでキャプションをオーバーレイ

**前後の処理との関連**：Xcodeビルドプロセスの一部として実行されます。ソースアイコンセット（AppIconSource）から処理済みアイコンセット（AppIcon）を生成します。

**影響範囲**：AppIcon.appiconset内の全PNGファイルと、JSONメタデータファイルに影響します。

## バッチ種別

開発ツール / ビルドスクリプト / 画像処理

## 実行スケジュール

| 項目 | 内容 |
|-----|------|
| 実行頻度 | 随時（Xcodeビルド時） |
| 実行時刻 | 不定 |
| 実行曜日 | 不定 |
| 実行日 | 不定 |
| トリガー | Xcode Build Phase（Run Script） |

## 実行条件

### 前提条件

| 条件 | 説明 |
|-----|------|
| Ghostscriptインストール | gsコマンドが利用可能であること |
| ImageMagickインストール | convert、identifyコマンドが利用可能であること |
| アイコンソース | AppIconSource.appiconsetが存在すること |
| Info.plist | INFOPLIST_FILE環境変数で指定されたファイルが存在すること |

### 実行可否判定

- Ghostscriptがない場合：警告メッセージを出力してスキップ
- ImageMagickがない場合：警告メッセージを出力してスキップ
- CONFIGURATION == "Release"の場合：オーバーレイ処理をスキップ（アイコンコピーのみ）
- 前回と同じキャプションの場合：処理をスキップ（キャッシュ機能）

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | デフォルト値 | 説明 |
|-------------|-----|-----|-------------|------|
| INFOPLIST_FILE | 環境変数 | Yes | なし | Info.plistのパス（Xcodeが設定） |
| CONFIGURATION | 環境変数 | Yes | なし | ビルド設定名（Debug/Release等） |
| CONFIGURATION_BUILD_DIR | 環境変数 | Yes | なし | ビルド出力ディレクトリ |

### 入力データソース

| データソース | 形式 | 説明 |
|-------------|------|------|
| AppIconSource.appiconset/*.png | PNG画像 | ソースアイコン画像 |
| AppIconSource.appiconset/*.json | JSON | アイコンセットメタデータ |
| Info.plist | plist | CFBundleVersion取得元 |

## 出力仕様

### 出力データ

| 出力先 | 形式 | 説明 |
|-------|------|------|
| AppIcon.appiconset/*.png | PNG画像 | 処理済みアイコン画像 |
| AppIcon.appiconset/*.json | JSON | コピーされたメタデータ |
| ${CONFIGURATION_BUILD_DIR}/icon_caption | テキスト | キャッシュ用キャプションファイル |

### 出力ファイル仕様

| 項目 | 内容 |
|-----|------|
| ファイル名 | 元のアイコンと同名（*.png） |
| 出力先 | AppIcon.appiconset/ |
| 文字コード | バイナリ（PNG） |
| 区切り文字 | - |

## 処理フロー

### 処理シーケンス

```
1. 依存ツール確認
   └─ gs、convert、identifyコマンドの存在チェック
2. ビルド情報取得
   └─ Info.plistからCFBundleVersionを取得
   └─ CONFIGURATION名と組み合わせてキャプション生成
3. キャッシュチェック
   └─ 前回のキャプションと比較
   └─ 同一なら処理をスキップ
4. アイコンセット処理
   └─ AppIconSourceから全PNGファイルを列挙
   └─ 各アイコンに対して処理を実行
5. 個別アイコン処理
   └─ Release: 単純コピー
   └─ 非Release: ImageMagickでオーバーレイ
   └─ 最小幅（57px）未満のアイコンは単純コピー
6. メタデータコピー
   └─ Contents.jsonをコピー
7. キャッシュ更新
   └─ キャプションをファイルに保存
```

### フローチャート

```mermaid
flowchart TD
    A[バッチ開始] --> B{gs存在?}
    B -->|No| C[警告出力・終了]
    B -->|Yes| D{convert/identify存在?}
    D -->|No| C
    D -->|Yes| E[ビルド番号取得]
    E --> F[キャプション生成]
    F --> G{キャッシュと同一?}
    G -->|Yes| H[スキップ・終了]
    G -->|No| I[アイコンファイル列挙]
    I --> J{各アイコンを処理}
    J --> K{CONFIGURATION==Release?}
    K -->|Yes| L[単純コピー]
    K -->|No| M{幅>=57px?}
    M -->|No| L
    M -->|Yes| N[ImageMagickでオーバーレイ]
    L --> O{次のアイコン}
    N --> O
    O -->|あり| J
    O -->|なし| P[JSONコピー]
    P --> Q[キャッシュ更新]
    Q --> R[バッチ終了]
```

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

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

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

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

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

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| 0（警告） | ツール未インストール | Ghostscriptがない | brew install ghostscript |
| 0（警告） | ツール未インストール | ImageMagickがない | brew install imagemagick |
| 非0 | 処理エラー | ImageMagick処理失敗 | エラーログを確認 |

### リトライ仕様

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

### 障害時対応

ツール未インストールの場合はHomebrewでインストールしてください：
```bash
brew install ghostscript imagemagick
```

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

| 項目 | 内容 |
|-----|------|
| トランザクション範囲 | なし（ファイル操作のみ） |
| コミットタイミング | - |
| ロールバック条件 | - |

## パフォーマンス要件

| 項目 | 内容 |
|-----|------|
| 想定処理件数 | 約20ファイル（アイコンサイズバリエーション） |
| 目標処理時間 | 数秒〜十数秒 |
| メモリ使用量上限 | ImageMagick処理に依存 |

## 排他制御

Xcodeビルドプロセス内で実行されるため、同時実行は発生しません。

## ログ出力

| ログ種別 | 出力タイミング | 出力内容 |
|---------|--------------|---------|
| 情報ログ | アイコン処理時 | "Overlaying source image [path]" |
| 情報ログ | スキップ時 | "Not overlaying source Image [path] because..." |
| 情報ログ | Releaseビルド時 | "Not overlaying source Image for Release build" |
| 情報ログ | キャッシュヒット時 | "Already overlaid [caption] on icons, skipping." |
| 警告ログ | ツール不足時 | "Please install ghostscript/imagemagick..." |

## 監視・アラート

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

## 備考

- オーバーレイは半透明黒背景（#0008）に白文字で表示されます
- オーバーレイの高さはアイコン高さの1/4、幅は3倍（はみ出し防止）
- 最小幅57px未満の小さなアイコンはオーバーレイされません（視認性確保）
- キャプション形式：`{CONFIGURATION}\n({build_number})`
- キャッシュ機能により、キャプションが変わらない限り再処理されません
- 参考：http://www.merowing.info/2013/03/overlaying-application-version-on-top-of-your-icon/
