Refactors: InAppUpdateListener

wordpress-mobile · May 20, 2024 · c138065 · c138065
1 parent ec5dbb6
commit c138065
Show file tree

Hide file tree

Showing 7 changed files with 41 additions and 37 deletions.
diff --git a/WordPress/src/main/java/org/wordpress/android/inappupdate/IInAppUpdateListener.kt b/WordPress/src/main/java/org/wordpress/android/inappupdate/IInAppUpdateListener.kt
diff --git a/WordPress/src/main/java/org/wordpress/android/inappupdate/IInAppUpdateManager.kt b/WordPress/src/main/java/org/wordpress/android/inappupdate/IInAppUpdateManager.kt
@@ -3,7 +3,7 @@ package org.wordpress.android.inappupdate
 import android.app.Activity
 
 interface IInAppUpdateManager {
-    fun checkForAppUpdate(activity: Activity, listener: IInAppUpdateListener)
+    fun checkForAppUpdate(activity: Activity, listener: InAppUpdateListener)
     fun completeAppUpdate()
     fun cancelAppUpdate(updateType: Int)
     fun onUserAcceptedAppUpdate(updateType: Int)

diff --git a/WordPress/src/main/java/org/wordpress/android/inappupdate/InAppUpdateListener.kt b/WordPress/src/main/java/org/wordpress/android/inappupdate/InAppUpdateListener.kt
@@ -0,0 +1,34 @@
+package org.wordpress.android.inappupdate
+
+/**
+ * Abstract class for handling callbacks related to in-app update events.
+ *
+ * Each method provides a default implementation that does nothing, allowing
+ * implementers to only override the necessary methods without implementing
+ * all callback methods.
+ */
+abstract class InAppUpdateListener {
+    open fun onAppUpdateStarted(type: Int) {
+        // Default empty implementation
+    }
+
+    open fun onAppUpdateDownloaded() {
+        // Default empty implementation
+    }
+
+    open fun onAppUpdateInstalled() {
+        // Default empty implementation
+    }
+
+    open fun onAppUpdateFailed() {
+        // Default empty implementation
+    }
+
+    open fun onAppUpdateCancelled() {
+        // Default empty implementation
+    }
+
+    open fun onAppUpdatePending() {
+        // Default empty implementation
+    }
+}
diff --git a/WordPress/src/main/java/org/wordpress/android/inappupdate/InAppUpdateManagerImpl.kt b/WordPress/src/main/java/org/wordpress/android/inappupdate/InAppUpdateManagerImpl.kt
@@ -39,9 +39,9 @@ class InAppUpdateManagerImpl(
     private val inAppUpdateAnalyticsTracker: InAppUpdateAnalyticsTracker,
     private val currentTimeProvider: () -> Long = {System.currentTimeMillis()}
 ): IInAppUpdateManager {
-    private var updateListener: IInAppUpdateListener? = null
+    private var updateListener: InAppUpdateListener? = null
 
-    override fun checkForAppUpdate(activity: Activity, listener: IInAppUpdateListener) {
+    override fun checkForAppUpdate(activity: Activity, listener: InAppUpdateListener) {
         updateListener = listener
         appUpdateManager.appUpdateInfo.addOnSuccessListener { appUpdateInfo ->
             handleUpdateInfoSuccess(appUpdateInfo, activity)

diff --git a/WordPress/src/main/java/org/wordpress/android/inappupdate/InAppUpdateManagerNoop.kt b/WordPress/src/main/java/org/wordpress/android/inappupdate/InAppUpdateManagerNoop.kt
@@ -3,7 +3,7 @@ package org.wordpress.android.inappupdate
 import android.app.Activity
 
 class InAppUpdateManagerNoop: IInAppUpdateManager {
-    override fun checkForAppUpdate(activity: Activity, listener: IInAppUpdateListener) {
+    override fun checkForAppUpdate(activity: Activity, listener: InAppUpdateListener) {
         /* Empty implementation */
     }
 

diff --git a/WordPress/src/main/java/org/wordpress/android/ui/main/WPMainActivity.java b/WordPress/src/main/java/org/wordpress/android/ui/main/WPMainActivity.java
@@ -40,7 +40,7 @@
 import org.greenrobot.eventbus.Subscribe;
 import org.greenrobot.eventbus.ThreadMode;
 import org.wordpress.android.BuildConfig;
-import org.wordpress.android.inappupdate.IInAppUpdateListener;
+import org.wordpress.android.inappupdate.InAppUpdateListener;
 import org.wordpress.android.inappupdate.IInAppUpdateManager;
 import org.wordpress.android.R;
 import org.wordpress.android.WordPress;
@@ -1213,30 +1213,10 @@ private void checkForInAppUpdate() {
         mInAppUpdateManager.checkForAppUpdate(this, mInAppUpdateListener);
     }
 
-    @NonNull final IInAppUpdateListener mInAppUpdateListener = new IInAppUpdateListener() {
-        @Override public void onAppUpdatePending() {
-            /* do nothing */
-        }
-
+    @NonNull final InAppUpdateListener mInAppUpdateListener = new InAppUpdateListener() {
         @Override public void onAppUpdateDownloaded() {
             popupSnackbarForCompleteUpdate();
         }
-        @Override public void onAppUpdateStarted(int type) {
-            /* do nothing */
-        }
-
-        @Override public void onAppUpdateInstalled() {
-            /* do nothing */
-        }
-
-        @Override public void onAppUpdateFailed() {
-            /* do nothing */
-        }
-
-        @Override public void onAppUpdateCancelled() {
-            // Todo do I need to handle this?
-            /* do nothing */
-        }
     };
 
     private void popupSnackbarForCompleteUpdate() {

diff --git a/WordPress/src/test/java/org/wordpress/android/inappupdate/InAppUpdateManagerImplTest.kt b/WordPress/src/test/java/org/wordpress/android/inappupdate/InAppUpdateManagerImplTest.kt
@@ -51,7 +51,7 @@ class InAppUpdateManagerImplTest {
     lateinit var inAppUpdateAnalyticsTracker: InAppUpdateAnalyticsTracker
 
     @Mock
-    lateinit var updateListener: IInAppUpdateListener
+    lateinit var updateListener: InAppUpdateListener
 
     @Mock
     lateinit var activity: Activity