579 - ODS-Module - About initialization

DEVELOP.md

@@ -18,7 +18,7 @@ repositories {
 
 ```groovy
 dependencies {
-    implementation 'com.orange.ods.android:ods-lib:0.15.0'
+    implementation 'com.orange.ods.android:ods-lib:0.15.1'
 }
 ```
 

app/build.gradle.kts

@@ -35,7 +35,7 @@ android {
         minSdk = Versions.minSdk
         targetSdk = Versions.targetSdk
         val versionCodeProperty = project.findTypedProperty<String>("versionCode")
-        versionCode = versionCodeProperty?.toInt() ?: 6
+        versionCode = versionCodeProperty?.toInt() ?: 7
         versionName = version.toString()
         val versionNameSuffixProperty = project.findTypedProperty<String>("versionNameSuffix")
         versionNameSuffix = versionNameSuffixProperty
@@ -127,12 +127,11 @@ dependencies {
     implementation(project(":lib"))
     implementation(project(":lib-xml"))
     implementation(project(":theme-innovation-cup"))
+    implementation(project(":module-about"))
 
-    implementation(Dependencies.accompanistFlowLayout)
     implementation(Dependencies.accompanistSystemUiController)
     implementation(Dependencies.activityCompose)
     implementation(Dependencies.appCompat)
-    implementation(Dependencies.browser)
     implementation(Dependencies.coil)
     implementation(Dependencies.coilCompose)
     implementation(platform(Dependencies.composeBom))

app/src/main/java/com/orange/ods/app/data/recipes/RecipesRepositoryImpl.kt

@@ -14,7 +14,7 @@ import android.content.Context
 import com.orange.ods.app.R
 import com.orange.ods.app.domain.recipes.Recipe
 import com.orange.ods.app.domain.recipes.RecipesRepository
-import com.orange.ods.app.ui.utilities.extension.contentAsString
+import com.orange.ods.extension.contentAsString
 import kotlinx.coroutines.flow.Flow
 import kotlinx.coroutines.flow.flow
 import timber.log.Timber

app/src/main/java/com/orange/ods/app/ui/AppNavigationController.kt

@@ -0,0 +1,60 @@
+/*
+ *
+ *  Copyright 2021 Orange
+ *
+ *  Use of this source code is governed by an MIT-style
+ *  license that can be found in the LICENSE file or at
+ *  https://opensource.org/licenses/MIT.
+ * /
+ */
+
+package com.orange.ods.app.ui
+
+import androidx.lifecycle.Lifecycle
+import androidx.navigation.NavBackStackEntry
+import androidx.navigation.NavController
+import androidx.navigation.NavDestination
+import androidx.navigation.NavGraph
+
+fun NavController.navigateToElement(route: String, elementId: Long?, from: NavBackStackEntry) {
+    // In order to discard duplicated navigation events, we check the Lifecycle
+    if (from.lifecycleIsResumed()) {
+        val fullRoute = if (elementId != null) "$route/$elementId" else route
+        navigate(fullRoute)
+    }
+}
+
+fun NavController.navigateToBottomBarRoute(route: String) {
+    navigate(route) {
+        // Avoid multiple copies of the same destination when
+        // reselecting the same item
+        launchSingleTop = true
+        // Restore state when reselecting a previously selected item
+        restoreState = true
+        // Pop up backstack to the first destination and save state. This makes going back
+        // to the start destination when pressing back in any other bottom tab.
+        popUpTo(findStartDestination(graph).id) {
+            saveState = true
+        }
+    }
+}
+
+/**
+ * If the lifecycle is not resumed it means this NavBackStackEntry already processed a nav event.
+ *
+ * This is used to de-duplicate navigation events.
+ */
+private fun NavBackStackEntry.lifecycleIsResumed() =
+    this.getLifecycle().currentState == Lifecycle.State.RESUMED
+
+private val NavGraph.startDestination: NavDestination?
+    get() = findNode(startDestinationId)
+
+/**
+ * Copied from similar function in NavigationUI.kt
+ *
+ * https://cs.android.com/androidx/platform/frameworks/support/+/androidx-main:navigation/navigation-ui/src/main/java/androidx/navigation/ui/NavigationUI.kt
+ */
+private tailrec fun findStartDestination(graph: NavDestination): NavDestination {
+    return if (graph is NavGraph) findStartDestination(graph.startDestination!!) else graph
+}

app/src/main/java/com/orange/ods/app/ui/MainBottomNavigation.kt

@@ -13,24 +13,19 @@ package com.orange.ods.app.ui
 import androidx.annotation.DrawableRes
 import androidx.annotation.StringRes
 import androidx.compose.runtime.Composable
-import androidx.compose.ui.platform.LocalContext
 import androidx.compose.ui.res.painterResource
 import androidx.compose.ui.res.stringResource
-import androidx.navigation.NavBackStackEntry
+import androidx.navigation.NavController
 import androidx.navigation.NavGraphBuilder
 import androidx.navigation.compose.composable
 import com.orange.ods.app.R
-import com.orange.ods.app.ui.about.AboutScreen
-import com.orange.ods.app.ui.about.UrlAboutItem
-import com.orange.ods.app.ui.about.aboutItems
-import com.orange.ods.app.ui.about.id
 import com.orange.ods.app.ui.components.ComponentsScreen
 import com.orange.ods.app.ui.guidelines.GuidelinesScreen
 import com.orange.ods.app.ui.modules.ModulesScreen
-import com.orange.ods.app.ui.utilities.launchUrl
 import com.orange.ods.compose.component.bottomnavigation.OdsBottomNavigation
 import com.orange.ods.compose.component.bottomnavigation.OdsBottomNavigationItem
 import com.orange.ods.compose.component.bottomnavigation.OdsBottomNavigationItemIcon
+import com.orange.ods.module.about.navigation.OdsAboutRoute
 
 @Composable
 fun MainBottomNavigation(items: Array<BottomNavigationSections>, currentRoute: String, navigateToRoute: (String) -> Unit) {
@@ -40,42 +35,26 @@ fun MainBottomNavigation(items: Array<BottomNavigationSections>, currentRoute: S
                 icon = OdsBottomNavigationItemIcon(painter = painterResource(id = item.iconRes), contentDescription = ""),
                 label = stringResource(id = item.titleRes),
                 selected = currentRoute == item.route,
-                onClick = { navigateToRoute(item.route) }
+                onClick = {
+                    navigateToRoute(item.route)
+                }
             )
         }
     )
 }
 
-fun NavGraphBuilder.addBottomNavigationGraph(navigateToElement: (String, Long?, NavBackStackEntry) -> Unit) {
+fun NavGraphBuilder.addBottomNavigationGraph(navController: NavController) {
     composable(BottomNavigationSections.Guidelines.route) { from ->
-        val topAppBarConfiguration = MainTopAppBarState.DefaultConfiguration.newBuilder()
-            .prependAction(TopAppBarConfiguration.Action.Search)
-            .build()
-        LocalMainTopAppBarManager.current.updateTopAppBar(topAppBarConfiguration)
-        GuidelinesScreen(onGuidelineClick = { route -> navigateToElement(route, null, from) })
+        LocalMainTopAppBarManager.current.updateTopAppBar(MainTopAppBarState.DefaultWithSearchActionConfiguration)
+        GuidelinesScreen(onGuidelineClick = { route -> navController.navigateToElement(route, null, from) })
     }
     composable(BottomNavigationSections.Components.route) { from ->
-        val topAppBarConfiguration = MainTopAppBarState.DefaultConfiguration.newBuilder()
-            .prependAction(TopAppBarConfiguration.Action.Search)
-            .build()
-        LocalMainTopAppBarManager.current.updateTopAppBar(topAppBarConfiguration)
-        ComponentsScreen(onComponentClick = { id -> navigateToElement(MainDestinations.ComponentDetailRoute, id, from) })
+        LocalMainTopAppBarManager.current.updateTopAppBar(MainTopAppBarState.DefaultWithSearchActionConfiguration)
+        ComponentsScreen(onComponentClick = { id -> navController.navigateToElement(MainDestinations.ComponentDetailRoute, id, from) })
     }
-    composable(BottomNavigationSections.Modules.route) {
-        LocalMainTopAppBarManager.current.updateTopAppBar(MainTopAppBarState.DefaultConfiguration)
-        ModulesScreen()
-    }
-    composable(BottomNavigationSections.About.route) { from ->
-        val context = LocalContext.current
-        LocalMainTopAppBarManager.current.updateTopAppBar(MainTopAppBarState.DefaultConfiguration)
-        AboutScreen(onAboutItemClick = { id ->
-            val aboutItem = aboutItems.firstOrNull { it.id == id }
-            if (aboutItem is UrlAboutItem) {
-                context.launchUrl(aboutItem.url)
-            } else {
-                navigateToElement(MainDestinations.AboutItemDetailRoute, id, from)
-            }
-        })
+    composable(BottomNavigationSections.Modules.route) { from ->
+        LocalMainTopAppBarManager.current.updateTopAppBar(MainTopAppBarState.DefaultWithSearchActionConfiguration)
+        ModulesScreen(onModuleClick = { route -> navController.navigateToElement(route, null, from) })
     }
 }
 
@@ -87,5 +66,5 @@ enum class BottomNavigationSections(
     Guidelines(R.string.navigation_item_guidelines, R.drawable.ic_guideline_dna, "main/guidelines"),
     Components(R.string.navigation_item_components, R.drawable.ic_component_atom, "main/components"),
     Modules(R.string.navigation_item_modules, R.drawable.ic_module_molecule, "main/modules"),
-    About(R.string.navigation_item_about, R.drawable.ic_info, "main/about");
+    About(R.string.navigation_item_about, R.drawable.ic_info, OdsAboutRoute);
 }

app/src/main/java/com/orange/ods/app/ui/MainScreen.kt

@@ -32,7 +32,7 @@ import androidx.compose.ui.platform.LocalConfiguration
 import androidx.compose.ui.text.input.TextFieldValue
 import androidx.compose.ui.unit.dp
 import androidx.lifecycle.viewmodel.compose.viewModel
-import androidx.navigation.NavBackStackEntry
+import androidx.navigation.NavController
 import androidx.navigation.NavGraphBuilder
 import androidx.navigation.compose.NavHost
 import androidx.navigation.compose.composable
@@ -41,16 +41,18 @@ import com.google.accompanist.systemuicontroller.rememberSystemUiController
 import com.orange.ods.app.R
 import com.orange.ods.app.domain.recipes.LocalCategories
 import com.orange.ods.app.domain.recipes.LocalRecipes
-import com.orange.ods.app.ui.about.addAboutGraph
+import com.orange.ods.app.ui.about.aboutConfiguration
 import com.orange.ods.app.ui.components.addComponentsGraph
 import com.orange.ods.app.ui.components.tabs.FixedTabRow
 import com.orange.ods.app.ui.components.tabs.ScrollableTabRow
 import com.orange.ods.app.ui.guidelines.addGuidelinesGraph
+import com.orange.ods.app.ui.modules.addModulesGraph
 import com.orange.ods.app.ui.search.SearchScreen
 import com.orange.ods.app.ui.utilities.extension.isDarkModeEnabled
 import com.orange.ods.app.ui.utilities.extension.isOrange
 import com.orange.ods.compose.theme.OdsTheme
 import com.orange.ods.extension.orElse
+import com.orange.ods.module.about.configuration.LocalOdsAboutModuleConfiguration
 import com.orange.ods.theme.OdsThemeConfigurationContract
 import com.orange.ods.xml.theme.OdsXml
 import com.orange.ods.xml.utilities.extension.xml
@@ -90,7 +92,8 @@ fun MainScreen(themeConfigurations: Set<OdsThemeConfigurationContract>, mainView
         LocalOdsGuideline provides mainState.themeState.currentThemeConfiguration.guideline,
         LocalRecipes provides mainViewModel.recipes,
         LocalCategories provides mainViewModel.categories,
-        LocalUiFramework provides mainState.uiFramework
+        LocalUiFramework provides mainState.uiFramework,
+        LocalOdsAboutModuleConfiguration provides aboutConfiguration()
     ) {
         OdsTheme(
             themeConfiguration = mainState.themeState.currentThemeConfiguration,
@@ -117,7 +120,6 @@ fun MainScreen(themeConfigurations: Set<OdsThemeConfigurationContract>, mainView
 
             Scaffold(
                 modifier = modifier,
-                backgroundColor = OdsTheme.colors.background,
                 topBar = {
                     Surface(elevation = if (isSystemInDarkTheme()) 0.dp else AppBarDefaults.TopAppBarElevation) {
                         Column {
@@ -155,7 +157,7 @@ fun MainScreen(themeConfigurations: Set<OdsThemeConfigurationContract>, mainView
                     navController = mainState.navController, startDestination = MainDestinations.HomeRoute, modifier = Modifier.padding(innerPadding)
                 ) {
                     mainNavGraph(
-                        navigateToElement = mainState::navigateToElement,
+                        navController = mainState.navController,
                         upPress = mainState::upPress,
                         searchedText = mainState.topAppBarState.searchedText
                     )
@@ -211,28 +213,28 @@ private fun MainTabs(mainTabsState: MainTabsState) {
 }
 
 private fun NavGraphBuilder.mainNavGraph(
-    navigateToElement: (String, Long?, NavBackStackEntry) -> Unit,
+    navController: NavController,
     upPress: () -> Unit,
     searchedText: MutableState<TextFieldValue>
 ) {
     navigation(
         route = MainDestinations.HomeRoute,
         startDestination = BottomNavigationSections.Guidelines.route
     ) {
-        addBottomNavigationGraph(navigateToElement)
+        addBottomNavigationGraph(navController)
     }
 
     addGuidelinesGraph()
-    addComponentsGraph(navigateToElement, upPress)
-    addAboutGraph()
+    addComponentsGraph(navController, upPress)
+    addModulesGraph(navController)
 
     composable(
         route = MainDestinations.SearchRoute
     ) { from ->
         LocalMainTopAppBarManager.current.updateTopAppBarTitle(R.string.navigation_item_search)
         SearchScreen(
             searchedText,
-            onResultItemClick = { route, id -> navigateToElement(route, id, from) }
+            onResultItemClick = { route, id -> navController.navigateToElement(route, id, from) }
         )
     }
 }

app/src/main/java/com/orange/ods/app/ui/MainState.kt

@@ -15,10 +15,6 @@ import androidx.compose.runtime.MutableState
 import androidx.compose.runtime.mutableStateOf
 import androidx.compose.runtime.remember
 import androidx.compose.runtime.saveable.rememberSaveable
-import androidx.lifecycle.Lifecycle
-import androidx.navigation.NavBackStackEntry
-import androidx.navigation.NavDestination
-import androidx.navigation.NavGraph
 import androidx.navigation.NavHostController
 import androidx.navigation.compose.currentBackStackEntryAsState
 import androidx.navigation.compose.rememberNavController
@@ -39,9 +35,6 @@ object MainDestinations {
     const val ComponentVariantIdKey = "componentVariantId"
     const val ComponentDemoRoute = "component/demo"
 
-    const val AboutItemDetailRoute = "aboutItem"
-    const val AboutItemIdKey = "aboutItemId"
-
     const val SearchRoute = "search"
 }
 
@@ -93,46 +86,7 @@ class MainState(
 
     fun navigateToBottomBarRoute(route: String) {
         if (route != currentRoute) {
-            navController.navigate(route) {
-                // Avoid multiple copies of the same destination when
-                // reselecting the same item
-                launchSingleTop = true
-                // Restore state when reselecting a previously selected item
-                restoreState = true
-                // Pop up backstack to the first destination and save state. This makes going back
-                // to the start destination when pressing back in any other bottom tab.
-                popUpTo(findStartDestination(navController.graph).id) {
-                    saveState = true
-                }
-            }
-        }
-    }
-
-    fun navigateToElement(route: String, elementId: Long?, from: NavBackStackEntry) {
-        // In order to discard duplicated navigation events, we check the Lifecycle
-        if (from.lifecycleIsResumed()) {
-            val fullRoute = if (elementId != null) "$route/$elementId" else route
-            navController.navigate(fullRoute)
+            navController.navigateToBottomBarRoute(route)
         }
     }
-}
-
-/**
- * If the lifecycle is not resumed it means this NavBackStackEntry already processed a nav event.
- *
- * This is used to de-duplicate navigation events.
- */
-private fun NavBackStackEntry.lifecycleIsResumed() =
-    this.getLifecycle().currentState == Lifecycle.State.RESUMED
-
-private val NavGraph.startDestination: NavDestination?
-    get() = findNode(startDestinationId)
-
-/**
- * Copied from similar function in NavigationUI.kt
- *
- * https://cs.android.com/androidx/platform/frameworks/support/+/androidx-main:navigation/navigation-ui/src/main/java/androidx/navigation/ui/NavigationUI.kt
- */
-private tailrec fun findStartDestination(graph: NavDestination): NavDestination {
-    return if (graph is NavGraph) findStartDestination(graph.startDestination!!) else graph
 }

app/src/main/java/com/orange/ods/app/ui/MainTopAppBarState.kt

@@ -68,6 +68,10 @@ class MainTopAppBarState(
             isNavigationIconEnabled = true,
             actions = listOf(TopAppBarConfiguration.Action.Theme, TopAppBarConfiguration.Action.Mode)
         )
+
+        val DefaultWithSearchActionConfiguration = DefaultConfiguration.newBuilder()
+            .prependAction(TopAppBarConfiguration.Action.Search)
+            .build()
     }
 
     // ----------------------------------------------------------

app/src/main/java/com/orange/ods/app/ui/about/AboutConfiguration.kt

@@ -0,0 +1,25 @@
+/*
+ *
+ *  Copyright 2021 Orange
+ *
+ *  Use of this source code is governed by an MIT-style
+ *  license that can be found in the LICENSE file or at
+ *  https://opensource.org/licenses/MIT.
+ * /
+ */
+
+package com.orange.ods.app.ui.about
+
+import androidx.compose.runtime.Composable
+import androidx.compose.ui.platform.LocalContext
+import androidx.compose.ui.res.stringResource
+import com.orange.ods.app.R
+import com.orange.ods.module.about.configuration.OdsAboutModuleConfiguration
+import com.orange.ods.module.about.utilities.VersionHelper
+
+@Composable
+fun aboutConfiguration() = OdsAboutModuleConfiguration(
+    appName = stringResource(id = R.string.about_app_name),
+    appVersion = VersionHelper.getFromPackageInfo(context = LocalContext.current),
+    appDescription = stringResource(id = R.string.about_description)
+)