Merge PR #174: Enable sorting genres by song count

This PR adds functionality to sort genres by either name (alphabetically)
or by song count (descending). The implementation includes:

Features:
- Added GenreSortOrder enum (Default, Name, SongCount)
- New toolbar menu for genre list with sort options
- Sort preference persistence via SortPreferenceManager
- Sorting works during media library scanning

Implementation:
- Updated GenreListViewModel to handle sort order changes
- Modified GenreList composable to notify Fragment of sort order updates
- Added GenreComparator with name and song count comparators
- Created menu_genre_list.xml with sort options
- Updated translations for menu strings across all languages

Testing:
- Added GenreComparatorTest for sort order validation
- Added GenreListTest for ViewModel behavior testing
- Tests use MockK and coroutines-test for comprehensive coverage

Dependencies:
- Added mockk (1.14.2) for unit testing
- Added kotlinx-coroutines-test (1.10.2) for testing coroutines
- Updated dependency versions to match current HEAD

Conflict Resolution:
- Merged GenreList.kt: Combined HEAD's loading UI with PR's sort callbacks
- Merged GenreListFragment.kt: Kept ImmutableList conversion and added sort menu
- Merged gradle/libs.versions.toml: Used HEAD versions, added PR test dependencies

Author: claude

android/app/build.gradle.kts

@@ -259,6 +259,8 @@ android {
 
 
         testImplementation(libs.junit)
+        testImplementation(libs.mockk)
+        testImplementation(libs.kotlinx.coroutines.test)
 
         // WorkManager
         implementation(libs.androidx.work.runtime.ktx)

android/app/src/main/java/com/simplecityapps/shuttle/ui/screens/library/SortPreferenceManager.kt

@@ -4,6 +4,7 @@ import android.content.SharedPreferences
 import com.simplecityapps.shuttle.persistence.get
 import com.simplecityapps.shuttle.persistence.put
 import com.simplecityapps.shuttle.sorting.AlbumSortOrder
+import com.simplecityapps.shuttle.sorting.GenreSortOrder
 import com.simplecityapps.shuttle.sorting.SongSortOrder
 import timber.log.Timber
 
@@ -32,4 +33,17 @@ class SortPreferenceManager(private val sharedPreferences: SharedPreferences) {
                 AlbumSortOrder.AlbumName
             }
         }
+
+    var sortOrderGenreList: GenreSortOrder
+        set(value) {
+            sharedPreferences.put("sort_order_genre_list", value.name)
+        }
+        get() {
+            return try {
+                GenreSortOrder.valueOf(sharedPreferences.get("sort_order_genre_list", GenreSortOrder.Name.name))
+            } catch (e: IllegalArgumentException) {
+                Timber.e(e, "Failed to retrieve sort order")
+                GenreSortOrder.Name
+            }
+        }
 }

android/app/src/main/java/com/simplecityapps/shuttle/ui/screens/library/genres/GenreList.kt

@@ -23,6 +23,7 @@ import com.simplecityapps.shuttle.R
 import com.simplecityapps.shuttle.model.Genre
 import com.simplecityapps.shuttle.model.MediaProviderType
 import com.simplecityapps.shuttle.model.Playlist
+import com.simplecityapps.shuttle.sorting.GenreSortOrder
 import com.simplecityapps.shuttle.sorting.PlaylistSongSortOrder
 import com.simplecityapps.shuttle.ui.common.components.CircularLoadingState
 import com.simplecityapps.shuttle.ui.common.components.FastScroller
