@k2works/claude-code-booster 0.3.0 → 0.4.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/lib/assets/.claude/README.md +2 -0
- package/lib/assets/.claude/commands/dev.md +105 -0
- package/lib/assets/.claude/commands/ops.md +121 -0
- package/lib/assets/docs/reference//343/202/263/343/203/274/343/203/207/343/202/243/343/203/263/343/202/260/343/201/250/343/203/206/343/202/271/343/203/210/343/202/254/343/202/244/343/203/211.md +704 -0
- package/lib/assets/docs/reference//351/226/213/347/231/272/343/202/254/343/202/244/343/203/211.md +5 -171
- package/lib/assets/scripts/journal.js +17 -7
- package/package.json +1 -1
|
@@ -0,0 +1,105 @@
|
|
|
1
|
+
## Development Guide Reference
|
|
2
|
+
|
|
3
|
+
コーディングとテストガイドを参照し、TDD サイクルに従った開発を支援します。
|
|
4
|
+
|
|
5
|
+
### 使い方
|
|
6
|
+
|
|
7
|
+
```bash
|
|
8
|
+
/dev [オプション]
|
|
9
|
+
```
|
|
10
|
+
|
|
11
|
+
### オプション
|
|
12
|
+
|
|
13
|
+
- なし : ガイド全体の要約と TDD サイクルの説明
|
|
14
|
+
- `--tdd` : TDD の Red-Green-Refactor サイクルの詳細
|
|
15
|
+
- `--approach` : インサイドアウト/アウトサイドインアプローチの選択指針
|
|
16
|
+
- `--checklist` : コミット前の品質チェックリスト表示
|
|
17
|
+
- `--refactor` : リファクタリングパターンの一覧
|
|
18
|
+
- `--test` : テスト作成のベストプラクティス
|
|
19
|
+
|
|
20
|
+
### 基本例
|
|
21
|
+
|
|
22
|
+
```bash
|
|
23
|
+
# TDD サイクルの開始
|
|
24
|
+
/dev --tdd
|
|
25
|
+
「現在のタスクに対して Red-Green-Refactor サイクルを開始」
|
|
26
|
+
|
|
27
|
+
# アプローチ戦略の確認
|
|
28
|
+
/dev --approach
|
|
29
|
+
「実装アプローチ(インサイドアウト/アウトサイドイン)の選択を支援」
|
|
30
|
+
|
|
31
|
+
# 品質チェックの実行
|
|
32
|
+
/dev --checklist
|
|
33
|
+
「コミット前の必須確認事項を順次実行」
|
|
34
|
+
|
|
35
|
+
# リファクタリング支援
|
|
36
|
+
/dev --refactor
|
|
37
|
+
「現在のコードに適用可能なリファクタリングパターンを提案」
|
|
38
|
+
```
|
|
39
|
+
|
|
40
|
+
### 詳細機能
|
|
41
|
+
|
|
42
|
+
#### TDD サイクルの実践
|
|
43
|
+
|
|
44
|
+
Red-Green-Refactor サイクルを厳密に実行:
|
|
45
|
+
|
|
46
|
+
1. **Red フェーズ**: 失敗するテストを最初に書く
|
|
47
|
+
2. **Green フェーズ**: テストを通す最小限のコードを実装
|
|
48
|
+
3. **Refactor フェーズ**: 重複を除去し設計を改善
|
|
49
|
+
4. @docs/reference/コーディングとテストガイド.md のワークフローに従う
|
|
50
|
+
|
|
51
|
+
```bash
|
|
52
|
+
# 新機能の TDD 実装開始
|
|
53
|
+
/dev --tdd
|
|
54
|
+
「User エンティティのテストから開始します」
|
|
55
|
+
```
|
|
56
|
+
- @docs/design/architecture_backend.md を参照
|
|
57
|
+
- @docs/design/architecture_frontend.md を参照
|
|
58
|
+
- @docs/design/data-model.md を参照
|
|
59
|
+
- @docs/design/domain-model.md を参照
|
|
60
|
+
- @docs/design/tech_stack.md を参照
|
|
61
|
+
|
|
62
|
+
#### アプローチ戦略の選択
|
|
63
|
+
|
|
64
|
+
プロジェクトの状態に応じた最適なアプローチを選択:
|
|
65
|
+
|
|
66
|
+
- **インサイドアウト**: データ層から開始し上位層へ展開
|
|
67
|
+
- **アウトサイドイン**: UI から開始しドメインロジックを段階的に実装
|
|
68
|
+
|
|
69
|
+
### Claude との連携
|
|
70
|
+
|
|
71
|
+
```bash
|
|
72
|
+
# 現在のコードを分析してリファクタリング提案
|
|
73
|
+
cat src/User.java
|
|
74
|
+
/dev --refactor
|
|
75
|
+
「このクラスに適用可能なリファクタリングパターンを分析」
|
|
76
|
+
|
|
77
|
+
# テストカバレッジを確認してテスト追加
|
|
78
|
+
npm run test:coverage
|
|
79
|
+
/dev --test
|
|
80
|
+
「カバレッジが低い箇所のテストを追加」
|
|
81
|
+
|
|
82
|
+
# コミット前の品質確認
|
|
83
|
+
git status
|
|
84
|
+
/dev --checklist
|
|
85
|
+
「全ての品質基準を満たすまで確認を実行」
|
|
86
|
+
```
|
|
87
|
+
|
|
88
|
+
### 注意事項
|
|
89
|
+
|
|
90
|
+
- **前提条件**: プロジェクトのテスト環境が設定済みであること
|
|
91
|
+
- **制限事項**: TDD の三原則を厳密に守る(テストなしでプロダクションコードを書かない)
|
|
92
|
+
- **推奨事項**: コミット前に必ず品質チェックリストを実行
|
|
93
|
+
|
|
94
|
+
### ベストプラクティス
|
|
95
|
+
|
|
96
|
+
1. **TODO 駆動開発**: タスクを細かい TODO に分割してから実装開始
|
|
97
|
+
2. **小さなサイクル**: Red-Green-Refactor を 10-15 分で完了させる
|
|
98
|
+
3. **継続的コミット**: 各サイクル完了時に動作する状態でコミット
|
|
99
|
+
4. **Rule of Three**: 同じコードが 3 回現れたらリファクタリング
|
|
100
|
+
|
|
101
|
+
### 関連コマンド
|
|
102
|
+
|
|
103
|
+
- `/task` : タスク管理と TODO リストの作成
|
|
104
|
+
- `/review` : コードレビューの実施
|
|
105
|
+
- `/test` : テスト実行と結果確認
|
|
@@ -14,6 +14,7 @@
|
|
|
14
14
|
- `--setup [環境名]` : 環境構築の初期設定とインフラ準備
|
|
15
15
|
- `--setup Java` : Java開発環境の構築とSpring Bootプロジェクトセットアップ
|
|
16
16
|
- `--setup FrontEnd` : TypeScript/React開発環境の構築とViteプロジェクトセットアップ
|
|
17
|
+
- `--setup C#WPF` : C# WPF開発環境の構築とClean Architectureプロジェクトセットアップ
|
|
17
18
|
- `--build` : アプリケーションのビルドとパッケージング
|
|
18
19
|
- `--deploy <環境>` : 指定環境へのデプロイ実行
|
|
19
20
|
- `--status <環境>` : 特定環境の動作状況確認
|
|
@@ -22,6 +23,7 @@
|
|
|
22
23
|
- `--health` : システム全体のヘルスチェック実行
|
|
23
24
|
- `--backup` : データベース・設定ファイルのバックアップ作成
|
|
24
25
|
- `--restore <バックアップ>` : 指定バックアップからの復元
|
|
26
|
+
- `--daily` : 日次運用タスクの自動実行(日誌生成と概要編集)
|
|
25
27
|
|
|
26
28
|
### 基本例
|
|
27
29
|
|
|
@@ -42,6 +44,10 @@
|
|
|
42
44
|
/ops --setup FrontEnd
|
|
43
45
|
「プロジェクト名と作成場所(デフォルト app/frontend)を対話式で確認後、docs/reference/TypeScriptアプリケーション環境構築ガイド.md、@docs/design/tech_stack.md、@docs/design/architecture_frontend.md を基にしたTypeScript/React開発環境の統合セットアップ」
|
|
44
46
|
|
|
47
|
+
# C# WPF開発環境の構築
|
|
48
|
+
/ops --setup C#WPF
|
|
49
|
+
「プロジェクト名と作成場所(デフォルト app/wpfapp)を対話式で確認後、@docs/design/tech_stack.md、@docs/design/architecture_backend.md、@docs/design/architecture_frontend.md を基にしたC# WPF + Clean Architecture開発環境の統合セットアップ」
|
|
50
|
+
|
|
45
51
|
# プロダクション環境へのデプロイ
|
|
46
52
|
/ops --deploy production
|
|
47
53
|
「本番環境への安全なデプロイ実行とヘルスチェック」
|
|
@@ -57,6 +63,10 @@
|
|
|
57
63
|
# 緊急時のロールバック
|
|
58
64
|
/ops --rollback production
|
|
59
65
|
「本番環境を前の安定バージョンにロールバック」
|
|
66
|
+
|
|
67
|
+
# 日次運用タスクの実行
|
|
68
|
+
/ops --daily
|
|
69
|
+
「日誌の自動生成と概要編集を実行」
|
|
60
70
|
```
|
|
61
71
|
|
|
62
72
|
### 詳細機能
|
|
@@ -146,7 +156,71 @@
|
|
|
146
156
|
/ops --setup FrontEnd
|
|
147
157
|
```
|
|
148
158
|
|
|
159
|
+
#### C# WPF開発環境の統合セットアップ
|
|
160
|
+
|
|
161
|
+
ドキュメントベースの包括的C# WPF + Clean Architecture開発環境構築コマンド:
|
|
162
|
+
|
|
163
|
+
```bash
|
|
164
|
+
# ドキュメント準拠のC# WPF開発環境セットアップ(対話式)
|
|
165
|
+
/ops --setup C#WPF
|
|
166
|
+
```
|
|
167
|
+
|
|
149
168
|
**参照ドキュメント**:
|
|
169
|
+
- `@docs/design/tech_stack.md`: C# WPF技術スタック選定理由と詳細仕様
|
|
170
|
+
- `@docs/design/architecture_backend.md`: Clean Architecture + MagicOnion サーバー設計詳細
|
|
171
|
+
- `@docs/design/architecture_frontend.md`: WPF MVVM アーキテクチャとプレゼンテーション層設計詳細
|
|
172
|
+
|
|
173
|
+
**初期設定プロセス**:
|
|
174
|
+
|
|
175
|
+
🎯 **対話式プロジェクト設定**:
|
|
176
|
+
- プロジェクト名の確認(例: AdventureWorks.PurchasingSystem)
|
|
177
|
+
- ソリューション名の確認(例: AdventureWorks)
|
|
178
|
+
- 作成場所の確認(デフォルト: `app/`配下)
|
|
179
|
+
- データベース接続文字列の確認
|
|
180
|
+
|
|
181
|
+
**注意点**
|
|
182
|
+
- app/app のような構成にしてはいけない
|
|
183
|
+
- app/{solution-name} のような構成すること
|
|
184
|
+
- tech_stack.md の ディレクトリ構成詳細にしたがうこと
|
|
185
|
+
- ディレクトリだけの場合もコミットしたいので `.gitkeep` を入れる
|
|
186
|
+
- Javaの `src` や `tests` のようなディレクトリ構成にしないこと
|
|
187
|
+
|
|
188
|
+
**構築される環境の詳細**:
|
|
189
|
+
|
|
190
|
+
**📋 基盤技術** (@docs/design/tech_stack.md 準拠):
|
|
191
|
+
- .NET 8.0 + C# 12
|
|
192
|
+
- WPF + CommunityToolkit.Mvvm 8.x
|
|
193
|
+
- MagicOnion 5.x (gRPC ベースRPC)
|
|
194
|
+
- Dapper 2.x (Micro ORM)
|
|
195
|
+
- Kamishibai 3.x (ナビゲーション)
|
|
196
|
+
|
|
197
|
+
**🏗️ アーキテクチャ** (@docs/design/architecture_backend.md + @docs/design/architecture_frontend.md 準拠):
|
|
198
|
+
- Clean Architecture(依存関係逆転)
|
|
199
|
+
- Domain-Driven Design(ドメインモデル中心)
|
|
200
|
+
- MVVM パターン(WPF標準)
|
|
201
|
+
- レイヤー分離: Domain → Application → Infrastructure → Presentation
|
|
202
|
+
- MagicOnion サーバーによるgRPC通信
|
|
203
|
+
|
|
204
|
+
**💾 データベース環境**:
|
|
205
|
+
- 開発・テスト: SQL Server LocalDB
|
|
206
|
+
- 本番: SQL Server + Dapper
|
|
207
|
+
- マイグレーション: DbUp 5.x
|
|
208
|
+
- 接続プール: SqlConnection + HikariCP相当
|
|
209
|
+
|
|
210
|
+
**🔍 品質管理ツール**:
|
|
211
|
+
- テスト: NUnit 3 + FluentAssertions + Moq + Codeer.Friendly
|
|
212
|
+
- 静的解析: SonarQube + StyleCop + FxCop
|
|
213
|
+
- カバレッジ: OpenCover (Domain: 95%, Application: 85%目標)
|
|
214
|
+
- UI テスト: Codeer.Friendly.Windows.Wpf
|
|
215
|
+
- E2E テスト: Page Object Pattern
|
|
216
|
+
|
|
217
|
+
**⚙️ 開発支援機能**:
|
|
218
|
+
- Serilog (構造化ログ)
|
|
219
|
+
- Docker Compose (開発環境)
|
|
220
|
+
- MkDocs (ドキュメントサイト)
|
|
221
|
+
- PlantUML (アーキテクチャ図)
|
|
222
|
+
|
|
223
|
+
**TypeScript/React 参照ドキュメント**:
|
|
150
224
|
- `docs/reference/TypeScriptアプリケーション環境構築ガイド.md`: TDD基盤セットアップ手順と開発規律
|
|
151
225
|
- `@docs/design/tech_stack.md`: フロントエンド技術スタック選定理由と詳細仕様
|
|
152
226
|
- `@docs/design/architecture_frontend.md`: SPA アーキテクチャとコンポーネント設計詳細
|
|
@@ -254,6 +328,36 @@
|
|
|
254
328
|
/ops --health --dashboard
|
|
255
329
|
```
|
|
256
330
|
|
|
331
|
+
#### 日次運用タスク
|
|
332
|
+
|
|
333
|
+
プロジェクトの日常的な運用作業を自動化し、開発履歴の記録と管理を支援:
|
|
334
|
+
|
|
335
|
+
```bash
|
|
336
|
+
# 日次運用タスクの自動実行
|
|
337
|
+
/ops --daily
|
|
338
|
+
```
|
|
339
|
+
|
|
340
|
+
**実行される作業**:
|
|
341
|
+
|
|
342
|
+
**📝 日誌生成と管理**:
|
|
343
|
+
1. `npm run journal` コマンドの実行
|
|
344
|
+
2. Git コミット履歴から日付別の作業記録を自動生成
|
|
345
|
+
3. `docs/journal/YYYYMMDD.md` 形式でファイル作成
|
|
346
|
+
4. `mkdocs.yml` に自動登録
|
|
347
|
+
|
|
348
|
+
**✏️ 概要の自動編集**:
|
|
349
|
+
- 技術的な作業内容を簡潔に要約
|
|
350
|
+
- DDD(ドメイン駆動設計)などの設計パターンへの言及
|
|
351
|
+
- 実施した主要な変更と改善点の明確化
|
|
352
|
+
- bounded context の整合性などアーキテクチャレベルの変更を強調
|
|
353
|
+
- 型参照の更新、リファクタリング詳細、テスト戦略などを含む
|
|
354
|
+
|
|
355
|
+
**生成される日誌の構成**:
|
|
356
|
+
- コミットメッセージ
|
|
357
|
+
- 変更されたファイル一覧
|
|
358
|
+
- 詳細な diff 情報
|
|
359
|
+
- 作業内容の技術的サマリー
|
|
360
|
+
|
|
257
361
|
#### バックアップと災害復旧
|
|
258
362
|
|
|
259
363
|
自動バックアップと迅速な災害復旧:
|
|
@@ -362,6 +466,23 @@ cat docs/design/architecture_frontend.md
|
|
|
362
466
|
# → 開発ポート確認: "3000" (Enter でデフォルト採用)
|
|
363
467
|
npm run dev
|
|
364
468
|
「設計ドキュメント確認後、対話式でプロジェクト設定を確認し、TypeScript/React環境構築と開発サーバー起動」
|
|
469
|
+
|
|
470
|
+
# ドキュメント準拠のC# WPF開発環境構築(対話式)
|
|
471
|
+
cat docs/design/tech_stack.md
|
|
472
|
+
cat docs/design/architecture_backend.md
|
|
473
|
+
cat docs/design/architecture_frontend.md
|
|
474
|
+
/ops --setup C#WPF
|
|
475
|
+
# → ソリューション名入力: "AdventureWorks"
|
|
476
|
+
# → プロジェクト名確認: "AdventureWorks.PurchasingSystem" (自動生成)
|
|
477
|
+
# → 作成場所確認: "app/wpfapp/" (Enter でデフォルト採用)
|
|
478
|
+
# → 接続文字列確認: "Server=(localdb)\\mssqllocaldb;..." (デフォルト採用)
|
|
479
|
+
dotnet build
|
|
480
|
+
「設計ドキュメント確認後、対話式でプロジェクト設定を確認し、C# WPF + Clean Architecture環境構築と初回ビルド実行」
|
|
481
|
+
|
|
482
|
+
# 日次運用タスクと開発履歴管理
|
|
483
|
+
git status
|
|
484
|
+
/ops --daily
|
|
485
|
+
「現在の作業状況を確認後、日誌生成と概要の自動編集を実行」
|
|
365
486
|
```
|
|
366
487
|
|
|
367
488
|
### 注意事項
|
|
@@ -0,0 +1,704 @@
|
|
|
1
|
+
# コーディングとテストガイド
|
|
2
|
+
|
|
3
|
+
## 概要
|
|
4
|
+
|
|
5
|
+
このガイドは、開発ガイドのコーディングとテスト部分を詳細化したドキュメントです。TDD(テスト駆動開発)を中核とした実装プロセスの具体的な手順と、品質を維持するための規律を定義します。
|
|
6
|
+
|
|
7
|
+
## 基本原則
|
|
8
|
+
|
|
9
|
+
### TDD(Test-Driven Development)の三つの原則
|
|
10
|
+
|
|
11
|
+
1. **失敗するテストを書くまで、プロダクションコードを書いてはならない**
|
|
12
|
+
2. **失敗するテストは、失敗するのに十分なだけ書く**
|
|
13
|
+
3. **現在失敗しているテストを成功させる以上のプロダクションコードを書いてはならない**
|
|
14
|
+
|
|
15
|
+
### Red-Green-Refactor サイクル
|
|
16
|
+
|
|
17
|
+
```plantuml
|
|
18
|
+
@startuml
|
|
19
|
+
skinparam state {
|
|
20
|
+
BackgroundColor Red
|
|
21
|
+
BackgroundColor LightGreen
|
|
22
|
+
BackgroundColor LightBlue
|
|
23
|
+
}
|
|
24
|
+
|
|
25
|
+
[*] --> Red
|
|
26
|
+
state Red {
|
|
27
|
+
[*] --> テストを書く
|
|
28
|
+
テストを書く : 失敗する
|
|
29
|
+
}
|
|
30
|
+
Red --> Green : 最小限の実装
|
|
31
|
+
|
|
32
|
+
state Green {
|
|
33
|
+
[*] --> テストが通る
|
|
34
|
+
テストが通る : 最小限のコード
|
|
35
|
+
}
|
|
36
|
+
Green --> Refactor : テスト成功
|
|
37
|
+
|
|
38
|
+
state Refactor {
|
|
39
|
+
[*] --> リファクタリング
|
|
40
|
+
リファクタリング : 設計改善
|
|
41
|
+
}
|
|
42
|
+
Refactor --> Red : 次のテスト
|
|
43
|
+
Refactor --> [*] : 完了
|
|
44
|
+
|
|
45
|
+
note right of Red
|
|
46
|
+
失敗するテストを
|
|
47
|
+
最初に書く
|
|
48
|
+
end note
|
|
49
|
+
|
|
50
|
+
note right of Green
|
|
51
|
+
テストを通す
|
|
52
|
+
最小限のコードを書く
|
|
53
|
+
end note
|
|
54
|
+
|
|
55
|
+
note right of Refactor
|
|
56
|
+
重複を除去し
|
|
57
|
+
設計を改善する
|
|
58
|
+
end note
|
|
59
|
+
|
|
60
|
+
@enduml
|
|
61
|
+
```
|
|
62
|
+
|
|
63
|
+
## イテレーション開発フロー
|
|
64
|
+
|
|
65
|
+
### 全体プロセス
|
|
66
|
+
|
|
67
|
+
```plantuml
|
|
68
|
+
@startuml "イテレーション開発プロセス"
|
|
69
|
+
|
|
70
|
+
start
|
|
71
|
+
|
|
72
|
+
partition "イテレーション開始" {
|
|
73
|
+
}
|
|
74
|
+
|
|
75
|
+
repeat :TODO確認;
|
|
76
|
+
partition "TDD実装サイクル" {
|
|
77
|
+
repeat
|
|
78
|
+
:TODO選択;
|
|
79
|
+
|
|
80
|
+
repeat
|
|
81
|
+
:失敗テスト作成 (Red);
|
|
82
|
+
:最小実装 (Green);
|
|
83
|
+
:リファクタリング (Refactor);
|
|
84
|
+
:品質チェック;
|
|
85
|
+
if (品質OK?) then (yes)
|
|
86
|
+
:コミット;
|
|
87
|
+
else (no)
|
|
88
|
+
:修正;
|
|
89
|
+
endif
|
|
90
|
+
repeat while (TODO完了?)
|
|
91
|
+
partition "コードレビュー" {
|
|
92
|
+
}
|
|
93
|
+
repeat while (全TODO完了?)
|
|
94
|
+
}
|
|
95
|
+
|
|
96
|
+
if (イテレーション完了?) then (yes)
|
|
97
|
+
partition "受け入れ" {
|
|
98
|
+
partition "ユーザーレビュー" {
|
|
99
|
+
}
|
|
100
|
+
if (受け入れOK?) then (yes)
|
|
101
|
+
partition "ふりかえり" {
|
|
102
|
+
}
|
|
103
|
+
else (no)
|
|
104
|
+
partition "修正対応" {
|
|
105
|
+
}
|
|
106
|
+
endif
|
|
107
|
+
}
|
|
108
|
+
else (no)
|
|
109
|
+
partition "設計リファクタリング" {
|
|
110
|
+
partition "アーキテクチャリファクタリング" {
|
|
111
|
+
}
|
|
112
|
+
partition "データモデルリファクタリング" {
|
|
113
|
+
}
|
|
114
|
+
partition "ドメインモデルリファクタリング" {
|
|
115
|
+
}
|
|
116
|
+
partition "UIリファクタリング" {
|
|
117
|
+
}
|
|
118
|
+
}
|
|
119
|
+
endif
|
|
120
|
+
repeat while (次のTODO?)
|
|
121
|
+
|
|
122
|
+
stop
|
|
123
|
+
|
|
124
|
+
@enduml
|
|
125
|
+
```
|
|
126
|
+
|
|
127
|
+
## アプローチ戦略
|
|
128
|
+
|
|
129
|
+
### インサイドアウト vs アウトサイドイン
|
|
130
|
+
|
|
131
|
+
```plantuml
|
|
132
|
+
@startuml
|
|
133
|
+
title 実装アプローチ選択フロー
|
|
134
|
+
|
|
135
|
+
start
|
|
136
|
+
|
|
137
|
+
:ユーザーストーリー分析;
|
|
138
|
+
|
|
139
|
+
if (基本CRUD実装済み?) then (はい)
|
|
140
|
+
if (ドメインロジックが複雑?) then (はい)
|
|
141
|
+
:ドメインモデル中心;
|
|
142
|
+
#lightgreen:アウトサイドイン推奨;
|
|
143
|
+
note right
|
|
144
|
+
UIからスタート
|
|
145
|
+
ドメインロジックを
|
|
146
|
+
段階的に実装
|
|
147
|
+
end note
|
|
148
|
+
else (いいえ)
|
|
149
|
+
:シンプルな機能追加;
|
|
150
|
+
#lightblue:どちらでも可;
|
|
151
|
+
endif
|
|
152
|
+
else (いいえ)
|
|
153
|
+
:貧血ドメインモデル;
|
|
154
|
+
#yellow:インサイドアウト推奨;
|
|
155
|
+
note right
|
|
156
|
+
データ層から開始
|
|
157
|
+
基盤を固めて
|
|
158
|
+
上位層へ展開
|
|
159
|
+
end note
|
|
160
|
+
endif
|
|
161
|
+
|
|
162
|
+
if (API実装済み?) then (はい)
|
|
163
|
+
#lightblue:インサイドアウト活用;
|
|
164
|
+
note right
|
|
165
|
+
既存APIを利用し
|
|
166
|
+
内部実装を改善
|
|
167
|
+
end note
|
|
168
|
+
else (いいえ)
|
|
169
|
+
#lightgreen:アウトサイドイン活用;
|
|
170
|
+
note right
|
|
171
|
+
UIのニーズから
|
|
172
|
+
API設計を導出
|
|
173
|
+
end note
|
|
174
|
+
endif
|
|
175
|
+
|
|
176
|
+
:アプローチ決定;
|
|
177
|
+
|
|
178
|
+
stop
|
|
179
|
+
@enduml
|
|
180
|
+
```
|
|
181
|
+
|
|
182
|
+
### インサイドアウトアプローチ
|
|
183
|
+
|
|
184
|
+
```plantuml
|
|
185
|
+
@startuml
|
|
186
|
+
title インサイドアウトアプローチ
|
|
187
|
+
|
|
188
|
+
participant "テスト" as test
|
|
189
|
+
participant "データベース層" as db
|
|
190
|
+
participant "インフラ層" as infra
|
|
191
|
+
participant "ドメイン層" as domain
|
|
192
|
+
participant "サービス層" as service
|
|
193
|
+
participant "プレゼンテーション層" as ui
|
|
194
|
+
|
|
195
|
+
== Phase 1: データベース ==
|
|
196
|
+
test -> db: テーブル定義テスト
|
|
197
|
+
activate db
|
|
198
|
+
db --> test: スキーマ検証
|
|
199
|
+
deactivate db
|
|
200
|
+
|
|
201
|
+
== Phase 2: インフラストラクチャ ==
|
|
202
|
+
test -> infra: リポジトリテスト
|
|
203
|
+
activate infra
|
|
204
|
+
infra -> db: CRUD操作
|
|
205
|
+
db --> infra: 結果
|
|
206
|
+
infra --> test: 永続化確認
|
|
207
|
+
deactivate infra
|
|
208
|
+
|
|
209
|
+
== Phase 3: ドメイン ==
|
|
210
|
+
test -> domain: ビジネスロジックテスト
|
|
211
|
+
activate domain
|
|
212
|
+
domain -> infra: データ取得
|
|
213
|
+
infra --> domain: エンティティ
|
|
214
|
+
domain --> test: ビジネスルール検証
|
|
215
|
+
deactivate domain
|
|
216
|
+
|
|
217
|
+
== Phase 4: サービス ==
|
|
218
|
+
test -> service: ユースケーステスト
|
|
219
|
+
activate service
|
|
220
|
+
service -> domain: ドメイン操作
|
|
221
|
+
domain --> service: 結果
|
|
222
|
+
service --> test: トランザクション確認
|
|
223
|
+
deactivate service
|
|
224
|
+
|
|
225
|
+
== Phase 5: プレゼンテーション ==
|
|
226
|
+
test -> ui: UIテスト
|
|
227
|
+
activate ui
|
|
228
|
+
ui -> service: API呼び出し
|
|
229
|
+
service --> ui: レスポンス
|
|
230
|
+
ui --> test: 画面表示確認
|
|
231
|
+
deactivate ui
|
|
232
|
+
|
|
233
|
+
@enduml
|
|
234
|
+
```
|
|
235
|
+
|
|
236
|
+
### アウトサイドインアプローチ
|
|
237
|
+
|
|
238
|
+
```plantuml
|
|
239
|
+
@startuml
|
|
240
|
+
title アウトサイドインアプローチ
|
|
241
|
+
|
|
242
|
+
participant "受け入れテスト" as at
|
|
243
|
+
participant "プレゼンテーション層" as ui
|
|
244
|
+
participant "サービス層" as service
|
|
245
|
+
participant "ドメイン層" as domain
|
|
246
|
+
participant "インフラ層" as infra
|
|
247
|
+
participant "データベース層" as db
|
|
248
|
+
|
|
249
|
+
== Phase 1: 受け入れテスト ==
|
|
250
|
+
at -> ui: ユーザーシナリオ
|
|
251
|
+
activate at
|
|
252
|
+
ui --> at: モック応答
|
|
253
|
+
deactivate at
|
|
254
|
+
|
|
255
|
+
== Phase 2: UI実装 ==
|
|
256
|
+
at -> ui: UIテスト
|
|
257
|
+
activate ui
|
|
258
|
+
ui -> service: サービス呼び出し(モック)
|
|
259
|
+
service --> ui: モックレスポンス
|
|
260
|
+
ui --> at: 画面動作確認
|
|
261
|
+
deactivate ui
|
|
262
|
+
|
|
263
|
+
== Phase 3: サービス実装 ==
|
|
264
|
+
at -> service: 統合テスト
|
|
265
|
+
activate service
|
|
266
|
+
service -> domain: ドメイン呼び出し(モック)
|
|
267
|
+
domain --> service: モック結果
|
|
268
|
+
service --> at: ビジネスロジック確認
|
|
269
|
+
deactivate service
|
|
270
|
+
|
|
271
|
+
== Phase 4: ドメイン実装 ==
|
|
272
|
+
at -> domain: ドメインテスト
|
|
273
|
+
activate domain
|
|
274
|
+
domain -> infra: リポジトリ呼び出し(モック)
|
|
275
|
+
infra --> domain: モックデータ
|
|
276
|
+
domain --> at: ビジネスルール確認
|
|
277
|
+
deactivate domain
|
|
278
|
+
|
|
279
|
+
== Phase 5: インフラ実装 ==
|
|
280
|
+
at -> infra: 永続化テスト
|
|
281
|
+
activate infra
|
|
282
|
+
infra -> db: DB操作
|
|
283
|
+
db --> infra: 実データ
|
|
284
|
+
infra --> at: データ永続化確認
|
|
285
|
+
deactivate infra
|
|
286
|
+
|
|
287
|
+
@enduml
|
|
288
|
+
```
|
|
289
|
+
|
|
290
|
+
## TDD実装の詳細手順
|
|
291
|
+
|
|
292
|
+
### 1. TODO作成
|
|
293
|
+
|
|
294
|
+
```markdown
|
|
295
|
+
## TODOリストの例
|
|
296
|
+
|
|
297
|
+
- [ ] ユーザー登録機能
|
|
298
|
+
- [ ] Userエンティティの作成
|
|
299
|
+
- [ ] 必須フィールドの検証
|
|
300
|
+
- [ ] メールアドレスの形式検証
|
|
301
|
+
- [ ] パスワードの強度チェック
|
|
302
|
+
- [ ] UserRepositoryの実装
|
|
303
|
+
- [ ] save()メソッド
|
|
304
|
+
- [ ] findByEmail()メソッド
|
|
305
|
+
- [ ] existsByEmail()メソッド
|
|
306
|
+
- [ ] UserServiceの実装
|
|
307
|
+
- [ ] register()メソッド
|
|
308
|
+
- [ ] 重複チェック
|
|
309
|
+
- [ ] パスワードハッシュ化
|
|
310
|
+
- [ ] UserControllerの実装
|
|
311
|
+
- [ ] POST /users エンドポイント
|
|
312
|
+
- [ ] バリデーション
|
|
313
|
+
- [ ] エラーハンドリング
|
|
314
|
+
```
|
|
315
|
+
|
|
316
|
+
### 2. Red フェーズ(失敗するテストを書く)
|
|
317
|
+
|
|
318
|
+
```java
|
|
319
|
+
// UserTest.java
|
|
320
|
+
@Test
|
|
321
|
+
void ユーザー作成時に必須フィールドが検証される() {
|
|
322
|
+
// Given
|
|
323
|
+
String email = "test@example.com";
|
|
324
|
+
String password = "SecurePass123!";
|
|
325
|
+
String name = "山田太郎";
|
|
326
|
+
|
|
327
|
+
// When
|
|
328
|
+
User user = new User(email, password, name);
|
|
329
|
+
|
|
330
|
+
// Then
|
|
331
|
+
assertThat(user.getEmail()).isEqualTo(email);
|
|
332
|
+
assertThat(user.getName()).isEqualTo(name);
|
|
333
|
+
// パスワードはハッシュ化されている
|
|
334
|
+
assertThat(user.getPassword()).isNotEqualTo(password);
|
|
335
|
+
}
|
|
336
|
+
|
|
337
|
+
@Test
|
|
338
|
+
void 無効なメールアドレスで例外が発生する() {
|
|
339
|
+
// Given
|
|
340
|
+
String invalidEmail = "invalid-email";
|
|
341
|
+
|
|
342
|
+
// When/Then
|
|
343
|
+
assertThrows(IllegalArgumentException.class, () -> {
|
|
344
|
+
new User(invalidEmail, "password", "name");
|
|
345
|
+
});
|
|
346
|
+
}
|
|
347
|
+
```
|
|
348
|
+
|
|
349
|
+
### 3. Green フェーズ(最小限の実装)
|
|
350
|
+
|
|
351
|
+
```java
|
|
352
|
+
// User.java
|
|
353
|
+
public class User {
|
|
354
|
+
private String email;
|
|
355
|
+
private String password;
|
|
356
|
+
private String name;
|
|
357
|
+
|
|
358
|
+
public User(String email, String password, String name) {
|
|
359
|
+
if (!isValidEmail(email)) {
|
|
360
|
+
throw new IllegalArgumentException("無効なメールアドレス");
|
|
361
|
+
}
|
|
362
|
+
this.email = email;
|
|
363
|
+
this.password = hashPassword(password);
|
|
364
|
+
this.name = name;
|
|
365
|
+
}
|
|
366
|
+
|
|
367
|
+
private boolean isValidEmail(String email) {
|
|
368
|
+
return email != null && email.contains("@");
|
|
369
|
+
}
|
|
370
|
+
|
|
371
|
+
private String hashPassword(String password) {
|
|
372
|
+
// 簡単なハッシュ化の実装(後で改善)
|
|
373
|
+
return "hashed_" + password;
|
|
374
|
+
}
|
|
375
|
+
|
|
376
|
+
// getters...
|
|
377
|
+
}
|
|
378
|
+
```
|
|
379
|
+
|
|
380
|
+
### 4. Refactor フェーズ(設計改善)
|
|
381
|
+
|
|
382
|
+
```java
|
|
383
|
+
// User.java (リファクタリング後)
|
|
384
|
+
public class User {
|
|
385
|
+
private final Email email;
|
|
386
|
+
private final Password password;
|
|
387
|
+
private final Name name;
|
|
388
|
+
|
|
389
|
+
public User(String email, String password, String name) {
|
|
390
|
+
this.email = new Email(email);
|
|
391
|
+
this.password = new Password(password);
|
|
392
|
+
this.name = new Name(name);
|
|
393
|
+
}
|
|
394
|
+
|
|
395
|
+
// getters...
|
|
396
|
+
}
|
|
397
|
+
|
|
398
|
+
// Email.java (値オブジェクト)
|
|
399
|
+
public class Email {
|
|
400
|
+
private static final Pattern VALID_EMAIL_PATTERN =
|
|
401
|
+
Pattern.compile("^[A-Za-z0-9+_.-]+@[A-Za-z0-9.-]+\\.[A-Za-z]{2,}$");
|
|
402
|
+
|
|
403
|
+
private final String value;
|
|
404
|
+
|
|
405
|
+
public Email(String value) {
|
|
406
|
+
if (value == null || !VALID_EMAIL_PATTERN.matcher(value).matches()) {
|
|
407
|
+
throw new IllegalArgumentException("無効なメールアドレス: " + value);
|
|
408
|
+
}
|
|
409
|
+
this.value = value;
|
|
410
|
+
}
|
|
411
|
+
|
|
412
|
+
public String getValue() {
|
|
413
|
+
return value;
|
|
414
|
+
}
|
|
415
|
+
}
|
|
416
|
+
|
|
417
|
+
// Password.java (値オブジェクト)
|
|
418
|
+
public class Password {
|
|
419
|
+
private static final int MIN_LENGTH = 8;
|
|
420
|
+
private final String hashedValue;
|
|
421
|
+
|
|
422
|
+
public Password(String rawPassword) {
|
|
423
|
+
validate(rawPassword);
|
|
424
|
+
this.hashedValue = BCrypt.hashpw(rawPassword, BCrypt.gensalt());
|
|
425
|
+
}
|
|
426
|
+
|
|
427
|
+
private void validate(String password) {
|
|
428
|
+
if (password == null || password.length() < MIN_LENGTH) {
|
|
429
|
+
throw new IllegalArgumentException(
|
|
430
|
+
"パスワードは" + MIN_LENGTH + "文字以上必要です"
|
|
431
|
+
);
|
|
432
|
+
}
|
|
433
|
+
}
|
|
434
|
+
|
|
435
|
+
public boolean matches(String rawPassword) {
|
|
436
|
+
return BCrypt.checkpw(rawPassword, hashedValue);
|
|
437
|
+
}
|
|
438
|
+
}
|
|
439
|
+
```
|
|
440
|
+
|
|
441
|
+
## 品質チェックリスト
|
|
442
|
+
|
|
443
|
+
### コミット前の必須確認事項
|
|
444
|
+
|
|
445
|
+
```bash
|
|
446
|
+
# 1. テスト実行
|
|
447
|
+
./gradlew test # または npm test
|
|
448
|
+
|
|
449
|
+
# 2. コードフォーマット
|
|
450
|
+
./gradlew spotlessApply # または npm run format
|
|
451
|
+
|
|
452
|
+
# 3. 静的解析
|
|
453
|
+
./gradlew check # または npm run lint
|
|
454
|
+
|
|
455
|
+
# 4. ビルド確認
|
|
456
|
+
./gradlew build # または npm run build
|
|
457
|
+
|
|
458
|
+
# 5. カバレッジ確認
|
|
459
|
+
./gradlew jacocoTestReport # または npm run test:coverage
|
|
460
|
+
```
|
|
461
|
+
|
|
462
|
+
### 品質基準
|
|
463
|
+
|
|
464
|
+
| 項目 | 基準 | 必須/推奨 |
|
|
465
|
+
|------|------|-----------|
|
|
466
|
+
| テストカバレッジ | 80%以上 | 必須 |
|
|
467
|
+
| 循環的複雑度 | 10以下 | 必須 |
|
|
468
|
+
| メソッドの行数 | 20行以下 | 推奨 |
|
|
469
|
+
| クラスの行数 | 200行以下 | 推奨 |
|
|
470
|
+
| 重複コード | 0% | 必須 |
|
|
471
|
+
| コンパイラ警告 | 0個 | 必須 |
|
|
472
|
+
| Linter警告 | 0個 | 必須 |
|
|
473
|
+
|
|
474
|
+
## コミット規約
|
|
475
|
+
|
|
476
|
+
### コミットメッセージフォーマット
|
|
477
|
+
|
|
478
|
+
```
|
|
479
|
+
<type>(<scope>): <subject>
|
|
480
|
+
|
|
481
|
+
<body>
|
|
482
|
+
|
|
483
|
+
<footer>
|
|
484
|
+
```
|
|
485
|
+
|
|
486
|
+
### タイプ一覧
|
|
487
|
+
|
|
488
|
+
| タイプ | 説明 | 例 |
|
|
489
|
+
|--------|------|-----|
|
|
490
|
+
| feat | 新機能追加 | `feat(auth): ユーザー認証機能を追加` |
|
|
491
|
+
| fix | バグ修正 | `fix(api): NullPointerExceptionを修正` |
|
|
492
|
+
| docs | ドキュメント変更 | `docs(readme): インストール手順を更新` |
|
|
493
|
+
| style | コードスタイル変更 | `style: インデントを修正` |
|
|
494
|
+
| refactor | リファクタリング | `refactor(user): Userクラスを値オブジェクトに分割` |
|
|
495
|
+
| test | テスト追加・修正 | `test(user): ユーザー登録のテストを追加` |
|
|
496
|
+
| chore | ビルド・ツール変更 | `chore(gradle): 依存関係を更新` |
|
|
497
|
+
|
|
498
|
+
### コミット単位
|
|
499
|
+
|
|
500
|
+
- **1コミット = 1論理的変更**
|
|
501
|
+
- TODOリストの項目単位でコミット
|
|
502
|
+
- Red-Green-Refactorサイクル完了時にコミット
|
|
503
|
+
- ビルドが通る状態でコミット
|
|
504
|
+
|
|
505
|
+
## テストの種類と戦略
|
|
506
|
+
|
|
507
|
+
### テストピラミッド
|
|
508
|
+
|
|
509
|
+
```plantuml
|
|
510
|
+
@startuml
|
|
511
|
+
skinparam defaultTextAlignment center
|
|
512
|
+
|
|
513
|
+
rectangle "E2Eテスト\n(10%)" as e2e #LightCoral
|
|
514
|
+
|
|
515
|
+
rectangle "統合テスト\n(30%)" as integration #LightSalmon
|
|
516
|
+
|
|
517
|
+
rectangle "単体テスト\n(60%)" as unit #LightGreen
|
|
518
|
+
|
|
519
|
+
e2e -[hidden]down-> integration
|
|
520
|
+
integration -[hidden]down-> unit
|
|
521
|
+
|
|
522
|
+
note right of e2e
|
|
523
|
+
ユーザーシナリオ
|
|
524
|
+
システム全体の動作確認
|
|
525
|
+
実行時間: 遅い
|
|
526
|
+
end note
|
|
527
|
+
|
|
528
|
+
note right of integration
|
|
529
|
+
モジュール間連携
|
|
530
|
+
API・DB接続テスト
|
|
531
|
+
実行時間: 中程度
|
|
532
|
+
end note
|
|
533
|
+
|
|
534
|
+
note right of unit
|
|
535
|
+
個別機能のテスト
|
|
536
|
+
ビジネスロジック検証
|
|
537
|
+
実行時間: 高速
|
|
538
|
+
end note
|
|
539
|
+
|
|
540
|
+
@enduml
|
|
541
|
+
```
|
|
542
|
+
|
|
543
|
+
### テスト作成のベストプラクティス
|
|
544
|
+
|
|
545
|
+
#### 1. AAA パターン(Arrange-Act-Assert)
|
|
546
|
+
|
|
547
|
+
```java
|
|
548
|
+
@Test
|
|
549
|
+
void 商品の在庫が減少する() {
|
|
550
|
+
// Arrange(準備)
|
|
551
|
+
Product product = new Product("商品A", 10);
|
|
552
|
+
int orderQuantity = 3;
|
|
553
|
+
|
|
554
|
+
// Act(実行)
|
|
555
|
+
product.reduceStock(orderQuantity);
|
|
556
|
+
|
|
557
|
+
// Assert(検証)
|
|
558
|
+
assertThat(product.getStock()).isEqualTo(7);
|
|
559
|
+
}
|
|
560
|
+
```
|
|
561
|
+
|
|
562
|
+
#### 2. テストの命名規則
|
|
563
|
+
|
|
564
|
+
```java
|
|
565
|
+
// パターン1: 日本語での説明的な名前
|
|
566
|
+
@Test
|
|
567
|
+
void 在庫が不足している場合は注文できない() { }
|
|
568
|
+
|
|
569
|
+
// パターン2: Given-When-Then形式
|
|
570
|
+
@Test
|
|
571
|
+
void given在庫10個_when15個注文_then在庫不足例外() { }
|
|
572
|
+
|
|
573
|
+
// パターン3: メソッド名_条件_期待結果
|
|
574
|
+
@Test
|
|
575
|
+
void reduceStock_在庫不足_IllegalStateException() { }
|
|
576
|
+
```
|
|
577
|
+
|
|
578
|
+
#### 3. テストデータの準備
|
|
579
|
+
|
|
580
|
+
```java
|
|
581
|
+
// テストフィクスチャの使用
|
|
582
|
+
public class UserTestFixture {
|
|
583
|
+
public static User createDefaultUser() {
|
|
584
|
+
return new User(
|
|
585
|
+
"test@example.com",
|
|
586
|
+
"password123",
|
|
587
|
+
"テストユーザー"
|
|
588
|
+
);
|
|
589
|
+
}
|
|
590
|
+
|
|
591
|
+
public static User createUserWithEmail(String email) {
|
|
592
|
+
return new User(
|
|
593
|
+
email,
|
|
594
|
+
"password123",
|
|
595
|
+
"テストユーザー"
|
|
596
|
+
);
|
|
597
|
+
}
|
|
598
|
+
}
|
|
599
|
+
```
|
|
600
|
+
|
|
601
|
+
## リファクタリングパターン
|
|
602
|
+
|
|
603
|
+
### よく使うリファクタリング手法
|
|
604
|
+
|
|
605
|
+
| パターン | 適用場面 | 例 |
|
|
606
|
+
|----------|----------|-----|
|
|
607
|
+
| メソッド抽出 | 長いメソッドの分割 | 検証ロジックを別メソッドへ |
|
|
608
|
+
| 変数抽出 | 複雑な式の簡略化 | 計算結果を一時変数へ |
|
|
609
|
+
| クラス抽出 | 責務の分離 | 値オブジェクトの抽出 |
|
|
610
|
+
| メソッド移動 | 適切なクラスへの配置 | ユーティリティメソッドの移動 |
|
|
611
|
+
| 条件記述の分解 | 複雑な条件式の整理 | if文の条件をメソッド化 |
|
|
612
|
+
| ループの分割 | 単一責任の原則適用 | 異なる処理を別ループへ |
|
|
613
|
+
|
|
614
|
+
### リファクタリング実施のタイミング
|
|
615
|
+
|
|
616
|
+
1. **Rule of Three(3回ルール)**
|
|
617
|
+
- 1回目: そのまま実装
|
|
618
|
+
- 2回目: 重複に気づくが我慢
|
|
619
|
+
- 3回目: リファクタリング実施
|
|
620
|
+
|
|
621
|
+
2. **コードの臭い(Code Smells)を検知したとき**
|
|
622
|
+
- 長すぎるメソッド(20行以上)
|
|
623
|
+
- 大きすぎるクラス(200行以上)
|
|
624
|
+
- 長すぎるパラメータリスト(4個以上)
|
|
625
|
+
- データの群れ(同じ引数の組み合わせ)
|
|
626
|
+
- スイッチ文の重複
|
|
627
|
+
|
|
628
|
+
## 継続的な改善
|
|
629
|
+
|
|
630
|
+
### ふりかえりでの確認項目
|
|
631
|
+
|
|
632
|
+
```markdown
|
|
633
|
+
## イテレーションふりかえりテンプレート
|
|
634
|
+
|
|
635
|
+
### Keep(継続すること)
|
|
636
|
+
- [ ] TDDサイクルの実践
|
|
637
|
+
- [ ] コードレビューの実施
|
|
638
|
+
- [ ] 品質基準の維持
|
|
639
|
+
|
|
640
|
+
### Problem(問題点)
|
|
641
|
+
- [ ] テスト作成に時間がかかった箇所
|
|
642
|
+
- [ ] リファクタリングが不十分な箇所
|
|
643
|
+
- [ ] 技術的負債の発生箇所
|
|
644
|
+
|
|
645
|
+
### Try(次に試すこと)
|
|
646
|
+
- [ ] 新しいテスト手法の導入
|
|
647
|
+
- [ ] リファクタリングの自動化
|
|
648
|
+
- [ ] 品質メトリクスの改善
|
|
649
|
+
|
|
650
|
+
### 数値指標
|
|
651
|
+
- テストカバレッジ: ___%
|
|
652
|
+
- ビルド成功率: ___%
|
|
653
|
+
- バグ発生率: ___件/イテレーション
|
|
654
|
+
- 平均サイクルタイム: ___時間
|
|
655
|
+
```
|
|
656
|
+
|
|
657
|
+
### 技術的負債の管理
|
|
658
|
+
|
|
659
|
+
```plantuml
|
|
660
|
+
@startuml
|
|
661
|
+
title 技術的負債の対処フロー
|
|
662
|
+
|
|
663
|
+
start
|
|
664
|
+
|
|
665
|
+
:技術的負債の識別;
|
|
666
|
+
note right
|
|
667
|
+
- コードレビューで発見
|
|
668
|
+
- 静的解析ツールの警告
|
|
669
|
+
- パフォーマンス問題
|
|
670
|
+
end note
|
|
671
|
+
|
|
672
|
+
if (緊急度は?) then (高)
|
|
673
|
+
:即座に対処;
|
|
674
|
+
#red:ホットフィックス;
|
|
675
|
+
elseif (影響範囲は?) then (大)
|
|
676
|
+
:次イテレーションで対処;
|
|
677
|
+
#yellow:計画的リファクタリング;
|
|
678
|
+
else (小)
|
|
679
|
+
:バックログに追加;
|
|
680
|
+
#lightgreen:継続的改善;
|
|
681
|
+
endif
|
|
682
|
+
|
|
683
|
+
:対処結果の記録;
|
|
684
|
+
note right
|
|
685
|
+
- 対処内容
|
|
686
|
+
- 所要時間
|
|
687
|
+
- 学習事項
|
|
688
|
+
end note
|
|
689
|
+
|
|
690
|
+
stop
|
|
691
|
+
|
|
692
|
+
@enduml
|
|
693
|
+
```
|
|
694
|
+
|
|
695
|
+
## まとめ
|
|
696
|
+
|
|
697
|
+
コーディングとテストは、よいソフトウェアを作るための最も基本的で重要な活動です。TDDを中心としたこれらの規律を守ることで:
|
|
698
|
+
|
|
699
|
+
1. **品質の作り込み** - バグの早期発見と修正
|
|
700
|
+
2. **設計の改善** - 継続的なリファクタリング
|
|
701
|
+
3. **変更容易性** - テストによる安全網
|
|
702
|
+
4. **ドキュメント性** - テストが仕様書として機能
|
|
703
|
+
|
|
704
|
+
これらの実践により、「変更を楽に安全にできて役に立つソフトウェア」の実現を目指します。
|
package/lib/assets/docs/reference//351/226/213/347/231/272/343/202/254/343/202/244/343/203/211.md
CHANGED
|
@@ -191,9 +191,9 @@ state イテレーション {
|
|
|
191
191
|
@startuml
|
|
192
192
|
|
|
193
193
|
[*] --> イテレーション計画
|
|
194
|
-
イテレーション計画 -->
|
|
195
|
-
|
|
196
|
-
|
|
194
|
+
イテレーション計画 --> ユースケース作成
|
|
195
|
+
ユースケース作成 --> ユーザーストーリー作成
|
|
196
|
+
ユーザーストーリー作成 --> コーディングとテスト
|
|
197
197
|
アーキテクチャ設計 --> コーディングとテスト
|
|
198
198
|
コーディングとテスト --> アーキテクチャ設計
|
|
199
199
|
データモデル設計 --> コーディングとテスト
|
|
@@ -202,7 +202,7 @@ state イテレーション {
|
|
|
202
202
|
コーディングとテスト --> ドメインモデル設計
|
|
203
203
|
コーディングとテスト --> ユーザーインターフェース設計
|
|
204
204
|
ユーザーインターフェース設計 --> コーディングとテスト
|
|
205
|
-
コーディングとテスト -->
|
|
205
|
+
コーディングとテスト --> ユーザーストーリー作成
|
|
206
206
|
コーディングとテスト --> イテレーションレビュー
|
|
207
207
|
イテレーションレビュー --> イテレーション計画
|
|
208
208
|
イテレーションレビュー --> [*]
|
|
@@ -210,173 +210,7 @@ state イテレーション {
|
|
|
210
210
|
@enduml
|
|
211
211
|
```
|
|
212
212
|
|
|
213
|
-
|
|
214
|
-
|
|
215
|
-
1. インサイドアウトアプローチ
|
|
216
|
-
- データモデルから実装を開始
|
|
217
|
-
- ドメイン駆動設計に適合
|
|
218
|
-
- テストファーストな開発
|
|
219
|
-
|
|
220
|
-
2. アウトサイドインアプローチ
|
|
221
|
-
- UIから実装を開始
|
|
222
|
-
- プロトタイプ駆動開発に適合
|
|
223
|
-
- モックを活用した開発
|
|
224
|
-
|
|
225
|
-
|
|
226
|
-
```plantuml
|
|
227
|
-
@startuml
|
|
228
|
-
start
|
|
229
|
-
:ユーザーストーリー;
|
|
230
|
-
if (CRUD実装済み?) then (はい)
|
|
231
|
-
:ドメインモデル;
|
|
232
|
-
:アウトサイドイン;
|
|
233
|
-
else (いいえ)
|
|
234
|
-
:貧血ドメインモデル;
|
|
235
|
-
:インサイドサイドアウト;
|
|
236
|
-
endif
|
|
237
|
-
if (API実装済み?) then (はい)
|
|
238
|
-
:インサイドサイドアウト;
|
|
239
|
-
else (いいえ)
|
|
240
|
-
:アウトサイドイン;
|
|
241
|
-
endif
|
|
242
|
-
stop
|
|
243
|
-
@enduml
|
|
244
|
-
```
|
|
245
|
-
#### インサイドアウト
|
|
246
|
-
|
|
247
|
-
```plantuml
|
|
248
|
-
@startuml
|
|
249
|
-
start
|
|
250
|
-
:データベース;
|
|
251
|
-
:インフラストラクチャ層;
|
|
252
|
-
:ドメイン層;
|
|
253
|
-
:サービス層;
|
|
254
|
-
:プレゼンテーション層;
|
|
255
|
-
stop
|
|
256
|
-
@enduml
|
|
257
|
-
```
|
|
258
|
-
|
|
259
|
-
```plantuml
|
|
260
|
-
@startuml
|
|
261
|
-
[*] --> コーディングとテスト
|
|
262
|
-
コーディングとテスト --> TODO : TODOリストを作成
|
|
263
|
-
TODO --> Red : 最小限の実装
|
|
264
|
-
Red --> Green : テストを書く
|
|
265
|
-
Green --> Refactor : リファクタリング
|
|
266
|
-
Refactor --> Red : 次の実装
|
|
267
|
-
Red : 動作の確認
|
|
268
|
-
Green : テストが成功
|
|
269
|
-
Refactor : コードの重複を除去してリファクタリング
|
|
270
|
-
Refactor --> TODO : リファクタリングが完了したらTODOリストに戻る
|
|
271
|
-
TODO --> コーディングとテスト : TODOリストが空になるまで繰り返す
|
|
272
|
-
コーディングとテスト --> イテレーションレビュー
|
|
273
|
-
@enduml
|
|
274
|
-
```
|
|
275
|
-
|
|
276
|
-
#### アウトサイドイン
|
|
277
|
-
|
|
278
|
-
```plantuml
|
|
279
|
-
@startuml
|
|
280
|
-
start
|
|
281
|
-
:プレゼンテーション層;
|
|
282
|
-
:サービス層;
|
|
283
|
-
:ドメイン層;
|
|
284
|
-
:インフラストラクチャ層;
|
|
285
|
-
:データベース;
|
|
286
|
-
stop
|
|
287
|
-
@enduml
|
|
288
|
-
```
|
|
289
|
-
|
|
290
|
-
```plantuml
|
|
291
|
-
@startuml
|
|
292
|
-
[*] --> コーディングとテスト
|
|
293
|
-
コーディングとテスト --> TODO : TODOリストを作成
|
|
294
|
-
TODO --> Red : テストを書く
|
|
295
|
-
Red --> Green : 最小限の実装
|
|
296
|
-
Green --> Refactor : リファクタリング
|
|
297
|
-
Refactor --> Red : 次のテストを書く
|
|
298
|
-
Red : テストに失敗
|
|
299
|
-
Green : テストに通る最小限の実装
|
|
300
|
-
Refactor : コードの重複を除去してリファクタリング
|
|
301
|
-
Refactor --> TODO : リファクタリングが完了したらTODOリストに戻る
|
|
302
|
-
TODO --> コーディングとテスト : TODOリストが空になるまで繰り返す
|
|
303
|
-
コーディングとテスト --> イテレーションレビュー
|
|
304
|
-
@enduml
|
|
305
|
-
```
|
|
306
|
-
|
|
307
|
-
### コーディングとテスト
|
|
308
|
-
|
|
309
|
-
```plantuml
|
|
310
|
-
@startuml "イテレーション開発プロセス"
|
|
311
|
-
|
|
312
|
-
start
|
|
313
|
-
|
|
314
|
-
partition "イテレーション開始" {
|
|
315
|
-
}
|
|
316
|
-
|
|
317
|
-
repeat :TODO確認;
|
|
318
|
-
partition "TDD実装サイクル" {
|
|
319
|
-
repeat
|
|
320
|
-
:TODO選択;
|
|
321
|
-
|
|
322
|
-
repeat
|
|
323
|
-
:失敗テスト作成 (Red);
|
|
324
|
-
:最小実装 (Green);
|
|
325
|
-
:リファクタリング (Refactor);
|
|
326
|
-
:品質チェック;
|
|
327
|
-
if (品質OK?) then (yes)
|
|
328
|
-
:コミット;
|
|
329
|
-
else (no)
|
|
330
|
-
:修正;
|
|
331
|
-
endif
|
|
332
|
-
repeat while (TODO完了?)
|
|
333
|
-
partition "コードレビュー" {
|
|
334
|
-
}
|
|
335
|
-
repeat while (全TODO完了?)
|
|
336
|
-
}
|
|
337
|
-
|
|
338
|
-
if (イテレーション完了?) then (yes)
|
|
339
|
-
partition "受け入れ" {
|
|
340
|
-
partition "ユーザーレビュー" {
|
|
341
|
-
}
|
|
342
|
-
if (受け入れOK?) then (yes)
|
|
343
|
-
partition "ふりかえり" {
|
|
344
|
-
}
|
|
345
|
-
else (no)
|
|
346
|
-
partition "修正対応" {
|
|
347
|
-
}
|
|
348
|
-
endif
|
|
349
|
-
}
|
|
350
|
-
else (no)
|
|
351
|
-
partition "設計リファクタリング" {
|
|
352
|
-
partition "アーキテクチャリファクタリング" {
|
|
353
|
-
}
|
|
354
|
-
partition "データモデルリファクタリング" {
|
|
355
|
-
}
|
|
356
|
-
partition "ドメインモデルリファクタリング" {
|
|
357
|
-
}
|
|
358
|
-
partition "UIリファクタリング" {
|
|
359
|
-
}
|
|
360
|
-
}
|
|
361
|
-
endif
|
|
362
|
-
repeat while (次のTODO?)
|
|
363
|
-
|
|
364
|
-
stop
|
|
365
|
-
|
|
366
|
-
@enduml
|
|
367
|
-
```
|
|
368
|
-
- 必ずイテレーション単位で開発を行う
|
|
369
|
-
- 勝手に次のイテレーションに進まない
|
|
370
|
-
- コミットは必ずTODO単位で実施する
|
|
371
|
-
- コミットの前に必ず品質確認を実施する
|
|
372
|
-
- コミットメッセージはAngularのコミットメッセージの書き方を参考にする
|
|
373
|
-
- feat: 新機能の追加
|
|
374
|
-
- fix: バグ修正
|
|
375
|
-
- docs: ドキュメントの変更
|
|
376
|
-
- style: フォーマットやセミコロンの追加など、コードの動作に影響しない変更
|
|
377
|
-
- refactor: リファクタリング(バグ修正や機能追加ではない)
|
|
378
|
-
- test: テストコードの追加や修正
|
|
379
|
-
- chore: ビルドプロセスや補助ツールの変更
|
|
213
|
+
開発の詳細は [コーディングとテストガイド](コーディングとテストガイド.md) を参照
|
|
380
214
|
|
|
381
215
|
## 運用
|
|
382
216
|
|
|
@@ -4,6 +4,9 @@ import fs from 'fs';
|
|
|
4
4
|
import path from 'path';
|
|
5
5
|
import { execSync } from 'child_process';
|
|
6
6
|
|
|
7
|
+
// Increase buffer to safely handle large diffs/logs
|
|
8
|
+
const MAX_BUFFER = 256 * 1024 * 1024; // 256 MB
|
|
9
|
+
|
|
7
10
|
// Function to register the journal:generate task
|
|
8
11
|
export default function(gulp) {
|
|
9
12
|
// Helper function to generate journal for a specific date
|
|
@@ -16,7 +19,7 @@ export default function(gulp) {
|
|
|
16
19
|
const journalFile = path.join(journalDir, `${formattedDate}.md`);
|
|
17
20
|
|
|
18
21
|
// Get commits for this date
|
|
19
|
-
const commits = execSync(`git log --since="${dateStr} 00:00:00" --until="${dateStr} 23:59:59" --format="%h %s%n%b"`, { maxBuffer:
|
|
22
|
+
const commits = execSync(`git log --since="${dateStr} 00:00:00" --until="${dateStr} 23:59:59" --format="%h %s%n%b"`, { maxBuffer: MAX_BUFFER }).toString();
|
|
20
23
|
|
|
21
24
|
// Skip if no commits
|
|
22
25
|
if (!commits.trim()) {
|
|
@@ -25,23 +28,30 @@ export default function(gulp) {
|
|
|
25
28
|
}
|
|
26
29
|
|
|
27
30
|
// Get detailed changes for each commit on this date
|
|
28
|
-
const commitHashesOutput = execSync(`git log --since="${dateStr} 00:00:00" --until="${dateStr} 23:59:59" --format="%h"`, { maxBuffer:
|
|
31
|
+
const commitHashesOutput = execSync(`git log --since="${dateStr} 00:00:00" --until="${dateStr} 23:59:59" --format="%h"`, { maxBuffer: MAX_BUFFER }).toString();
|
|
29
32
|
const commitHashes = commitHashesOutput.split('\n').map(line => line.trim()).filter(Boolean);
|
|
30
33
|
|
|
31
34
|
const detailedCommits = [];
|
|
32
35
|
|
|
33
36
|
commitHashes.forEach(hash => {
|
|
34
37
|
// Get commit details
|
|
35
|
-
const commitMessage = execSync(`git show -s --format="%s%n%b" ${hash}`, { maxBuffer:
|
|
38
|
+
const commitMessage = execSync(`git show -s --format="%s%n%b" ${hash}`, { maxBuffer: MAX_BUFFER }).toString().trim();
|
|
36
39
|
|
|
37
40
|
// Get files changed
|
|
38
|
-
const filesChangedOutput = execSync(`git show --name-status ${hash}`, { maxBuffer:
|
|
41
|
+
const filesChangedOutput = execSync(`git show --name-status ${hash}`, { maxBuffer: MAX_BUFFER }).toString();
|
|
39
42
|
const filesChanged = filesChangedOutput.split('\n')
|
|
40
43
|
.map(line => line.trim())
|
|
41
44
|
.filter(line => /^[AMDRT]\s/.test(line));
|
|
42
45
|
|
|
43
|
-
// Get code changes (diff)
|
|
44
|
-
|
|
46
|
+
// Get code changes (diff) with robust handling for large diffs
|
|
47
|
+
let diff = '';
|
|
48
|
+
try {
|
|
49
|
+
diff = execSync(`git show ${hash} --color=never`, { maxBuffer: MAX_BUFFER }).toString();
|
|
50
|
+
} catch (e) {
|
|
51
|
+
// Fallback to a summary if diff is too large or any error occurs
|
|
52
|
+
const summary = execSync(`git show --stat --oneline ${hash} --color=never`, { maxBuffer: MAX_BUFFER }).toString();
|
|
53
|
+
diff = `[Diff too large or failed to load. Showing summary instead.]\n\n${summary}`;
|
|
54
|
+
}
|
|
45
55
|
|
|
46
56
|
detailedCommits.push({
|
|
47
57
|
hash,
|
|
@@ -144,7 +154,7 @@ export default function(gulp) {
|
|
|
144
154
|
}
|
|
145
155
|
|
|
146
156
|
// Get all commit dates
|
|
147
|
-
const datesOutput = execSync('git log --format=%ad --date=short').toString();
|
|
157
|
+
const datesOutput = execSync('git log --format=%ad --date=short', { maxBuffer: MAX_BUFFER }).toString();
|
|
148
158
|
const dates = [...new Set(datesOutput.split('\n').map(line => line.trim()).filter(Boolean))];
|
|
149
159
|
|
|
150
160
|
dates.forEach(dateStr => {
|