For the complete documentation index, see llms.txt. This page is also available as Markdown.

時間

時間

この章のすべてのコードはここにあります

プロダクトオーナーは、テキサス・ホールデム・ポーカーをプレイする人たちのグループを手助けできるよう、コマンドラインアプリケーションの機能を拡張してほしいと考えています。

ポーカーについて必要最低限の知識

ポーカーについて多くのことを知る必要はありません。一定の時間間隔で、すべてのプレーヤーに着実に増加する「ブラインド(強制bet)」値を通知する必要があるということだけです。

私たちのアプリケーションは、ブラインドをいつ上げるべきか、そしていくらにすべきかを把握するのに役立ちます。

  • 開始すると、何人のプレーヤーがプレイしているかを尋ねます。これは、「ブラインド」ベットが上がるまでの時間を決定します。

    • 基本時間は5分です。

    • プレーヤー1人につき、1分が追加されます。

    • 例:プレーヤーが6人の場合、ブラインドの時間は11分になります。

  • ブラインドの時間が過ぎたら、ゲームはプレーヤーに新しいブラインドベットの額を知らせる必要があります。

  • ブラインドは100チップから始まり、その後200、400、600、1000、2000となり、その後はゲームが終了するまで2倍ずつ増えていきます(以前実装した「Ruth wins」でゲームを終了する機能は引き続き動作する必要があります)。

これまでのコードのおさらい

前の章では、{name} winsというコマンドを受け付けるコマンドラインアプリケーションを作り始めました。現在のCLIのコードは次のとおりですが、始める前に他のコードにも目を通しておいてください。

type CLI struct {
	playerStore PlayerStore
	in          *bufio.Scanner
}

func NewCLI(store PlayerStore, in io.Reader) *CLI {
	return &CLI{
		playerStore: store,
		in:          bufio.NewScanner(in),
	}
}

func (cli *CLI) PlayPoker() {
	userInput := cli.readLine()
	cli.playerStore.RecordWin(extractWinner(userInput))
}

func extractWinner(userInput string) string {
	return strings.Replace(userInput, " wins", "", 1)
}

func (cli *CLI) readLine() string {
	cli.in.Scan()
	return cli.in.Text()
}

time.AfterFunc

プレーヤーの数に応じた一定の時間間隔で、ブラインドベットの値を出力するようプログラムをスケジュールできるようにしたいと考えています。

作業の範囲を絞るため、今のところプレーヤーの数のことは忘れて5人のプレーヤーがいると仮定し、10分ごとにブラインドベットの新しい値が出力されること をテストします。

いつものように、標準ライブラリにはfunc AfterFunc(d Duration, f func()) *Timerが用意されています。

AfterFuncは継続時間が経過するのを待ってから、自身のゴルーチンでfを呼び出します。これは、Stopメソッドを使用して呼び出しをキャンセルするために使用できるTimerを返します。

time.Duration

Durationは、2つの時点間の経過時間をint64のナノ秒数として表します。

timeライブラリには、ナノ秒に掛け合わせるための定数がいくつか用意されているので、これから扱うようなシナリオでも読みやすく書けます。

PlayPokerを呼び出したときに、すべてのブラインドアラートをスケジュールします。

これをテストするのは少し難しいかもしれません。各時刻が正しいブラインド額でスケジュールされていることを確認する必要がありますが、time.AfterFuncのシグネチャを見ると、2番目の引数は実行される関数です。 Goでは関数を比較できないため、どの関数が渡されたかをテストすることはできません。そこで、実行する時刻と出力する額を受け取る、time.AfterFuncのラッパーのようなものを書いて、それをスパイできるようにする必要があります。

最初にテストを書く

スイートに新しいテストを追加する

SpyBlindAlerterを作成してCLIに注入し、PlayPokerを呼び出した後にアラートがスケジュールされていることを確認している点に気づくでしょう。

(まずは最も単純なシナリオから始めて、その後で繰り返し改良していくことを思い出してください。)

ここにSpyBlindAlerterの定義があります

テストを実行してみます

テストを実行するための最小限のコードを記述し、失敗したテスト出力を確認します

新しい引数を追加しましたが、コンパイラは不満を言っています。 厳密に言えば、最小限のコードはNewCLIが*SpyBlindAlerterを受け入れるようにすることですが、少しズルをして、依存関係をインターフェースとして定義してしまいましょう。

そして、それをコンストラクタに追加します。

他のテストはNewCLIにBlindAlerterが渡されていないので失敗します。

