From 71d2f4e965c2c58a34f7c35973fbae03b176d9f4 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Lu=C3=ADs=20Arteiro?= <lucho14garfield@gmail.com>
Date: Mon, 14 Nov 2022 13:56:15 +0000
Subject: [PATCH] fix: Adding documentation and simplifying controller pattern
 matching on error. #195

---
 lib/app/timer.ex             | 22 +++++++++++++++-------
 lib/app_web/live/app_live.ex |  8 +-------
 2 files changed, 16 insertions(+), 14 deletions(-)

diff --git a/lib/app/timer.ex b/lib/app/timer.ex
index 27ab2244..8a7dd67e 100644
--- a/lib/app/timer.ex
+++ b/lib/app/timer.ex
@@ -80,6 +80,14 @@ defmodule App.Timer do
     |> Repo.update()
   end
 
+  @doc """
+  Updates a timer object inside a list with timer changesets.
+  This function is only useful for form validations, since it replaces the errored changeset
+  according to the index that is passed, alongside the list and the fields to update the timer.
+
+  It returns {:ok, []} in case the update is successful.
+  Otherwise, it returns {:error, updated_list}, where `error_term` is the error that occurred and `updated_list` being the updated item changeset list with the error.
+  """
   def update_timer_inside_changeset_list(
     timer_id,
     timer_start,
@@ -128,7 +136,7 @@ defmodule App.Timer do
             :update
           )
 
-        {:error_invalid_start, updated_changeset_timers_list}
+        {:error, updated_changeset_timers_list}
 
       :error_not_after_others ->
         updated_changeset_timers_list =
@@ -141,7 +149,7 @@ defmodule App.Timer do
             :update
           )
 
-        {:error_not_after_others, updated_changeset_timers_list}
+        {:error, updated_changeset_timers_list}
     end
   end
   def update_timer_inside_changeset_list(
@@ -217,7 +225,7 @@ defmodule App.Timer do
             :update
           )
 
-        {:error_invalid_start, updated_changeset_timers_list}
+        {:error, updated_changeset_timers_list}
 
       :error_invalid_stop ->
         updated_changeset_timers_list =
@@ -230,7 +238,7 @@ defmodule App.Timer do
             :update
           )
 
-        {:error_invalid_stop, updated_changeset_timers_list}
+        {:error, updated_changeset_timers_list}
 
       :error_overlap ->
         updated_changeset_timers_list =
@@ -243,7 +251,7 @@ defmodule App.Timer do
             :update
           )
 
-        {:error_overlap, updated_changeset_timers_list}
+        {:error, updated_changeset_timers_list}
 
       :error_start_equal_stop ->
         updated_changeset_timers_list =
@@ -256,7 +264,7 @@ defmodule App.Timer do
             :update
           )
 
-        {:error_start_equal_stop, updated_changeset_timers_list}
+        {:error, updated_changeset_timers_list}
 
       :error_start_greater_than_stop ->
         updated_changeset_timers_list =
@@ -269,7 +277,7 @@ defmodule App.Timer do
             :update
           )
 
-        {:error_start_greater_than_stop, updated_changeset_timers_list}
+        {:error, updated_changeset_timers_list}
     end
   end
 
diff --git a/lib/app_web/live/app_live.ex b/lib/app_web/live/app_live.ex
index ef4c7893..9bec2198 100644
--- a/lib/app_web/live/app_live.ex
+++ b/lib/app_web/live/app_live.ex
@@ -137,13 +137,7 @@ defmodule AppWeb.AppLive do
 
     case Timer.update_timer_inside_changeset_list(id, timer_start, timer_stop, index, timer_changeset_list) do
       {:ok, _list} -> {:noreply, assign(socket, editing: nil, editing_timers: [])}
-
-      {:error_invalid_start, updated_list} -> {:noreply, assign(socket, editing_timers: updated_list)}
-      {:error_invalid_stop, updated_list} -> {:noreply, assign(socket, editing_timers: updated_list)}
-      {:error_start_greater_than_stop, updated_list} -> {:noreply, assign(socket, editing_timers: updated_list)}
-      {:error_start_equal_stop, updated_list} -> {:noreply, assign(socket, editing_timers: updated_list)}
-      {:error_overlap, updated_list} -> {:noreply, assign(socket, editing_timers: updated_list)}
-      {:error_not_after_others, updated_list} -> {:noreply, assign(socket, editing_timers: updated_list)}
+      {:error, updated_errored_list} -> {:noreply, assign(socket, editing_timers: updated_errored_list)}
     end
   end