# 機能設計書 80-ジェネレーター

## 概要

本ドキュメントは、Nushellのジェネレーター機能の設計仕様を定義する。generateコマンドは、クロージャを繰り返し実行してリストを生成する機能を提供する。

### 本機能の処理概要

ジェネレーター機能は、クロージャを繰り返し呼び出し、その結果からリストを動的に生成する機能である。各呼び出しでクロージャは現在の状態を受け取り、出力値と次の状態を返す。入力ストリームと組み合わせることも可能。

**業務上の目的・背景**：再帰的なデータ生成や状態を持つシーケンス生成は、多くのプログラミングシナリオで必要となる。本機能により、フィボナッチ数列のような複雑なシーケンスや、累積計算を伴うデータ変換を簡潔に表現できる。

**機能の利用シーン**：
- フィボナッチ数列などの再帰的シーケンスを生成したい場合
- 状態を持つデータ変換（累積和など）を行いたい場合
- 条件に基づいて動的にリストを生成したい場合
- unfold/scan操作をNushellで実現したい場合

**主要な処理内容**：
1. 初期状態を取得（引数または閉包パラメータのデフォルト値）
2. クロージャを状態とともに呼び出し
3. 結果から`out`キーの値を出力に追加
4. `next`キーの値を次の状態として使用
5. `next`キーがない場合、またはクロージャが空を返した場合に終了

**関連システム・外部連携**：
- nu-engine::ClosureEval：クロージャ評価
- nu-protocol::ListStream：遅延リスト生成

**権限による制御**：特になし。全ユーザーが使用可能。

## 関連画面

| 画面No | 画面名 | 関連種別 | 関連する操作・処理 |
|--------|--------|----------|------------------|
| 1 | メインREPL | 主画面 | generateコマンドの実行と結果表示 |

## 機能種別

シーケンス生成機能

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | 説明 | バリデーション |
|-------------|-----|-----|------|---------------|
| closure | Closure | Yes | ジェネレータクロージャ | - |
| initial | Any | No | 初期状態（クロージャのデフォルト値でも可） | - |

### 入力データソース

- パイプライン入力（オプション、クロージャの第1引数として渡される）
- initial引数またはクロージャパラメータのデフォルト値

## 出力仕様

### 出力データ

| 項目名 | 型 | 説明 |
|--------|-----|------|
| 出力 | List<Any> | クロージャのoutキーから生成されたリスト |

### 出力先

標準出力（パイプライン出力）

## 処理フロー

### 処理シーケンス

```
1. generate コマンド（入力なし）
   └─ 初期状態を取得
   └─ クロージャ(state)を呼び出し
   └─ 結果をparse_closure_resultでパース
   └─ out値を出力、next値を次の状態に
   └─ next値がない場合終了

2. generate コマンド（入力ストリームあり）
   └─ 初期状態を取得
   └─ 入力ストリームの各要素について:
       └─ クロージャ(element, state)を呼び出し
       └─ 結果をparse_closure_resultでパース
       └─ out値を出力、next値を次の状態に
   └─ next値がないか、入力が終了したら終了
```

### フローチャート

```mermaid
flowchart TD
    A[generate コマンド] --> B{入力ストリーム?}

    B -->|No| C[初期状態取得]
    C --> D[クロージャ呼び出し: closure(state)]
    D --> E[parse_closure_result]
    E --> F{結果?}
    F -->|Record| G{outキー?}
    G -->|Yes| H[outを出力]
    G -->|No| I[スキップ]
    F -->|その他| J[エラー出力]
    H --> K{nextキー?}
    I --> K
    K -->|Yes| L[nextを次の状態に]
    K -->|No| M[終了]
    L --> D

    B -->|Yes| N[初期状態取得]
    N --> O[入力から要素取得]
    O --> P[クロージャ呼び出し: closure(element, state)]
    P --> Q[parse_closure_result]
    Q --> R{結果?}
    R -->|Record| S{outキー?}
    S -->|Yes| T[outを出力]
    S -->|No| U[スキップ]
    R -->|その他| V[エラー出力]
    T --> W{nextキー?}
    U --> W
    W -->|Yes| X[nextを次の状態に]
    W -->|No| Y[終了]
    X --> Z{入力終了?}
    Z -->|No| O
    Z -->|Yes| Y
```

## ビジネスルール

### 業務ルール

| ルールNo | ルール名 | 内容 | 適用条件 |
|---------|---------|------|---------|
| BR-80-1 | 結果形式 | クロージャはRecordを返す必要がある（out/nextキー） | 常時 |
| BR-80-2 | out出力 | outキーがあれば出力に追加、なければスキップ | 常時 |
| BR-80-3 | next状態 | nextキーがあれば次の状態、なければ終了 | 常時 |
| BR-80-4 | 初期状態 | initial引数がなければクロージャのデフォルト値を使用 | initial未指定時 |
| BR-80-5 | 入力ストリーム | 入力がある場合、クロージャは2引数（element, state） | 入力ストリームあり時 |
| BR-80-6 | 不明キー | out/next以外のキーはエラー | Recordに不明キーあり時 |

### 計算ロジック

