Merge pull request #1270 from elixir-lsp/fix-1038-end-of-symbol

Resolve goto-def/refs/hover at the end of a symbol (#1038 / #1027)

Author: lukaszsamson

apps/language_server/test/providers/definition/locator_test.exs

@@ -18,6 +18,43 @@ defmodule ElixirLS.LanguageServer.Providers.Definition.LocatorTest do
     assert nil == Locator.definition("__MODULE__", 1, 1)
   end
 
+  # elixir-lsp/elixir-ls#1038: goto-definition must work when the cursor is at the very end of a
+  # symbol (one column past its last character), not only when it is on a character of the symbol.
+  test "find definition with the cursor at the end of the symbol (#1038)" do
+    buffer = """
+    defmodule MyModule do
+      def my_func(a), do: a
+
+      def caller do
+        my_func(1)
+      end
+    end
+    """
+
+    # `my_func` is on line 5 at columns 5..11; column 12 is the end of the symbol.
+    for col <- [8, 11, 12] do
+      assert %Location{type: :function, line: 2} = Locator.definition(buffer, 5, col),
+             "expected my_func/1 definition at line 5 column #{col}"
+    end
+  end
+
+  # elixir-lsp/elixir-ls#1027: at the end of an alias that is the LHS of a remote call, the cursor
+  # resolves to the module, not the function.
+  test "cursor at the end of an alias before `.` resolves the module (#1027)" do
+    buffer = """
+    defmodule MyModule do
+      alias ElixirSenseExample.ModuleWithFunctions
+
+      def caller do
+        ModuleWithFunctions.function_arity_zero()
+      end
+    end
+    """
+
+    # `ModuleWithFunctions` is on line 5 at columns 5..23; column 24 is on the `.` (its end).
+    assert %Location{type: :module} = Locator.definition(buffer, 5, 24)
+  end
+
   test "find module definition inside Phoenix's scope" do
     _define_existing_atom = ExampleWeb
 

apps/language_server/test/providers/hover_test.exs

@@ -56,6 +56,32 @@ defmodule ElixirLS.LanguageServer.Providers.HoverTest do
            )
   end
 
+  # elixir-lsp/elixir-ls#1027: at the end of the alias `IO` (on the `.` before `inspect`) the module
+  # is hovered, not the remote function - the same trailing-edge resolution the definition locator uses.
+  test "elixir module hover at the end of an alias before `.` (#1027)" do
+    text = """
+    defmodule MyModule do
+      def hello() do
+        IO.inspect("hello world")
+      end
+    end
+    """
+
+    # `IO` is on line 3, columns 5-6; the caret sits just past it, on the `.` (0-based char 6).
+    {line, char} = {2, 6}
+    parser_context = ParserContextBuilder.from_string(text)
+
+    {line, char} =
+      SourceFile.lsp_position_to_elixir(parser_context.source_file.text, {line, char})
+
+    assert {:ok,
+            %GenLSP.Structures.Hover{
+              contents: %GenLSP.Structures.MarkupContent{kind: "markdown", value: v}
+            }} = Hover.hover(parser_context, line, char)
+
+    assert String.starts_with?(v, "```elixir\nIO\n```\n\n*module*")
+  end
+
   test "function hover" do
     text = """
     defmodule MyModule do

apps/language_server/test/providers/implementation/locator_test.exs

@@ -80,6 +80,22 @@ defmodule ElixirLS.LanguageServer.Providers.Implementation.LocatorTest do
              "ElixirSenseExample.ExampleBehaviourWithDocCallbackNoImpl"
   end
 
+  # elixir-lsp/elixir-ls#1038: implementations resolve with the cursor at the end of the behaviour
+  # alias (one column past its last character), not only when it is on a character of the name.
+  test "find implementations of behaviour module with cursor at the end of the alias (#1038)" do
+    buffer = """
+    defmodule ElixirSenseExample.ExampleBehaviourWithDoc do
+    end
+    """
+
+    # the alias starts at column 11 and is 42 characters long, so column 53 is its end (on the space).
+    mid = Locator.implementations(buffer, 1, 32)
+    at_end = Locator.implementations(buffer, 1, 53)
+
+    assert length(at_end) == 2
+    assert at_end == mid
+  end
+
   test "find protocol implementations" do
     buffer = """
     defprotocol ElixirSenseExample.ExampleProtocol do

