Skip to content

Commit aa9c8ea

Browse files
committed
Implements Enhancement elixir-ecto#3890
1 parent 19cba74 commit aa9c8ea

2 files changed

Lines changed: 271 additions & 130 deletions

File tree

‎lib/ecto/embedded.ex‎

Lines changed: 52 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -49,9 +49,10 @@ defmodule Ecto.Embedded do
4949
if cardinality == :one, do: @embeds_one_on_replace_opts, else: @on_replace_opts
5050

5151
unless opts[:on_replace] in on_replace_opts do
52-
raise ArgumentError, "invalid `:on_replace` option for #{inspect Keyword.fetch!(opts, :field)}. " <>
53-
"The only valid options are: " <>
54-
Enum.map_join(on_replace_opts, ", ", &"`#{inspect &1}`")
52+
raise ArgumentError,
53+
"invalid `:on_replace` option for #{inspect(Keyword.fetch!(opts, :field))}. " <>
54+
"The only valid options are: " <>
55+
Enum.map_join(on_replace_opts, ", ", &"`#{inspect(&1)}`")
5556
end
5657

5758
struct(%Embedded{}, opts)
@@ -66,7 +67,8 @@ defmodule Ecto.Embedded do
6667

6768
def load(nil, _fun, %{cardinality: :many}), do: {:ok, []}
6869

69-
def load(value, fun, %{cardinality: :many, related: schema, field: field}) when is_list(value) do
70+
def load(value, fun, %{cardinality: :many, related: schema, field: field})
71+
when is_list(value) do
7072
{:ok, Enum.map(value, &load_field(field, schema, &1, fun))}
7173
end
7274

@@ -79,7 +81,7 @@ defmodule Ecto.Embedded do
7981
end
8082

8183
defp load_field(field, _schema, value, _fun) do
82-
raise ArgumentError, "cannot load embed `#{field}`, expected a map but got: #{inspect value}"
84+
raise ArgumentError, "cannot load embed `#{field}`, expected a map but got: #{inspect(value)}"
8385
end
8486

8587
@impl Ecto.ParameterizedType
@@ -89,7 +91,8 @@ defmodule Ecto.Embedded do
8991
{:ok, dump_field(field, schema, value, schema.__schema__(:dump), fun, _one_embed? = true)}
9092
end
9193

92-
def dump(value, fun, %{cardinality: :many, related: schema, field: field}) when is_list(value) do
94+
def dump(value, fun, %{cardinality: :many, related: schema, field: field})
95+
when is_list(value) do
9396
types = schema.__schema__(:dump)
9497
{:ok, Enum.map(value, &dump_field(field, schema, &1, types, fun, _one_embed? = false))}
9598
end
@@ -105,20 +108,22 @@ defmodule Ecto.Embedded do
105108
defp dump_field(field, schema, value, _types, _dumper, one_embed?) do
106109
one_or_many =
107110
if one_embed?,
108-
do: "a struct #{inspect schema} value",
109-
else: "a list of #{inspect schema} struct values"
111+
do: "a struct #{inspect(schema)} value",
112+
else: "a list of #{inspect(schema)} struct values"
110113

111114
raise ArgumentError,
112-
"cannot dump embed `#{field}`, expected #{one_or_many} but got: #{inspect value}"
115+
"cannot dump embed `#{field}`, expected #{one_or_many} but got: #{inspect(value)}"
113116
end
114117

115118
@impl Ecto.ParameterizedType
116119
def cast(nil, %{cardinality: :one}), do: {:ok, nil}
120+
117121
def cast(%{__struct__: schema} = struct, %{cardinality: :one, related: schema}) do
118122
{:ok, struct}
119123
end
120124

121125
def cast(nil, %{cardinality: :many}), do: {:ok, []}
126+
122127
def cast(value, %{cardinality: :many, related: schema}) when is_list(value) do
123128
if Enum.all?(value, &Kernel.match?(%{__struct__: ^schema}, &1)) do
124129
{:ok, value}
@@ -152,10 +157,10 @@ defmodule Ecto.Embedded do
152157
end
153158

154159
defp prepare(embeds, types, adapter, repo, repo_action) do
155-
Enum.reduce embeds, embeds, fn {name, changeset_or_changesets}, acc ->
160+
Enum.reduce(embeds, embeds, fn {name, changeset_or_changesets}, acc ->
156161
{:embed, embed} = Map.get(types, name)
157162
Map.put(acc, name, prepare_each(embed, changeset_or_changesets, adapter, repo, repo_action))
158-
end
163+
end)
159164
end
160165

161166
defp prepare_each(%{cardinality: :one}, nil, _adapter, _repo, _repo_action) do
@@ -176,20 +181,21 @@ defmodule Ecto.Embedded do
176181
do: prepared
177182
end
178183

