Deprecate Exception.format_entry in favor of Exception.format_stacktrace_entry

Author: José Valim

CHANGELOG.md

@@ -35,6 +35,7 @@
 
 * deprecations
   * [Code] `Code.eval` is deprecated in favor of `Code.eval_string`
+  * [Exception] `Exception.format_entry` is deprecated in favor of `Exception.format_stacktrace_entry`
   * [ExUnit] `assert left inlist right` is deprecated in favor of `assert left in right`
   * [IO] `IO.getb` is deprecated in favor of `IO.getn`
   * [List] `List.member?/2` is deprecated in favor of `Enum.member?/2`

lib/elixir/lib/exception.ex

@@ -150,33 +150,39 @@ defmodule Exception do
     ErlangError[original: other]
   end
 
+  @doc false
+  def format_entry(entry, cwd // nil) do
+    IO.write "[WARNING] Exception.format_stacktrace is deprecated, please use Exception.format_stacktrace_entry instead\n#{Exception.format_stacktrace}"
+    format_stacktrace_entry(entry, cwd)
+  end
+
   @doc """
   Receives a tuple representing a stacktrace entry and formats it.
   The current working directory may be given as argument, which
   is used to prettify the stacktrace.
   """
-  def format_entry(entry, cwd // nil)
+  def format_stacktrace_entry(entry, cwd // nil)
 
   # From Macro.Env.stacktrace
-  def format_entry({ module, :__MODULE__, 0, file_line }, cwd) do
+  def format_stacktrace_entry({ module, :__MODULE__, 0, file_line }, cwd) do
     "#{format_file_line(file_line, cwd)}#{inspect module} (module)"
   end
 
   # From :elixir_compiler
-  def format_entry({ _module, :__MODULE__, 2, file_line }, cwd) do
+  def format_stacktrace_entry({ _module, :__MODULE__, 2, file_line }, cwd) do
     "#{format_file_line(file_line, cwd)}(module)"
   end
 
   # From :elixir_compiler
-  def format_entry({ _module, :__FILE__, 2, file_line }, cwd) do
+  def format_stacktrace_entry({ _module, :__FILE__, 2, file_line }, cwd) do
     "#{format_file_line(file_line, cwd)}(file)"
   end
 
-  def format_entry({module, fun, arity, file_line}, cwd) do
+  def format_stacktrace_entry({module, fun, arity, file_line}, cwd) do
     "#{format_file_line(file_line, cwd)}#{format_module_fun_arity(module, fun, arity)}"
   end
 
-  def format_entry({fun, arity, file_line}, cwd) do
+  def format_stacktrace_entry({fun, arity, file_line}, cwd) do
     "#{format_file_line(file_line, cwd)}#{format_fun_arity(fun, arity)}"
   end
 
@@ -198,7 +204,7 @@ defmodule Exception do
 
     case trace do
       [] -> "\n"
-      s  -> "    " <> Enum.map_join(s, "\n    ", format_entry(&1)) <> "\n"
+      s  -> "    " <> Enum.map_join(s, "\n    ", format_stacktrace_entry(&1)) <> "\n"
     end
   end
 

lib/elixir/test/elixir/exception_test.exs

@@ -10,32 +10,32 @@ defmodule Kernel.ExceptionTest do
     refute is_exception(a_list)
   end
 
-  test :format_entry_with_no_file_or_line do
-    assert Exception.format_entry({Foo, :bar, [1, 2, 3], []}) == "Foo.bar(1, 2, 3)"
-    assert Exception.format_entry({Foo, :bar, [], []}) == "Foo.bar()"
-    assert Exception.format_entry({Foo, :bar, 1, []}) == "Foo.bar/1"
+  test :format_stacktrace_entry_with_no_file_or_line do
+    assert Exception.format_stacktrace_entry({Foo, :bar, [1, 2, 3], []}) == "Foo.bar(1, 2, 3)"
+    assert Exception.format_stacktrace_entry({Foo, :bar, [], []}) == "Foo.bar()"
+    assert Exception.format_stacktrace_entry({Foo, :bar, 1, []}) == "Foo.bar/1"
   end
 
-  test :format_entry_with_file_and_line do
-    assert Exception.format_entry({Foo, :bar, [], [file: 'file.ex', line: 10]}) == "file.ex:10: Foo.bar()"
-    assert Exception.format_entry({Foo, :bar, [1, 2, 3], [file: 'file.ex', line: 10]}) == "file.ex:10: Foo.bar(1, 2, 3)"
-    assert Exception.format_entry({Foo, :bar, 1, [file: 'file.ex', line: 10]}) == "file.ex:10: Foo.bar/1"
+  test :format_stacktrace_entry_with_file_and_line do
+    assert Exception.format_stacktrace_entry({Foo, :bar, [], [file: 'file.ex', line: 10]}) == "file.ex:10: Foo.bar()"
+    assert Exception.format_stacktrace_entry({Foo, :bar, [1, 2, 3], [file: 'file.ex', line: 10]}) == "file.ex:10: Foo.bar(1, 2, 3)"
+    assert Exception.format_stacktrace_entry({Foo, :bar, 1, [file: 'file.ex', line: 10]}) == "file.ex:10: Foo.bar/1"
   end
 
-  test :format_entry_with_file_and_line_and_cwd do
-    assert Exception.format_entry({Foo, :bar, [], [file: '/foo/file.ex', line: 10]}, "/foo") == "file.ex:10: Foo.bar()"
+  test :format_stacktrace_entry_with_file_and_line_and_cwd do
+    assert Exception.format_stacktrace_entry({Foo, :bar, [], [file: '/foo/file.ex', line: 10]}, "/foo") == "file.ex:10: Foo.bar()"
   end
 
-  test :format_entry_with_file_no_line do
-    assert Exception.format_entry({Foo, :bar, [], [file: 'file.ex']}) == "file.ex: Foo.bar()"
-    assert Exception.format_entry({Foo, :bar, [], [file: 'file.ex', line: 0]}) == "file.ex: Foo.bar()"
-    assert Exception.format_entry({Foo, :bar, [1, 2, 3], [file: 'file.ex']}) == "file.ex: Foo.bar(1, 2, 3)"
-    assert Exception.format_entry({Foo, :bar, 1, [file: 'file.ex']}) == "file.ex: Foo.bar/1"
+  test :format_stacktrace_entry_with_file_no_line do
+    assert Exception.format_stacktrace_entry({Foo, :bar, [], [file: 'file.ex']}) == "file.ex: Foo.bar()"
+    assert Exception.format_stacktrace_entry({Foo, :bar, [], [file: 'file.ex', line: 0]}) == "file.ex: Foo.bar()"
+    assert Exception.format_stacktrace_entry({Foo, :bar, [1, 2, 3], [file: 'file.ex']}) == "file.ex: Foo.bar(1, 2, 3)"
+    assert Exception.format_stacktrace_entry({Foo, :bar, 1, [file: 'file.ex']}) == "file.ex: Foo.bar/1"
   end
 
-  test :format_entry_with_fun do
-    assert Exception.format_entry({fn(x) -> x end, [1], []}) =~ %r"\(1\)"
-    assert Exception.format_entry({fn(x, y) -> { x, y } end, 2, []}) =~ %r"/2"
+  test :format_stacktrace_entry_with_fun do
+    assert Exception.format_stacktrace_entry({fn(x) -> x end, [1], []}) =~ %r"\(1\)"
+    assert Exception.format_stacktrace_entry({fn(x, y) -> { x, y } end, 2, []}) =~ %r"/2"
   end
 
   test :format_module_function_arity do

lib/ex_unit/lib/ex_unit/cli_formatter.ex

@@ -8,7 +8,7 @@ defmodule ExUnit.CLIFormatter do
   @timeout 30_000
   use GenServer.Behaviour
 
-  import Exception, only: [format_entry: 2]
+  import Exception, only: [format_stacktrace_entry: 2]
   defrecord Config, counter: 0, test_failures: [], case_failures: []
 
   ## Behaviour
@@ -157,7 +157,7 @@ defmodule ExUnit.CLIFormatter do
 
   defp print_stacktrace(stacktrace, _case, _test, cwd) do
     IO.puts location_info "stacktrace:"
-    Enum.each stacktrace, fn(s) -> IO.puts stacktrace_info format_entry(s, cwd) end
+    Enum.each stacktrace, fn(s) -> IO.puts stacktrace_info format_stacktrace_entry(s, cwd) end
   end
 
   defp print_time(run_us, nil) do