): T {
162 | if (modelClass.isAssignableFrom(FavListMatchViewModel::class.java)) {
163 | @Suppress("UNCHECKED_CAST")
164 | return FavListMatchViewModel(repository) as T
165 | }
166 | throw IllegalArgumentException("Unknown ViewModel class")
167 | }
168 | }
169 |
--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
1 |
2 |
3 | 
4 | [](https://woodpecker.join-lemmy.org/dessalines/rank-my-favs)
5 | [](https://github.com/dessalines/rank-my-favs/issues)
6 | [](LICENSE)
7 | 
8 |
9 |
10 |
11 |
12 |
13 | 
14 |
15 |
16 |
17 |
18 | Rank your favorite things, using simple pair-wise matchups.
19 |
20 |
21 | Report Bug
22 | ·
23 | Request Feature
24 | ·
25 | Releases
26 |
27 |
28 | 
29 | 
30 | 
31 | 
32 |
33 |
34 |
35 | ## About Rank-My-Favs
36 |
37 |
38 |
39 | 
40 |
41 |
42 |
43 | Do you keep lists of your favorite things, such as movies, books, recipes, or music albums? You might keep list(s) that looks like this:
44 |
45 | - Network (1976)
46 | - Lone Star (1996)
47 | - Devils (1971)
48 | - The Seventh Seal (1957)
49 | - ... _Many more films_
50 |
51 | But how do you rank these?
52 |
53 | You might be tempted to order them by preference, but this could quickly get overwhelming for long lists.
54 |
55 | A much easier method is to use [pairwise comparisons](https://www.opinionx.co/blog/pairwise-comparison), which shows you single head-to-head pairs, and has you choose which one you like best.
56 |
57 | After doing a small number of these matchups, Rank-My-Favs can confidently create a ranked list for you.
58 |
59 | Under the hood, Rank-My-Favs uses the advanced [Glicko rating system](https://en.m.wikipedia.org/wiki/Glicko_rating_system), to determine how many matches are necessary, and for ranking.
60 |
61 | ### Features
62 |
63 | - Import your existing lists quickly.
64 | - Uses the advanced [Glicko rating system](https://en.m.wikipedia.org/wiki/Glicko_rating_system).
65 |
66 | ### Built With
67 |
68 | - [Android Jetpack Compose](https://developer.android.com/jetpack/compose)
69 |
70 | ## Installation / Releases
71 |
72 | - [Releases](https://github.com/dessalines/rank-my-favs/releases)
73 | - [IzzyOnDroid](https://apt.izzysoft.de/fdroid/index/apk/com.dessalines.rankmyfavs)
74 | - [F-Droid](https://f-droid.org/en/packages/com.dessalines.rankmyfavs/)
75 | - [Google Play](https://play.google.com/store/apps/details?id=com.dessalines.rankmyfavs)
76 |
77 | ## Support / Donate
78 |
79 | Rank-My-Favs will always remain free, open-source software. We've seen many open-source projects go unmaintained after a few years. **Recurring donations have proven to be the only way these projects can stay alive.**
80 |
81 | Your donations directly support full-time development, and help keep this maintained. If you find yourself using rank-my-favs every day, consider donating:
82 |
83 | - [Support me on Liberapay](https://liberapay.com/dessalines).
84 | - [Support me Patreon](https://www.patreon.com/dessalines).
85 |
86 | ### Crypto
87 |
88 | - bitcoin: `1Hefs7miXS5ff5Ck5xvmjKjXf5242KzRtK`
89 | - ethereum: `0x400c96c96acbC6E7B3B43B1dc1BB446540a88A01`
90 | - monero: `41taVyY6e1xApqKyMVDRVxJ76sPkfZhALLTjRvVKpaAh2pBd4wv9RgYj1tSPrx8wc6iE1uWUfjtQdTmTy2FGMeChGVKPQuV`
91 |
92 | ## Social / Contact
93 |
94 | - [lemmy.ml/c/rankmyfavs](https://lemmy.ml/c/rankmyfavs)
95 | - [Mastodon](https://mastodon.social/@dessalines)
96 | - [Matrix chat](https://matrix.to/#/#rank-my-favs:matrix.org)
97 |
98 | ## Resources
99 |
100 | - https://github.com/goochjs/glicko2
101 | - https://prioneer.io/tools/pairwise-ranking-tool
102 | - https://www.opinionx.co/research-method-guides/best-free-pairwise-ranking-tools
103 | - https://medium.com/@anton.myller/from-elo-to-trueskill-a-journey-in-the-world-of-ranking-systems-part-i-b186341d5ed0
104 | - [Build adaptive navigation](https://developer.android.com/develop/ui/compose/layouts/adaptive/build-adaptive-navigation)
105 | - [Adaptive list-detail sample](https://github.com/android/user-interface-samples/blob/main/CanonicalLayouts/list-detail-compose/app/src/main/java/com/example/listdetailcompose/ui/ListDetailSample.kt)
106 |
--------------------------------------------------------------------------------
/app/build.gradle.kts:
--------------------------------------------------------------------------------
1 | plugins {
2 | id("com.android.application")
3 | id("org.jetbrains.kotlin.android")
4 | id("org.jetbrains.kotlin.plugin.compose")
5 | id("com.google.devtools.ksp")
6 | }
7 |
8 | android {
9 | buildToolsVersion = "36.0.0"
10 | compileSdk = 36
11 |
12 | defaultConfig {
13 | applicationId = "com.dessalines.rankmyfavs"
14 | minSdk = 23
15 | targetSdk = 36
16 | versionCode = 40
17 | versionName = "0.6.17"
18 |
19 | testInstrumentationRunner = "androidx.test.runner.AndroidJUnitRunner"
20 | vectorDrawables {
21 | useSupportLibrary = true
22 | }
23 | ksp { arg("room.schemaLocation", "$projectDir/schemas") }
24 | }
25 |
26 | // Necessary for izzyondroid releases
27 | dependenciesInfo {
28 | // Disables dependency metadata when building APKs.
29 | includeInApk = false
30 | // Disables dependency metadata when building Android App Bundles.
31 | includeInBundle = false
32 | }
33 |
34 | if (project.hasProperty("RELEASE_STORE_FILE")) {
35 | signingConfigs {
36 | create("release") {
37 | storeFile = file(project.property("RELEASE_STORE_FILE")!!)
38 | storePassword = project.property("RELEASE_STORE_PASSWORD") as String?
39 | keyAlias = project.property("RELEASE_KEY_ALIAS") as String?
40 | keyPassword = project.property("RELEASE_KEY_PASSWORD") as String?
41 |
42 | // Optional, specify signing versions used
43 | enableV1Signing = true
44 | enableV2Signing = true
45 | }
46 | }
47 | }
48 | buildTypes {
49 | release {
50 | if (project.hasProperty("RELEASE_STORE_FILE")) {
51 | signingConfig = signingConfigs.getByName("release")
52 | }
53 |
54 | isMinifyEnabled = true
55 | isShrinkResources = true
56 | proguardFiles(
57 | // Includes the default ProGuard rules files that are packaged with
58 | // the Android Gradle plugin. To learn more, go to the section about
59 | // R8 configuration files.
60 | getDefaultProguardFile("proguard-android-optimize.txt"),
61 |
62 | // Includes a local, custom Proguard rules file
63 | "proguard-rules.pro"
64 | )
65 | }
66 | debug {
67 | applicationIdSuffix = ".debug"
68 | versionNameSuffix = " (DEBUG)"
69 | }
70 | }
71 |
72 | lint {
73 | disable += "MissingTranslation"
74 | disable += "KtxExtensionAvailable"
75 | disable += "UseKtx"
76 | }
77 |
78 | compileOptions {
79 | sourceCompatibility = JavaVersion.VERSION_17
80 | targetCompatibility = JavaVersion.VERSION_17
81 | }
82 | kotlinOptions {
83 | jvmTarget = "17"
84 | freeCompilerArgs = listOf("-Xjvm-default=all-compatibility", "-opt-in=kotlin.RequiresOptIn")
85 | }
86 | buildFeatures {
87 | compose = true
88 | }
89 | namespace = "com.dessalines.rankmyfavs"
90 | }
91 |
92 | dependencies {
93 | // Color picker
94 | implementation("com.github.skydoves:colorpicker-compose:1.1.3")
95 |
96 | // Exporting / importing DB helper
97 | implementation("com.github.dessalines:room-db-export-import:0.1.0")
98 |
99 | // Composable screenshot
100 | implementation("dev.shreyaspatil:capturable:3.0.1")
101 |
102 | // CSV exporting
103 | implementation("com.floern.castingcsv:casting-csv-kt:1.2")
104 |
105 | // Tables
106 | implementation("com.github.Breens-Mbaka:BeeTablesCompose:1.2.0")
107 |
108 | // Glicko2
109 | implementation("com.github.goochjs:glicko2:master")
110 |
111 | // Compose BOM
112 | implementation(platform("androidx.compose:compose-bom:2025.12.01"))
113 | implementation("androidx.compose.ui:ui")
114 | implementation("androidx.compose.material3:material3")
115 | implementation("androidx.compose.material:material-icons-extended:1.7.8")
116 | implementation("androidx.compose.material3:material3-window-size-class")
117 | implementation("androidx.compose.ui:ui-tooling")
118 | implementation("androidx.compose.runtime:runtime-livedata:1.10.0")
119 |
120 | // Adaptive layouts
121 | implementation("androidx.compose.material3.adaptive:adaptive:1.2.0")
122 | implementation("androidx.compose.material3.adaptive:adaptive-layout:1.2.0")
123 | implementation("androidx.compose.material3.adaptive:adaptive-navigation:1.2.0")
124 | implementation("androidx.compose.material3:material3-adaptive-navigation-suite")
125 |
126 | // Activities
127 | implementation("androidx.activity:activity-compose:1.12.2")
128 | implementation("androidx.activity:activity-ktx:1.12.2")
129 |
130 | // LiveData
131 | implementation("androidx.lifecycle:lifecycle-runtime-compose:2.10.0")
132 |
133 | // Navigation
134 | implementation("androidx.navigation:navigation-compose:2.9.6")
135 |
136 | // Markdown
137 | implementation("com.github.jeziellago:compose-markdown:0.5.8")
138 |
139 | // Preferences
140 | implementation("me.zhanghai.compose.preference:library:1.1.1")
141 |
142 | // Room
143 | // To use Kotlin annotation processing tool
144 | ksp("androidx.room:room-compiler:2.8.4")
145 | implementation("androidx.room:room-runtime:2.8.4")
146 | annotationProcessor("androidx.room:room-compiler:2.8.4")
147 |
148 | // optional - Kotlin Extensions and Coroutines support for Room
149 | implementation("androidx.room:room-ktx:2.8.4")
150 |
151 | // App compat
152 | implementation("androidx.appcompat:appcompat:1.7.1")
153 | }
154 |
--------------------------------------------------------------------------------
/app/src/main/java/com/dessalines/rankmyfavs/ui/components/favlist/ImportListScreen.kt:
--------------------------------------------------------------------------------
1 | package com.dessalines.rankmyfavs.ui.components.favlist
2 |
3 | import androidx.compose.foundation.BasicTooltipBox
4 | import androidx.compose.foundation.ExperimentalFoundationApi
5 | import androidx.compose.foundation.layout.Arrangement
6 | import androidx.compose.foundation.layout.Column
7 | import androidx.compose.foundation.layout.fillMaxWidth
8 | import androidx.compose.foundation.layout.imePadding
9 | import androidx.compose.foundation.layout.padding
10 | import androidx.compose.foundation.rememberBasicTooltipState
11 | import androidx.compose.foundation.rememberScrollState
12 | import androidx.compose.foundation.shape.CircleShape
13 | import androidx.compose.foundation.verticalScroll
14 | import androidx.compose.material.icons.Icons
15 | import androidx.compose.material.icons.outlined.Save
16 | import androidx.compose.material3.ExperimentalMaterial3Api
17 | import androidx.compose.material3.FloatingActionButton
18 | import androidx.compose.material3.Icon
19 | import androidx.compose.material3.OutlinedTextField
20 | import androidx.compose.material3.Scaffold
21 | import androidx.compose.material3.Text
22 | import androidx.compose.material3.TooltipAnchorPosition
23 | import androidx.compose.material3.TooltipDefaults
24 | import androidx.compose.material3.TopAppBar
25 | import androidx.compose.runtime.Composable
26 | import androidx.compose.runtime.getValue
27 | import androidx.compose.runtime.mutableStateOf
28 | import androidx.compose.runtime.saveable.rememberSaveable
29 | import androidx.compose.runtime.setValue
30 | import androidx.compose.ui.Modifier
31 | import androidx.compose.ui.res.stringResource
32 | import androidx.compose.ui.tooling.preview.Preview
33 | import androidx.navigation.NavController
34 | import com.dessalines.rankmyfavs.R
35 | import com.dessalines.rankmyfavs.db.FavListItemInsert
36 | import com.dessalines.rankmyfavs.db.FavListItemViewModel
37 | import com.dessalines.rankmyfavs.ui.components.common.BackButton
38 | import com.dessalines.rankmyfavs.ui.components.common.SMALL_PADDING
39 | import com.dessalines.rankmyfavs.ui.components.common.ToolTip
40 | import com.dessalines.rankmyfavs.ui.components.favlistitem.FavListItemForm
41 | import com.dessalines.rankmyfavs.utils.nameIsValid
42 |
43 | @OptIn(ExperimentalMaterial3Api::class, ExperimentalFoundationApi::class)
44 | @Composable
45 | fun ImportListScreen(
46 | navController: NavController,
47 | favListItemViewModel: FavListItemViewModel,
48 | favListId: Int,
49 | ) {
50 | val scrollState = rememberScrollState()
51 | val tooltipPosition = TooltipDefaults.rememberTooltipPositionProvider(TooltipAnchorPosition.Above)
52 |
53 | var listStr = ""
54 |
55 | Scaffold(
56 | topBar = {
57 | TopAppBar(
58 | title = { Text(stringResource(R.string.import_list)) },
59 | navigationIcon = {
60 | BackButton(
61 | onBackClick = { navController.navigateUp() },
62 | )
63 | },
64 | )
65 | },
66 | content = { padding ->
67 | Column(
68 | modifier =
69 | Modifier
70 | .padding(padding)
71 | .verticalScroll(scrollState)
72 | .imePadding(),
73 | ) {
74 | ImportListForm(
75 | onChange = { listStr = it },
76 | )
77 | }
78 | },
79 | floatingActionButton = {
80 | BasicTooltipBox(
81 | positionProvider = tooltipPosition,
82 | state = rememberBasicTooltipState(isPersistent = false),
83 | tooltip = {
84 | ToolTip(stringResource(R.string.save))
85 | },
86 | ) {
87 | FloatingActionButton(
88 | modifier = Modifier.imePadding(),
89 | onClick = {
90 | val listItems = extractLines(listStr)
91 | for (item in listItems) {
92 | val insert =
93 | FavListItemInsert(
94 | favListId = favListId,
95 | name = item.name,
96 | description = item.description,
97 | )
98 | favListItemViewModel.insert(insert)
99 | }
100 | navController.navigateUp()
101 | },
102 | shape = CircleShape,
103 | ) {
104 | Icon(
105 | imageVector = Icons.Outlined.Save,
106 | contentDescription = stringResource(R.string.save),
107 | )
108 | }
109 | }
110 | },
111 | )
112 | }
113 |
114 | data class FavListItemLine(
115 | val name: String,
116 | val description: String?,
117 | )
118 |
119 | /**
120 | * This is of the form: - option 1 name | option 1 description
121 | */
122 | private fun extractLines(listStr: String): List {
123 | val listItems =
124 | listStr
125 | .lines()
126 | .map { it.trim() }
127 | // Remove the preceding list items if necessary
128 | .map {
129 | // Remove the markdown list start
130 | val removedMarkdownListStart =
131 | if (it.startsWith("- ") || it.startsWith("* ")) {
132 | it.substring(2)
133 | } else {
134 | it
135 | }
136 |
137 | // Split it with |
138 | val split = removedMarkdownListStart.split("|")
139 | val name = split[0].trim()
140 | val description = split.getOrNull(1)?.trim()
141 | FavListItemLine(name, description)
142 | }.filter { nameIsValid(it.name) }
143 | return listItems
144 | }
145 |
146 | @Composable
147 | fun ImportListForm(onChange: (String) -> Unit) {
148 | var listStr by rememberSaveable {
149 | mutableStateOf("")
150 | }
151 |
152 | Column(
153 | modifier = Modifier.padding(horizontal = SMALL_PADDING),
154 | verticalArrangement = Arrangement.spacedBy(SMALL_PADDING),
155 | ) {
156 | OutlinedTextField(
157 | label = { Text(stringResource(R.string.import_list_description)) },
158 | minLines = 3,
159 | modifier = Modifier.fillMaxWidth(),
160 | value = listStr,
161 | onValueChange = {
162 | listStr = it
163 | onChange(listStr)
164 | },
165 | )
166 | }
167 | }
168 |
169 | @Composable
170 | @Preview
171 | fun FavListItemFormPreview() {
172 | FavListItemForm(onChange = {})
173 | }
174 |
--------------------------------------------------------------------------------
/app/src/main/java/com/dessalines/rankmyfavs/db/TierList.kt:
--------------------------------------------------------------------------------
1 | package com.dessalines.rankmyfavs.db
2 |
3 | import androidx.annotation.Keep
4 | import androidx.annotation.WorkerThread
5 | import androidx.lifecycle.ViewModel
6 | import androidx.lifecycle.ViewModelProvider
7 | import androidx.lifecycle.viewModelScope
8 | import androidx.room.ColumnInfo
9 | import androidx.room.Dao
10 | import androidx.room.Delete
11 | import androidx.room.Entity
12 | import androidx.room.ForeignKey
13 | import androidx.room.Index
14 | import androidx.room.Insert
15 | import androidx.room.OnConflictStrategy
16 | import androidx.room.PrimaryKey
17 | import androidx.room.Query
18 | import androidx.room.Update
19 | import kotlinx.coroutines.flow.Flow
20 | import kotlinx.coroutines.launch
21 |
22 | @Entity(
23 | foreignKeys = [
24 | ForeignKey(
25 | entity = FavList::class,
26 | parentColumns = arrayOf("id"),
27 | childColumns = arrayOf("fav_list_id"),
28 | onDelete = ForeignKey.CASCADE,
29 | ),
30 | ],
31 | indices = [
32 | Index(value = ["fav_list_id"], unique = false),
33 | // Uniqueness is hard to deal with when swapping tier orders so I kept it false
34 | Index(value = ["tier_order"], unique = false),
35 | ],
36 | )
37 | @Keep
38 | data class TierList(
39 | @PrimaryKey(autoGenerate = true) val id: Int,
40 | @ColumnInfo(
41 | name = "fav_list_id",
42 | )
43 | val favListId: Int,
44 | @ColumnInfo(
45 | name = "name",
46 | )
47 | val name: String,
48 | @ColumnInfo(
49 | name = "color",
50 | )
51 | val color: Int,
52 | @ColumnInfo(
53 | name = "tier_order",
54 | )
55 | val tierOrder: Int,
56 | )
57 |
58 | @Entity
59 | data class TierListInsert(
60 | @ColumnInfo(
61 | name = "fav_list_id",
62 | )
63 | val favListId: Int,
64 | @ColumnInfo(
65 | name = "name",
66 | )
67 | val name: String,
68 | @ColumnInfo(
69 | name = "color",
70 | )
71 | val color: Int,
72 | @ColumnInfo(
73 | name = "tier_order",
74 | )
75 | val tierOrder: Int,
76 | )
77 |
78 | @Entity
79 | data class TierListUpdate(
80 | val id: Int,
81 | @ColumnInfo(
82 | name = "fav_list_id",
83 | )
84 | val favListId: Int,
85 | @ColumnInfo(
86 | name = "name",
87 | )
88 | val name: String,
89 | @ColumnInfo(
90 | name = "color",
91 | )
92 | val color: Int,
93 | @ColumnInfo(
94 | name = "tier_order",
95 | )
96 | val tierOrder: Int,
97 | )
98 |
99 | @Dao
100 | interface TierListDao {
101 | @Query("SELECT * FROM TierList where fav_list_id = :favListId ORDER BY tier_order ASC")
102 | fun getFromList(favListId: Int): Flow>
103 |
104 | @Query("SELECT * FROM TierList where tier_order = :tierOrder")
105 | fun getByTierOrder(tierOrder: Int): TierList?
106 |
107 | @Query(
108 | """
109 | UPDATE TierList
110 | SET tier_order = CASE
111 | WHEN id = :tier1Id THEN :tier2Order
112 | WHEN id = :tier2Id THEN :tier1Order
113 | ELSE tier_order
114 | END
115 | WHERE id IN (:tier1Id, :tier2Id)
116 | """,
117 | )
118 | suspend fun swapTierOrders(
119 | tier1Id: Int,
120 | tier1Order: Int,
121 | tier2Id: Int,
122 | tier2Order: Int,
123 | )
124 |
125 | @Insert(entity = TierList::class, onConflict = OnConflictStrategy.IGNORE)
126 | fun insert(tierList: TierListInsert): Long
127 |
128 | @Update(entity = TierList::class)
129 | suspend fun update(tierList: TierListUpdate)
130 |
131 | @Delete
132 | suspend fun delete(tierList: TierList)
133 |
134 | @Query(
135 | """
136 | UPDATE TierList
137 | SET tier_order = tier_order - 1
138 | WHERE tier_order > :deletedTierOrder
139 | AND fav_list_id = :favListId
140 | """,
141 | )
142 | suspend fun decrementHigherTierOrders(
143 | deletedTierOrder: Int,
144 | favListId: Int,
145 | )
146 | }
147 |
148 | // Declares the DAO as a private property in the constructor. Pass in the DAO
149 | // instead of the whole database, because you only need access to the DAO
150 | class TierListRepository(
151 | private val tierListDao: TierListDao,
152 | ) {
153 | // Room executes all queries on a separate thread.
154 | // Observed Flow will notify the observer when the data has changed.
155 | fun getFromList(favListId: Int) = tierListDao.getFromList(favListId)
156 |
157 | fun getByTierOrder(tierOrder: Int) = tierListDao.getByTierOrder(tierOrder)
158 |
159 | @WorkerThread
160 | suspend fun swapTierOrders(
161 | tierList1: TierList,
162 | tierList2: TierList,
163 | ) = tierListDao.swapTierOrders(
164 | tierList1.id,
165 | tierList1.tierOrder,
166 | tierList2.id,
167 | tierList2.tierOrder,
168 | )
169 |
170 | fun insert(tierList: TierListInsert) = tierListDao.insert(tierList)
171 |
172 | @WorkerThread
173 | suspend fun update(tierList: TierListUpdate) = tierListDao.update(tierList)
174 |
175 | @WorkerThread
176 | suspend fun delete(tierList: TierList) = tierListDao.delete(tierList)
177 |
178 | @WorkerThread
179 | suspend fun decrementHigherTierOrders(
180 | deletedTierOrder: Int,
181 | favListId: Int,
182 | ) = tierListDao.decrementHigherTierOrders(deletedTierOrder, favListId)
183 | }
184 |
185 | class TierListViewModel(
186 | private val repository: TierListRepository,
187 | ) : ViewModel() {
188 | fun getFromList(favListId: Int) = repository.getFromList(favListId)
189 |
190 | fun getByTierOrder(tierOrder: Int) = repository.getByTierOrder(tierOrder)
191 |
192 | fun swapTierOrders(
193 | tierList: TierList,
194 | relativeTierOrder: Int,
195 | ) = viewModelScope.launch {
196 | getByTierOrder(tierList.tierOrder + relativeTierOrder)?.let {
197 | repository.swapTierOrders(tierList, it)
198 | }
199 | }
200 |
201 | fun insert(tierList: TierListInsert) = repository.insert(tierList)
202 |
203 | fun update(tierList: TierListUpdate) =
204 | viewModelScope.launch {
205 | repository.update(tierList)
206 | }
207 |
208 | fun delete(tierList: TierList) =
209 | viewModelScope.launch {
210 | repository.delete(tierList)
211 | repository.decrementHigherTierOrders(tierList.tierOrder, tierList.favListId)
212 | }
213 | }
214 |
215 | class TierListViewModelFactory(
216 | private val repository: TierListRepository,
217 | ) : ViewModelProvider.Factory {
218 | override fun create(modelClass: Class): T {
219 | if (modelClass.isAssignableFrom(TierListViewModel::class.java)) {
220 | @Suppress("UNCHECKED_CAST")
221 | return TierListViewModel(repository) as T
222 | }
223 | throw IllegalArgumentException("Unknown ViewModel class")
224 | }
225 | }
226 |
--------------------------------------------------------------------------------
/app/src/main/java/com/dessalines/rankmyfavs/ui/components/favlist/favlistanddetails/FavListsPane.kt:
--------------------------------------------------------------------------------
1 | package com.dessalines.rankmyfavs.ui.components.favlist.favlistanddetails
2 |
3 | import androidx.compose.foundation.BasicTooltipBox
4 | import androidx.compose.foundation.ExperimentalFoundationApi
5 | import androidx.compose.foundation.clickable
6 | import androidx.compose.foundation.layout.Box
7 | import androidx.compose.foundation.layout.imePadding
8 | import androidx.compose.foundation.layout.padding
9 | import androidx.compose.foundation.lazy.LazyColumn
10 | import androidx.compose.foundation.lazy.LazyListState
11 | import androidx.compose.foundation.lazy.items
12 | import androidx.compose.foundation.rememberBasicTooltipState
13 | import androidx.compose.foundation.shape.CircleShape
14 | import androidx.compose.material.icons.Icons
15 | import androidx.compose.material.icons.filled.Settings
16 | import androidx.compose.material.icons.outlined.Add
17 | import androidx.compose.material3.CenterAlignedTopAppBar
18 | import androidx.compose.material3.ExperimentalMaterial3Api
19 | import androidx.compose.material3.FloatingActionButton
20 | import androidx.compose.material3.Icon
21 | import androidx.compose.material3.IconButton
22 | import androidx.compose.material3.ListItem
23 | import androidx.compose.material3.ListItemDefaults
24 | import androidx.compose.material3.MaterialTheme
25 | import androidx.compose.material3.Scaffold
26 | import androidx.compose.material3.Text
27 | import androidx.compose.material3.TooltipAnchorPosition
28 | import androidx.compose.material3.TooltipDefaults
29 | import androidx.compose.material3.TopAppBarScrollBehavior
30 | import androidx.compose.runtime.Composable
31 | import androidx.compose.ui.Modifier
32 | import androidx.compose.ui.input.nestedscroll.nestedScroll
33 | import androidx.compose.ui.res.stringResource
34 | import androidx.compose.ui.tooling.preview.Preview
35 | import com.dessalines.rankmyfavs.R
36 | import com.dessalines.rankmyfavs.db.FavList
37 | import com.dessalines.rankmyfavs.ui.components.common.LARGE_PADDING
38 | import com.dessalines.rankmyfavs.ui.components.common.ToolTip
39 | import com.dessalines.rankmyfavs.utils.SelectionVisibilityState
40 | import kotlin.collections.orEmpty
41 |
42 | @OptIn(ExperimentalMaterial3Api::class, ExperimentalFoundationApi::class)
43 | @Composable
44 | fun FavListsPane(
45 | favLists: List?,
46 | listState: LazyListState,
47 | scrollBehavior: TopAppBarScrollBehavior,
48 | onFavListClick: (favListId: Int) -> Unit,
49 | selectionState: SelectionVisibilityState,
50 | isListAndDetailVisible: Boolean,
51 | onCreateFavlistClick: () -> Unit,
52 | onSettingsClick: () -> Unit,
53 | ) {
54 | val tooltipPosition = TooltipDefaults.rememberTooltipPositionProvider(TooltipAnchorPosition.Above)
55 | val title =
56 | if (!isListAndDetailVisible) stringResource(R.string.app_name) else stringResource(R.string.lists)
57 |
58 | Scaffold(
59 | topBar = {
60 | CenterAlignedTopAppBar(
61 | title = { Text(title) },
62 | scrollBehavior = scrollBehavior,
63 | navigationIcon = {
64 | BasicTooltipBox(
65 | positionProvider = tooltipPosition,
66 | state = rememberBasicTooltipState(isPersistent = false),
67 | tooltip = {
68 | ToolTip(stringResource(R.string.settings))
69 | },
70 | ) {
71 | IconButton(
72 | onClick = onSettingsClick,
73 | ) {
74 | Icon(
75 | Icons.Filled.Settings,
76 | contentDescription = stringResource(R.string.settings),
77 | )
78 | }
79 | }
80 | },
81 | )
82 | },
83 | modifier = Modifier.Companion.nestedScroll(scrollBehavior.nestedScrollConnection),
84 | content = { padding ->
85 | Box(
86 | modifier =
87 | Modifier.Companion
88 | .padding(padding)
89 | .imePadding(),
90 | ) {
91 | LazyColumn(
92 | state = listState,
93 | ) {
94 | items(favLists.orEmpty()) { favList ->
95 | val selected =
96 | when (selectionState) {
97 | is SelectionVisibilityState.ShowSelection -> selectionState.selectedItem == favList.id
98 | else -> false
99 | }
100 |
101 | FavListRow(
102 | favList = favList,
103 | onClick = { onFavListClick(favList.id) },
104 | selected = selected,
105 | )
106 | }
107 | item {
108 | if (favLists.isNullOrEmpty()) {
109 | Text(
110 | text = stringResource(R.string.no_lists),
111 | modifier = Modifier.Companion.padding(horizontal = LARGE_PADDING),
112 | )
113 | }
114 | }
115 | }
116 | }
117 | },
118 | floatingActionButton = {
119 | BasicTooltipBox(
120 | positionProvider = tooltipPosition,
121 | state = rememberBasicTooltipState(isPersistent = false),
122 | tooltip = {
123 | ToolTip(stringResource(R.string.create_list))
124 | },
125 | ) {
126 | FloatingActionButton(
127 | modifier = Modifier.Companion.imePadding(),
128 | onClick = onCreateFavlistClick,
129 | shape = CircleShape,
130 | ) {
131 | Icon(
132 | imageVector = Icons.Outlined.Add,
133 | contentDescription = stringResource(R.string.create_list),
134 | )
135 | }
136 | }
137 | },
138 | )
139 | }
140 |
141 | @Composable
142 | fun FavListRow(
143 | favList: FavList,
144 | selected: Boolean = false,
145 | onClick: () -> Unit,
146 | ) {
147 | val containerColor =
148 | if (!selected) MaterialTheme.colorScheme.surface else MaterialTheme.colorScheme.surfaceVariant
149 |
150 | ListItem(
151 | headlineContent = {
152 | Text(favList.name)
153 | },
154 | colors = ListItemDefaults.colors(containerColor = containerColor),
155 | modifier =
156 | Modifier.Companion.clickable {
157 | onClick()
158 | },
159 | )
160 | }
161 |
162 | @Composable
163 | @Preview
164 | fun FavListRowPreview() {
165 | FavListRow(
166 | favList = FavList(id = 1, name = "Fav List 1"),
167 | onClick = {},
168 | )
169 | }
170 |
--------------------------------------------------------------------------------
/app/src/main/java/com/dessalines/rankmyfavs/ui/components/about/AboutScreen.kt:
--------------------------------------------------------------------------------
1 | package com.dessalines.rankmyfavs.ui.components.about
2 |
3 | import android.util.Log
4 | import androidx.compose.foundation.layout.Column
5 | import androidx.compose.foundation.layout.padding
6 | import androidx.compose.foundation.layout.size
7 | import androidx.compose.foundation.rememberScrollState
8 | import androidx.compose.foundation.verticalScroll
9 | import androidx.compose.material.icons.Icons
10 | import androidx.compose.material.icons.automirrored.outlined.Chat
11 | import androidx.compose.material.icons.outlined.AttachMoney
12 | import androidx.compose.material.icons.outlined.BugReport
13 | import androidx.compose.material.icons.outlined.Code
14 | import androidx.compose.material.icons.outlined.NewReleases
15 | import androidx.compose.material.icons.outlined.TravelExplore
16 | import androidx.compose.material3.ExperimentalMaterial3Api
17 | import androidx.compose.material3.HorizontalDivider
18 | import androidx.compose.material3.Icon
19 | import androidx.compose.material3.Scaffold
20 | import androidx.compose.material3.Text
21 | import androidx.compose.material3.TopAppBar
22 | import androidx.compose.runtime.Composable
23 | import androidx.compose.ui.Modifier
24 | import androidx.compose.ui.platform.LocalContext
25 | import androidx.compose.ui.res.painterResource
26 | import androidx.compose.ui.res.stringResource
27 | import androidx.compose.ui.tooling.preview.Preview
28 | import androidx.compose.ui.unit.dp
29 | import androidx.navigation.NavController
30 | import androidx.navigation.compose.rememberNavController
31 | import com.dessalines.rankmyfavs.R
32 | import com.dessalines.rankmyfavs.ui.components.common.BackButton
33 | import com.dessalines.rankmyfavs.utils.DONATE_URL
34 | import com.dessalines.rankmyfavs.utils.GITHUB_URL
35 | import com.dessalines.rankmyfavs.utils.LEMMY_URL
36 | import com.dessalines.rankmyfavs.utils.MASTODON_URL
37 | import com.dessalines.rankmyfavs.utils.MATRIX_CHAT_URL
38 | import com.dessalines.rankmyfavs.utils.TAG
39 | import com.dessalines.rankmyfavs.utils.openLink
40 | import me.zhanghai.compose.preference.Preference
41 | import me.zhanghai.compose.preference.PreferenceCategory
42 | import me.zhanghai.compose.preference.ProvidePreferenceTheme
43 |
44 | @OptIn(ExperimentalMaterial3Api::class)
45 | @Composable
46 | fun AboutScreen(navController: NavController) {
47 | Log.d(TAG, "Got to About activity")
48 |
49 | val ctx = LocalContext.current
50 |
51 | val version = ctx.packageManager.getPackageInfo(ctx.packageName, 0).versionName ?: "1"
52 | val scrollState = rememberScrollState()
53 |
54 | Scaffold(
55 | topBar = {
56 | TopAppBar(
57 | title = { Text(stringResource(R.string.about)) },
58 | navigationIcon = {
59 | BackButton(
60 | onBackClick = { navController.navigateUp() },
61 | )
62 | },
63 | )
64 | },
65 | content = { padding ->
66 | Column(
67 | modifier =
68 | Modifier
69 | .padding(padding)
70 | .verticalScroll(scrollState),
71 | ) {
72 | ProvidePreferenceTheme {
73 | Preference(
74 | title = { Text(stringResource(R.string.whats_new)) },
75 | summary = { Text(stringResource(R.string.version, version)) },
76 | icon = {
77 | Icon(
78 | imageVector = Icons.Outlined.NewReleases,
79 | contentDescription = stringResource(R.string.releases),
80 | )
81 | },
82 | onClick = {
83 | openLink("$GITHUB_URL/blob/main/RELEASES.md", ctx)
84 | },
85 | )
86 | SettingsDivider()
87 | PreferenceCategory(
88 | title = { Text(stringResource(R.string.support)) },
89 | )
90 | Preference(
91 | title = { Text(stringResource(R.string.issue_tracker)) },
92 | icon = {
93 | Icon(
94 | imageVector = Icons.Outlined.BugReport,
95 | contentDescription = stringResource(R.string.issue_tracker),
96 | )
97 | },
98 | onClick = {
99 | openLink("$GITHUB_URL/issues", ctx)
100 | },
101 | )
102 | Preference(
103 | title = { Text(stringResource(R.string.developer_matrix_chatroom)) },
104 | icon = {
105 | Icon(
106 | imageVector = Icons.AutoMirrored.Outlined.Chat,
107 | contentDescription = stringResource(R.string.developer_matrix_chatroom),
108 | )
109 | },
110 | onClick = {
111 | openLink(MATRIX_CHAT_URL, ctx)
112 | },
113 | )
114 |
115 | Preference(
116 | title = { Text(stringResource(R.string.donate_to_rank_my_favs)) },
117 | icon = {
118 | Icon(
119 | imageVector = Icons.Outlined.AttachMoney,
120 | contentDescription = stringResource(R.string.donate_to_rank_my_favs),
121 | )
122 | },
123 | onClick = {
124 | openLink(DONATE_URL, ctx)
125 | },
126 | )
127 | SettingsDivider()
128 | PreferenceCategory(
129 | title = { Text(stringResource(R.string.social)) },
130 | )
131 | Preference(
132 | title = { Text(stringResource(R.string.join_c_rankmyfavs)) },
133 | icon = {
134 | Icon(
135 | painter = painterResource(id = R.drawable.app_icon),
136 | modifier = Modifier.size(32.dp),
137 | contentDescription = stringResource(R.string.join_c_rankmyfavs),
138 | )
139 | },
140 | onClick = {
141 | openLink(LEMMY_URL, ctx)
142 | },
143 | )
144 | Preference(
145 | title = { Text(stringResource(R.string.follow_me_mastodon)) },
146 | icon = {
147 | Icon(
148 | imageVector = Icons.Outlined.TravelExplore,
149 | contentDescription = stringResource(R.string.follow_me_mastodon),
150 | )
151 | },
152 | onClick = {
153 | openLink(MASTODON_URL, ctx)
154 | },
155 | )
156 | SettingsDivider()
157 | PreferenceCategory(
158 | title = { Text(stringResource(R.string.open_source)) },
159 | )
160 | Preference(
161 | title = { Text(stringResource(R.string.source_code)) },
162 | summary = {
163 | Text(stringResource(R.string.source_code_subtitle))
164 | },
165 | icon = {
166 | Icon(
167 | imageVector = Icons.Outlined.Code,
168 | contentDescription = stringResource(R.string.source_code),
169 | )
170 | },
171 | onClick = {
172 | openLink(GITHUB_URL, ctx)
173 | },
174 | )
175 | }
176 | }
177 | },
178 | )
179 | }
180 |
181 | @Composable
182 | fun SettingsDivider() {
183 | HorizontalDivider(modifier = Modifier.padding(vertical = 10.dp))
184 | }
185 |
186 | @Preview
187 | @Composable
188 | fun AboutPreview() {
189 | AboutScreen(navController = rememberNavController())
190 | }
191 |
--------------------------------------------------------------------------------
/app/src/main/java/com/dessalines/rankmyfavs/ui/components/common/Dialogs.kt:
--------------------------------------------------------------------------------
1 | package com.dessalines.rankmyfavs.ui.components.common
2 |
3 | import androidx.compose.foundation.layout.Column
4 | import androidx.compose.foundation.layout.Spacer
5 | import androidx.compose.foundation.layout.fillMaxSize
6 | import androidx.compose.foundation.layout.fillMaxWidth
7 | import androidx.compose.foundation.layout.height
8 | import androidx.compose.foundation.layout.padding
9 | import androidx.compose.foundation.rememberScrollState
10 | import androidx.compose.foundation.shape.RoundedCornerShape
11 | import androidx.compose.foundation.verticalScroll
12 | import androidx.compose.material.icons.Icons
13 | import androidx.compose.material.icons.outlined.Info
14 | import androidx.compose.material3.AlertDialog
15 | import androidx.compose.material3.Button
16 | import androidx.compose.material3.ElevatedCard
17 | import androidx.compose.material3.Icon
18 | import androidx.compose.material3.MaterialTheme
19 | import androidx.compose.material3.Surface
20 | import androidx.compose.material3.Text
21 | import androidx.compose.material3.TextButton
22 | import androidx.compose.runtime.Composable
23 | import androidx.compose.runtime.LaunchedEffect
24 | import androidx.compose.runtime.MutableState
25 | import androidx.compose.runtime.collectAsState
26 | import androidx.compose.runtime.getValue
27 | import androidx.compose.runtime.livedata.observeAsState
28 | import androidx.compose.runtime.mutableStateOf
29 | import androidx.compose.runtime.remember
30 | import androidx.compose.runtime.setValue
31 | import androidx.compose.ui.Alignment
32 | import androidx.compose.ui.ExperimentalComposeUiApi
33 | import androidx.compose.ui.Modifier
34 | import androidx.compose.ui.graphics.Color
35 | import androidx.compose.ui.platform.LocalContext
36 | import androidx.compose.ui.res.stringResource
37 | import androidx.compose.ui.semantics.semantics
38 | import androidx.compose.ui.semantics.testTagsAsResourceId
39 | import androidx.compose.ui.tooling.preview.Preview
40 | import androidx.compose.ui.unit.dp
41 | import androidx.compose.ui.window.Dialog
42 | import androidx.lifecycle.asLiveData
43 | import com.dessalines.rankmyfavs.R
44 | import com.dessalines.rankmyfavs.db.AppSettingsViewModel
45 | import com.dessalines.rankmyfavs.utils.getVersionCode
46 | import com.github.skydoves.colorpicker.compose.ColorPickerController
47 | import com.github.skydoves.colorpicker.compose.HsvColorPicker
48 | import dev.jeziellago.compose.markdowntext.MarkdownText
49 |
50 | val DONATION_MARKDOWN =
51 | """
52 | ### Support Rank-My-Favs
53 | [Rank-My-Favs](https://github.com/dessalines/rank-my-favs) is free, open-source software, meaning no spying, keylogging, or advertising, ever.
54 |
55 | No one likes recurring donations, but they've proven to be the only way open-source software like Rank-My-Favs can stay alive. If you find yourself using Rank-My-Favs every day, please consider donating:
56 | - [Support on Liberapay](https://liberapay.com/dessalines).
57 | - [Support on Patreon](https://www.patreon.com/dessalines).
58 | ---
59 |
60 | """.trimIndent()
61 |
62 | @OptIn(ExperimentalComposeUiApi::class)
63 | @Composable
64 | fun ShowChangelog(appSettingsViewModel: AppSettingsViewModel) {
65 | val ctx = LocalContext.current
66 | val lastVersionCodeViewed =
67 | appSettingsViewModel.appSettings
68 | .asLiveData()
69 | .observeAsState()
70 | .value
71 | ?.lastVersionCodeViewed
72 |
73 | // Make sure its initialized
74 | lastVersionCodeViewed?.also { lastViewed ->
75 | val currentVersionCode = ctx.getVersionCode()
76 | val viewed = lastViewed == currentVersionCode
77 |
78 | var whatsChangedDialogOpen by remember { mutableStateOf(!viewed) }
79 |
80 | if (whatsChangedDialogOpen) {
81 | val scrollState = rememberScrollState()
82 | val markdown by appSettingsViewModel.changelog.collectAsState()
83 | LaunchedEffect(appSettingsViewModel) {
84 | appSettingsViewModel.updateChangelog(ctx)
85 | }
86 |
87 | AlertDialog(
88 | text = {
89 | Column(
90 | modifier =
91 | Modifier
92 | .fillMaxSize()
93 | .verticalScroll(scrollState),
94 | ) {
95 | val markdownText = DONATION_MARKDOWN + markdown
96 | MarkdownText(
97 | markdown = markdownText,
98 | linkColor = MaterialTheme.colorScheme.primary,
99 | )
100 | }
101 | },
102 | confirmButton = {
103 | Button(
104 | onClick = {
105 | whatsChangedDialogOpen = false
106 | appSettingsViewModel.updateLastVersionCodeViewed(currentVersionCode)
107 | },
108 | modifier = Modifier.fillMaxWidth(),
109 | ) {
110 | Text(stringResource(R.string.done))
111 | }
112 | },
113 | onDismissRequest = {
114 | whatsChangedDialogOpen = false
115 | appSettingsViewModel.updateLastVersionCodeViewed(currentVersionCode)
116 | },
117 | modifier = Modifier.semantics { testTagsAsResourceId = true },
118 | )
119 | }
120 | }
121 | }
122 |
123 | @Composable
124 | fun ToolTip(text: String) {
125 | ElevatedCard {
126 | Text(
127 | text = text,
128 | modifier = Modifier.padding(SMALL_PADDING),
129 | )
130 | }
131 | }
132 |
133 | @Composable
134 | fun AreYouSureDialog(
135 | show: MutableState,
136 | title: String,
137 | onYes: () -> Unit,
138 | ) {
139 | if (show.value) {
140 | AlertDialog(
141 | title = { Text(title) },
142 | text = { Text(stringResource(R.string.are_you_sure)) },
143 | icon = {
144 | Icon(
145 | imageVector = Icons.Outlined.Info,
146 | contentDescription = stringResource(R.string.are_you_sure),
147 | )
148 | },
149 | confirmButton = {
150 | TextButton(
151 | onClick = {
152 | onYes()
153 | show.value = false
154 | },
155 | ) {
156 | Text(
157 | stringResource(R.string.yes),
158 | )
159 | }
160 | },
161 | onDismissRequest = {
162 | show.value = false
163 | },
164 | dismissButton = {
165 | TextButton(
166 | onClick = { show.value = false },
167 | ) {
168 | Text(stringResource(R.string.cancel))
169 | }
170 | },
171 | )
172 | }
173 | }
174 |
175 | @Preview
176 | @Composable
177 | fun PreviewAreYouSureDialog() {
178 | val show = remember { mutableStateOf(true) }
179 | AreYouSureDialog(
180 | show = show,
181 | title = "Test title",
182 | onYes = {},
183 | )
184 | }
185 |
186 | @Composable
187 | fun ColorPickerDialog(
188 | onColorSelected: (Color) -> Unit,
189 | onDismissRequest: () -> Unit,
190 | controller: ColorPickerController,
191 | ) {
192 | Dialog(onDismissRequest = onDismissRequest) {
193 | Surface(
194 | shape = RoundedCornerShape(MEDIUM_PADDING),
195 | color = MaterialTheme.colorScheme.surface,
196 | modifier = Modifier.padding(LARGE_PADDING),
197 | ) {
198 | Column(
199 | modifier = Modifier.padding(LARGE_PADDING),
200 | horizontalAlignment = Alignment.CenterHorizontally,
201 | ) {
202 | Text(
203 | text = stringResource(R.string.pick_a_color),
204 | style = MaterialTheme.typography.headlineSmall,
205 | )
206 | Spacer(modifier = Modifier.height(LARGE_PADDING))
207 | HsvColorPicker(
208 | modifier =
209 | Modifier
210 | .fillMaxWidth()
211 | .height(250.dp),
212 | onColorChanged = { colorEnvelope ->
213 | onColorSelected(colorEnvelope.color)
214 | },
215 | controller = controller,
216 | )
217 | Spacer(modifier = Modifier.height(LARGE_PADDING))
218 | Button(onClick = onDismissRequest) {
219 | Text("Done")
220 | }
221 | }
222 | }
223 | }
224 | }
225 |
--------------------------------------------------------------------------------
/app/src/main/java/com/dessalines/rankmyfavs/ui/components/favlist/favlistanddetails/FavListsAndDetailScreen.kt:
--------------------------------------------------------------------------------
1 | package com.dessalines.rankmyfavs.ui.components.favlist.favlistanddetails
2 |
3 | import android.annotation.SuppressLint
4 | import android.widget.Toast
5 | import androidx.activity.compose.BackHandler
6 | import androidx.compose.animation.AnimatedContent
7 | import androidx.compose.animation.ExperimentalSharedTransitionApi
8 | import androidx.compose.animation.SharedTransitionLayout
9 | import androidx.compose.foundation.ExperimentalFoundationApi
10 | import androidx.compose.foundation.lazy.rememberLazyListState
11 | import androidx.compose.material3.ExperimentalMaterial3Api
12 | import androidx.compose.material3.TopAppBarDefaults
13 | import androidx.compose.material3.adaptive.ExperimentalMaterial3AdaptiveApi
14 | import androidx.compose.material3.adaptive.layout.AnimatedPane
15 | import androidx.compose.material3.adaptive.layout.ListDetailPaneScaffold
16 | import androidx.compose.material3.adaptive.layout.ListDetailPaneScaffoldRole
17 | import androidx.compose.material3.adaptive.layout.PaneAdaptedValue
18 | import androidx.compose.material3.adaptive.navigation.rememberListDetailPaneScaffoldNavigator
19 | import androidx.compose.material3.rememberTopAppBarState
20 | import androidx.compose.runtime.Composable
21 | import androidx.compose.runtime.getValue
22 | import androidx.compose.runtime.livedata.observeAsState
23 | import androidx.compose.runtime.mutableStateOf
24 | import androidx.compose.runtime.rememberCoroutineScope
25 | import androidx.compose.runtime.saveable.rememberSaveable
26 | import androidx.compose.runtime.setValue
27 | import androidx.compose.ui.platform.LocalContext
28 | import androidx.compose.ui.res.stringResource
29 | import androidx.lifecycle.asLiveData
30 | import androidx.navigation.NavController
31 | import com.dessalines.rankmyfavs.R
32 | import com.dessalines.rankmyfavs.db.FavListItemViewModel
33 | import com.dessalines.rankmyfavs.db.FavListMatchViewModel
34 | import com.dessalines.rankmyfavs.db.FavListViewModel
35 | import com.dessalines.rankmyfavs.utils.SelectionVisibilityState
36 | import kotlinx.coroutines.launch
37 |
38 | @SuppressLint("UnusedContentLambdaTargetStateParameter")
39 | @OptIn(
40 | ExperimentalFoundationApi::class,
41 | ExperimentalMaterial3AdaptiveApi::class,
42 | ExperimentalSharedTransitionApi::class,
43 | ExperimentalMaterial3Api::class,
44 | )
45 | @Composable
46 | fun FavListsAndDetailScreen(
47 | navController: NavController,
48 | favListViewModel: FavListViewModel,
49 | favListItemViewModel: FavListItemViewModel,
50 | favListMatchViewModel: FavListMatchViewModel,
51 | favListId: Int?,
52 | ) {
53 | val scope = rememberCoroutineScope()
54 | val ctx = LocalContext.current
55 |
56 | var selectedFavListId: Int? by rememberSaveable { mutableStateOf(favListId) }
57 | val favLists by favListViewModel.getAll.asLiveData().observeAsState()
58 |
59 | val favListsPaneScrollBehavior = TopAppBarDefaults.enterAlwaysScrollBehavior(rememberTopAppBarState())
60 | val favListsPaneListState = rememberLazyListState()
61 | val favListDetailListState = rememberLazyListState()
62 | val navigator = rememberListDetailPaneScaffoldNavigator()
63 | val isListAndDetailVisible =
64 | navigator.scaffoldValue[ListDetailPaneScaffoldRole.Detail] == PaneAdaptedValue.Companion.Expanded &&
65 | navigator.scaffoldValue[ListDetailPaneScaffoldRole.List] == PaneAdaptedValue.Companion.Expanded
66 | val isDetailVisible =
67 | navigator.scaffoldValue[ListDetailPaneScaffoldRole.Detail] == PaneAdaptedValue.Companion.Expanded
68 |
69 | BackHandler(enabled = navigator.canNavigateBack()) {
70 | scope.launch {
71 | navigator.navigateBack()
72 | }
73 | }
74 |
75 | SharedTransitionLayout {
76 | AnimatedContent(targetState = isListAndDetailVisible, label = "simple sample") {
77 | ListDetailPaneScaffold(
78 | directive = navigator.scaffoldDirective,
79 | value = navigator.scaffoldValue,
80 | listPane = {
81 | val currentSelectedFavlistId = selectedFavListId
82 | val selectionState =
83 | if (isDetailVisible && currentSelectedFavlistId != null) {
84 | SelectionVisibilityState.ShowSelection(currentSelectedFavlistId)
85 | } else {
86 | SelectionVisibilityState.NoSelection
87 | }
88 |
89 | AnimatedPane {
90 | FavListsPane(
91 | favLists = favLists,
92 | listState = favListsPaneListState,
93 | scrollBehavior = favListsPaneScrollBehavior,
94 | onFavListClick = { favListId ->
95 | selectedFavListId = favListId
96 | scope.launch {
97 | navigator.navigateTo(ListDetailPaneScaffoldRole.Detail)
98 | }
99 | },
100 | selectionState = selectionState,
101 | isListAndDetailVisible = isListAndDetailVisible,
102 | onCreateFavlistClick = {
103 | navController.navigate("createFavList")
104 | },
105 | onSettingsClick = {
106 | navController.navigate("settings")
107 | },
108 | )
109 | }
110 | },
111 | detailPane = {
112 | AnimatedPane {
113 | selectedFavListId?.let { favListId ->
114 |
115 | val favList by favListViewModel.getById(favListId).asLiveData().observeAsState()
116 | val favListItems by favListItemViewModel.getFromList(favListId).asLiveData().observeAsState()
117 | val clearStatsMessage = stringResource(R.string.clear_stats)
118 | val deletedMessage = stringResource(R.string.list_deleted)
119 |
120 | FavListDetailPane(
121 | favList = favList,
122 | favListItems = favListItems,
123 | listState = favListDetailListState,
124 | isListAndDetailVisible = isListAndDetailVisible,
125 | onBackClick = {
126 | scope.launch {
127 | navigator.navigateBack()
128 | }
129 | },
130 | onClearStats = {
131 | favListItemViewModel.clearStatsForList(favListId = favListId)
132 | favListMatchViewModel.deleteMatchesForList(favListId = favListId)
133 | Toast
134 | .makeText(ctx, clearStatsMessage, Toast.LENGTH_SHORT)
135 | .show()
136 | },
137 | onDelete = {
138 | favList?.let {
139 | favListViewModel.delete(it)
140 | navController.navigateUp()
141 | Toast
142 | .makeText(ctx, deletedMessage, Toast.LENGTH_SHORT)
143 | .show()
144 | }
145 | },
146 | onCreateItemClick = {
147 | navController.navigate("createItem/$favListId")
148 | },
149 | onEditClick = {
150 | navController.navigate("editFavList/$favListId")
151 | },
152 | onImportListClick = {
153 | navController.navigate("importList/$favListId")
154 | },
155 | onTierListClick = {
156 | navController.navigate("tierList/$favListId")
157 | },
158 | onItemDetailsClick = {
159 | navController.navigate("itemDetails/$it")
160 | },
161 | onMatchClick = {
162 | navController.navigate("match?favListId=$favListId")
163 | },
164 | )
165 | }
166 | }
167 | },
168 | )
169 | }
170 | }
171 | }
172 |
--------------------------------------------------------------------------------
/gradlew:
--------------------------------------------------------------------------------
1 | #!/bin/sh
2 |
3 | #
4 | # Copyright © 2015 the original authors.
5 | #
6 | # Licensed under the Apache License, Version 2.0 (the "License");
7 | # you may not use this file except in compliance with the License.
8 | # You may obtain a copy of the License at
9 | #
10 | # https://www.apache.org/licenses/LICENSE-2.0
11 | #
12 | # Unless required by applicable law or agreed to in writing, software
13 | # distributed under the License is distributed on an "AS IS" BASIS,
14 | # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15 | # See the License for the specific language governing permissions and
16 | # limitations under the License.
17 | #
18 | # SPDX-License-Identifier: Apache-2.0
19 | #
20 |
21 | ##############################################################################
22 | #
23 | # Gradle start up script for POSIX generated by Gradle.
24 | #
25 | # Important for running:
26 | #
27 | # (1) You need a POSIX-compliant shell to run this script. If your /bin/sh is
28 | # noncompliant, but you have some other compliant shell such as ksh or
29 | # bash, then to run this script, type that shell name before the whole
30 | # command line, like:
31 | #
32 | # ksh Gradle
33 | #
34 | # Busybox and similar reduced shells will NOT work, because this script
35 | # requires all of these POSIX shell features:
36 | # * functions;
37 | # * expansions «$var», «${var}», «${var:-default}», «${var+SET}»,
38 | # «${var#prefix}», «${var%suffix}», and «$( cmd )»;
39 | # * compound commands having a testable exit status, especially «case»;
40 | # * various built-in commands including «command», «set», and «ulimit».
41 | #
42 | # Important for patching:
43 | #
44 | # (2) This script targets any POSIX shell, so it avoids extensions provided
45 | # by Bash, Ksh, etc; in particular arrays are avoided.
46 | #
47 | # The "traditional" practice of packing multiple parameters into a
48 | # space-separated string is a well documented source of bugs and security
49 | # problems, so this is (mostly) avoided, by progressively accumulating
50 | # options in "$@", and eventually passing that to Java.
51 | #
52 | # Where the inherited environment variables (DEFAULT_JVM_OPTS, JAVA_OPTS,
53 | # and GRADLE_OPTS) rely on word-splitting, this is performed explicitly;
54 | # see the in-line comments for details.
55 | #
56 | # There are tweaks for specific operating systems such as AIX, CygWin,
57 | # Darwin, MinGW, and NonStop.
58 | #
59 | # (3) This script is generated from the Groovy template
60 | # https://github.com/gradle/gradle/blob/HEAD/platforms/jvm/plugins-application/src/main/resources/org/gradle/api/internal/plugins/unixStartScript.txt
61 | # within the Gradle project.
62 | #
63 | # You can find Gradle at https://github.com/gradle/gradle/.
64 | #
65 | ##############################################################################
66 |
67 | # Attempt to set APP_HOME
68 |
69 | # Resolve links: $0 may be a link
70 | app_path=$0
71 |
72 | # Need this for daisy-chained symlinks.
73 | while
74 | APP_HOME=${app_path%"${app_path##*/}"} # leaves a trailing /; empty if no leading path
75 | [ -h "$app_path" ]
76 | do
77 | ls=$( ls -ld "$app_path" )
78 | link=${ls#*' -> '}
79 | case $link in #(
80 | /*) app_path=$link ;; #(
81 | *) app_path=$APP_HOME$link ;;
82 | esac
83 | done
84 |
85 | # This is normally unused
86 | # shellcheck disable=SC2034
87 | APP_BASE_NAME=${0##*/}
88 | # Discard cd standard output in case $CDPATH is set (https://github.com/gradle/gradle/issues/25036)
89 | APP_HOME=$( cd -P "${APP_HOME:-./}" > /dev/null && printf '%s\n' "$PWD" ) || exit
90 |
91 | # Use the maximum available, or set MAX_FD != -1 to use that value.
92 | MAX_FD=maximum
93 |
94 | warn () {
95 | echo "$*"
96 | } >&2
97 |
98 | die () {
99 | echo
100 | echo "$*"
101 | echo
102 | exit 1
103 | } >&2
104 |
105 | # OS specific support (must be 'true' or 'false').
106 | cygwin=false
107 | msys=false
108 | darwin=false
109 | nonstop=false
110 | case "$( uname )" in #(
111 | CYGWIN* ) cygwin=true ;; #(
112 | Darwin* ) darwin=true ;; #(
113 | MSYS* | MINGW* ) msys=true ;; #(
114 | NONSTOP* ) nonstop=true ;;
115 | esac
116 |
117 |
118 |
119 | # Determine the Java command to use to start the JVM.
120 | if [ -n "$JAVA_HOME" ] ; then
121 | if [ -x "$JAVA_HOME/jre/sh/java" ] ; then
122 | # IBM's JDK on AIX uses strange locations for the executables
123 | JAVACMD=$JAVA_HOME/jre/sh/java
124 | else
125 | JAVACMD=$JAVA_HOME/bin/java
126 | fi
127 | if [ ! -x "$JAVACMD" ] ; then
128 | die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME
129 |
130 | Please set the JAVA_HOME variable in your environment to match the
131 | location of your Java installation."
132 | fi
133 | else
134 | JAVACMD=java
135 | if ! command -v java >/dev/null 2>&1
136 | then
137 | die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH.
138 |
139 | Please set the JAVA_HOME variable in your environment to match the
140 | location of your Java installation."
141 | fi
142 | fi
143 |
144 | # Increase the maximum file descriptors if we can.
145 | if ! "$cygwin" && ! "$darwin" && ! "$nonstop" ; then
146 | case $MAX_FD in #(
147 | max*)
148 | # In POSIX sh, ulimit -H is undefined. That's why the result is checked to see if it worked.
149 | # shellcheck disable=SC2039,SC3045
150 | MAX_FD=$( ulimit -H -n ) ||
151 | warn "Could not query maximum file descriptor limit"
152 | esac
153 | case $MAX_FD in #(
154 | '' | soft) :;; #(
155 | *)
156 | # In POSIX sh, ulimit -n is undefined. That's why the result is checked to see if it worked.
157 | # shellcheck disable=SC2039,SC3045
158 | ulimit -n "$MAX_FD" ||
159 | warn "Could not set maximum file descriptor limit to $MAX_FD"
160 | esac
161 | fi
162 |
163 | # Collect all arguments for the java command, stacking in reverse order:
164 | # * args from the command line
165 | # * the main class name
166 | # * -classpath
167 | # * -D...appname settings
168 | # * --module-path (only if needed)
169 | # * DEFAULT_JVM_OPTS, JAVA_OPTS, and GRADLE_OPTS environment variables.
170 |
171 | # For Cygwin or MSYS, switch paths to Windows format before running java
172 | if "$cygwin" || "$msys" ; then
173 | APP_HOME=$( cygpath --path --mixed "$APP_HOME" )
174 |
175 | JAVACMD=$( cygpath --unix "$JAVACMD" )
176 |
177 | # Now convert the arguments - kludge to limit ourselves to /bin/sh
178 | for arg do
179 | if
180 | case $arg in #(
181 | -*) false ;; # don't mess with options #(
182 | /?*) t=${arg#/} t=/${t%%/*} # looks like a POSIX filepath
183 | [ -e "$t" ] ;; #(
184 | *) false ;;
185 | esac
186 | then
187 | arg=$( cygpath --path --ignore --mixed "$arg" )
188 | fi
189 | # Roll the args list around exactly as many times as the number of
190 | # args, so each arg winds up back in the position where it started, but
191 | # possibly modified.
192 | #
193 | # NB: a `for` loop captures its iteration list before it begins, so
194 | # changing the positional parameters here affects neither the number of
195 | # iterations, nor the values presented in `arg`.
196 | shift # remove old arg
197 | set -- "$@" "$arg" # push replacement arg
198 | done
199 | fi
200 |
201 |
202 | # Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script.
203 | DEFAULT_JVM_OPTS='"-Xmx64m" "-Xms64m"'
204 |
205 | # Collect all arguments for the java command:
206 | # * DEFAULT_JVM_OPTS, JAVA_OPTS, and optsEnvironmentVar are not allowed to contain shell fragments,
207 | # and any embedded shellness will be escaped.
208 | # * For example: A user cannot expect ${Hostname} to be expanded, as it is an environment variable and will be
209 | # treated as '${Hostname}' itself on the command line.
210 |
211 | set -- \
212 | "-Dorg.gradle.appname=$APP_BASE_NAME" \
213 | -jar "$APP_HOME/gradle/wrapper/gradle-wrapper.jar" \
214 | "$@"
215 |
216 | # Stop when "xargs" is not available.
217 | if ! command -v xargs >/dev/null 2>&1
218 | then
219 | die "xargs is not available"
220 | fi
221 |
222 | # Use "xargs" to parse quoted args.
223 | #
224 | # With -n1 it outputs one arg per line, with the quotes and backslashes removed.
225 | #
226 | # In Bash we could simply go:
227 | #
228 | # readarray ARGS < <( xargs -n1 <<<"$var" ) &&
229 | # set -- "${ARGS[@]}" "$@"
230 | #
231 | # but POSIX shell has neither arrays nor command substitution, so instead we
232 | # post-process each arg (as a line of input to sed) to backslash-escape any
233 | # character that might be a shell metacharacter, then use eval to reverse
234 | # that process (while maintaining the separation between arguments), and wrap
235 | # the whole thing up as a single "set" statement.
236 | #
237 | # This will of course break if any of these variables contains a newline or
238 | # an unmatched quote.
239 | #
240 |
241 | eval "set -- $(
242 | printf '%s\n' "$DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS" |
243 | xargs -n1 |
244 | sed ' s~[^-[:alnum:]+,./:=@_]~\\&~g; ' |
245 | tr '\n' ' '
246 | )" '"$@"'
247 |
248 | exec "$JAVACMD" "$@"
249 |
--------------------------------------------------------------------------------
/app/src/main/java/com/dessalines/rankmyfavs/db/FavListItem.kt:
--------------------------------------------------------------------------------
1 | package com.dessalines.rankmyfavs.db
2 |
3 | import androidx.annotation.Keep
4 | import androidx.annotation.WorkerThread
5 | import androidx.lifecycle.ViewModel
6 | import androidx.lifecycle.ViewModelProvider
7 | import androidx.lifecycle.viewModelScope
8 | import androidx.room.ColumnInfo
9 | import androidx.room.Dao
10 | import androidx.room.Delete
11 | import androidx.room.Entity
12 | import androidx.room.ForeignKey
13 | import androidx.room.Index
14 | import androidx.room.Insert
15 | import androidx.room.OnConflictStrategy
16 | import androidx.room.PrimaryKey
17 | import androidx.room.Query
18 | import androidx.room.Update
19 | import kotlinx.coroutines.flow.Flow
20 | import kotlinx.coroutines.launch
21 |
22 | const val DEFAULT_WIN_RATE = 0F
23 | const val DEFAULT_GLICKO_RATING = 1500F
24 | const val DEFAULT_GLICKO_DEVIATION = 350F
25 | const val DEFAULT_GLICKO_VOLATILITY = 0.06F
26 | const val DEFAULT_MATCH_COUNT = 0
27 |
28 | @Entity(
29 | foreignKeys = [
30 | ForeignKey(
31 | entity = FavList::class,
32 | parentColumns = arrayOf("id"),
33 | childColumns = arrayOf("fav_list_id"),
34 | onDelete = ForeignKey.CASCADE,
35 | ),
36 | ],
37 | indices = [Index(value = ["fav_list_id", "name"], unique = true)],
38 | )
39 | @Keep
40 | data class FavListItem(
41 | @PrimaryKey(autoGenerate = true) val id: Int,
42 | @ColumnInfo(
43 | name = "fav_list_id",
44 | )
45 | val favListId: Int,
46 | @ColumnInfo(
47 | name = "name",
48 | )
49 | val name: String,
50 | @ColumnInfo(
51 | name = "description",
52 | )
53 | val description: String? = null,
54 | @ColumnInfo(
55 | name = "win_rate",
56 | defaultValue = DEFAULT_WIN_RATE.toString(),
57 | )
58 | val winRate: Float,
59 | @ColumnInfo(
60 | name = "glicko_rating",
61 | defaultValue = DEFAULT_GLICKO_RATING.toString(),
62 | )
63 | val glickoRating: Float,
64 | @ColumnInfo(
65 | name = "glicko_deviation",
66 | defaultValue = DEFAULT_GLICKO_DEVIATION.toString(),
67 | )
68 | val glickoDeviation: Float,
69 | @ColumnInfo(
70 | name = "glicko_volatility",
71 | defaultValue = DEFAULT_GLICKO_VOLATILITY.toString(),
72 | )
73 | val glickoVolatility: Float,
74 | @ColumnInfo(
75 | name = "match_count",
76 | defaultValue = DEFAULT_MATCH_COUNT.toString(),
77 | )
78 | val matchCount: Int,
79 | )
80 |
81 | @Entity
82 | data class FavListItemInsert(
83 | @ColumnInfo(
84 | name = "fav_list_id",
85 | )
86 | val favListId: Int,
87 | @ColumnInfo(
88 | name = "name",
89 | )
90 | val name: String,
91 | @ColumnInfo(
92 | name = "description",
93 | )
94 | val description: String? = null,
95 | )
96 |
97 | @Entity
98 | data class FavListItemUpdateNameAndDesc(
99 | val id: Int,
100 | @ColumnInfo(
101 | name = "name",
102 | )
103 | val name: String,
104 | @ColumnInfo(
105 | name = "description",
106 | )
107 | val description: String?,
108 | )
109 |
110 | @Entity
111 | data class FavListItemUpdateStats(
112 | val id: Int,
113 | @ColumnInfo(
114 | name = "win_rate",
115 | defaultValue = DEFAULT_WIN_RATE.toString(),
116 | )
117 | val winRate: Float,
118 | @ColumnInfo(
119 | name = "glicko_rating",
120 | defaultValue = DEFAULT_GLICKO_RATING.toString(),
121 | )
122 | val glickoRating: Float,
123 | @ColumnInfo(
124 | name = "glicko_deviation",
125 | defaultValue = DEFAULT_GLICKO_DEVIATION.toString(),
126 | )
127 | val glickoDeviation: Float,
128 | @ColumnInfo(
129 | name = "glicko_volatility",
130 | defaultValue = DEFAULT_GLICKO_VOLATILITY.toString(),
131 | )
132 | val glickoVolatility: Float,
133 | @ColumnInfo(
134 | name = "match_count",
135 | defaultValue = DEFAULT_MATCH_COUNT.toString(),
136 | )
137 | val matchCount: Int,
138 | )
139 |
140 | private const val BY_ID_QUERY = "SELECT * FROM FavListItem where id = :favListItemId"
141 |
142 | @Dao
143 | interface FavListItemDao {
144 | @Query("SELECT * FROM FavListItem where fav_list_id = :favListId order by glicko_rating desc")
145 | fun getFromList(favListId: Int): Flow>
146 |
147 | @Query("SELECT COUNT(*) FROM FavListItem where fav_list_id = :favListId")
148 | fun getCountByIdSync(favListId: Int): Int
149 |
150 | @Query(BY_ID_QUERY)
151 | fun getById(favListItemId: Int): Flow
152 |
153 | @Query(BY_ID_QUERY)
154 | fun getByIdSync(favListItemId: Int): FavListItem?
155 |
156 | // The first option is the one with the lowest glicko_deviation, and a stop gap.
157 | // The second option is a random one.
158 |
159 | @Query(
160 | """
161 | SELECT * FROM FavListItem
162 | WHERE fav_list_id = :favListId
163 | AND glicko_deviation > (1500 * (1 - (SELECT min_confidence/100.0 from AppSettings)))
164 | ORDER BY RANDOM()
165 | LIMIT 1
166 | """,
167 | )
168 | fun leastTrained(favListId: Int): FavListItem?
169 |
170 | // Sort the second match by the closest neighbor, IE abs(difference)
171 | @Query(
172 | """
173 | SELECT * FROM FavListItem
174 | WHERE fav_list_id = :favListId
175 | AND id <> :firstItemId
176 | ORDER BY ABS(glicko_rating - :firstGlickoRating), RANDOM()
177 | LIMIT 1
178 | """,
179 | )
180 | fun closestMatch(
181 | favListId: Int,
182 | firstItemId: Int,
183 | firstGlickoRating: Float,
184 | ): FavListItem?
185 |
186 | @Query(
187 | """
188 | SELECT * FROM FavListItem
189 | WHERE fav_list_id = :favListId
190 | AND id <> :firstItemId
191 | ORDER BY RANDOM()
192 | LIMIT 1
193 | """,
194 | )
195 | fun randomMatch(
196 | favListId: Int,
197 | firstItemId: Int,
198 | ): FavListItem?
199 |
200 | @Insert(entity = FavListItem::class, onConflict = OnConflictStrategy.IGNORE)
201 | fun insert(favListItem: FavListItemInsert): Long
202 |
203 | @Update(entity = FavListItem::class)
204 | suspend fun updateNameAndDesc(favListItem: FavListItemUpdateNameAndDesc)
205 |
206 | @Update(entity = FavListItem::class)
207 | suspend fun updateStats(favListItem: FavListItemUpdateStats)
208 |
209 | @Query(
210 | """
211 | UPDATE FavListItem
212 | SET win_rate = $DEFAULT_WIN_RATE,
213 | glicko_rating = $DEFAULT_GLICKO_RATING,
214 | glicko_deviation = $DEFAULT_GLICKO_DEVIATION,
215 | glicko_volatility = $DEFAULT_GLICKO_VOLATILITY
216 | WHERE fav_list_id = :favListId
217 | """,
218 | )
219 | suspend fun clearStatsForList(favListId: Int)
220 |
221 | @Delete
222 | suspend fun delete(favListItem: FavListItem)
223 | }
224 |
225 | // Declares the DAO as a private property in the constructor. Pass in the DAO
226 | // instead of the whole database, because you only need access to the DAO
227 | class FavListItemRepository(
228 | private val favListItemDao: FavListItemDao,
229 | ) {
230 | // Room executes all queries on a separate thread.
231 | // Observed Flow will notify the observer when the data has changed.
232 | fun getFromList(favListId: Int) = favListItemDao.getFromList(favListId)
233 |
234 | fun getById(favListItemId: Int) = favListItemDao.getById(favListItemId)
235 |
236 | fun getByIdSync(favListItemId: Int) = favListItemDao.getByIdSync(favListItemId)
237 |
238 | fun leastTrained(favListId: Int) = favListItemDao.leastTrained(favListId)
239 |
240 | fun closestMatch(
241 | favListId: Int,
242 | firstItemId: Int,
243 | firstGlickoRating: Float,
244 | ) = favListItemDao.closestMatch(favListId, firstItemId, firstGlickoRating)
245 |
246 | fun randomMatch(
247 | favListId: Int,
248 | firstItemId: Int,
249 | ) = favListItemDao.randomMatch(favListId, firstItemId)
250 |
251 | fun insert(favListItem: FavListItemInsert) = favListItemDao.insert(favListItem)
252 |
253 | @WorkerThread
254 | suspend fun updateNameAndDesc(favListItem: FavListItemUpdateNameAndDesc) = favListItemDao.updateNameAndDesc(favListItem)
255 |
256 | @WorkerThread
257 | suspend fun updateStats(favListItem: FavListItemUpdateStats) = favListItemDao.updateStats(favListItem)
258 |
259 | @WorkerThread
260 | suspend fun clearStatsForList(favListId: Int) = favListItemDao.clearStatsForList(favListId)
261 |
262 | @WorkerThread
263 | suspend fun delete(favListItem: FavListItem) = favListItemDao.delete(favListItem)
264 | }
265 |
266 | class FavListItemViewModel(
267 | private val repository: FavListItemRepository,
268 | ) : ViewModel() {
269 | fun getFromList(favListId: Int) = repository.getFromList(favListId)
270 |
271 | fun getById(favListItemId: Int) = repository.getById(favListItemId)
272 |
273 | fun getByIdSync(favListItemId: Int) = repository.getByIdSync(favListItemId)
274 |
275 | fun leastTrained(favListId: Int) = repository.leastTrained(favListId)
276 |
277 | fun closestMatch(
278 | favListId: Int,
279 | firstItemId: Int,
280 | firstGlickoRating: Float,
281 | ) = repository.closestMatch(favListId, firstItemId, firstGlickoRating)
282 |
283 | fun randomMatch(
284 | favListId: Int,
285 | firstItemId: Int,
286 | ) = repository.randomMatch(favListId, firstItemId)
287 |
288 | fun insert(favListItem: FavListItemInsert) = repository.insert(favListItem)
289 |
290 | fun updateNameAndDesc(favListItem: FavListItemUpdateNameAndDesc) =
291 | viewModelScope.launch {
292 | repository.updateNameAndDesc(favListItem)
293 | }
294 |
295 | fun updateStats(favListItem: FavListItemUpdateStats) =
296 | viewModelScope.launch {
297 | repository.updateStats(favListItem)
298 | }
299 |
300 | fun clearStatsForList(favListId: Int) =
301 | viewModelScope.launch {
302 | repository.clearStatsForList(favListId)
303 | }
304 |
305 | fun delete(favListItem: FavListItem) =
306 | viewModelScope.launch {
307 | repository.delete(favListItem)
308 | }
309 | }
310 |
311 | class FavListItemViewModelFactory(
312 | private val repository: FavListItemRepository,
313 | ) : ViewModelProvider.Factory {
314 | override fun create(modelClass: Class): T {
315 | if (modelClass.isAssignableFrom(FavListItemViewModel::class.java)) {
316 | @Suppress("UNCHECKED_CAST")
317 | return FavListItemViewModel(repository) as T
318 | }
319 | throw IllegalArgumentException("Unknown ViewModel class")
320 | }
321 | }
322 |
323 | val sampleFavListItem =
324 | FavListItem(
325 | id = 1,
326 | favListId = 1,
327 | name = "Fav List 1",
328 | description = "ok",
329 | winRate = 66.5F,
330 | glickoRating = 1534F,
331 | glickoDeviation = 150F,
332 | glickoVolatility = 0.06F,
333 | matchCount = 5,
334 | )
335 |
--------------------------------------------------------------------------------
/app/src/main/java/com/dessalines/rankmyfavs/ui/components/settings/SettingsScreen.kt:
--------------------------------------------------------------------------------
1 | package com.dessalines.rankmyfavs.ui.components.settings
2 |
3 | import android.os.Build
4 | import android.widget.Toast
5 | import androidx.activity.compose.rememberLauncherForActivityResult
6 | import androidx.activity.result.contract.ActivityResultContracts
7 | import androidx.compose.foundation.layout.Column
8 | import androidx.compose.foundation.layout.imePadding
9 | import androidx.compose.foundation.layout.padding
10 | import androidx.compose.foundation.rememberScrollState
11 | import androidx.compose.foundation.verticalScroll
12 | import androidx.compose.material.icons.Icons
13 | import androidx.compose.material.icons.outlined.Colorize
14 | import androidx.compose.material.icons.outlined.DataThresholding
15 | import androidx.compose.material.icons.outlined.Info
16 | import androidx.compose.material.icons.outlined.Palette
17 | import androidx.compose.material.icons.outlined.Restore
18 | import androidx.compose.material.icons.outlined.Save
19 | import androidx.compose.material3.ExperimentalMaterial3Api
20 | import androidx.compose.material3.Icon
21 | import androidx.compose.material3.Scaffold
22 | import androidx.compose.material3.Text
23 | import androidx.compose.material3.TopAppBar
24 | import androidx.compose.runtime.Composable
25 | import androidx.compose.runtime.getValue
26 | import androidx.compose.runtime.livedata.observeAsState
27 | import androidx.compose.runtime.mutableFloatStateOf
28 | import androidx.compose.runtime.remember
29 | import androidx.compose.runtime.setValue
30 | import androidx.compose.ui.Modifier
31 | import androidx.compose.ui.platform.LocalContext
32 | import androidx.compose.ui.platform.LocalResources
33 | import androidx.compose.ui.res.stringResource
34 | import androidx.compose.ui.text.AnnotatedString
35 | import androidx.lifecycle.asLiveData
36 | import androidx.navigation.NavController
37 | import com.dessalines.rankmyfavs.R
38 | import com.dessalines.rankmyfavs.db.AppDB
39 | import com.dessalines.rankmyfavs.db.AppSettingsViewModel
40 | import com.dessalines.rankmyfavs.db.DEFAULT_MIN_CONFIDENCE
41 | import com.dessalines.rankmyfavs.db.DEFAULT_THEME
42 | import com.dessalines.rankmyfavs.db.DEFAULT_THEME_COLOR
43 | import com.dessalines.rankmyfavs.db.MIN_CONFIDENCE_BOUND
44 | import com.dessalines.rankmyfavs.db.SettingsUpdate
45 | import com.dessalines.rankmyfavs.ui.components.common.BackButton
46 | import com.dessalines.rankmyfavs.utils.ThemeColor
47 | import com.dessalines.rankmyfavs.utils.ThemeMode
48 | import com.roomdbexportimport.RoomDBExportImport
49 | import me.zhanghai.compose.preference.ListPreference
50 | import me.zhanghai.compose.preference.ListPreferenceType
51 | import me.zhanghai.compose.preference.Preference
52 | import me.zhanghai.compose.preference.ProvidePreferenceTheme
53 | import me.zhanghai.compose.preference.SliderPreference
54 |
55 | @OptIn(ExperimentalMaterial3Api::class)
56 | @Composable
57 | fun SettingsScreen(
58 | navController: NavController,
59 | appSettingsViewModel: AppSettingsViewModel,
60 | ) {
61 | val settings by appSettingsViewModel.appSettings.asLiveData().observeAsState()
62 | val ctx = LocalContext.current
63 | val resources = LocalResources.current
64 |
65 | var minConfidenceState = (settings?.minConfidence ?: DEFAULT_MIN_CONFIDENCE).toFloat()
66 | var minConfidenceSliderState by remember { mutableFloatStateOf(minConfidenceState) }
67 |
68 | var themeState = ThemeMode.entries[settings?.theme ?: DEFAULT_THEME]
69 | var themeColorState = ThemeColor.entries[settings?.themeColor ?: DEFAULT_THEME_COLOR]
70 |
71 | val dbSavedText = stringResource(R.string.database_backed_up)
72 | val dbRestoredText = stringResource(R.string.database_restored)
73 |
74 | val dbHelper = RoomDBExportImport(AppDB.getDatabase(ctx).openHelper)
75 |
76 | val exportDbLauncher =
77 | rememberLauncherForActivityResult(
78 | ActivityResultContracts.CreateDocument("application/zip"),
79 | ) {
80 | it?.also {
81 | if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.O) {
82 | dbHelper.export(ctx, it)
83 | Toast.makeText(ctx, dbSavedText, Toast.LENGTH_SHORT).show()
84 | }
85 | }
86 | }
87 |
88 | val importDbLauncher =
89 | rememberLauncherForActivityResult(
90 | ActivityResultContracts.OpenDocument(),
91 | ) {
92 | it?.also {
93 | if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.O) {
94 | dbHelper.import(ctx, it, true)
95 | Toast.makeText(ctx, dbRestoredText, Toast.LENGTH_SHORT).show()
96 | }
97 | }
98 | }
99 |
100 | fun updateSettings() {
101 | appSettingsViewModel.updateSettings(
102 | SettingsUpdate(
103 | id = 1,
104 | minConfidence = minConfidenceState.toInt(),
105 | theme = themeState.ordinal,
106 | themeColor = themeColorState.ordinal,
107 | ),
108 | )
109 | }
110 |
111 | val scrollState = rememberScrollState()
112 |
113 | Scaffold(
114 | topBar = {
115 | TopAppBar(
116 | title = { Text(stringResource(R.string.settings)) },
117 | navigationIcon = {
118 | BackButton(
119 | onBackClick = { navController.navigateUp() },
120 | )
121 | },
122 | )
123 | },
124 | content = { padding ->
125 | Column(
126 | modifier =
127 | Modifier
128 | .padding(padding)
129 | .verticalScroll(scrollState)
130 | .imePadding(),
131 | ) {
132 | ProvidePreferenceTheme {
133 | Preference(
134 | title = { Text(stringResource(R.string.about)) },
135 | icon = {
136 | Icon(
137 | imageVector = Icons.Outlined.Info,
138 | contentDescription = null,
139 | )
140 | },
141 | onClick = { navController.navigate("about") },
142 | )
143 | SliderPreference(
144 | value = minConfidenceState,
145 | sliderValue = minConfidenceSliderState,
146 | onValueChange = {
147 | minConfidenceState = it
148 | updateSettings()
149 | },
150 | onSliderValueChange = { minConfidenceSliderState = it },
151 | valueRange = MIN_CONFIDENCE_BOUND.toFloat()..99f,
152 | title = {
153 | val confidenceStr = stringResource(R.string.min_confidence, minConfidenceSliderState.toInt().toString())
154 | Text(confidenceStr)
155 | },
156 | summary = {
157 | Text(stringResource(R.string.min_confidence_summary))
158 | },
159 | icon = {
160 | Icon(
161 | imageVector = Icons.Outlined.DataThresholding,
162 | contentDescription = null,
163 | )
164 | },
165 | )
166 | ListPreference(
167 | type = ListPreferenceType.DROPDOWN_MENU,
168 | value = themeState,
169 | onValueChange = {
170 | themeState = it
171 | updateSettings()
172 | },
173 | values = ThemeMode.entries,
174 | valueToText = {
175 | AnnotatedString(resources.getString(it.resId))
176 | },
177 | title = {
178 | Text(stringResource(R.string.theme))
179 | },
180 | summary = {
181 | Text(stringResource(themeState.resId))
182 | },
183 | icon = {
184 | Icon(
185 | imageVector = Icons.Outlined.Palette,
186 | contentDescription = null,
187 | )
188 | },
189 | )
190 |
191 | ListPreference(
192 | type = ListPreferenceType.DROPDOWN_MENU,
193 | value = themeColorState,
194 | onValueChange = {
195 | themeColorState = it
196 | updateSettings()
197 | },
198 | values = ThemeColor.entries,
199 | valueToText = {
200 | AnnotatedString(resources.getString(it.resId))
201 | },
202 | title = {
203 | Text(stringResource(R.string.theme_color))
204 | },
205 | summary = {
206 | Text(stringResource(themeColorState.resId))
207 | },
208 | icon = {
209 | Icon(
210 | imageVector = Icons.Outlined.Colorize,
211 | contentDescription = null,
212 | )
213 | },
214 | )
215 | Preference(
216 | title = { Text(stringResource(R.string.backup_database)) },
217 | icon = {
218 | Icon(
219 | imageVector = Icons.Outlined.Save,
220 | contentDescription = null,
221 | )
222 | },
223 | onClick = {
224 | exportDbLauncher.launch("rank-my-favs")
225 | },
226 | )
227 | Preference(
228 | title = { Text(stringResource(R.string.restore_database)) },
229 | summary = {
230 | Text(stringResource(R.string.restore_database_warning))
231 | },
232 | icon = {
233 | Icon(
234 | imageVector = Icons.Outlined.Restore,
235 | contentDescription = null,
236 | )
237 | },
238 | onClick = {
239 | importDbLauncher.launch(arrayOf("application/zip"))
240 | },
241 | )
242 | }
243 | }
244 | },
245 | )
246 | }
247 |
--------------------------------------------------------------------------------
/app/src/main/java/com/dessalines/rankmyfavs/ui/components/match/MatchScreen.kt:
--------------------------------------------------------------------------------
1 | package com.dessalines.rankmyfavs.ui.components.match
2 |
3 | import androidx.compose.foundation.BasicTooltipBox
4 | import androidx.compose.foundation.ExperimentalFoundationApi
5 | import androidx.compose.foundation.layout.Arrangement
6 | import androidx.compose.foundation.layout.Box
7 | import androidx.compose.foundation.layout.Column
8 | import androidx.compose.foundation.layout.ExperimentalLayoutApi
9 | import androidx.compose.foundation.layout.FlowRow
10 | import androidx.compose.foundation.layout.fillMaxSize
11 | import androidx.compose.foundation.layout.fillMaxWidth
12 | import androidx.compose.foundation.layout.imePadding
13 | import androidx.compose.foundation.layout.padding
14 | import androidx.compose.foundation.rememberBasicTooltipState
15 | import androidx.compose.foundation.rememberScrollState
16 | import androidx.compose.foundation.shape.CircleShape
17 | import androidx.compose.foundation.verticalScroll
18 | import androidx.compose.material.icons.Icons
19 | import androidx.compose.material.icons.outlined.Done
20 | import androidx.compose.material.icons.outlined.SkipNext
21 | import androidx.compose.material3.ExperimentalMaterial3Api
22 | import androidx.compose.material3.FloatingActionButton
23 | import androidx.compose.material3.Icon
24 | import androidx.compose.material3.IconButton
25 | import androidx.compose.material3.MaterialTheme
26 | import androidx.compose.material3.OutlinedCard
27 | import androidx.compose.material3.Scaffold
28 | import androidx.compose.material3.Text
29 | import androidx.compose.material3.TooltipAnchorPosition
30 | import androidx.compose.material3.TooltipDefaults
31 | import androidx.compose.material3.TopAppBar
32 | import androidx.compose.runtime.Composable
33 | import androidx.compose.ui.Alignment
34 | import androidx.compose.ui.Modifier
35 | import androidx.compose.ui.res.stringResource
36 | import androidx.compose.ui.tooling.preview.Preview
37 | import androidx.navigation.NavController
38 | import com.dessalines.rankmyfavs.R
39 | import com.dessalines.rankmyfavs.db.FavListItem
40 | import com.dessalines.rankmyfavs.db.FavListItemUpdateStats
41 | import com.dessalines.rankmyfavs.db.FavListItemViewModel
42 | import com.dessalines.rankmyfavs.db.FavListMatchInsert
43 | import com.dessalines.rankmyfavs.db.FavListMatchViewModel
44 | import com.dessalines.rankmyfavs.db.sampleFavListItem
45 | import com.dessalines.rankmyfavs.ui.components.common.BackButton
46 | import com.dessalines.rankmyfavs.ui.components.common.SMALL_PADDING
47 | import com.dessalines.rankmyfavs.ui.components.common.ToolTip
48 | import dev.jeziellago.compose.markdowntext.MarkdownText
49 | import org.goochjs.glicko2.Rating
50 | import org.goochjs.glicko2.RatingCalculator
51 | import org.goochjs.glicko2.RatingPeriodResults
52 |
53 | @OptIn(
54 | ExperimentalMaterial3Api::class,
55 | ExperimentalFoundationApi::class,
56 | ExperimentalLayoutApi::class,
57 | )
58 | @Composable
59 | fun MatchScreen(
60 | navController: NavController,
61 | favListItemViewModel: FavListItemViewModel,
62 | favListMatchViewModel: FavListMatchViewModel,
63 | favListId: Int?,
64 | favListItemId: Int?,
65 | ) {
66 | val tooltipPosition = TooltipDefaults.rememberTooltipPositionProvider(TooltipAnchorPosition.Above)
67 | val scrollState = rememberScrollState()
68 |
69 | val first =
70 | if (favListId !== null) {
71 | favListItemViewModel.leastTrained(favListId)
72 | } else if (favListItemId !== null) {
73 | favListItemViewModel.getByIdSync(favListItemId)
74 | } else {
75 | null
76 | }
77 |
78 | fun rematchNav() =
79 | if (favListId !== null) {
80 | navController.navigate("match?favListId=$favListId") {
81 | popUpTo("match?favListId=$favListId") { inclusive = true }
82 | }
83 | } else if (favListItemId !== null) {
84 | navController.navigate("match?favListItemId=$favListItemId") {
85 | popUpTo("match?favListItemId=$favListItemId") { inclusive = true }
86 | }
87 | } else {
88 | null
89 | }
90 |
91 | val second =
92 | if (first !== null) {
93 | // Randomly either go with the closest match, or a random one from the list.
94 | // This keeps the skip a little more random.
95 | if ((1..2).random() == 1) {
96 | favListItemViewModel.closestMatch(first.favListId, first.id, first.glickoRating)
97 | } else {
98 | favListItemViewModel.randomMatch(first.favListId, first.id)
99 | }
100 | } else {
101 | null
102 | }
103 |
104 | Scaffold(
105 | topBar = {
106 | TopAppBar(
107 | title = { Text(stringResource(R.string.rate)) },
108 | navigationIcon = {
109 | BackButton(
110 | onBackClick = { navController.popBackStack() },
111 | )
112 | },
113 | actions = {
114 | if (first !== null && second !== null) {
115 | BasicTooltipBox(
116 | positionProvider = tooltipPosition,
117 | state = rememberBasicTooltipState(isPersistent = false),
118 | tooltip = {
119 | ToolTip(stringResource(id = R.string.skip))
120 | },
121 | ) {
122 | IconButton(
123 | onClick = {
124 | rematchNav()
125 | },
126 | ) {
127 | Icon(
128 | Icons.Outlined.SkipNext,
129 | contentDescription = stringResource(R.string.skip),
130 | )
131 | }
132 | }
133 | }
134 | },
135 | )
136 | },
137 | content = { padding ->
138 | Box(
139 | contentAlignment = Alignment.Center,
140 | modifier =
141 | Modifier
142 | .fillMaxSize()
143 | .padding(padding)
144 | .verticalScroll(scrollState),
145 | ) {
146 | if (first !== null && second !== null) {
147 | FlowRow(
148 | modifier =
149 | Modifier
150 | .fillMaxWidth()
151 | .padding(SMALL_PADDING),
152 | horizontalArrangement = Arrangement.SpaceAround,
153 | ) {
154 | MatchItem(
155 | favListItem = first,
156 | onClick = {
157 | recalculateStats(
158 | favListItemViewModel = favListItemViewModel,
159 | favListMatchViewModel = favListMatchViewModel,
160 | winner = first,
161 | loser = second,
162 | )
163 | rematchNav()
164 | },
165 | )
166 | MatchItem(
167 | favListItem = second,
168 | onClick = {
169 | recalculateStats(
170 | favListItemViewModel = favListItemViewModel,
171 | favListMatchViewModel = favListMatchViewModel,
172 | winner = second,
173 | loser = first,
174 | )
175 | rematchNav()
176 | },
177 | )
178 | }
179 | } else {
180 | Text(stringResource(R.string.no_more_training))
181 | }
182 | }
183 | },
184 | floatingActionButton = {
185 | BasicTooltipBox(
186 | positionProvider = tooltipPosition,
187 | state = rememberBasicTooltipState(isPersistent = false),
188 | tooltip = {
189 | ToolTip(stringResource(R.string.done))
190 | },
191 | ) {
192 | FloatingActionButton(
193 | modifier = Modifier.imePadding(),
194 | onClick = {
195 | navController.navigateUp()
196 | },
197 | shape = CircleShape,
198 | ) {
199 | Icon(
200 | imageVector = Icons.Outlined.Done,
201 | contentDescription = stringResource(R.string.done),
202 | )
203 | }
204 | }
205 | },
206 | )
207 | }
208 |
209 | /**
210 | * The win rate and other scores are stored on the item row.
211 | */
212 | fun recalculateStats(
213 | favListItemViewModel: FavListItemViewModel,
214 | favListMatchViewModel: FavListMatchViewModel,
215 | winner: FavListItem,
216 | loser: FavListItem,
217 | ) {
218 | // Insert the winner
219 | favListMatchViewModel.insert(
220 | FavListMatchInsert(winner.id, loser.id, winner.id),
221 | )
222 | val (winRateWinner, matchCountWinner) = calculateWinRate(favListMatchViewModel, winner)
223 | val (winRateLoser, matchCountLoser) = calculateWinRate(favListMatchViewModel, loser)
224 |
225 | // Initialize Glicko
226 | val ratingSystem = RatingCalculator(0.06, 0.5)
227 | val results = RatingPeriodResults()
228 |
229 | val gWinner = Rating("1", ratingSystem)
230 | val gLoser = Rating("2", ratingSystem)
231 |
232 | gWinner.rating = winner.glickoRating.toDouble()
233 | gWinner.ratingDeviation = winner.glickoDeviation.toDouble()
234 | gWinner.volatility = winner.glickoVolatility.toDouble()
235 |
236 | gLoser.rating = loser.glickoRating.toDouble()
237 | gLoser.ratingDeviation = loser.glickoDeviation.toDouble()
238 | gLoser.volatility = loser.glickoVolatility.toDouble()
239 |
240 | results.addResult(gWinner, gLoser)
241 |
242 | ratingSystem.updateRatings(results)
243 |
244 | // Update the winner
245 | favListItemViewModel.updateStats(
246 | FavListItemUpdateStats(
247 | id = winner.id,
248 | winRate = winRateWinner,
249 | glickoRating = gWinner.rating.toFloat(),
250 | glickoDeviation = gWinner.ratingDeviation.toFloat(),
251 | glickoVolatility = gWinner.volatility.toFloat(),
252 | matchCount = matchCountWinner,
253 | ),
254 | )
255 |
256 | // Update the loser
257 | favListItemViewModel.updateStats(
258 | FavListItemUpdateStats(
259 | id = loser.id,
260 | winRate = winRateLoser,
261 | glickoRating = gLoser.rating.toFloat(),
262 | glickoDeviation = gLoser.ratingDeviation.toFloat(),
263 | glickoVolatility = gLoser.volatility.toFloat(),
264 | matchCount = matchCountLoser,
265 | ),
266 | )
267 | }
268 |
269 | fun calculateWinRate(
270 | favListMatchViewModel: FavListMatchViewModel,
271 | item: FavListItem,
272 | ): Pair {
273 | val matches = favListMatchViewModel.getMatchups(item.id)
274 |
275 | val matchCount = matches.count()
276 | val winCount = matches.count { it.winnerId == item.id }
277 | val winRate = 100F * winCount / matchCount
278 | return Pair(winRate, matchCount)
279 | }
280 |
281 | @Composable
282 | fun MatchItem(
283 | favListItem: FavListItem,
284 | onClick: () -> Unit,
285 | ) {
286 | OutlinedCard(
287 | onClick = onClick,
288 | ) {
289 | Column(
290 | modifier = Modifier.padding(SMALL_PADDING),
291 | ) {
292 | Text(
293 | text = favListItem.name,
294 | )
295 | if (!favListItem.description.isNullOrBlank()) {
296 | MarkdownText(
297 | markdown = favListItem.description,
298 | linkColor = MaterialTheme.colorScheme.primary,
299 | // There's no way to actually override this
300 | onClick = onClick,
301 | )
302 | }
303 | }
304 | }
305 | }
306 |
307 | @Composable
308 | @Preview
309 | fun MatchItemPreview() {
310 | MatchItem(
311 | favListItem = sampleFavListItem,
312 | onClick = {},
313 | )
314 | }
315 |
--------------------------------------------------------------------------------
/app/src/main/java/com/dessalines/rankmyfavs/ui/components/favlistitem/FavListItemDetailScreen.kt:
--------------------------------------------------------------------------------
1 | package com.dessalines.rankmyfavs.ui.components.favlistitem
2 |
3 | import android.widget.Toast
4 | import androidx.annotation.Keep
5 | import androidx.compose.foundation.BasicTooltipBox
6 | import androidx.compose.foundation.ExperimentalFoundationApi
7 | import androidx.compose.foundation.layout.Box
8 | import androidx.compose.foundation.layout.Row
9 | import androidx.compose.foundation.layout.fillMaxWidth
10 | import androidx.compose.foundation.layout.imePadding
11 | import androidx.compose.foundation.layout.padding
12 | import androidx.compose.foundation.lazy.LazyColumn
13 | import androidx.compose.foundation.lazy.rememberLazyListState
14 | import androidx.compose.foundation.rememberBasicTooltipState
15 | import androidx.compose.foundation.shape.CircleShape
16 | import androidx.compose.material.icons.Icons
17 | import androidx.compose.material.icons.automirrored.outlined.Help
18 | import androidx.compose.material.icons.outlined.ClearAll
19 | import androidx.compose.material.icons.outlined.Delete
20 | import androidx.compose.material.icons.outlined.Edit
21 | import androidx.compose.material.icons.outlined.Reviews
22 | import androidx.compose.material3.ExperimentalMaterial3Api
23 | import androidx.compose.material3.FloatingActionButton
24 | import androidx.compose.material3.Icon
25 | import androidx.compose.material3.IconButton
26 | import androidx.compose.material3.MaterialTheme
27 | import androidx.compose.material3.MediumTopAppBar
28 | import androidx.compose.material3.Scaffold
29 | import androidx.compose.material3.Text
30 | import androidx.compose.material3.TooltipAnchorPosition
31 | import androidx.compose.material3.TooltipDefaults
32 | import androidx.compose.material3.TopAppBarDefaults
33 | import androidx.compose.material3.rememberTopAppBarState
34 | import androidx.compose.runtime.Composable
35 | import androidx.compose.runtime.getValue
36 | import androidx.compose.runtime.livedata.observeAsState
37 | import androidx.compose.runtime.mutableStateOf
38 | import androidx.compose.runtime.remember
39 | import androidx.compose.ui.Modifier
40 | import androidx.compose.ui.input.nestedscroll.nestedScroll
41 | import androidx.compose.ui.platform.LocalContext
42 | import androidx.compose.ui.res.stringResource
43 | import androidx.compose.ui.tooling.preview.Preview
44 | import androidx.compose.ui.unit.dp
45 | import androidx.lifecycle.asLiveData
46 | import androidx.navigation.NavController
47 | import com.breens.beetablescompose.BeeTablesCompose
48 | import com.dessalines.rankmyfavs.R
49 | import com.dessalines.rankmyfavs.db.DEFAULT_GLICKO_DEVIATION
50 | import com.dessalines.rankmyfavs.db.DEFAULT_GLICKO_RATING
51 | import com.dessalines.rankmyfavs.db.DEFAULT_GLICKO_VOLATILITY
52 | import com.dessalines.rankmyfavs.db.DEFAULT_MATCH_COUNT
53 | import com.dessalines.rankmyfavs.db.DEFAULT_WIN_RATE
54 | import com.dessalines.rankmyfavs.db.FavListItem
55 | import com.dessalines.rankmyfavs.db.FavListItemUpdateStats
56 | import com.dessalines.rankmyfavs.db.FavListItemViewModel
57 | import com.dessalines.rankmyfavs.db.FavListMatchViewModel
58 | import com.dessalines.rankmyfavs.db.sampleFavListItem
59 | import com.dessalines.rankmyfavs.ui.components.common.AreYouSureDialog
60 | import com.dessalines.rankmyfavs.ui.components.common.BackButton
61 | import com.dessalines.rankmyfavs.ui.components.common.LARGE_PADDING
62 | import com.dessalines.rankmyfavs.ui.components.common.SMALL_PADDING
63 | import com.dessalines.rankmyfavs.ui.components.common.ToolTip
64 | import com.dessalines.rankmyfavs.utils.GLICKO_WIKI_URL
65 | import com.dessalines.rankmyfavs.utils.numToString
66 | import com.dessalines.rankmyfavs.utils.openLink
67 | import dev.jeziellago.compose.markdowntext.MarkdownText
68 |
69 | @OptIn(ExperimentalMaterial3Api::class, ExperimentalFoundationApi::class)
70 | @Composable
71 | fun FavListItemDetailScreen(
72 | navController: NavController,
73 | favListItemViewModel: FavListItemViewModel,
74 | favListMatchViewModel: FavListMatchViewModel,
75 | id: Int,
76 | ) {
77 | val ctx = LocalContext.current
78 | val tooltipPosition = TooltipDefaults.rememberTooltipPositionProvider(TooltipAnchorPosition.Above)
79 | val scrollBehavior = TopAppBarDefaults.enterAlwaysScrollBehavior(rememberTopAppBarState())
80 | val listState = rememberLazyListState()
81 |
82 | val favListItem by favListItemViewModel.getById(id).asLiveData().observeAsState()
83 |
84 | val showDeleteDialog = remember { mutableStateOf(false) }
85 | val showClearStatsDialog = remember { mutableStateOf(false) }
86 |
87 | val deletedMessage = stringResource(R.string.item_deleted)
88 | val clearStatsMessage = stringResource(R.string.clear_stats)
89 |
90 | Scaffold(
91 | topBar = {
92 | MediumTopAppBar(
93 | title = { Text(favListItem?.name.orEmpty()) },
94 | scrollBehavior = scrollBehavior,
95 | navigationIcon = {
96 | BackButton(
97 | onBackClick = { navController.navigateUp() },
98 | )
99 | },
100 | actions = {
101 | BasicTooltipBox(
102 | positionProvider = tooltipPosition,
103 | state = rememberBasicTooltipState(isPersistent = false),
104 | tooltip = {
105 | ToolTip(stringResource(R.string.what_do_these_numbers_mean))
106 | },
107 | ) {
108 | IconButton(onClick = { openLink(GLICKO_WIKI_URL, ctx) }) {
109 | Icon(
110 | imageVector = Icons.AutoMirrored.Outlined.Help,
111 | contentDescription = stringResource(R.string.what_do_these_numbers_mean),
112 | )
113 | }
114 | }
115 | BasicTooltipBox(
116 | positionProvider = tooltipPosition,
117 | state = rememberBasicTooltipState(isPersistent = false),
118 | tooltip = {
119 | ToolTip(stringResource(R.string.edit_item))
120 | },
121 | ) {
122 | IconButton(
123 | onClick = {
124 | navController.navigate("editItem/$id")
125 | },
126 | ) {
127 | Icon(
128 | imageVector = Icons.Outlined.Edit,
129 | contentDescription = stringResource(R.string.edit_item),
130 | )
131 | }
132 | }
133 | BasicTooltipBox(
134 | positionProvider = tooltipPosition,
135 | state = rememberBasicTooltipState(isPersistent = false),
136 | tooltip = {
137 | ToolTip(clearStatsMessage)
138 | },
139 | ) {
140 | IconButton(
141 | onClick = {
142 | showClearStatsDialog.value = true
143 | },
144 | ) {
145 | Icon(
146 | Icons.Outlined.ClearAll,
147 | contentDescription = stringResource(R.string.clear_stats),
148 | )
149 | }
150 | }
151 | BasicTooltipBox(
152 | positionProvider = tooltipPosition,
153 | state = rememberBasicTooltipState(isPersistent = false),
154 | tooltip = {
155 | ToolTip(stringResource(R.string.delete))
156 | },
157 | ) {
158 | IconButton(
159 | onClick = {
160 | showDeleteDialog.value = true
161 | },
162 | ) {
163 | Icon(
164 | Icons.Outlined.Delete,
165 | contentDescription = stringResource(R.string.delete),
166 | )
167 | }
168 | }
169 | },
170 | )
171 | },
172 | content = { padding ->
173 | AreYouSureDialog(
174 | show = showDeleteDialog,
175 | title = stringResource(R.string.delete),
176 | onYes = {
177 | favListItem?.let {
178 | favListItemViewModel.delete(it)
179 | navController.navigateUp()
180 | Toast.makeText(ctx, deletedMessage, Toast.LENGTH_SHORT).show()
181 | }
182 | },
183 | )
184 |
185 | AreYouSureDialog(
186 | show = showClearStatsDialog,
187 | title = clearStatsMessage,
188 | onYes = {
189 | // Update the stats for that row
190 | favListItemViewModel.updateStats(
191 | FavListItemUpdateStats(
192 | id = id,
193 | winRate = DEFAULT_WIN_RATE,
194 | glickoRating = DEFAULT_GLICKO_RATING,
195 | glickoDeviation = DEFAULT_GLICKO_DEVIATION,
196 | glickoVolatility = DEFAULT_GLICKO_VOLATILITY,
197 | matchCount = DEFAULT_MATCH_COUNT,
198 | ),
199 | )
200 | favListMatchViewModel.deleteMatchesForItem(id)
201 | Toast.makeText(ctx, clearStatsMessage, Toast.LENGTH_SHORT).show()
202 | },
203 | )
204 |
205 | Box(
206 | modifier = Modifier.padding(padding).imePadding().nestedScroll(scrollBehavior.nestedScrollConnection),
207 | ) {
208 | LazyColumn(
209 | state = listState,
210 | ) {
211 | favListItem?.let {
212 | item {
213 | FavListItemDetails(it)
214 | }
215 |
216 | item {
217 | Stats(it)
218 | }
219 | }
220 | }
221 | }
222 | },
223 | floatingActionButton = {
224 | BasicTooltipBox(
225 | positionProvider = tooltipPosition,
226 | state = rememberBasicTooltipState(isPersistent = false),
227 | tooltip = {
228 | ToolTip(stringResource(R.string.rate))
229 | },
230 | ) {
231 | FloatingActionButton(
232 | modifier = Modifier.imePadding(),
233 | onClick = {
234 | navController.navigate("match?favListItemId=$id")
235 | },
236 | shape = CircleShape,
237 | ) {
238 | Icon(
239 | Icons.Outlined.Reviews,
240 | contentDescription = stringResource(R.string.rate),
241 | )
242 | }
243 | }
244 | },
245 | )
246 | }
247 |
248 | @Keep
249 | data class StatItem(
250 | val key: String,
251 | val v: String,
252 | )
253 |
254 | @Composable
255 | fun Stats(favListItem: FavListItem) {
256 | val titles = listOf("Key", "V")
257 | val data =
258 | listOf(
259 | StatItem(
260 | key = stringResource(R.string.rating),
261 | v = numToString(favListItem.glickoRating, 0),
262 | ),
263 | StatItem(
264 | key = stringResource(R.string.confidence),
265 | v = calculateConfidenceStr(favListItem.glickoDeviation),
266 | ),
267 | StatItem(
268 | key = stringResource(R.string.deviation),
269 | v = numToString(favListItem.glickoDeviation, 0),
270 | ),
271 | // StatItem(
272 | // key = stringResource(R.string.Volatility),
273 | // v = numToString(favListItem.glickoVolatility, 2),
274 | // ),
275 | StatItem(
276 | key = stringResource(R.string.win_rate),
277 | v = numToString(favListItem.winRate, 0) + "%",
278 | ),
279 | StatItem(
280 | key = stringResource(R.string.match_count),
281 | v = favListItem.matchCount.toString(),
282 | ),
283 | )
284 | Row(
285 | modifier = Modifier.padding(horizontal = LARGE_PADDING),
286 | ) {
287 | BeeTablesCompose(data = data, headerTableTitles = titles, enableTableHeaderTitles = false)
288 | }
289 | }
290 |
291 | fun calculateConfidence(deviation: Float) = ((1500F - deviation) / 1500F * 100F)
292 |
293 | fun calculateConfidenceStr(deviation: Float): String = numToString(calculateConfidence(deviation), 1) + "%"
294 |
295 | @Composable
296 | @Preview
297 | fun StatsPreview() {
298 | Stats(sampleFavListItem)
299 | }
300 |
301 | @Composable
302 | fun FavListItemDetails(favListItem: FavListItem) {
303 | if (!favListItem.description.isNullOrBlank()) {
304 | MarkdownText(
305 | markdown = favListItem.description,
306 | linkColor = MaterialTheme.colorScheme.primary,
307 | modifier =
308 | Modifier
309 | .padding(
310 | top = 0.dp,
311 | bottom = SMALL_PADDING,
312 | start = LARGE_PADDING,
313 | end = LARGE_PADDING,
314 | ).fillMaxWidth(),
315 | )
316 | }
317 | }
318 |
319 | @Composable
320 | @Preview
321 | fun FavListItemDetailsPreview() {
322 | FavListItemDetails(sampleFavListItem)
323 | }
324 |
--------------------------------------------------------------------------------