Merge pull request #110 from hotwired/extract-animations

jayohms · web-flow · commit 3d2b7a8dc25f · 2025-03-06T08:12:58.000-05:00
Add `animated` Path Configuration property
diff --git a/core/src/main/assets/json/test-configuration.json b/core/src/main/assets/json/test-configuration.json
@@ -94,6 +94,14 @@
         "uri": "hotwire://fragment/web/modal",
         "presentation": "replace_root"
       }
+    },
+    {
+      "patterns": [
+        "/not-animated"
+      ],
+      "properties": {
+        "animated": false
+      }
     }
   ]
 }
diff --git a/core/src/main/kotlin/dev/hotwire/core/turbo/config/PathConfiguration.kt b/core/src/main/kotlin/dev/hotwire/core/turbo/config/PathConfiguration.kt
@@ -156,3 +156,6 @@ val PathConfigurationProperties.title: String?
 
 val PathConfigurationProperties.pullToRefreshEnabled: Boolean
     get() = get("pull_to_refresh_enabled")?.toBoolean() ?: false
+
+val PathConfigurationProperties.animated: Boolean
+    get() = get("animated")?.toBoolean() ?: true
diff --git a/core/src/test/kotlin/dev/hotwire/core/turbo/config/PathConfigurationRepositoryTest.kt b/core/src/test/kotlin/dev/hotwire/core/turbo/config/PathConfigurationRepositoryTest.kt
@@ -50,7 +50,7 @@ class PathConfigurationRepositoryTest : BaseRepositoryTest() {
         assertThat(json).isNotNull()
 
         val config = load(json)
-        assertThat(config?.rules?.size).isEqualTo(10)
+        assertThat(config?.rules?.size).isEqualTo(11)
     }
 
     @Test
