[feat] integrate refactorex (#5)

* temp: commented formatter dep imports

* feat: added refactorex as a dependency

* feat: added refactorex as a code action handler

* temp: skipping broken remote control tests

* refactor: less restrict refactorex dependency version

Co-authored-by: Steve Cohen <[email protected]>

* refactor: removed useless test

* feat: range subtree (selection) extraction algorithm - inlined from refactorex

* Revert "feat: range subtree (selection) extraction algorithm - inlined from refactorex"

This reverts commit a362383.

* refactor: using Document.fragment/3 to find the selection, then positioning it

* refactor: improved test infrastructure and multiline selection test

* fix: fixed the formatter import deps problem

* Revert "temp: commented formatter dep imports"

This reverts commit b4ad1ce.

* feat: introducing context.trigger_kind to Code Actions so they can decide when they are triggered

* refactor: adding more supported code actions

* refactor: removed Logger used for debugging

* [bugfix] Only index if there's stuff to index

A colleague found a fun edge case. He added three new empty files to a
project, and Expert wouldn't start. This is because of a divide by
zero error when there are no bytes to index, which causes progress
updates to fail (indexing completed successfully).

This fix checks for this condition and no-ops if there's nothing to index.

* refactor: sort aliases

* refactor: remove unnecessary changes.

* refactor: better naming the test cases

* Revert "temp: skipping broken remote control tests"

This reverts commit 389afbba063341ccde90bad72d0aa1246c9c3a5a.

* Update Nix hash of Mix deps

* fix: removed GenLSP from refactorex so it is not imported into remote_control

* Update Nix hash of Mix deps

* fix: setting up Project before tests

* refactor: bump Sourceror and using updates on Refactorex

* Update Nix hash of Mix deps

---------

Co-authored-by: Steve Cohen <[email protected]>

Author: gp-pereira

apps/common/mix.exs

@@ -35,7 +35,7 @@ defmodule Common.MixProject do
       Mix.Credo.dependency(),
       Mix.Dialyzer.dependency(),
       {:snowflake, "~> 1.0"},
-      {:sourceror, "~> 1.7"},
+      {:sourceror, "~> 1.9"},
       {:stream_data, "~> 1.1", only: [:test], runtime: false},
       {:patch, "~> 0.15", only: [:test], optional: true, runtime: false}
     ]

apps/common/mix.lock

@@ -9,7 +9,7 @@
   "jason": {:hex, :jason, "1.4.4", "b9226785a9aa77b6857ca22832cffa5d5011a667207eb2a0ad56adb5db443b8a", [:mix], [{:decimal, "~> 1.0 or ~> 2.0", [hex: :decimal, repo: "hexpm", optional: true]}], "hexpm", "c5eb0cab91f094599f94d55bc63409236a8ec69a21a67814529e8d5f6cc90b3b"},
   "patch": {:hex, :patch, "0.15.0", "947dd6a8b24a2d2d1137721f20bb96a8feb4f83248e7b4ad88b4871d52807af5", [:mix], [], "hexpm", "e8dadf9b57b30e92f6b2b1ce2f7f57700d14c66d4ed56ee27777eb73fb77e58d"},
   "snowflake": {:hex, :snowflake, "1.0.4", "8433b4e04fbed19272c55e1b7de0f7a1ee1230b3ae31a813b616fd6ef279e87a", [:mix], [], "hexpm", "badb07ebb089a5cff737738297513db3962760b10fe2b158ae3bebf0b4d5be13"},
-  "sourceror": {:hex, :sourceror, "1.7.1", "599d78f4cc2be7d55c9c4fd0a8d772fd0478e3a50e726697c20d13d02aa056d4", [:mix], [], "hexpm", "cd6f268fe29fa00afbc535e215158680a0662b357dc784646d7dff28ac65a0fc"},
+  "sourceror": {:hex, :sourceror, "1.9.0", "3bf5fe2d017aaabe3866d8a6da097dd7c331e0d2d54e59e21c2b066d47f1e08e", [:mix], [], "hexpm", "d20a9dd5efe162f0d75a307146faa2e17b823ea4f134f662358d70f0332fed82"},
   "statistex": {:hex, :statistex, "1.0.0", "f3dc93f3c0c6c92e5f291704cf62b99b553253d7969e9a5fa713e5481cd858a5", [:mix], [], "hexpm", "ff9d8bee7035028ab4742ff52fc80a2aa35cece833cf5319009b52f1b5a86c27"},
   "stream_data": {:hex, :stream_data, "1.1.3", "15fdb14c64e84437901258bb56fc7d80aaf6ceaf85b9324f359e219241353bfb", [:mix], [], "hexpm", "859eb2be72d74be26c1c4f272905667672a52e44f743839c57c7ee73a1a66420"},
 }

