Feat/implement UI for event filtering

app/src/androidTest/java/com/android/streetworkapp/ui/map/ParkFilterTest.kt

@@ -0,0 +1,111 @@
+package com.android.streetworkapp.ui.map
+
+import android.content.Context
+import androidx.compose.ui.platform.LocalContext
+import androidx.compose.ui.test.assertIsNotSelected
+import androidx.compose.ui.test.assertIsSelected
+import androidx.compose.ui.test.assertTextEquals
+import androidx.compose.ui.test.junit4.createComposeRule
+import androidx.compose.ui.test.onNodeWithTag
+import androidx.compose.ui.test.performClick
+import com.android.sample.R
+import com.android.streetworkapp.utils.EventDensity
+import com.android.streetworkapp.utils.FilterSettings
+import org.junit.Before
+import org.junit.Rule
+import org.junit.Test
+
+class ParkFilterTest {
+  @get:Rule val composeTestRule = createComposeRule()
+
+  private lateinit var filterSettings: FilterSettings
+  private lateinit var context: Context
+
+  @Before
+  fun setUp() {
+    filterSettings = FilterSettings()
+    composeTestRule.setContent {
+      ParkFilterSettings(filterSettings)
+      context = LocalContext.current
+    }
+  }
+
+  @Test
+  fun displayAllComponents() {
+    composeTestRule.onNodeWithTag("ratingFilterTitle").assertExists()
+    composeTestRule.onNodeWithTag("ratingComponent").assertExists()
+    composeTestRule.onNodeWithTag("eventDensityFilterTitle").assertExists()
+    composeTestRule.onNodeWithTag("lowDensityFilterChip").assertExists()
+    composeTestRule.onNodeWithTag("mediumDensityFilterChip").assertExists()
+    composeTestRule.onNodeWithTag("highDensityFilterChip").assertExists()
+    composeTestRule.onNodeWithTag("resetButton").assertExists()
+
+    // Check the default values being correctly displayed
+    composeTestRule
+        .onNodeWithTag("ratingFilterTitle")
+        .assertTextEquals(
+            context.getString(R.string.rating_filter_title, FilterSettings.DEFAULT_RATING))
+    composeTestRule
+        .onNodeWithTag("eventDensityFilterTitle")
+        .assertTextEquals(context.getString(R.string.eventDensity_filter_title))
+
+    // Chips all enabled by default
+    composeTestRule.onNodeWithTag("lowDensityFilterChip").assertIsSelected()
+    composeTestRule.onNodeWithTag("mediumDensityFilterChip").assertIsSelected()
+    composeTestRule.onNodeWithTag("highDensityFilterChip").assertIsSelected()
+  }
+
+  @Test
+  fun isEventFilterInteractionCorrect() {
+
+    assert(filterSettings.eventDensity.size == 3)
+
+    // Click on the chips to change the filter settings :
+    composeTestRule.onNodeWithTag("lowDensityFilterChip").performClick()
+    composeTestRule.onNodeWithTag("mediumDensityFilterChip").performClick()
+    composeTestRule.onNodeWithTag("highDensityFilterChip").performClick()
+
+    composeTestRule.waitForIdle()
+
+    // Check if the chips are selected :
+    composeTestRule.onNodeWithTag("lowDensityFilterChip").assertIsNotSelected()
+    composeTestRule.onNodeWithTag("mediumDensityFilterChip").assertIsNotSelected()
+    composeTestRule.onNodeWithTag("highDensityFilterChip").assertIsNotSelected()
+
+    assert(filterSettings.eventDensity.size == 0)
+
+    composeTestRule.onNodeWithTag("lowDensityFilterChip").performClick()
+
+    composeTestRule.waitForIdle()
+
+    assert(filterSettings.eventDensity.contains(EventDensity.LOW))
+    assert(!filterSettings.eventDensity.contains(EventDensity.MEDIUM))
+    assert(!filterSettings.eventDensity.contains(EventDensity.HIGH))
+
+    composeTestRule.onNodeWithTag("mediumDensityFilterChip").performClick()
+
+    composeTestRule.waitForIdle()
+
+    assert(filterSettings.eventDensity.contains(EventDensity.LOW))
+    assert(filterSettings.eventDensity.contains(EventDensity.MEDIUM))
+    assert(!filterSettings.eventDensity.contains(EventDensity.HIGH))
+
+    composeTestRule.onNodeWithTag("highDensityFilterChip").performClick()
+
+    composeTestRule.waitForIdle()
+
+    assert(filterSettings.eventDensity.contains(EventDensity.LOW))
+    assert(filterSettings.eventDensity.contains(EventDensity.MEDIUM))
+    assert(filterSettings.eventDensity.contains(EventDensity.HIGH))
+
+    // Click on the reset button :
+    composeTestRule.onNodeWithTag("resetButton").performClick()
+
+    composeTestRule.waitForIdle()
+
+    // Check if the chips are selected :
+    composeTestRule.onNodeWithTag("lowDensityFilterChip").assertIsSelected()
+    composeTestRule.onNodeWithTag("mediumDensityFilterChip").assertIsSelected()
+    composeTestRule.onNodeWithTag("highDensityFilterChip").assertIsSelected()
+  }
+}

