fixed casting empty embedded schemas with use_parent_field_for_type

Author: dimakula

lib/polymorphic_embed.ex

@@ -125,7 +125,11 @@ defmodule PolymorphicEmbed do
 
     raise_if_invalid_options(field, field_opts)
 
-    %{array?: array?, types_metadata: types_metadata} = field_opts
+    %{
+      array?: array?,
+      use_parent_field_for_type: parent_field_for_type,
+      types_metadata: types_metadata
+    } = field_opts
 
     required = Keyword.get(cast_opts, :required, false)
     with = Keyword.get(cast_opts, :with, nil)
@@ -172,7 +176,8 @@ defmodule PolymorphicEmbed do
       {:ok, nil} when not required ->
         Ecto.Changeset.put_change(changeset, field, nil)
 
-      {:ok, map} when map == %{} and not array? ->
+      {:ok, map}
+      when map == %{} and not array? and is_nil(parent_field_for_type) and not required ->
         changeset
 
       {:ok, params_for_field} when array? ->

test/polymorphic_embed_test.exs

@@ -228,6 +228,69 @@ defmodule PolymorphicEmbedTest do
              insert_result
   end
 
+  test "infer type from parent field and cast an empty embed" do
+    generator = :polymorphic
+    reminder_module = get_module(Reminder, generator)
+
+    reminder_attrs = %{
+      date: DateTime.utc_now(),
+      text: "This is a reminder #{generator}",
+      type: "not_provided",
+      channel4: %{}
+    }
+
+    insert_result =
+      struct(reminder_module)
+      |> reminder_module.changeset(reminder_attrs)
+      |> Repo.insert()
+
+    assert {:ok, %{id: id, channel4: %PolymorphicEmbed.Channel.NotProvided{}}} =
+             insert_result
+
+    assert %{channel4: %PolymorphicEmbed.Channel.NotProvided{}} = Repo.get!(reminder_module, id)
+  end
+
+  test "cast an empty embed with no type if the embedded field is not required" do
+    generator = :polymorphic
+    reminder_module = get_module(Reminder, generator)
+
+    reminder_attrs = %{
+      date: DateTime.utc_now(),
+      text: "This is a reminder #{generator}",
+      channel2: %{}
+    }
+
+    insert_result =
+      struct(reminder_module)
+      |> reminder_module.changeset(reminder_attrs)
+      |> Repo.insert()
+
+    assert {:ok, %{id: id, channel2: nil}} = insert_result
+
+    assert %{channel2: nil} = Repo.get!(reminder_module, id)
+  end
+
+  test "cannot cast an empty embed when no type can be inferred but the embed is required" do
+    generator = :polymorphic
+    reminder_module = get_module(Reminder, generator)
+
+    reminder_attrs = %{
+      date: DateTime.utc_now(),
+      text: "This is a reminder #{generator}",
+      channel2: %{}
+    }
+
+    insert_result =
+      struct(reminder_module)
+      |> reminder_module.changeset(reminder_attrs, channel2_required?: true)
+      |> Repo.insert()
+
+    assert {:error, changeset} = insert_result
+
+    assert changeset.errors == [channel2: {"is invalid", []}]
+    refute changeset.valid?
+  end
+
   test "validations before casting polymorphic embed still work" do
     for generator <- @generators do
       reminder_module = get_module(Reminder, generator)

test/support/models/polymorphic/channel/not_provided.ex

@@ -0,0 +1,11 @@
+defmodule PolymorphicEmbed.Channel.NotProvided do
+  use Ecto.Schema
+  import Ecto.Changeset
+
+  embedded_schema do
+  end
+
+  def changeset(struct, attrs) do
+    cast(struct, attrs, [])
+  end
+end

test/support/models/polymorphic/reminder.ex

@@ -45,7 +45,8 @@ defmodule PolymorphicEmbed.Reminder do
     polymorphic_embeds_one(:channel4,
       types: [
         sms: PolymorphicEmbed.Channel.SMS,
-        email: PolymorphicEmbed.Channel.Email
+        email: PolymorphicEmbed.Channel.Email,
+        not_provided: PolymorphicEmbed.Channel.NotProvided
       ],
       on_replace: :update,
       use_parent_field_for_type: :type
@@ -82,12 +83,14 @@ defmodule PolymorphicEmbed.Reminder do
     timestamps()
   end
 
-  def changeset(struct, values) do
+  def changeset(struct, values, opts \\ []) do
+    channel2_required? = Keyword.get(opts, :channel2_required?, false)
+
     struct
     |> cast(values, [:date, :text, :type])
     |> validate_required(:date)
     |> cast_polymorphic_embed(:channel)
-    |> cast_polymorphic_embed(:channel2)
+    |> cast_polymorphic_embed(:channel2, required: channel2_required?)
     |> cast_polymorphic_embed(:channel3)
     |> cast_polymorphic_embed(:channel4)
     |> cast_polymorphic_embed(:contexts,