# 機能設計書 52-URL操作

## 概要

本ドキュメントは、NushellにおけるURL操作機能の設計仕様を記載する。この機能は、URLの解析（パース）、結合、エンコード・デコード、クエリ文字列の操作などを提供する。

### 本機能の処理概要

URL操作機能は、URL文字列を構造化データとして扱い、各コンポーネント（スキーム、ホスト、パス、クエリなど）への分解・結合・変換を可能にする。

**業務上の目的・背景**：WebシステムやAPI開発において、URLの操作は頻繁に発生する作業である。URLのパースやクエリパラメータの抽出・構築を手作業で行うと誤りが生じやすいため、正確で効率的なURL操作機能を提供することで、開発・運用の効率を向上させる。

**機能の利用シーン**：
- APIエンドポイントURLからホスト名やパスを抽出
- クエリ文字列からパラメータを取得・変更
- 相対URLと基底URLの結合
- URLセーフな文字列へのエンコード・デコード
- 動的なURL構築

**主要な処理内容**：
1. URL文字列を構造化レコードにパース（scheme, host, path, query, fragment等）
2. 複数のURL要素を結合して完全なURLを生成
3. URL用エンコード/デコード処理
4. クエリ文字列とレコード間の相互変換

**関連システム・外部連携**：
- HTTP通信機能（No.51）と連携してAPIリクエストを構築
- ファイル出力・データ連携で動的URLを生成

**権限による制御**：なし

## 関連画面

| 画面No | 画面名 | 関連種別 | 関連する操作・処理 |
|--------|--------|----------|------------------|
| - | - | - | CLI専用コマンド |

## 機能種別

データ変換 / 文字列操作

## 入力仕様

### 入力パラメータ

#### url parse

| パラメータ名 | 型 | 必須 | 説明 | バリデーション |
|-------------|-----|-----|------|---------------|
| (パイプライン入力) | String | Yes | パース対象のURL文字列 | 有効なURL形式 |
| rest | CellPath | No | 操作対象のセルパス | - |

#### url join

| パラメータ名 | 型 | 必須 | 説明 | バリデーション |
|-------------|-----|-----|------|---------------|
| (パイプライン入力) | Record | Yes | URL要素を含むレコード | scheme, hostなどのキーを含む |

#### url encode

| パラメータ名 | 型 | 必須 | 説明 | バリデーション |
|-------------|-----|-----|------|---------------|
| (パイプライン入力) | String | Yes | エンコード対象の文字列 | - |
| --all, -a | Switch | No | 全文字をエンコード | - |

#### url decode

| パラメータ名 | 型 | 必須 | 説明 | バリデーション |
|-------------|-----|-----|------|---------------|
| (パイプライン入力) | String | Yes | デコード対象の文字列 | - |

#### url build-query

| パラメータ名 | 型 | 必須 | 説明 | バリデーション |
|-------------|-----|-----|------|---------------|
| (パイプライン入力) | Record | Yes | クエリパラメータのレコード | - |

#### url split-query

| パラメータ名 | 型 | 必須 | 説明 | バリデーション |
|-------------|-----|-----|------|---------------|
| (パイプライン入力) | String | Yes | クエリ文字列 | - |

### 入力データソース

パイプライン入力、コマンドライン引数

## 出力仕様

### 出力データ

#### url parse

| 項目名 | 型 | 説明 |
|--------|-----|------|
| scheme | String | URLスキーム（http, https等） |
| username | String | 認証ユーザー名 |
| password | String | 認証パスワード |
| host | String | ホスト名 |
| port | String | ポート番号 |
| path | String | パス |
| query | String | クエリ文字列 |
| fragment | String | フラグメント |
| params | List | クエリパラメータのリスト（key/value） |

#### url join

| 項目名 | 型 | 説明 |
|--------|-----|------|
| (出力) | String | 結合されたURL文字列 |

### 出力先

パイプライン出力

## 処理フロー

### 処理シーケンス（url parse）

```
1. 入力値取得
   └─ パイプラインから文字列を取得
2. URL解析
   └─ url::Url::parse()でパース
3. クエリパラメータ解析
   └─ query_string_to_table()でパラメータをテーブル化
4. レコード構築
   └─ 各コンポーネントをレコードに格納
5. 結果返却
   └─ PipelineDataとして返却
```

### フローチャート

```mermaid
flowchart TD
    A[開始] --> B[URL文字列取得]
    B --> C{URL形式有効?}
    C -->|No| D[エラー: UnsupportedInput]
    C -->|Yes| E[URLパース]
    E --> F[クエリパラメータ解析]
    F --> G{解析成功?}
    G -->|No| D
    G -->|Yes| H[レコード構築]
    H --> I[結果返却]
    I --> J[終了]
```

