@spec create_player(map()) ::
  {:ok, GameApp.Accounts.Player.t()} | {:error, Ecto.Changeset.t()}

Creates a new player in the database.

This function creates a new player using the provided attributes. It uses a changeset to validate the attributes against the Player schema before attempting to insert them into the database. If the attributes are valid, the new player is saved, and the function returns the newly created player struct. If there are validation errors or any other insertion issues, it returns an error changeset.

Parameters

• attrs: A map containing the attributes for the new player. Expected keys correspond to the fields defined in the Player schema, such as name, email, and score.

Examples

# Creating a player with valid attributes
iex> create_player(%{"name" => "John Doe", "email" => "john@example.com", "score" => "20"})
{:ok, %Player{name: "John Doe", email: "john@example.com", score: 20}}

# Attempting to create a player with invalid attributes
iex> create_player(%{"name" => nil, "email" => "john@example.com", "score" => "20"})
{:error, %Ecto.Changeset{errors: [name: {"can't be blank", [validation: :required]}]}}

Returns

• {:ok, %Player{}}: Successfully created player.
• {:error, %Ecto.Changeset{}}: The changeset did not validate or could not be saved to the database.

@spec delete_player(GameApp.Accounts.Player.t()) ::
  {:ok, GameApp.Accounts.Player.t()} | {:error, Ecto.Changeset.t()}

Deletes a specific player from the database.

This function takes a player struct and deletes it from the database. It is essential to provide an existing player struct as the argument. If the deletion is successful, it returns an :ok tuple with the deleted player data. If the deletion fails (e.g., due to foreign key constraints or if the player does not exist), it returns an :error tuple.

Parameters

• player: A %Player{} struct representing the player to be deleted. The struct must already exist and be loaded from the database.

Examples

# Deleting a player with a valid struct
iex> delete_player(player)
{:ok, %Player{id: 4, name: "Charlie", email: "charlie@example.com", score: 10}}

# Attempting to delete a player that does not exist or has constraints preventing deletion
iex> delete_player(non_existent_player)
{:error, changeset}

Returns

• {:ok, %Player{}}: Successfully deleted player.
• {:error, changeset}: The deletion failed due to a constraint or the player does not exist.

@spec get_player(integer()) :: {:ok, GameApp.Accounts.Player.t()} | {:none}

Fetches a player by ID from the database.

This function retrieves a player based on the provided ID. It directly queries the Player table in the database. If a player with the specified ID exists, it returns {:ok, player}. If no player with such ID exists, it returns {:none}.

Parameters

• id: The ID of the player to retrieve. Typically, this is an integer value.

Examples

# Fetching a player with a valid ID
iex> get_player(5)
{:ok, %Player{id: 5, name: "Alice", email: "alice@example.com", score: 15}}

# Attempting to fetch a player with a non-existing ID
iex> get_player(9999)
{:none}

Returns

• {:ok, %Player{}}: The player record if found.
• {:none}: If no player with the given ID exists.

@spec get_player!(integer()) :: GameApp.Accounts.Player.t()

Fetches a player by ID from the database.

This function retrieves a player based on the provided ID. It directly queries the Player table in the database. If a player with the specified ID exists, it returns the player struct. If no player with such ID exists, it raises an Ecto.NoResultsError.

Parameters

• id: The ID of the player to retrieve. Typically, this is an integer value.

Examples

# Fetching a player with a valid ID
iex> get_player!(5)
%Player{id: 5, name: "Alice", email: "alice@example.com", score: 15}

# Attempting to fetch a player with a non-existing ID
iex> get_player!(9999)
** (Ecto.NoResultsError)

Returns

• %Player{}: The player record if found.
• Raises Ecto.NoResultsError if no player with the given ID exists.

@spec list_players() :: [GameApp.Accounts.Player.t()]

Retrieves all players from the database.

This function queries the Player table and returns a list of all player records. It's a straightforward retrieval that does not apply any filters or conditions, so it will return all players stored in the database.

Examples

# Getting a list of all players
iex> list_players()
[%Player{id: 1, name: "Alice", email: "alice@example.com", score: 15},
 %Player{id: 2, name: "Bob", email: "bob@example.com", score: 12}]

Returns

• A list of %Player{} structs: This could be an empty list if no players are present in the database.

@spec update_player(GameApp.Accounts.Player.t(), map()) ::
  {:ok, GameApp.Accounts.Player.t()} | {:error, Ecto.Changeset.t()} | {:none}

Updates a player record with the given attributes.

This function fetches the player by ID, applies the changes from the provided attributes, and attempts to update the player record in the database. If the player is found, it returns {:ok, updated_player}. If the player is not found, it returns {:none}. If the update fails due to validation errors, it returns {:error, changeset}.

Parameters

• player: The player struct to update.
• attrs: A map of attributes to update the player with.

Examples

# Updating a player with valid attributes
iex> update_player(%Player{id: 5}, %{name: "Alice Updated"})
{:ok, %Player{id: 5, name: "Alice Updated", email: "alice@example.com", score: 15}}

# Attempting to update a non-existing player
iex> update_player(%Player{id: 9999}, %{name: "Non-existing"})
{:none}

# Attempting to update a player with invalid attributes
iex> update_player(%Player{id: 5}, %{email: "invalid-email"})
{:error, %Ecto.Changeset{}}

Returns

• {:ok, %Player{}}: The updated player record if the update is successful.
• {:none}: If the player with the given ID does not exist.
• {:error, %Ecto.Changeset{}}: If the update fails due to validation errors.

@spec update_player!(GameApp.Accounts.Player.t(), map()) ::
  GameApp.Accounts.Player.t()

Updates a player record with the given attributes.

This function fetches the player by ID, applies the changes from the provided attributes, and updates the player record in the database. If the player is not found, it raises an Ecto.NoResultsError. If the update fails, it raises an Ecto.InvalidChangesetError.

Parameters

• player: The player struct to update.
• attrs: A map of attributes to update the player with.

Examples

# Updating a player with valid attributes
iex> update_player!(%Player{id: 5}, %{name: "Alice Updated"})
%Player{id: 5, name: "Alice Updated", email: "alice@example.com", score: 15}

# Attempting to update a non-existing player
iex> update_player!(%Player{id: 9999}, %{name: "Non-existing"})
** (Ecto.NoResultsError)

Returns

• %Player{}: The updated player record.
• Raises Ecto.NoResultsError if the player with the given ID does not exist.
• Raises Ecto.InvalidChangesetError if the update fails due to validation errors.