Fix codestyle issues

TimPushkin · Aug 20, 2022 · e13160c · e13160c
1 parent f5ac39c
commit e13160c
Show file tree

Hide file tree

Showing 10 changed files with 35 additions and 14 deletions.
diff --git a/app/src/androidTest/java/ru/spbu/depnav/data/db/AppDatabaseDaosTest.kt b/app/src/androidTest/java/ru/spbu/depnav/data/db/AppDatabaseDaosTest.kt
@@ -182,7 +182,6 @@ class AppDatabaseDaosTest {
                         insertMarkerTexts(listOf(MarkerText(id, languageId, null, null)))
                     }
                 }
-
             }
             id++
         }

diff --git a/app/src/main/java/ru/spbu/depnav/MainActivity.kt b/app/src/main/java/ru/spbu/depnav/MainActivity.kt
@@ -19,6 +19,7 @@ import ru.spbu.depnav.ui.search.SearchScreen
 import ru.spbu.depnav.ui.theme.DepNavTheme
 import ru.spbu.depnav.utils.preferences.PreferencesManager
 
+@Suppress("UndocumentedPublicClass") // Class name is self-explanatory
 @AndroidEntryPoint
 class MainActivity : ComponentActivity() {
     private val mapScreenVm: MapScreenViewModel by viewModels()
@@ -57,4 +58,4 @@ class MainActivity : ComponentActivity() {
             }
         }
     }
-}
+}
diff --git a/app/src/main/java/ru/spbu/depnav/data/db/DatabaseModule.kt b/app/src/main/java/ru/spbu/depnav/data/db/DatabaseModule.kt
@@ -1,3 +1,5 @@
+@file:Suppress("UndocumentedPublicFunction") // Method names are self-explanatory
+
 package ru.spbu.depnav.data.db
 
 import android.content.Context
@@ -11,6 +13,7 @@ import javax.inject.Singleton
 
 private const val DB_ASSET = "markers.db"
 
