prophesizer/prophesizer

Generates prophecy double stubs

dev-master 2017-08-19 19:26 UTC

Requires

• php: >=5.3.6

Requires (Dev)

• phpmd/phpmd: 2.4.*
• phpro/grumphp: 0.9.*
• squizlabs/php_codesniffer: 2.7.*

MIT

• Aleksei Lukashin

README

Generates a Prophecy Dummy for class/interface you want to prophesize

Prophesizer inspects @docComment blocks in your code and creates method prophecies according to specified @return, @throws and @param docTags

@return and @throws samples generated in ->will(){...} closure

@param int $id used to check parameters with Argument::type('int') etc.

Example

public function someUnitTest()
{
    $service = $this->prophesize('Service\SomeService'); ///
}    

Press Ctrl+S and line with /// will be transformed into

public function someUnitTest()
{
    // $service = $this->prophesize('Service\SomeService');
    $service = $this->getSomeServiceDouble(); // todo: edit predictions!
}

/**
 * @return \Service\SomeService
 */
private function getSomeServiceDouble()
{
    $someServiceProphecy = $this->prophesize('Service\SomeService');
    
    /** @noinspection PhpUndefinedMethodInspection */
    $someServiceProphecy
        ->createSomething(
            Argument::type('int'),
            Argument::type('string'),
            Argument::allOf(Argument::type('DateTime'), Argument::type('null'))
        )
        ->will(function (array $args) {
            // todo: modify generated method double
            // throw new \SomeService\Exception('Thrown in SomeService::createSomething()');
            // return 999;
        })
        ->shouldBeCalled();
        //->shouldNotBeCalled();

    return $someServiceProphecy->reveal();
}

Why?

I'm tired of manual Dummies writing

Installation

composer require prophesizer/prophesizer

PhpStorm Settings / Tools / File Watchers / +

-Watcher-
Name: prophesizer

-Options-
Show console : Error
[ ] Immediate file synchronization

-Watcher Settings-
File type    : PHP
Scope        : VCS / Changed Files
Program      : $ProjectFileDir$/vendor/bin/prophesizer
Arguments    : $FilePath$ $ProjectFileDir$ 
[x] Create output file from stdout 

PhpStorm / Edit watcher dialog