Sync high-scores (#918)

Author: IsaacUtah1379

bin/auto-sync.txt

@@ -30,6 +30,7 @@ gigasecond
 grade-school
 hamming
 hello-world
+high-scores
 house
 isbn-verifier
 isogram

exercises/practice/high-scores/.docs/instructions.append.md

@@ -0,0 +1,5 @@
+# Introduction append
+
+For this exercise, you may want to look at [PHP property hooks][property_hooks].
+
+[property_hooks]: https://www.php.net/manual/en/language.oop5.property-hooks.php

exercises/practice/high-scores/.docs/instructions.md

@@ -1,3 +1,6 @@
-# Manage a game player's High Score list.
+# Instructions
 
-Your task is to build a high-score component of the classic Frogger game, one of the highest selling and addictive games of all time, and a classic of the arcade era. Your task is to write methods that return the highest score from the list, the last added score and the three highest scores.
+Manage a game player's High Score list.
+
+Your task is to build a high-score component of the classic Frogger game, one of the highest selling and most addictive games of all time, and a classic of the arcade era.
+Your task is to write methods that return the highest score from the list, the last added score and the three highest scores.

exercises/practice/high-scores/.meta/config.json

@@ -16,5 +16,6 @@
       ".meta/example.php"
     ]
   },
-  "blurb": "Manage a player's High Score list"
+  "blurb": "Manage a player's High Score list.",
+  "source": "Tribute to the eighties' arcade game Frogger"
 }

exercises/practice/high-scores/.meta/example.php

@@ -1,27 +1,5 @@
 <?php
 
-/*
- * By adding type hints and enabling strict type checking, code can become
- * easier to read, self-documenting and reduce the number of potential bugs.
- * By default, type declarations are non-strict, which means they will attempt
- * to change the original type to match the type specified by the
- * type-declaration.
- *
- * In other words, if you pass a string to a function requiring a float,
- * it will attempt to convert the string value to a float.
- *
- * To enable strict mode, a single declare directive must be placed at the top
- * of the file.
- * This means that the strictness of typing is configured on a per-file basis.
- * This directive not only affects the type declarations of parameters, but also
- * a function's return type.
- *
- * For more info review the Concept on strict type checking in the PHP track
- * <link>.
- *
- * To disable strict typing, comment out the directive below.
- */
-
 declare(strict_types=1);
 
 class HighScores

exercises/practice/high-scores/.meta/tests.toml

@@ -0,0 +1,46 @@
+# This is an auto-generated file.
+#
+# Regenerating this file via `configlet sync` will:
+# - Recreate every `description` key/value pair
+# - Recreate every `reimplements` key/value pair, where they exist in problem-specifications
+# - Remove any `include = true` key/value pair (an omitted `include` key implies inclusion)
+# - Preserve any other key/value pair
+#
+# As user-added comments (using the # character) will be removed when this file
+# is regenerated, comments can be added via a `comment` key.
+
+[1035eb93-2208-4c22-bab8-fef06769a73c]
+description = "List of scores"
+
+[6aa5dbf5-78fa-4375-b22c-ffaa989732d2]
+description = "Latest score"
+
+[b661a2e1-aebf-4f50-9139-0fb817dd12c6]
+description = "Personal best"
+
+[3d996a97-c81c-4642-9afc-80b80dc14015]
+description = "Top 3 scores -> Personal top three from a list of scores"
+
+[1084ecb5-3eb4-46fe-a816-e40331a4e83a]
+description = "Top 3 scores -> Personal top highest to lowest"
+
+[e6465b6b-5a11-4936-bfe3-35241c4f4f16]
+description = "Top 3 scores -> Personal top when there is a tie"
+
+[f73b02af-c8fd-41c9-91b9-c86eaa86bce2]
+description = "Top 3 scores -> Personal top when there are less than 3"
+
+[16608eae-f60f-4a88-800e-aabce5df2865]
+description = "Top 3 scores -> Personal top when there is only one"
+
+[2df075f9-fec9-4756-8f40-98c52a11504f]
+description = "Top 3 scores -> Latest score after personal top scores"
+
+[809c4058-7eb1-4206-b01e-79238b9b71bc]
+description = "Top 3 scores -> Scores after personal top scores"
+
+[ddb0efc0-9a86-4f82-bc30-21ae0bdc6418]
+description = "Top 3 scores -> Latest score after personal best"
+
+[6a0fd2d1-4cc4-46b9-a5bb-2fb667ca2364]
+description = "Top 3 scores -> Scores after personal best"