BlindAlerterをスパイすることは他のテストには関係ないので、テストファイルに次を追加します。

そして、コンパイルの問題を修正するために他のテストでそれを使ってください。 これを「ダミー」と名付けることで、テストの読者にはそれが重要ではないことが明らかになります。

ダミーオブジェクトは渡されますが、実際に使われることはありません。通常はパラメータリストを埋めるために使われるだけです

これでテストはコンパイルされ、新しいテストは失敗します。

成功させるのに十分なコードを書く

これをPlayPokerメソッドで参照できるようにするためにBlindAlerterをCLIのフィールドとして追加する必要があります。

テストを通過させるには、BlindAlerterを好きな引数で呼び出せば十分です。

次は、5人のプレーヤーの場合に期待するアラートがすべてスケジュールされているかを確認したいと思います。

最初にテストを書く

テーブルベースのテストはここではうまく機能し、要件が何であるかを明確に示しています。テーブルを順に処理し、SpyBlindAlerterをチェックして、アラートが正しい値でスケジュールされているかどうかを確認します。

テストを実行してみます

次のような失敗がたくさん表示されるはずです。

成功させるのに十分なコードを書く

それは、私たちがすでに持っていたものよりもそれほど複雑ではありません。 私たちは今、blindsの配列を反復処理し、増加するblindTimeでスケジューラを呼び出しています

リファクタリング♪

PlayPokerが少し読みやすくなるように、アラートのスケジュール処理をメソッドにカプセル化できます。

最後に、テストは少し不格好に見えます。同じもの(ScheduledAlert)を表す2つの匿名構造体があります。それを新しい型にリファクタリングして、比較用のヘルパーをいくつか作りましょう。

型にString()メソッドを追加したので、テストが失敗した場合にうまく表示されます。

新しい型を使用するようにテストを更新します。

assertScheduledAlertは自分で実装してみてください。

ここまでかなりの時間をかけてテストを書いてきましたが、アプリケーションに組み込まずにいたのは少し行儀が悪かったですね。これ以上の要件に取り掛かる前に、その問題に取り組みましょう。

アプリを実行しようとしても、NewCLIへの引数が足りないというエラーでコンパイルできません。

アプリケーションで使用できるBlindAlerterの実装を作成してみましょう。

blind_alerter.goを作成し、BlindAlerterインターフェースを移動して、以下の新しいものを追加します

structだけでなく、どんな 型 でもインターフェースを実装できることを思い出してください。関数が1つだけ定義されたインターフェースを公開するライブラリを作る場合、MyInterfaceFunc型もあわせて公開するのはよくあるイディオムです。

この型は、インターフェースを実装するfuncになります。こうすることで、インターフェースの利用者は関数だけでインターフェースを実装できます。 空のstruct型を作成する必要はありません。

次に、関数と同じシグネチャを持つ関数StdOutAlerterを作成し、time.AfterFuncを使用して、それをos.Stdoutに出力するようにスケジュールします。

この動作を確認するには、NewCLIを作成するmainを更新します。

実行する前に、CLIのblindTimeの増分を10分ではなく10秒に変更すると、実際の動作を確認できます。

期待どおり、10秒ごとにブラインドの値が出力されるはずです。また、CLIにShaun winsと入力すれば、これまでどおり期待したとおりにプログラムが停止することにも注目してください。

ゲームは常に5人でプレイされるとは限らないため、ゲームを開始する前に、プレーヤーの人数を入力するようユーザーに促す必要があります。

最初にテストを書く

プレーヤーの人数の入力を促していることを確認するために、StdOutに書き込まれた内容を記録します。 これはもう何度かやってきました。os.Stdoutはio.Writerなので、テストで依存性注入を使ってbytes.Bufferを渡せば、コードが何を書き込むかを確認できます。

このテストでは、他の協調オブジェクトについてはまだ気にしないので、テストファイルにダミーをいくつか用意しました。

CLIの依存関係が4つになったことには少し警戒すべきでしょう。 責任を持ちすぎ始めているように感じられます。とりあえず今はこのままにして、この新しい機能を追加する中でリファクタリングの方向性が見えてくるか様子を見ましょう。

これが新しいテストです。

mainでos.Stdoutになるものを渡し、何が書き込まれるかを確認します。

テストを実行してみます

テストを実行するための最小限のコードを記述し、失敗したテスト出力を確認します

新しい依存関係があるため、NewCLIを更新する必要があります

その他のテストは、NewCLIに渡されるio.Writerがないため、コンパイルに失敗します。

