Finished prototype of refactoring rename local variable.

Author: beberlei

README.md

@@ -20,7 +20,7 @@ The refactoring browser is used with:
 List of Refactorings to implement:
 
 * Extract Method (Prototype Done)
-* Rename Local Variable
+* Rename Local Variable (Prototype Done)
 * Rename Method
     * Private Methods Only first
 * Rename Instance Variable

features/bootstrap/FeatureContext.php

@@ -64,6 +64,7 @@ public function iUseRefactoringWith($refactoringName, TableNode $table)
         if (isset($data['file'])) {
             $data['file'] = vfsStream::url('project/' . $data['file']);
         }
+        $data['--verbose'] = true;
 
         $fh = fopen("php://memory", "rw");
         $input = new ArrayInput($data);
@@ -82,6 +83,9 @@ public function iUseRefactoringWith($refactoringName, TableNode $table)
      */
     public function thePhpFileShouldBeRefactored($file, PyStringNode $expectedPatch)
     {
-        assertEquals(rtrim((string)$expectedPatch), rtrim($this->output), "Refactored File:\n" . rtrim($this->output));
+        $output = implode("\n", array_map('trim', explode("\n", rtrim($this->output))));
+        $expectedPatch = implode("\n", array_map('trim', explode("\n", rtrim((string)$expectedPatch))));
+
+        assertEquals($expectedPatch, $output, "Refactored File:\n" . $output);
     }
 }

src/main/QafooLabs/Patches/ChangeTokenOperation.php

@@ -0,0 +1,22 @@
+<?php
+
+namespace QafooLabs\Patches;
+
+class ChangeTokenOperation implements Operation
+{
+    private $originalLine;
+    private $oldToken;
+    private $newToken;
+
+    public function __construct($originalLine, $oldToken, $newToken)
+    {
+        $this->originalLine = $originalLine;
+        $this->oldToken = $oldToken;
+        $this->newToken = $newToken;
+    }
+
+    public function perform(Hunk $hunk)
+    {
+        return $hunk->changeToken($this->originalLine, $this->oldToken, $this->newToken);
+    }
+}

src/main/QafooLabs/Patches/Hunk.php

@@ -159,6 +159,27 @@ public function changeLines($originalLine, array $newLines)
         ));
     }
 
+    public function changeToken($originalLine, $oldToken, $newToken)
+    {
+        $relativeLine = $this->getRelativeLine($originalLine);
+        $beforeLines = array_slice($this->lines, 0, $relativeLine);
+        $afterLines = array_slice($this->lines, $relativeLine + 1);
+
+        $newLine = substr($this->lines[$relativeLine], 1);
+        $newLine = preg_replace(
+            '(([^a-zA-Z0-9]?)(' . preg_quote($oldToken) . ')([^[a-zA-Z0-9]?))',
+            '\1' . $newToken . '\3',
+            $newLine
+        );
+
+        return $this->newLines(array_merge(
+            $beforeLines,
+            array('-' . substr($this->lines[$relativeLine], 1)),
+            array('+' . $newLine),
+            $afterLines
+        ));
+    }
+
     private function newLines(array $newLines)
     {
         return new Hunk($this->before, $this->after, $newLines, $this->start, $this->size);

src/main/QafooLabs/Patches/Operation.php

@@ -4,5 +4,12 @@
 
 interface Operation
 {
+    /**
+     * Perform opertaion on the hunk and return a new modified hunk.
+     *
+     * @param Hunk $hunk
+     *
+     * @return Hunk
+     */
     public function perform(Hunk $hunk);
 }

src/main/QafooLabs/Patches/PatchBuilder.php

@@ -31,6 +31,22 @@ public function __construct($contents)
         }
     }
 