apps/language_server/test/providers/references/locator_test.exs

@@ -158,6 +158,27 @@ defmodule ElixirLS.LanguageServer.Providers.References.LocatorTest do
              %{start: %{line: 65, column: 79}, end: %{line: 65, column: 83}}
   end
 
+  # elixir-lsp/elixir-ls#1038: references resolve with the cursor at the end of the symbol
+  # (one column past its last character), not only when it is on a character of the name.
+  test "find references with cursor at the end of a function definition name (#1038)", %{
+    trace: trace
+  } do
+    buffer = """
+    defmodule ElixirSense.Providers.ReferencesTest.Modules.Callee1 do
+      def func() do
+        IO.puts ""
+      end
+    end
+    """
+
+    # `func` is on line 2 at columns 7-10; column 11 is the end of the symbol (on the `(`).
+    mid = Locator.references(buffer, 2, 10, trace)
+    at_end = Locator.references(buffer, 2, 11, trace)
+
+    assert at_end != []
+    assert at_end == mid
+  end
+
   test "find references with cursor over a function definition with default arg", %{trace: trace} do
     buffer = """
     defmodule ElixirSenseExample.Subscription do

dep_versions.exs

@@ -1,5 +1,5 @@
 [
-  elixir_sense: "89eda3fc4df9cea0d70c528f3e7e240a70c860f8",
+  elixir_sense: "9460c60651c2419d81fa447d70d3e1596e30dab0",
   dialyxir_vendored: "accfec9393079abc4a82b7e79a4997f59f085b67",
   jason_v: "f1c10fa9c445cb9f300266122ef18671054b2330",
   erl2ex_vendored: "04f93e55f46d35d0aa3c149616f2c7a6a1ad9311",

mix.lock

@@ -2,7 +2,7 @@
   "benchee": {:hex, :benchee, "1.1.0", "f3a43817209a92a1fade36ef36b86e1052627fd8934a8b937ac9ab3a76c43062", [:mix], [{:deep_merge, "~> 1.0", [hex: :deep_merge, repo: "hexpm", optional: false]}, {:statistex, "~> 1.0", [hex: :statistex, repo: "hexpm", optional: false]}], "hexpm", "7da57d545003165a012b587077f6ba90b89210fd88074ce3c60ce239eb5e6d93"},
   "deep_merge": {:hex, :deep_merge, "1.0.0", "b4aa1a0d1acac393bdf38b2291af38cb1d4a52806cf7a4906f718e1feb5ee961", [:mix], [], "hexpm", "ce708e5f094b9cd4e8f2be4f00d2f4250c4095be93f8cd6d018c753894885430"},
   "dialyxir_vendored": {:git, "https://github.com/elixir-lsp/dialyxir.git", "accfec9393079abc4a82b7e79a4997f59f085b67", [ref: "accfec9393079abc4a82b7e79a4997f59f085b67"]},
-  "elixir_sense": {:git, "https://github.com/elixir-lsp/elixir_sense.git", "89eda3fc4df9cea0d70c528f3e7e240a70c860f8", [ref: "89eda3fc4df9cea0d70c528f3e7e240a70c860f8"]},
+  "elixir_sense": {:git, "https://github.com/elixir-lsp/elixir_sense.git", "9460c60651c2419d81fa447d70d3e1596e30dab0", [ref: "9460c60651c2419d81fa447d70d3e1596e30dab0"]},
   "erl2ex_vendored": {:git, "https://github.com/elixir-lsp/erl2ex.git", "04f93e55f46d35d0aa3c149616f2c7a6a1ad9311", [ref: "04f93e55f46d35d0aa3c149616f2c7a6a1ad9311"]},
   "erlex_vendored": {:git, "https://github.com/elixir-lsp/erlex.git", "50b8307f90451a5d0288fb239fb6405b5ca1f1a4", [ref: "50b8307f90451a5d0288fb239fb6405b5ca1f1a4"]},
   "jason_v": {:git, "https://github.com/elixir-lsp/jason.git", "f1c10fa9c445cb9f300266122ef18671054b2330", [ref: "f1c10fa9c445cb9f300266122ef18671054b2330"]},