Merge pull request #22 from patjackson52/feature/lifecycle-fixes

add fixes for restoring state in android when view is recreated

Author: patjackson52

app/src/main/java/com/willowtreeapps/namegame/store/BaseNameGameViewFragment.kt

@@ -1,6 +1,8 @@
 package com.willowtreeapps.namegame.store
 
+import android.os.Bundle
 import androidx.fragment.app.Fragment
+import com.willowtreeapps.common.Logger
 import com.willowtreeapps.common.Presenter
 import com.willowtreeapps.common.View
 import com.willowtreeapps.common.ui.GameResultsPresenter
@@ -14,10 +16,24 @@ open class BaseNameGameViewFragment<TPresenter: Presenter<*>>: Fragment(), Corou
         get() = Dispatchers.Main
 
     override lateinit var presenter: TPresenter
+    private var viewRecreated: Boolean = false
+
+    override fun onViewCreated(view: android.view.View, savedInstanceState: Bundle?) {
+        super.onViewCreated(view, savedInstanceState)
+        if (savedInstanceState == null)
+            Logger.d("savedInstanceState == null")
+        else {
+            Logger.d("savedInstanceState != null")
+            viewRecreated = true
+        }
+    }
 
     override fun onResume() {
         super.onResume()
         NameGameApp.gameEngine().attachView(this)
+        if (viewRecreated) {
+            presenter.recreateView()
+        }
     }
 
     override fun onPause() {

app/src/main/java/com/willowtreeapps/namegame/store/QuestionFragment.kt

@@ -7,6 +7,7 @@ import android.os.Bundle
 import android.view.LayoutInflater
 import android.view.View
 import android.view.ViewGroup
+import android.view.ViewTreeObserver
 import android.view.animation.BounceInterpolator
 import com.bumptech.glide.load.resource.drawable.DrawableTransitionOptions
 import com.willowtreeapps.common.QuestionViewState
@@ -17,6 +18,7 @@ import nl.dionsegijn.konfetti.models.Size
 import android.widget.Button
 import androidx.core.content.res.ResourcesCompat
 import androidx.interpolator.view.animation.FastOutSlowInInterpolator
+import com.willowtreeapps.common.Logger
 import com.willowtreeapps.common.ui.QuestionPresenter
 import com.willowtreeapps.namegame.*
 
@@ -33,6 +35,7 @@ class QuestionFragment : BaseNameGameViewFragment<QuestionPresenter>(), Question
     }
 
     override fun onViewCreated(view: View, savedInstanceState: Bundle?) {
+        super.onViewCreated(view, savedInstanceState)
         initViews()
     }
 
@@ -52,6 +55,65 @@ class QuestionFragment : BaseNameGameViewFragment<QuestionPresenter>(), Question
         return false
     }
 
+    override fun showProfileNotAnimated(viewState: QuestionViewState) {
+        view?.viewTreeObserver?.addOnGlobalLayoutListener(object : ViewTreeObserver.OnGlobalLayoutListener {
+            override fun onGlobalLayout() {
+                Logger.d("viewState: $viewState")
+                GlideApp.with(this@QuestionFragment).load(viewState.itemImageUrl)
+                        .into(imageView)
+                txt_question_title.text = viewState.title
+                when {
+                    viewState.nextButtonVisible -> {
+                        txt_timer.visibility = View.GONE
+                        btn_next.visibility = View.VISIBLE
+                        btn_next.alpha = 1f
+                        btn_end_game.visibility = View.GONE
+                        btn_end_game.alpha = 0f
+                        showCorrectButton(viewState.correctBtnNum)
+                        setButtonText(viewState)
+                    }
+                    viewState.endButtonVisible -> {
+                        txt_timer.visibility = View.GONE
+                        btn_next.visibility = View.GONE
+                        btn_next.alpha = 0f
+                        btn_end_game.visibility = View.VISIBLE
+                        btn_end_game.alpha = 1f
+                        showCorrectButton(viewState.correctBtnNum)
+                        setButtonText(viewState)
+                    }
+                    else -> {
+                        txt_timer.text = viewState.timerText
+                        setButtonText(viewState)
+                        setAllButtonsVisible()
+                        btn_next.visibility = View.GONE
+                        btn_next.alpha = 0f
+                        btn_end_game.visibility = View.GONE
+                        btn_end_game.alpha = 1f
+                        //start timer again
+                        presenter.profileImageIsVisible()
+                    }
+
+                }
+                view?.viewTreeObserver?.removeOnGlobalLayoutListener(this)
+            }
+        })
+    }
+
+    private fun showCorrectButton(correctBtnNum: Int) {
+        val correctBtn = getBtnByNum(correctBtnNum)
+        if (correctBtn != null) {
+            correctBtn.visibility = View.VISIBLE
+            correctBtn.alpha = 1f
+            restoreX = correctBtn.x
+            restoreY = correctBtn.y
+            correctBtn.x = correctBtnX(correctBtn)
+            correctBtn.y = correctBtnY()
+            correctBtn.scaleX = 2f
+            correctBtn.scaleY = 2f
+            lastCorrectBtn = correctBtn
+        }
+    }
+
     override fun showProfile(viewState: QuestionViewState) {
         activity?.runOnUiThread {
             if (btn_next.visibility == View.VISIBLE) {
@@ -60,7 +122,6 @@ class QuestionFragment : BaseNameGameViewFragment<QuestionPresenter>(), Question
                 setProfileAndFadeIn(viewState)
             }
         }
-
     }
 
     override fun showCorrectAnswer(viewState: QuestionViewState, isEndGame: Boolean) {
@@ -101,6 +162,9 @@ class QuestionFragment : BaseNameGameViewFragment<QuestionPresenter>(), Question
         }
     }
 
