Skip to content

Adds missing testcases and solves issue nullable #121

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Dec 26, 2017
Merged

Adds missing testcases and solves issue nullable #121

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 8 additions & 2 deletions src/phpDocumentor/Reflection/Php/Factory/Function_.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@
use phpDocumentor\Reflection\TypeResolver;
use phpDocumentor\Reflection\Types\Context;
use PhpParser\Comment\Doc;
use PhpParser\Node\NullableType;
use PhpParser\Node\Stmt\Function_ as FunctionNode;

/**
Expand Down Expand Up @@ -59,9 +60,14 @@ protected function doCreate($object, StrategyContainer $strategies, Context $con
$docBlock = $this->createDocBlock($strategies, $object->getDocComment(), $context);

$returnType = null;
if ($object->returnType !== null) {
if ($object->getReturnType() !== null) {
$typeResolver = new TypeResolver();
$returnType = $typeResolver->resolve($object->returnType, $context);
if ($object->getReturnType() instanceof NullableType) {
$typeString = '?' . $object->getReturnType()->type;
} else {
$typeString = (string)$object->getReturnType();
}
$returnType = $typeResolver->resolve($typeString, $context);
}

$function = new FunctionDescriptor($object->fqsen, $docBlock, new Location($object->getLine()), $returnType);
Expand Down
10 changes: 8 additions & 2 deletions src/phpDocumentor/Reflection/Php/Factory/Method.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@
use phpDocumentor\Reflection\TypeResolver;
use phpDocumentor\Reflection\Types\Context;
use phpDocumentor\Reflection\Types\Mixed_;
use PhpParser\Node\NullableType;
use PhpParser\Node\Stmt\ClassMethod;

/**
Expand Down Expand Up @@ -51,9 +52,14 @@ protected function doCreate($object, StrategyContainer $strategies, Context $con
$docBlock = $this->createDocBlock($strategies, $object->getDocComment(), $context);

$returnType = null;
if ($object->returnType !== null) {
if ($object->getReturnType() !== null) {
$typeResolver = new TypeResolver();
$returnType = $typeResolver->resolve($object->returnType, $context);
if ($object->getReturnType() instanceof NullableType) {
$typeString = '?' . $object->getReturnType()->type;
} else {
$typeString = (string)$object->getReturnType();
}
$returnType = $typeResolver->resolve($typeString, $context);
}

$method = new MethodDescriptor(
Expand Down
50 changes: 50 additions & 0 deletions tests/unit/phpDocumentor/Reflection/Php/Factory/Function_Test.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,10 @@
use Mockery as m;
use phpDocumentor\Reflection\Php\StrategyContainer;
use phpDocumentor\Reflection\Types\Context;
use phpDocumentor\Reflection\Types\Integer;
use phpDocumentor\Reflection\Types\Nullable;
use PhpParser\Comment\Doc;
use PhpParser\Node\NullableType;

/**
* Test case for \phpDocumentor\Reflection\Php\Factory\Function_
Expand Down Expand Up @@ -55,6 +58,7 @@ public function testCreateWithoutParameters()
$functionMock->params = [];
$functionMock->shouldReceive('getDocComment')->andReturnNull();
$functionMock->shouldReceive('getLine')->andReturn(1);
$functionMock->shouldReceive('getReturnType')->andReturnNull();

$containerMock = m::mock(StrategyContainer::class);
$containerMock->shouldReceive('findMatching')->never();
Expand All @@ -75,6 +79,7 @@ public function testCreateWithParameters()
$functionMock->params = array('param1');
$functionMock->shouldReceive('getDocComment')->andReturnNull();
$functionMock->shouldReceive('getLine')->andReturn(1);
$functionMock->shouldReceive('getReturnType')->andReturnNull();

$containerMock = m::mock(StrategyContainer::class);
$containerMock->shouldReceive('findMatching->create')
Expand All @@ -88,6 +93,50 @@ public function testCreateWithParameters()
$this->assertEquals('\SomeSpace::function()', (string)$function->getFqsen());
}

/**
* @covers ::create
*/
public function testReturnTypeResolving()
{
$functionMock = m::mock(\PhpParser\Node\Stmt\Function_::class);
$functionMock->fqsen = new Fqsen('\SomeSpace::function()');
$functionMock->params = [];
$functionMock->shouldReceive('getDocComment')->andReturnNull();
$functionMock->shouldReceive('getLine')->andReturn(1);
$functionMock->shouldReceive('getReturnType')->times(3)->andReturn('int');

$containerMock = m::mock(StrategyContainer::class);
$containerMock->shouldReceive('findMatching')->never();


/** @var FunctionDescriptor $function */
$function = $this->fixture->create($functionMock, $containerMock);

$this->assertEquals(new Integer(), $function->getReturnType());
}

