return metadata on signatures

Author: lukaszsamson

lib/elixir_sense/core/introspection.ex

@@ -150,7 +150,14 @@ defmodule ElixirSense.Core.Introspection do
     for {f, a} <- BuiltinFunctions.all(), f == fun do
       spec = BuiltinFunctions.get_specs({f, a}) |> Enum.join("\n")
       params = BuiltinFunctions.get_args({f, a})
-      %{name: Atom.to_string(fun), params: params, documentation: "Built-in function", spec: spec}
+
+      %{
+        name: Atom.to_string(fun),
+        params: params,
+        documentation: "Built-in function",
+        spec: spec,
+        metadata: %{builtin: true}
+      }
     end
   end
 
@@ -165,7 +172,7 @@ defmodule ElixirSense.Core.Introspection do
             doc = extract_summary_from_docs(text)
 
             spec = get_spec_as_string(mod, fun, arity, kind, metadata)
-            %{name: fun_str, params: fun_args, documentation: doc, spec: spec}
+            %{name: fun_str, params: fun_args, documentation: doc, spec: spec, metadata: metadata}
           end
 
         case results do
@@ -185,6 +192,7 @@ defmodule ElixirSense.Core.Introspection do
   defp get_spec_from_typespec(mod, fun) do
     # TypeInfo.get_function_specs does fallback to behaviours
     function_specs = TypeInfo.get_function_specs(mod, fun, :any)
+    app = ElixirSense.Core.Applications.get_application(mod)
 
     results =
       for {behaviour, specs} <- function_specs, {{_name, _arity}, [params | _]} = spec <- specs do
@@ -194,7 +202,8 @@ defmodule ElixirSense.Core.Introspection do
           name: Atom.to_string(fun),
           params: params,
           documentation: "",
-          spec: spec |> spec_to_string(if(behaviour, do: :callback, else: :spec))
+          spec: spec |> spec_to_string(if(behaviour, do: :callback, else: :spec)),
+          metadata: if(behaviour, do: %{implementing: behaviour, app: app}, else: %{app: app})
         }
       end
 
@@ -216,11 +225,20 @@ defmodule ElixirSense.Core.Introspection do
         f == fun do
       dummy_params = if a == 0, do: [], else: Enum.map(1..a, fn _ -> "term" end)
 
+      metadata =
+        if {f, a} in BuiltinFunctions.erlang_builtin_functions(mod) do
+          %{builtin: true, app: :erts}
+        else
+          app = ElixirSense.Core.Applications.get_application(mod)
+          %{app: app}
+        end
+
       %{
         name: Atom.to_string(fun),
         params: dummy_params,
         documentation: "",
-        spec: ""
+        spec: "",
+        metadata: metadata
       }
     end
   end

lib/elixir_sense/core/metadata.ex

@@ -88,7 +88,7 @@ defmodule ElixirSense.Core.Metadata do
 
   if Version.match?(System.version(), "< 1.15.0-dev") do
     # return early if cursor env already found by parser replacing line
-    # this helps on < 1.15 and braks tests on later versions
+    # this helps on < 1.15 and breaks tests on later versions
     def get_cursor_env(%__MODULE__{cursor_env: {_, env}}, _position, _surround) do
       env
     end
@@ -429,7 +429,8 @@ defmodule ElixirSense.Core.Metadata do
         name: Atom.to_string(function),
         params: args,
         documentation: Introspection.extract_summary_from_docs(docs),
-        spec: spec
+        spec: spec,
+        metadata: %{builtin: true}
       }
     end
   end
@@ -459,7 +460,8 @@ defmodule ElixirSense.Core.Metadata do
         name: Atom.to_string(function),
         params: params |> Enum.with_index() |> Enum.map(&Introspection.param_to_var/1),
         documentation: Introspection.extract_summary_from_docs(function_info.doc),
