Issue #166: Added format string to @Parameters annotation in Scrabble… (#222)

* Added format string to @Parameters annotation in and (to make them more descriptive) changed names of variables and tests in:
  * AtbashTest,
  * BinaryTest,
  * OctalTest,
  * PigLatinTest,
  * RaindropsTest,
  * RomanNumeralsTest,
  * ScrabbleScoreTest.
* Removed repeated word in format string for PiglatinTest and ScrabbleScoreTest.

Fixes #160.
Fixes #161.
Fixes #162.
Fixes #163.
Fixes #164.
Fixes #165.
Fixes #166.

exercises/atbash-cipher/src/test/java/AtbashTest.java

@@ -15,10 +15,10 @@ public class AtbashTest {
 
     @RunWith(Parameterized.class)
     public static class EncodeTest {
-        private String input;
-        private String expectedOutput;
+        private String plaintext;
+        private String ciphertext;
 
-        @Parameters
+        @Parameters(name = "{index}: expected plaintext \"{0}\" to encode to ciphertext \"{1}\".")
         public static Collection<Object[]> data() {
             return Arrays.asList(new Object[][] {
                     { "no", "ml" },
@@ -31,15 +31,15 @@ public class AtbashTest {
             });
         }
 
-        public EncodeTest(String input, String expectedOutput) {
-            this.input = input;
-            this.expectedOutput = expectedOutput;
+        public EncodeTest(String plaintext, String ciphertext) {
+            this.plaintext = plaintext;
+            this.ciphertext = ciphertext;
         }
 
 
     @Test
         public void test() {
-            assertEquals(expectedOutput, Atbash.encode(input));
+            assertEquals(ciphertext, Atbash.encode(plaintext));
         }
     }
 

exercises/binary/src/test/java/BinaryTest.java

@@ -12,10 +12,10 @@ import static org.junit.Assert.assertEquals;
 @RunWith(Parameterized.class)
 public class BinaryTest {
 
-    private String input;
-    private int expectedOutput;
+    private String binaryNumberAsString;
+    private int decimalNumber;
 
-    @Parameters
+    @Parameters(name = "{index}: expected {1} when converting \"{0}\" from binary to decimal.")
     public static Collection<Object[]> data() {
         return Arrays.asList(new Object[][]{
                 {"1", 1},
@@ -34,16 +34,16 @@ public class BinaryTest {
         });
     }
 
-    public BinaryTest(String input, int expectedOutput) {
-        this.input = input;
-        this.expectedOutput = expectedOutput;
+    public BinaryTest(String binaryNumberAsString, int decimalNumber) {
+        this.binaryNumberAsString = binaryNumberAsString;
+        this.decimalNumber = decimalNumber;
     }
 
 
     @Test
     public void test() {
-        Binary binary = new Binary(input);
+        Binary binary = new Binary(binaryNumberAsString);
 
-        assertEquals(expectedOutput, binary.getDecimal());
+        assertEquals(decimalNumber, binary.getDecimal());
     }
 }

exercises/octal/src/test/java/OctalTest.java

@@ -11,10 +11,10 @@ import static org.junit.Assert.assertEquals;
 @RunWith(Parameterized.class)
 public class OctalTest {
 
-    private String input;
-    private int expectedOutput;
+    private String octalNumberAsString;
+    private int decimalNumber;
 
-    @Parameterized.Parameters
+    @Parameterized.Parameters(name = "{index}: expected {1} when converting \"{0}\" from octal to decimal.")
     public static Collection<Object[]> data() {
         return Arrays.asList(new Object[][]{
                 {"1", 1},
@@ -34,16 +34,16 @@ public class OctalTest {
         });
     }
 
-    public OctalTest(String input, int expectedOutput) {
-        this.input = input;
-        this.expectedOutput = expectedOutput;
+    public OctalTest(String octalNumberAsString, int decimalNumber) {
+        this.octalNumberAsString = octalNumberAsString;
+        this.decimalNumber = decimalNumber;
     }
 
 
     @Test
     public void test() {
-        Octal octal = new Octal(input);
+        Octal octal = new Octal(octalNumberAsString);
 
-        assertEquals(expectedOutput, octal.getDecimal());
+        assertEquals(decimalNumber, octal.getDecimal());
     }
 }

exercises/pig-latin/src/test/java/PigLatinTest.java

@@ -11,10 +11,10 @@ import static org.junit.Assert.assertEquals;
 @RunWith(Parameterized.class)
 public class PigLatinTest {
 
-    private String input;
-    private String expectedOutput;
+    private String englishPhrase;
+    private String pigLatinTranslation;
 
-    @Parameterized.Parameters
+    @Parameterized.Parameters(name = "{index}: expected \"{0}\" to translate to the pig latin phrase \"{1}\"")
     public static Collection<Object[]> data() {
         return Arrays.asList(new Object[][]{
                 // Ay is added to words that start with vowels
@@ -59,14 +59,14 @@ public class PigLatinTest {
         });
     }
 
-    public PigLatinTest(String input, String expectedOutput) {
-        this.input = input;
-        this.expectedOutput = expectedOutput;
+    public PigLatinTest(String englishPhrase, String pigLatinTranslation) {
+        this.englishPhrase = englishPhrase;
+        this.pigLatinTranslation = pigLatinTranslation;
     }
 
 
     @Test
     public void test() {
-        assertEquals(expectedOutput, PigLatin.translate(input));
+        assertEquals(pigLatinTranslation, PigLatin.translate(englishPhrase));
     }
 }

exercises/raindrops/src/test/java/RaindropsTest.java

@@ -12,10 +12,10 @@ import static org.junit.Assert.assertEquals;
 @RunWith(Parameterized.class)
 public class RaindropsTest {
 
-    private int input;
-    private String expectedOutput;
+    private int inputNumber;
+    private String outputFromRaindropConversion;
 
-    @Parameters
+    @Parameters(name = "{index}: expected input number {0} to be converted to \"{1}\"")
     public static Collection<Object[]> data() {
         return Arrays.asList(new Object[][]{
                 // Non-primes
@@ -46,14 +46,14 @@ public class RaindropsTest {
         });
     }
 
-    public RaindropsTest(int input, String expectedOutput) {
-        this.input = input;
-        this.expectedOutput = expectedOutput;
+    public RaindropsTest(int inputNumber, String outputFromRaindropConversion) {
+        this.inputNumber = inputNumber;
+        this.outputFromRaindropConversion = outputFromRaindropConversion;
     }
 
 
     @Test
     public void test() {
-        assertEquals(expectedOutput, Raindrops.convert(input));
+        assertEquals(outputFromRaindropConversion, Raindrops.convert(inputNumber));
     }
 }

exercises/roman-numerals/src/test/java/RomanNumeralsTest.java

@@ -12,10 +12,10 @@ import static org.junit.Assert.assertEquals;
 @RunWith(Parameterized.class)
 public class RomanNumeralsTest {
 
-    private int input;
-    private String expectedOutput;
+    private int arabicNumeral;
+    private String romanNumeral;
 
-    @Parameters
+    @Parameters(name = "{index}: expected arabic numeral {0} to be converted to roman numeral \"{1}\".")
     public static Collection<Object[]> data() {
         return Arrays.asList(new Object[][]{
                 {0, ""},
@@ -40,16 +40,16 @@ public class RomanNumeralsTest {
         });
     }
 
-    public RomanNumeralsTest(int input, String expectedOutput) {
-        this.input = input;
-        this.expectedOutput = expectedOutput;
+    public RomanNumeralsTest(int arabicNumeral, String romanNumeral) {
+        this.arabicNumeral = arabicNumeral;
+        this.romanNumeral = romanNumeral;
     }
 
 
     @Test
     public void convertArabicNumberalToRomanNumeral() {
-        RomanNumeral romanNumeral = new RomanNumeral(input);
+        RomanNumeral romanNumeral = new RomanNumeral(arabicNumeral);
 
-        assertEquals(expectedOutput, romanNumeral.getRomanNumeral());
+        assertEquals(this.romanNumeral, romanNumeral.getRomanNumeral());
     }
 }

exercises/scrabble-score/src/test/java/ScrabbleScoreTest.java

@@ -11,10 +11,10 @@ import static org.junit.Assert.assertEquals;
 @RunWith(Parameterized.class)
 public class ScrabbleScoreTest {
 
-    private String input;
-    private int expectedOutput;
+    private String scrabbleInput;
+    private int scrabbleScore;
 
-    @Parameterized.Parameters
+    @Parameterized.Parameters(name = "{index}: expected scrabble score for \"{0}\" to be {1}")
     public static Collection<Object[]> data() {
         return Arrays.asList(new Object[][]{
                 {"", 0},
@@ -29,16 +29,16 @@ public class ScrabbleScoreTest {
         });
     }
 
-    public ScrabbleScoreTest(String input, int expectedOutput) {
-        this.input = input;
-        this.expectedOutput = expectedOutput;
+    public ScrabbleScoreTest(String scrabbleInput, int scrabbleScore) {
+        this.scrabbleInput = scrabbleInput;
+        this.scrabbleScore = scrabbleScore;
     }
 
 
     @Test
     public void test() {
-        Scrabble scrabble = new Scrabble(input);
+        Scrabble scrabble = new Scrabble(scrabbleInput);
 
-        assertEquals(expectedOutput, scrabble.getScore());
+        assertEquals(scrabbleScore, scrabble.getScore());
     }
 }