Mockery1.0 複雑な引数マッチング(on)

複雑な引数マッチング(on)

メソッド呼び出しで期待される引数のマッチングを複雑にする必要がある場合は、\Mockery::on()マッチャーを使うととても簡単です。引数としてクロージャを受け付け、そのクロージャへメソッド呼び出し時の引数が渡されます。クロージャからtrueを返すと、Mockeryは引数がエクスペクションに一致したと取り扱い、「失敗した」値の場合は合致しなかったと考えます。

\Mockery::on()マッチャーは多くのシナリオで使用できます。複数のキー／値に基づいた配列の引数や、複雑な文字列のマッチングなどです。

たとえば、次のようなコードです。これは、さほど複雑ではありませんが、データベース上のpublishedフラッグを1にセットすることで、あるポストを公開済みにし、published_atへ現日時をセットします。

<?php
namespace Service;
class Post
{
    public function __construct($model)
    {
        $this->model = $model;
    }

    public function publishPost($id)
    {
        $saveData = [
            'post_id' => $id,
            'published' => 1,
            'published_at' => gmdate('Y-m-d H:i:s'),
        ];
        $this->model->save($saveData);
    }
}

テストでモデルをモックし、save()メソッドにエクスペクションを指定してみましょう。

<?php
$postId = 42;

$modelMock = \Mockery::mock('Model');
$modelMock->shouldReceive('save')
    ->once()
    ->with(\Mockery::on(function ($argument) use ($postId) {
        $postIdIsSet = isset($argument['post_id']) && $argument['post_id'] === $postId;
        $publishedFlagIsSet = isset($argument['published']) && $argument['published'] === 1;
        $publishedAtIsSet = isset($argument['published_at']);

        return $postIdIsSet && $publishedFlagIsSet && $publishedAtIsSet;
    }));

$service = new \Service\Post($modelMock);
$service->publishPost($postId);

\Mockery::close();

この例で重要なのは、\Mockery::on()マッチャーへ渡したクロージャの内容です。 $argumentは実際には、save()メソッドが呼び出されたときの引数である、$saveDataです。この引数について、いくつかのことをチェックしています。

• ポストIDがセットされており、publishPost()メソッドへ渡したポストIDと一致していること
• publishedがセットされており、1であること
• published_atキーが存在していること

どれかの要件を満たさない場合、クロージャはfalseを返し、メソッド呼び出しのエクスペクションは一致せず、MockeryはNoMatchingExpectationExceptionを投げます。

Note: このクックブックのエントリーは、Robertによるブログ記事である、"Complex argument matching in Mockery"を元に引用したものです。