Implement helper hierarchy functions

compose-destinations-codegen/src/main/java/com/ramcosta/composedestinations/codegen/commons/Utils.kt

@@ -32,10 +32,4 @@ fun String.sanitizePackageName(): String {
 }
 
 private val humps = "(?<=.)(?=\\p{Upper})".toRegex()
-fun String.toSnakeCase() = replace(humps, "_").lowercase(Locale.US)
-
-fun String.asNavGraphName(): String {
- var lower = this.lowercase(Locale.US)
- lower = lower.replace("navgraph", "")
- return this.substring(0, lower.length).replaceFirstChar { it.lowercase() }
-}
+fun String.toSnakeCase() = replace(humps, "_").lowercase(Locale.US)

compose-destinations-codegen/src/main/java/com/ramcosta/composedestinations/codegen/model/NavGraphGeneratingParams.kt

@@ -5,6 +5,5 @@ data class NavGraphGeneratingParams(
  val destinations: List<GeneratedDestination>,
  val startRouteFieldName: String,
  val nestedNavGraphRoutes: List<String>,
- val requireOptInAnnotationTypes: Set<Importable>,
- val parent: String?
+ val requireOptInAnnotationTypes: Set<Importable>
 )

compose-destinations-codegen/src/main/java/com/ramcosta/composedestinations/codegen/templates/DestinationTemplate.kt

@@ -9,7 +9,6 @@ import com.ramcosta.composedestinations.codegen.templates.core.setOfImportable
 const val DESTINATION_NAME = "[DESTINATION_NAME]"
 const val BASE_ROUTE = "[ROUTE_ID]"
 const val COMPOSED_ROUTE = "[COMPOSED_ROUTE]"
-const val DESTINATION_PARENT = "[DESTINATION_PARENT]"
 const val NAV_ARGUMENTS = "[NAV_ARGUMENTS]"
 const val DEEP_LINKS = "[DEEP_LINKS]"
 const val DESTINATION_STYLE = "[DESTINATION_STYLE]"
