Prototype for #1481

Extract logic for calculating neighbouring periods
mtotschnig · Apr 25, 2024 · d3d8364 · d3d8364
1 parent 8fac94a
commit d3d8364
Show file tree

Hide file tree

Showing 10 changed files with 185 additions and 103 deletions.
diff --git a/myExpenses/src/main/java/org/totschnig/myexpenses/db2/RepositoryBudget.kt b/myExpenses/src/main/java/org/totschnig/myexpenses/db2/RepositoryBudget.kt
@@ -22,9 +22,10 @@ import org.totschnig.myexpenses.provider.TransactionProvider
 import org.totschnig.myexpenses.provider.filter.FilterPersistence
 import org.totschnig.myexpenses.provider.getEnumOrNull
 import org.totschnig.myexpenses.provider.getLocalDate
+import org.totschnig.myexpenses.util.GroupingInfo
+import org.totschnig.myexpenses.util.GroupingNavigator
 import org.totschnig.myexpenses.viewmodel.BudgetViewModel
 import org.totschnig.myexpenses.viewmodel.BudgetViewModel2.Companion.aggregateNeutralPrefKey
-import org.totschnig.myexpenses.viewmodel.DistributionViewModelBase
 import org.totschnig.myexpenses.viewmodel.data.Budget
 import org.totschnig.myexpenses.viewmodel.data.BudgetAllocation
 import org.totschnig.myexpenses.viewmodel.data.BudgetProgress
@@ -53,7 +54,7 @@ fun budgetAllocationUri(budgetId: Long, categoryId: Long) = ContentUris.withAppe
 fun budgetAllocationQueryUri(
  budgetId: Long,
  categoryId: Long,
- groupingInfo: DistributionViewModelBase.GroupingInfo
+ groupingInfo: GroupingInfo
 ): Uri = budgetAllocationQueryUri(
  budgetId,
  categoryId,
@@ -139,24 +140,16 @@ suspend fun Repository.loadBudgetProgress(budgetId: Long): BudgetProgress? = con
  end = cursor.getLocalDate(KEY_END)
  ),
  description = budget.durationPrettyPrint()