diff --git a/core/src/test/kotlin/dev/hotwire/core/turbo/config/PathConfigurationTest.kt b/core/src/test/kotlin/dev/hotwire/core/turbo/config/PathConfigurationTest.kt
@@ -48,7 +48,7 @@ class PathConfigurationTest : BaseRepositoryTest() {
 
     @Test
     fun assetConfigurationIsLoaded() {
-        assertThat(pathConfiguration.rules.size).isEqualTo(10)
+        assertThat(pathConfiguration.rules.size).isEqualTo(11)
     }
 
     @Test
@@ -130,6 +130,13 @@ class PathConfigurationTest : BaseRepositoryTest() {
         assertThat(pathConfiguration.properties("$url/image.jpg").title).isEqualTo("Image Viewer")
     }
 
+    @Test
+    fun animated() {
+        assertThat(pathConfiguration.properties("$url/home").animated).isTrue()
+        assertThat(pathConfiguration.properties("$url/new").animated).isTrue()
+        assertThat(pathConfiguration.properties("$url/not-animated").animated).isFalse()
+    }
+
     @Test
     fun pullToRefresh() {
         assertThat(pathConfiguration.properties("$url/home").pullToRefreshEnabled).isTrue
diff --git a/navigation-fragments/src/main/java/dev/hotwire/navigation/destinations/HotwireDestination.kt b/navigation-fragments/src/main/java/dev/hotwire/navigation/destinations/HotwireDestination.kt
@@ -137,52 +137,11 @@ interface HotwireDestination : BridgeDestination {
         newPathProperties: PathConfigurationProperties,
         action: VisitAction
     ): NavOptions {
-        val navigatingToModalContext = pathProperties.context == PresentationContext.DEFAULT &&
-                newPathProperties.context == PresentationContext.MODAL
-
-        val navigatingWithinModalContext = pathProperties.context == PresentationContext.MODAL &&
-                newPathProperties.context == PresentationContext.MODAL
-
-        val dismissingModalContext = pathProperties.context == PresentationContext.MODAL &&
-                newPathProperties.context == PresentationContext.DEFAULT
-
-        val animate = (navigatingToModalContext || dismissingModalContext) ||
-                (action != VisitAction.REPLACE &&
-                newPathProperties.presentation != Presentation.REPLACE &&
-                newPathProperties.presentation != Presentation.REPLACE_ROOT)
-
-        val clearAll = newPathProperties.presentation == Presentation.CLEAR_ALL
-
-        return if (navigatingToModalContext || navigatingWithinModalContext || dismissingModalContext) {
-            navOptions {
-                anim {
-                    enter = if (animate) R.anim.enter_slide_in_bottom else 0
-                    exit = R.anim.exit_slide_out_bottom
-                    popEnter = R.anim.enter_slide_in_bottom
-                    popExit = R.anim.exit_slide_out_bottom
-                }
-            }
-        } else {
-            if (clearAll) {
-                navOptions {
-                    anim {
-                        enter = R.anim.exit_slide_out_left
-                        exit = R.anim.exit_slide_out_right
-                        popEnter = R.anim.enter_slide_in_left
-                        popExit = R.anim.enter_slide_in_right
-                    }
-                }
-            } else {
-                navOptions {
-                    anim {
-                        enter = if (animate) R.anim.enter_slide_in_right else 0
-                        exit = R.anim.exit_slide_out_left
-                        popEnter = R.anim.enter_slide_in_left
-                        popExit = R.anim.exit_slide_out_right
-                    }
-                }
-            }
-        }
+        return HotwireDestinationAnimations.defaultNavOptions(
+            currentPathProperties = pathProperties,
+            newPathProperties = newPathProperties,
+            action = action
+        )
     }
 
     /**
diff --git a/navigation-fragments/src/main/java/dev/hotwire/navigation/destinations/HotwireDestinationAnimations.kt b/navigation-fragments/src/main/java/dev/hotwire/navigation/destinations/HotwireDestinationAnimations.kt
@@ -0,0 +1,90 @@
+package dev.hotwire.navigation.destinations
+
+import androidx.navigation.NavOptions
+import androidx.navigation.navOptions
+import dev.hotwire.core.turbo.config.PathConfigurationProperties
+import dev.hotwire.core.turbo.config.animated
+import dev.hotwire.core.turbo.config.context
+import dev.hotwire.core.turbo.config.presentation
+import dev.hotwire.core.turbo.nav.Presentation
+import dev.hotwire.core.turbo.nav.PresentationContext
+import dev.hotwire.core.turbo.visit.VisitAction
+import dev.hotwire.navigation.R
+
+class HotwireDestinationAnimations {
+    companion object {
+        fun defaultNavOptions(
+            currentPathProperties: PathConfigurationProperties,
+            newPathProperties: PathConfigurationProperties,
+            action: VisitAction
+        ): NavOptions {
+            val navigatingToModalContext = currentPathProperties.context == PresentationContext.DEFAULT &&
+                    newPathProperties.context == PresentationContext.MODAL
+
+            val navigatingWithinModalContext = currentPathProperties.context == PresentationContext.MODAL &&
+                    newPathProperties.context == PresentationContext.MODAL
+
+            val dismissingModalContext = currentPathProperties.context == PresentationContext.MODAL &&
+                    newPathProperties.context == PresentationContext.DEFAULT
+
+            val animate = shouldAnimate(
+                navigatingToModalContext = navigatingToModalContext,
+                dismissingModalContext = dismissingModalContext,
+                newPathProperties = newPathProperties,
+                action = action
+            )
+
+            val clearAll = newPathProperties.presentation == Presentation.CLEAR_ALL
+
+            return if (navigatingToModalContext || navigatingWithinModalContext || dismissingModalContext) {
+                navOptions {
+                    anim {
+                        enter = if (animate) R.anim.enter_slide_in_bottom else 0
+                        exit = R.anim.exit_slide_out_bottom
+                        popEnter = R.anim.enter_slide_in_bottom
+                        popExit = R.anim.exit_slide_out_bottom
+                    }
+                }
+            } else {
+                if (clearAll) {
+                    navOptions {
+                        anim {
+                            enter = R.anim.exit_slide_out_left
+                            exit = R.anim.exit_slide_out_right
+                            popEnter = R.anim.enter_slide_in_left
+                            popExit = R.anim.enter_slide_in_right
+                        }
+                    }
+                } else {
+                    navOptions {
+                        anim {
+                            enter = if (animate) R.anim.enter_slide_in_right else 0
+                            exit = R.anim.exit_slide_out_left
+                            popEnter = R.anim.enter_slide_in_left
+                            popExit = R.anim.exit_slide_out_right
+                        }
+                    }
+                }
+            }
+        }
+
+        private fun shouldAnimate(
+            navigatingToModalContext: Boolean,
+            dismissingModalContext: Boolean,
+            newPathProperties: PathConfigurationProperties,
+            action: VisitAction
+        ): Boolean {
+            if (!newPathProperties.animated) {
+                return false
+            }
+
+            if (navigatingToModalContext || dismissingModalContext) {
+                return true
+            }
+
+            return action != VisitAction.REPLACE &&
+                    newPathProperties.presentation != Presentation.REPLACE &&
+                    newPathProperties.presentation != Presentation.REPLACE_ROOT
+        }
+    }
+}

Original file line number	Diff line number	Diff line change
`@@ -94,6 +94,14 @@`
`94`	`94`	`"uri": "hotwire://fragment/web/modal",`
`95`	`95`	`"presentation": "replace_root"`
`96`	`96`	`}`
	`97`	`+ },`
	`98`	`+ {`
	`99`	`+ "patterns": [`
	`100`	`+ "/not-animated"`
	`101`	`+ ],`
	`102`	`+ "properties": {`
	`103`	`+ "animated": false`
	`104`	`+ }`
`97`	`105`	`}`
`98`	`106`	`]`
`99`	`107`	`}`
Original file line number	Diff line number	Diff line change
`@@ -50,7 +50,7 @@ class PathConfigurationRepositoryTest : BaseRepositoryTest() {`
`50`	`50`	`assertThat(json).isNotNull()`
`51`	`51`
`52`	`52`	`val config = load(json)`
`53`		`- assertThat(config?.rules?.size).isEqualTo(10)`
	`53`	`+ assertThat(config?.rules?.size).isEqualTo(11)`
`54`	`54`	`}`
`55`	`55`
`56`	`56`	`@Test`