Return an intersection type when nameMock is used

[martinssipenko]

This will return intersetion type when namedMock function is used.

Currently when Mockery::namedMock() is used within tests PHPStan complains that the mocked object does not conform to what is expected.

interface Bar {}

class Foo
{
    public function foo(Bar $bar) {
        $this->bar = $bar;
    }
}

// Works
$mock = Mockery::mock(Bar::class);
(new Foo)->foo($mock);

// Does not work
// Parameter #1 $bar of method Foo::foo() expects Bar, Mockery\MockInterface given. 
$namedMock = Mockery::namedMock('Buzz', Bar::class);
(new Foo)->foo($namedMock);

[ondrejmirtes]

Hi, this isn't sufficient as the extension will try to make a type from the first argument too.

[martinssipenko]

Hi, this isn't sufficient as the extension will try to make a type from the first argument too.

Hm, I understand first argument also represents a type, essantually namedMock('Foo', 'Bar') is same as calss Foo implements Bar.

[ondrejmirtes]

From the documentation I don't understand what the method does: http://docs.mockery.io/en/latest/cookbook/class_constants.html

There are only classes involved, and in PHP you can't create intersection types from classes.

[martinssipenko]

When you mock something with Mockery::mock(SomeInterface::class) mockery creates a "fake" class that implements SomeInterface and a mock object from this "fake" class is created.

Now suppose you need to create two mock objects of same interface.

$mock1 = Mockery::mock(SomeInterface::class);
$mock2 = Mockery::mock(SomeInterface::class);

If you do get_class($mock1) and get_class($mock2) you will get the same result because the same "fake" class is used.

Using namedMock method you can get specify the name of the "fake" calss mockery creates, thus it allows to have two distinct objects that are created from different classes, but implement same interface.

[ondrejmirtes]

Yeah but if class name in the first argument isn't an existing one, we have to skip it when creating the intersection...

[martinssipenko]

Can you help me understand why? If we use mock method, then class/interface name (1st arg) can also be non-existant.

How do you think we can fix this?

[ondrejmirtes]

 then class/interface name (1st arg) can also be non-existant.

I don't think that's true.

[martinssipenko]

<?php
// x.php

require_once __DIR__ . '/vendor/autoload.php';

$mock1 = Mockery::mock('WhaterverRandomNameIComeUpWith');
$mock2 = Mockery::mock('WhaterverRandomNameIComeUpWith');

var_dump(get_class($mock1));
var_dump(get_class($mock2));

php x.php 
/Users/msipenko/src/msipenko/forks/phpstan-mockery/x.php:8:
string(41) "Mockery_0__WhaterverRandomNameIComeUpWith"
/Users/msipenko/src/msipenko/forks/phpstan-mockery/x.php:9:
string(41) "Mockery_0__WhaterverRandomNameIComeUpWith"

[ondrejmirtes]

Yeah but PHPStan won't like it: https://phpstan.org/r/31d8e42c-5d2c-420a-b7d0-8161f271e686

Is it a valid use-case?

[martinssipenko]

Ah ok, I understand now, strangely I edited the code locally in my projects vendor directory, and just adding that entry to array made PHPStan error go away.

Either way, what do you suggest we can do here?

[ondrejmirtes]

There has to be another extension similar to MockDynamicReturnTypeExtension but that skips the first parameter.

[martinssipenko]

Meybe we can just add something like this?

		$args = $methodCall->args;
		if ($methodReflection->getName() === 'namedMock') {
			array_shift($args);
		}

[ondrejmirtes]

Nope, it'd be a mess, this needs a separate class.

[ondrejmirtes]

Some code added to https://github.com/phpstan/phpstan-mockery/blob/master/tests/Mockery/MockeryTest.php to verify by running vendor/bin/phing phpstan this actually works would be nice.

[ondrejmirtes]

You need to make sure the array has at least two elements.

[martinssipenko]

@ondrejmirtes, any updates on this?

[ondrejmirtes]

Merged and released, thanks.

[martinssipenko]

Thank you!