Archives/JetBrains_intellij-platform-plugin-template
1
0
Fork 0
mirror of https://github.com/JetBrains/intellij-platform-plugin-template.git synced 2025-12-05 06:11:52 +00:00
Code Issues Projects Releases Wiki Activity

Refactor: Make ViewModel APIs Disposable and rename cancel to dispose for cleanup consistency

Browse Source
This commit is contained in:
Nebojsa Vuksic 2025-08-07 10:11:01 +02:00
parent 9591bc93f3
commit 015bd0426c
3 changed files with 9 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
src/main/kotlin/org/jetbrains/plugins/template/toolWindow/ComposeSamplesToolWindowFactory.kt
View File

@ -37,7 +37,7 @@ class ComposeSamplesToolWindowFactory : ToolWindowFactory, DumbAware {
DisposableEffect(Unit) { DisposableEffect(Unit) {
viewModel.onReloadWeatherForecast() viewModel.onReloadWeatherForecast()
onDispose { viewModel.cancel() } onDispose { viewModel.dispose() }
} }
WeatherAppSample( WeatherAppSample(

7
src/main/kotlin/org/jetbrains/plugins/template/weatherApp/services/WeatherAppViewModel.kt
View File

@ -1,5 +1,6 @@
package org.jetbrains.plugins.template.weatherApp.services package org.jetbrains.plugins.template.weatherApp.services
import com.intellij.openapi.Disposable
import com.intellij.openapi.application.EDT import com.intellij.openapi.application.EDT
import kotlinx.coroutines.CoroutineScope import kotlinx.coroutines.CoroutineScope
import kotlinx.coroutines.Dispatchers import kotlinx.coroutines.Dispatchers
@ -18,7 +19,7 @@ import org.jetbrains.plugins.template.weatherApp.model.WeatherForecastData
* a flow to observe the list of selectable locations. Implementations are expected to handle * a flow to observe the list of selectable locations. Implementations are expected to handle
* location-related logic and state management. * location-related logic and state management.
*/ */
interface MyLocationsViewModelApi { interface MyLocationsViewModelApi : Disposable {
fun onAddLocation(locationToAdd: Location) fun onAddLocation(locationToAdd: Location)
fun onDeleteLocation(locationToDelete: Location) fun onDeleteLocation(locationToDelete: Location)
@ -32,7 +33,7 @@ interface MyLocationsViewModelApi {
* Interface representing a ViewModel for managing weather-related data * Interface representing a ViewModel for managing weather-related data
* and user interactions. * and user interactions.
*/ */
interface WeatherViewModelApi { interface WeatherViewModelApi : Disposable {
val weatherForecast: Flow<WeatherForecastData> val weatherForecast: Flow<WeatherForecastData>
fun onLoadWeatherForecast(location: Location) fun onLoadWeatherForecast(location: Location)
@ -134,7 +135,7 @@ class WeatherAppViewModel(
* This method is used to release resources and stop ongoing tasks when the ViewModel * This method is used to release resources and stop ongoing tasks when the ViewModel
* is no longer needed, ensuring proper cleanup of coroutine-based operations. * is no longer needed, ensuring proper cleanup of coroutine-based operations.
*/ */
fun cancel() { override fun dispose() {
viewModelScope.cancel() viewModelScope.cancel()
} }
} }

4
src/test/kotlin/org/jetbrains/plugins/template/MyLocationListTest.kt
View File

@ -176,6 +176,10 @@ internal class MyLocationListTest : ComposeBasedTestCase() {
override fun onLocationSelected(selectedLocationIndex: Int) { override fun onLocationSelected(selectedLocationIndex: Int) {
selectedItemIndex.value = selectedLocationIndex selectedItemIndex.value = selectedLocationIndex
} }
override fun dispose() {
}
} }
private class MyLocationListRobot(private val composableRule: ComposeTestRule) { private class MyLocationListRobot(private val composableRule: ComposeTestRule) {