Add support for renaming local variables inside functions

Author: K-Phoen

src/main/QafooLabs/Refactoring/Adapters/TokenReflection/StaticCodeAnalysis.php

@@ -62,6 +62,28 @@ public function getMethodStartLine(File $file, LineRange $range)
         return $method->getStartLine();
     }
 
+    public function getFunctionEndLine(File $file, LineRange $range)
+    {
+        $function = $this->findMatchingFunction($file, $range);
+
+        if ($function === null) {
+            throw new \InvalidArgumentException("Could not find function end line.");
+        }
+
+        return $function->getEndLine();
+    }
+
+    public function getFunctionStartLine(File $file, LineRange $range)
+    {
+        $function = $this->findMatchingFunction($file, $range);
+
+        if ($function === null) {
+            throw new \InvalidArgumentException("Could not find function start line.");
+        }
+
+        return $function->getStartLine();
+    }
+
     public function getLineOfLastPropertyDefinedInScope(File $file, $lastLine)
     {
         $this->broker = new Broker(new Memory);
@@ -91,6 +113,16 @@ public function isInsideMethod(File $file, LineRange $range)
         return $this->findMatchingMethod($file, $range) !== null;
     }
 
+    public function isInsideFunction(File $file, LineRange $range)
+    {
+        return $this->findMatchingFunction($file, $range) !== null;
+    }
+
+    public function isLocalScope(File $file, LineRange $range)
+    {
+        return $this->isInsideMethod($file, $range) || $this->isInsideFunction($file, $range);
+    }
+
     /**
      * @param File $file
      * @return PhpClass[]
@@ -137,4 +169,24 @@ private function findMatchingMethod(File $file, LineRange $range)
 
         return $foundMethod;
     }
+
+    private function findMatchingFunction(File $file, LineRange $range)
+    {
+        $foundFunction = null;
+
+        $this->broker = new Broker(new Memory);
+        $file = $this->broker->processString($file->getCode(), $file->getRelativePath(), true);
+        $lastLine = $range->getEnd();
+
+        foreach ($file->getNamespaces() as $namespace) {
+            foreach ($namespace->getFunctions() as $function) {
+                if ($function->getStartLine() < $lastLine && $lastLine < $function->getEndLine()) {
+                    $foundFunction = $function;
+                    break;
+                }
+            }
+        }
+
+        return $foundFunction;
+    }
 }

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

@@ -39,7 +39,7 @@ public function refactor(File $file, $line, Variable $oldName, Variable $newName
         $this->newName = $newName;
         $this->oldName = $oldName;
 
-        $this->assertIsInsideMethod();
+        $this->assertIsLocalScope();
 
         $this->assertVariableIsLocal($this->oldName);
         $this->assertVariableIsLocal($this->newName);

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

@@ -59,6 +59,13 @@ protected function assertIsInsideMethod()
         }
     }
 
+    protected function assertIsLocalScope()
+    {
+        if ( ! $this->codeAnalysis->isLocalScope($this->file, LineRange::fromSingleLine($this->line)) ) {
+            throw RefactoringException::rangeIsNotLocalScope(LineRange::fromSingleLine($this->line));
+        }
+    }
+
     protected function startEditingSession()
     {
         $buffer = $this->editor->openBuffer($this->file);
@@ -75,7 +82,11 @@ protected function completeEditingSession()
 
     protected function getDefinedVariables()
     {
-        $selectedMethodLineRange = $this->codeAnalysis->findMethodRange($this->file, LineRange::fromSingleLine($this->line));
+        if ($this->codeAnalysis->isInsideFunction($this->file, LineRange::fromSingleLine($this->line))) {
+            $selectedMethodLineRange = $this->codeAnalysis->findFunctionRange($this->file, LineRange::fromSingleLine($this->line));
+        } else {
+            $selectedMethodLineRange = $this->codeAnalysis->findMethodRange($this->file, LineRange::fromSingleLine($this->line));
+        }
 
         $definedVariables = $this->variableScanner->scanForVariables(
             $this->file, $selectedMethodLineRange

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

@@ -45,4 +45,12 @@ static public function rangeIsNotInsideMethod(LineRange $range)
             $range->getStart(), $range->getEnd()
         ));
     }
+
+    static public function rangeIsNotLocalScope(LineRange $range)
+    {
+        return new self(sprintf(
+            'The range %d-%d is not inside a method or a function.',
+            $range->getStart(), $range->getEnd()
+        ));
+    }
 }

src/main/QafooLabs/Refactoring/Domain/Services/CodeAnalysis.php

@@ -40,12 +40,42 @@ abstract public function getMethodStartLine(File $file, LineRange $range);
      */
     abstract public function getMethodEndLine(File $file, LineRange $range);
 
+    /**
+     * Get the function start line
+     *
+     * @param File $file
+     * @param LineRange $range
+     *
+     * @return int
+     */
+    abstract public function getFunctionStartLine(File $file, LineRange $range);
+
+    /**
+     * Get the function end line
+     *
+     * @param File $file
+     * @param LineRange $range
+     *
+     * @return int
+     */
+    abstract public function getFunctionEndLine(File $file, LineRange $range);
+
     /**
      * @param File $file
      * @param int $line
      */
     abstract public function getLineOfLastPropertyDefinedInScope(File $file, $line);
 
+    /**
+     * Check if the line range is inside a local scope. A local scope being a method or a function.
+     *
+     * @param File $file
+     * @param LineRange $range
+     *
+     * @return bool
+     */
+    abstract public function isLocalScope(File $file, LineRange $range);
+
     /**
      * Check if the line range is inside exactly one class method.
      *
@@ -56,6 +86,16 @@ abstract public function getLineOfLastPropertyDefinedInScope(File $file, $line);
      */
     abstract public function isInsideMethod(File $file, LineRange $range);
 
+    /**
+     * Check if the line range is inside a function.
+     *
+     * @param File $file
+     * @param LineRange $range
+     *
+     * @return bool
+     */
+    abstract public function isInsideFunction(File $file, LineRange $range);
+
     /**
      * Find all classes in the file.
      *
@@ -79,5 +119,21 @@ public function findMethodRange(File $file, LineRange $range)
 
         return LineRange::fromLines($methodStartLine, $methodEndLine);
     }
+
+    /**
+     * From a range within a method, find the start and end range of that method.
+     *
+     * @param File $file
+     * @param LineRange $range
+     *
+     * @return LineRange
+     */
+    public function findFunctionRange(File $file, LineRange $range)
+    {
+        $methodStartLine = $this->getFunctionStartLine($file, $range);
+        $methodEndLine = $this->getFunctionEndLine($file, $range);
+
+        return LineRange::fromLines($methodStartLine, $methodEndLine);
+    }
 }