phpstan-prophecy

Provides a prophecy/prophecy extension for phpstan/phpstan.

Installation

Run

composer require --dev jangregor/phpstan-prophecy

Configuration

Automatic

When using phpstan/extension-installer, no further setup is required.

Manual

When not using phpstan/extension-installer, extension.neon needs to be included in phpstan.neon:

 includes:
+	- vendor/jangregor/phpstan-prophecy/extension.neon

Usage

prophesize() and reveal()

<?phpusePHPUnit\Framework;
finalclass ExampleTest extendsFramework\TestCase
{
private$prophecy;
protectedfunctionsetUp()
{
$this->prophecy = $this->prophesize(SomeModel::class);
}
publicfunctiontestSomething(): void
{
$prophecy = $this->prophesize(SomeModel::class);
$testDouble = $prophecy->reveal();
// ...
}
publicfunctiontestSomethingElse(): void
{
$testDouble = $this->prophecy->reveal();
// ...
}
publicfunctiontestSomethingDifferent(): void
{
$testDouble = $this->createProphecy()->reveal();
// ...
}
privatefunctioncreateProphecy()
{
return$this->prophesize(SomeModel::class);
}
}

💡 With this extension enabled, phpstan/phpstan will understand that $testDouble is an instance of SomeModel.

prophesize(), willExtend(), and reveal()

<?phpusePHPUnit\Framework;
finalclass ExampleTest extendsFramework\TestCase
{
private$prophecy;
protectedfunctionsetUp()
{
$this->prophecy = $this->prophesize()->willExtend(SomeModel::class);
}
publicfunctiontestSomething(): void
{
$prophecy = $this->prophesize()->willExtend(SomeModel::class);
$testDouble = $prophecy->reveal();
// ...
}
publicfunctiontestSomethingElse(): void
{
$testDouble = $this->prophecy->reveal();
// ...
}
publicfunctiontestSomethingDifferent(): void
{
$testDouble = $this->createProphecy()->reveal();
// ...
}
privatefunctioncreateProphecy()
{
return$this->prophesize(SomeModel::class)->willExtend(SomeInterface::class);
}
}

💡 With this extension enabled, phpstan/phpstan will understand that $testDouble is an instance of SomeModel.

prophesize(), willImplement(), and reveal()

<?phpusePHPUnit\Framework;
finalclass ExampleTest extendsFramework\TestCase
{
private$prophecy;
protectedfunctionsetUp()
{
$this->prophecy = $this->prophesize(SomeModel::class)->willImplement(SomeInterface::class);
}
publicfunctiontestSomething(): void
{
$prophecy = $this->prophesize(SomeModel::class)->willImplement(SomeInterface::class);
$testDouble = $prophecy->reveal();
// ...
}
publicfunctiontestSomethingElse(): void
{
$testDouble = $this->prophecy->reveal();
// ...
}
publicfunctiontestSomethingDifferent(): void
{
$testDouble = $this->createProphecy()->reveal();
// ...
}
privatefunctioncreateProphecy()
{
return$this->prophesize(SomeModel::class)->willImplement(SomeInterface::class);
}
}

💡 With this extension enabled, phpstan/phpstan will understand that $testDouble is an instance of SomeModel that also implements SomeInterface.

Method Predictions

<?phpusePHPUnit\Framework;
finalclass ExampleTest extendsFramework\TestCase
{
publicfunctiontestSomething(): void
{
$prophecy = $this->prophesize(SomeModel::class);
$prophecy
->doubleTheNumber(Argument::is(2))
->willReturn(4);
$testDouble = $prophecy->reveal();
// ...
}
}

💡 With this extension enabled, phpstan/phpstan will understand that $prophecy accepts method calls to all methods that are implemented by its prophesized class (or additionally implemented interfaces, when using willImplement()).

Method Arguments

❗ Currently here are no checks in place to validate the arguments of methods that are invoked on prophecies.

Development

A development environment is provided via .docker/Dockerfile.

Run

$ docker build --tag phpstan-prophecy .docker/

to build and tag the Docker image.

Run

$ docker run -it --rm --volume "$PWD":/var/www/html --workdir /var/www/html phpstan-prophecy bash

to open a shell in the Docker container.

Changelog

Please have a look at CHANGELOG.md.

Contributing

Please have a look at CONTRIBUTING.md.

License

This package is licensed using the MIT License.

Please have a look at LICENSE.md.