Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
15 changes: 14 additions & 1 deletion lib/private/AppFramework/Utility/ControllerMethodReflector.php
Original file line number Diff line number Diff line change
Expand Up @@ -18,13 +18,18 @@ class ControllerMethodReflector implements IControllerMethodReflector {
private $types = [];
private $parameters = [];
private array $ranges = [];
private int $startLine = 0;
private string $file = '';

/**
* @param object $object an object or classname
* @param string $method the method which we want to inspect
*/
public function reflect($object, string $method) {
$reflection = new \ReflectionMethod($object, $method);
$this->startLine = $reflection->getStartLine();
$this->file = $reflection->getFileName();

$docs = $reflection->getDocComment();

if ($docs !== false) {
Expand All @@ -50,7 +55,7 @@ public function reflect($object, string $method) {
// extract type parameter information
preg_match_all('/@param\h+(?P<type>\w+)\h+\$(?P<var>\w+)/', $docs, $matches);
$this->types = array_combine($matches['var'], $matches['type']);
preg_match_all('/@psalm-param\h+(?P<type>\w+)<(?P<rangeMin>(-?\d+|min)),\h*(?P<rangeMax>(-?\d+|max))>\h+\$(?P<var>\w+)/', $docs, $matches);
preg_match_all('/@(?:psalm-)?param\h+(\?)?(?P<type>\w+)<(?P<rangeMin>(-?\d+|min)),\h*(?P<rangeMax>(-?\d+|max))>(\|null)?\h+\$(?P<var>\w+)/', $docs, $matches);
foreach ($matches['var'] as $index => $varName) {
if ($matches['type'][$index] !== 'int') {
// only int ranges are possible at the moment
Expand Down Expand Up @@ -134,4 +139,12 @@ public function getAnnotationParameter(string $name, string $key): string {

return '';
}

public function getStartLine(): int {
return $this->startLine;
}

public function getFile(): string {
return $this->file;
}
}
48 changes: 43 additions & 5 deletions tests/lib/AppFramework/Utility/ControllerMethodReflectorTest.php
Original file line number Diff line number Diff line change
Expand Up @@ -43,9 +43,21 @@ public function test3() {
/**
* @psalm-param int<-4, 42> $rangedOne
* @psalm-param int<min, max> $rangedTwo
* @psalm-param int<1, 6>|null $rangedThree
* @psalm-param ?int<-70, -30> $rangedFour
* @return void
*/
public function test4(int $rangedOne, int $rangedTwo) {
public function test4(int $rangedOne, int $rangedTwo, ?int $rangedThree, ?int $rangedFour) {
}

/**
* @param int<-4, 42> $rangedOne
* @param int<min, max> $rangedTwo
* @param int<1, 6>|null $rangedThree
* @param ?int<-70, -30> $rangedFour
* @return void
*/
public function test5(int $rangedOne, int $rangedTwo, ?int $rangedThree, ?int $rangedFour) {
}
}

Expand Down Expand Up @@ -132,9 +144,6 @@ public function testReadTypeIntAnnotations(): void {
public function arguments3($a, float $b, int $c, $d) {
}

/**
* @requires PHP 7
*/
public function testReadTypeIntAnnotationsScalarTypes(): void {
$reader = new ControllerMethodReflector();
$reader->reflect(
Expand Down Expand Up @@ -228,7 +237,7 @@ public function testInheritanceOverrideNoDocblock(): void {
$this->assertFalse($reader->hasAnnotation('Annotation'));
}

public function testRangeDetection(): void {
public function testRangeDetectionPsalm(): void {
$reader = new ControllerMethodReflector();
$reader->reflect('Test\AppFramework\Utility\EndController', 'test4');

Expand All @@ -239,5 +248,34 @@ public function testRangeDetection(): void {
$rangeInfo2 = $reader->getRange('rangedTwo');
$this->assertSame(PHP_INT_MIN, $rangeInfo2['min']);
$this->assertSame(PHP_INT_MAX, $rangeInfo2['max']);

$rangeInfo3 = $reader->getRange('rangedThree');
$this->assertSame(1, $rangeInfo3['min']);
$this->assertSame(6, $rangeInfo3['max']);

$rangeInfo3 = $reader->getRange('rangedFour');
$this->assertSame(-70, $rangeInfo3['min']);
$this->assertSame(-30, $rangeInfo3['max']);
}

public function testRangeDetectionNative(): void {
$reader = new ControllerMethodReflector();
$reader->reflect('Test\AppFramework\Utility\EndController', 'test5');

$rangeInfo1 = $reader->getRange('rangedOne');
$this->assertSame(-4, $rangeInfo1['min']);
$this->assertSame(42, $rangeInfo1['max']);

$rangeInfo2 = $reader->getRange('rangedTwo');
$this->assertSame(PHP_INT_MIN, $rangeInfo2['min']);
$this->assertSame(PHP_INT_MAX, $rangeInfo2['max']);

$rangeInfo3 = $reader->getRange('rangedThree');
$this->assertSame(1, $rangeInfo3['min']);
$this->assertSame(6, $rangeInfo3['max']);

$rangeInfo3 = $reader->getRange('rangedFour');
$this->assertSame(-70, $rangeInfo3['min']);
$this->assertSame(-30, $rangeInfo3['max']);
}
}
Loading