他のテスト用にdummyStdOutを追加します。

新しいテストは次のように失敗するはずです。

成功させるのに十分なコードを書く

CLIに新しい依存関係を追加して、PlayPokerで参照できるようにする必要があります。

最後に、ゲームの開始時にプロンプトを書き込むことができます。

リファクタリング♪

プロンプトの文字列が重複しているので、定数に抽出しましょう。

テストコードとCLIの両方でこれを使用してください。

次に、数値を送り込んで、それを取り出す必要があります。 目的の効果があったかどうかを確認する唯一の方法は、スケジュールされたブラインドアラートを確認することです。

最初にテストを書く

うわっ!変更がたくさんありますね。

  • StdInのダミーを削除し、代わりに、7を入力するユーザーを表すモックバージョンを送信します。

  • また、ブラインドアラーターのダミーも削除して、プレーヤー数がスケジュールに影響を与えていることを確認できるようにしました

  • スケジュールされているアラートをテストします

テストを実行してみます

テストはコンパイルされ、失敗するはずですが、5人のプレーヤーに基づいてゲームをハードコーディングしているため、スケジュールされた時間が間違っていると報告されます。

成功させるのに十分なコードを書く

これを動かすためなら、どんな罪を犯しても構わないことを思い出してください。 動くソフトウェアができたら、これから作る散らかったコードのリファクタリングに取り掛かればよいのです!

  • numberOfPlayersInputを文字列に読み込みます

  • ユーザーから入力を取得するために cli.readLine()を使用し、次にエラーシナリオを無視して、Atoiを呼び出して整数に変換します。後でそのシナリオのテストを作成する必要があります。

  • そして、scheduleBlindAlertsがプレーヤーの人数を受け取るように変更します。次に、ブラインド額を順に処理するときにblindTimeに加算するblindIncrementの時間を計算します

新しいテストは成功するようになりましたが、ゲームの開始時にユーザーが数値を入力しないとシステムが動作しなくなったため、他の多くのテストが失敗しています。 ユーザー入力を変更して、数値とそれに続く改行が追加されるようにテストを修正する必要があります。 (これは、現在のアプローチのさらなる欠陥を浮き彫りにしています)。

リファクタリング♪

なんだかひどい感じですよね?テストの声に耳を傾けましょう。

  • いくつかのアラートをスケジュールしていることをテストするために、4つの異なる依存関係を設定しました。システム内のある もの に依存関係がたくさんある場合、それはそのものが多くのことをやりすぎていることを意味します。視覚的には、テストが雑然としていることがわかります。

  • 私には、ユーザー入力の読み取りと、実行したいビジネスロジックとの間をより明確に抽象化する必要があるように感じます

  • より良いテストは、このユーザー入力が与えられたとき、新しい型Gameを正しいプレーヤー数で呼び出すかどうか です。

  • 次に、スケジューリングのテストを新しいGameのテストに抽出します。

まずGameに向けてリファクタリングを進めても、テストは引き続き成功するはずです。望む構造の変更が済んだら、新しい関心の分離を反映するようにテストをリファクタリングする方法を考えられます

リファクタリングで変更を加えるときは、変更をできるだけ小さくして、テストを再実行し続けるようにしてください。

まず自分で試してみてください。Gameが提供するものとCLIが行うべきことの境界について考えてみましょう。

今のところは、NewCLIの外部インターフェースを変更しないでください。 テストコードとクライアントコードを同時に変更すると、一度に扱うことが多すぎて、何かを壊してしまいかねないからです。

これは私が思いついたものです。

「ドメイン」の観点から

  • 何人がプレイするかを指定してGameをStartしたい

  • 勝者を宣言してGameをFinishしたい

新しいGame型がこれをカプセル化します。

この変更で、BlindAlerterとPlayerStoreをGameに渡すようにしました。 今後はGameがアラートと結果の保存を担当するからです。

これでCLIが担うのは次のことだけになりました。

  • 既存の依存関係を使用してGameを構築します(これは次にリファクタリングします)

  • ユーザー入力をGameのメソッド呼び出しとして解釈する

テストが長時間失敗したままになるような「大きな」リファクタリングは避けたいところです。 そうした状態はミスの可能性を高めるからです。 (大規模なチームや分散したチームで作業している場合、これは特に重要です)

まず最初に、Gameをリファクタリングして、CLIに注入します。 そのためのテストへの変更は最小限にとどめ、その後、テストをユーザー入力の解析とゲーム管理というテーマに分割する方法を考えます。

