Skip to content
This repository was archived by the owner on Jul 12, 2020. It is now read-only.

Convert local to instance variable with method argument #53

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
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
41 changes: 41 additions & 0 deletions features/convert_local_to_instance_variable.feature
Original file line number Diff line number Diff line change
Expand Up @@ -46,3 +46,44 @@ Feature: Convert Local to Instance Variable
}
"""

Scenario: Convert Argument Variable
Given a PHP File named "src/FooWithArgument.php" with:
"""
<?php
class FooWithArgument
{
public function operation($service)
{
$service->operation();

return $service;
}
}
"""
When I use refactoring "convert-local-to-instance-variable" with:
| arg | value |
| file | src/FooWithArgument.php |
| line | 6 |
| variable | service |
Then the PHP File "src/FooWithArgument.php" should be refactored:
"""
--- a/vfs://project/src/FooWithArgument.php
+++ b/vfs://project/src/FooWithArgument.php
@@ -1,10 +1,14 @@
<?php
class FooWithArgument
{
+ private $service;
+
public function operation($service)
{
- $service->operation();
+ $this->service = $service;

- return $service;
+ $this->service->operation();
+
+ return $this->service;
}
}
"""
Original file line number Diff line number Diff line change
Expand Up @@ -94,10 +94,7 @@ public function changeToken($originalLine, $oldToken, $newToken)
*/
public function appendToLine($originalLine, array $lines)
{
// Why is this one method different to the rest?
$originalLine++;

$this->buffer->insert($this->createLineNumber($originalLine), $lines);
$this->buffer->append($this->createLineNumber($originalLine), $lines);
}

/**
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,11 +14,12 @@

namespace QafooLabs\Refactoring\Adapters\TokenReflection;

use QafooLabs\Refactoring\Domain\Services\CodeAnalysis;
use QafooLabs\Refactoring\Domain\Model\LineRange;
use QafooLabs\Refactoring\Domain\Model\File;
use QafooLabs\Refactoring\Domain\Model\LineRange;
use QafooLabs\Refactoring\Domain\Model\PhpClass;
use QafooLabs\Refactoring\Domain\Model\PhpName;
use QafooLabs\Refactoring\Domain\Model\RefactoringException;
use QafooLabs\Refactoring\Domain\Services\CodeAnalysis;

use TokenReflection\Broker;
use TokenReflection\Broker\Backend\Memory;
Expand Down Expand Up @@ -91,6 +92,17 @@ public function isInsideMethod(File $file, LineRange $range)
return $this->findMatchingMethod($file, $range) !== null;
}

public function getMethod(File $file, LineRange $range)
{
$method = $this->findMatchingMethod($file, $range);

if ($method === null) {
throw RefactoringException::rangeIsNotInsideMethod($range);
}

return $method;
}

/**
* @param File $file
* @return PhpClass[]
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,16 +13,24 @@
use QafooLabs\Refactoring\Domain\Services\VariableScanner;
use QafooLabs\Refactoring\Domain\Services\CodeAnalysis;
use QafooLabs\Refactoring\Domain\Services\Editor;
use QafooLabs\Refactoring\Domain\Model\EditingAction\AddAssignment;
use QafooLabs\Refactoring\Domain\Model\EditingAction\AddProperty;
use QafooLabs\Refactoring\Domain\Model\EditingAction\LocalVariableToInstance;

use TokenReflection\ReflectionMethod;

class ConvertLocalToInstanceVariable extends SingleFileRefactoring
{
/**
* @var Variable
*/
private $convertVariable;

/**
* @var ReflectionMethod
*/
private $method;

/**
* @param int $line
*/
Expand All @@ -32,11 +40,19 @@ public function refactor(File $file, $line, Variable $convertVariable)
$this->line = $line;
$this->convertVariable = $convertVariable;

$this->method = $this->codeAnalysis->getMethod($this->file, LineRange::fromSingleLine($line));

$this->assertIsInsideMethod();

$this->startEditingSession();

$this->addProperty();
$this->convertVariablesToInstanceVariables();

if ($this->variableIsMethodParameter()) {
$this->assignArgumentVariableToInstanceVariable();
}

$this->completeEditingSession();
}

Expand All @@ -51,12 +67,55 @@ private function addProperty()

private function convertVariablesToInstanceVariables()
{
$range = $this->getMethodBodyRange();

$definedVariables = $this->getDefinedVariables();

$this->assertVariableIsDefiniedInScope($range, $definedVariables);

$this->session->addEdit(new LocalVariableToInstance($definedVariables, $this->convertVariable));
}

private function variableIsMethodParameter()
{
return in_array($this->convertVariable->getName(), array_map(function ($parameter) {
return $parameter->getName();
}, $this->method->getParameters()));
}

private function assignArgumentVariableToInstanceVariable()
{
$instanceVariable = $this->convertVariable->convertToInstance();

$line = $this->method->getStartLine() + 1;

// The +1 assumes that the function definition is followed by a newline with the
// opening brace. Ideally this needs to be detected.
$this->session->addEdit(new AddAssignment($line, $instanceVariable, $this->convertVariable->getToken()));
}

protected function getDefinedVariables()
{
$selectedMethodLineRange = $this->getMethodBodyRange();

$definedVariables = $this->variableScanner->scanForVariables(
$this->file, $selectedMethodLineRange
);

return $definedVariables;
}

private function getMethodBodyRange()
{
$methodLineRange = $this->codeAnalysis->findMethodRange($this->file, LineRange::fromSingleLine($this->line));

return LineRange::fromLines($methodLineRange->getStart() + 1, $methodLineRange->getEnd());
}

private function assertVariableIsDefiniedInScope(LineRange $selectedMethodLineRange, DefinedVariables $definedVariables)
{
if ( ! $definedVariables->contains($this->convertVariable)) {
throw RefactoringException::variableNotInRange($this->convertVariable, $selectedMethodLineRange);
}

$this->session->addEdit(new LocalVariableToInstance($definedVariables, $this->convertVariable));
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
<?php

namespace QafooLabs\Refactoring\Domain\Model\EditingAction;

use QafooLabs\Refactoring\Domain\Model\EditingAction;
use QafooLabs\Refactoring\Domain\Model\EditorBuffer;
use QafooLabs\Refactoring\Domain\Model\Variable;

class AddAssignment implements EditingAction
{
/**
* @var int
*/
private $line;

/**
* @var Variable
*/
private $lhs;

/**
* @var string
*/
private $rhs;

/**
* @param int $line
* @param string $rhs
*/
public function __construct($line, Variable $lhs, $rhs)
{
$this->line = $line;
$this->lhs = $lhs;
$this->rhs = $rhs;
}

public function performEdit(EditorBuffer $buffer)
{
$buffer->append($this->line, array(
' ' . $this->lhs->getToken() . ' = ' . $this->rhs . ';',
''
));
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
<?php

namespace QafooLabs\Refactoring\Domain\Model\EditingAction;

use QafooLabs\Refactoring\Domain\Model\Variable;

class AddAssignmentTest extends \PHPUnit_Framework_TestCase
{
private $buffer;

protected function setUp()
{
$this->buffer = $this->getMock('QafooLabs\Refactoring\Domain\Model\EditorBuffer');
}

public function testItIsAnEditingAction()
{
$this->assertInstanceOf(
'QafooLabs\Refactoring\Domain\Model\EditingAction',
new AddAssignment(4, new Variable('lhs'), 'rhs')
);
}

public function testAssignementIsAppenedAtGivenLine()
{
$line = 27;

$action = new AddAssignment($line, new Variable(''), '');

$this->buffer
->expects($this->once())
->method('append')
->with($line, $this->anything());

$action->performEdit($this->buffer);
}

public function testPropertyCodeIsCorrect()
{
$action = new AddAssignment(5, new Variable('$this->value'), '$value');

$this->buffer
->expects($this->once())
->method('append')
->with($this->anything(), $this->equalTo(array(
' $this->value = $value;',
''
)));

$action->performEdit($this->buffer);
}
}