@@ -48,8 +47,6 @@ ${REQUIRE_OPT_IN_ANNOTATIONS_PLACEHOLDER}object $DESTINATION_NAME : $SUPERTYPE {
  override val baseRoute = "$BASE_ROUTE"
 
  override val route = $COMPOSED_ROUTE
-
- override val parent = $DESTINATION_PARENT
  $NAV_ARGUMENTS$DEEP_LINKS$DESTINATION_STYLE
  @Composable
  override fun DestinationScope<$NAV_ARGS_CLASS_SIMPLE_NAME>.Content(

compose-destinations-codegen/src/main/java/com/ramcosta/composedestinations/codegen/templates/SingleModuleExtensionsTemplate.kt

@@ -39,26 +39,39 @@ data class $GENERATED_NAV_GRAPH(
  override val route: String,
  override val startRoute: Route,
  val destinations: List<$typeAliasDestination>,
- override val nestedNavGraphs: List<$GENERATED_NAV_GRAPH> = emptyList(),
- override val parent: String?
+ override val nestedNavGraphs: List<$GENERATED_NAV_GRAPH> = emptyList()
 ): $CORE_NAV_GRAPH_SPEC {
  override val destinationsByRoute: Map<String, $typeAliasDestination> = destinations.associateBy { it.route }
 }
 
-val DestinationSpec<*>.parent: NavGraph
- get() {
- val parent = NavGraphs.all.find {
- it.destinations.contains(this)
- }
-
- return parent
- ?: throw InvalidObjectException("The calling object should always have a parent!")
+/**
+ * Return the parent of this [Destination][DestinationSpec] by searching through the [NavGraph]s in
+ * the [NavGraphs] object.
+ *
+ * This variable should **NEVER** be null. If `first { ... }` throws a [NoSuchElementException], it
+ * means this [Destination][DestinationSpec] somehow isn't part of a [NavGraph].
+ */
+val $CORE_DESTINATION_SPEC<*>.parent: $GENERATED_NAV_GRAPH
+ get() = $GENERATED_NAV_GRAPHS_OBJECT.all.first {
+ it.destinations.contains(this)
  }
 
-val $CORE_NAV_GRAPH_SPEC.parent: NavGraph?
- get() = NavGraphs.all.find {
+/**
+ * Return the parent of this [NavGraphSpec] by searching through the [NavGraph]s'
+ * [NavGraph.nestedNavGraphs] in the [NavGraphs] object.
+ */
+val $CORE_NAV_GRAPH_SPEC.parent: $GENERATED_NAV_GRAPH?
+ get() = $GENERATED_NAV_GRAPHS_OBJECT.all.find {
  it.nestedNavGraphs.contains(this)
  }
+
+/**
+ * Provides a sequence of the [DestinationSpec]'s hierarchy. The hierarchy starts with this
+ * [DestinationSpec]'s [parent][DestinationSpec.parent] [NavGraph], then that graph's parent, and up 
+ * the hierarchy until you've reached the root navigation graph.
+ */
+val $CORE_DESTINATION_SPEC<*>.hierarchy: Sequence<$GENERATED_NAV_GRAPH>
+ get() = generateSequence(this.parent) { it.parent }
 
 /**
  * If this [Route] is a [$typeAliasDestination], returns it

compose-destinations-codegen/src/main/java/com/ramcosta/composedestinations/codegen/writers/SingleDestinationWriter.kt

@@ -51,7 +51,6 @@ class SingleDestinationWriter(
  .replace(BASE_ROUTE, destination.cleanRoute)
  .replace(NAV_ARGS_CLASS_SIMPLE_NAME, navArgsDataClassName())
  .replace(COMPOSED_ROUTE, constructRouteFieldCode())
- .replace(DESTINATION_PARENT, parentNavGraph())
  .replace(NAV_ARGUMENTS, navArgumentsDeclarationCode())
  .replace(DEEP_LINKS, deepLinksDeclarationCode())
  .replace(DESTINATION_STYLE, destinationStyle())
@@ -354,30 +353,6 @@ class SingleDestinationWriter(
  ).write()
  }
 
- private fun parentNavGraph(): String {
- return when (val navGraph = destination.navGraphInfo) {
- is NavGraphInfo.Legacy -> {
- // Get the NavGraph object from its route
- importableHelper.addAndGetPlaceholder(
- Importable(
- navGraph.navGraphRoute,
- "$codeGenBasePackageName.$GENERATED_NAV_GRAPHS_OBJECT.${navGraph.navGraphRoute}"
- )
- )
- }
- is NavGraphInfo.AnnotatedSource -> {
- // Get the NavGraph object from its route too
- navGraph.graphType.toString()
- importableHelper.addAndGetPlaceholder(
- Importable(
- navGraph.graphType.simpleName.asNavGraphName(),
- "$codeGenBasePackageName.$GENERATED_NAV_GRAPHS_OBJECT.${navGraph.graphType.simpleName.asNavGraphName()}"
- )
- )
- }
- }
- }
-
  private fun navArgumentsDeclarationCode(): String {
  val code = StringBuilder()
 

compose-destinations-codegen/src/main/java/com/ramcosta/composedestinations/codegen/writers/sub/LegacyNavGraphsSingleObjectWriter.kt

@@ -64,16 +64,13 @@ class LegacyNavGraphsSingleObjectWriter(
  val nestedGraphsAnchor = "[NESTED_GRAPHS]"
  val requireOptInAnnotationsAnchor = "[REQUIRE_OPT_IN_ANNOTATIONS_ANCHOR]"
 
- val parent = if (route == "root") "null" else "\"${navGraphParams.parent}\""
-
  return """
  | ${requireOptInAnnotationsAnchor}val ${navGraphFieldName(route)} = $GENERATED_NAV_GRAPH(
  | route = "$route",
  | startRoute = ${startRouteFieldName},
  | destinations = listOf(
  | $destinationsAnchor
- | )${if (nestedNavGraphRoutes.isEmpty()) "" else ",\n|\t\t$nestedGraphsAnchor"},
- | parent = $parent
+ | )${if (nestedNavGraphRoutes.isEmpty()) "" else ",\n|\t\t$nestedGraphsAnchor"}
  | )
  """.trimMargin()
  .replace(destinationsAnchor, destinationsInsideList(destinations))
@@ -158,8 +155,7 @@ class LegacyNavGraphsSingleObjectWriter(
  destinations = it.value,
  startRouteFieldName = legacyStartingDestination(navGraphRoute, it.value),
  nestedNavGraphRoutes = emptyList(),
- requireOptInAnnotationTypes = requireOptInClassTypes,
- parent = it.key
+ requireOptInAnnotationTypes = requireOptInClassTypes
  )
  )
  }
@@ -172,8 +168,7 @@ class LegacyNavGraphsSingleObjectWriter(
  nestedNavGraphRoutes = nestedNavGraphs,
  requireOptInAnnotationTypes = rootDestinations.orEmpty()
  .requireOptInAnnotationClassTypes()
- .apply { addAll(nestedNavGraphsRequireOptInAnnotations) },
- parent = null
+ .apply { addAll(nestedNavGraphsRequireOptInAnnotations) }
  )
  )
 

compose-destinations-codegen/src/main/java/com/ramcosta/composedestinations/codegen/writers/sub/NavGraphsSingleObjectWriter.kt

@@ -65,8 +65,7 @@ class NavGraphsSingleObjectWriter(
  nestedNavGraphs.forEach {
  addAll(destinationsByNavGraphParams[it]!!.requireOptInAnnotationClassTypes())
  }
- },
- parent = rawGraph.parent?.simpleName?.asNavGraphName()
+ }
  )
  }
 
@@ -115,16 +114,13 @@ class NavGraphsSingleObjectWriter(
  val nestedGraphsAnchor = "[NESTED_GRAPHS]"
  val requireOptInAnnotationsAnchor = "[REQUIRE_OPT_IN_ANNOTATIONS_ANCHOR]"
 
- val parent = if (route == "root") "null" else "\"${navGraphParams.parent}\""
-
  return """
  | ${requireOptInAnnotationsAnchor}val ${navGraphFieldName(route)} = $GENERATED_NAV_GRAPH(
  | route = "$route",
  | startRoute = ${startRouteFieldName},
  | destinations = listOf(
  | $destinationsAnchor
- | )${if (nestedNavGraphRoutes.isEmpty()) "" else ",\n|\t\t$nestedGraphsAnchor"},
- | parent = $parent
+ | )${if (nestedNavGraphRoutes.isEmpty()) "" else ",\n|\t\t$nestedGraphsAnchor"}
  | )
  """.trimMargin()
  .replace(destinationsAnchor, destinationsInsideList(destinations))

compose-destinations/src/main/java/com/ramcosta/composedestinations/dynamic/DynamicDestinationSpec.kt

@@ -51,8 +51,6 @@ infix fun <T> DestinationSpec<T>.routedIn(navGraph: NavGraphSpec): DestinationSp
  override val route = "${navGraph.route}/${[email protected]}"
 
  override val originalDestination = [email protected]
-
- override val parent: NavGraphSpec = navGraph
  }
 }
 

compose-destinations/src/main/java/com/ramcosta/composedestinations/spec/DestinationSpec.kt

@@ -65,11 +65,6 @@ interface DestinationSpec<T> : Route {
  */
  val deepLinks: List<NavDeepLink> get() = emptyList()
 
- /**
- * The parent [NavGraph][NavGraphSpec] of the current destination
- */
- val parent: NavGraphSpec
-
  /**
  * Style of this destination. It can be one of:
  * - [DestinationStyle.Default]

compose-destinations/src/main/java/com/ramcosta/composedestinations/spec/NavGraphSpec.kt

@@ -16,11 +16,6 @@ interface NavGraphSpec: Direction, Route {
  */
  val startRoute: Route
 
- /**
- * The parent route of the current NavGraph if any
- */
- val parent: String?
-
  /**
  * All destinations which belong to this navigation graph
  * by their route

playground/src/main/java/com/ramcosta/samples/playground/commons/DestinationsAppExtensions.kt

@@ -9,12 +9,8 @@ import androidx.compose.ui.Modifier
 import androidx.compose.ui.res.stringResource
 import androidx.compose.ui.text.font.FontWeight
 import androidx.compose.ui.unit.dp
-import com.ramcosta.composedestinations.spec.DestinationSpec
 import com.ramcosta.samples.playground.R
-import com.ramcosta.samples.playground.ui.screens.NavGraph
-import com.ramcosta.samples.playground.ui.screens.NavGraphs
 import com.ramcosta.samples.playground.ui.screens.destinations.*
-import java.io.InvalidObjectException
 
 @Composable
 fun DirectionDestination.DrawerContent(
@@ -59,13 +55,4 @@ val Destination.title
  TestScreenDestination -> null
  TestScreen2Destination -> null
  }
- }
-
-val DestinationSpec<*>.parent: NavGraph
- get() {
- val parent = NavGraphs.all.find {
- it.destinations.contains(this)
- }
-
- return parent ?: throw InvalidObjectException("The calling object should always have a parent!")
  }

playground/src/main/java/com/ramcosta/samples/playground/ui/screens/settings/ThemeSettings.kt

@@ -1,6 +1,5 @@
 package com.ramcosta.samples.playground.ui.screens.settings
 
-import android.widget.Toast
 import androidx.compose.foundation.background
 import androidx.compose.foundation.layout.*
 import androidx.compose.material.Button
@@ -10,16 +9,12 @@ import androidx.compose.runtime.Composable
 import androidx.compose.ui.Alignment
 import androidx.compose.ui.Modifier
 import androidx.compose.ui.graphics.Color
-import androidx.compose.ui.platform.LocalContext
 import androidx.compose.ui.res.stringResource
 import androidx.compose.ui.unit.dp
 import com.ramcosta.composedestinations.annotation.Destination
 import com.ramcosta.composedestinations.result.ResultBackNavigator
-import com.ramcosta.composedestinations.spec.DestinationSpec
 import com.ramcosta.composedestinations.spec.DestinationStyle
-import com.ramcosta.composedestinations.spec.NavGraphSpec
 import com.ramcosta.samples.playground.commons.SettingsNavGraph
-import com.ramcosta.samples.playground.commons.findDestinationParentNavGraph
 import com.ramcosta.samples.playground.commons.requireTitle
 import com.ramcosta.samples.playground.ui.screens.destinations.ThemeSettingsDestination
 import com.ramcosta.samples.playground.ui.screens.profile.SerializableExampleWithNavTypeSerializer
@@ -31,10 +26,6 @@ fun ColumnScope.ThemeSettings(
  viewModel: SettingsViewModel,
  resultNavigator: ResultBackNavigator<SerializableExampleWithNavTypeSerializer>
 ) {
- val context = LocalContext.current
-
- Toast.makeText(context, "Hierarchy: ${ThemeSettingsDestination.findDestinationParentNavGraph()}", Toast.LENGTH_LONG).show()
-
  Box(
  Modifier
  .fillMaxWidth()