music: add support for compilation sub-types

Add support for compilation + live, compilation + remix,
and compilation + dj-mix release types.

This was not included due to the changes it required to the
parser. Turns out these changes are largely trivial if I do
more clever inlining.

CHANGELOG.md

@@ -7,6 +7,7 @@
 
 #### What's Improved
 - Sorting now takes accented characters into account
+- Added support for compilation sub-release-types like (DJ) Mix
 
 #### What's Fixed
 - Fixed issue where the scroll popup would not display correctly in landscape mode [#230]

app/src/main/java/org/oxycblt/auxio/detail/DetailViewModel.kt

@@ -245,22 +245,23 @@ class DetailViewModel(application: Application) :
         val byReleaseGroup =
             albums.groupBy {
                 when (it.releaseType.refinement) {
-                    ReleaseType.Refinement.LIVE -> R.string.lbl_live_group
+                    ReleaseType.Refinement.LIVE -> ReleaseTypeGrouping.LIVE
-                    ReleaseType.Refinement.REMIX -> R.string.lbl_remix_group
+                    ReleaseType.Refinement.REMIX -> ReleaseTypeGrouping.REMIXES
                     null ->
                         when (it.releaseType) {
-                            is ReleaseType.Album -> R.string.lbl_albums
+                            is ReleaseType.Album -> ReleaseTypeGrouping.ALBUMS
-                            is ReleaseType.EP -> R.string.lbl_eps
+                            is ReleaseType.EP -> ReleaseTypeGrouping.EPS
-                            is ReleaseType.Single -> R.string.lbl_singles
+                            is ReleaseType.Single -> ReleaseTypeGrouping.SINGLES
-                            is ReleaseType.Compilation -> R.string.lbl_compilations
+                            is ReleaseType.Compilation -> ReleaseTypeGrouping.COMPILATIONS
-                            is ReleaseType.Soundtrack -> R.string.lbl_soundtracks
+                            is ReleaseType.Soundtrack -> ReleaseTypeGrouping.SOUNDTRACKS
-                            is ReleaseType.Mixtape -> R.string.lbl_mixtapes
+                            is ReleaseType.Mix -> ReleaseTypeGrouping.MIXES
+                            is ReleaseType.Mixtape -> ReleaseTypeGrouping.MIXTAPES
                         }
                 }
             }
 
         for (entry in byReleaseGroup.entries.sortedBy { it.key }) {
-            data.add(Header(entry.key))
+            data.add(Header(entry.key.string))
             data.addAll(entry.value)
         }
 
@@ -324,6 +325,18 @@ class DetailViewModel(application: Application) :
     override fun onCleared() {
         musicStore.removeCallback(this)
     }
+
+    private enum class ReleaseTypeGrouping(@StringRes val string: Int) {
+        ALBUMS(R.string.lbl_albums),
+        EPS(R.string.lbl_eps),
+        SINGLES(R.string.lbl_singles),
+        COMPILATIONS(R.string.lbl_compilations),
+        SOUNDTRACKS(R.string.lbl_compilations),
+        MIXES(R.string.lbl_mixes),
+        MIXTAPES(R.string.lbl_mixtapes),
+        LIVE(R.string.lbl_live_group),
+        REMIXES(R.string.lbl_remix_group),
+    }
 }
 
 data class SortHeader(@StringRes val string: Int) : Item

app/src/main/java/org/oxycblt/auxio/music/Music.kt

@@ -771,12 +771,13 @@ sealed class ReleaseType {
                 }
     }
 
