cannery/lib/cannery/tags.ex

138 lines
3.2 KiB
Elixir
Raw Normal View History

2021-09-02 23:31:14 -04:00
defmodule Cannery.Tags do
@moduledoc """
The Tags context.
"""
import Ecto.Query, warn: false
2022-02-13 21:14:48 -05:00
import CanneryWeb.Gettext
2022-01-31 20:10:48 -05:00
alias Cannery.{Accounts.User, Repo, Tags.Tag}
2022-02-08 22:12:22 -05:00
alias Ecto.Changeset
2021-09-02 23:31:14 -04:00
@doc """
Returns the list of tags.
## Examples
2022-02-09 23:21:42 -05:00
iex> list_tags(%User{id: 123})
2021-09-02 23:31:14 -04:00
[%Tag{}, ...]
"""
2022-02-09 23:21:42 -05:00
@spec list_tags(User.t()) :: [Tag.t()]
2022-02-15 19:55:48 -05:00
def list_tags(%{id: user_id}),
do: Repo.all(from t in Tag, where: t.user_id == ^user_id, order_by: t.name)
2021-09-02 23:31:14 -04:00
@doc """
Gets a single tag.
2022-02-13 21:14:48 -05:00
## Examples
iex> get_tag(123, %User{id: 123})
{:ok, %Tag{}}
iex> get_tag(456, %User{id: 123})
{:error, "tag not found"}
"""
@spec get_tag(Tag.id(), User.t()) :: {:ok, Tag.t()} | {:error, String.t()}
def get_tag(id, %User{id: user_id}) do
Repo.one(from t in Tag, where: t.id == ^id and t.user_id == ^user_id)
|> case do
nil -> {:error, dgettext("errors", "Tag not found")}
tag -> {:ok, tag}
end
end
@doc """
Gets a single tag.
2021-09-02 23:31:14 -04:00
Raises `Ecto.NoResultsError` if the Tag does not exist.
## Examples
2022-02-09 23:21:42 -05:00
iex> get_tag!(123, %User{id: 123})
2021-09-02 23:31:14 -04:00
%Tag{}
2022-02-09 23:21:42 -05:00
iex> get_tag!(456, %User{id: 123})
2021-09-02 23:31:14 -04:00
** (Ecto.NoResultsError)
"""
2022-02-09 23:21:42 -05:00
@spec get_tag!(Tag.id(), User.t()) :: Tag.t()
def get_tag!(id, %User{id: user_id}),
do: Repo.one!(from t in Tag, where: t.id == ^id and t.user_id == ^user_id)
2021-09-02 23:31:14 -04:00
@doc """
Creates a tag.
## Examples
2022-02-09 23:21:42 -05:00
iex> create_tag(%{field: value}, %User{id: 123})
2021-09-02 23:31:14 -04:00
{:ok, %Tag{}}
2022-02-09 23:21:42 -05:00
iex> create_tag(%{field: bad_value}, %User{id: 123})
2022-01-31 20:10:48 -05:00
{:error, %Changeset{}}
2021-09-02 23:31:14 -04:00
"""
2022-02-09 23:21:42 -05:00
@spec create_tag(attrs :: map(), User.t()) ::
{:ok, Tag.t()} | {:error, Changeset.t(Tag.new_tag())}
2022-07-04 21:06:35 -04:00
def create_tag(attrs, %User{} = user),
do: %Tag{} |> Tag.create_changeset(user, attrs) |> Repo.insert()
2021-09-02 23:31:14 -04:00
@doc """
Updates a tag.
## Examples
2022-02-09 23:21:42 -05:00
iex> update_tag(tag, %{field: new_value}, %User{id: 123})
2021-09-02 23:31:14 -04:00
{:ok, %Tag{}}
2022-02-09 23:21:42 -05:00
iex> update_tag(tag, %{field: bad_value}, %User{id: 123})
2022-01-31 20:10:48 -05:00
{:error, %Changeset{}}
2021-09-02 23:31:14 -04:00
"""
2022-02-09 23:21:42 -05:00
@spec update_tag(Tag.t(), attrs :: map(), User.t()) ::
{:ok, Tag.t()} | {:error, Changeset.t(Tag.t())}
def update_tag(%Tag{user_id: user_id} = tag, attrs, %User{id: user_id}),
do: tag |> Tag.update_changeset(attrs) |> Repo.update()
2021-09-02 23:31:14 -04:00
@doc """
Deletes a tag.
## Examples
2022-02-09 23:21:42 -05:00
iex> delete_tag(tag, %User{id: 123})
2021-09-02 23:31:14 -04:00
{:ok, %Tag{}}
2022-02-09 23:21:42 -05:00
iex> delete_tag(tag, %User{id: 123})
2022-01-31 20:10:48 -05:00
{:error, %Changeset{}}
2021-09-02 23:31:14 -04:00
"""
2022-02-09 23:21:42 -05:00
@spec delete_tag(Tag.t(), User.t()) :: {:ok, Tag.t()} | {:error, Changeset.t(Tag.t())}
def delete_tag(%Tag{user_id: user_id} = tag, %User{id: user_id}), do: tag |> Repo.delete()
2021-09-02 23:31:14 -04:00
@doc """
2022-01-31 20:10:48 -05:00
Deletes a tag.
## Examples
2022-02-09 23:21:42 -05:00
iex> delete_tag!(tag, %User{id: 123})
2022-01-31 20:10:48 -05:00
%Tag{}
"""
2022-02-09 23:21:42 -05:00
@spec delete_tag!(Tag.t(), User.t()) :: Tag.t()
def delete_tag!(%Tag{user_id: user_id} = tag, %User{id: user_id}), do: tag |> Repo.delete!()
2022-01-31 20:10:48 -05:00
2022-01-28 21:05:54 -05:00
@doc """
Get a random tag bg_color in `#ffffff` hex format
## Examples
iex> random_color()
"#cc0066"
"""
@spec random_bg_color() :: <<_::7>>
def random_bg_color do
["#cc0066", "#ff6699", "#6666ff", "#0066cc", "#00cc66", "#669900", "#ff9900", "#996633"]
|> Enum.random()
end
2021-09-02 23:31:14 -04:00
end