@@ -37,6 +38,7 @@ import kotlinx.collections.immutable.toImmutableList
 fun GenreList(
     viewState: GenreListViewModel.ViewState,
     playlists: ImmutableList<Playlist>,
+    setToolbarMenu: (sortOrder: GenreSortOrder) -> Unit,
     modifier: Modifier = Modifier,
     onSelectGenre: (genre: Genre) -> Unit = {},
     onPlayGenre: (Genre) -> Unit = {},
@@ -49,6 +51,7 @@ fun GenreList(
 ) {
     when (viewState) {
         is GenreListViewModel.ViewState.Scanning -> {
+            setToolbarMenu(viewState.sortOrder)
             HorizontalLoadingView(
                 modifier = modifier
                     .fillMaxSize()
@@ -69,6 +72,7 @@ fun GenreList(
         }
 
         is GenreListViewModel.ViewState.Ready -> {
+            setToolbarMenu(viewState.sortOrder)
             if (viewState.genres.isEmpty()) {
                 LoadingStatusIndicator(
                     modifier = modifier
@@ -159,7 +163,8 @@ private fun GenreListLoadingPreview() {
         ) {
             GenreList(
                 viewState = GenreListViewModel.ViewState.Loading,
-                playlists = samplePlaylists
+                playlists = samplePlaylists,
+                setToolbarMenu = {}
             )
         }
     }
@@ -175,8 +180,9 @@ private fun GenreListScanningPreview() {
                 .background(MaterialTheme.colorScheme.background)
         ) {
             GenreList(
-                viewState = GenreListViewModel.ViewState.Scanning(progress = Progress(20, 205)),
-                playlists = samplePlaylists
+                viewState = GenreListViewModel.ViewState.Scanning(progress = Progress(20, 205), sortOrder = GenreSortOrder.Name),
+                playlists = samplePlaylists,
+                setToolbarMenu = {}
             )
         }
     }
@@ -192,8 +198,9 @@ private fun GenreListEmptyPreview() {
                 .background(MaterialTheme.colorScheme.background)
         ) {
             GenreList(
-                viewState = GenreListViewModel.ViewState.Ready(genres = emptyList()),
-                playlists = samplePlaylists
+                viewState = GenreListViewModel.ViewState.Ready(genres = emptyList(), sortOrder = GenreSortOrder.Name),
+                playlists = samplePlaylists,
+                setToolbarMenu = {}
             )
         }
     }
@@ -210,9 +217,11 @@ private fun GenreListPreview() {
         ) {
             GenreList(
                 viewState = GenreListViewModel.ViewState.Ready(
-                    genres = sampleGenres
+                    genres = sampleGenres,
+                    sortOrder = GenreSortOrder.Name
                 ),
-                playlists = samplePlaylists
+                playlists = samplePlaylists,
+                setToolbarMenu = {}
             )
         }
     }

android/app/src/main/java/com/simplecityapps/shuttle/ui/screens/library/genres/GenreListFragment.kt

@@ -2,6 +2,9 @@ package com.simplecityapps.shuttle.ui.screens.library.genres
 
 import android.os.Bundle
 import android.view.LayoutInflater
+import android.view.Menu
+import android.view.MenuInflater
+import android.view.MenuItem
 import android.view.View
 import android.view.ViewGroup
 import android.widget.Toast
@@ -15,9 +18,11 @@ import androidx.navigation.fragment.findNavController
 import com.simplecityapps.shuttle.R
 import com.simplecityapps.shuttle.model.Genre
 import com.simplecityapps.shuttle.model.Song
+import com.simplecityapps.shuttle.sorting.GenreSortOrder
 import com.simplecityapps.shuttle.ui.common.autoCleared
 import com.simplecityapps.shuttle.ui.common.dialog.TagEditorAlertDialog
 import com.simplecityapps.shuttle.ui.common.error.userDescription
+import com.simplecityapps.shuttle.ui.common.view.findToolbarHost
 import com.simplecityapps.shuttle.ui.screens.library.genres.detail.GenreDetailFragmentArgs
 import com.simplecityapps.shuttle.ui.screens.playlistmenu.CreatePlaylistDialogFragment
 import com.simplecityapps.shuttle.ui.screens.playlistmenu.PlaylistData
@@ -44,6 +49,12 @@ class GenreListFragment :
 
     // Lifecycle
 
+    override fun onCreate(savedInstanceState: Bundle?) {
+        super.onCreate(savedInstanceState)
+
+        setHasOptionsMenu(true)
+    }
+
     override fun onCreateView(
         inflater: LayoutInflater,
         container: ViewGroup?,
@@ -75,6 +86,9 @@ class GenreListFragment :
                 GenreList(
                     viewState = viewState,
                     playlists = playlistMenuPresenter.playlists.toImmutableList(),
+                    setToolbarMenu = { sortOrder ->
+                        updateToolbarMenu(sortOrder)
+                    },
                     onSelectGenre = {
                         onGenreSelected(it)
                     },
@@ -121,12 +135,47 @@ class GenreListFragment :
         }
     }
 
+    override fun onCreateOptionsMenu(
+        menu: Menu,
+        inflater: MenuInflater
+    ) {
+        super.onCreateOptionsMenu(menu, inflater)
+
+        inflater.inflate(R.menu.menu_genre_list, menu)
+    }
+
     override fun onDestroyView() {
         playlistMenuPresenter.unbindView()
 
         super.onDestroyView()
     }
 
+    // Toolbar item selection
+
+    override fun onOptionsItemSelected(item: MenuItem): Boolean = when (item.itemId) {
+        R.id.sortGenreName -> {
+            viewModel.setSortOrder(GenreSortOrder.Name)
+            true
+        }
+        R.id.sortSongCount -> {
+            viewModel.setSortOrder(GenreSortOrder.SongCount)
+            true
+        }
+        else -> false
+    }
+
+    private fun updateToolbarMenu(sortOrder: GenreSortOrder) {
+        findToolbarHost()?.toolbar?.menu?.let { menu ->
+            when (sortOrder) {
+                GenreSortOrder.Name -> menu.findItem(R.id.sortGenreName)?.isChecked = true
+                GenreSortOrder.SongCount -> menu.findItem(R.id.sortSongCount)?.isChecked = true
+                else -> {
+                    // Nothing to do
+                }
+            }
+        }
+    }
+
     fun onAddedToQueue(genre: Genre) {
         Toast.makeText(context, Phrase.from(requireContext(), R.string.queue_item_added).put("item_name", genre.name).format(), Toast.LENGTH_SHORT).show()
     }

android/app/src/main/java/com/simplecityapps/shuttle/ui/screens/library/genres/GenreListViewModel.kt

@@ -8,22 +8,28 @@ import com.simplecityapps.mediaprovider.Progress
 import com.simplecityapps.mediaprovider.SongImportState
 import com.simplecityapps.mediaprovider.repository.genres.GenreQuery
 import com.simplecityapps.mediaprovider.repository.genres.GenreRepository
+import com.simplecityapps.mediaprovider.repository.genres.comparator
 import com.simplecityapps.mediaprovider.repository.songs.SongRepository
 import com.simplecityapps.playback.PlaybackManager
 import com.simplecityapps.playback.queue.QueueManager
 import com.simplecityapps.shuttle.model.Genre
 import com.simplecityapps.shuttle.model.Song
 import com.simplecityapps.shuttle.persistence.GeneralPreferenceManager
 import com.simplecityapps.shuttle.query.SongQuery
+import com.simplecityapps.shuttle.sorting.GenreSortOrder
+import com.simplecityapps.shuttle.ui.screens.library.SortPreferenceManager
 import dagger.hilt.android.lifecycle.HiltViewModel
 import javax.inject.Inject
+import kotlinx.coroutines.Dispatchers
 import kotlinx.coroutines.flow.MutableStateFlow
 import kotlinx.coroutines.flow.asStateFlow
 import kotlinx.coroutines.flow.combine
 import kotlinx.coroutines.flow.firstOrNull
 import kotlinx.coroutines.flow.launchIn
 import kotlinx.coroutines.flow.onStart
 import kotlinx.coroutines.launch
+import kotlinx.coroutines.withContext
+import timber.log.Timber
 
 @OpenForTesting
 @HiltViewModel
@@ -32,6 +38,7 @@ class GenreListViewModel @Inject constructor(
     private val songRepository: SongRepository,
     private val playbackManager: PlaybackManager,
     private val queueManager: QueueManager,
+    private val sortPreferenceManager: SortPreferenceManager,
     preferenceManager: GeneralPreferenceManager,
     mediaImportObserver: MediaImportObserver
 ) : ViewModel() {
@@ -40,13 +47,13 @@ class GenreListViewModel @Inject constructor(
 
     init {
         combine(
-            genreRepository.getGenres(GenreQuery.All()),
+            genreRepository.getGenres(GenreQuery.All(sortOrder = sortPreferenceManager.sortOrderGenreList)),
             mediaImportObserver.songImportState
         ) { genres, songImportState ->
             if (songImportState is SongImportState.ImportProgress) {
-                _viewState.emit(ViewState.Scanning(songImportState.progress))
+                _viewState.emit(ViewState.Scanning(songImportState.progress, sortPreferenceManager.sortOrderGenreList))
             } else {
-                _viewState.emit(ViewState.Ready(genres))
+                _viewState.emit(ViewState.Ready(genres, sortPreferenceManager.sortOrderGenreList))
             }
         }
             .onStart {
@@ -106,13 +113,31 @@ class GenreListViewModel @Inject constructor(
         }
     }
 
+    fun setSortOrder(sortOrder: GenreSortOrder) {
+        if (sortPreferenceManager.sortOrderGenreList == sortOrder) return
+
+        Timber.i("Updating sort order: $sortOrder")
+        viewModelScope.launch {
+            withContext(Dispatchers.IO) {
+                sortPreferenceManager.sortOrderGenreList = sortOrder
+            }
+            when (val state = _viewState.value) {
+                is ViewState.Scanning -> _viewState.emit(ViewState.Scanning(state.progress, sortOrder))
+                is ViewState.Ready -> _viewState.emit(ViewState.Ready(state.genres.sortedWith(sortOrder.comparator), sortOrder))
+                else -> {
+                    // View is not created
+                }
+            }
+        }
+    }
+
     private suspend fun getSongsForGenreOrEmpty(genre: Genre) = genreRepository.getSongsForGenre(genre.name, SongQuery.All())
         .firstOrNull()
         .orEmpty()
 
     sealed class ViewState {
-        data class Scanning(val progress: Progress?) : ViewState()
         data object Loading : ViewState()
-        data class Ready(val genres: List<Genre>) : ViewState()
+        data class Scanning(val progress: Progress?, val sortOrder: GenreSortOrder) : ViewState()
+        data class Ready(val genres: List<Genre>, val sortOrder: GenreSortOrder) : ViewState()
     }
 }

android/app/src/main/res/menu/menu_genre_list.xml

@@ -0,0 +1,21 @@
+<?xml version="1.0" encoding="utf-8"?>
+<menu xmlns:android="http://schemas.android.com/apk/res/android"
+    xmlns:app="http://schemas.android.com/apk/res-auto">
+    <item
+        android:id="@+id/genreSortOrder"
+        android:icon="@drawable/ic_baseline_sort_24"
+        android:title="@string/menu_title_sort_by"
+        app:showAsAction="never">
+
+        <menu>
+            <group android:checkableBehavior="single">
+                <item
+                    android:id="@+id/sortGenreName"
+                    android:title="@string/menu_title_sort_name" />
+                <item
+                    android:id="@+id/sortSongCount"
+                    android:title="@string/menu_title_sort_song_count" />
+            </group>
+        </menu>
+    </item>
+</menu>

android/app/src/main/res/values-de/strings_menu.xml

@@ -46,6 +46,10 @@
     <string name="menu_title_sort_song_name">Song-Name</string>
     <!-- Menu option to sort by year-->
     <string name="menu_title_sort_year">Jahr</string>
+    <!-- Menu option to sort by name -->
+    <string name="menu_title_sort_name">Name</string>
+    <!-- Menu option to sort by song count -->
+    <string name="menu_title_sort_song_count">"Liedanzahl"</string>
     <!-- Menu option to sort by song duration -->
     <string name="menu_title_sort_duration">Dauer</string>
     <!-- Menu option to sort by last modified date -->

android/app/src/main/res/values-en-rGB/strings_menu.xml

@@ -46,6 +46,10 @@
     <string name="menu_title_sort_song_name">Song Name</string>
     <!-- Menu option to sort by year-->
     <string name="menu_title_sort_year">Year</string>
+    <!-- Menu option to sort by name -->
+    <string name="menu_title_sort_name">Name</string>
+    <!-- Menu option to sort by song count -->
+    <string name="menu_title_sort_song_count">Song Count</string>
     <!-- Menu option to sort by song duration -->
     <string name="menu_title_sort_duration">Duration</string>
     <!-- Menu option to sort by last modified date -->

android/app/src/main/res/values-es-rES/strings_menu.xml

@@ -46,6 +46,10 @@
     <string name="menu_title_sort_song_name">Nombre de canción</string>
     <!-- Menu option to sort by year-->
     <string name="menu_title_sort_year">Año</string>
+    <!-- Menu option to sort by name -->
+    <string name="menu_title_sort_name">Nombre</string>
+    <!-- Menu option to sort by song count -->
+    <string name="menu_title_sort_song_count">Número de canciones</string>
     <!-- Menu option to sort by song duration -->
     <string name="menu_title_sort_duration">Duración</string>
     <!-- Menu option to sort by last modified date -->

android/app/src/main/res/values-es/strings_menu.xml

@@ -46,6 +46,10 @@
     <string name="menu_title_sort_song_name">Nombre de canción</string>
     <!-- Menu option to sort by year-->
     <string name="menu_title_sort_year">Año</string>
+    <!-- Menu option to sort by name -->
+    <string name="menu_title_sort_name">Nombre</string>
+    <!-- Menu option to sort by song count -->
+    <string name="menu_title_sort_song_count">Número de canciones</string>
     <!-- Menu option to sort by song duration -->
     <string name="menu_title_sort_duration">Duración</string>
     <!-- Menu option to sort by last modified date -->