今必要なのは、NewCLIを変更することだけです。

これはすでに改善のように感じられます。 依存関係が減り、依存関係のリストが全体的な設計目標を反映しています。つまり、CLIは入出力に専念し、ゲーム固有のアクションはGameに委任するということです。

コンパイルしてみると問題があります。これらの問題は自分で修正できるはずです。 今すぐGameのモックを作成する必要はありません。すべてをコンパイルしてテストをグリーンにするために、本物の Gameを初期化するだけで構いません。

これを行うには、コンストラクタを作成する必要があります。

これは、修正されたテストの設定の1つの例です。

テストを修正して再びグリーンに戻すのに大した労力はかからないはずです(それが狙いです!)。 次の段階の前にmain.goも修正するようにしてください。

Gameを抽出したので、ゲーム固有のアサーションをCLIとは別のテストに移動する必要があります。

これは、CLIのテストを依存関係を減らしてコピーするだけの作業です。

ポーカーのゲームが始まったときに何が起きるかの背後にある意図が今やはるかに明確になりました。

ゲーム終了時のテストも忘れずに移動してください。

ゲームロジックのテストを移し終えたら、 CLIのテストを簡略化して、意図した責任がより明確に反映されるようにできます。

  • ユーザー入力を処理し、必要に応じてGameのメソッドを呼び出します

  • 出力を送信

  • 重要なのは、ゲームが実際にどう動くかについては何も知らないこと

これを行うには、CLIが具体的なGame型に依存せず、代わりにStart(numberOfPlayers)とFinish(winner)を持つインターフェースを受け取るようにする必要があります。そうすれば、その型のスパイを作成して、正しい呼び出しが行われたことを確認できます。

ここで、名前付けが時に厄介であることに気づきます。Gameの名前をTexasHoldemに変更します(これが現在プレイしているゲームの 種類 であるため)。新しいインターフェースをGameと呼ぶことにします。こうすることで、CLIは実際にプレイしているゲームや、Start・Finishしたときに何が起こるかを知らない、という考え方に忠実でいられます。

CLI内の*Gameへの参照をすべてGame(新しいインターフェース)に置き換えます。 いつものように、リファクタリングしている間はテストを再実行し続けて、すべてがグリーンであることを確認します。

TexasHoldemからCLIを分離したので、スパイを使用して、正しい引数で、期待どおりにStartとFinishが呼び出されることを確認できます。

Gameを実装するスパイを作成する

ゲーム固有のロジックをテストするすべてのCLIテストを、GameSpyの呼び出し方法のチェックに置き換えます。これは、テストにおけるCLIの責任を明確に反映します。

これは、修正されたテストの1つの例です。 残りを自分で試して、行き詰まった場合はソースコードを確認してください。

関心をきれいに分離できたので、CLIでのIOに関するエッジケースのチェックが簡単になるはずです。

プレーヤー数の入力を求められたときにユーザーが非数値を入力するシナリオに対処する必要があります。

その場合、コードはゲームを開始せず、ユーザーにわかりやすいエラーを出力して終了する必要があります。

最初にテストを書く

ゲームが開始しないことを確認することから始めます

GameSpyに、Startが呼び出された場合にのみ設定されるフィールドStartCalledを追加する必要があります

テストを実行してみます

成功させるのに十分なコードを書く

Atoiを呼び出している箇所で、エラーをチェックするだけです

次に、ユーザーに何を間違えたのかを知らせる必要があるので、stdoutに出力される内容をアサートします。

最初にテストを書く

stdoutに出力された内容のアサートは前にもやったので、今のところはそのコードをコピーできます

stdoutに書き込まれるものは すべて 保存しているので、poker.PlayerPromptも引き続き期待されます。 そのうえで、追加で何かが出力されていることを確認するだけです。 今のところ正確な文言にはあまりこだわらず、リファクタリングのときに対処します。

テストを実行してみます

成功させるのに十分なコードを書く

エラー処理コードを変更する

リファクタリング♪

次に、メッセージをPlayerPromptのような定数にリファクタリングします

より適切なメッセージを入れます

最後に、stdoutに送信された内容に関するテストがかなり冗長なので、整理するためのアサート関数を作成しましょう。

さまざまな数のメッセージをアサートする必要があるので、ここでは可変長引数の構文(...string)が便利です。

このヘルパーは、ユーザーに送信されるメッセージに対してアサートする両方のテストで使用します。

assertX関数を使えば改善できるテストがいくつかあるので、テストを読みやすく整理してリファクタリングの練習をしてみてください。

