/**
* A typical test with *mockster* might look like this.
*/
public function testQuickStart()
{
/**
* <a href="javascript:" onclick="$('#quickStartDefinitions').toggle();">
* Show class definitions for this example
* </a><div id="quickStartDefinitions" style="display: none;">
*/
eval('
class FooClass {
/** @var MyDatabase <- */
protected $database;
public function setUserName($id, $name) {
$user = $this->database->readUser($id);
$user->setName($name);
$this->database->update($user);
}
}
class MyDatabase {
public function readUser($id) {
// [...]
}
public function update($object) {
// [...]
}
}
class MyUser {
public function setName($name) {
// [...]
}
}');
// </div>
/*
* First create `Mockster` instances of the classes we're gonna mock.
*/
$foo = Mockster::of('FooClass');
$user = Mockster::of('MyUser');
/*
* Then configure the behaviour of the dependencies of our *Unit Under Test*.
*
* The `Database` should return a mock of the `User` class when called with the argument `1`.
*/
$foo->database->readUser(1)->will()->return_(Mockster::mock($user));
/*
* Now execute the code to be tested.
*
* The `uut()` method will create an instance of the `FooClass` with
* all it's dependencies replaced by mocks and none of it's methods stubbed.
*/
Mockster::uut($foo)->setUserName(1, 'Bart');
/*
* Last, assert the expected behaviour.
*
* There should have been a call to `User::setName()` with the argument
* `'Bart'` and a call on `Database::update()`.
*/
$this->assert($user->setName('Bart')->has()->beenCalled());
$this->assert($foo->database->update(Argument::any())->has()->beenCalled());
}
private function whenICreateAnObjectActionFrom($className)
{
$this->action = Mockster::of(ObjectAction::class);
$parser = Mockster::of(CommentParser::class);
Mockster::stub($parser->parse(Argument::any()))->will()->forwardTo(function ($comment) {
return $comment . ' (parsed)';
});
$this->uut = Mockster::uut($this->action, [$className, new TypeFactory(), Mockster::mock($parser)]);
}
