Variable refactoring dependent on cursor point

Summary: By using (thing-at-point 'symbol), the refactoring command becomes highly dependent on the placement of the point at the time the refactoring command is called. By using 'sexp, the placement of the point doesn't matter. The tests were never catching this because it only shows up when php-mode is actually enabled. The tests have been updated to cover this situation. I have also expanded them to verify that we never break snake case functionality as well. Fixes #4
keelerm84 · Nov 24, 2017 · d06dabd · d06dabd
1 parent de47bb7
commit d06dabd
Show file tree

Hide file tree

Showing 7 changed files with 117 additions and 9 deletions.
diff --git a/Cask b/Cask
@@ -4,4 +4,5 @@
 
 (development
     (depends-on "ecukes")
-    (depends-on "espuds"))
+    (depends-on "espuds")
+    (depends-on "php-mode"))
diff --git a/features/convert-local.feature b/features/convert-local.feature
@@ -16,12 +16,59 @@ Feature: Convert Local to Instance Variable
         }
     }
     """
+    And I turn on php-mode
     And I turn on php-refactor-mode
-    And I go to word "$localVariable"
+    And I place the cursor before "$localVariable"
     And I press "C-c r lv"
     Then I should see "private $localVariable"
     And I should not see pattern "^ *$localVariable"
 
+  Scenario: A local variable should be converted to an instance variable when point is in middle of variable
+    When I open temp file "convert-local-to-instance-variable"
+    And I insert:
+    """
+    <?php
+
+    class ConvertLocalToInstanceVariable
+    {
+        public function internalMethod()
+        {
+            $localVariable = "This needs to be an instance variable";
+
+            echo $localVariable;
+        }
+    }
+    """
+    And I turn on php-mode
+    And I turn on php-refactor-mode
+    And I place the cursor after "$localV"
+    And I press "C-c r lv"
+    Then I should see "private $localVariable"
+    And I should not see pattern "^ *$localVariable"
+
+  Scenario: A local variable should be converted to an instance variable when using snake case
+    When I open temp file "convert-local-to-instance-variable"
+    And I insert:
+    """
+    <?php
+
+    class ConvertLocalToInstanceVariable
+    {
+        public function internalMethod()
+        {
+            $local_variable = "This needs to be an instance variable";
+
+            echo $local_variable;
+        }
+    }
+    """
+    And I turn on php-mode
+    And I turn on php-refactor-mode
+    And I place the cursor before "$local_variable"
+    And I press "C-c r lv"
+    Then I should see "private $local_variable"
+    And I should not see pattern "^ *$local_variable"
+
   Scenario: Converting local variable is an undoable operation
     When I open temp file "convert-local-to-instance-variable"
     And I insert:
@@ -38,8 +85,9 @@ Feature: Convert Local to Instance Variable
         }
     }
     """
+    And I turn on php-mode
     And I turn on php-refactor-mode
-    And I go to word "$localVariable"
+    And I place the cursor before "$localVariable"
     And I press "C-c r lv"
     And I press "C-_"
     Then I should not see "private $localVariable"

diff --git a/features/extract-method.feature b/features/extract-method.feature
@@ -17,8 +17,9 @@ Feature: Extract a Method
         }
     }
     """
+    And I turn on php-mode
     And I turn on php-refactor-mode
-    And I go to word "$localVariable"
+    And I place the cursor before "$localVariable"
     And I set the mark
     And I go to word "World"
     And I start an action chain
@@ -65,8 +66,9 @@ Feature: Extract a Method
         }
     }
     """
+    And I turn on php-mode
     And I turn on php-refactor-mode
-    And I go to word "$localVariable"
+    And I place the cursor before "$localVariable"
     And I set the mark
     And I go to word "World"
     And I start an action chain

diff --git a/features/optimize-use.feature b/features/optimize-use.feature
@@ -18,6 +18,7 @@ Feature: Optimize Use
         }
     }
     """
+    And I turn on php-mode
     And I turn on php-refactor-mode
     And I press "C-c r ou"
     Then I should see "use Top\Level\Domain\Name"
@@ -42,6 +43,7 @@ Feature: Optimize Use
         }
     }
     """
+    And I turn on php-mode
     And I turn on php-refactor-mode
     And I press "C-c r ou"
     And I press "C-_"

diff --git a/features/rename-local.feature b/features/rename-local.feature
@@ -16,15 +16,68 @@ Feature: Rename Local Variable
         }
     }
     """
+    And I turn on php-mode
     And I turn on php-refactor-mode
-    And I go to word "$localVariable"
+    And I place the cursor before "$localVariable"
     And I start an action chain
     And I press "C-c r rv"
     And I type "renamedVariable"
     And I execute the action chain
     Then I should not see "$localVariable"
     And I should see "$renamedVariable"
 
+  Scenario: A variable should be renamed when point is in middle of variable
+    When I open temp file "rename-local-variable"
+    And I insert:
+    """
+    <?php
+
+    class RenameLocalVariable
+    {
+        public function internalMethod()
+        {
+            $localVariable = "This variable needs renamed.";
+
+            echo $localVariable;
+        }
+    }
+    """
+    And I turn on php-mode
+    And I turn on php-refactor-mode
+    And I place the cursor after "$localV"
+    And I start an action chain
+    And I press "C-c r rv"
+    And I type "renamedVariable"
+    And I execute the action chain
+    Then I should not see "$localVariable"
+    And I should see "$renamedVariable"
+
+  Scenario: A variable should be renamed when using snake case
+    When I open temp file "rename-local-variable"
+    And I insert:
+    """
+    <?php
+
+    class RenameLocalVariable
+    {
+        public function internalMethod()
+        {
+            $local_variable = "This variable needs renamed.";
+
+            echo $local_variable;
+        }
+    }
+    """
+    And I turn on php-mode
+    And I turn on php-refactor-mode
+    And I place the cursor before "$local_variable"
+    And I start an action chain
+    And I press "C-c r rv"
+    And I type "renamed_variable"
+    And I execute the action chain
+    Then I should not see "$local_variable"
+    And I should see "$renamed_variable"
+
   Scenario: Renaming a variable is an undoable operation
     When I open temp file "rename-local-variable"
     And I insert:
@@ -41,8 +94,9 @@ Feature: Rename Local Variable
         }
     }
     """
+    And I turn on php-mode
     And I turn on php-refactor-mode
-    And I go to word "$localVariable"
+    And I place the cursor before "$localVariable"
     And I start an action chain
     And I press "C-c r rv"
     And I type "renamedVariable"

diff --git a/features/support/env.el b/features/support/env.el
@@ -5,6 +5,7 @@
 
 (add-to-list 'load-path php-refactor-root-path)
 
+(require 'php-mode)
 (require 'php-refactor-mode)
 (require 'espuds)
 (require 'ert)

diff --git a/php-refactor-mode.el b/php-refactor-mode.el
@@ -79,7 +79,7 @@
    "convert-local-to-instance-variable"
    (buffer-file-name)
    (php-refactor--get-effective-line-number-as-string)
-   (thing-at-point 'symbol)))
+   (thing-at-point 'sexp)))
 
 (defun php-refactor--optimize-use ()
   "Optimizes the use of Fully qualified names in a file."
@@ -111,7 +111,7 @@ END is the ending position of the selected region."
      "rename-local-variable"
      (buffer-file-name)
      (php-refactor--get-effective-line-number-as-string)
-     (thing-at-point 'symbol)
+     (thing-at-point 'sexp)
      renamed)))
 
 (defun php-refactor--get-effective-line-number-as-string ()