Add displayname annotations (#3003)

* Add DisplayName annotations to pov

* Add DisplayName annotations to prime-factors

* Add DisplayName annotations to protein-translation

* Add DisplayName annotations to proverb

* Add DisplayName annotations to pythagorean-triplet

* Add DisplayName annotations to queen-attack

* Add DisplayName annotations to rail-fence-cipher

* Add DisplayName annotations to raindrops

* Add DisplayName annotations to rational-numbers

* Add DisplayName annotations to react

* Add DisplayName annotations to queen-attack

[no important files changed]

Author: bibekparajuli123

exercises/practice/pov/src/test/java/PovTest.java

@@ -1,4 +1,5 @@
 import org.junit.jupiter.api.Disabled;
+import org.junit.jupiter.api.DisplayName;
 import org.junit.jupiter.api.Test;
 
 import java.util.List;
@@ -9,6 +10,7 @@
 public class PovTest {
 
     @Test
+    @DisplayName("Results in the same tree if the input tree is a singleton")
     public void testFromPovGivenSingletonTree() {
         Tree tree = Tree.of("x");
         Tree expected = Tree.of("x");
@@ -17,6 +19,7 @@ public void testFromPovGivenSingletonTree() {
 
     @Disabled("Remove to run test")
     @Test
+    @DisplayName("Can reroot a tree with a parent and one sibling")
     public void testFromPovGivenTreeWithParentAndOneSibling() {
         Tree tree = Tree.of("parent",
                 List.of(Tree.of("x"),
@@ -30,6 +33,7 @@ public void testFromPovGivenTreeWithParentAndOneSibling() {
 
     @Disabled("Remove to run test")
     @Test
+    @DisplayName("Can reroot a tree with a parent and many siblings")
     public void testFromPovGivenTreeWithParentAndManySibling() {
         Tree tree = Tree.of("parent",
                 List.of(Tree.of("x"),
@@ -48,6 +52,7 @@ public void testFromPovGivenTreeWithParentAndManySibling() {
 
     @Disabled("Remove to run test")
     @Test
+    @DisplayName("an reroot a tree with new root deeply nested in the tree")
     public void testFromPovGivenTreeWithNewRootDeeplyNested() {
         Tree tree = Tree.of("level-0",
                 List.of(Tree.of("level-1",
@@ -66,6 +71,7 @@ public void testFromPovGivenTreeWithNewRootDeeplyNested() {
 
     @Disabled("Remove to run test")
     @Test
+    @DisplayName("Moves children of the new root to same level as former parent")
     public void testFromPovGivenMovesChildrenOfNewRootToSameLevelAsFormerParent() {
         Tree tree = Tree.of("parent",
                 List.of(Tree.of("x",
@@ -82,6 +88,7 @@ public void testFromPovGivenMovesChildrenOfNewRootToSameLevelAsFormerParent() {
 
     @Disabled("Remove to run test")
     @Test
+    @DisplayName("Can reroot a complex tree with cousins")
     public void testFromPovGivenComplexTreeWithCousins() {
         Tree tree = Tree.of("grandparent",
                 List.of(Tree.of("parent",
@@ -110,6 +117,7 @@ public void testFromPovGivenComplexTreeWithCousins() {
 
     @Disabled("Remove to run test")
     @Test
+    @DisplayName("Errors if target does not exist in a singleton tree")
     public void testFromPovGivenNonExistentTargetInSingletonTree() {
         Tree tree = Tree.of("x");
         assertThatExceptionOfType(UnsupportedOperationException.class)
@@ -119,6 +127,7 @@ public void testFromPovGivenNonExistentTargetInSingletonTree() {
 
     @Disabled("Remove to run test")
     @Test
+    @DisplayName("Errors if target does not exist in a larger tree")
     public void testFromPovGivenNonExistentTargetInLargeTree() {
         Tree tree = Tree.of("parent",
                 List.of(Tree.of("x",
@@ -134,6 +143,7 @@ public void testFromPovGivenNonExistentTargetInLargeTree() {
 
     @Disabled("Remove to run test")
     @Test
+    @DisplayName("Can find path to parent")
     public void testPathToCanFindPathToParent() {
         Tree tree = Tree.of("parent",
                 List.of(Tree.of("x"),
@@ -158,6 +168,7 @@ public void testPathToCanFindPathToSibling() {
 
     @Disabled("Remove to run test")
     @Test
+    @DisplayName("Can find path to cousin")
     public void testPathToCanFindPathToCousin() {
         Tree tree = Tree.of("grandparent",
                 List.of(Tree.of("parent",
@@ -176,6 +187,7 @@ public void testPathToCanFindPathToCousin() {
 
     @Disabled("Remove to run test")
     @Test
+    @DisplayName("Can find path not involving root")
     public void testPathToCanFindPathNotEnvolvingRoot() {
         Tree tree = Tree.of("grandparent",
                 List.of(Tree.of("parent",
@@ -189,6 +201,7 @@ public void testPathToCanFindPathNotEnvolvingRoot() {
 
     @Disabled("Remove to run test")
     @Test
+    @DisplayName("Can find path from nodes other than x")
     public void testPathToCanFindPathFromNodesOtherThanX() {
         Tree tree = Tree.of("parent",
                 List.of(Tree.of("a"),
@@ -202,6 +215,7 @@ public void testPathToCanFindPathFromNodesOtherThanX() {
 
     @Disabled("Remove to run test")
     @Test
+    @DisplayName("Errors if destination does not exist")
     public void testPathWhenDestinationDoesNotExist() {
         Tree tree = Tree.of("parent",
                 List.of(Tree.of("x",
@@ -217,6 +231,7 @@ public void testPathWhenDestinationDoesNotExist() {
 
     @Disabled("Remove to run test")
     @Test
+    @DisplayName("Errors if source does not exist")
     public void testPathWhenSourceDoesNotExist() {
         Tree tree = Tree.of("parent",
                 List.of(Tree.of("x",

exercises/practice/prime-factors/src/test/java/PrimeFactorsCalculatorTest.java

@@ -1,5 +1,6 @@
 import org.junit.jupiter.api.BeforeEach;
 import org.junit.jupiter.api.Disabled;
+import org.junit.jupiter.api.DisplayName;
 import org.junit.jupiter.api.Test;
 
 import static org.assertj.core.api.Assertions.assertThat;
@@ -14,72 +15,84 @@ public void setUp() {
     }
 
     @Test
+    @DisplayName("no factors")
     public void testNoFactors() {
         assertThat(primeFactorsCalculator.calculatePrimeFactorsOf(1L)).isEmpty();
     }
 
     @Disabled("Remove to run test")
     @Test
+    @DisplayName("prime number")
     public void testPrimeNumber() {
         assertThat(primeFactorsCalculator.calculatePrimeFactorsOf(2L)).containsExactly(2L);
     }
 
     @Disabled("Remove to run test")
     @Test
+    @DisplayName("another prime number")
     public void testAnotherPrimeNumber() {
         assertThat(primeFactorsCalculator.calculatePrimeFactorsOf(3L)).containsExactly(3L);
     }
 
     @Disabled("Remove to run test")
     @Test
+    @DisplayName("square of a prime")
     public void testSquareOfAPrime() {
         assertThat(primeFactorsCalculator.calculatePrimeFactorsOf(9L)).containsExactly(3L, 3L);
     }
 
     @Disabled("Remove to run test")
     @Test
+    @DisplayName("product of first prime")
     public void testProductOfFirstPrime() {
         assertThat(primeFactorsCalculator.calculatePrimeFactorsOf(4L)).containsExactly(2L, 2L);
     }
 
     @Disabled("Remove to run test")
     @Test
+    @DisplayName("cube of a prime")
     public void testCubeOfAPrime() {
         assertThat(primeFactorsCalculator.calculatePrimeFactorsOf(8L)).containsExactly(2L, 2L, 2L);
     }
 
     @Disabled("Remove to run test")
     @Test
+    @DisplayName("product of second prime")
     public void testProductOfSecondPrime() {
         assertThat(primeFactorsCalculator.calculatePrimeFactorsOf(625L)).containsExactly(5L, 5L, 5L, 5L);
     }
 
     @Disabled("Remove to run test")
     @Test
+    @DisplayName("product of third prime")
     public void testProductOfThirdPrime() {
         assertThat(primeFactorsCalculator.calculatePrimeFactorsOf(27L)).containsExactly(3L, 3L, 3L);
     }
 
     @Disabled("Remove to run test")
     @Test
+    @DisplayName("product of first and second prime")
     public void testProductOfFirstAndSecondPrime() {
         assertThat(primeFactorsCalculator.calculatePrimeFactorsOf(6L)).containsExactly(2L, 3L);
     }
 
     @Disabled("Remove to run test")
     @Test
+    @DisplayName("product of primes and non-primes")
     public void testProductOfPrimesAndNonPrimes() {
         assertThat(primeFactorsCalculator.calculatePrimeFactorsOf(12L)).containsExactly(2L, 2L, 3L);
     }
 
     @Disabled("Remove to run test")
     @Test
+    @DisplayName("product of primes")
     public void testProductOfPrimes() {
         assertThat(primeFactorsCalculator.calculatePrimeFactorsOf(901255L)).containsExactly(5L, 17L, 23L, 461L);
     }
 
     @Disabled("Remove to run test")
     @Test
+    @DisplayName("factors include a large prime")
     public void testFactorsIncludingALargePrime() {
         assertThat(primeFactorsCalculator.calculatePrimeFactorsOf(93819012551L)).containsExactly(11L, 9539L, 894119L);
     }