Make API to get change log nicer

cketti · Nov 4, 2016 · 5b90cf4 · 5b90cf4 · johnjohndoe · Jan 10, 2017
1 parent ac3b4cb
commit 5b90cf4
Show file tree

Hide file tree

Showing 3 changed files with 19 additions and 15 deletions.
diff --git a/ckChangeLog-core/src/main/java/de/cketti/library/changelog/ChangeLog.java b/ckChangeLog-core/src/main/java/de/cketti/library/changelog/ChangeLog.java
@@ -189,18 +189,20 @@ public void writeCurrentVersion() {
     }
 
     /**
-     * Returns the change log.
+     * Returns the full change log.
      *
-     * @param full
-     *         If this is {@code true} the full change log is returned. Otherwise only changes for
-     *         versions newer than the last version are returned.
+     * @return A sorted {@code List} containing {@link ReleaseItem}s representing the full change log.
+     */
+    public List<ReleaseItem> getChangeLog() {
+        return changeLogProvider.getChangeLog();
+    }
+
+    /**
+     * Returns the list of changes for versions newer than the last version ("What's New").
      *
-     * @return A sorted {@code List} containing {@link ReleaseItem}s representing the (partial)
-     *         change log.
+     * @return A sorted {@code List} containing {@link ReleaseItem}s representing the recent changes.
      */
-    public List<ReleaseItem> getChangeLog(boolean full) {
-        return full ?
-                changeLogProvider.getChangeLog() :
-                changeLogProvider.getChangeLogSince(lastVersionCode);
+    public List<ReleaseItem> getRecentChanges() {
+        return changeLogProvider.getChangeLogSince(lastVersionCode);
     }
 }
diff --git a/ckChangeLog-core/src/test/java/de/cketti/library/changelog/ChangeLogTest.java b/ckChangeLog-core/src/test/java/de/cketti/library/changelog/ChangeLogTest.java
@@ -125,24 +125,24 @@ public void writeCurrentVersion() throws Exception {
     }
 
     @Test
-    public void getChangeLog_withTrueArgument_shouldReturnDataFromChangeLogProvider() throws Exception {
+    public void getChangeLog_shouldReturnDataFromChangeLogProvider() throws Exception {
         ChangeLog changeLog = ChangeLog.newInstance(context, preferences, changeLogProvider);
         List<ReleaseItem> releaseItemsToReturn = new ArrayList<>();
         when(changeLogProvider.getChangeLog()).thenReturn(releaseItemsToReturn);
 
-        List<ReleaseItem> releaseItems = changeLog.getChangeLog(true);
+        List<ReleaseItem> releaseItems = changeLog.getChangeLog();
 
         assertSame(releaseItemsToReturn, releaseItems);
     }
 
     @Test
-    public void getChangeLog_withFalseArgument_shouldReturnDataFromChangeLogProvider() throws Exception {
+    public void getRecentChanges_shouldReturnDataFromChangeLogProvider() throws Exception {
         setLastVersionCode(2);
         ChangeLog changeLog = ChangeLog.newInstance(context, preferences, changeLogProvider);
         List<ReleaseItem> releaseItemsToReturn = new ArrayList<>();
         when(changeLogProvider.getChangeLogSince(2)).thenReturn(releaseItemsToReturn);
 
-        List<ReleaseItem> releaseItems = changeLog.getChangeLog(false);
+        List<ReleaseItem> releaseItems = changeLog.getRecentChanges();
 
         assertSame(releaseItemsToReturn, releaseItems);
     }

diff --git a/ckChangeLog-dialog/src/main/java/de/cketti/library/changelog/dialog/DialogChangeLog.java b/ckChangeLog-dialog/src/main/java/de/cketti/library/changelog/dialog/DialogChangeLog.java
@@ -112,7 +112,9 @@ private String getLog(boolean full) {
 
         String versionFormat = context.getResources().getString(R.string.changelog_version_format);
 
-        List<ReleaseItem> changelog = changeLog.getChangeLog(full);
+        List<ReleaseItem> changelog = full ?
+                changeLog.getChangeLog() :
+                changeLog.getRecentChanges();
 
         for (ReleaseItem release : changelog) {
             sb.append("<h1>");