apps/lexical_credo/mix.lock

@@ -14,7 +14,7 @@
   "makeup_erlang": {:hex, :makeup_erlang, "1.0.2", "03e1804074b3aa64d5fad7aa64601ed0fb395337b982d9bcf04029d68d51b6a7", [:mix], [{:makeup, "~> 1.0", [hex: :makeup, repo: "hexpm", optional: false]}], "hexpm", "af33ff7ef368d5893e4a267933e7744e46ce3cf1f61e2dccf53a111ed3aa3727"},
   "nimble_parsec": {:hex, :nimble_parsec, "1.4.2", "8efba0122db06df95bfaa78f791344a89352ba04baedd3849593bfce4d0dc1c6", [:mix], [], "hexpm", "4b21398942dda052b403bbe1da991ccd03a053668d147d53fb8c4e0efe09c973"},
   "snowflake": {:hex, :snowflake, "1.0.4", "8433b4e04fbed19272c55e1b7de0f7a1ee1230b3ae31a813b616fd6ef279e87a", [:mix], [], "hexpm", "badb07ebb089a5cff737738297513db3962760b10fe2b158ae3bebf0b4d5be13"},
-  "sourceror": {:hex, :sourceror, "1.7.1", "599d78f4cc2be7d55c9c4fd0a8d772fd0478e3a50e726697c20d13d02aa056d4", [:mix], [], "hexpm", "cd6f268fe29fa00afbc535e215158680a0662b357dc784646d7dff28ac65a0fc"},
+  "sourceror": {:hex, :sourceror, "1.9.0", "3bf5fe2d017aaabe3866d8a6da097dd7c331e0d2d54e59e21c2b066d47f1e08e", [:mix], [], "hexpm", "d20a9dd5efe162f0d75a307146faa2e17b823ea4f134f662358d70f0332fed82"},
   "statistex": {:hex, :statistex, "1.0.0", "f3dc93f3c0c6c92e5f291704cf62b99b553253d7969e9a5fa713e5481cd858a5", [:mix], [], "hexpm", "ff9d8bee7035028ab4742ff52fc80a2aa35cece833cf5319009b52f1b5a86c27"},
   "stream_data": {:hex, :stream_data, "1.1.3", "15fdb14c64e84437901258bb56fc7d80aaf6ceaf85b9324f359e219241353bfb", [:mix], [], "hexpm", "859eb2be72d74be26c1c4f272905667672a52e44f743839c57c7ee73a1a66420"},
 }

apps/proto/mix.lock

@@ -8,7 +8,7 @@
   "file_system": {:hex, :file_system, "1.1.0", "08d232062284546c6c34426997dd7ef6ec9f8bbd090eb91780283c9016840e8f", [:mix], [], "hexpm", "bfcf81244f416871f2a2e15c1b515287faa5db9c6bcf290222206d120b3d43f6"},
   "jason": {:hex, :jason, "1.4.4", "b9226785a9aa77b6857ca22832cffa5d5011a667207eb2a0ad56adb5db443b8a", [:mix], [{:decimal, "~> 1.0 or ~> 2.0", [hex: :decimal, repo: "hexpm", optional: true]}], "hexpm", "c5eb0cab91f094599f94d55bc63409236a8ec69a21a67814529e8d5f6cc90b3b"},
   "snowflake": {:hex, :snowflake, "1.0.4", "8433b4e04fbed19272c55e1b7de0f7a1ee1230b3ae31a813b616fd6ef279e87a", [:mix], [], "hexpm", "badb07ebb089a5cff737738297513db3962760b10fe2b158ae3bebf0b4d5be13"},
