Feature/event listing - Implement Event List Overview with Mock Data, UI Enhancements, and Unit Tests #29

Aurelien9Code · 2024-10-08T18:34:37Z

This pull request introduces the foundational structure for the "Events" feature, including a mock implementation of event data handling, UI enhancements, and essential unit tests. The focus is to provide a functional event list view for testing and development purposes until the final event data source is implemented.

Key Features ->

Event Data Handling:
-Created Event.kt data class to represent event entities.
-Implemented EventRepositoryMock for testing, providing sample events as the real event repository is yet to be finalized.

ViewModel and State Management:
-Introduced EventListViewModel with StateFlow to manage event data.
-Mock data is loaded into the ViewModel for use during testing and development.

UI Enhancements:
-Developed a responsive Event List Overview with a tab selection animation (switching between "All" and "Following").
-Created a dynamic layout that adjusts the tab size based on text width and tracks the X coordinates for smooth transitions.
-Designed EventItem UI with gradient colors, background images, and dynamic styling for better user experience.
-Added handling for empty event lists, showing a user-friendly message when no events are available.
-Implemented utility functions for event type color mapping and contrast adjustments.
-Introduced new properties to Event (like catchy_description, main_type, and picture) to enrich the event details.

UI Testing and Preview:
-Added a composable function, EventListOverviewPreview, for easier UI previews in development.
-Enhanced UI components with test tags to support automated UI testing.

Unit Testing:
-Added comprehensive tests for the Event List Overview component, covering tab switching, empty list handling, and rendering of event items.
-Verified UI animations and behavior, including the functionality of the "Map" button.

Let me know if you'd like any modification ! ; )

- Create `Event.kt` data class to represent event entities. - Define `EventRepository` interface for event-related data operations. - Implement `EventRepositoryFirestore` to fetch events from Firebase Firestore. Theses implementations are very dumb, as someone else will take care of the Events database. I made it in order to start doing the events list

- Implemented EventRepositoryMock to provide mock data since EventRepository is not made yet - Mock data includes sample events for testing purposes

- Created EventListViewModel to manage event data using StateFlow. - Added a function to load mock events for testing and development. - Provided ViewModelFactory for proper lifecycle management.

… animation and dynamic layout - Implemented nice event layout with gradient colors. - Implemented a smooth sliding animation for tab selection between "All" and "Following". - Added dynamic width calculation for tab text to ensure proper layout. - Introduced tracking of X coordinates for both tabs to calculate the selected tab's position and width. - Converted pixel sizes to density-independent pixels (dp) for better scalability across devices. - Enhanced event list handling to display a message when no events are available, improving user experience.

- Created a data class `EventTypeColor` to represent event types and their associated colors. - Implemented a function `getColorForEventType` to retrieve the color based on the event type.

…es to Event data class

- Added a preview composable function `EventListOverviewPreview` for `EventListOverview`. - Enhanced the `EventItem` UI to include a background image and improved text styling. - Added utility functions for color manipulation and contrast calculation. - Updated imports and dependencies to support new features.

- Add tests for tab switching and animations in the EventListOverview component. - Add a test for displaying the empty event list message when no events are available. - Add a test for rendering a non-empty event list and verifying the titles and descriptions of the events. - Add a test to verify the functionality of the "Map" button.

- Added test tags for various UI components in the `EventListOverview` and `EventItem` composables to facilitate automated testing.

-will remake one later

Aurelien9Code · 2024-10-09T10:56:20Z

There is a lot of duplicated code, but it's only for the EventListRepositoryMock for test reasons so it will be destroyed when I will delete my mock

Romainhir · 2024-10-09T11:47:00Z

The image in "model/events/events_picture" is already in "resources". The "event_picture" package should not exist in "model/events". However, it can be a sub package of "resources"

Romainhir · 2024-10-09T11:50:17Z

app/src/main/java/com/android/unio/model/events/Event.kt

+    val title: String,
+    val catchy_description: String,
+    val description: String,
+    val date: String, // Consider using Date type with proper formatting


Is there a good reason to keep the "date" attribute as a String for now ? Why isn't this already a "Date" type ?

Indeed, we should use the Firebase Timestamp class.

Indeed, we should use the Firebase Timestamp class.

Agreed.

This class was only a 'mock' class to wait for the real Event Repository structure
When it will be pushed to main, i will delete my event repository structure and connect my code with the one in main

Romainhir · 2024-10-09T11:54:08Z