- ) else with(DateInfo.load(contentResolver)) {
+ ) else {
+ val dateInfo = DateInfo.load(contentResolver)
+ val info = GroupingNavigator.current(grouping, dateInfo)
  val weekStartDay = prefHandler.weekStartAsDayOfWeek
- val today = LocalDate.ofYearDay(year, day)
+ val today = LocalDate.ofYearDay(dateInfo.year, dateInfo.day)
  val weekStart = today.with(TemporalAdjusters.previousOrSame(weekStartDay))
- val year = when (grouping) {
- Grouping.WEEK -> yearOfWeekStart
- Grouping.MONTH -> yearOfMonthStart
- else -> year
- }
- val second = when (grouping) {
- Grouping.DAY -> day
- Grouping.WEEK -> week
- Grouping.MONTH -> month
- else -> 0
- }
+
  BudgetPeriod(
- year = year,
- second = second,
+ year = info.year,
+ second = info.second,
  duration = when (grouping) {
  Grouping.DAY -> {
  today.dayOfWeek
@@ -174,26 +167,26 @@ suspend fun Repository.loadBudgetProgress(budgetId: Long): BudgetProgress? = con
 
  Grouping.MONTH -> with(
  Grouping.getMonthRange(
- yearOfMonthStart,
- month,
+ info.year,
+ info.second,
  prefHandler.monthStart
  )
  ) {
  BudgetDuration(this.first, this.second)
  }
 
  Grouping.YEAR -> BudgetDuration(
- LocalDate.ofYearDay(year, 1),
- LocalDate.of(year, 12, 31)
+ LocalDate.ofYearDay(info.year, 1),
+ LocalDate.of(info.year, 12, 31)
  )
 
  else -> throw IllegalStateException()
  },
  description = grouping.getDisplayTitle(
  context,
- year,
- second,
- this,
+ info.year,
+ info.second,
+ dateInfo,
  weekStart,
  true
  )
@@ -224,7 +217,7 @@ suspend fun Repository.loadBudgetProgress(budgetId: Long): BudgetProgress? = con
  BudgetProgress(
  budget.title,
  budget.currencyUnit,
- groupingInfo.description,
+ groupingInfo,
  allocated,
  -spent,
  totalDays,

diff --git a/myExpenses/src/main/java/org/totschnig/myexpenses/util/GroupingNavigator.kt b/myExpenses/src/main/java/org/totschnig/myexpenses/util/GroupingNavigator.kt
@@ -0,0 +1,59 @@
+package org.totschnig.myexpenses.util
+
+import android.os.Parcelable
+import kotlinx.parcelize.Parcelize
+import org.totschnig.myexpenses.model.Grouping
+import org.totschnig.myexpenses.model.Grouping.DAY
+import org.totschnig.myexpenses.model.Grouping.MONTH
+import org.totschnig.myexpenses.model.Grouping.NONE
+import org.totschnig.myexpenses.model.Grouping.WEEK
+import org.totschnig.myexpenses.viewmodel.data.DateInfo
+import org.totschnig.myexpenses.viewmodel.data.DateInfoExtra
+
+@Parcelize
+data class GroupingInfo(
+ val grouping: Grouping = NONE,
+ val year: Int = -1,
+ val second: Int = -1
+) : Parcelable
+
+object GroupingNavigator {
+ fun current(grouping: Grouping, dateInfo: DateInfo) = with(dateInfo) {
+ GroupingInfo(
+ grouping = grouping,
+ year = when (grouping) {
+ WEEK -> yearOfWeekStart
+ MONTH -> yearOfMonthStart
+ else -> year
+ },
+ second = when (grouping) {
+ DAY -> day
+ WEEK -> week
+ MONTH -> month
+ else -> 0
+ }
+ )
+ }
+
+ fun nextYear(groupingInfo: GroupingInfo) = groupingInfo.copy(year = groupingInfo.year + 1)
+
+ fun next(groupingInfo: GroupingInfo, dateInfo: DateInfoExtra): GroupingInfo {
+ val nextSecond = groupingInfo.second + 1
+ val overflow = nextSecond > dateInfo.maxValue
+ return groupingInfo.copy(
+ year = if (overflow) groupingInfo.year + 1 else groupingInfo.year,
+ second = if (overflow) groupingInfo.grouping.minValue else nextSecond
+ )
+ }
+
+ fun previousYear(groupingInfo: GroupingInfo) = groupingInfo.copy(year = groupingInfo.year - 1)
+
+ fun previous(groupingInfo: GroupingInfo, dateInfo: DateInfoExtra): GroupingInfo {
+ val nextSecond = groupingInfo.second - 1
+ val underflow = nextSecond < groupingInfo.grouping.minValue
+ return groupingInfo.copy(
+ year = if (underflow) groupingInfo.year - 1 else groupingInfo.year,
+ second = if (underflow) dateInfo.maxValue else nextSecond
+ )
+ }
+}
diff --git a/myExpenses/src/main/java/org/totschnig/myexpenses/viewmodel/BudgetViewModel2.kt b/myExpenses/src/main/java/org/totschnig/myexpenses/viewmodel/BudgetViewModel2.kt
@@ -34,6 +34,8 @@ import org.totschnig.myexpenses.provider.DatabaseConstants
 import org.totschnig.myexpenses.provider.DatabaseConstants.KEY_ROWID
 import org.totschnig.myexpenses.provider.TransactionProvider
 import org.totschnig.myexpenses.provider.filter.FilterPersistence
+import org.totschnig.myexpenses.util.GroupingInfo
+import org.totschnig.myexpenses.util.GroupingNavigator
 import org.totschnig.myexpenses.util.crashreporting.CrashHandler
 import org.totschnig.myexpenses.viewmodel.data.Budget
 import org.totschnig.myexpenses.viewmodel.data.BudgetAllocation
@@ -191,12 +193,16 @@ class BudgetViewModel2(application: Application, savedStateHandle: SavedStateHan
  )
  }
 
+ private suspend fun nextGrouping() =
+ GroupingNavigator.next(groupingInfo!!, dateInfoExtra.filterNotNull().first())
+
+
  fun rollOverClear() {
  viewModelScope.launch(context = coroutineContext()) {
  val budget = accountInfo.value!!
  val selection =
  "${DatabaseConstants.KEY_BUDGETID} = ? AND ${DatabaseConstants.KEY_YEAR} = ? AND ${DatabaseConstants.KEY_SECOND_GROUP} = ?"
- val nextGrouping = groupingInfo!!.next(dateInfoExtra.filterNotNull().first())
+ val nextGrouping = nextGrouping()
  val ops = arrayListOf(
  ContentProviderOperation.newUpdate(TransactionProvider.BUDGET_ALLOCATIONS_URI)
  .withSelection(
@@ -227,7 +233,7 @@ class BudgetViewModel2(application: Application, savedStateHandle: SavedStateHan
 
  private suspend fun saveRollOverList(rollOverList: List<Pair<Long, Long>>) {
  val budget = accountInfo.value!!
- val nextGrouping = groupingInfo!!.next(dateInfoExtra.filterNotNull().first())
+ val nextGrouping = nextGrouping()
  val ops = ArrayList<ContentProviderOperation>()
  rollOverList.forEach {
  val (categoryId, rollOver) = it

diff --git a/myExpenses/src/main/java/org/totschnig/myexpenses/viewmodel/DistributionViewModelBase.kt b/myExpenses/src/main/java/org/totschnig/myexpenses/viewmodel/DistributionViewModelBase.kt
@@ -1,7 +1,6 @@
 package org.totschnig.myexpenses.viewmodel
 
 import android.app.Application
-import android.os.Parcelable
 import androidx.compose.runtime.MutableState
 import androidx.compose.runtime.mutableStateOf
 import androidx.compose.runtime.snapshots.SnapshotStateList
@@ -29,7 +28,6 @@ import kotlinx.coroutines.flow.mapNotNull
 import kotlinx.coroutines.flow.stateIn
 import kotlinx.coroutines.launch
 import kotlinx.coroutines.withContext
-import kotlinx.parcelize.Parcelize
 import org.totschnig.myexpenses.R
 import org.totschnig.myexpenses.db2.updateCategoryColor
 import org.totschnig.myexpenses.model.Grouping
@@ -56,6 +54,8 @@ import org.totschnig.myexpenses.provider.DbUtils
 import org.totschnig.myexpenses.provider.TransactionProvider
 import org.totschnig.myexpenses.provider.filter.WhereFilter
 import org.totschnig.myexpenses.provider.getLongIfExistsOr0
+import org.totschnig.myexpenses.util.GroupingInfo
+import org.totschnig.myexpenses.util.GroupingNavigator
 import org.totschnig.myexpenses.viewmodel.data.Budget
 import org.totschnig.myexpenses.viewmodel.data.Category
 import org.totschnig.myexpenses.viewmodel.data.DateInfoExtra
@@ -97,52 +97,21 @@ abstract class DistributionViewModelBase<T : DistributionAccountInfo>(
  groupingInfo = GroupingInfo(grouping, 0, 0)
  } else {
  viewModelScope.launch {
- groupingInfo = with(dateInfo.first()) {
- GroupingInfo(
- grouping = grouping,
- year = when (grouping) {
- Grouping.WEEK -> yearOfWeekStart
- Grouping.MONTH -> yearOfMonthStart
- else -> year
- },
- second = when (grouping) {
- Grouping.DAY -> day
- Grouping.WEEK -> week
- Grouping.MONTH -> month
- else -> 0
- }
- )
- }
+ groupingInfo = GroupingNavigator.current(grouping,dateInfo.first())
  }
  }
  }
 
- fun GroupingInfo.next(dateInfo: DateInfoExtra): GroupingInfo {
- val nextSecond = second + 1
- val overflow = nextSecond > dateInfo.maxValue
- return copy(
- year = if (overflow) year + 1 else year,
- second = if (overflow) grouping.minValue else nextSecond
- )
- }
-
- fun GroupingInfo.previous(dateInfo: DateInfoExtra): GroupingInfo {
- val nextSecond = second - 1
- val underflow = nextSecond < grouping.minValue
- return copy(
- year = if (underflow) year - 1 else year,
- second = if (underflow) dateInfo.maxValue else nextSecond
- )
- }
-
  fun forward() {
  groupingInfo?.let { info ->
  if (info.grouping == Grouping.YEAR) {
- groupingInfo = info.copy(year = info.year + 1)
+ groupingInfo = GroupingNavigator.nextYear(info)
  } else {
  viewModelScope.launch {
- val dateInfo = dateInfoExtra.filterNotNull().first()
- groupingInfo = info.next(dateInfo)
+ groupingInfo = GroupingNavigator.next(
+ info,
+ dateInfoExtra.filterNotNull().first()
+ )
  }
  }
  }
@@ -151,11 +120,13 @@ abstract class DistributionViewModelBase<T : DistributionAccountInfo>(
  fun backward() {
  groupingInfo?.let { info ->
  if (info.grouping == Grouping.YEAR) {
- groupingInfo = info.copy(year = info.year - 1)
+ groupingInfo = GroupingNavigator.previousYear(info)
  } else {
  viewModelScope.launch {
- val dateInfo = dateInfoExtra.filterNotNull().first()
- groupingInfo = info.previous(dateInfo)
+ groupingInfo = GroupingNavigator.previous(
+ info,
+ dateInfoExtra.filterNotNull().first()
+ )
  }
  }
  }
@@ -375,11 +346,4 @@ abstract class DistributionViewModelBase<T : DistributionAccountInfo>(
  preference[aggregateNeutralPrefKey] = aggregateNeutral
  }
  }
-
- @Parcelize
- data class GroupingInfo(
- val grouping: Grouping = Grouping.NONE,
- val year: Int = -1,
- val second: Int = -1
- ) : Parcelable
 }
diff --git a/myExpenses/src/main/java/org/totschnig/myexpenses/viewmodel/data/BudgetProgress.kt b/myExpenses/src/main/java/org/totschnig/myexpenses/viewmodel/data/BudgetProgress.kt
@@ -1,11 +1,12 @@
 package org.totschnig.myexpenses.viewmodel.data
 
+import org.totschnig.myexpenses.db2.BudgetPeriod
 import org.totschnig.myexpenses.model.CurrencyUnit
 
 data class BudgetProgress(
  val title: String,
  val currency: CurrencyUnit,
- val groupInfo: String,
+ val groupInfo: BudgetPeriod,
  val allocated: Long,
  val spent: Long,
  val totalDays: Long,

diff --git a/myExpenses/src/main/java/org/totschnig/myexpenses/widget/AbstractListWidget.kt b/myExpenses/src/main/java/org/totschnig/myexpenses/widget/AbstractListWidget.kt
@@ -14,8 +14,6 @@ import org.totschnig.myexpenses.injector
 import org.totschnig.myexpenses.preference.PrefKey
 import timber.log.Timber
 
-
-const val WIDGET_CLICK = "org.totschnig.myexpenses.WIDGET_CLICK"
 const val KEY_CLICK_ACTION = "clickAction"
 const val WIDGET_CONTEXT_CHANGED = "org.totschnig.myexpenses.CONTEXT_CHANGED"
 const val EXTRA_START_FROM_WIDGET = "startFromWidget"
@@ -51,28 +49,15 @@ abstract class AbstractListWidget(
  val instance = AppWidgetManager.getInstance(context)
  val appWidgetIds = intent.extras?.getIntArray(AppWidgetManager.EXTRA_APPWIDGET_IDS)
  when (intent.action) {
- WIDGET_LIST_DATA_CHANGED -> {
+ WIDGET_LIST_DATA_CHANGED ->
  appWidgetIds?.let { instance.notifyAppWidgetViewDataChanged(it, R.id.list) }
- }
-
- WIDGET_CONTEXT_CHANGED -> {
- appWidgetIds?.let { onUpdate(context, instance, it) }
- }
 
- WIDGET_CLICK -> {
- handleWidgetClick(context, intent)
- }
+ WIDGET_CONTEXT_CHANGED -> appWidgetIds?.let { onUpdate(context, instance, it) }
 
- else -> {
- super.onReceive(context, intent)
- }
+ else -> super.onReceive(context, intent)
  }
  }
 
- abstract fun handleWidgetClick(context: Context, intent: Intent)
-
- fun clickBaseIntent(context: Context) = Intent(WIDGET_CLICK, null, context, javaClass)
-
  override suspend fun updateWidgetDo(
  context: Context,
  appWidgetManager: AppWidgetManager,

diff --git a/myExpenses/src/main/java/org/totschnig/myexpenses/widget/BaseWidget.kt b/myExpenses/src/main/java/org/totschnig/myexpenses/widget/BaseWidget.kt
@@ -4,6 +4,7 @@ import android.app.PendingIntent
 import android.appwidget.AppWidgetManager
 import android.appwidget.AppWidgetProvider
 import android.content.Context
+import android.content.Intent
 import android.content.res.Configuration
 import android.os.Bundle
 import android.widget.RemoteViews
@@ -22,6 +23,7 @@ import javax.inject.Inject
 
 class NoDataException(message: String) : Exception(message)
 
+const val WIDGET_CLICK = "org.totschnig.myexpenses.WIDGET_CLICK"
 const val WIDGET_LIST_DATA_CHANGED = "org.totschnig.myexpenses.LIST_DATA_CHANGED"
 
 abstract class BaseWidget(private val protectionKey: PrefKey) : AppWidgetProvider() {
@@ -38,6 +40,16 @@ abstract class BaseWidget(private val protectionKey: PrefKey) : AppWidgetProvide
  protected open fun isProtected(context: Context) = prefHandler.isProtected &&
  !prefHandler.getBoolean(protectionKey, false)
 
+
+ abstract fun handleWidgetClick(context: Context, intent: Intent)
+
+ fun clickBaseIntent(context: Context) = Intent(WIDGET_CLICK, null, context, javaClass)
+
+ override fun onReceive(context: Context, intent: Intent) {
+ if (intent.action == WIDGET_CLICK) handleWidgetClick(context, intent)
+ else super.onReceive(context, intent)
+ }
+
  override fun onAppWidgetOptionsChanged(
  context: Context,
  appWidgetManager: AppWidgetManager,