Rename :end metadata to less ambiguous :closing

Signed-off-by: José Valim <[email protected]>

Author: José Valim

lib/elixir/lib/code/formatter.ex

@@ -1156,7 +1156,7 @@ defmodule Code.Formatter do
         {left_doc, _join, state} =
           args_to_algebra_with_comments(
             left,
-            Keyword.delete(meta, :end),
+            Keyword.delete(meta, :closing),
             skip_parens?,
             :force_comma,
             join,
@@ -1847,7 +1847,7 @@ defmodule Code.Formatter do
   end
 
   defp add_max_line_to_last_clause([{op, meta, args}], max_line) do
-    [{op, [end: [line: max_line]] ++ meta, args}]
+    [{op, [closing: [line: max_line]] ++ meta, args}]
   end
 
   defp add_max_line_to_last_clause([clause | clauses], max_line) do
@@ -2239,7 +2239,7 @@ defmodule Code.Formatter do
   end
 
   defp end_line(meta) do
-    meta[:end][:line] || @min_line
+    meta[:closing][:line] || @min_line
   end
 
   ## Algebra helpers

lib/elixir/src/elixir_parser.yrl

@@ -653,12 +653,12 @@ line_from_location({Line, _Column, _}) -> Line.
 is_eol({_, _, Eol}) -> is_integer(Eol) and (Eol > 0).
 
 end_meta(Token) ->
-  [{format, block}, {'end', meta_from_location(?location(Token))}].
+  [{format, block}, {closing, meta_from_location(?location(Token))}].
 
-meta_from_token_with_end(Begin, End) ->
+meta_from_token_with_closing(Begin, End) ->
   case ?formatter_metadata() of
     true ->
-      [{'end', meta_from_location(?location(End))} | meta_from_token(Begin)];
+      [{closing, meta_from_location(?location(End))} | meta_from_token(Begin)];
     false ->
       meta_from_token(Begin)
   end.
@@ -740,7 +740,7 @@ eol_pair(Left, Right) ->
     true ->
       [
         {eol, is_eol(?location(Left)) and is_eol(?location(Right))},
-        {'end', meta_from_location(?location(Right))}
+        {closing, meta_from_location(?location(Right))}
       ];
     false ->
       []
@@ -828,7 +828,7 @@ build_identifier({_, Location, Identifier}, Args) ->
 build_fn(Fn, Stab, End) ->
   case check_stab(Stab, none) of
     stab ->
-      Meta = eol_op(?location(Fn)) ++ meta_from_token_with_end(Fn, End),
+      Meta = eol_op(?location(Fn)) ++ meta_from_token_with_closing(Fn, End),
       {fn, Meta, collect_stab(Stab, [], [])};
     block ->
       return_error(meta_from_token(Fn), "expected anonymous functions to be defined with -> inside: ", "'fn'")
@@ -902,7 +902,7 @@ charlist_part({Begin, End, Tokens}) ->
   Form = string_tokens_parse(Tokens),
   Meta =
     case ?formatter_metadata() of
-      true -> [{'end', meta_from_location(End)} | meta_from_location(Begin)];
+      true -> [{closing, meta_from_location(End)} | meta_from_location(Begin)];
       false -> meta_from_location(Begin)
     end,
   {{'.', Meta, ['Elixir.Kernel', to_string]}, Meta, [Form]}.
@@ -915,7 +915,7 @@ string_part({Begin, End, Tokens}) ->
   Form = string_tokens_parse(Tokens),
   Meta =
     case ?formatter_metadata() of
-      true -> [{'end', meta_from_location(End)} | meta_from_location(Begin)];
+      true -> [{closing, meta_from_location(End)} | meta_from_location(Begin)];
       false -> meta_from_location(Begin)
     end,
   {'::', Meta, [{{'.', Meta, ['Elixir.Kernel', to_string]}, Meta, [Form]}, {binary, Meta, nil}]}.
@@ -943,7 +943,7 @@ build_stab(Stab) ->
 build_stab(Before, Stab, After) ->
   case build_stab(Stab) of
     {'__block__', Meta, Block} ->
-      {'__block__', Meta ++ meta_from_token_with_end(Before, After), Block};
+      {'__block__', Meta ++ meta_from_token_with_closing(Before, After), Block};
     Other ->
       Other
   end.

lib/elixir/test/elixir/code_test.exs

@@ -252,25 +252,27 @@ defmodule CodeTest do
       assert string_to_quoted.(":one") == {:__block__, [line: 1], [:one]}
 
       args = [[{:__block__, [original: '1', line: 1], [1]}]]
-      assert string_to_quoted.("[1]") == {:__block__, [eol: false, end: [line: 1], line: 1], args}
+
+      assert string_to_quoted.("[1]") ==
+               {:__block__, [eol: false, closing: [line: 1], line: 1], args}
 
       args = [{{:__block__, [line: 1], [:ok]}, {:__block__, [line: 1], [:test]}}]
 
       assert string_to_quoted.("{:ok, :test}") ==
-               {:__block__, [eol: false, end: [line: 1], line: 1], args}
+               {:__block__, [eol: false, closing: [line: 1], line: 1], args}
 
       assert string_to_quoted.(~s("""\nhello\n""")) ==
                {:__block__, [format: :bin_heredoc, line: 1], ["hello\n"]}
 
       assert string_to_quoted.("'''\nhello\n'''") ==
                {:__block__, [format: :list_heredoc, line: 1], ['hello\n']}
 
-      left = {:__block__, [original: '1', line: 1, end: [line: 1], line: 1], [1]}
+      left = {:__block__, [original: '1', line: 1, closing: [line: 1], line: 1], [1]}
       right = {:__block__, [format: :string, line: 1], ["hello"]}
       args = [{:->, [line: 1], [[left], right]}]
 
       assert string_to_quoted.(~s[fn (1) -> "hello" end]) ==
-               {:fn, [end: [line: 1], line: 1], args}
+               {:fn, [closing: [line: 1], line: 1], args}
     end
 
     test "adds newlines information to blocks when :formatter_metadata (private) is given" do
@@ -285,11 +287,11 @@ defmodule CodeTest do
       """
 
       args = [
-        {:one, [eol: false, end: [line: 1], line: 1], []},
-        {:two, [newlines: 0, eol: false, end: [line: 1], line: 1], []},
-        {:three, [newlines: 1, eol: false, end: [line: 2], line: 2], []},
-        {:four, [newlines: 2, eol: false, end: [line: 4], line: 4], []},
-        {:five, [newlines: 3, eol: false, end: [line: 7], line: 7], []}
+        {:one, [eol: false, closing: [line: 1], line: 1], []},
+        {:two, [newlines: 0, eol: false, closing: [line: 1], line: 1], []},
+        {:three, [newlines: 1, eol: false, closing: [line: 2], line: 2], []},
+        {:four, [newlines: 2, eol: false, closing: [line: 4], line: 4], []},
+        {:five, [newlines: 3, eol: false, closing: [line: 7], line: 7], []}
       ]
 
       assert Code.string_to_quoted!(file, formatter_metadata: true) == {:__block__, [], args}