Skip to content
This repository was archived by the owner on Mar 6, 2022. It is now read-only.
Merged
86 changes: 52 additions & 34 deletions lib/Adapter/WorseReflection/Refactor/WorseGenerateAccessor.php
Original file line number Diff line number Diff line change
Expand Up @@ -2,15 +2,17 @@

namespace Phpactor\CodeTransform\Adapter\WorseReflection\Refactor;

use InvalidArgumentException;
use RuntimeException;
use Phpactor\WorseReflection\Core\ClassName;
use Phpactor\WorseReflection\Core\Reflection\ReflectionClass;
use Phpactor\WorseReflection\Core\Reflection\ReflectionProperty;
use Phpactor\WorseReflection\Reflector;
use Phpactor\CodeBuilder\Domain\Updater;
use Phpactor\WorseReflection\Core\Inference\Symbol;
use Phpactor\CodeBuilder\Domain\Builder\SourceCodeBuilder;
use Phpactor\CodeTransform\Domain\SourceCode;
use Phpactor\CodeBuilder\Domain\Code;
use Phpactor\CodeTransform\Domain\Refactor\GenerateAccessor;
use Phpactor\WorseReflection\Core\Inference\SymbolContext;
use Phpactor\CodeTransform\Domain\Exception\TransformException;

class WorseGenerateAccessor implements GenerateAccessor
{
Expand Down Expand Up @@ -46,31 +48,19 @@ public function __construct(
$this->upperCaseFirst = $upperCaseFirst;
}

public function generateAccessor(SourceCode $sourceCode, int $offset): SourceCode
public function generate(SourceCode $sourceCode, string $propertyName, int $offset): SourceCode
{
$info = $this->getInfo($sourceCode, $offset);
$prototype = $this->buildPrototype($info);
$sourceCode = $this->sourceFromSymbolInformation($sourceCode, $info);
$property = $this->class((string) $sourceCode, $offset)
->properties()
->offsetGet($propertyName);

return $sourceCode->withSource(
(string) $this->updater->apply($prototype, Code::fromString((string) $sourceCode))
);
}

private function getInfo(SourceCode $sourceCode, int $offset): SymbolContext
{
$reflectionOffset = $this->reflector->reflectOffset($sourceCode->__toString(), $offset);
$info = $reflectionOffset->symbolContext();

if ($info->symbol()->symbolType() !== Symbol::PROPERTY) {
throw new TransformException(sprintf(
'Symbol at offset "%s" is not a property, it is a symbol of type "%s"',
$offset,
$info->symbol()->symbolType()
));
}
$prototype = $this->buildPrototype($property);
$sourceCode = $this->sourceFromClassName($sourceCode, $property->class()->name());

return $info;
return $sourceCode->withSource((string) $this->updater->apply(
$prototype,
Code::fromString((string) $sourceCode)
));
}

private function formatName(string $name)
Expand All @@ -82,25 +72,28 @@ private function formatName(string $name)
return $this->prefix . $name;
}