exercises/practice/high-scores/HighScores.php

@@ -26,6 +26,11 @@
 
 class HighScores
 {
+    /**
+     * You will need to add the methods and properties to store and present the
+     * desired values yourself. You will want to consider using property hooks:
+     * https://www.php.net/manual/en/language.oop5.property-hooks.php
+     */
     public function __construct(array $scores)
     {
         throw new \BadFunctionCallException("Implement the HighScores class");

exercises/practice/high-scores/HighScoresTest.php

@@ -1,30 +1,9 @@
 <?php
 
-/*
- * By adding type hints and enabling strict type checking, code can become
- * easier to read, self-documenting and reduce the number of potential bugs.
- * By default, type declarations are non-strict, which means they will attempt
- * to change the original type to match the type specified by the
- * type-declaration.
- *
- * In other words, if you pass a string to a function requiring a float,
- * it will attempt to convert the string value to a float.
- *
- * To enable strict mode, a single declare directive must be placed at the top
- * of the file.
- * This means that the strictness of typing is configured on a per-file basis.
- * This directive not only affects the type declarations of parameters, but also
- * a function's return type.
- *
- * For more info review the Concept on strict type checking in the PHP track
- * <link>.
- *
- * To disable strict typing, comment out the directive below.
- */
-
 declare(strict_types=1);
 
 use PHPUnit\Framework\TestCase;
+use PHPUnit\Framework\Attributes\TestDox;
 
 class HighScoresTest extends TestCase
 {
@@ -33,69 +12,135 @@ public static function setUpBeforeClass(): void
         require_once 'HighScores.php';
     }
 
+    /**
+     * uuid: 1035eb93-2208-4c22-bab8-fef06769a73c
+     */
+    #[TestDox('List of scores')]
     public function testListOfScores(): void
     {
         $input = [30, 50, 20, 70];
         $this->assertEquals([30, 50, 20, 70], (new HighScores($input))->scores);
     }
 
+    /**
+     * uuid: 6aa5dbf5-78fa-4375-b22c-ffaa989732d2
+     */
+    #[TestDox('Latest score')]
     public function testLatestScore(): void
     {
         $input = [100, 0, 90, 30];
         $this->assertEquals(30, (new HighScores($input))->latest);
     }
 
+    /**
+     * uuid: b661a2e1-aebf-4f50-9139-0fb817dd12c6
+     */
+    #[TestDox('Personal best')]
     public function testPersonalBest(): void
     {
         $input = [40, 100, 70];
         $this->assertEquals(100, (new HighScores($input))->personalBest);
     }
 
-    public function testPersonalTopThreeFromAListOfScores(): void
+    /**
+     * uuid: 3d996a97-c81c-4642-9afc-80b80dc14015
+     */
+    #[TestDox('Top 3 scores -> Personal top three from a list of scores')]
+    public function testTop3ScoresPersonalTopThreeFromAListOfScores(): void
     {
         $input = [10, 30, 90, 30, 100, 20, 10, 0, 30, 40, 40, 70, 70];
         $this->assertEquals([100, 90, 70], (new HighScores($input))->personalTopThree);
     }
 
-    public function testPersonalTopHighestToLowest(): void
+    /**
+     * uuid: 1084ecb5-3eb4-46fe-a816-e40331a4e83a
+     */
+    #[TestDox('Top 3 scores -> Personal top highest to lowest')]
+    public function testTop3ScoresPersonalTopHighestToLowest(): void
     {
         $input = [20, 10, 30];
         $this->assertEquals([30, 20, 10], (new HighScores($input))->personalTopThree);
     }
 
-    public function testPersonalTopWhenThereIsATie(): void
+    /**
+     * uuid: e6465b6b-5a11-4936-bfe3-35241c4f4f16
+     */
+    #[TestDox('Top 3 scores -> Personal top when there is a tie')]
+    public function testTop3ScoresPersonalTopWhenThereIsATie(): void
     {
         $input = [40, 20, 40, 30];
         $this->assertEquals([40, 40, 30], (new HighScores($input))->personalTopThree);
     }
 
-    public function testPersonalTopWhenThereAreLessThan3(): void
+    /**
+     * uuid: f73b02af-c8fd-41c9-91b9-c86eaa86bce2
+     */
+    #[TestDox('Top 3 scores -> Personal top when there are less than 3')]
+    public function testTop3ScoresPersonalTopWhenThereAreLessThan3(): void
     {
         $input = [30, 70];
         $this->assertEquals([70, 30], (new HighScores($input))->personalTopThree);
     }
 
-    public function testPersonalTopWhenThereIsOnlyOne(): void
+    /**
+     * uuid: 16608eae-f60f-4a88-800e-aabce5df2865
+     */
+    #[TestDox('Top 3 scores -> Personal top when there is only one')]
+    public function testTop3ScoresPersonalTopWhenThereIsOnlyOne(): void
     {
         $input = [40];
         $this->assertEquals([40], (new HighScores($input))->personalTopThree);
     }
 
-    public function testLatestScoreDoesNotChangeAfterGettingPersonalBest(): void
+    /**
+     * uuid: 2df075f9-fec9-4756-8f40-98c52a11504f
+     */
+    #[TestDox('Top 3 scores -> Latest score after personal top scores')]
+    public function testTop3ScoresLatestScoreAfterPersonalTopScores(): void
+    {
+        $input     = [70, 50, 20, 30];
+        $highScore = new HighScores($input);
+
+        $this->assertEquals([70, 50, 30], $highScore->personalTopThree);
+        $this->assertEquals(30, $highScore->latest);
+    }
+
+    /**
+     * uuid: 809c4058-7eb1-4206-b01e-79238b9b71bc
+     */
+    #[TestDox('Top 3 scores -> Scores after personal top scores')]
+    public function testTop3ScoresScoresAfterPersonalTopScores(): void
+    {
+        $input     = [30, 50, 20, 70];
+        $highScore = new HighScores($input);
+
+        $this->assertEquals([70, 50, 30], $highScore->personalTopThree);
+        $this->assertEquals([30, 50, 20, 70], $highScore->scores);
+    }
+
+    /**
+     * uuid: ddb0efc0-9a86-4f82-bc30-21ae0bdc6418
+     */
+    #[TestDox('Top 3 scores -> Latest score after personal best')]
+    public function testTop3ScoresLatestScoreAfterPersonalBest(): void
     {
-        $input     = [20, 10, 30, 3, 2, 1];
+        $input     = [20, 70, 15, 25, 30];
         $highScore = new HighScores($input);
 
-        $this->assertEquals(30, $highScore->personalBest);
-        $this->assertEquals(1, $highScore->latest);
+        $this->assertEquals(70, $highScore->personalBest);
+        $this->assertEquals(30, $highScore->latest);
     }
 
-    public function testLatestScoreDoesNotChangeAfterGettingPersonalTopThree(): void
+    /**
+     * uuid: 6a0fd2d1-4cc4-46b9-a5bb-2fb667ca2364
+     */
+    #[TestDox('Top 3 scores -> Scores after personal best')]
+    public function testTop3ScoresScoresAfterPersonalBest(): void
     {
-        $input     = [20, 100, 30, 90, 2, 70];
+        $input     = [20, 70, 15, 25, 30];
         $highScore = new HighScores($input);
 
-        $this->assertEquals([100, 90, 70], $highScore->personalTopThree);
-        $this->assertEquals(70, $highScore->latest);
+        $this->assertEquals(70, $highScore->personalBest);
+        $this->assertEquals([20, 70, 15, 25, 30], $highScore->scores);
     }
 }