-  "sourceror": {:hex, :sourceror, "1.7.1", "599d78f4cc2be7d55c9c4fd0a8d772fd0478e3a50e726697c20d13d02aa056d4", [:mix], [], "hexpm", "cd6f268fe29fa00afbc535e215158680a0662b357dc784646d7dff28ac65a0fc"},
+  "sourceror": {:hex, :sourceror, "1.9.0", "3bf5fe2d017aaabe3866d8a6da097dd7c331e0d2d54e59e21c2b066d47f1e08e", [:mix], [], "hexpm", "d20a9dd5efe162f0d75a307146faa2e17b823ea4f134f662358d70f0332fed82"},
   "statistex": {:hex, :statistex, "1.0.0", "f3dc93f3c0c6c92e5f291704cf62b99b553253d7969e9a5fa713e5481cd858a5", [:mix], [], "hexpm", "ff9d8bee7035028ab4742ff52fc80a2aa35cece833cf5319009b52f1b5a86c27"},
   "stream_data": {:hex, :stream_data, "1.1.3", "15fdb14c64e84437901258bb56fc7d80aaf6ceaf85b9324f359e219241353bfb", [:mix], [], "hexpm", "859eb2be72d74be26c1c4f272905667672a52e44f743839c57c7ee73a1a66420"},
 }

apps/protocol/mix.lock

@@ -9,7 +9,7 @@
   "jason": {:hex, :jason, "1.4.4", "b9226785a9aa77b6857ca22832cffa5d5011a667207eb2a0ad56adb5db443b8a", [:mix], [{:decimal, "~> 1.0 or ~> 2.0", [hex: :decimal, repo: "hexpm", optional: true]}], "hexpm", "c5eb0cab91f094599f94d55bc63409236a8ec69a21a67814529e8d5f6cc90b3b"},
   "patch": {:hex, :patch, "0.15.0", "947dd6a8b24a2d2d1137721f20bb96a8feb4f83248e7b4ad88b4871d52807af5", [:mix], [], "hexpm", "e8dadf9b57b30e92f6b2b1ce2f7f57700d14c66d4ed56ee27777eb73fb77e58d"},
   "snowflake": {:hex, :snowflake, "1.0.4", "8433b4e04fbed19272c55e1b7de0f7a1ee1230b3ae31a813b616fd6ef279e87a", [:mix], [], "hexpm", "badb07ebb089a5cff737738297513db3962760b10fe2b158ae3bebf0b4d5be13"},
-  "sourceror": {:hex, :sourceror, "1.7.1", "599d78f4cc2be7d55c9c4fd0a8d772fd0478e3a50e726697c20d13d02aa056d4", [:mix], [], "hexpm", "cd6f268fe29fa00afbc535e215158680a0662b357dc784646d7dff28ac65a0fc"},
+  "sourceror": {:hex, :sourceror, "1.9.0", "3bf5fe2d017aaabe3866d8a6da097dd7c331e0d2d54e59e21c2b066d47f1e08e", [:mix], [], "hexpm", "d20a9dd5efe162f0d75a307146faa2e17b823ea4f134f662358d70f0332fed82"},
   "statistex": {:hex, :statistex, "1.0.0", "f3dc93f3c0c6c92e5f291704cf62b99b553253d7969e9a5fa713e5481cd858a5", [:mix], [], "hexpm", "ff9d8bee7035028ab4742ff52fc80a2aa35cece833cf5319009b52f1b5a86c27"},
   "stream_data": {:hex, :stream_data, "1.1.3", "15fdb14c64e84437901258bb56fc7d80aaf6ceaf85b9324f359e219241353bfb", [:mix], [], "hexpm", "859eb2be72d74be26c1c4f272905667672a52e44f743839c57c7ee73a1a66420"},
 }

apps/remote_control/lib/lexical/remote_control.ex

@@ -33,7 +33,9 @@ defmodule Lexical.RemoteControl do
 
   defdelegate list_modules, to: :code, as: :all_available
 