app/src/main/java/com/android/unio/model/events/Event.kt

+    val catchy_description: String,
+    val description: String,
+    val date: String, // Consider using Date type with proper formatting
+    val location: String,


The "location" attribute should be a "Location" type, like used in the bootcamp, or another type, from a new class, to fit better with EPFL geography.

The "location" attribute should be a "Location" type, like used in the bootcamp, or another type, from a new class, to fit better with EPFL geography.

Yes. We do have a Location data class available which can and should be used

Agreed, I believe Firebase provides a GeoPoint data class we could use.

same as before, i just did it blindly but i will destroy this class for the better one

Agreed, I believe Firebase provides a GeoPoint data class we could use.

True, however this would only store the coordinates correct?

You can transform Coordinates into a place with Google Maps API
I think the best thing to do would be to ask the Event creator precise coordinates (as our map feature is based on precision of the event) and then we could show himthe output of Maps API for example 'Plage de Vidy'
Then he can agree to it or edit it, and the location as a text would be what people see on the event page, but if they clic on the map the pin point location would be the precise coordinates of the event

Yes correct I just mean we will still need to hava a String field for the name of the location, so we either keep Location.kt as is, or use the GeoPoint data class instead of having two Double fields

True, however this would only store the coordinates correct?

Yes, the GeoPoint class contains only a longitude and latitude property, but its advantage is the automatic serialization and hydration when sending/retrieving from Firebase. Maybe the correct way to go is a wrapper class that contains a GeoPoint in addition to some information about the event's location.

Romainhir · 2024-10-09T11:57:11Z

app/src/main/java/com/android/unio/model/events/Event.kt

+    val description: String,
+    val date: String, // Consider using Date type with proper formatting
+    val location: String,
+    val main_type: String,


The "main_type" attribute should probably be an Enumeration of type of event. This will also be useful in "EventTypeColor"

Yes, kind of like the enum class AssociationType I wrote in the MockAssociations.kt file (which we will also incorporate to the real association data class)

same haha but thank you for the idea

Romainhir · 2024-10-09T11:59:59Z

app/src/main/java/com/android/unio/model/events/Event.kt

+    val location: String,
+    val main_type: String,
+    val picture: String
+)


Consider also using camelCase over snake_case for attribute, to keep the same naming convention over the whole project

Thanks ! I'm gonna check on the real one to make sure it's in camelCase

Romainhir · 2024-10-09T12:02:18Z

app/src/main/java/com/android/unio/model/events/EventTypeColor.kt

+import androidx.compose.ui.graphics.Color
+
+// class for event types and their corresponding colors
+data class EventTypeColor(val type: String, val color: Color)


As said in "Event.kt", the "type" attribute should be an Enumeration of type

Additionally, this class should simply be called EventType, as its main purpose isn't providing colors, but instead distinguishing event types.

Okay, I will change that ! Thanks

Romainhir · 2024-10-09T12:04:05Z

app/src/main/java/com/android/unio/model/events/EventTypeColor.kt