-    object Compilation : ReleaseType() {
+    data class Compilation(override val refinement: Refinement?) : ReleaseType() {
-        override val refinement: Refinement?
-            get() = null
-
         override val stringRes: Int
-            get() = R.string.lbl_compilation
+            get() = when (refinement) {
+                null -> R.string.lbl_compilation
+                Refinement.LIVE -> R.string.lbl_compilation_live
+                Refinement.REMIX -> R.string.lbl_compilation_remix
+            }
     }
 
     object Soundtrack : ReleaseType() {
@@ -787,6 +788,14 @@ sealed class ReleaseType {
             get() = R.string.lbl_soundtrack
     }
 
+    object Mix : ReleaseType() {
+        override val refinement: Refinement?
+            get() = null
+
+        override val stringRes: Int
+            get() = R.string.lbl_mix
+    }
+
     object Mixtape : ReleaseType() {
         override val refinement: Refinement?
             get() = null
@@ -806,6 +815,9 @@ sealed class ReleaseType {
     }
 
     companion object {
+        // Note: The parsing code is extremely clever in order to reduce duplication. It's
+        // better just to read the specification behind release types than follow this code.
+
         fun parse(types: List<String>): ReleaseType {
             val primary = types[0]
 
@@ -823,22 +835,31 @@ sealed class ReleaseType {
 
         private inline fun List<String>.parseSecondaryTypes(
             secondaryIdx: Int,
-            target: (Refinement?) -> ReleaseType
+            convertRefinement: (Refinement?) -> ReleaseType
         ): ReleaseType {
-            val secondary = (getOrNull(secondaryIdx) ?: return target(null))
+            val secondary = getOrNull(secondaryIdx)
 
-            return when {
+            return if (secondary.equals("compilation", true)) {
-                // Compilation is the only weird secondary release type, as it could
+                // Secondary type is a compilation, actually parse the third type
-                // theoretically have additional modifiers including soundtrack, remix,
+                // and put that into a compilation if needed.
-                // live, dj-mix, etc. However, since there is no real demand for me to
+                parseSecondaryTypeImpl(getOrNull(secondaryIdx + 1)) { Compilation(it) }
-                // respond to those, I don't implement them simply for simplicity.
+            } else {
-                secondary.equals("compilation", true) -> Compilation
+                // Secondary type is a plain value, use the original values given.
-                secondary.equals("soundtrack", true) -> Soundtrack
+                parseSecondaryTypeImpl(secondary, convertRefinement)
-                secondary.equals("mixtape/street", true) -> Mixtape
-                secondary.equals("live", true) -> target(Refinement.LIVE)
-                secondary.equals("remix", true) -> target(Refinement.REMIX)
-                else -> target(null)
             }
         }
+
+        private inline fun parseSecondaryTypeImpl(
+            type: String?,
+            convertRefinement: (Refinement?) -> ReleaseType
+        ) = when {
+            // Parse all the types that have no children
+            type.equals("soundtrack", true) -> Soundtrack
+            type.equals("mixtape/street", true) -> Mixtape
+            type.equals("dj-mix", true) -> Mix
+            type.equals("live", true) -> convertRefinement(Refinement.LIVE)
+            type.equals("remix", true) -> convertRefinement(Refinement.REMIX)
+            else -> convertRefinement(null)
+        }
     }
 }

app/src/main/res/values/strings.xml

@@ -51,12 +51,19 @@
     <string name="lbl_compilations">Compilations</string>
     <!-- As in a compilation of music -->
     <string name="lbl_compilation">Compilation</string>
+    <!-- As in a compilation of live music -->
+    <string name="lbl_compilation_live">Live compilation</string>
+    <string name="lbl_compilation_remix">Remix compilations</string>
     <string name="lbl_soundtracks">Soundtracks</string>
     <string name="lbl_soundtrack">Soundtrack</string>
     <!-- As in the collection of music -->
     <string name="lbl_mixtapes">Mixtapes</string>
     <!-- As in the collection of music -->
     <string name="lbl_mixtape">Mixtape</string>
+    <!-- As in a compilation of several performances that blend into a single continuous flow of music -->
+    <string name="lbl_mixes">Mixes</string>
+    <!-- As in a compilation of several performances that blend into a single continuous flow of music -->
+    <string name="lbl_mix">Mix</string>
 
     <!-- As in music that was performed live -->
     <string name="lbl_live_group">Live</string>