Skip to content

Commit dd3e029

Browse files
Halleck45Halleck45
committed
[PHP7] detection of returned type
1 parent 0aa8b4d commit dd3e029

File tree

12 files changed

+280
-105
lines changed

12 files changed

+280
-105
lines changed

‎src/Hal/Component/OOP/Extractor/Extractor.php‎

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -74,8 +74,7 @@ public function extract($filename)
7474
$nameResolver = new NameResolver();
7575

7676
// default current values
77-
$class = $interface = $function = $method = null;
78-
// $mapOfAliases = array();
77+
$class = $interface = $function = $namespace = $method = null;
7978

8079
$len = sizeof($tokens, COUNT_NORMAL);
8180
$endAnonymous = 0;
@@ -157,7 +156,7 @@ public function extract($filename)
157156
continue;
158157
}
159158
$method = $this->extractors->method->extract($n, $tokens);
160-
$method->setNameResolver($nameResolver);
159+
$method->setNamespace($namespace);
161160
$class->pushMethod($method);
162161
}
163162
break;

‎src/Hal/Component/OOP/Extractor/MethodExtractor.php‎

Lines changed: 22 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,8 @@
1111
use Hal\Component\OOP\Reflected\MethodUsage;
1212
use Hal\Component\OOP\Reflected\ReflectedArgument;
1313
use Hal\Component\OOP\Reflected\ReflectedMethod;
14+
use Hal\Component\OOP\Reflected\ReflectedReturn;
15+
use Hal\Component\OOP\Resolver\TypeResolver;
1416
use Hal\Component\Token\TokenCollection;
1517

1618

@@ -105,7 +107,7 @@ public function extract(&$n, TokenCollection $tokens)
105107
$this->extractDependencies($method, $n, $tokens);
106108

107109
// returns
108-
$this->extractReturns($method, $method->getContent());
110+
$this->extractReturns($method, $p = $start, $tokens);
109111

