Some format change to adhere to backend style

Author: Cheng20010201

lib/cadet/accounts/game_states.ex

@@ -1,6 +1,8 @@
 defmodule Cadet.Accounts.GameStates do
-  import Ecto.Repo
+  use Cadet, :context
+  alias Cadet.Accounts.User
 
+  @update_gamestate_roles ~w(student)a
   # currently in this module no error handling function
   # has been implemented yet
 
@@ -16,24 +18,24 @@ defmodule Cadet.Accounts.GameStates do
     user.game_states["completed_quests"]
   end
 
-  def update(user, new_game_states) do
-    if user.role == :student do
-      changeset = Ecto.Changeset.cast(user, %{game_states: new_game_states}, [:game_states])
-      Cadet.Repo.update!(changeset)
+  def update(user = %User{role: role}, new_game_states) do
+    if role in @update_gamestate_roles do
+      changeset = cast(user, %{game_states: new_game_states}, [:game_states])
+      Repo.update!(changeset)
       {:ok, nil}
     else
       {:error, {:forbidden, "Please try again later."}}
     end
   end
 
-  def clear(user) do
-    if user.role == :student do
+  def clear(user = %User{role: role}) do
+    if role in @update_gamestate_roles do
       changeset =
-        Ecto.Changeset.cast(user, %{game_states: %{collectibles: %{}, completed_quests: []}}, [
+        cast(user, %{game_states: %{collectibles: %{}, completed_quests: []}}, [
           :game_states
         ])
 
-      Cadet.Repo.update!(changeset)
+      Repo.update!(changeset)
       {:ok, nil}
     else
       {:error, {:forbidden, "Please try again later."}}

lib/cadet_web/controllers/user_controller.ex

@@ -6,8 +6,7 @@ defmodule CadetWeb.UserController do
   use CadetWeb, :controller
   use PhoenixSwagger
   import Cadet.Assessments
-  import Cadet.GameStates
-  import Ecto.Repo
+  import Cadet.Accounts.GameStates
 
   def index(conn, _) do
     user = conn.assigns.current_user
@@ -29,19 +28,24 @@ defmodule CadetWeb.UserController do
     )
   end
 
-  swagger_path :index do
-    get("/user")
-    summary("Get the name and role of a user")
-    security([%{JWT: []}])
-    produces("application/json")
-    response(200, "OK", Schema.ref(:UserInfo))
-    response(401, "Unauthorised")
+  def update_game_states(conn, %{"gameStates" => new_game_states}) do
+    user = conn.assigns[:current_user]
+
+    case update(user, new_game_states) do
+      {:ok, nil} ->
+        text(conn, "OK")
+
+      {:error, {status, message}} ->
+        conn
+        |> put_status(status)
+        |> text(message)
+    end
   end
 
-  def update_game_states(conn, %{"gameStates" => new_game_states}) do
+  def clear_up_game_states(conn, _) do
     user = conn.assigns[:current_user]
 
-    case Cadet.GameStates.update(user, new_game_states) do
+    case clear(user) do
       {:ok, nil} ->
         text(conn, "OK")
 
@@ -52,6 +56,16 @@ defmodule CadetWeb.UserController do
     end
   end
 
+  swagger_path :index do
+    get("/user")
+    summary("Get the name and role of a user")
+    security([%{JWT: []}])
+    produces("application/json")
+    response(200, "OK", Schema.ref(:UserInfo))
+    response(401, "Unauthorised")
+  end
+
+
   swagger_path :update_game_states do
     put("/user/game_states/save")
     summary("update user's game states")
@@ -70,20 +84,6 @@ defmodule CadetWeb.UserController do
     response(401, "Unauthorised")
   end
 
-  def clear_up_game_states(conn, _) do
-    user = conn.assigns[:current_user]
-
-    case Cadet.GameStates.clear(user) do
-      {:ok, nil} ->
-        text(conn, "OK")
-
-      {:error, {status, message}} ->
-        conn
-        |> put_status(status)
-        |> text(message)
-    end
-  end
-
   swagger_path :clear_up_game_states do
     put("/user/game_states/clear")
     summary("clear up users' game data saved")