```
// 入力なしの場合
state = initial ?? closure.default_value
loop:
  result = closure(state)
  if result is Empty: break
  if result is Record:
    if result.out: yield result.out
    if result.next: state = result.next; continue
    else: break
  else: yield Error

// 入力ありの場合
state = initial ?? closure.default_value
for element in input:
  result = closure(element, state)
  if result is Record:
    if result.out: yield result.out
    if result.next: state = result.next
    else: break
  else: yield Error
```

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

該当なし（本機能はデータベースを使用しない）

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| - | GenericError | 初期状態が指定されていない | initial引数またはクロージャのデフォルト値を指定 |
| - | GenericError | クロージャがRecordを返さなかった | Recordを返すクロージャを指定 |
| - | GenericError | 不明なキーがRecordに含まれる | out/nextキーのみを使用 |
| - | PipelineMismatch | 対応していない入力タイプ | List、Range、またはListStreamを使用 |

### リトライ仕様

リトライは行わない。

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

該当なし

## パフォーマンス要件

- 遅延評価でメモリ効率を確保
- 無限シーケンス生成時は消費者側での制限が必要

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

- クロージャ内で任意のコマンドが実行される
- 無限ループの可能性があるため、外部からの中断が必要

## 備考

- search_termsにunfold, stream, yield, expand, state, scanが含まれる
- 関数型プログラミングのunfold操作に相当
- 入力ストリームと組み合わせるとscan操作に相当

---

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

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

### 推奨読解順序

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

クロージャの結果パース構造を理解する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | generate.rs | `crates/nu-command/src/generators/generate.rs` | parse_closure_result関数（188-264行目） |

**読解のコツ**: クロージャの結果はRecord（out/nextキー）、Empty、またはエラーのいずれか。Recordの場合はキーを検証する。

#### Step 2: メイン処理を理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | generate.rs | `crates/nu-command/src/generators/generate.rs` | run関数（91-154行目） |
| 2-2 | generate.rs | `crates/nu-command/src/generators/generate.rs` | get_initial_state関数（156-186行目） |

**主要処理フロー** (generate.rs):
- **91-103行目**: 引数の取得とClosureEval作成
- **104-128行目**: 入力なしの場合 - from_fnイテレータ
- **129-152行目**: 入力ありの場合 - map_whileイテレータ
- **156-186行目**: get_initial_state - 初期状態の取得ロジック
- **188-264行目**: parse_closure_result - 結果のパースとエラー処理

**入力なし処理フロー** (104-128行目):
- **109行目**: get_initial_state()で初期状態取得
- **110-123行目**: from_fnでイテレータ作成
- **111行目**: state.take()で状態を取り出し
- **113-115行目**: closure.add_arg(state_arg).run_with_input()
- **116行目**: parse_closure_resultで結果パース
- **121行目**: nextを次の状態にセット

**入力あり処理フロー** (129-146行目):
- **132行目**: get_initial_state()で初期状態取得
- **133-142行目**: map_whileでイテレータ作成
- **135-138行目**: closure.add_arg(item).add_arg(state_arg).run_with_input()
- **139行目**: parse_closure_resultで結果パース

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

```
Generate::run (generate.rs)
    ├─ call.req::<Closure>()
    ├─ call.opt::<Value>("initial")
    ├─ ClosureEval::new()
    │
    ├─ 入力なしの場合:
    │      └─ std::iter::from_fn()
    │             ├─ get_initial_state()
    │             ├─ closure.add_arg(state).run_with_input()
    │             └─ parse_closure_result()
    │
    └─ 入力ありの場合:
           └─ input.into_iter().map_while()
                  ├─ get_initial_state()
                  ├─ closure.add_arg(item).add_arg(state).run_with_input()
                  └─ parse_closure_result()

parse_closure_result (generate.rs)
    ├─ PipelineData::Empty → (None, None)
    ├─ PipelineData::Value(Record) → outとnextを抽出
    │      ├─ "out"キー → 出力値
    │      ├─ "next"キー → 次の状態
    │      └─ その他 → エラー
    └─ その他 → エラー

get_initial_state (generate.rs)
    ├─ initial引数あり → その値
    └─ initial引数なし
           ├─ クロージャのデフォルト値あり → その値
           └─ なし → エラー
```

### データフロー図

```
[generate 入力なし]
initial ───▶ state ───▶ closure(state) ───▶ {out, next}
                │                              │    │
                │                              │    └───▶ state (ループ)
                │                              │
                └──────────────────────────────┘
                                               │
                                               ▼
                                         List<out値>

[generate 入力あり]
initial ───▶ state ─────────────────────────────────────┐
                                                        │
input ───▶ element ───▶ closure(element, state) ───▶ {out, next}
             │                                         │    │
             │                                         │    └───▶ state
             │                                         │
             └─────────────────────────────────────────┘
                                                       │
                                                       ▼
                                                 List<out値>
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| generate.rs | `crates/nu-command/src/generators/generate.rs` | ソース | generateコマンド |
| mod.rs | `crates/nu-command/src/generators/mod.rs` | ソース | generatorsモジュール定義 |