-  defdelegate code_actions(document, range, diagnostics, kinds), to: CodeAction, as: :for_range
+  defdelegate code_actions(document, range, diagnostics, kinds, trigger_kind),
+    to: CodeAction,
+    as: :for_range
 
   defdelegate complete(env), to: RemoteControl.Completion, as: :elixir_sense_expand
 

apps/remote_control/lib/lexical/remote_control/api.ex

@@ -44,13 +44,15 @@ defmodule Lexical.RemoteControl.Api do
         %Document{} = document,
         %Range{} = range,
         diagnostics,
-        kinds
+        kinds,
+        trigger_kind
       ) do
     RemoteControl.call(project, RemoteControl, :code_actions, [
       document,
       range,
       diagnostics,
-      kinds
+      kinds,
+      trigger_kind
     ])
   end
 

apps/remote_control/lib/lexical/remote_control/code_action.ex

@@ -18,6 +18,8 @@ defmodule Lexical.RemoteControl.CodeAction do
           | :source_organize_imports
           | :source_fix_all
 
+  @type trigger_kind :: :invoked | :automatic
+
   @type t :: %__MODULE__{
           title: String.t(),
           kind: code_action_kind,
@@ -30,33 +32,35 @@ defmodule Lexical.RemoteControl.CodeAction do
     Handlers.ReplaceWithUnderscore,
     Handlers.OrganizeAliases,
     Handlers.AddAlias,
-    Handlers.RemoveUnusedAlias
+    Handlers.RemoveUnusedAlias,
+    Handlers.Refactorex
   ]
 
   @spec new(Lexical.uri(), String.t(), code_action_kind(), Changes.t()) :: t()
   def new(uri, title, kind, changes) do
     %__MODULE__{uri: uri, title: title, changes: changes, kind: kind}
   end
 
-  @spec for_range(Document.t(), Range.t(), [Diagnostic.t()], [code_action_kind] | :all) :: [t()]
-  def for_range(%Document{} = doc, %Range{} = range, diagnostics, kinds) do
-    results =
-      Enum.flat_map(@handlers, fn handler ->
-        if applies?(kinds, handler) do
-          handler.actions(doc, range, diagnostics)
-        else
-          []
-        end
-      end)
-
-    results
+  @spec for_range(
+          Document.t(),
+          Range.t(),
+          [Diagnostic.t()],
+          [code_action_kind] | :all,
+          trigger_kind
+        ) :: [t()]
+  def for_range(%Document{} = doc, %Range{} = range, diagnostics, kinds, trigger_kind) do
+    Enum.flat_map(@handlers, fn handler ->
+      if handle_kinds?(handler, kinds) and handle_trigger_kind?(handler, trigger_kind) do
+        handler.actions(doc, range, diagnostics)
+      else
+        []
+      end
+    end)
   end
 
-  defp applies?(:all, _handler_module) do
-    true
-  end
+  defp handle_kinds?(_handler, :all), do: true
+  defp handle_kinds?(handler, kinds), do: kinds -- handler.kinds() != kinds
 
-  defp applies?(kinds, handler_module) do
-    kinds -- handler_module.kinds() != kinds
-  end
+  defp handle_trigger_kind?(handler, trigger_kind),
+    do: handler.trigger_kind() in [trigger_kind, :all]
 end

apps/remote_control/lib/lexical/remote_control/code_action/handler.ex

@@ -6,4 +6,5 @@ defmodule Lexical.RemoteControl.CodeAction.Handler do
 
   @callback actions(Document.t(), Range.t(), [Diagnostic.t()]) :: [CodeAction.t()]
   @callback kinds() :: [CodeAction.code_action_kind()]
+  @callback trigger_kind() :: CodeAction.trigger_kind() | :all
 end

apps/remote_control/lib/lexical/remote_control/code_action/handlers/add_alias.ex

@@ -44,6 +44,9 @@ defmodule Lexical.RemoteControl.CodeAction.Handlers.AddAlias do
     [:quick_fix]
   end
 
+  @impl CodeAction.Handler
+  def trigger_kind, do: :all
+
   defp build_code_action(%Analysis{} = analysis, range, current_aliases, potential_alias_module) do
     case Ast.Module.safe_split(potential_alias_module, as: :atoms) do
       {:erlang, _} ->