mirror of
https://github.com/TheRealOwenRees/chess-endgame-trainer.git
synced 2026-11-18 03:32:06 +00:00
Derive canonical material Key from the FEN
The Endgame key is now a canonical, colour-agnostic material signature derived from the FEN instead of a hand-typed field: each side's pieces, strongest side first by material value (e.g. "KQ v KR"). This fixes the seed ordering inconsistency and guarantees the key always matches the position. - Add Chesstrainer.Key.from_fen/1. - Compute the key in the Endgame changeset; drop the manual input and its regex validation. - Index endgames.key and derive keys in the seeds. - Document the Key term and the decision (ADR 0003). Closes #13
This commit is contained in:
@@ -6,23 +6,47 @@ defmodule Chesstrainer.EndgamesTest do
|
||||
alias Chesstrainer.Themes
|
||||
|
||||
describe "create_endgame/1 FEN validation" do
|
||||
test "accepts a standard valid FEN" do
|
||||
test "accepts a standard valid FEN and derives its key" do
|
||||
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)
|
||||
assert {:ok, %Endgame{} = endgame} = Endgames.create_endgame(attrs)
|
||||
assert endgame.key == "KR v K"
|
||||
end
|
||||
|
||||
test "derives the key from the strongest side, colour-agnostically" do
|
||||
attrs = %{
|
||||
fen: "6k1/5p2/6p1/8/7p/8/6PP/6K1 b - - 0 0",
|
||||
color: :black,
|
||||
result: :win,
|
||||
rating: 1500
|
||||
}
|
||||
|
||||
assert {:ok, endgame} = Endgames.create_endgame(attrs)
|
||||
assert endgame.key == "KPPP v KPP"
|
||||
end
|
||||
|
||||
test "ignores a supplied key and derives it from the FEN" do
|
||||
attrs = %{
|
||||
fen: "8/8/3k4/8/8/3K1R2/8/8 w - - 0 1",
|
||||
color: :white,
|
||||
key: "KQ v K",
|
||||
result: :win,
|
||||
rating: 1500
|
||||
}
|
||||
|
||||
assert {:ok, endgame} = Endgames.create_endgame(attrs)
|
||||
assert endgame.key == "KR v K"
|
||||
end
|
||||
|
||||
test "normalizes fullmove 0 to 1 before inserting" do
|
||||
attrs = %{
|
||||
fen: "6k1/5p2/6p1/8/7p/8/6PP/6K1 b - - 0 0",
|
||||
color: :black,
|
||||
key: "KPPP v KPP",
|
||||
result: :win,
|
||||
rating: 1500
|
||||
}
|
||||
@@ -35,7 +59,6 @@ defmodule Chesstrainer.EndgamesTest do
|
||||
attrs = %{
|
||||
fen: " 8/8/3k4/8/8/3K1R2/8/8 w - - 0 1\t\n",
|
||||
color: :white,
|
||||
key: "KR v K",
|
||||
result: :win,
|
||||
rating: 1500
|
||||
}
|
||||
@@ -48,7 +71,6 @@ defmodule Chesstrainer.EndgamesTest do
|
||||
attrs = %{
|
||||
fen: "4k3/8/8/8/8/8/8/0K7 w - - 0 1",
|
||||
color: :white,
|
||||
key: "KQ v K",
|
||||
result: :win,
|
||||
rating: 1500
|
||||
}
|
||||
@@ -62,7 +84,6 @@ defmodule Chesstrainer.EndgamesTest do
|
||||
attrs = %{
|
||||
fen: "8/8/3k4/8/8/3K1R2/8/8",
|
||||
color: :white,
|
||||
key: "KQ v K",
|
||||
result: :win,
|
||||
rating: 1500
|
||||
}
|
||||
@@ -76,7 +97,6 @@ defmodule Chesstrainer.EndgamesTest do
|
||||
attrs = %{
|
||||
fen: "8/8/3k4/8/8/3K1R2/8/8 x - - 0 1",
|
||||
color: :white,
|
||||
key: "KQ v K",
|
||||
result: :win,
|
||||
rating: 1500
|
||||
}
|
||||
@@ -94,7 +114,6 @@ defmodule Chesstrainer.EndgamesTest do
|
||||
attrs = %{
|
||||
fen: "8/8/3k4/8/8/3K1R2/8/8 w - - 0 1",
|
||||
color: :white,
|
||||
key: "KR v K",
|
||||
result: :win,
|
||||
rating: 1500
|
||||
}
|
||||
@@ -110,7 +129,6 @@ defmodule Chesstrainer.EndgamesTest do
|
||||
attrs = %{
|
||||
fen: "6k1/5p2/6p1/8/7p/8/6PP/6K1 b - - 0 1",
|
||||
color: :black,
|
||||
key: "KPPP v KPP",
|
||||
result: :win,
|
||||
rating: 1500
|
||||
}
|
||||
@@ -118,6 +136,7 @@ defmodule Chesstrainer.EndgamesTest do
|
||||
assert {:ok, endgame} = Endgames.create_endgame(attrs, [lucena])
|
||||
assert {:ok, updated} = Endgames.update_endgame(endgame, %{rating: 1600}, [philidor])
|
||||
assert Enum.map(updated.themes, & &1.id) == [philidor.id]
|
||||
assert updated.key == "KPPP v KPP"
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
@@ -0,0 +1,39 @@
|
||||
defmodule Chesstrainer.KeyTest do
|
||||
use ExUnit.Case, async: true
|
||||
|
||||
doctest Chesstrainer.Key
|
||||
|
||||
alias Chesstrainer.Key
|
||||
|
||||
describe "from_fen/1" do
|
||||
test "derives a rook endgame" do
|
||||
assert Key.from_fen("8/8/3k4/8/8/3K1R2/8/8 w - - 0 1") == {:ok, "KR v K"}
|
||||
end
|
||||
|
||||
test "is colour-agnostic" do
|
||||
white_queen = "8/8/3k1r2/8/8/3K1Q2/8/8 w - - 0 1"
|
||||
black_queen = "8/8/3k1q2/8/8/3K1R2/8/8 w - - 0 1"
|
||||
|
||||
assert Key.from_fen(white_queen) == {:ok, "KQ v KR"}
|
||||
assert Key.from_fen(black_queen) == {:ok, "KQ v KR"}
|
||||
end
|
||||
|
||||
test "puts the side with more material first" do
|
||||
assert Key.from_fen("6k1/5p2/6p1/8/7p/8/6PP/6K1 b - - 0 1") == {:ok, "KPPP v KPP"}
|
||||
end
|
||||
|
||||
test "orders equal-value sides deterministically" do
|
||||
white_bishop = "8/8/3k1n2/8/8/3K1B2/8/8 w - - 0 1"
|
||||
white_knight = "8/8/3k1b2/8/8/3K1N2/8/8 w - - 0 1"
|
||||
|
||||
assert Key.from_fen(white_bishop) == {:ok, "KB v KN"}
|
||||
assert Key.from_fen(white_knight) == {:ok, "KB v KN"}
|
||||
end
|
||||
|
||||
test "returns an error for malformed FENs" do
|
||||
assert Key.from_fen("not a fen") == {:error, :invalid_fen}
|
||||
assert Key.from_fen("8/8/8 w - - 0 1") == {:error, :invalid_fen}
|
||||
assert Key.from_fen(nil) == {:error, :invalid_fen}
|
||||
end
|
||||
end
|
||||
end
|
||||
@@ -20,7 +20,7 @@ defmodule ChesstrainerWeb.EndgameLive.FormTest do
|
||||
|
||||
view
|
||||
|> form("#endgame-form",
|
||||
endgame: %{fen: @fen, key: "KR v K", rating: 1500, result: "win"}
|
||||
endgame: %{fen: @fen, rating: 1500, result: "win"}
|
||||
)
|
||||
|> render_submit()
|
||||
|
||||
@@ -62,7 +62,7 @@ defmodule ChesstrainerWeb.EndgameLive.FormTest do
|
||||
|
||||
test "removes a theme from an existing endgame", %{conn: conn} do
|
||||
theme = theme_fixture(%{name: "Lucena"})
|
||||
attrs = %{fen: @fen, color: :white, key: "KR v K", result: :win, rating: 1500}
|
||||
attrs = %{fen: @fen, color: :white, result: :win, rating: 1500}
|
||||
{:ok, endgame} = Endgames.create_endgame(attrs, [theme])
|
||||
|
||||
{:ok, view, _html} = live(conn, ~p"/admin/endgames/#{endgame}/edit")
|
||||
@@ -72,7 +72,7 @@ defmodule ChesstrainerWeb.EndgameLive.FormTest do
|
||||
view |> element("button[aria-label='Remove Lucena']") |> render_click()
|
||||
|
||||
view
|
||||
|> form("#endgame-form", endgame: %{key: "KR v K", rating: 1500, result: "win"})
|
||||
|> form("#endgame-form", endgame: %{rating: 1500, result: "win"})
|
||||
|> render_submit()
|
||||
|
||||
assert_redirect(view, ~p"/admin/endgames")
|
||||
|
||||
@@ -78,7 +78,14 @@ defmodule ChesstrainerWeb.EndgameLive.PlayTest do
|
||||
end
|
||||
|
||||
test "shows endgame metadata in the header", %{conn: conn} do
|
||||
endgame = endgame_fixture(key: "KQ v K", color: :white, result: :win, rating: 1800)
|
||||
endgame =
|
||||
endgame_fixture(
|
||||
fen: "8/8/3k4/8/8/3K1Q2/8/8 w - - 0 1",
|
||||
color: :white,
|
||||
result: :win,
|
||||
rating: 1800
|
||||
)
|
||||
|
||||
seed_tablebase(endgame.fen)
|
||||
|
||||
{:ok, _view, html} = live(conn, ~p"/endgames/#{endgame}/play")
|
||||
|
||||
@@ -24,15 +24,13 @@ defmodule Chesstrainer.EndgamesFixtures do
|
||||
@doc """
|
||||
Generate an endgame.
|
||||
|
||||
A simple K v K position with a unique FEN, color,
|
||||
key, rating, and result.
|
||||
A simple K v K position with a unique FEN, color, rating, and result.
|
||||
"""
|
||||
def endgame_fixture(attrs \\ %{}) do
|
||||
{:ok, endgame} =
|
||||
attrs
|
||||
|> Enum.into(%{
|
||||
fen: unique_endgame_fen(),
|
||||
key: "KQ v K",
|
||||
color: :white,
|
||||
result: :win,
|
||||
rating: 1500
|
||||
|
||||
Reference in New Issue
Block a user