110112
// usage
111113
$this->extractUsage($method);
@@ -214,13 +216,28 @@ private function extractDependencies(ReflectedMethod $method, $n, TokenCollectio
214216
* Extract the list of returned values
215217
*
216218
* @param ReflectedMethod $method
217-
* @param string $content
218219
* @return $this
219220
*/
220-
private function extractReturns(ReflectedMethod $method, $content) {
221-
if(preg_match_all('!([\s;]return\s|^return\s)!', $content, $matches)) {
221+
private function extractReturns(ReflectedMethod $method, $n, TokenCollection $tokens) {
222+
223+
$resolver = new TypeResolver();
224+
225+
// PHP 7
226+
// we cannot use specific token. The ":" delimiter is a T_STRING token
227+
$following = $this->searcher->getUnder(array('{'), $n, $tokens);
228+
if(preg_match('!:(.*)!', $following, $matches)) {
229+
$type = trim($matches[1]);
230+
$return = new ReflectedReturn($type, ReflectedReturn::VALUE_UNKNOW, ReflectedReturn::STRICT_TYPE_HINT);
231+
$method->pushReturn($return);
232+
return $this;
233+
}
234+
235+
// array of available values based on code
236+
if(preg_match_all('![\s;]return\s|^return\s(.*)!', $method->getContent(), $matches)) {
222237
foreach($matches[1] as $m) {
223-
$method->pushReturn($m);
238+
$value = trim($m, ";\t\n\r\0\x0B");
239+
$return = new ReflectedReturn($resolver->resolve($m), $value, ReflectedReturn::ESTIMATED_TYPE_HINT);
240+
$method->pushReturn($return);
224241
}
225242
}
226243
return $this;

‎src/Hal/Component/OOP/Reflected/ReflectedClass.php‎

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -140,8 +140,7 @@ public function getDependencies()
140140
$dependencies = array_merge($dependencies, $method->getDependencies());
141141
}
142142
foreach($dependencies as &$name) {
143-
// $name = preg_replace('!^(\\\\)!', '', $name);
144-
$name = $this->nameResolver->resolve($name, $this->getNamespace());
143+
$name = $this->nameResolver->resolve($name, $this->namespace);
145144
}
146145
return array_unique($dependencies);
147146
}
@@ -196,7 +195,7 @@ public function getParent() {
196195
if ($this->parent === null) {
197196
return null;
198197
}
199-
return $this->nameResolver->resolve($this->parent, $this->getNamespace());
198+
return $this->nameResolver->resolve($this->parent, $this->namespace);
200199
}
201200

202201
/**

‎src/Hal/Component/OOP/Reflected/ReflectedMethod.php‎

Lines changed: 31 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@
1010
namespace Hal\Component\OOP\Reflected;
1111
use Hal\Component\OOP\Reflected\ReflectedClass\ReflectedAnonymousClass;
1212
use Hal\Component\OOP\Resolver\NameResolver;
13+
use Hal\Component\OOP\Resolver\TypeResolver;
1314

1415

1516
/**
@@ -97,6 +98,11 @@ class ReflectedMethod {
9798
*/
9899
private $anonymousClasses = array();
99100

101+
/**
102+
* @var string
103+
*/
104+
private $namespace;
105+
100106
/**
101107
* @param string $name
102108
*/
@@ -170,12 +176,25 @@ public function setTokens($tokens)
170176
}
171177

172178
/**
173-
* Get the list of returned values
179+
* Get returned value
174180
*
175181
* @return array
176182
*/
177183
public function getReturns() {
178-
return $this->returns;
184+
// on read : compare with aliases. We cannot make it in pushDependency() => aliases aren't yet known
185+
$result = array();
186+
$resolver = new TypeResolver();
187+
foreach($this->returns as $return) {
188+
$type = $this->nameResolver->resolve($return->getType(), null);
189+
190+
if("\\" !== $type[0] &&!$resolver->isNative($type)) {
191+
$type = $this->namespace.'\\'.$type;
192+
}
193+
194+
$return->setType($type);
195+
$result[$type] = $return;
196+
}
197+
return array_values($result);
179198
}
180199

181200
/**
@@ -349,4 +368,14 @@ public function getAnonymousClasses()
349368
return $this->anonymousClasses;
350369
}
351370

371+
/**
372+
* @param string $namespace
373+
* @return ReflectedMethod
374+
*/
375+
public function setNamespace($namespace)
376+
{
377+
$this->namespace = $namespace;
378+
return $this;
379+
}
380+
352381
};

‎src/Hal/Component/OOP/Reflected/ReflectedReturn.php‎

Lines changed: 107 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,107 @@
1+
<?php
2+
3+
/*
4+
* (c) Jean-François Lépine <https://twitter.com/Halleck45>
5+
*
6+
* For the full copyright and license information, please view the LICENSE
7+
* file that was distributed with this source code.
8+
*/
9+
10+
namespace Hal\Component\OOP\Reflected;
11+
use Hal\Component\OOP\Resolver\NameResolver;
12+
13+
14+
/**
15+
* represents the value returned by a method
16+
*
17+
* @author Jean-François Lépine <https://twitter.com/Halleck45>
18+
*/
19+
class ReflectedReturn {
20+
21+
const STRICT_TYPE_HINT = 1;
22+
const DOC_TYPE_HINT = 2;
23+
const ESTIMATED_TYPE_HINT = 3;
24+
const VALUE_UNKNOW = 'unknown';
25+
26+
/**
27+
* @var string
28+
*/
29+
private $value = self::VALUE_UNKNOW;
30+
31+
/**
32+
* @var string
33+
*/
34+
private $type;
35+
36+
/**
37+
* @var int
38+
*/
39+
private $mode = self::ESTIMATED_TYPE_HINT;
40+
41+
/**
42+
* @param null $type
43+
* @param string $value
44+
* @param int $mode
45+
*/
46+
public function __construct($type = null, $value = self::VALUE_UNKNOW, $mode = self::ESTIMATED_TYPE_HINT)
47+
{
48+
$this->type = $type;
49+
$this->value = $value;
50+
$this->mode = $mode;
51+
}
52+
53+
/**
54+
* @return string
55+
*/
56+
public function getValue()
57+
{
58+
return $this->value;
59+
}
60+
61+
/**
62+
* @param string $value
63+
* @return ReflectedReturn
64+
*/
65+
public function setValue($value)
66+
{
67+
$this->value = $value;
68+
return $this;
69+
}
70+
71+
/**
72+
* @return string
73+
*/
74+
public function getType()
75+
{
76+
return $this->type;
77+
}
78+
79+
/**
80+
* @param string $type
81+
* @return ReflectedReturn
82+
*/
83+
public function setType($type)
84+
{
85+
$this->type = $type;
86+
return $this;
87+
}
88+
89+
/**
90+
* @return int
91+
*/
92+
public function getMode()
93+
{
94+
return $this->mode;
95+
}
96+
97+
/**
98+
* @param int $mode
99+
* @return ReflectedReturn
100+
*/
101+
public function setMode($mode)
102+
{
103+
$this->mode = $mode;
104+
return $this;
105+
}
106+
107+
};