少し時間をとって、これまでに書いてきたテストの価値について考えてみてください。 必要以上のテストは不要だということを思い出してください。 いくつかのテストをリファクタリング/削除しても、すべてが動作するという確信を持ち続けられるでしょうか?

これが私が思いついたものです。

これでテストはCLIの主な機能を反映するようになりました。CLIは、何人がプレイするか、誰が勝ったかについてのユーザー入力を読み取ることができ、プレーヤー数に不正な値が入力された場合にも対処できます。 こうすることで、CLIが何をするのか、そして何をしないのかが読者にとって明確になります。

ユーザーがRuth winsの代わりにLloyd is a killerと入力したらどうなるでしょうか?

このシナリオのテストを書いて成功させ、この章を締めくくりましょう。

まとめ

プロジェクトの簡単な要約

ここまでの5つの章で、かなりの量のコードを少しずつTDDで書いてきました

  • コマンドラインアプリケーションとWebサーバーの2つのアプリケーションがあります。

  • これらのアプリケーションは両方とも、勝者を記録するためにPlayerStoreに依存しています

  • Webサーバーは、最も多くのゲームに勝っている人のリーグテーブルを表示することもできます

  • コマンドラインアプリは、現在のブラインドの値を追跡することで、プレーヤーがポーカーをプレイするのを手助けします。

time.Afterfunc

特定の時間が経過した後に関数呼び出しをスケジュールするための、とても便利な方法です。timeのドキュメントを読むことに時間を投資する価値は十分にあります。時間を節約できる便利な関数やメソッドがたくさん用意されています。

私のお気に入りをいくつか紹介します。

  • 期間が終了すると、time.After(duration)はchan Timeを返します。したがって、特定の時間の後に何かをしたい場合は、これが役立ちます。

  • time.NewTicker(duration)は、チャネルを返すという点で上記と同様の Tickerを返しますが、こちらは1回だけではなく、期間ごとに「ティック」します。これは、N durationごとにコードを実行する場合に非常に便利です。

関心の分離のさらなる良い例

一般的には、ユーザー入力と応答の処理の責任をドメインコードから分離することをお勧めします。 コマンドラインアプリケーションとWebサーバーで確認できます。

テストが乱雑になりました。アサーションが多すぎ(この入力をチェックし、これらのアラートをスケジュールし、など)、依存関係も多すぎました。 散らかっていることを視覚的に確認できました。 テストに耳を傾けることはとても重要です。

  • テストが乱雑に見える場合は、リファクタリングしてみてください。

  • これを行ってもまだ混乱している場合は、デザインの欠陥を指摘している可能性が高いです。

  • これはテストの真の強みの1つです。

テストも本番コードも少し雑然としていましたが、テストに支えられて自由にリファクタリングできました。

これらの状況に陥ったときは、常に小さなステップを踏んで、変更のたびにテストを再実行することを忘れないでください。

テストコード と 本番コードの両方を同時にリファクタリングするのは危険でした。 そのため、インターフェースを変更せずに、最初に本番コードをリファクタリングしました(現在の状態では、テストを大幅に改善することはできませんでした)。 こうすることで、変更している間もできる限りテストに頼ることができました。その後で、設計が改善されてからテストをリファクタリングしました。

リファクタリング後、依存関係のリストは設計目標を反映するようになりました。 これは、意図を文書化することが多いという点で、DIのもう1つの利点です。グローバル変数に依存すると、責任が非常に不明確になります。

インターフェースを実装する関数の例

1つのメソッドでインターフェースを定義するとき、ユーザーが関数だけでインターフェースを実装できるように、それを補完するためにMyInterfaceFunc型を定義することを検討することができます。

こうすることで、あなたのライブラリを利用する人は、関数だけであなたのインターフェースを実装することができます。彼らは 型変換 を使って関数を BlindAlerterFunc に変換し、それを BlindAlerter として使うことができます (BlindAlerterFunc は BlindAlerter を実装しているので)。

ここで重要なのは、Goでは構造体だけでなく、型 にもメソッドを追加できるということです。これは非常に強力な機能で、これを利用すればより便利な方法でインターフェースを実装することができます。

関数の型を定義するだけでなく、他の型の周りに型を定義して、その型にメソッドを追加することができることを考慮してください。

ここでは、非常にシンプルな「ブログ」を実装するHTTPハンドラーを作成しました。このハンドラーでは、URLパスをキーとして、マップに格納された投稿を表示します。

最終更新