Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Feat/blog tag schema #185

Merged
merged 9 commits into from
Aug 28, 2024
Merged
Show file tree
Hide file tree
Changes from 6 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
55 changes: 55 additions & 0 deletions lib/pescarte/blog/blog.ex
Original file line number Diff line number Diff line change
@@ -0,0 +1,55 @@
defmodule Pescarte.Blog.Blog do
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

repito, o contexto blog só expõe a API pública que será usada no frontend ou em outros contextos. Funções de CRUD não deveriam ir nesse contexto.

exemplo de funções do contexto blog:

  • fetch_recent_posts
  • register new post (envolve criar as tags, criar o post no banco, conectar o post com as tags)
  • mark_post_for_cancelation

funções de CRUD de uma entidade pura devem ser centralizadas no arquivo que define essa entidade, no caso Blog.Entity.Tag

@moduledoc """
O contexto Blog é responsável por gerenciar as operações relacionadas aos Posts e as Tags.
"""

alias Pescarte.Blog.Entity.Tag
alias Pescarte.Database.Repo
import Ecto.Query

@spec list_tags() :: {:ok, list(Tag.t())} | {:error, term()}
def list_tags do
Repo.replica().all(Tag)
end

@spec fetch_tag_by_id(String.t()) :: {:ok, Tag.t()} | {:error, term()}
def fetch_tag_by_id(id) do
Pescarte.Database.fetch(Tag, id)
end

@spec fetch_tag_by_name(String.t()) :: {:ok, Tag.t()} | {:error, term()}
def fetch_tag_by_name(nome) do
Pescarte.Database.fetch_by(Tag, nome: nome)
end

@spec create_tag(map()) :: {:ok, Tag.t()} | {:error, Ecto.Changeset.t()}
def create_tag(attrs) do
%Tag{}
|> Tag.changeset(attrs)
|> Repo.insert()
end

@spec update_tag(String.t(), map()) :: {:ok, :updated} | {:error, :not_found}
def update_tag(id, attrs) do
query = from(t in Tag, where: t.id == ^id)

query
|> Repo.update_all(set: Map.to_list(attrs))
|> case do
{0, _} -> {:error, :not_found}
{_, _} -> {:ok, :updated}
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

uma tupla de ok necessariamente retorna um valor concreto.

na query de update e delete vc pode usar a diretiva select, dessa forma o valor atualizado ou deletado vai ser retornado, com o estamos atualizando e deletando apenas 1 entrada, o retorno de sucesso seria:

{1, [entidade]}, onde a função entoa vai retornar {:ok, entidade}

no caso do delete a gente não precisa da entidade, então pode retornar apenas :ok puro

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

além disso a função update_all não atualiza o campo updated_at de timestamp da tabela, então esse campo precisa ser listado manualmente ali na lista de alterações do set

end
end

@spec delete_tag(String.t()) :: {:ok, :deleted} | {:error, :not_found}
def delete_tag(id) do
query = from(t in Tag, where: t.id == ^id)

query
|> Repo.delete_all()
|> case do
{0, _} -> {:error, :not_found}
{_, _} -> {:ok, :deleted}
end
end
end
24 changes: 24 additions & 0 deletions lib/pescarte/blog/entity/tag.ex
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
defmodule Pescarte.Blog.Entity.Tag do
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

seria interessante ter uma documentação simples do que essa entidade representa no sistema

use Pescarte, :model

alias Pescarte.Database.Types.PublicId

@type t :: %Tag{nome: binary, id: binary}

@required_fields ~w(nome)a

@primary_key {:id, PublicId, autogenerate: true}
schema "blog_tag" do
field :nome, :string

timestamps()
end

@spec changeset(Tag.t(), map) :: changeset
def changeset(%Tag{} = tag, attrs) do
tag
|> cast(attrs, @required_fields)
|> validate_required(@required_fields)
|> unique_constraint(:nome)
end
end
13 changes: 13 additions & 0 deletions priv/repo/migrations/20240814202453_create_blog_tag.exs
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
defmodule Pescarte.Database.Repo.Migrations.CreateBlogTag do
use Ecto.Migration

def change do
create table(:blog_tag, primary_key: false) do
add :id, :string, primary_key: true
add :nome, :string, null: false

timestamps()
end
create unique_index(:blog_tag, [:nome])
end
end
Loading