+    /**
+     * Change Token in given line from old to new.
+     *
+     * @param int $originalLine
+     * @param string $oldToken
+     * @param string $newToken
+     *
+     * @return void
+     */
+    public function changeToken($originalLine, $oldToken, $newToken)
+    {
+        $this->assertValidOriginalLine($originalLine);
+
+        $this->operations[$originalLine] = new ChangeTokenOperation($originalLine, $oldToken, $newToken);
+    }
+
     /**
      * Append new lines to an original line of the file.
      *
@@ -166,7 +182,7 @@ private function getLineGroups()
         $currentLineGroup = array(array_shift($affectedLines));
 
         foreach ($affectedLines as $affectedLine) {
-            if ($affectedLine - max($currentLineGroup) < 3) {
+            if ($affectedLine - max($currentLineGroup) < 4) {
                 $currentLineGroup[] = $affectedLine;
             } else {
                 $lineGroups[] = $currentLineGroup;

src/main/QafooLabs/Refactoring/Adapters/PHPParser/Visitor/LocalVariableClassifier.php

@@ -63,6 +63,14 @@ public function getUsedLocalVariables()
 
     public function getAssignments()
     {
-        return $this->assignments;
+        $assignments = $this->assignments;
+
+        foreach ($this->localVariables as $localVariable => $lines) {
+            if (isset($assignments[$localVariable])) {
+                $assignments[$localVariable] = array_unique($lines);
+            }
+        }
+
+        return $assignments;
     }
 }

src/main/QafooLabs/Refactoring/Adapters/Patches/PatchBuffer.php

@@ -27,4 +27,9 @@ public function append($line, array $newLines)
     {
         $this->builder->appendToLine($line, $newLines);
     }
+
+    public function replaceString($line, $oldToken, $newToken)
+    {
+        $this->builder->changeToken($line, $oldToken, $newToken);
+    }
 }

src/main/QafooLabs/Refactoring/Adapters/Symfony/Commands/RenameLocalVariableCommand.php

@@ -10,6 +10,12 @@
 
 use QafooLabs\Refactoring\Domain\Model\File;
 
+use QafooLabs\Refactoring\Application\RenameLocalVariable;
+use QafooLabs\Refactoring\Adapters\PHPParser\ParserVariableScanner;
+use QafooLabs\Refactoring\Adapters\TokenReflection\StaticCodeAnalysis;
+use QafooLabs\Refactoring\Adapters\Patches\PatchEditor;
+use QafooLabs\Refactoring\Adapters\Symfony\OutputPatchCommand;
+
 class RenameLocalVariableCommand extends Command
 {
     protected function configure()
@@ -27,8 +33,15 @@ protected function configure()
     protected function execute(InputInterface $input, OutputInterface $output)
     {
         $file = File::createFromPath($input->getArgument('file'), getcwd());
-        $line = $input->getArgument('line');
+        $line = (int)$input->getArgument('line');
         $name = $input->getArgument('name');
         $newName = $input->getArgument('new-name');
+
+        $scanner = new ParserVariableScanner();
+        $codeAnalysis = new StaticCodeAnalysis();
+        $editor = new PatchEditor(new OutputPatchCommand($output));
+
+        $renameLocalVariable = new RenameLocalVariable($scanner, $codeAnalysis, $editor);
+        $renameLocalVariable->refactor($file, $line, $name, $newName);
     }
 }

src/main/QafooLabs/Refactoring/Application/RenameLocalVariable.php

@@ -38,11 +38,32 @@ public function __construct(VariableScanner $variableScanner, CodeAnalysis $code
 
     public function refactor(File $file, $line, $oldName, $newName)
     {
+        $oldName = ltrim($oldName, '$');
+        $newName = ltrim($newName, '$');
+
         $methodRange = $this->findMethodRange($file, $line);
         $declaredVariables = $this->variableScanner->scanForVariables($file, $methodRange);
 
+        if ( ! isset($declaredVariables->localVariables[$oldName]) &&
+             ! isset($declaredVariables->assignments[$oldName])) {
+
+            return;
+        }
+
         $buffer = $this->editor->openBuffer($file);
 
+        if (isset($declaredVariables->localVariables[$oldName])) {
+            foreach ($declaredVariables->localVariables[$oldName] as $line) {
+                $buffer->replaceString($line, '$' . $oldName, '$' . $newName);
+            }
+        }
+
+        if (isset($declaredVariables->assignments[$oldName])) {
+            foreach ($declaredVariables->assignments[$oldName] as $line) {
+                $buffer->replaceString($line, '$' . $oldName, '$' . $newName);
+            }
+        }
+
         $this->editor->save();
     }
 

src/main/QafooLabs/Refactoring/Domain/Model/EditorBuffer.php

@@ -7,6 +7,35 @@
  */
 interface EditorBuffer
 {
+    /**
+     * Replace LineRange with new lines.
+     *
+     * @param LineRange $range
+     * @param array $newLines
+     *
+     * @return void
+     */
     public function replace(LineRange $range, array $newLines);
+
+    /**
+     * Append new lines to a given line.
+     *
+     * @param integer $line
+     * @param array $newLines
+     *
+     * @return void
+     */
     public function append($line, array $newLines);
+
+    /**
+     * Replace a token in in a line with another token.
+     *
+     * @param integer $line
+     * @param string $oldToken
+     * @param string $newToken
+     *
+     * @return void
+     */
+    public function replaceString($line, $oldToken, $newToken);
 }
+

src/test/QafooLabs/Patches/HunkTest.php

@@ -132,4 +132,17 @@ public function testForLinesAppend()
 HUNK
             , (string)$hunk);
     }
+
+    public function testChangeToken()
+    {
+        $hunk = Hunk::forLine(1, array('$foo = $foo;'));
+        $newHunk = $hunk->changeToken(1, '$foo', '$bar');
+
+        $this->assertEquals(<<<'HUNK'
+@@ -1,1 +1,1 @@
+-$foo = $foo;
++$bar = $bar;
+HUNK
+            , (string)$newHunk);
+    }
 }