‎src/Hal/Component/OOP/Resolver/NameResolver.php‎

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,11 @@ class NameResolver
2323
*/
2424
private $aliases = array();
2525

26+
/**
27+
* @var string
28+
*/
29+
private $namespace = '\\';
30+
2631
/**
2732
* Resolve name of class
2833
*
@@ -68,4 +73,23 @@ public function pushAlias(\StdClass $alias) {
6873
$this->aliases[$alias->alias] = $alias->name;
6974
return $this;
7075
}
76+
77+
/**
78+
* @return string
79+
*/
80+
public function getNamespace()
81+
{
82+
return $this->namespace;
83+
}
84+
85+
/**
86+
* @param string $namespace
87+
* @return NameResolver
88+
*/
89+
public function setNamespace($namespace)
90+
{
91+
$this->namespace = $namespace;
92+
return $this;
93+
}
94+
7195
}

‎tests/Hal/Component/OOP/MethodExtractorTest.php‎

Lines changed: 12 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22
namespace Test\Hal\Component\OOP;
33

44
use Hal\Component\OOP\Reflected\ReflectedMethod;
5+
use Hal\Component\OOP\Reflected\ReflectedReturn;
56
use Hal\Component\Token\TokenCollection;
67
use Hal\Metrics\Design\Component\MaintainabilityIndex\MaintainabilityIndex;
78
use Hal\Metrics\Design\Component\MaintainabilityIndex\Result;
@@ -117,15 +118,21 @@ public function testReturnsAreFound($expected, $code) {
117118
$tokens = new TokenCollection(token_get_all($code));
118119
$n = 1;
119120
$method = $methodExtractor->extract($n, $tokens);
120-
$this->assertEquals($expected, sizeof($method->getReturns(), COUNT_NORMAL));
121+
$this->assertEquals($expected, $method->getReturns());
121122
}
122123

123124
public function provideCodeForReturns() {
124125
return array(
125-
array(1, '<?php public function foo() { return 1; }')
126-
, array(0, '<?php public function foo() { }')
127-
, array(2, '<?php public function foo() { if(true) { return 1; } return 2; }')
128-
, array(0, '<?php public function bar() { $x->a(); }')
126+
array(array(new ReflectedReturn('integer', '1', ReflectedReturn::ESTIMATED_TYPE_HINT)), '<?php public function foo() { return 1; }')
127+
/*, array(array(), '<?php public function foo() { }')
128+
, array(
129+
array(
130+
new ReflectedReturn('integer', '1', ReflectedReturn::ESTIMATED_TYPE_HINT),
131+
new ReflectedReturn('integer', '2', ReflectedReturn::ESTIMATED_TYPE_HINT)
132+
),
133+
'<?php public function foo() { if(true) { return 1; } return 2; }'
134+
)
135+
, array(array(), '<?php public function bar() { $x->a(); }')*/
129136
);
130137
}
131138

‎tests/Hal/Component/OOP/Php7AnonymousClassExtractorTest.php‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@
1212
* @group oop
1313
* @group extractor
1414
* @group php7
15+
* @group wip
1516
*/
1617
class Php7AnonymousClassExtractorTest extends \PHPUnit_Framework_TestCase {
1718

0 commit comments

Comments
 (0)