+    private fun correctBtnX(btn: Button) = imageView.x + (imageView.width - btn.width) / 2
+    private fun correctBtnY() = imageView.y + imageView.height
+
     /**
      *  Hides the incorrect buttons and animates the correct name to be centered below profile image
      */
@@ -109,10 +173,10 @@ class QuestionFragment : BaseNameGameViewFragment<QuestionPresenter>(), Question
         val correctBtn = getBtnByNum(viewState.correctBtnNum)
         val selectedBtn = getBtnByNum(viewState.selectedBtnNum)
 
-        fun View.hideOrMoveAnimation(): AnimatorSet {
+        fun Button.hideOrMoveAnimation(): AnimatorSet {
             return if (this == correctBtn) {
-                val endX = imageView.x + (imageView.width - this.width) / 2
-                val endY = imageView.y + imageView.height
+                val endX = correctBtnX(this)
+                val endY = correctBtnY()
 
                 val animX = ObjectAnimator.ofFloat(this, View.X, endX)
                 val animY = ObjectAnimator.ofFloat(this, View.Y, endY)
@@ -133,26 +197,29 @@ class QuestionFragment : BaseNameGameViewFragment<QuestionPresenter>(), Question
         lastCorrectBtn = correctBtn
         lastSelectedBtn = selectedBtn
 
-        val anim1 = button1.hideOrMoveAnimation()
-        val anim2 = button2.hideOrMoveAnimation()
-        val anim3 = button3.hideOrMoveAnimation()
-        val anim4 = button4.hideOrMoveAnimation()
+        val anim1 = button1?.hideOrMoveAnimation()
+        val anim2 = button2?.hideOrMoveAnimation()
+        val anim3 = button3?.hideOrMoveAnimation()
+        val anim4 = button4?.hideOrMoveAnimation()
 
-        val set = AnimatorSet()
-        set.playTogether(anim1, anim2, anim3, anim4)
-        set.onComplete {
-            val btn = if (isEndGame) {
-                btn_end_game
-            } else {
-                btn_next
-            }
-            if (btn != null) {
-                btn.visibility = View.VISIBLE
-                btn.alpha = 0F
-                btn.animate().alpha(1f)
+        //TODO replace with isViewCreated fun
+        if (anim1 != null) {
+            val set = AnimatorSet()
+            set.playTogether(anim1, anim2, anim3, anim4)
+            set.onComplete {
+                val btn = if (isEndGame) {
+                    btn_end_game
+                } else {
+                    btn_next
+                }
+                if (btn != null) {
+                    btn.visibility = View.VISIBLE
+                    btn.alpha = 0F
+                    btn.animate().alpha(1f)
+                }
             }
+            set.start()
         }
-        set.start()
     }
 
     private fun showButtons() {
@@ -169,29 +236,48 @@ class QuestionFragment : BaseNameGameViewFragment<QuestionPresenter>(), Question
     private fun fadeNextButton(after: () -> Unit) {
         btn_next.animate().alpha(0f).withEndAction {
             lastCorrectBtn?.alpha = 0f
-            btn_next.visibility = View.GONE
+            btn_next?.visibility = View.GONE
             after()
         }
     }
 
     private fun setProfileAndFadeIn(viewState: QuestionViewState) {
         with(viewState) {
-            txt_question_title.text = title
-            GlideApp.with(this@QuestionFragment).load(itemImageUrl)
-                    .transition(DrawableTransitionOptions.withCrossFade())
-                    .onComplete {
-                        showButtons()
-                        txt_timer.visibility = View.VISIBLE
-                        presenter.profileImageIsVisible()
-                    }
-                    .into(imageView)
+            if (txt_question_title != null) {
+                txt_question_title.text = title
+                GlideApp.with(this@QuestionFragment).load(itemImageUrl)
+                        .transition(DrawableTransitionOptions.withCrossFade())
+                        .onComplete {
+                            showButtons()
+                            txt_timer.visibility = View.VISIBLE
+                            presenter.profileImageIsVisible()
+                        }
+                        .into(imageView)
+                setButtonText(viewState)
+            }
+        }
+    }
+
+    private fun setButtonText(viewState: QuestionViewState) {
+        with(viewState) {
             button1.text = button1Text
             button2.text = button2Text
             button3.text = button3Text
             button4.text = button4Text
         }
     }
 
+    private fun setAllButtonsVisible() {
+        button1.visibility = View.VISIBLE
+        button2.visibility = View.VISIBLE
+        button3.visibility = View.VISIBLE
+        button4.visibility = View.VISIBLE
+        button1.alpha = 1f
+        button2.alpha = 1f
+        button3.alpha = 1f
+        button4.alpha = 1f
+    }
+
     override fun setTimerText(viewState: QuestionViewState) {
         activity?.runOnUiThread {
             txt_timer.scaleX = 0f
@@ -228,10 +314,10 @@ class QuestionFragment : BaseNameGameViewFragment<QuestionPresenter>(), Question
                     .setDuration(500)
                     .withEndAction {
                         showWrongAnswer(viewState, isEndGame)
-                        txt_timer.animate().alpha(0f)
-                                .withEndAction {
-                                    txt_timer.visibility = View.VISIBLE
-                                    txt_timer.setTextColor(restoreColor)
+                        txt_timer?.animate()?.alpha(0f)
+                                ?.withEndAction {
+                                    txt_timer?.visibility = View.VISIBLE
+                                    txt_timer?.setTextColor(restoreColor)
                                 }
                     }
 

common/src/commonMain/kotlin/com/willowtreeapps/common/AppState.kt

@@ -6,7 +6,6 @@ data class AppState(val isLoadingItems: Boolean = false,
                     val errorMsg: String = "",
                     val currentQuestionIndex: Int = 0,
                     val waitingForNextQuestion: Boolean = false,
-                    val waitingForResultsTap: Boolean = false,
                     val questionClock: Int = -1,
                     val questionTitle: String = "",
                     val questions: List<Question> = listOf(),
@@ -34,6 +33,8 @@ data class AppState(val isLoadingItems: Boolean = false,
 
     fun isGameComplete(): Boolean = currentQuestionIndex >= questions.size || (currentQuestionIndex == questions.size - 1 && questions[currentQuestionIndex].status != Question.Status.UNANSWERED)
 
+    fun isCurrentQuestionAnswered(): Boolean = currentQuestion?.status != Question.Status.UNANSWERED
+
     val numCorrect: Int
         get() = questions.count { it.status == Question.Status.CORRECT }
 }
@@ -85,4 +86,3 @@ data class UserSettings(val numQuestions: Int,
         fun defaults() = UserSettings(3, categoryId = QuestionCategoryId.CATS)
     }
 }
-

common/src/commonMain/kotlin/com/willowtreeapps/common/GameEngine.kt

@@ -3,8 +3,8 @@ package com.willowtreeapps.common
 import com.beyondeye.reduks.SimpleStore
 import com.beyondeye.reduks.middlewares.applyMiddleware
 import com.beyondeye.reduks.middlewares.thunkMiddleware
+import com.willowtreeapps.common.middleware.*
 import com.willowtreeapps.common.middleware.NavigationMiddleware
-import com.willowtreeapps.common.middleware.Navigator
 import com.willowtreeapps.common.middleware.SettingsMiddleware
 import com.willowtreeapps.common.middleware.ViewEffectsMiddleware
 import com.willowtreeapps.common.repo.LocalStorageSettingsRepository
@@ -20,20 +20,22 @@ class GameEngine(navigator: Navigator,
     private val viewEffectsMiddleware = ViewEffectsMiddleware()
     private val presenterFactory by lazy { PresenterFactory(this, networkContext) }
     val vibrateUtil = VibrateUtil(application)
-    private val settingsMiddleware by lazy {  SettingsMiddleware(LocalStorageSettingsRepository(userSettings(application)), networkContext) }
+    private val settingsMiddleware by lazy { SettingsMiddleware(LocalStorageSettingsRepository(userSettings(application)), networkContext) }
 
     val appStore by lazy {
         SimpleStore(AppState.INITIAL_STATE, ::reducer)
                 .applyMiddleware(::thunkMiddleware,
                         viewEffectsMiddleware::dispatch,
                         navigationMiddleware::dispatch,
-                        settingsMiddleware::dispatch)
+                        settingsMiddleware::dispatch,
+                        ::loggerMiddleware)
     }
 
     init {
         appStore.dispatch(Actions.LoadAllSettingsAction())
     }
-    fun <T: Presenter<*>>attachView(view: View<T>) = presenterFactory.attachView(view as View<Presenter<*>>)
+
+    fun <T : Presenter<*>> attachView(view: View<T>) = presenterFactory.attachView(view as View<Presenter<*>>)
 
     fun detachView(view: View<*>) = presenterFactory.detachView(view)
 }

common/src/commonMain/kotlin/com/willowtreeapps/common/Reducers.kt

@@ -31,7 +31,7 @@ internal fun reducer(state: AppState, action: Any): AppState =
                 state.copy(questions = newQuestions, waitingForNextQuestion = true)
             }
             is NextQuestionAction -> state.copy(waitingForNextQuestion = false, currentQuestionIndex = state.currentQuestionIndex + 1)
-            is GameCompleteAction -> state.copy(waitingForResultsTap = true, waitingForNextQuestion = false, currentQuestionIndex = state.currentQuestionIndex + 1)
+            is GameCompleteAction -> state.copy(waitingForNextQuestion = false, currentQuestionIndex = state.currentQuestionIndex + 1)
             is StartOverAction, is ResetGameStateAction -> AppState.INITIAL_STATE.copy(settings = state.settings)
             is StartQuestionTimerAction -> state.copy(questionClock = action.initialValue)
             is DecrementCountDownAction -> state.copy(questionClock = state.questionClock - 1)

common/src/commonMain/kotlin/com/willowtreeapps/common/TimerThunks.kt

@@ -16,19 +16,22 @@ class TimerThunks(private val backgroundContext: CoroutineContext, val store: St
      * the timer and start the new one.
      */
     fun startCountDownTimer(initialValue: Int): ThunkImpl<AppState> = ThunkFn { dispatcher, state ->
-        if (timerJob == null || timerJob?.isActive == false) {
+        if (timerJob == null || timerJob?.isCompleted == true) {
+            Logger.d("Launching new Timer")
             store.dispatch(Actions.StartQuestionTimerAction(initialValue))
             timerJob = launchTimer(1000, CoroutineScope(coroutineContext)) {
-
                 if (store.state.questionClock > 0) {
                     store.dispatch(Actions.DecrementCountDownAction())
                 } else {
                     store.dispatch(Actions.TimesUpAction())
                     timerJob?.cancel()
+
                 }
             }
+            timerJob?.invokeOnCompletion {
+                Logger.d("TIMERJOB is complete: ${it?.message}")
+            }
         }
-        Any()
     }
 
     fun stopTimer() {

common/src/commonMain/kotlin/com/willowtreeapps/common/boundary/TransformFunctions.kt

@@ -26,6 +26,8 @@ fun AppState.toQuestionViewState(): QuestionViewState {
             button3Text = choice3,
             button4Text = choice4,
             correctBtnNum = correctBtnNum,
+            nextButtonVisible = this.waitingForNextQuestion && !isGameComplete(),
+            endButtonVisible = isGameComplete(),
             timerText = timerText,
             selectedBtnNum =  selectedBtnNum ?: -1)
 }

common/src/commonMain/kotlin/com/willowtreeapps/common/middleware/LoggingMiddleware.kt

@@ -0,0 +1,12 @@
+package com.willowtreeapps.common.middleware
+
+import com.beyondeye.reduks.Store
+import com.willowtreeapps.common.Actions
+import com.willowtreeapps.common.AppState
+import com.willowtreeapps.common.Logger
+
+fun loggerMiddleware(store: Store<AppState>, nextDispatcher: (Any) -> Any, action: Any): Any {
+    val result = nextDispatcher(action)
+    Logger.d("DISPATCH action: ${action::class.simpleName}")
+    return result
+}