-        spec: spec
+        spec: spec,
+        metadata: function_info.meta
       }
     end)
   end
@@ -485,7 +487,8 @@ defmodule ElixirSense.Core.Metadata do
         name: Atom.to_string(type),
         params: type_info.args |> List.last(),
         documentation: Introspection.extract_summary_from_docs(type_info.doc),
-        spec: spec
+        spec: spec,
+        metadata: type_info.meta
       }
     end)
   end
@@ -495,17 +498,17 @@ defmodule ElixirSense.Core.Metadata do
       NormalizedCode.callback_documentation(behaviour)
       |> Map.new()
 
-    meta = %{implementing: behaviour}
-    spec = Introspection.get_spec_as_string(nil, f, a, kind, meta)
     app = ElixirSense.Core.Applications.get_application(behaviour)
+    meta = %{implementing: behaviour, implementing_module_app: app}
+
+    spec = Introspection.get_spec_as_string(nil, f, a, kind, meta)
 
     case docs[{f, a}] do
       nil ->
         {spec, "", meta}
 
       {_signatures, docs, callback_meta, mime_type} ->
-        {spec, docs |> NormalizedCode.extract_docs(mime_type, behaviour, app),
-         callback_meta |> Map.merge(meta)}
+        {spec, docs |> NormalizedCode.extract_docs(mime_type, behaviour, app), callback_meta}
     end
   end
 

lib/elixir_sense/core/type_info.ex

@@ -66,17 +66,19 @@ defmodule ElixirSense.Core.TypeInfo do
   def get_signatures(mod, type, code_docs) when not is_nil(mod) and not is_nil(type) do
     case code_docs || NormalizedCode.get_docs(mod, :type_docs) do
       docs when is_list(docs) ->
-        for {{t, arity}, _, _, text, _metadata} <- docs, t == type do
+        for {{t, arity}, _, _, text, metadata} <- docs, t == type do
           {_kind, {_name, _def, args}} = get_type_spec(mod, type, arity)
           type_args = Enum.map(args, &(&1 |> elem(2) |> Atom.to_string()))
           type_str = Atom.to_string(type)
           doc = Introspection.extract_summary_from_docs(text)
           typedef = get_type_spec(mod, type, arity)
           spec = format_type_spec(typedef, line_length: @param_option_spec_line_length)
-          %{name: type_str, params: type_args, documentation: doc, spec: spec}
+          %{name: type_str, params: type_args, documentation: doc, spec: spec, metadata: metadata}
         end
 
       nil ->
+        app = ElixirSense.Core.Applications.get_application(mod)
+
         for {kind, {name, _type, args}} = typedef <- Typespec.get_types(mod),
             name == type,
             kind in [:type, :opaque] do
@@ -86,7 +88,8 @@ defmodule ElixirSense.Core.TypeInfo do
             name: Atom.to_string(name),
             params: type_args,
             documentation: "",
-            spec: format_type_spec(typedef)
+            spec: format_type_spec(typedef),
+            metadata: %{app: app}
           }
         end
     end
@@ -104,7 +107,8 @@ defmodule ElixirSense.Core.TypeInfo do
               %{spec: ast} -> spec_ast_to_string(ast)
               %{signature: signature} -> signature
               _ -> "#{type}"
-            end
+            end,
+        metadata: %{builtin: true}
       }
     end
   end

test/elixir_sense/core/metadata_test.exs

@@ -40,12 +40,13 @@ defmodule ElixirSense.Core.MetadataTest do
       |> Metadata.get_function_signatures(MyModule, :func)
 
     assert signatures == [
-             %{name: "func", params: ["par"], documentation: "", spec: ""},
+             %{name: "func", params: ["par"], documentation: "", spec: "", metadata: %{}},
              %{
                name: "func",
                params: ["tuple", "optional \\\\ true"],
                documentation: "",
-               spec: ""
+               spec: "",
+               metadata: %{}
              }
            ]
   end