make option names more explicit

Author: woylie

CHANGELOG.md

@@ -2,6 +2,13 @@
 
 ## Unreleased
 
+## [0.1.1] - 2021-08-28
+
+### Changed
+
+- Rename `mode` options `:replace` and `:delete` to `{:action, :replace}` and
+  `{:action, :delete}`.
+
 ## [0.1.0] - 2021-08-28
 
 initial release

README.md

@@ -11,7 +11,7 @@ Add `ecto_nested_changeset` to your list of dependencies in `mix.exs`:
 ```elixir
 def deps do
   [
-    {:ecto_nested_changeset, "~> 0.1.0"}
+    {:ecto_nested_changeset, "~> 0.1.1"}
   ]
 end
 ```
@@ -39,7 +39,7 @@ category
 |> Ecto.Changeset.change()
 |> append_at(:posts, %Post{title: "Padawan", comments: []})
 |> prepend_at([:posts, 0, :comments], %Comment{body: "ecneitaP"})
-|> delete_at([:posts, 0, :comments, 1], mode: :delete)
+|> delete_at([:posts, 0, :comments, 1], mode: {:action, :delete})
 |> insert_at([:posts, 1], %Post{title: "have"})
 |> append_at([:posts, 2, :comments], %Comment{body: "my"})
 |> update_at([:posts, 0, :comments, 0, :body], &String.reverse/1)

lib/ecto_nested_changeset.ex

@@ -141,11 +141,11 @@ defmodule EctoNestedChangeset do
   the list. For structs that are already persisted in the database, there are
   three different modes.
 
-  - `[mode: :replace]` (default) - The item will be wrapped in a changeset with
-    the `:replace` action. This only works if an appropriate `:on_replace`
-    option is set for the relation in the schema.
-  - `[mode: :delete]` - The item will be wrapped in a changeset with the action
-    set to `:delete`.
+  - `[mode: {:action, :replace}]` (default) - The item will be wrapped in a
+    changeset with the `:replace` action. This only works if an appropriate
+    `:on_replace` option is set for the relation in the schema.
+  - `[mode: {:action, :delete}]` - The item will be wrapped in a changeset with
+    the action set to `:delete`.
   - `[mode: {:flag, field}]` - Puts `true` as a change for the given field.
 
   The flag option useful for explicitly marking items for deletion in form
@@ -183,7 +183,7 @@ defmodule EctoNestedChangeset do
           %Changeset{action: :update, data: %Post{name: "George"}},
         ]
       }
-      iex> delete_at(changeset, [:pets, 1], mode: :delete)
+      iex> delete_at(changeset, [:pets, 1], mode: {:action, :delete})
       %Ecto.Changeset{
         changes: [
           %Changeset{action: :update, data: %Post{name: "George"}},
@@ -271,15 +271,15 @@ defmodule EctoNestedChangeset do
         List.delete_at(items, index)
 
       %{} = item ->
-        case opts[:mode] || :replace do
-          :delete ->
+        case opts[:mode] || {:action, :replace} do
+          {:action, :delete} ->
             List.replace_at(
               items,
               index,
               item |> change() |> Map.put(:action, :delete)
             )
 
-          :replace ->
+          {:action, :replace} ->
             List.delete_at(items, index)
 
           {:flag, field} ->

mix.exs

@@ -1,7 +1,7 @@
 defmodule EctoNestedChangeset.MixProject do
   use Mix.Project
 
-  @version "0.1.0"
+  @version "0.1.1"
   @source_url "https://github.com/woylie/ecto_nested_changeset"
 
   def project do

test/ecto_nested_changeset_test.exs

@@ -574,8 +574,8 @@ defmodule EctoNestedChangesetTest do
         }
         |> change()
         |> prepend_at([:posts], %Post{})
-        |> delete_at([:posts, 2], mode: :delete)
-        |> delete_at([:posts, 0], mode: :delete)
+        |> delete_at([:posts, 2], mode: {:action, :delete})
+        |> delete_at([:posts, 0], mode: {:action, :delete})
 
       assert %{
                posts: [
@@ -598,8 +598,8 @@ defmodule EctoNestedChangesetTest do
         }
         |> change()
         |> prepend_at([:posts], %Post{})
-        |> delete_at([:posts, 0], mode: :replace)
-        |> delete_at([:posts, 1], mode: :replace)
+        |> delete_at([:posts, 0], mode: {:action, :replace})
+        |> delete_at([:posts, 1], mode: {:action, :replace})
 
       assert %{
                posts: [
@@ -677,8 +677,8 @@ defmodule EctoNestedChangesetTest do
           ]
         }
         |> change()
-        |> delete_at([:posts, 1, :comments, 0], mode: :delete)
-        |> delete_at([:posts, 0, :comments, 1], mode: :delete)
+        |> delete_at([:posts, 1, :comments, 0], mode: {:action, :delete})
+        |> delete_at([:posts, 0, :comments, 1], mode: {:action, :delete})
 
       assert %{
                posts: [