Update bird-watcher to use best practices (exercism#1985)

jmrunkle · web-flow · commit c807679a7350 · 2021-09-05T15:34:41.000-07:00
* Update bird-watcher to use best practices

* Fix indentation level for BirdWatcherTest
diff --git a/exercises/concept/bird-watcher/.meta/src/reference/java/BirdWatcher.java b/exercises/concept/bird-watcher/.meta/src/reference/java/BirdWatcher.java
@@ -1,13 +1,13 @@
 
 class BirdWatcher {
-    private int[] birdsPerDay;
+    private final int[] birdsPerDay;
 
     public BirdWatcher(int[] birdsPerDay) {
-        this.birdsPerDay = birdsPerDay;
+        this.birdsPerDay = birdsPerDay.clone();
     }
 
     public int[] getLastWeek() {
-        return birdsPerDay;
+        return birdsPerDay.clone();
     }
 
     public int getToday() {
@@ -17,9 +17,8 @@ public int getToday() {
         return birdsPerDay[birdsPerDay.length - 1];
     }
 
-    public int incrementTodaysCount() {
+    public void incrementTodaysCount() {
         birdsPerDay[birdsPerDay.length - 1] = birdsPerDay[birdsPerDay.length - 1] + 1;
-        return birdsPerDay[birdsPerDay.length - 1];
     }
 
     public boolean hasDayWithoutBirds() {
diff --git a/exercises/concept/bird-watcher/src/main/java/BirdWatcher.java b/exercises/concept/bird-watcher/src/main/java/BirdWatcher.java
@@ -1,10 +1,11 @@
 
 class BirdWatcher {
-    private int[] birdsPerDay;
+    private final int[] birdsPerDay;
 
     public BirdWatcher(int[] birdsPerDay) {
-        this.birdsPerDay = birdsPerDay;
+        this.birdsPerDay = birdsPerDay.clone();
     }
+
     public int[] getLastWeek() {
         throw new UnsupportedOperationException("Please implement the BirdCount.getLastWeek() method");
     }
@@ -13,7 +14,7 @@ public int getToday() {
         throw new UnsupportedOperationException("Please implement the BirdCount.getToday() method");
     }
 
-    public int incrementTodaysCount() {
+    public void incrementTodaysCount() {
         throw new UnsupportedOperationException("Please implement the BirdCount.incrementTodaysCount() method");
     }
 
diff --git a/exercises/concept/bird-watcher/src/test/java/BirdWatcherTest.java b/exercises/concept/bird-watcher/src/test/java/BirdWatcherTest.java
@@ -7,8 +7,16 @@
 
 public class BirdWatcherTest {
 
+    private static final int DAY1 = 0;
+    private static final int DAY2 = 2;
+    private static final int DAY3 = 5;
+    private static final int DAY4 = 3;
+    private static final int DAY5 = 7;
+    private static final int DAY6 = 8;
+    private static final int TODAY = 4;
+
     private BirdWatcher birdWatcher;
-    private int lastWeek[] = {0, 2, 5, 3, 7, 8, 4};
+    private int lastWeek[] = {DAY1, DAY2, DAY3, DAY4, DAY5, DAY6, TODAY};
 
     @Before
     public void setUp() {
@@ -17,13 +25,14 @@ public void setUp() {
 
     @Test
     public void itTestGetLastWeek() {
-        assertThat(birdWatcher.getLastWeek().equals(lastWeek)).isTrue();
+        assertThat(birdWatcher.getLastWeek())
+            .containsExactly(DAY1, DAY2, DAY3, DAY4, DAY5, DAY6, TODAY);
     }
 
     @Test
     @Ignore("Remove to run test")
     public void itTestGetToday() {
-        assertThat(birdWatcher.getToday()).isEqualTo(lastWeek[lastWeek.length - 1]);
+        assertThat(birdWatcher.getToday()).isEqualTo(TODAY);
     }
 
     @Test
@@ -39,7 +48,7 @@ public void itShouldReturnZeroIfBirdWatcherLastWeekIsEmpty() {
     public void itIncrementTodaysCount() {
         int currentTodayCount = birdWatcher.getToday();
         birdWatcher.incrementTodaysCount();
-        assertThat(birdWatcher.getToday()).isEqualTo(currentTodayCount + 1);
+        assertThat(birdWatcher.getToday()).isEqualTo(TODAY + 1);
     }
 
     @Test
@@ -59,18 +68,20 @@ public void itShouldNotHaveDaysWithoutBirds() {
     @Test
     @Ignore("Remove to run test")
     public void itTestGetCountForFirstDays() {
-        assertThat(birdWatcher.getCountForFirstDays(4)).isEqualTo(10);
+        assertThat(birdWatcher.getCountForFirstDays(4)).isEqualTo(DAY1 + DAY2 + DAY3 + DAY4);
     }
 
     @Test
     @Ignore("Remove to run test")
     public void itTestGetCountForMoreDaysThanTheArraySize() {
-        assertThat(birdWatcher.getCountForFirstDays(10)).isEqualTo(29);
+        assertThat(birdWatcher.getCountForFirstDays(10))
+            .isEqualTo(DAY1 + DAY2 + DAY3 + DAY4 + DAY5 + DAY6 + TODAY);
     }
 
     @Test
     @Ignore("Remove to run test")
     public void itTestGetCountForBusyDays() {
+        // DAY3, DAY5 and DAY6 are all >= 5 birds
         assertThat(birdWatcher.getBusyDays()).isEqualTo(3);
     }
 

Original file line number	Diff line number	Diff line change
`@@ -1,13 +1,13 @@`
`1`	`1`
`2`	`2`	`class BirdWatcher {`
`3`		`- private int[] birdsPerDay;`
	`3`	`+ private final int[] birdsPerDay;`
`4`	`4`
`5`	`5`	`public BirdWatcher(int[] birdsPerDay) {`
`6`		`- this.birdsPerDay = birdsPerDay;`
	`6`	`+ this.birdsPerDay = birdsPerDay.clone();`
`7`	`7`	`}`
`8`	`8`
`9`	`9`	`public int[] getLastWeek() {`
`10`		`- return birdsPerDay;`
	`10`	`+ return birdsPerDay.clone();`
`11`	`11`	`}`
`12`	`12`
`13`	`13`	`public int getToday() {`
`@@ -17,9 +17,8 @@ public int getToday() {`
`17`	`17`	`return birdsPerDay[birdsPerDay.length - 1];`
`18`	`18`	`}`
`19`	`19`
`20`		`- public int incrementTodaysCount() {`
	`20`	`+ public void incrementTodaysCount() {`
`21`	`21`	`birdsPerDay[birdsPerDay.length - 1] = birdsPerDay[birdsPerDay.length - 1] + 1;`
`22`		`- return birdsPerDay[birdsPerDay.length - 1];`
`23`	`22`	`}`
`24`	`23`
`25`	`24`	`public boolean hasDayWithoutBirds() {`
Original file line number	Diff line number	Diff line change
`@@ -1,10 +1,11 @@`
`1`	`1`
`2`	`2`	`class BirdWatcher {`
`3`		`- private int[] birdsPerDay;`
	`3`	`+ private final int[] birdsPerDay;`
`4`	`4`
`5`	`5`	`public BirdWatcher(int[] birdsPerDay) {`
`6`		`- this.birdsPerDay = birdsPerDay;`
	`6`	`+ this.birdsPerDay = birdsPerDay.clone();`
`7`	`7`	`}`
	`8`	`+`
`8`	`9`	`public int[] getLastWeek() {`
`9`	`10`	`throw new UnsupportedOperationException("Please implement the BirdCount.getLastWeek() method");`
`10`	`11`	`}`
`@@ -13,7 +14,7 @@ public int getToday() {`
`13`	`14`	`throw new UnsupportedOperationException("Please implement the BirdCount.getToday() method");`
`14`	`15`	`}`
`15`	`16`
`16`		`- public int incrementTodaysCount() {`
	`17`	`+ public void incrementTodaysCount() {`
`17`	`18`	`throw new UnsupportedOperationException("Please implement the BirdCount.incrementTodaysCount() method");`
`18`	`19`	`}`
`19`	`20`