Remove get_in/1

Author: José Valim

lib/elixir/lib/kernel.ex

@@ -1715,68 +1715,6 @@ defmodule Kernel do
     Access.get_and_update(data, h, &get_and_update_in(&1, t, fun))
   end
 
-  @doc """
-  Gets a value from a nested structure via the given `path`.
-
-  This is similar to `get_in/2`, except the path is extracted via
-  a macro rather than passing a list. For example:
-
-      get_in(opts[:foo][:bar])
-
-  Is equivalent to:
-
-      get_in(opts, [:foo, :bar])
-
-  Note that in order for this macro to work, the complete path must always
-  be visible by this macro.
-
-  ## Examples
-
-      iex> users = %{"josé" => %{age: 27}, "eric" => %{age: 23}}
-      iex> get_in(users["josé"][:age])
-      27
-
-      iex> users = %{"josé" => %{age: 27}, "eric" => %{age: 23}}
-      iex> get_in(users["josé"].age)
-      27
-
-  ## Paths
-
-  A path may start with a variable, local or remote call, and must be
-  followed by one or more:
-
-  * `foo[bar]` - access a field. In case an intermediate field is not
-    present or returns nil, an empty map is used;
-
-  * `foo.bar` - access a map/struct field. In case the field is not
-    present, an error is raised;
-
-  Here are some valid paths:
-
-      users["josé"][:age]
-      users["josé"].age
-      User.all["josé"].age
-      all_users()["josé"].age
-
-  Here are some invalid ones:
-
-      # Does a remote call after the initial value
-      users["josé"].do_something(arg1, arg2)
-
-      # Does not access any field
-      users
-
-  """
-  defmacro get_in(path) do
-    [h|t] = unnest(path, [], "get_in/2")
-    Enum.reduce(t, h, fn
-      {:access, key}, acc ->
-        quote do: Access.get(unquote(acc), unquote(key))
-      {:map, key}, acc ->
-        quote do: Access.Map.get!(unquote(acc), unquote(key))
-    end)
-  end
-
   @doc """
   Puts a value in a nested structure via the given `path`.
 
@@ -1791,7 +1729,7 @@ defmodule Kernel do
 
   Note that in order for this macro to work, the complete path must always
   be visible by this macro. For more information about the supported path
-  expressions, please check `get_in/1` docs.
+  expressions, please check `get_and_update_in/2` docs.
 
   ## Examples
 
@@ -1824,7 +1762,7 @@ defmodule Kernel do
 
   Note that in order for this macro to work, the complete path must always
   be visible by this macro. For more information about the supported path
-  expressions, please check `get_in/1` docs.
+  expressions, please check `get_and_update_in/2` docs.
 
   ## Examples
 
@@ -1856,15 +1794,40 @@ defmodule Kernel do
       get_and_update_in(opts, [:foo, :bar], &{&1, &1 + 1})
 
   Note that in order for this macro to work, the complete path must always
-  be visible by this macro. For more information about the supported path
-  expressions, please check `get_in/1` docs.
+  be visible by this macro. See the Paths section below.
 
   ## Examples
 
       iex> users = %{"josé" => %{age: 27}, "eric" => %{age: 23}}
       iex> get_and_update_in(users["josé"][:age], &{&1, &1 + 1})
       {27, %{"josé" => %{age: 28}, "eric" => %{age: 23}}}
 
+  ## Paths
+
+  A path may start with a variable, local or remote call, and must be
+  followed by one or more:
+
+  * `foo[bar]` - access a field. In case an intermediate field is not
+    present or returns nil, an empty map is used;
+
+  * `foo.bar` - access a map/struct field. In case the field is not
+    present, an error is raised;
+
+  Here are some valid paths:
+
+      users["josé"][:age]
+      users["josé"].age
+      User.all["josé"].age
+      all_users()["josé"].age
+
+  Here are some invalid ones:
+
+      # Does a remote call after the initial value
+      users["josé"].do_something(arg1, arg2)
+
+      # Does not access any field
+      users
+
   """
   defmacro get_and_update_in(path, fun) do
     [h|t] = unnest(path, [], "get_and_update_in/2")

lib/elixir/test/elixir/kernel_test.exs

@@ -196,22 +196,6 @@ defmodule KernelTest do
     end
   end
 
-  test "get_in/1" do
-    users = %{"josé" => %{age: 27}, "eric" => %{age: 23}}
-    assert get_in(users["josé"][:age]) == 27
-    assert get_in(users["dave"][:age]) == nil
-
-    assert get_in(users["josé"].age) == 27
-
-    assert_raise ArgumentError, fn ->
-      get_in(users["dave"].age)
-    end
-
-    assert_raise KeyError, fn ->
-      get_in(users["eric"].unknown)
-    end
-  end
-
   test "put_in/3" do
     users = %{"josé" => %{age: 27}, "eric" => %{age: 23}}
 
@@ -330,17 +314,17 @@ defmodule KernelTest do
   test "paths" do
     map = empty_map()
 
-    assert get_in(map[:foo]) == nil
-    assert get_in(empty_map()[:foo]) == nil
-    assert get_in(KernelTest.empty_map()[:foo]) == nil
-    assert get_in(__MODULE__.empty_map()[:foo]) == nil
+    assert put_in(map[:foo], "bar") == %{foo: "bar"}
+    assert put_in(empty_map()[:foo], "bar") == %{foo: "bar"}
+    assert put_in(KernelTest.empty_map()[:foo], "bar") == %{foo: "bar"}
+    assert put_in(__MODULE__.empty_map()[:foo], "bar") == %{foo: "bar"}
 
     assert_raise ArgumentError, ~r"access at least one field,", fn ->
-      Code.eval_quoted(quote(do: get_in(map)), [])
+      Code.eval_quoted(quote(do: put_in(map, "bar")), [])
     end
 
     assert_raise ArgumentError, ~r"must start with a variable, local or remote call", fn ->
-      Code.eval_quoted(quote(do: get_in(map.foo(1, 2)[:bar])), [])
+      Code.eval_quoted(quote(do: put_in(map.foo(1, 2)[:bar], "baz")), [])
     end
   end