Simplify tests with rename_example

- Make rename_example a `.ex` file so we can later test multi-file refactors - Simplify rename_example to make it easier to follow - Extract some common patterns out in the tests
Tuxified · Oct 21, 2022 · 1daf1c8 · 1daf1c8
1 parent 2e76985
commit 1daf1c8
Show file tree

Hide file tree

Showing 3 changed files with 128 additions and 174 deletions.
diff --git a/apps/language_server/test/providers/rename_test.exs b/apps/language_server/test/providers/rename_test.exs
@@ -36,25 +36,18 @@ defmodule ElixirLS.LanguageServer.Providers.RenameTest do
       # _a + b
       {line, char} = {3, 5}
 
-      assert {:ok, %{"documentChanges" => changes}} =
-               Rename.rename(%SourceFile{text: text, version: 0}, @fake_uri, line, char, "test")
-
-      assert %{
-               "textDocument" => %{
-                 "uri" => @fake_uri,
-                 "version" => 1
-               },
-               "edits" => [
-                 %{
-                   "range" => %{end: %{character: 11, line: 1}, start: %{character: 10, line: 1}},
-                   "newText" => "test"
-                 },
-                 %{
-                   "range" => %{end: %{character: 5, line: 2}, start: %{character: 4, line: 2}},
-                   "newText" => "test"
-                 }
-               ]
-             } == List.first(changes)
+      edits =
+        Rename.rename(%SourceFile{text: text, version: 0}, @fake_uri, line, char, "test")
+        |> assert_return_structure_and_get_edits(@fake_uri, 1)
+
+      expected_edits =
+        [
+          %{line: 1, start_char: 10, end_char: 11},
+          %{line: 2, start_char: 4, end_char: 5}
+        ]
+        |> get_expected_edits("test")
+
+      assert sort_edit_by_start_line(edits) == expected_edits
     end
 
     test "nema -> name" do
@@ -69,112 +62,91 @@ defmodule ElixirLS.LanguageServer.Providers.RenameTest do
       # "Hello " <> ne_ma
       {line, char} = {3, 19}
 
-      assert {:ok, %{"documentChanges" => [changes]}} =
-               Rename.rename(
-                 %SourceFile{text: text, version: 0},
-                 @fake_uri,
-                 line,
-                 char,
-                 "name"
-               )
-
-      assert %{
-               "textDocument" => %{
-                 "uri" => @fake_uri,
-                 "version" => 1
-               },
-               "edits" => [
-                 %{
-                   "range" => %{end: %{character: 16, line: 1}, start: %{character: 12, line: 1}},
-                   "newText" => "name"
-                 },
-                 %{
-                   "range" => %{end: %{character: 20, line: 2}, start: %{character: 16, line: 2}},
-                   "newText" => "name"
-                 }
-               ]
-             } == changes
+      edits =
+        Rename.rename(
+          %SourceFile{text: text, version: 0},
+          @fake_uri,
+          line,
+          char,
+          "name"
+        )
+        |> assert_return_structure_and_get_edits(@fake_uri, 1)
+
+      expected_edits =
+        [
+          %{line: 1, start_char: 12, end_char: 16},
+          %{line: 2, start_char: 16, end_char: 20}
+        ]
+        |> get_expected_edits("name")
+
+      assert sort_edit_by_start_line(edits) == expected_edits
     end
   end
 
   describe "renaming local function" do
-    test "create_message -> store_message" do
-      file_path = FixtureHelpers.get_path("rename_example.exs")
+    test "subtract -> new_subtract" do
+      file_path = FixtureHelpers.get_path("rename_example.ex")
       text = File.read!(file_path)
       uri = SourceFile.path_to_uri(file_path)
 
-      # |> _create_message
-      {line, char} = {28, 8}
-
-      assert {:ok, %{"documentChanges" => [changes]}} =
-               Rename.rename(
-                 %SourceFile{text: text, version: 0},
-                 uri,
-                 line,
-                 char,
-                 "store_message"
-               )
-
-      assert %{
-               "textDocument" => %{
-                 "uri" => uri,
-                 "version" => 1
-               },
-               "edits" => [
-                 %{
-                   "newText" => "store_message",
-                   "range" => %{end: %{character: 21, line: 43}, start: %{character: 7, line: 43}}
-                 },
-                 %{
-                   "newText" => "store_message",
-                   "range" => %{end: %{character: 21, line: 27}, start: %{character: 7, line: 27}}
-                 }
-               ]
-             } == changes
+      #     d = subtract(a, b)
+      {line, char} = {6, 10}
+
+      edits =
+        Rename.rename(
+          %SourceFile{text: text, version: 0},
+          uri,
+          line,
+          char,
+          "new_subtract"
+        )
+        |> assert_return_structure_and_get_edits(uri, 1)
+
+      expected_edits =
+        [
+          %{line: 5, start_char: 8, end_char: 16},
+          %{line: 13, start_char: 7, end_char: 15}
+        ]
+        |> get_expected_edits("new_subtract")
+
+      assert sort_edit_by_start_line(edits) == expected_edits
     end
 
     test "rename function with multiple heads: handle_error -> handle_errors" do
