Fixes #741 Place methods specifically after the last one

phpspec · Jul 14, 2015 · f365af0 · f365af0
1 parent 7402e30
commit f365af0
Show file tree

Hide file tree

Showing 3 changed files with 93 additions and 2 deletions.
diff --git a/features/code_generation/developer_generates_method.feature b/features/code_generation/developer_generates_method.feature
@@ -204,3 +204,60 @@ Feature: Developer generates a method
       }
 
       """
+
+  Scenario: Generating a method in a class with existing methods and new lines
+    Given the spec file "spec/MyNamespace/ExistingMethodSpec.php" contains:
+      """
+      <?php
+
+      namespace spec\MyNamespace;
+
+      use PhpSpec\ObjectBehavior;
+      use Prophecy\Argument;
+
+      class ExistingMethodSpec extends ObjectBehavior
+      {
+          function it_should_do_something()
+          {
+              $this->foo()->shouldReturn('bar');
+          }
+      }
+      """
+    And the class file "src/MyNamespace/ExistingMethod.php" contains:
+      """
+      <?php
+
+      namespace MyNamespace;
+
+      class ExistingMethod
+      {
+          public function existing()
+          {
+              return 'something';
+          }
+
+      }
+
+      """
+    When I run phpspec and answer "y" when asked if I want to generate the code
+    Then the class in "src/MyNamespace/ExistingMethod.php" should contain:
+      """
+      <?php
+
+      namespace MyNamespace;
+
+      class ExistingMethod
+      {
+          public function existing()
+          {
+              return 'something';
+          }
+
+          public function foo()
+          {
+              // TODO: write logic here
+          }
+
+      }
+
+      """
diff --git a/src/PhpSpec/CodeGenerator/Writer/TokenizedCodeWriter.php b/src/PhpSpec/CodeGenerator/Writer/TokenizedCodeWriter.php
@@ -54,7 +54,8 @@ public function insertMethodFirstInClass($class, $method)
     public function insertMethodLastInClass($class, $method)
     {
         if ($this->analyser->classHasMethods($class)) {
-            return $this->writeAtEndOfClass($class, $method, true);
+            $line = $this->analyser->getEndLineOfLastMethod($class);
+            return $this->insertStringAfterLine($class, $method, $line);
         }
 
         return $this->writeAtEndOfClass($class, $method);

diff --git a/src/PhpSpec/Util/ClassFileAnalyser.php b/src/PhpSpec/Util/ClassFileAnalyser.php
@@ -30,6 +30,17 @@ public function getStartLineOfFirstMethod($class)
         return $tokens[$index][2];
     }
 
+    /**
+     * @param string $class
+     * @return int
+     */
+    public function getEndLineOfLastMethod($class)
+    {
+        $tokens = $this->getTokensForClass($class);
+        $index = $this->findIndexOfMethodEnd($tokens, $this->findIndexOfLastMethod($tokens));
+        return $tokens[$index][2];
+    }
+
     /**
      * @param string $class
      * @return bool
@@ -69,7 +80,20 @@ public function getEndLineOfNamedMethod($class, $methodName)
     private function findIndexOfFirstMethod(array $tokens)
     {
         for ($i = 0, $max = count($tokens); $i < $max; $i++) {
-            if (is_array($tokens[$i]) && $tokens[$i][0] === T_FUNCTION) {
+            if ($this->tokenIsFunction($tokens[$i])) {
+                return $i;
+            }
+        }
+    }
+
+    /**
+     * @param array $tokens
+     * @return int
+     */
+    private function findIndexOfLastMethod(array $tokens)
+    {
+        for ($i = count($tokens) - 1; $i >= 0; $i--) {
+            if ($this->tokenIsFunction($tokens[$i])) {
                 return $i;
             }
         }
@@ -199,4 +223,13 @@ private function findIndexOfMethodEnd(array $tokens, $index)
             }
         }
     }
+
+    /**
+     * @param mixed $token
+     * @return bool
+     */
+    private function tokenIsFunction($token)
+    {
+        return is_array($token) && $token[0] === T_FUNCTION;
+    }
 }