+/** Database-related providers for Hilt. */
 @Module
 @InstallIn(SingletonComponent::class)
 object DatabaseModule {
@@ -25,6 +28,7 @@ object DatabaseModule {
         .fallbackToDestructiveMigration()
         .build()
 
+    /** Provides */
     @Provides
     fun provideMapInfoDao(appDatabase: AppDatabase) = appDatabase.mapInfoDao()
 

diff --git a/app/src/main/java/ru/spbu/depnav/data/model/MarkerText.kt b/app/src/main/java/ru/spbu/depnav/data/model/MarkerText.kt
@@ -43,6 +43,8 @@ data class MarkerText(
         EN, RU;
 
         companion object {
+            /** Returns the current locale's language, if it is supported, or [EN] otherwise. */
+            @Suppress("UseIfInsteadOfWhen") // Planning to add more languages later.
             fun getCurrent() = when (Locale.current.language) {
                 "ru" -> RU
                 else -> EN

diff --git a/app/src/main/java/ru/spbu/depnav/data/repository/MapInfoRepo.kt b/app/src/main/java/ru/spbu/depnav/data/repository/MapInfoRepo.kt
@@ -6,7 +6,7 @@ import javax.inject.Inject
 
 /** Repository for loading and saving [MapInfo] objects. */
 class MapInfoRepo @Inject constructor(private val dao: MapInfoDao) {
-    /** Saves the provided [MapInfo] objects. */
+    /** Saves the provided objects. */
     suspend fun insertAll(vararg mapInfos: MapInfo) = dao.insertAll(*mapInfos)
 
     /** Loads a [MapInfo] by its name. */

diff --git a/app/src/main/java/ru/spbu/depnav/data/repository/MarkerWithTextRepo.kt b/app/src/main/java/ru/spbu/depnav/data/repository/MarkerWithTextRepo.kt
@@ -10,11 +10,13 @@ private const val TAG = "MarkerWithTextRepo"
 
 /** Repository for loading and saving [Marker] objects with associated [MarkerText] objects. */
 class MarkerWithTextRepo @Inject constructor(private val dao: MarkerWithTextDao) {
+    /** Saves the provided objects. */
     suspend fun insertAll(markersWithText: Map<Marker, MarkerText>) {
         dao.insertMarkers(markersWithText.keys)
         dao.insertMarkerTexts(markersWithText.values)
     }
 
+    /** Loads a [Marker] by its ID and its corresponding [MarkerText] on the current language. */
     suspend fun loadById(id: Int): Pair<Marker, MarkerText> {
         val language = MarkerText.LanguageId.getCurrent()
         val (marker, markerTexts) = dao.loadById(id, language).entries.firstOrNull()
@@ -23,7 +25,12 @@ class MarkerWithTextRepo @Inject constructor(private val dao: MarkerWithTextDao)
         return marker to markerText
     }
 
-    suspend fun loadByFloor(floor: Int, language: MarkerText.LanguageId): Map<Marker, MarkerText> {
+    /**
+     * Loads all [Markers][Marker] on the specified floor with their corresponding [MarkerText] on
+     * the current language.
+     */
+    suspend fun loadByFloor(floor: Int): Map<Marker, MarkerText> {
+        val language = MarkerText.LanguageId.getCurrent()
         val markersWithTexts = dao.loadByFloor(floor, language)
         return markersWithTexts.entries.associate { (marker, markerTexts) ->
             val markerText = markerTexts.squeezedFor(marker, language)
@@ -37,10 +44,12 @@ class MarkerWithTextRepo @Inject constructor(private val dao: MarkerWithTextDao)
             MarkerText(marker.id, language, null, null)
         }
 
-    suspend fun loadByTokens(
-        tokens: String,
-        language: MarkerText.LanguageId
-    ): Map<Marker, MarkerText> {
+    /**
+     * Loads a [Marker] and its corresponding [MarkerText] on the current language so that the text
+     * has the specified tokens in it.
+     */
+    suspend fun loadByTokens(tokens: String): Map<Marker, MarkerText> {
+        val language = MarkerText.LanguageId.getCurrent()
         val textsWithMarkers = dao.loadByTokens(tokens, language)
         return textsWithMarkers.entries.associate { (markerText, markers) ->
             val marker = markers.firstOrNull()

diff --git a/app/src/main/java/ru/spbu/depnav/ui/NavDestination.kt b/app/src/main/java/ru/spbu/depnav/ui/NavDestination.kt
@@ -1,3 +1,4 @@
 package ru.spbu.depnav.ui
 
+/** Application's GUI screens as navigation destinations. */
 enum class NavDestination { MAP, SEARCH }
diff --git a/app/src/main/java/ru/spbu/depnav/ui/map/MapScreenViewModel.kt b/app/src/main/java/ru/spbu/depnav/ui/map/MapScreenViewModel.kt
@@ -139,9 +139,7 @@ class MapScreenViewModel @Inject constructor(
     }
 
     private suspend fun initMap(mapName: String, tilesSubdir: String) {
-        val language = MarkerText.LanguageId.getCurrent()
-
-        Log.i(TAG, "Initializing map $mapName on $language language")
+        Log.i(TAG, "Initializing map $mapName")
 
         minScaleCollectionJob?.cancel("State changed")
         mapState.shutdown()
@@ -155,7 +153,7 @@ class MapScreenViewModel @Inject constructor(
                     val floorNum = it + 1
                     val layers = listOf(makeTileProviderForFloor(floorNum))
                     val markers = withContext(Dispatchers.IO) {
-                        async { markerWithTextRepo.loadByFloor(floorNum, language) }
+                        async { markerWithTextRepo.loadByFloor(floorNum) }
                     }
                     floorNum to Floor(layers, markers)
                 }.toMap()

diff --git a/app/src/main/java/ru/spbu/depnav/ui/search/SearchScreenViewModel.kt b/app/src/main/java/ru/spbu/depnav/ui/search/SearchScreenViewModel.kt
@@ -56,7 +56,7 @@ class SearchScreenViewModel @Inject constructor(private val markerWithTextRepo:
         val query = text.split(' ').joinToString(" ") { "$it*" }
 
         viewModelScope.launch(Dispatchers.IO) {
-            val matches = markerWithTextRepo.loadByTokens(query, language)
+            val matches = markerWithTextRepo.loadByTokens(query)
             Log.v(TAG, "Found ${matches.size} matches")
             launch(Dispatchers.Main) { matchedMarkers = matches.values }
         }

diff --git a/app/src/main/java/ru/spbu/depnav/utils/preferences/PreferencesManager.kt b/app/src/main/java/ru/spbu/depnav/utils/preferences/PreferencesManager.kt
@@ -8,6 +8,7 @@ import androidx.compose.runtime.setValue
 import androidx.core.content.edit
 import dagger.hilt.android.qualifiers.ApplicationContext
 import ru.spbu.depnav.R
+import ru.spbu.depnav.data.model.MapInfo
 import javax.inject.Inject
 import javax.inject.Singleton
 
@@ -60,16 +61,22 @@ class PreferencesManager @Inject constructor(@ApplicationContext context: Contex
         prefs.getString(MAP_STORED_NAME_KEY, MAP_STORED_NAME_DEFAULT) ?: MAP_STORED_NAME_DEFAULT
     )
 
+    /** Defines what map the app shows. */
     var mapStoredName: MapStoredName
         get() = MapStoredName.valueOf(_mapStoredName)
         set(value) {
             prefs.edit { putString(MAP_STORED_NAME_KEY, value.name) }
             _mapStoredName = value.name
         }
 
-    enum class MapStoredName(val storedName: String) {
+    /** Maps available in the app. */
+    enum class MapStoredName(
+        /** Map's name as it is stored in the corresponding [MapInfo] in the database. */
+        val storedName: String
+    ) {
         SPBU_MM("spbu-mm");
 
+        /** Subdirectory with map's tiles in assets. */
         val tilesSubdir = "$storedName/tiles"
     }
 }