app/src/main/java/com/android/streetworkapp/MainActivity.kt

@@ -339,6 +339,8 @@ fun StreetWorkApp(
               route = Route.MAP,
           ) {
             composable(Screen.MAP) {
+              val showFilterSettings = mutableStateOf(false)
+
               infoManager.Display(LocalContext.current)
               MapScreen(
                   parkLocationViewModel,
@@ -349,11 +351,18 @@ fun StreetWorkApp(
                   mapCallbackOnMapLoaded,
                   innerPadding,
                   scope,
-                  host)
+                  host,
+                  showFilterSettings)
+
               screenParams?.topAppBarManager?.setActionCallback(
                   TopAppBarManager.TopAppBarAction.SEARCH) {
                     showSearchBar.value = true
                   }
+
+              screenParams?.topAppBarManager?.setActionCallback(
+                  TopAppBarManager.TopAppBarAction.FILTER) {
+                    showFilterSettings.value = true
+                  }
             }
             composable(Screen.PARK_OVERVIEW) {
               infoManager.Display(LocalContext.current)

app/src/main/java/com/android/streetworkapp/model/event/EventViewModel.kt

@@ -20,6 +20,10 @@ open class EventViewModel(private val repository: EventRepository) : ViewModel()
   val currentEvent: StateFlow<Event?>
     get() = _currentEvent
 
+  private val _eventList: MutableStateFlow<Map<String, Event>> = MutableStateFlow(emptyMap())
+  val eventList: StateFlow<Map<String, Event>>
+    get() = _eventList
+
   fun setCurrentEvent(event: Event?) {
     _currentEvent.value = event
   }
@@ -31,6 +35,33 @@ open class EventViewModel(private val repository: EventRepository) : ViewModel()
     }
   }
 
+  /**
+   * Get a list of events by their IDs.
+   *
+   * @param eids The list of event IDs.
+   */
+  fun getEventsByEid(eids: List<String>) {
+    val fetchedEvents = mutableMapOf<String, Event>()
+    viewModelScope.launch {
+      eids.forEach {
+        val event = repository.getEventByEid(it)
+        if (event != null) fetchedEvents[it] = event
+      }
+      _eventList.value = fetchedEvents
+    }
+  }
+
+  /**
+   * Get a list of events from the park they are in.
+   *
+   * @param parks The list of parks.
+   */
+  fun getEventsByParkList(parks: List<Park>) {
+    val eids = parks.flatMap { it.events }
+
+    getEventsByEid(eids)
+  }
+
   fun setUiState(state: EventOverviewUiState) {
     _uiState.value = state
   }

app/src/main/java/com/android/streetworkapp/ui/map/MapUi.kt

@@ -16,7 +16,11 @@ import androidx.compose.foundation.shape.RoundedCornerShape
 import androidx.compose.material.icons.Icons
 import androidx.compose.material.icons.automirrored.filled.ArrowBack
 import androidx.compose.material.icons.filled.Event
+import androidx.compose.material3.Button
 import androidx.compose.material3.ExperimentalMaterial3Api
+import androidx.compose.material3.FilterChip
+import androidx.compose.material3.FilterChipDefaults
+import androidx.compose.material3.HorizontalDivider
 import androidx.compose.material3.Icon
 import androidx.compose.material3.IconButton
 import androidx.compose.material3.SearchBar
@@ -41,15 +45,23 @@ import androidx.compose.ui.unit.dp
 import androidx.compose.ui.unit.sp
 import androidx.core.content.ContextCompat
 import androidx.navigation.compose.rememberNavController