-      file_path = FixtureHelpers.get_path("rename_example.exs")
+      file_path = FixtureHelpers.get_path("rename_example.ex")
       text = File.read!(file_path)
       uri = SourceFile.path_to_uri(file_path)
 
-      {line, char} = {29, 8}
-
-      assert {:ok, %{"documentChanges" => [changes]}} =
-               Rename.rename(
-                 %SourceFile{text: text, version: 0},
-                 uri,
-                 line,
-                 char,
-                 "handle_errors"
-               )
-
-      assert %{
-               "textDocument" => %{
-                 "uri" => uri,
-                 "version" => 1
-               },
-               "edits" => [
-                 %{
-                   "newText" => "handle_errors",
-                   "range" => %{end: %{character: 19, line: 39}, start: %{character: 7, line: 39}}
-                 },
-                 %{
-                   "newText" => "handle_errors",
-                   "range" => %{end: %{character: 19, line: 37}, start: %{character: 7, line: 37}}
-                 },
-                 %{
-                   "newText" => "handle_errors",
-                   "range" => %{end: %{character: 19, line: 28}, start: %{character: 7, line: 28}}
-                 }
-               ]
-             } == changes
+      #     c = add(a, b)
+      {line, char} = {5, 9}
+
+      edits =
+        Rename.rename(
+          %SourceFile{text: text, version: 0},
+          uri,
+          line,
+          char,
+          "new_add"
+        )
+        |> assert_return_structure_and_get_edits(uri, 1)
+
+      expected_edits =
+        [
+          %{line: 4, start_char: 8, end_char: 11},
+          %{line: 6, start_char: 4, end_char: 7},
+          %{line: 9, start_char: 7, end_char: 10},
+          %{line: 10, start_char: 7, end_char: 10},
+          %{line: 11, start_char: 7, end_char: 10}
+        ]
+        |> get_expected_edits("new_add")
+
+      assert sort_edit_by_start_line(edits) == expected_edits
     end
   end
 
   describe "not yet (fully) supported/working renaming cases" do
     test "rename started with cursor at function definition" do
-      file_path = FixtureHelpers.get_path("rename_example.exs")
+      file_path = FixtureHelpers.get_path("rename_example.ex")
       text = File.read!(file_path)
       uri = SourceFile.path_to_uri(file_path)
 
@@ -212,4 +184,38 @@ defmodule ElixirLS.LanguageServer.Providers.RenameTest do
              } == List.first(changes)
     end
   end
+
+  defp get_expected_edits(edits, new_text) when is_list(edits),
+    do: Enum.map(edits, &get_expected_edits(&1, new_text))
+
+  defp get_expected_edits(%{line: line, start_char: start_char, end_char: end_char}, new_text) do
+    %{
+      "newText" => new_text,
+      "range" => %{
+        start: %{line: line, character: start_char},
+        end: %{line: line, character: end_char}
+      }
+    }
+  end
+
+  defp assert_return_structure_and_get_edits(rename_result, uri, version) do
+    assert {:ok,
+            %{
+              "documentChanges" => [
+                %{
+                  "textDocument" => %{
+                    "uri" => ^uri,
+                    "version" => ^version
+                  },
+                  "edits" => edits
+                }
+              ]
+            }} = rename_result
+
+    edits
+  end
+
+  defp sort_edit_by_start_line(edits) do
+    Enum.sort(edits, &(&1["range"].start.line < &2["range"].start.line))
+  end
 end
diff --git a/apps/language_server/test/support/fixtures/rename_example.ex b/apps/language_server/test/support/fixtures/rename_example.ex
@@ -0,0 +1,15 @@
+defmodule ElixirLS.Test.RenameExample do
+  def main do
+    a = 5
+    b = 10
+    c = add(a, b)
+    d = subtract(a, b)
+    add(c, d)
+  end
+
+  defp add(a, b)
+  defp add(a, b) when is_integer(a) and is_integer(b), do: a + b
+  defp add(a, b) when is_binary(a) and is_binary(b), do: a <> b
+
+  defp subtract(a, b), do: a - b
+end
diff --git a/apps/language_server/test/support/fixtures/rename_example.exs b/apps/language_server/test/support/fixtures/rename_example.exs