+    listOf(
+        EventTypeColor("festival", Color(0xFF6200EE)), // purple
+        EventTypeColor("apéro", Color(0xFF03DAC5)), // teal
+        EventTypeColor("soirée", Color(0xFFFF5722)), // deep orange


Consider translate "type" in english, for consistency (like "apéro" or "soirée")

oskar-codes · 2024-10-09T12:35:07Z

app/src/main/java/com/android/unio/model/events/EventRepositoryFirestore.kt

+class EventRepositoryFirestore : EventRepository {
+  private val firestore = FirebaseFirestore.getInstance()
+
+  // Change the return type to accept a callback


This one will be destroyed, as the other for the same explanation

oskar-codes · 2024-10-09T12:37:52Z

app/src/main/java/com/android/unio/model/events/EventListViewModel.kt

+
+  /** Loads the list of events from the repository and updates the internal [MutableStateFlow]. */
+  fun loadEvents() {
+    _events.value = repository.getEvents()


When at a later time the EventRepositoryFirestore is integrated, this will not work, as repository.getEvents is asynchronous. Consider changing this to use a callback function.

Yes thank you ! Copilot proposed it to me, but as I didn't know how EventRepositoryFirestore would be made, i didn't do it

Aurelien9Code · 2024-10-09T13:47:31Z

If that is okay for all of my reviewers, I will change EnventListViewModel.kt to use a callback function, restructure the EventType.kt file and add some consistency in the names. For the rest, as it was only a blind implementation of EventRepository structure in order to wait for the real one (which is now pushed to main), I will just push to the main and then destroy my structure and connect the real one to the rest of my code. Thanks !

oskar-codes · 2024-10-09T15:03:03Z

If that is okay for all of my reviewers, I will change EnventListViewModel.kt to use a callback function, restructure the EventType.kt file and add some consistency in the names. For the rest, as it was only a blind implementation of EventRepository structure in order to wait for the real one (which is now pushed to main), I will just push to the main and then destroy my structure and connect the real one to the rest of my code. Thanks !

@Aurelien9Code I believe you can pull the changes from main directly to this branch, without having to merge beforehand. See this.

Aurelien9Code · 2024-10-09T15:04:22Z

If that is okay for all of my reviewers, I will change EnventListViewModel.kt to use a callback function, restructure the EventType.kt file and add some consistency in the names. For the rest, as it was only a blind implementation of EventRepository structure in order to wait for the real one (which is now pushed to main), I will just push to the main and then destroy my structure and connect the real one to the rest of my code. Thanks !

@Aurelien9Code I believe you can pull the changes from main directly to this branch, without having to merge beforehand. See this.

thanks ! I'll check this tomorrow morning

…m for better understanding and utilization

…tructure

- Updated EventListViewModel to load events asynchronously using coroutines. - Refactored `loadEvents()` to use `viewModelScope.launch` for non-blocking execution.

… (also for test file)

oskar-codes · 2024-10-10T16:14:56Z

app/src/main/java/com/android/unio/ui/event/EventListOverview.kt

+
+// these twos functions might be useful later
+
+/*fun getContrastingColorBlackAndWhite(backgroundColor: Color): Color {


Consider removing these comments in a later pull request.

Aurelien9Code · 2024-10-10T16:15:54Z

All the changements required are now done !
To summary, it was :
-> change EnventListViewModel.kt to use a callback function
-> structure the EventType.kt file and add some consistency in the names
-> add some consistency in the names
-> pull main to my branch
-> recode my files to link them to the real EventRespository structure
-> delete my mock EventRepository structure

Thanks !

Romainhir · 2024-10-10T16:42:17Z

LGTM

oskar-codes · 2024-10-10T16:42:31Z

Astronomically low code coverage, but apart from that it looks good to me.

Aurelien9Code · 2024-10-10T16:46:17Z

71% will be improved soon for sure ! But it's not that bad...
Thanks for the review thought !

sonarqubecloud · 2024-10-10T17:06:46Z

Quality Gate failed

Failed conditions
71.2% Coverage on New Code (required ≥ 80%)

See analysis details on SonarCloud

leagrieder

PR Review

Improving Description for Clarity: Consider adding titles and subtitles in Markdown to improve readability and make the description clearer. This structure helps reviewers quickly understand what has been implemented and its purpose.
Hardcoded Strings: You still have hardcoded strings in your code. It’s better to move them to string resources (strings.xml) to make the code more maintainable. This will also make it easier if you plan to support multiple languages in the future.
Comment Removal: It seems there are still comments in your code, such as "these two functions might be useful later", which have not been removed. If you choose to leave comments like these, be more specific about their purpose. Explain why they may be useful later and provide context for future contributors.
Inlined Comments: Small suggestion regarding the inlined comments—there are quite a few that explain what the code is doing, which is already clear from the code itself. This can make the code less readable and weigh it down. To keep things clean and easy to follow, we could reduce some of these comments and instead focus on explaining why certain decisions were made or clarifying any complex logic. This will help make the code more concise and maintainable.
Positive Feedback: Excellent commit messages and a very well-organized description! Your reviewers provided valuable feedback, and you did a fantastic job implementing their suggestions. Your code is clean, maintainable, and well-documented. Keep up the great work!

leagrieder · 2024-10-14T06:28:25Z

app/src/main/java/com/android/unio/ui/event/EventListOverview.kt

+                      style =
+                          TextStyle(
+                              fontSize =
+                                  24.sp // Set the font size to 24 sp (scale-independent pixels)


This comment is not necessary

leagrieder · 2024-10-14T06:28:52Z

app/src/main/java/com/android/unio/ui/event/EventListOverview.kt

+
+                        // Clickable text for "Following"
+                        Text(
+                            text = "Following",


It's a good habit to develop to avoid writing hard coded string in the code, and favor the use of String.xml resources. This will makes it easier to later localize the application. It also makes the app more maintainable as it is easy to modify one text, without having to remember to modify every places that are displaying the hard coded text.

Aurelien9Code and others added 20 commits October 6, 2024 22:31

feat(events): add mock implementation of EventRepository

6b9020d

- Implemented EventRepositoryMock to provide mock data since EventRepository is not made yet - Mock data includes sample events for testing purposes

feat(events): add EventListViewModel with mock data loading

2cef11b

- Created EventListViewModel to manage event data using StateFlow. - Added a function to load mock events for testing and development. - Provided ViewModelFactory for proper lifecycle management.

feat(events): add event type colors mapping and retrieval function

dd2de2b

- Created a data class `EventTypeColor` to represent event types and their associated colors. - Implemented a function `getColorForEventType` to retrieve the color based on the event type.

feat(events): add catchy_description, main_type, and picture properti…

448d0a5

…es to Event data class

feat(events): add some example types

80045f1

feat(events): minor change to the event type - color mapping

952f958

feat(events): add comments using Java Doc conventional comments

8c49a6c

feat(events): add test tags for UI components

c79e00b

- Added test tags for various UI components in the `EventListOverview` and `EventItem` composables to facilitate automated testing.

Merge branch 'main' into feature/event-listing

d5bc008

feat(events): execute ktfmtFormat

5d9d633

feat(events): add pictures for temporary uses

7d5fe28

feat(events): remove weird test temporarily

e4b4332

style(Kotlin Format) : format file using ktfmt

2479a35

test(events) : remove bugged test

c274b20

-will remake one later

style(Kotlin Format) : format file using ktfmt

aaf4288

test(events) : add a new test

5ea51c5

Romainhir requested changes Oct 9, 2024

View reviewed changes

oskar-codes reviewed Oct 9, 2024

View reviewed changes

feat(events) : change types in english for consistency

3d12e82

Aurelien9Code added 7 commits October 10, 2024 17:02

feat(events) : modified EventTypeColor into EventType and into an enu…

826dec1

…m for better understanding and utilization

feat(events) : modified all files according to the new EventType.kt s…

f688e0a

…tructure

feat(events) : modify structure of Event.kt for camelCase convention

2666739

feat(events) : deleted unused directory

93abbeb

refactor(viewmodel): handle asynchronous event loading with coroutines

3c3ace8

- Updated EventListViewModel to load events asynchronously using coroutines. - Refactored `loadEvents()` to use `viewModelScope.launch` for non-blocking execution.

style(format): format file using ktfmt format

c1ac946

feat(events) : use real EventRepository structure and delete test one…

b5fd44b

… (also for test file)

oskar-codes reviewed Oct 10, 2024

View reviewed changes

Romainhir approved these changes Oct 10, 2024

View reviewed changes

Aurelien9Code and others added 2 commits October 10, 2024 18:46

Merge branch 'main' into feature/event-listing

07362b4

feat(events) : modify mock file according to conflict resolution

d35b4dd

Aurelien9Code merged commit 067494f into main Oct 10, 2024
1 of 2 checks passed

Aurelien9Code deleted the feature/event-listing branch October 10, 2024 17:09

leagrieder reviewed Oct 14, 2024

View reviewed changes


		// these twos functions might be useful later

		/*fun getContrastingColorBlackAndWhite(backgroundColor: Color): Color {

Feature/event listing - Implement Event List Overview with Mock Data, UI Enhancements, and Unit Tests #29

Feature/event listing - Implement Event List Overview with Mock Data, UI Enhancements, and Unit Tests #29

Conversation

Aurelien9Code commented Oct 8, 2024

Aurelien9Code commented Oct 9, 2024

Romainhir commented Oct 9, 2024

Choose a reason for hiding this comment

oskar-codes Oct 9, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Aurelien9Code commented Oct 9, 2024

oskar-codes commented Oct 9, 2024 • edited Loading

Aurelien9Code commented Oct 9, 2024

Choose a reason for hiding this comment

Aurelien9Code commented Oct 10, 2024

Romainhir commented Oct 10, 2024

oskar-codes commented Oct 10, 2024

Aurelien9Code commented Oct 10, 2024

sonarqubecloud bot commented Oct 10, 2024

Quality Gate failed

leagrieder left a comment

Choose a reason for hiding this comment

PR Review

Choose a reason for hiding this comment

Choose a reason for hiding this comment

oskar-codes Oct 9, 2024 •

edited

Loading

oskar-codes commented Oct 9, 2024 •

edited

Loading