+import com.android.sample.R
 import com.android.streetworkapp.model.park.Park
 import com.android.streetworkapp.model.park.ParkViewModel
 import com.android.streetworkapp.model.parklocation.ParkLocationViewModel
 import com.android.streetworkapp.model.user.UserViewModel
 import com.android.streetworkapp.ui.navigation.NavigationActions
 import com.android.streetworkapp.ui.navigation.Screen
+import com.android.streetworkapp.ui.park.InteractiveRatingComponent
 import com.android.streetworkapp.ui.park.RatingComponent
 import com.android.streetworkapp.ui.theme.ColorPalette
+import com.android.streetworkapp.ui.theme.Typography as Type
+import com.android.streetworkapp.ui.utils.CustomDialog
+import com.android.streetworkapp.ui.utils.DialogType
+import com.android.streetworkapp.utils.EventDensity
+import com.android.streetworkapp.utils.FilterSettings
 import com.android.streetworkapp.utils.LocationService
+import com.android.streetworkapp.utils.ParkFilter
 import com.android.streetworkapp.utils.PermissionManager
 import com.google.android.gms.maps.model.BitmapDescriptorFactory
 import com.google.android.gms.maps.model.CameraPosition
@@ -68,7 +80,7 @@ import kotlinx.coroutines.CoroutineScope
  * @param parkLocationViewModel The view model for park locations.
  * @param navigationActions The navigation actions to navigate to other screens.
  */
