feat: entry entity (#46)

* feat: entry entity

* fix: documentation

* refactor: define required and optional fields

Author: glfaria

lib/yearbook/entries.ex

@@ -0,0 +1,104 @@
+defmodule Yearbook.Entries do
+  @moduledoc """
+  The Entries context.
+  """
+
+  import Ecto.Query, warn: false
+  alias Yearbook.Repo
+
+  alias Yearbook.Entries.Entry
+
+  @doc """
+  Returns the list of entries.
+
+  ## Examples
+
+      iex> list_entries()
+      [%Entry{}, ...]
+
+  """
+  def list_entries do
+    Repo.all(Entry)
+  end
+
+  @doc """
+  Gets a single entry.
+
+  Raises `Ecto.NoResultsError` if the Entry does not exist.
+
+  ## Examples
+
+      iex> get_entry!(123)
+      %Entry{}
+
+      iex> get_entry!(456)
+      ** (Ecto.NoResultsError)
+
+  """
+  def get_entry!(id), do: Repo.get!(Entry, id)
+
+  @doc """
+  Creates a entry.
+
+  ## Examples
+
+      iex> create_entry(%{field: value})
+      {:ok, %Entry{}}
+
+      iex> create_entry(%{field: bad_value})
+      {:error, %Ecto.Changeset{}}
+
+  """
+  def create_entry(attrs) do
+    %Entry{}
+    |> Entry.changeset(attrs)
+    |> Repo.insert()
+  end
+
+  @doc """
+  Updates a entry.
+
+  ## Examples
+
+      iex> update_entry(entry, %{field: new_value})
+      {:ok, %Entry{}}
+
+      iex> update_entry(entry, %{field: bad_value})
+      {:error, %Ecto.Changeset{}}
+
+  """
+  def update_entry(%Entry{} = entry, attrs) do
+    entry
+    |> Entry.changeset(attrs)
+    |> Repo.update()
+  end
+
+  @doc """
+  Deletes a entry.
+
+  ## Examples
+
+      iex> delete_entry(entry)
+      {:ok, %Entry{}}
+
+      iex> delete_entry(entry)
+      {:error, %Ecto.Changeset{}}
+
+  """
+  def delete_entry(%Entry{} = entry) do
+    Repo.delete(entry)
+  end
+
+  @doc """
+  Returns an `%Ecto.Changeset{}` for tracking entry changes.
+
+  ## Examples
+
+      iex> change_entry(entry)
+      %Ecto.Changeset{data: %Entry{}}
+
+  """
+  def change_entry(%Entry{} = entry, attrs \\ %{}) do
+    Entry.changeset(entry, attrs)
+  end
+end

lib/yearbook/entries/entry.ex

@@ -0,0 +1,28 @@
+defmodule Yearbook.Entries.Entry do
+  @moduledoc """
+  Schema for a yearbook entry.
+  """
+
+  use Ecto.Schema
+  import Ecto.Changeset
+
+  @required_fields ~w(photo name text)a
+  @optional_fields ~w(status)a
+  @primary_key {:id, :binary_id, autogenerate: true}
+  @foreign_key_type :binary_id
+  schema "entries" do
+    field :photo, :string
+    field :name, :string
+    field :text, :string
+    field :status, Ecto.Enum, values: [:accepted, :pending, :denied], default: :pending
+
+    timestamps(type: :utc_datetime)
+  end
+
+  @doc false
+  def changeset(entry, attrs) do
+    entry
+    |> cast(attrs, @required_fields ++ @optional_fields)
+    |> validate_required(@required_fields)
+  end
+end

priv/repo/migrations/20260311233906_create_entries.exs

@@ -0,0 +1,15 @@
+defmodule Yearbook.Repo.Migrations.CreateEntries do
+  use Ecto.Migration
+
+  def change do
+    create table(:entries, primary_key: false) do
+      add :id, :binary_id, primary_key: true
+      add :photo, :string
+      add :name, :string
+      add :text, :text
+      add :status, :string, default: "pending"
+
+      timestamps(type: :utc_datetime)
+    end
+  end
+end

test/support/fixtures/entries_fixtures.ex

@@ -0,0 +1,23 @@
+defmodule Yearbook.EntriesFixtures do
+  @moduledoc """
+  This module defines test helpers for creating
+  entities via the `Yearbook.Entries` context.
+  """
+
+  @doc """
+  Generate a entry.
+  """
+  def entry_fixture(attrs \\ %{}) do
+    {:ok, entry} =
+      attrs
+      |> Enum.into(%{
+        name: "some name",
+        photo: "some photo",
+        status: :pending,
+        text: "some text"
+      })
+      |> Yearbook.Entries.create_entry()
+
+    entry
+  end
+end

test/yearbook/entries_test.exs

@@ -0,0 +1,71 @@
+defmodule Yearbook.EntriesTest do
+  use Yearbook.DataCase
+
+  alias Yearbook.Entries
+
+  describe "entries" do
+    alias Yearbook.Entries.Entry
+
+    import Yearbook.EntriesFixtures
+
+    @invalid_attrs %{name: nil, status: nil, text: nil, photo: nil}
+
+    test "list_entries/0 returns all entries" do
+      entry = entry_fixture()
+      assert Entries.list_entries() == [entry]
+    end
+
+    test "get_entry!/1 returns the entry with given id" do
+      entry = entry_fixture()
+      assert Entries.get_entry!(entry.id) == entry
+    end
+
+    test "create_entry/1 with valid data creates a entry" do
+      valid_attrs = %{name: "some name", status: :pending, text: "some text", photo: "some photo"}
+
+      assert {:ok, %Entry{} = entry} = Entries.create_entry(valid_attrs)
+      assert entry.name == "some name"
+      assert entry.status == :pending
+      assert entry.text == "some text"
+      assert entry.photo == "some photo"
+    end
+
+    test "create_entry/1 with invalid data returns error changeset" do
+      assert {:error, %Ecto.Changeset{}} = Entries.create_entry(@invalid_attrs)
+    end
+
+    test "update_entry/2 with valid data updates the entry" do
+      entry = entry_fixture()
+
+      update_attrs = %{
+        name: "some updated name",
+        status: :accepted,
+        text: "some updated text",
+        photo: "some updated photo"
+      }
+
+      assert {:ok, %Entry{} = entry} = Entries.update_entry(entry, update_attrs)
+      assert entry.name == "some updated name"
+      assert entry.status == :accepted
+      assert entry.text == "some updated text"
+      assert entry.photo == "some updated photo"
+    end
+
+    test "update_entry/2 with invalid data returns error changeset" do
+      entry = entry_fixture()
+      assert {:error, %Ecto.Changeset{}} = Entries.update_entry(entry, @invalid_attrs)
+      assert entry == Entries.get_entry!(entry.id)
+    end
+
+    test "delete_entry/1 deletes the entry" do
+      entry = entry_fixture()
+      assert {:ok, %Entry{}} = Entries.delete_entry(entry)
+      assert_raise Ecto.NoResultsError, fn -> Entries.get_entry!(entry.id) end
+    end
+
+    test "change_entry/1 returns a entry changeset" do
+      entry = entry_fixture()
+      assert %Ecto.Changeset{} = Entries.change_entry(entry)
+    end
+  end
+end