feat: rename DrawerState.visibilityPercentage to visibilityProgress, make it receive a dp parameter, coerce its result into a range from 0f - 1f

- fix corresponding unit tests

Author: w2sv

composed-material3/src/main/kotlin/com/w2sv/composed/material3/extensions/DrawerState.kt

@@ -1,29 +1,32 @@
 package com.w2sv.composed.material3.extensions
 
-import androidx.annotation.FloatRange
 import androidx.compose.material3.DrawerDefaults
 import androidx.compose.material3.DrawerState
 import androidx.compose.runtime.Composable
 import androidx.compose.runtime.State
 import androidx.compose.runtime.derivedStateOf
 import androidx.compose.runtime.remember
+import androidx.compose.ui.unit.Dp
 import com.w2sv.composed.core.extensions.toPx
 
 /**
  * @return Float [State] whose value ranges from 0.0 (drawer fully closed) to 1.0 (drawer fully open).
- * @param maxWidthPx The with in pixels upon the drawer being fully expanded. If unmodified, this will equal [DrawerDefaults.MaximumDrawerWidth].
+ * @param maxWidthPx The max drawer sheet width.
  */
-fun DrawerState.visibilityPercentage(@FloatRange(from = 0.0) maxWidthPx: Float): State<Float> {
-    return derivedStateOf { currentOffset / maxWidthPx + 1 } // currentOffset = -MAX when completely hidden, 0 when completely visible
+fun DrawerState.visibilityProgress(maxWidthPx: Float): State<Float> {
+    require(maxWidthPx != 0f) { "maxWidthPx can not be 0f" }
+    return derivedStateOf {
+        // currentOffset ∈ [-maxWidthPx (fully hidden), 0 (fully visible)]
+        ((currentOffset + maxWidthPx) / maxWidthPx).coerceIn(0f, 1f)
+    }
 }
 
 /**
- * @see visibilityPercentage
+ * @return the remembered drawer visibility percentage ranging from 0 to 1.
+ * @param maxWidth The max drawer sheet width. Will equal [DrawerDefaults.MaximumDrawerWidth] by default.
  */
 @Composable
-fun DrawerState.rememberVisibilityPercentage(
-    @FloatRange(from = 0.0) maxWidthPx: Float = DrawerDefaults.MaximumDrawerWidth.toPx()
-): State<Float> =
-    remember {
-        visibilityPercentage(maxWidthPx)
-    }
+fun DrawerState.rememberVisibilityProgress(maxWidth: Dp = DrawerDefaults.MaximumDrawerWidth): State<Float> {
+    val maxWidthPx = maxWidth.toPx()
+    return remember(maxWidthPx) { visibilityProgress(maxWidthPx) }
+}

composed-material3/src/test/kotlin/com/w2sv/composed/material3/extensions/DrawerStateKtTest.kt

@@ -1,15 +1,16 @@
 package com.w2sv.composed.material3.extensions
 
+import androidx.compose.foundation.layout.width
 import androidx.compose.material3.DrawerState
 import androidx.compose.material3.DrawerValue
+import androidx.compose.material3.ModalDrawerSheet
 import androidx.compose.material3.ModalNavigationDrawer
-import androidx.compose.runtime.getValue
+import androidx.compose.runtime.State
+import androidx.compose.ui.Modifier
 import androidx.compose.ui.test.junit4.createComposeRule
-import com.w2sv.composed.material3.extensions.visibilityPercentage
-import kotlin.properties.Delegates
-import kotlinx.coroutines.test.runTest
+import androidx.compose.ui.unit.dp
+import kotlinx.coroutines.runBlocking
 import org.junit.Assert.assertEquals
-import org.junit.Ignore
 import org.junit.Rule
 import org.junit.Test
 import org.junit.runner.RunWith
@@ -21,29 +22,29 @@ class DrawerStateKtTest {
     @get:Rule
     val composeTestRule = createComposeRule()
 
-    private var maxWidthPx by Delegates.notNull<Float>()
-
-    @Ignore("Mysteriously not working anymore after update of compose dependencies. DrawerState.currentOffset always null.")
     @Test
-    fun visibilityPercentage() =
-        runTest {
-            val drawerState = DrawerState(initialValue = DrawerValue.Closed)
+    fun visibilityProgress() {
+        val drawerState = DrawerState(initialValue = DrawerValue.Closed)
+        lateinit var visibilityProgress: State<Float>
+        val sheetWidth = 300.dp
+
+        with(composeTestRule) {
+            setContent {
+                visibilityProgress = drawerState.rememberVisibilityProgress(sheetWidth)
 
-            composeTestRule.setContent {
-                maxWidthPx = 120f
                 ModalNavigationDrawer(
-                    drawerContent = { /*TODO*/ },
                     drawerState = drawerState,
+                    drawerContent = { ModalDrawerSheet(modifier = Modifier.width(sheetWidth)) {} },
                     content = {}
                 )
             }
 
-            val visibilityPercentage by drawerState.visibilityPercentage(maxWidthPx)
-
-            assertEquals(0f, visibilityPercentage)
+            runOnIdle {
+                assertEquals(0f, visibilityProgress.value)
 
-            drawerState.snapTo(DrawerValue.Open)
-
-            assertEquals(1f, visibilityPercentage)
+                runBlocking { drawerState.snapTo(DrawerValue.Open) }
+                assertEquals(1f, visibilityProgress.value)
+            }
         }
+    }
 }