Remove usage of lookupService("appContext") from extension sample

Zhuinden · Zhuinden · commit 842bfc781fa1 · 2020-06-03T16:12:00.000+02:00
diff --git a/samples/advanced-samples/extensions-example/src/main/AndroidManifest.xml b/samples/advanced-samples/extensions-example/src/main/AndroidManifest.xml
@@ -3,6 +3,7 @@
     package="com.zhuinden.simplestackextensionsample">
 
     <application
+        android:name=".app.CustomApplication"
         android:allowBackup="true"
         android:icon="@mipmap/ic_launcher"
         android:label="@string/app_name"
diff --git a/samples/advanced-samples/extensions-example/src/main/java/com/zhuinden/simplestackextensionsample/app/AuthenticationManager.kt b/samples/advanced-samples/extensions-example/src/main/java/com/zhuinden/simplestackextensionsample/app/AuthenticationManager.kt
@@ -1,25 +1,20 @@
 package com.zhuinden.simplestackextensionsample.app
 
-import android.content.Context
-import android.preference.PreferenceManager
+import android.content.SharedPreferences
 
-object AuthenticationManager {
-    @Suppress("DEPRECATION") // w/e androidx-chan
-    fun isAuthenticated(appContext: Context): Boolean {
-        val sharedPref = PreferenceManager.getDefaultSharedPreferences(appContext)
-        return sharedPref.getBoolean("isRegistered", false)
+class AuthenticationManager(
+    private val sharedPreferences: SharedPreferences
+) {
+    fun isAuthenticated(): Boolean {
+        return sharedPreferences.getBoolean("isRegistered", false)
     }
 
-    @Suppress("DEPRECATION") // w/e androidx-chan
-    fun saveRegistration(appContext: Context) {
-        val sharedPref = PreferenceManager.getDefaultSharedPreferences(appContext)
-        sharedPref.edit().putBoolean("isRegistered", true).apply()
+    fun saveRegistration() {
+        sharedPreferences.edit().putBoolean("isRegistered", true).apply()
     }
 
-    @Suppress("DEPRECATION") // w/e androidx-chan
-    fun clearRegistration(appContext: Context) {
-        val sharedPref = PreferenceManager.getDefaultSharedPreferences(appContext)
-        sharedPref.edit().remove("isRegistered").apply()
+    fun clearRegistration() {
+        sharedPreferences.edit().remove("isRegistered").apply()
     }
 
     var authToken: String = "" // why would this be in the viewModel?
diff --git a/samples/advanced-samples/extensions-example/src/main/java/com/zhuinden/simplestackextensionsample/app/CustomApplication.kt b/samples/advanced-samples/extensions-example/src/main/java/com/zhuinden/simplestackextensionsample/app/CustomApplication.kt
@@ -0,0 +1,16 @@
+package com.zhuinden.simplestackextensionsample.app
+
+import android.app.Application
+import android.preference.PreferenceManager
+
+class CustomApplication: Application() {
+    lateinit var authenticationManager: AuthenticationManager
+        private set
+
+    override fun onCreate() {
+        super.onCreate()
+
+        @Suppress("DEPRECATION")
+        authenticationManager = AuthenticationManager(PreferenceManager.getDefaultSharedPreferences(this))
+    }
+}
diff --git a/samples/advanced-samples/extensions-example/src/main/java/com/zhuinden/simplestackextensionsample/app/MainActivity.kt b/samples/advanced-samples/extensions-example/src/main/java/com/zhuinden/simplestackextensionsample/app/MainActivity.kt
@@ -9,34 +9,37 @@ import com.zhuinden.simplestack.SimpleStateChanger
 import com.zhuinden.simplestack.StateChange
 import com.zhuinden.simplestack.navigator.Navigator
 import com.zhuinden.simplestackextensions.fragments.DefaultFragmentStateChanger
+import com.zhuinden.simplestackextensions.servicesktx.add
 import com.zhuinden.simplestackextensionsample.R
 import com.zhuinden.simplestackextensionsample.features.login.LoginKey
 import com.zhuinden.simplestackextensionsample.features.profile.ProfileKey
 import kotlinx.android.synthetic.main.main_activity.*
 
 class MainActivity : AppCompatActivity(), SimpleStateChanger.NavigationHandler {
     private lateinit var fragmentStateChanger: DefaultFragmentStateChanger
-    private lateinit var appContext: Context
+    private lateinit var authenticationManager: AuthenticationManager
 
     override fun onCreate(savedInstanceState: Bundle?) {
         super.onCreate(savedInstanceState)
         setContentView(R.layout.main_activity)
 
         fragmentStateChanger = DefaultFragmentStateChanger(supportFragmentManager, R.id.step9Root)
-        appContext = applicationContext
+
+        val app = application as CustomApplication
+        authenticationManager = app.authenticationManager
 
         Navigator.configure()
             .setStateChanger(SimpleStateChanger(this))
             .setScopedServices(ServiceProvider())
             .setGlobalServices(
                 GlobalServices.builder()
-                    .addService("appContext", appContext)
+                    .add(authenticationManager)
                     .build()
             )
             .install(
                 this, step9Root, History.of(
                     when {
-                        AuthenticationManager.isAuthenticated(appContext) -> ProfileKey()
+                        authenticationManager.isAuthenticated() -> ProfileKey()
                         else -> LoginKey()
                     }
                 )
@@ -55,7 +58,7 @@ class MainActivity : AppCompatActivity(), SimpleStateChanger.NavigationHandler {
 
     override fun onDestroy() {
         if (isFinishing) {
-            AuthenticationManager.clearRegistration(appContext) // just for sample repeat sake
+            authenticationManager.clearRegistration() // just for sample repeat sake
         }
 
         super.onDestroy()
diff --git a/samples/advanced-samples/extensions-example/src/main/java/com/zhuinden/simplestackextensionsample/app/ServiceProvider.kt b/samples/advanced-samples/extensions-example/src/main/java/com/zhuinden/simplestackextensionsample/app/ServiceProvider.kt
@@ -3,6 +3,7 @@ package com.zhuinden.simplestackextensionsample.app
 import com.zhuinden.simplestack.ServiceBinder
 import com.zhuinden.simplestackextensions.services.DefaultServiceProvider
 import com.zhuinden.simplestackextensions.servicesktx.add
+import com.zhuinden.simplestackextensions.servicesktx.lookup
 import com.zhuinden.simplestackextensionsample.features.registration.RegistrationViewModel
 
 class ServiceProvider : DefaultServiceProvider() {
@@ -13,12 +14,9 @@ class ServiceProvider : DefaultServiceProvider() {
 
         with(serviceBinder) {
             when (scope) { // explicit shared services
-                "registration" -> add(
-                    RegistrationViewModel(
-                        lookupService("appContext"),
-                        backstack
-                    )
-                )
+                "registration" -> {
+                    add(RegistrationViewModel(lookup(), backstack))
+                }
                 else -> {
                 }
             }
diff --git a/samples/advanced-samples/extensions-example/src/main/java/com/zhuinden/simplestackextensionsample/features/login/LoginKey.kt b/samples/advanced-samples/extensions-example/src/main/java/com/zhuinden/simplestackextensionsample/features/login/LoginKey.kt
@@ -12,7 +12,7 @@ import kotlinx.android.parcel.Parcelize
 data class LoginKey(private val placeholder: String = "") : DefaultFragmentKey(), DefaultServiceProvider.HasServices {
     override fun bindServices(serviceBinder: ServiceBinder) {
         with(serviceBinder) {
-            add(LoginViewModel(lookup("appContext"), backstack))
+            add(LoginViewModel(lookup(), backstack))
         }
     }
 
diff --git a/samples/advanced-samples/extensions-example/src/main/java/com/zhuinden/simplestackextensionsample/features/login/LoginViewModel.kt b/samples/advanced-samples/extensions-example/src/main/java/com/zhuinden/simplestackextensionsample/features/login/LoginViewModel.kt
@@ -15,7 +15,7 @@ import io.reactivex.rxkotlin.addTo
 import io.reactivex.rxkotlin.subscribeBy
 
 class LoginViewModel(
-    private val appContext: Context,
+    private val authenticationManager: AuthenticationManager,
     private val backstack: Backstack
 ) : Bundleable, ScopedServices.Registered {
     private val compositeDisposable = CompositeDisposable()
@@ -38,7 +38,7 @@ class LoginViewModel(
 
     fun onLoginClicked() {
         if (isLoginEnabled.get()) {
-            AuthenticationManager.saveRegistration(appContext)
+            authenticationManager.saveRegistration()
             backstack.setHistory(History.of(ProfileKey()), StateChange.FORWARD)
         }
     }
diff --git a/samples/advanced-samples/extensions-example/src/main/java/com/zhuinden/simplestackextensionsample/features/profile/ProfileKey.kt b/samples/advanced-samples/extensions-example/src/main/java/com/zhuinden/simplestackextensionsample/features/profile/ProfileKey.kt
@@ -12,7 +12,7 @@ import kotlinx.android.parcel.Parcelize
 data class ProfileKey(private val placeholder: String = "") : DefaultFragmentKey(), DefaultServiceProvider.HasServices {
     override fun bindServices(serviceBinder: ServiceBinder) {
         with(serviceBinder) {
-            add(ProfileViewModel(lookup("appContext"), backstack))
+            add(ProfileViewModel(lookup(), backstack))
         }
     }
 
diff --git a/samples/advanced-samples/extensions-example/src/main/java/com/zhuinden/simplestackextensionsample/features/profile/ProfileViewModel.kt b/samples/advanced-samples/extensions-example/src/main/java/com/zhuinden/simplestackextensionsample/features/profile/ProfileViewModel.kt
@@ -9,11 +9,11 @@ import com.zhuinden.simplestackextensionsample.app.AuthenticationManager
 import com.zhuinden.simplestackextensionsample.features.login.LoginKey
 
 class ProfileViewModel(
-    private val appContext: Context,
+    private val authenticationManager: AuthenticationManager,
     private val backstack: Backstack
 ) : ScopedServices.Activated {
     override fun onServiceActive() {
-        if (!AuthenticationManager.isAuthenticated(appContext)) {
+        if (!authenticationManager.isAuthenticated()) {
             backstack.setHistory(History.of(LoginKey()), StateChange.REPLACE)
         }
     }
diff --git a/samples/advanced-samples/extensions-example/src/main/java/com/zhuinden/simplestackextensionsample/features/registration/RegistrationViewModel.kt b/samples/advanced-samples/extensions-example/src/main/java/com/zhuinden/simplestackextensionsample/features/registration/RegistrationViewModel.kt
@@ -14,7 +14,7 @@ import io.reactivex.rxkotlin.addTo
 import io.reactivex.rxkotlin.subscribeBy
 
 class RegistrationViewModel(
-    private val appContext: Context,
+    private val authenticationManager: AuthenticationManager,
     private val backstack: Backstack
 ) : Bundleable, ScopedServices.Registered, ScopedServices.HandlesBack {
     enum class RegistrationState { // this is actually kinda superfluous/unnecessary but ok
@@ -55,7 +55,7 @@ class RegistrationViewModel(
     fun onRegisterAndLoginClicked() {
         if (isRegisterAndLoginEnabled.get()) {
             currentState = RegistrationState.REGISTRATION_COMPLETED
-            AuthenticationManager.saveRegistration(appContext)
+            authenticationManager.saveRegistration()
             backstack.setHistory(History.of(ProfileKey()), StateChange.FORWARD)
         }
     }
diff --git a/tutorials/README.md b/tutorials/README.md
@@ -56,6 +56,14 @@ This way, we can handle result passing between screens as a regular callback met
 
 In this step, we'll add RxJava's BehaviorRelays and create ViewModel-internal subscriptions to provide field validation.
 
+## 10.) Replace custom code with the simple-stack-extensions
+
+Congratulations! 
+
+You can now check https://github.com/Zhuinden/simple-stack/tree/master/samples/advanced-samples/extensions-example and remove some clutter.
+
+Most of the things written throughout Step 5 to Step 9 are provided by `simple-stack-extensions`.
+
 ## License
 
     Copyright 2020 Gabor Varadi

Original file line number	Diff line number	Diff line change
`@@ -12,7 +12,7 @@ import kotlinx.android.parcel.Parcelize`
`12`	`12`	`data class LoginKey(private val placeholder: String = "") : DefaultFragmentKey(), DefaultServiceProvider.HasServices {`
`13`	`13`	`override fun bindServices(serviceBinder: ServiceBinder) {`
`14`	`14`	`with(serviceBinder) {`
`15`		`- add(LoginViewModel(lookup("appContext"), backstack))`
	`15`	`+ add(LoginViewModel(lookup(), backstack))`
`16`	`16`	`}`
`17`	`17`	`}`
`18`	`18`
Original file line number	Diff line number	Diff line change
`@@ -9,11 +9,11 @@ import com.zhuinden.simplestackextensionsample.app.AuthenticationManager`
`9`	`9`	`import com.zhuinden.simplestackextensionsample.features.login.LoginKey`
`10`	`10`
`11`	`11`	`class ProfileViewModel(`
`12`		`- private val appContext: Context,`
	`12`	`+ private val authenticationManager: AuthenticationManager,`
`13`	`13`	`private val backstack: Backstack`
`14`	`14`	`) : ScopedServices.Activated {`
`15`	`15`	`override fun onServiceActive() {`
`16`		`- if (!AuthenticationManager.isAuthenticated(appContext)) {`
	`16`	`+ if (!authenticationManager.isAuthenticated()) {`
`17`	`17`	`backstack.setHistory(History.of(LoginKey()), StateChange.REPLACE)`
`18`	`18`	`}`
`19`	`19`	`}`