diff --git a/GLOSSARY.md b/GLOSSARY.md index dde4092..1725fa4 100644 --- a/GLOSSARY.md +++ b/GLOSSARY.md @@ -19,6 +19,11 @@ _Avoid_: Endgame (the stored record), exercise One playthrough of a puzzle by a user, ending solved or failed. _Avoid_: Run, session, game +**Theme**: +A label describing an endgame's technique or goal, such as "mate in 2", "Lucena" or +"opposition"; an endgame can carry several. +_Avoid_: Tag, label, category + ## Play **Winning side**: diff --git a/lib/chesstrainer/endgames.ex b/lib/chesstrainer/endgames.ex index 10fc6d0..da838a4 100644 --- a/lib/chesstrainer/endgames.ex +++ b/lib/chesstrainer/endgames.ex @@ -49,9 +49,10 @@ defmodule Chesstrainer.Endgames do {:error, %Ecto.Changeset{}} """ - def create_endgame(attrs) do + def create_endgame(attrs, tags \\ []) do %Endgame{} |> Endgame.changeset(attrs) + |> Ecto.Changeset.put_assoc(:tags, tags) |> Repo.insert() end @@ -67,12 +68,14 @@ defmodule Chesstrainer.Endgames do {:error, %Ecto.Changeset{}} """ - def update_endgame(%Endgame{} = endgame, attrs) do + def update_endgame(%Endgame{} = endgame, attrs, tags \\ []) do # ignore fen on update attrs = Map.delete(attrs, "fen") endgame + |> Repo.preload(:tags) |> Endgame.changeset(attrs) + |> Ecto.Changeset.put_assoc(:tags, tags) |> Repo.update() end @@ -120,20 +123,4 @@ defmodule Chesstrainer.Endgames do {:ok, Repo.get!(Endgame, id)} end - - def add_tag(endgame, tag) do - endgame - |> Repo.preload(:tags) - |> Ecto.Changeset.change() - |> Ecto.Changeset.put_assoc(:tags, [tag | endgame.tags]) - |> Repo.update() - end - - def remove_tag(endgame, tag) do - endgame - |> Repo.preload(:tags) - |> Ecto.Changeset.change() - |> Ecto.Changeset.put_assoc(:tags, endgame.tags -- [tag]) - |> Repo.update() - end end diff --git a/lib/chesstrainer/tags.ex b/lib/chesstrainer/tags.ex index 27d099a..3ed1e22 100644 --- a/lib/chesstrainer/tags.ex +++ b/lib/chesstrainer/tags.ex @@ -105,19 +105,52 @@ defmodule Chesstrainer.Tags do def search("", _category), do: [] def search(query, category) when is_binary(query) do - pattern = "%#{query}%" + case String.trim(query) do + "" -> + [] - Tag - |> where([t], ilike(t.name, ^pattern) and t.category == ^category) - |> order_by([t], asc: t.name) - |> limit(20) - |> Repo.all() - end + query -> + pattern = "%#{query}%" - def get_or_create(name, category) when is_binary(name) do - case Repo.get_by(Tag, name: name, category: category) do - nil -> create_tag(%{name: name, category: category}) - tag -> {:ok, tag} + Tag + |> where([t], ilike(t.name, ^pattern) and t.category == ^category) + |> order_by([t], asc: t.name) + |> limit(20) + |> Repo.all() end end + + @doc """ + Finds a tag by name (trimmed and case-insensitive) for a category, creating it + if it does not exist. + """ + def get_or_create(name, category) when is_binary(name) do + name = String.trim(name) + + if name == "" do + {:error, :blank_name} + else + case find_by_name(name, category) do + nil -> create_tag(%{name: name, category: category}) + tag -> {:ok, tag} + end + end + end + + defp find_by_name(name, category) do + downcased = String.downcase(name) + + Repo.one( + from t in Tag, + where: t.category == ^category and fragment("lower(?)", t.name) == ^downcased, + limit: 1 + ) + end + + @doc """ + Returns the names of the given tags, sorted. + """ + def names(tags) when is_list(tags) do + tags |> Enum.map(& &1.name) |> Enum.sort() + end end diff --git a/lib/chesstrainer/tags/tag.ex b/lib/chesstrainer/tags/tag.ex index 93fe811..242df98 100644 --- a/lib/chesstrainer/tags/tag.ex +++ b/lib/chesstrainer/tags/tag.ex @@ -13,7 +13,12 @@ defmodule Chesstrainer.Tags.Tag do def changeset(tag, attrs) do tag |> cast(attrs, [:name, :category]) + |> update_change(:name, fn + name when is_binary(name) -> String.trim(name) + name -> name + end) |> validate_required([:name, :category]) - |> unique_constraint(:name) + |> validate_length(:name, min: 1, max: 60) + |> unique_constraint(:name, name: :tags_name_category_lower_index, message: "already exists") end end diff --git a/lib/chesstrainer_web/live/endgame_live/form.ex b/lib/chesstrainer_web/live/endgame_live/form.ex index e102fe6..4bd3181 100644 --- a/lib/chesstrainer_web/live/endgame_live/form.ex +++ b/lib/chesstrainer_web/live/endgame_live/form.ex @@ -16,51 +16,65 @@ defmodule ChesstrainerWeb.EndgameLive.Form do <:subtitle>Use this form to manage endgame records in your database. +
+ + +
+ <%= for tag <- @selected_tags do %> + + {tag.name} + + + <% end %> +
+ +
+ + + +
+
+ <.form for={@form} id="endgame-form" phx-change="validate" phx-submit="save"> <.input field={@form[:fen]} type="text" label="Fen" disabled={@live_action == :edit} /> <.input field={@form[:color]} type="text" label="Color" disabled /> <.input field={@form[:key]} type="text" label="Key" /> <.input field={@form[:rating]} type="number" label="Rating" /> - - -
- - - - - - - - - -
- <%= for tag <- @endgame.tags do %> - - {tag.name} - - - <% end %> -
-
- <.input field={@form[:message]} type="textarea" label="Message" /> <.input field={@form[:notes]} type="textarea" label="Notes" /> <.input @@ -94,14 +108,15 @@ defmodule ChesstrainerWeb.EndgameLive.Form do defp return_to(_), do: "index" defp apply_action(socket, :edit, %{"id" => id}) do - endgame = Endgames.get_endgame!(id) + endgame = Endgames.get_endgame!(id) |> Repo.preload(:tags) socket |> assign(:page_title, "Edit Endgame") |> assign(:endgame, endgame) + |> assign(:selected_tags, endgame.tags) |> assign(:tag_query, "") |> assign(:tag_results, []) - |> assign(:endgame, Repo.preload(endgame, :tags)) + |> assign(:can_create, false) |> assign(:form, to_form(Endgames.change_endgame(endgame))) end @@ -111,67 +126,46 @@ defmodule ChesstrainerWeb.EndgameLive.Form do socket |> assign(:page_title, "New Endgame") |> assign(:endgame, endgame) + |> assign(:selected_tags, []) |> assign(:tag_query, "") |> assign(:tag_results, []) - |> assign(:endgame, Repo.preload(endgame, :tags)) + |> assign(:can_create, false) |> assign(:form, to_form(Endgames.change_endgame(endgame))) end @impl true def handle_event("search_tags", %{"tag_search" => query}, socket) do - tags = Tags.search(query, "endgame") - - {:noreply, - socket - |> assign(:tag_query, query) - |> assign(:tag_results, tags)} + {:noreply, assign_search(socket, query)} end def handle_event("add_tag", %{"id" => id}, socket) do tag = Tags.get_tag!(id) - {:ok, endgame} = Endgames.add_tag(socket.assigns.endgame, tag) - - {:noreply, - socket - |> assign(:endgame, Repo.preload(endgame, :tags)) - |> assign(:tag_query, "") - |> assign(:tag_results, [])} + {:noreply, socket |> add_selected_tag(tag) |> clear_search()} end def handle_event("create_tag", %{"name" => name}, socket) do - {:ok, tag} = Tags.get_or_create(name, "endgame") - {:ok, endgame} = Endgames.add_tag(socket.assigns.endgame, tag) + {:noreply, create_theme(socket, name)} + end - {:noreply, - socket - |> assign(:endgame, Repo.preload(endgame, :tags)) - |> assign(:tag_query, "") - |> assign(:tag_results, [])} + def handle_event("create_tag_from_search", %{"tag_search" => name}, socket) do + {:noreply, create_theme(socket, name)} end def handle_event("remove_tag", %{"id" => id}, socket) do - tag = Tags.get_tag!(id) - {:ok, endgame} = Endgames.remove_tag(socket.assigns.endgame, tag) - - {:noreply, - socket - |> assign(:endgame, Repo.preload(endgame, :tags))} + selected = Enum.reject(socket.assigns.selected_tags, &(Integer.to_string(&1.id) == id)) + {:noreply, assign(socket, :selected_tags, selected)} end def handle_event("validate", %{"endgame" => endgame_params}, socket) do - # Compute color from the incoming FEN - color = FEN.color_from_fen(endgame_params["fen"]) + fen = endgame_params["fen"] || socket.assigns.endgame.fen + color = FEN.color_from_fen(fen) - # Update the struct - endgame = %{socket.assigns.endgame | color: color} - - # Build the changeset *from the updated struct* changeset = - endgame - |> Endgames.change_endgame() + socket.assigns.endgame + |> Endgames.change_endgame(endgame_params) |> Ecto.Changeset.put_change(:color, color) - {:noreply, assign(socket, endgame: endgame, form: to_form(changeset, action: :validate))} + {:noreply, assign(socket, form: to_form(changeset, action: :validate))} end def handle_event("save", %{"endgame" => endgame_params}, socket) do @@ -179,7 +173,11 @@ defmodule ChesstrainerWeb.EndgameLive.Form do end defp save_endgame(socket, :edit, endgame_params) do - case Endgames.update_endgame(socket.assigns.endgame, endgame_params) do + case Endgames.update_endgame( + socket.assigns.endgame, + endgame_params, + socket.assigns.selected_tags + ) do {:ok, endgame} -> {:noreply, socket @@ -195,7 +193,7 @@ defmodule ChesstrainerWeb.EndgameLive.Form do color = FEN.color_from_fen(endgame_params["fen"]) params = Map.put(endgame_params, "color", color) - case Endgames.create_endgame(params) do + case Endgames.create_endgame(params, socket.assigns.selected_tags) do {:ok, endgame} -> {:noreply, socket @@ -207,6 +205,46 @@ defmodule ChesstrainerWeb.EndgameLive.Form do end end + defp assign_search(socket, query) do + trimmed = String.trim(query) + results = Tags.search(query, "endgame") + + can_create = + trimmed != "" and + not Enum.any?(results, &(String.downcase(&1.name) == String.downcase(trimmed))) + + socket + |> assign(:tag_query, query) + |> assign(:tag_results, results) + |> assign(:can_create, can_create) + end + + defp create_theme(socket, name) do + if String.trim(name) == "" do + socket + else + case Tags.get_or_create(name, "endgame") do + {:ok, tag} -> socket |> add_selected_tag(tag) |> clear_search() + {:error, _reason} -> put_flash(socket, :error, "Could not create that theme.") + end + end + end + + defp clear_search(socket) do + socket + |> assign(:tag_query, "") + |> assign(:tag_results, []) + |> assign(:can_create, false) + end + + defp add_selected_tag(socket, tag) do + if Enum.any?(socket.assigns.selected_tags, &(&1.id == tag.id)) do + socket + else + assign(socket, :selected_tags, socket.assigns.selected_tags ++ [tag]) + end + end + defp return_path("index", _endgame), do: ~p"/admin/endgames" defp return_path("show", endgame), do: ~p"/admin/endgames/#{endgame}" end diff --git a/lib/chesstrainer_web/live/endgame_live/index.ex b/lib/chesstrainer_web/live/endgame_live/index.ex index 0de26bf..902ab43 100644 --- a/lib/chesstrainer_web/live/endgame_live/index.ex +++ b/lib/chesstrainer_web/live/endgame_live/index.ex @@ -2,6 +2,8 @@ defmodule ChesstrainerWeb.EndgameLive.Index do use ChesstrainerWeb, :live_view alias Chesstrainer.Endgames + alias Chesstrainer.Repo + alias Chesstrainer.Tags @impl true def render(assigns) do @@ -28,6 +30,9 @@ defmodule ChesstrainerWeb.EndgameLive.Index do <:col :let={{_id, endgame}} label="Message">{endgame.message} <:col :let={{_id, endgame}} label="Notes">{endgame.notes} <:col :let={{_id, endgame}} label="Result">{endgame.result} + <:col :let={{_id, endgame}} label="Themes"> + {Enum.join(Tags.names(endgame.tags), ", ")} + <:col :let={{_id, endgame}} label="Attempted">{endgame.times_attempted} <:col :let={{_id, endgame}} label="Solved">{endgame.times_solved} <:action :let={{_id, endgame}}> @@ -67,6 +72,6 @@ defmodule ChesstrainerWeb.EndgameLive.Index do end defp list_endgames() do - Endgames.list_endgames() + Endgames.list_endgames() |> Repo.preload(:tags) end end diff --git a/lib/chesstrainer_web/live/endgame_live/show.ex b/lib/chesstrainer_web/live/endgame_live/show.ex index 3900adb..532539a 100644 --- a/lib/chesstrainer_web/live/endgame_live/show.ex +++ b/lib/chesstrainer_web/live/endgame_live/show.ex @@ -3,6 +3,8 @@ defmodule ChesstrainerWeb.EndgameLive.Show do alias Chesstrainer.Endgames alias Chesstrainer.Game + alias Chesstrainer.Repo + alias Chesstrainer.Tags import ChesstrainerWeb.Board.BoardComponent @@ -50,6 +52,7 @@ defmodule ChesstrainerWeb.EndgameLive.Show do <:item title="Message">{@endgame.message} <:item title="Notes">{@endgame.notes} <:item title="Result">{@endgame.result} + <:item title="Themes">{Enum.join(Tags.names(@endgame.tags), ", ")} <:item title="Attempted">{@endgame.times_attempted} <:item title="Solved">{@endgame.times_solved} @@ -62,6 +65,6 @@ defmodule ChesstrainerWeb.EndgameLive.Show do {:ok, socket |> assign(:page_title, "Show Endgame") - |> assign(:endgame, Endgames.get_endgame!(id))} + |> assign(:endgame, Endgames.get_endgame!(id) |> Repo.preload(:tags))} end end diff --git a/priv/repo/migrations/20261101120000_case_insensitive_tag_names.exs b/priv/repo/migrations/20261101120000_case_insensitive_tag_names.exs new file mode 100644 index 0000000..c047d91 --- /dev/null +++ b/priv/repo/migrations/20261101120000_case_insensitive_tag_names.exs @@ -0,0 +1,15 @@ +defmodule Chesstrainer.Repo.Migrations.CaseInsensitiveTagNames do + use Ecto.Migration + + def up do + drop index(:tags, [:name, :category]) + + create unique_index(:tags, ["lower(name)", :category], name: :tags_name_category_lower_index) + end + + def down do + drop index(:tags, ["lower(name)", :category], name: :tags_name_category_lower_index) + + create unique_index(:tags, [:name, :category]) + end +end diff --git a/priv/repo/seeds.exs b/priv/repo/seeds.exs index ab718a6..7fd6ef0 100644 --- a/priv/repo/seeds.exs +++ b/priv/repo/seeds.exs @@ -18,48 +18,55 @@ now = DateTime.utc_now() |> DateTime.truncate(:second) IO.puts("🌱 Seeding basic endgames into DB...") -Repo.insert_all(Endgame, [ - %{ - id: Ecto.UUID.generate(), - fen: "8/8/3k4/8/8/3K1R2/8/8 w - - 0 1", - color: :white, - key: "KR v K", - message: "Rook vs king endgame", - notes: "Basic rook endgame", - result: :win, - inserted_at: now, - updated_at: now - }, - %{ - id: Ecto.UUID.generate(), - fen: "6k1/5p2/6p1/8/7p/8/6PP/6K1 b - - 0 1", - color: :black, - key: "KPPP v KPP", - message: "3 pawns vs 2 pawns", - notes: "https://www.chessgames.com/perl/chessgame?gid=1017147", - result: :win, - inserted_at: now, - updated_at: now - } -]) +Repo.insert_all( + Endgame, + [ + %{ + id: Ecto.UUID.generate(), + fen: "8/8/3k4/8/8/3K1R2/8/8 w - - 0 1", + color: :white, + key: "KR v K", + message: "Rook vs king endgame", + notes: "Basic rook endgame", + result: :win, + inserted_at: now, + updated_at: now + }, + %{ + id: Ecto.UUID.generate(), + fen: "6k1/5p2/6p1/8/7p/8/6PP/6K1 b - - 0 1", + color: :black, + key: "KPPP v KPP", + message: "3 pawns vs 2 pawns", + notes: "https://www.chessgames.com/perl/chessgame?gid=1017147", + result: :win, + inserted_at: now, + updated_at: now + } + ], + on_conflict: :nothing +) IO.puts("✅ Done seeding endgames.") IO.puts("🌱 Seeding endgame tags into DB...") -Repo.insert_all(Tag, [ - %{ - name: "mate in 2", - category: :endgame, - inserted_at: now, - updated_at: now - }, - %{ - name: "mate in 3", - category: :endgame, - inserted_at: now, - updated_at: now - } -]) +theme_names = [ + "mate in 2", + "mate in 3", + "Lucena", + "Philidor", + "opposition", + "promotion", + "stalemate" +] + +Repo.insert_all( + Tag, + Enum.map(theme_names, fn name -> + %{name: name, category: :endgame, inserted_at: now, updated_at: now} + end), + on_conflict: :nothing +) IO.puts("✅ Done seeding endgame tags.") diff --git a/test/chesstrainer/endgames_test.exs b/test/chesstrainer/endgames_test.exs index bf7716d..ef8969e 100644 --- a/test/chesstrainer/endgames_test.exs +++ b/test/chesstrainer/endgames_test.exs @@ -3,6 +3,7 @@ defmodule Chesstrainer.EndgamesTest do alias Chesstrainer.Endgames alias Chesstrainer.Endgames.Endgame + alias Chesstrainer.Tags describe "create_endgame/1 FEN validation" do test "accepts a standard valid FEN" do @@ -85,4 +86,38 @@ defmodule Chesstrainer.EndgamesTest do assert msg =~ "active color" end end + + describe "tags" do + test "create_endgame/2 associates themes" do + {:ok, tag} = Tags.create_tag(%{name: "Lucena", category: :endgame}) + + attrs = %{ + fen: "8/8/3k4/8/8/3K1R2/8/8 w - - 0 1", + color: :white, + key: "KR v K", + result: :win, + rating: 1500 + } + + assert {:ok, endgame} = Endgames.create_endgame(attrs, [tag]) + assert Enum.map(endgame.tags, & &1.id) == [tag.id] + end + + test "update_endgame/3 replaces themes" do + {:ok, lucena} = Tags.create_tag(%{name: "Lucena", category: :endgame}) + {:ok, philidor} = Tags.create_tag(%{name: "Philidor", category: :endgame}) + + attrs = %{ + fen: "6k1/5p2/6p1/8/7p/8/6PP/6K1 b - - 0 1", + color: :black, + key: "KPPP v KPP", + result: :win, + rating: 1500 + } + + assert {:ok, endgame} = Endgames.create_endgame(attrs, [lucena]) + assert {:ok, updated} = Endgames.update_endgame(endgame, %{rating: 1600}, [philidor]) + assert Enum.map(updated.tags, & &1.id) == [philidor.id] + end + end end diff --git a/test/chesstrainer/tags_test.exs b/test/chesstrainer/tags_test.exs index c4eb490..8d75796 100644 --- a/test/chesstrainer/tags_test.exs +++ b/test/chesstrainer/tags_test.exs @@ -57,5 +57,23 @@ defmodule Chesstrainer.TagsTest do tag = tag_fixture() assert %Ecto.Changeset{} = Tags.change_tag(tag) end + + test "get_or_create/2 matches case-insensitively and trims" do + assert {:ok, tag} = Tags.get_or_create("Lucena", "endgame") + + assert {:ok, found} = Tags.get_or_create(" lucena ", "endgame") + assert found.id == tag.id + assert length(Tags.list_tags()) == 1 + end + + test "get_or_create/2 rejects a blank name" do + assert {:error, :blank_name} = Tags.get_or_create(" ", "endgame") + end + + test "create_tag/1 rejects a case-insensitive duplicate" do + assert {:ok, _tag} = Tags.create_tag(%{name: "Lucena", category: :endgame}) + assert {:error, changeset} = Tags.create_tag(%{name: "lucena", category: :endgame}) + assert changeset.errors[:name] + end end end diff --git a/test/chesstrainer_web/live/endgame_live/form_test.exs b/test/chesstrainer_web/live/endgame_live/form_test.exs new file mode 100644 index 0000000..3f22fa1 --- /dev/null +++ b/test/chesstrainer_web/live/endgame_live/form_test.exs @@ -0,0 +1,83 @@ +defmodule ChesstrainerWeb.EndgameLive.FormTest do + use ChesstrainerWeb.ConnCase + + import Phoenix.LiveViewTest + import Chesstrainer.TagsFixtures + + alias Chesstrainer.Endgames + alias Chesstrainer.Repo + alias Chesstrainer.Tags + + @fen "8/8/3k4/8/8/3K1R2/8/8 w - - 0 1" + + test "creates an endgame with staged themes", %{conn: conn} do + tag = tag_fixture(%{name: "Lucena"}) + + {:ok, view, _html} = live(conn, ~p"/admin/endgames/new") + + view |> form("#theme-form", %{tag_search: "Luc"}) |> render_change() + view |> element("button", "Lucena") |> render_click() + + view + |> form("#endgame-form", + endgame: %{fen: @fen, key: "KR v K", rating: 1500, result: "win"} + ) + |> render_submit() + + assert_redirect(view, ~p"/admin/endgames") + + endgame = + Endgames.list_endgames() + |> Enum.find(&(&1.fen == @fen)) + |> Repo.preload(:tags) + + assert Enum.map(endgame.tags, & &1.id) == [tag.id] + end + + test "attaches multiple themes", %{conn: conn} do + tag_fixture(%{name: "Lucena"}) + tag_fixture(%{name: "Philidor"}) + + {:ok, view, _html} = live(conn, ~p"/admin/endgames/new") + + view |> form("#theme-form", %{tag_search: "Luc"}) |> render_change() + view |> element("button", "Lucena") |> render_click() + + view |> form("#theme-form", %{tag_search: "Phil"}) |> render_change() + view |> element("button", "Philidor") |> render_click() + + html = render(view) + assert html =~ "Lucena" + assert html =~ "Philidor" + end + + test "creates and attaches a new theme inline", %{conn: conn} do + {:ok, view, _html} = live(conn, ~p"/admin/endgames/new") + + view |> form("#theme-form", %{tag_search: "Lucerne"}) |> render_submit() + + assert render(view) =~ "Lucerne" + assert [%{name: "Lucerne"}] = Tags.search("Lucerne", "endgame") + end + + test "removes a theme from an existing endgame", %{conn: conn} do + tag = tag_fixture(%{name: "Lucena"}) + attrs = %{fen: @fen, color: :white, key: "KR v K", result: :win, rating: 1500} + {:ok, endgame} = Endgames.create_endgame(attrs, [tag]) + + {:ok, view, _html} = live(conn, ~p"/admin/endgames/#{endgame}/edit") + + assert render(view) =~ "Lucena" + + view |> element("button[aria-label='Remove Lucena']") |> render_click() + + view + |> form("#endgame-form", endgame: %{key: "KR v K", rating: 1500, result: "win"}) + |> render_submit() + + assert_redirect(view, ~p"/admin/endgames") + + updated = Endgames.get_endgame!(endgame.id) |> Repo.preload(:tags) + assert updated.tags == [] + end +end diff --git a/test/chesstrainer_web/live/endgame_live/index_test.exs b/test/chesstrainer_web/live/endgame_live/index_test.exs new file mode 100644 index 0000000..15fd6ab --- /dev/null +++ b/test/chesstrainer_web/live/endgame_live/index_test.exs @@ -0,0 +1,19 @@ +defmodule ChesstrainerWeb.EndgameLive.IndexTest do + use ChesstrainerWeb.ConnCase + + import Phoenix.LiveViewTest + import Chesstrainer.EndgamesFixtures + import Chesstrainer.TagsFixtures + + alias Chesstrainer.Endgames + + test "lists an endgame's themes", %{conn: conn} do + tag = tag_fixture(%{name: "Lucena"}) + endgame = endgame_fixture() + {:ok, _endgame} = Endgames.update_endgame(endgame, %{}, [tag]) + + {:ok, _view, html} = live(conn, ~p"/admin/endgames") + + assert html =~ "Lucena" + end +end