/**
* @covers ::create
*/
public function testReturnTypeNullableResolving()
{
$functionMock = m::mock(\PhpParser\Node\Stmt\Function_::class);
$functionMock->fqsen = new Fqsen('\SomeSpace::function()');
$functionMock->params = [];
$functionMock->shouldReceive('getDocComment')->andReturnNull();
$functionMock->shouldReceive('getLine')->andReturn(1);
$functionMock->shouldReceive('getReturnType')->times(3)->andReturn(new NullableType('int'));

$containerMock = m::mock(StrategyContainer::class);
$containerMock->shouldReceive('findMatching')->never();


/** @var FunctionDescriptor $method */
$function = $this->fixture->create($functionMock, $containerMock);

$this->assertEquals(new Nullable(new Integer()), $function->getReturnType());
}

/**
* @covers ::create
*/
Expand All @@ -99,6 +148,7 @@ public function testCreateWithDocBlock()
$functionMock->params = [];
$functionMock->shouldReceive('getDocComment')->andReturn($doc);
$functionMock->shouldReceive('getLine')->andReturn(1);
$functionMock->shouldReceive('getReturnType')->andReturnNull();

$docBlock = new DocBlockDescriptor('');

Expand Down
49 changes: 49 additions & 0 deletions tests/unit/phpDocumentor/Reflection/Php/Factory/MethodTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,10 @@
use Mockery as m;
use phpDocumentor\Reflection\Php\StrategyContainer;
use phpDocumentor\Reflection\Types\Context;
use phpDocumentor\Reflection\Types\Integer;
use phpDocumentor\Reflection\Types\Nullable;
use PhpParser\Comment\Doc;
use PhpParser\Node\NullableType;
use PhpParser\Node\Stmt\ClassMethod;

/**
Expand Down Expand Up @@ -53,6 +56,7 @@ public function testCreateWithoutParameters()
$classMethodMock->shouldReceive('isPrivate')->once()->andReturn(false);
$classMethodMock->shouldReceive('isProtected')->once()->andReturn(false);
$classMethodMock->shouldReceive('getDocComment')->once()->andReturnNull();
$classMethodMock->shouldReceive('getReturnType')->once()->andReturn(null);

$containerMock = m::mock(StrategyContainer::class);
$containerMock->shouldReceive('findMatching')->never();
Expand All @@ -71,6 +75,7 @@ public function testCreateProtectedMethod()
$classMethodMock->shouldReceive('isPrivate')->once()->andReturn(false);
$classMethodMock->shouldReceive('isProtected')->once()->andReturn(true);
$classMethodMock->shouldReceive('getDocComment')->once()->andReturnNull();
$classMethodMock->shouldReceive('getReturnType')->once()->andReturn(null);

$containerMock = m::mock(StrategyContainer::class);
$containerMock->shouldReceive('findMatching')->never();
Expand All @@ -91,6 +96,7 @@ public function testCreateWithParameters()
$classMethodMock->params = array('param1');
$classMethodMock->shouldReceive('isPrivate')->once()->andReturn(true);
$classMethodMock->shouldReceive('getDocComment')->once()->andReturnNull();
$classMethodMock->shouldReceive('getReturnType')->once()->andReturn(null);

$containerMock = m::mock(StrategyContainer::class);
$containerMock->shouldReceive('findMatching->create')
Expand All @@ -108,6 +114,48 @@ public function testCreateWithParameters()
$this->assertEquals('private', (string)$method->getVisibility());
}

/**
* @covers ::create
*/
public function testReturnTypeResolving()
{
$classMethodMock = $this->buildClassMethodMock();
$classMethodMock->params = [];
$classMethodMock->shouldReceive('isPrivate')->once()->andReturn(true);
$classMethodMock->shouldReceive('getDocComment')->once()->andReturnNull();
$classMethodMock->shouldReceive('getReturnType')->times(3)->andReturn('int');

$containerMock = m::mock(StrategyContainer::class);
$containerMock->shouldReceive('findMatching')->never();


/** @var MethodDescriptor $method */
$method = $this->fixture->create($classMethodMock, $containerMock);

$this->assertEquals(new Integer(), $method->getReturnType());
}

/**
* @covers ::create
*/
public function testReturnTypeNullableResolving()
{
$classMethodMock = $this->buildClassMethodMock();
$classMethodMock->params = [];
$classMethodMock->shouldReceive('isPrivate')->once()->andReturn(true);
$classMethodMock->shouldReceive('getDocComment')->once()->andReturnNull();
$classMethodMock->shouldReceive('getReturnType')->times(3)->andReturn(new NullableType('int'));

$containerMock = m::mock(StrategyContainer::class);
$containerMock->shouldReceive('findMatching')->never();


/** @var MethodDescriptor $method */
$method = $this->fixture->create($classMethodMock, $containerMock);

$this->assertEquals(new Nullable(new Integer()), $method->getReturnType());
}

/**
* @covers ::create
*/
Expand All @@ -118,6 +166,7 @@ public function testCreateWithDocBlock()
$classMethodMock->params = array();
$classMethodMock->shouldReceive('isPrivate')->once()->andReturn(true);
$classMethodMock->shouldReceive('getDocComment')->andReturn($doc);
$classMethodMock->shouldReceive('getReturnType')->once()->andReturn(null);

$docBlock = new DocBlockDescriptor('');

Expand Down