## ビジネスルール

### 業務ルール

| ルールNo | ルール名 | 内容 | 適用条件 |
|---------|---------|------|---------|
| BR-01 | 空ポート処理 | ポートがない場合は空文字を返却 | url parse実行時 |
| BR-02 | 空クエリ処理 | クエリがない場合は空のリストを返却 | url parse実行時 |
| BR-03 | エンコード対象 | 予約文字のみエンコード（--allで全文字） | url encode実行時 |
| BR-04 | percent-decode | %エンコードされた文字列をデコード | url decode実行時 |

### 計算ロジック

特になし

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

該当なし

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| UnsupportedInput | 入力エラー | 無効なURL形式 | 完全なURL形式で入力 |
| UnsupportedInput | 入力エラー | URLエンコード非互換 | 正しい文字列を入力 |

### リトライ仕様

該当なし

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

該当なし

## パフォーマンス要件

特になし

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

- URL内のパスワード情報の取り扱いに注意
- ユーザー入力をURLに含める場合は適切にエンコードすること

## 備考

urlクレートを使用したRFC準拠のURL解析

---

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

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

### 推奨読解順序

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

URL操作では主に文字列とレコードを扱う。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | parse.rs | `crates/nu-command/src/network/url/parse.rs` | URLパース結果のレコード構造を確認 |

**読解のコツ**:
- **108-118行目**: パース結果のレコード構造（scheme, username, password, host, port, path, query, fragment, params）

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

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | mod.rs | `crates/nu-command/src/network/url/mod.rs` | 提供されるコマンド一覧 |
| 2-2 | url_.rs | `crates/nu-command/src/network/url/url_.rs` | urlコマンドのヘルプ |

**主要処理フロー**:
- **mod.rs 10-16行目**: 各コマンドのエクスポート

#### Step 3: 各コマンド実装を理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | parse.rs | `crates/nu-command/src/network/url/parse.rs` | url parseの実装 |
| 3-2 | join.rs | `crates/nu-command/src/network/url/join.rs` | url joinの実装 |
| 3-3 | encode.rs | `crates/nu-command/src/network/url/encode.rs` | url encodeの実装 |
| 3-4 | decode.rs | `crates/nu-command/src/network/url/decode.rs` | url decodeの実装 |
| 3-5 | build_query.rs | `crates/nu-command/src/network/url/build_query.rs` | url build-queryの実装 |
| 3-6 | split_query.rs | `crates/nu-command/src/network/url/split_query.rs` | url split-queryの実装 |

**主要処理フロー（parse.rs）**:
- **83-121行目**: parse()関数でURL解析とレコード構築
- **89-95行目**: url::Url::parse()でURLをパース
- **97-104行目**: query_string_to_table()でクエリパラメータを解析
- **106-118行目**: 各URLコンポーネントをレコードに格納

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

```
url parse
    │
    ├─ parse() - URL解析
    │      ├─ url::Url::parse() - URLパース
    │      └─ query_string_to_table() - クエリパラメータ解析
    │
    └─ Value::record() - レコード生成

url join
    │
    └─ URL要素からURLを構築

url encode / decode
    │
    └─ percent-encoding処理

url build-query / split-query
    │
    └─ クエリ文字列とレコードの相互変換
```

### データフロー図

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

URL文字列 ─────────────▶ url parse ────────────────────▶ Record (scheme, host, path等)
Record ─────────────────▶ url join ─────────────────────▶ URL文字列
文字列 ─────────────────▶ url encode ───────────────────▶ エンコード済み文字列
エンコード済み ──────────▶ url decode ───────────────────▶ デコード済み文字列
Record ─────────────────▶ url build-query ──────────────▶ クエリ文字列
クエリ文字列 ───────────▶ url split-query ───────────────▶ Record
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| mod.rs | `crates/nu-command/src/network/url/mod.rs` | ソース | モジュール定義 |
| url_.rs | `crates/nu-command/src/network/url/url_.rs` | ソース | urlコマンド（ヘルプ） |
| parse.rs | `crates/nu-command/src/network/url/parse.rs` | ソース | url parseコマンド |
| join.rs | `crates/nu-command/src/network/url/join.rs` | ソース | url joinコマンド |
| encode.rs | `crates/nu-command/src/network/url/encode.rs` | ソース | url encodeコマンド |
| decode.rs | `crates/nu-command/src/network/url/decode.rs` | ソース | url decodeコマンド |
| build_query.rs | `crates/nu-command/src/network/url/build_query.rs` | ソース | url build-queryコマンド |
| split_query.rs | `crates/nu-command/src/network/url/split_query.rs` | ソース | url split-queryコマンド |
| query.rs | `crates/nu-command/src/network/url/query.rs` | ソース | クエリ文字列ユーティリティ |