-@OptIn(MapsComposeExperimentalApi::class)
+@OptIn(MapsComposeExperimentalApi::class, ExperimentalMaterial3Api::class)
 @Composable
 fun MapScreen(
     parkLocationViewModel: ParkLocationViewModel,
@@ -80,6 +92,7 @@ fun MapScreen(
     innerPaddingValues: PaddingValues = PaddingValues(0.dp),
     scope: CoroutineScope = rememberCoroutineScope(),
     host: SnackbarHostState? = null,
+    showFilterSettings: MutableState<Boolean> = mutableStateOf(false)
 ) {
 
   val context = LocalContext.current
@@ -114,6 +127,11 @@ fun MapScreen(
 
   LaunchedEffect(parks) { parkViewModel.getOrCreateAllParksByLocation(parks) }
 
+  // Set values for park filtering :
+  val filter = FilterSettings()
+  val parkFilter = ParkFilter(filter)
+  val userFilterInput = FilterSettings()
+
   Box(modifier = Modifier.testTag("mapScreen")) {
     // Create a CameraPositionState to control the camera position
     val cameraPositionState = rememberCameraPositionState {
@@ -142,6 +160,7 @@ fun MapScreen(
           parkList.value
               .filterNotNull()
               .filter { it.name.contains(searchQuery.value, ignoreCase = true) }
+              .filter { parkFilter.filter(it) }
               .forEach { park ->
                 ++markerIndex
 
@@ -169,6 +188,84 @@ fun MapScreen(
               }
         }
   }
+  // Settings variable defined beforehand :
+  // Affected by the filter settings => changes confirmed when confirming (onSubmit).
+
+  // Display the Filter component :
+  CustomDialog(
+      showFilterSettings,
+      tag = "Filter",
+      dialogType = DialogType.CONFIRM,
+      title = LocalContext.current.getString(R.string.park_filter_title),
+      Content = { ParkFilterSettings(userFilterInput) },
+      onSubmit = { filter.set(userFilterInput) },
+      onDismiss = { userFilterInput.set(filter) })
+}
+
+@OptIn(ExperimentalMaterial3Api::class)
+@Composable
+fun ParkFilterSettings(userFilterInput: FilterSettings) {
+  val context = LocalContext.current
+
+  // Note - This is a composable and cannot be defined in the ColorPalette (Theme.kt).
+  val filterChipColors =
+      FilterChipDefaults.filterChipColors(
+          selectedLabelColor = ColorPalette.PRINCIPLE_BACKGROUND_COLOR,
+          selectedContainerColor = ColorPalette.INTERACTION_COLOR_DARK)
+
+  Column(verticalArrangement = Arrangement.spacedBy(10.dp)) {
+    // Park rating filter :
+    Text(
+        text =
+            context.getString(
+                R.string.rating_filter_title, userFilterInput.minRating.value.toString()),
+        fontSize = Type.bodyLarge.fontSize,
+        modifier = Modifier.testTag("ratingFilterTitle"))
+    InteractiveRatingComponent(userFilterInput.minRating)
+
+    HorizontalDivider()
+
+    // Event quantity filter :
+    Text(
+        context.getString(R.string.eventDensity_filter_title),
+        fontSize = Type.bodyLarge.fontSize,
+        modifier = Modifier.testTag("eventDensityFilterTitle"))
+
+    Row(modifier = Modifier.align(Alignment.CenterHorizontally).fillMaxWidth(0.825f)) {
+      FilterChip(
+          selected = userFilterInput.eventDensity.contains(EventDensity.LOW),
+          onClick = { userFilterInput.updateDensity(EventDensity.LOW) },
+          label = { Text("[ 0 .. 2 ]") },
+          colors = filterChipColors,
+          modifier = Modifier.padding(end = 2.dp).testTag("lowDensityFilterChip"))
+
+      FilterChip(
+          selected = userFilterInput.eventDensity.contains(EventDensity.MEDIUM),
+          onClick = { userFilterInput.updateDensity(EventDensity.MEDIUM) },
+          label = { Text("[ 3 .. 6 ]") },
+          colors = filterChipColors,
+          modifier = Modifier.padding(end = 2.dp).testTag("mediumDensityFilterChip"))
+
+      FilterChip(
+          selected = userFilterInput.eventDensity.contains(EventDensity.HIGH),
+          onClick = { userFilterInput.updateDensity(EventDensity.HIGH) },
+          label = { Text("[7 + ]") },
+          colors = filterChipColors,
+          modifier = Modifier.padding(end = 2.dp).testTag("highDensityFilterChip"))
+    }
+
+    HorizontalDivider()
+
+    Button(
+        onClick = { userFilterInput.reset() },
+        colors = ColorPalette.BUTTON_COLOR,
+        modifier =
+            Modifier.align(Alignment.CenterHorizontally)
+                .padding(top = 4.dp)
+                .testTag("resetButton")) {
+          Text(context.getString(R.string.reset_button))
+        }
+  }
 }
 
 @OptIn(ExperimentalMaterial3Api::class)

app/src/main/java/com/android/streetworkapp/ui/navigation/NavigationActions.kt

@@ -46,7 +46,7 @@ data class ScreenParams(
     val bottomBarType: BottomNavigationMenuType = BottomNavigationMenuType.DEFAULT,
     val isTopBarVisible: Boolean = true,
     val topAppBarManager: TopAppBarManager?,
-    val hasSearchBar: Boolean = false
+    val hasSearchBar: Boolean = false,
 ) {
   companion object {
     val AUTH =
@@ -65,7 +65,8 @@ data class ScreenParams(
                     actions =
                         listOf(
                             TopAppBarManager.TopAppBarAction.SEARCH,
-                            TopAppBarManager.TopAppBarAction.INFO)),
+                            TopAppBarManager.TopAppBarAction.INFO,
+                            TopAppBarManager.TopAppBarAction.FILTER)),
             hasSearchBar = true)
     val PROFILE =
         ScreenParams(

app/src/main/java/com/android/streetworkapp/ui/navigation/TopAppBarManager.kt

@@ -22,6 +22,7 @@ class TopAppBarManager(
         icon = R.drawable.settings, contentDescription = "Settings", testTag = "settingsButton"),
     INFO(icon = R.drawable.octagon_help, contentDescription = "Info", testTag = "infoButton"),
     SEARCH(icon = R.drawable.map_search, contentDescription = "Search", testTag = "searchButton"),
+    FILTER(icon = R.drawable.map_search, contentDescription = "Filter", testTag = "filterButton"),
 
     // Add more actions here
   }

app/src/main/java/com/android/streetworkapp/ui/park/ParkOverview.kt

@@ -388,7 +388,10 @@ fun InteractiveRatingComponent(rating: MutableState<Int>) {
  * @param navigationActions The navigation actions to navigate to other screens.
  */
 @Composable
-fun EventItemList(eventViewModel: EventViewModel, navigationActions: NavigationActions) {
+fun EventItemList(
+    eventViewModel: EventViewModel,
+    navigationActions: NavigationActions,
+) {
   val uiState = eventViewModel.uiState.collectAsState().value
 
   Column(modifier = Modifier.testTag("eventItemList")) {