private function buildPrototype(SymbolContext $info)
private function buildPrototype(ReflectionProperty $property)
{
$builder = SourceCodeBuilder::create();
$builder->namespace($info->containerType()->className()->namespace());
$className = $property->class()->name();

$builder->namespace($className->namespace());
$method = $builder
->class($info->containerType()->className()->short())
->method($this->formatName($info->symbol()->name()));
$method->body()->line(sprintf('return $this->%s;', $info->symbol()->name()));
->class($className->short())
->method($this->formatName($property->name()));
$method->body()->line(sprintf('return $this->%s;', $property->name()));

if ($info->type()->isDefined()) {
$method->returnType($info->type()->isClass() ? $info->type()->className()->short() : $info->type()->primitive());
$type = $property->inferredTypes()->best();
if ($type->isDefined()) {
$method->returnType($type->isClass() ? $type->className()->short() : $type->primitive());
}

return $builder->build();
}

private function sourceFromSymbolInformation(SourceCode $sourceCode, SymbolContext $info): SourceCode
private function sourceFromClassName(SourceCode $sourceCode, ClassName $className): SourceCode
{
$containingClass = $this->reflector->reflectClassLike($info->containerType()->className());
$containingClass = $this->reflector->reflectClassLike($className);
$worseSourceCode = $containingClass->sourceCode();

if ($worseSourceCode->path() != $sourceCode->path()) {
Expand All @@ -112,4 +105,29 @@ private function sourceFromSymbolInformation(SourceCode $sourceCode, SymbolConte
$worseSourceCode->path()
);
}

private function class(string $source, int $offset): ReflectionClass
Comment thread
camilledejoye marked this conversation as resolved.
Resolved
{
$classes = $this->reflector->reflectClassesIn($source);

if (0 === $classes->count()) {
throw new InvalidArgumentException(
'No classes in source file'
);
}

if (1 === $classes->count()) {
return $classes->first();
}

foreach ($this->reflector->reflectClassesIn($source) as $class) {
$position = $class->position();

if ($position->start() <= $offset && $offset <= $position->end()) {
return $class;
}
}
Comment thread
camilledejoye marked this conversation as resolved.
Resolved

throw new RuntimeException('Impossible to determine which class to use.');
}
}
2 changes: 1 addition & 1 deletion lib/Domain/Refactor/GenerateAccessor.php
Original file line number Diff line number Diff line change
Expand Up @@ -6,5 +6,5 @@

interface GenerateAccessor
{
public function generateAccessor(SourceCode $sourceCode, int $offset): SourceCode;
public function generate(SourceCode $sourceCode, string $propertyName, int $offset): SourceCode;
Comment thread
camilledejoye marked this conversation as resolved.
Resolved
}
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
use Phpactor\CodeTransform\Tests\Adapter\WorseReflection\WorseTestCase;
use Phpactor\CodeTransform\Adapter\WorseReflection\Refactor\WorseGenerateAccessor;
use Phpactor\CodeTransform\Domain\SourceCode;
use Phpactor\CodeTransform\Domain\Exception\TransformException;
use Phpactor\WorseReflection\Core\Exception\ItemNotFound;

class WorseGenerateAccessorTest extends WorseTestCase
{
Expand All @@ -14,47 +14,70 @@ class WorseGenerateAccessorTest extends WorseTestCase
*/
public function testGenerateAccessor(
string $test,
string $propertyName,
string $prefix = '',
bool $upperCaseFirst = false
) {
list($source, $expected, $offset) = $this->sourceExpectedAndOffset(__DIR__ . '/fixtures/' . $test);
list($source, $expected, $offset) = $this->sourceExpectedAndOffset(
__DIR__ . '/fixtures/' . $test
);

$generateAccessor = new WorseGenerateAccessor($this->reflectorFor($source), $this->updater(), $prefix, $upperCaseFirst);
$transformed = $generateAccessor->generateAccessor(SourceCode::fromString($source), $offset);
$generateAccessor = new WorseGenerateAccessor(
$this->reflectorFor($source),
$this->updater(),
$prefix,
$upperCaseFirst
);
$transformed = $generateAccessor->generate(
SourceCode::fromString($source),
$propertyName,
$offset
);

$this->assertEquals(trim($expected), trim($transformed));
}

public function provideExtractAccessor()
{
$propertyName = 'method';

return [
'property' => [
'generateAccessor1.test',
$propertyName,
],
'prefix and ucfirst' => [
'generateAccessor2.test',
$propertyName,
'get',
true,
],
'return type' => [
'generateAccessor3.test',
$propertyName,
],
'namespaced' => [
'generateAccessor4.test',
$propertyName,
],
'pseudo-type' => [
'generateAccessor5.test',
$propertyName,
],
'multiple-classes' => [
'generateAccessor6.test',
$propertyName,

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

why do we add $propertyName when it is always the same?

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Would have slightly preferred to keep "constants" as a value in the test rather than repeating here (we don't vary in this test). But not important :)

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I always try to keep tests configurable, not saying it's a good thing.
It makes my life terrible some time ! :D
But that's why, I just don't like the idea of coupling even... Early optimization, sill got some work to do on that ><

],
];
}

public function testNonProperty()
{
$this->expectException(TransformException::class);
$this->expectExceptionMessage('Symbol at offset "9" is not a property');
$source = '<?php echo "hello";';
$this->expectException(ItemNotFound::class);
$this->expectExceptionMessage('Unknown item "bar", known items: "foo"');
$source = '<?php class Foo { private $foo; }';

$generateAccessor = new WorseGenerateAccessor($this->reflectorFor(''), $this->updater());
$generateAccessor->generateAccessor(SourceCode::fromString($source), 9);
$generateAccessor->generate(SourceCode::fromString($source), 'bar', 0);
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@

class generateMethod
{
private $met<>hod;
pr<>ivate $method;
}
// File: expected
<?php
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,8 @@

class generateMethod
{
private $met<>hod;
}
private $method;
<>}
// File: expected
<?php

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,11 +3,11 @@
<?php

class generateMethod
{
{<>
/**
* @var Type1
*/
private $met<>hod;
private $method;
}
// File: expected
<?php
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,8 @@ class generateMethod
/**
* @var Type1
*/
private $met<>hod;
}
private $method;
<>}
// File: expected
<?php

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,8 @@ class generateMethod
/**
* @var Type1[]
*/
private $met<>hod;
}
private $method;
<>}
// File: expected
<?php

Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
// File: source

<?php

namespace Acme;

class generateMethod
{
/**
* @var Type1[]
*/
private $method;
<>}

class Bar
{
}
// File: expected
<?php

namespace Acme;

class generateMethod
{
/**
* @var Type1[]
*/
private $method;

public function method(): array
{
return $this->method;
}
}

class Bar
{
}