179-
defp to_struct(%Changeset{valid?: false}, _action,
180-
%{related: schema}, _adapter) do
181-
raise ArgumentError, "changeset for embedded #{inspect schema} is invalid, " <>
182-
"but the parent changeset was not marked as invalid"
184+
defp to_struct(%Changeset{valid?: false}, _action, %{related: schema}, _adapter) do
185+
raise ArgumentError,
186+
"changeset for embedded #{inspect(schema)} is invalid, " <>
187+
"but the parent changeset was not marked as invalid"
183188
end
184189

185-
defp to_struct(%Changeset{data: %{__struct__: actual}}, _action,
186-
%{related: expected}, _adapter) when actual != expected do
187-
raise ArgumentError, "expected changeset for embedded schema `#{inspect expected}`, " <>
188-
"got: #{inspect actual}"
190+
defp to_struct(%Changeset{data: %{__struct__: actual}}, _action, %{related: expected}, _adapter)
191+
when actual != expected do
192+
raise ArgumentError,
193+
"expected changeset for embedded schema `#{inspect(expected)}`, " <>
194+
"got: #{inspect(actual)}"
189195
end
190196

191-
defp to_struct(%Changeset{changes: changes, data: schema}, :update,
192-
_embed, _adapter) when changes == %{} do
197+
defp to_struct(%Changeset{changes: changes, data: schema}, :update, _embed, _adapter)
198+
when changes == %{} do
193199
schema
194200
end
195201

@@ -198,8 +204,8 @@ defmodule Ecto.Embedded do
198204
end
199205

200206
defp to_struct(%Changeset{data: data} = changeset, action, %{related: schema}, adapter) do
201-
%{data: struct, changes: changes} = changeset =
202-
maybe_surface_changes(changeset, data, schema, action)
207+
%{data: struct, changes: changes} =
208+
changeset = maybe_surface_changes(changeset, data, schema, action)
203209

204210
embeds = prepare(changeset, schema.__schema__(:embeds), adapter, action)
205211

@@ -223,10 +229,12 @@ defmodule Ecto.Embedded do
223229

224230
Enum.reduce(Enum.reverse(changeset.prepare), changeset, fn fun, acc ->
225231
case fun.(acc) do
226-
%Ecto.Changeset{} = acc -> acc
232+
%Ecto.Changeset{} = acc ->
233+
acc
234+
227235
other ->
228-
raise "expected function #{inspect fun} given to Ecto.Changeset.prepare_changes/2 " <>
229-
"to return an Ecto.Changeset, got: `#{inspect other}`"
236+
raise "expected function #{inspect(fun)} given to Ecto.Changeset.prepare_changes/2 " <>
237+
"to return an Ecto.Changeset, got: `#{inspect(other)}`"
230238
end
231239
end)
232240
end
@@ -237,18 +245,27 @@ defmodule Ecto.Embedded do
237245

238246
defp check_action!(:replace, action, %{on_replace: :delete} = embed),
239247
do: check_action!(:delete, action, embed)
248+
240249
defp check_action!(:update, :insert, %{related: schema}),
241-
do: raise(ArgumentError, "got action :update in changeset for embedded #{inspect schema} while inserting")
250+
do:
251+
raise(
252+
ArgumentError,
253+
"got action :update in changeset for embedded #{inspect(schema)} while inserting"
254+
)
255+
242256
defp check_action!(action, _, _), do: action
243257

244258
defp autogenerate_id(changes, _struct, :insert, schema, adapter) do
245259
case schema.__schema__(:autogenerate_id) do
246260
{key, _source, :binary_id} ->
247261
Map.put_new_lazy(changes, key, fn -> adapter.autogenerate(:embed_id) end)
262+
248263
{_key, :id} ->
249-
raise ArgumentError, "embedded schema `#{inspect schema}` cannot autogenerate `:id` primary keys, " <>
250-
"those are typically used for auto-incrementing constraints. " <>
251-
"Maybe you meant to use `:binary_id` instead?"
264+
raise ArgumentError,
265+
"embedded schema `#{inspect(schema)}` cannot autogenerate `:id` primary keys, " <>
266+
"those are typically used for auto-incrementing constraints. " <>
267+
"Maybe you meant to use `:binary_id` instead?"
268+
252269
nil ->
253270
changes
254271
end
@@ -258,6 +275,7 @@ defmodule Ecto.Embedded do
258275
for {_, nil} <- Ecto.primary_key(struct) do
259276
raise Ecto.NoPrimaryKeyValueError, struct: struct
260277
end
278+
261279
changes
262280
end
263281

@@ -283,4 +301,8 @@ defmodule Ecto.Embedded do
283301
def build(%Embedded{related: related}, _owner) do
284302
related.__struct__
285303
end
304+
305+
def preload_info(_embed) do
306+
{:embed}
307+
end
286308
end

0 commit comments

Comments
 (0)