plans: make finished plans look differently (#132)

wfleischer · web-flow · commit 44ec61b2240b · 2024-11-26T00:13:43.000+01:00
diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml
@@ -33,7 +33,7 @@ jobs:
         run: "xcrun xctrace list devices"
       - name: Start simulator
         run: |
-          UDID=$(xcrun xctrace list devices | grep "^iPhone 15 Plus Simulator (18.1)" | awk '{gsub(/[()]/,""); print $NF}')
+          UDID=$(xcrun xctrace list devices | grep "^iPhone 15 Simulator (18.1)" | awk '{gsub(/[()]/,""); print $NF}')
           echo $UDID
           xcrun simctl boot "${UDID:?No Simulator with this name found}"
       - uses: actions/checkout@v3
diff --git a/integration_test/app_test.dart b/integration_test/app_test.dart
@@ -436,6 +436,11 @@ void main() async {
             .color,
         Colors.red);
 
+    await tester.scrollUntilVisible(
+      find.byKey(const Key('day-82')),
+      50.0,
+    );
+    await tester.pumpAndSettle();
     await tester.tap(find
         .descendant(
             of: find.byKey(const Key('day-83')),
@@ -550,6 +555,45 @@ void main() async {
     expect(find.byKey(const Key('target-status')), findsOneWidget);
   });
 
+  testWidgets('Plans showing if finished', (tester) async {
+    final providerContainer =
+        await SettledTester(tester, sharedPreferences: testPlansPreferences)
+            .providerContainer;
+    await tester.pumpAndSettle();
+
+    expect(find.byIcon(Icons.verified), findsOneWidget);
+
+    await tester.tap(find.byType(PlanCard).first);
+    await tester.pumpAndSettle();
+    await tester.scrollUntilVisible(
+      find.byKey(const Key('day-365')),
+      500.0,
+      maxScrolls: 200,
+    );
+    await tester.pumpAndSettle();
+    await Future<void>.delayed(Duration(seconds: 2));
+    await tester.tap(find
+        .descendant(
+            of: find.byKey(const Key('day-365')),
+            matching: find.byType(IconButton))
+        .last);
+    await tester.pumpAndSettle();
+    await tester.tap(find.byKey(const Key('confirm-toggle-read')));
+    await tester.pumpAndSettle();
+
+    expect(providerContainer.read(plansProvider).plans.first.bookmark.dayIndex,
+        366);
+    expect(providerContainer.read(plansProvider).plans.first.lastDate,
+        DateUtils.dateOnly(DateTime.now()));
+    expect(find.byIcon(Icons.check_circle), findsWidgets);
+    expect(find.byIcon(Icons.check_circle_outline), findsNothing);
+
+    await tester.pageBack();
+    await tester.pumpAndSettle();
+
+    expect(find.byIcon(Icons.verified), findsExactly(2));
+  });
+
   testWidgets('Bookmark button resets schedule view', (tester) async {
     await SettledTester(tester, sharedPreferences: testPlansPreferences)
         .providerContainer;
diff --git a/lib/src/plans/entities/plan.dart b/lib/src/plans/entities/plan.dart
@@ -7,7 +7,6 @@ import 'package:nwt_reading/src/schedules/entities/schedule.dart';
 final planProviderFamily =
     AutoDisposeNotifierProviderFamily<PlanNotifier, Plan, String>(
         PlanNotifier.new,
-        dependencies: [plansProvider],
         name: 'planProviderFamily');
 
 class PlanNotifier extends AutoDisposeFamilyNotifier<Plan, String> {
@@ -19,13 +18,14 @@ class PlanNotifier extends AutoDisposeFamilyNotifier<Plan, String> {
     final planId = arg;
 
     ref.watch(plansProvider);
-    plansNotifier = ref.read(plansProvider.notifier);
+    plansNotifier = ref.watch(plansProvider.notifier);
 
-    return plansNotifier!.getPlan(planId) ?? plansNotifier!.getNewPlan(planId);
-  }
+    final plan =
+        (plansNotifier!.getPlan(planId) ?? plansNotifier!.getNewPlan(planId));
+    schedule = ref.watch(scheduleProviderFamily(plan.scheduleKey)).valueOrNull;
 
-  Schedule? getSchedule() =>
-      ref.read(scheduleProviderFamily(state.scheduleKey)).valueOrNull;
+    return plan.copyWith();
+  }
 
   void delete() {
     plansNotifier?.removePlan(state.id);
@@ -48,7 +48,7 @@ class PlanNotifier extends AutoDisposeFamilyNotifier<Plan, String> {
 
   void setRead(
       {required int dayIndex, required int sectionIndex, bool force = false}) {
-    final sections = getSchedule()?.days[dayIndex].sections.length;
+    final sections = schedule?.days[dayIndex].sections.length;
     final newBookmark = sections != null && sectionIndex >= sections - 1
         ? Bookmark(dayIndex: dayIndex + 1, sectionIndex: -1)
         : Bookmark(dayIndex: dayIndex, sectionIndex: sectionIndex);
@@ -59,7 +59,7 @@ class PlanNotifier extends AutoDisposeFamilyNotifier<Plan, String> {
 
     plansNotifier?.updatePlan(state.copyWith(
       bookmark: newBookmark,
-      startDate: _getStartDate(newBookmark),
+      startDate: getStartDate(newBookmark),
       lastDate: DateUtils.dateOnly(DateTime.now()),
       targetDate: state.targetDate ?? calcTargetDate(newBookmark),
     ));
@@ -78,14 +78,17 @@ class PlanNotifier extends AutoDisposeFamilyNotifier<Plan, String> {
     }
   }
 
-  double getProgress() => getSchedule() == null
-      ? 0
-      : state.bookmark.dayIndex / getSchedule()!.length;
+  double getProgress() =>
+      schedule == null ? 0 : state.bookmark.dayIndex / schedule!.length;
 
   int getDeviationDays() {
-    if (state.withTargetDate && getTargetDate() != null) {
-      final deviationDays =
-          getTargetDate()!.difference(calcTargetDate()!).inDays;
+    final targetDate = getTargetDate();
+    final calculatedTargetDate = calcTargetDate();
+
+    if (state.withTargetDate &&
+        targetDate != null &&
+        calculatedTargetDate != null) {
+      final deviationDays = targetDate.difference(calculatedTargetDate).inDays;
 
       // If ahead, don't count the current day.
       return deviationDays <= 0 ? deviationDays : deviationDays - 1;
@@ -94,33 +97,34 @@ class PlanNotifier extends AutoDisposeFamilyNotifier<Plan, String> {
     }
   }
 
-  int getRemainingDays() => _getRemainingDays();
-
-  DateTime? getStartDate() => _getStartDate();
+  bool isFinished() => getRemainingDays() == 0;
 
   DateTime? getTargetDate() => state.targetDate ?? calcTargetDate();
 
-  DateTime? calcTargetDate([Bookmark? bookmark]) => state.withTargetDate
-      ? DateUtils.dateOnly(DateTime.now())
-          .add(Duration(days: _getRemainingDays(bookmark)))
-      : null;
+  DateTime? calcTargetDate([Bookmark? bookmark]) {
+    final remainingDays = getRemainingDays(bookmark);
+
+    return state.withTargetDate && remainingDays != null
+        ? DateUtils.dateOnly(DateTime.now()).add(Duration(days: remainingDays))
+        : null;
+  }
 
   int? todayTargetIndex() => state.withTargetDate &&
           getTargetDate() != null &&
-          getSchedule() != null
-      ? getSchedule()!.length -
+          schedule != null
+      ? schedule!.length -
           getTargetDate()!.difference(DateUtils.dateOnly(DateTime.now())).inDays
       : null;
 
-  DateTime? _getStartDate([Bookmark? bookmark]) => state.withTargetDate
+  DateTime? getStartDate([Bookmark? bookmark]) => state.withTargetDate
       ? state.startDate ??
           DateUtils.dateOnly(DateTime.now())
               .add(Duration(days: -(bookmark ?? state.bookmark).dayIndex))
       : null;
 
-  int _getRemainingDays([Bookmark? bookmark]) => getSchedule() == null
-      ? 0
-      : getSchedule()!.length - (bookmark ?? state.bookmark).dayIndex;
+  int? getRemainingDays([Bookmark? bookmark]) => schedule == null
+      ? null
+      : schedule!.length - (bookmark ?? state.bookmark).dayIndex;
 }
 
 class TogglingTooManyDaysException implements Exception {}
diff --git a/lib/src/plans/presentations/plan_card.dart b/lib/src/plans/presentations/plan_card.dart
@@ -16,63 +16,81 @@ class PlanCard extends ConsumerWidget {
     final planNotifier = ref.read(planProviderFamily(planId).notifier);
     final deviationDays = planNotifier.getDeviationDays();
     final remainingDays = planNotifier.getRemainingDays();
+    final isFinished = planNotifier.isFinished();
     final progress = planNotifier.getProgress();
     const planTypeIcons = {
       ScheduleType.chronological: Icons.hourglass_empty,
       ScheduleType.sequential: Icons.menu_book,
       ScheduleType.written: Icons.edit_note,
     };
 
+    buildNameTitle() => Row(children: [
+          Icon(
+            planTypeIcons[plan.scheduleKey.type],
+            color: Theme.of(context).colorScheme.surface,
+            size: 56,
+            shadows: [
+              Shadow(
+                  offset: Offset(-1, -1),
+                  color: Theme.of(context).colorScheme.primary,
+                  blurRadius: 2),
+              Shadow(
+                  offset: Offset(1, 1),
+                  color: Theme.of(context).colorScheme.onPrimary,
+                  blurRadius: 2)
+            ],
+          ),
+          Text(
+            plan.name,
+            style: Theme.of(context)
+                .textTheme
+                .headlineMedium
+                ?.copyWith(color: Theme.of(context).colorScheme.secondary),
+          )
+        ]);
+
+    buildYearText() => Text(
+          plan.lastDate == null
+              ? ''
+              : MaterialLocalizations.of(context).formatYear(plan.lastDate!),
+          style: TextStyle(
+              fontSize: 80, color: Theme.of(context).colorScheme.primary),
+        );
+
+    buildRemainingDaysStatus() => isFinished
+        ? Icon(Icons.verified, color: Colors.green, size: 72)
+        : Stack(alignment: Alignment.center, children: [
+            Text(
+                style:
+                    TextStyle(color: Theme.of(context).colorScheme.secondary),
+                remainingDays == null
+                    ? ''
+                    : AppLocalizations.of(context)
+                        .plansPageCardRemainingDays(remainingDays)),
+            SizedBox(
+                width: 60,
+                height: 60,
+                child:
+                    CircularProgressIndicator(strokeWidth: 6, value: progress)),
+          ]);
+
     final card = Card(
-        key: Key('plan-$planId'),
-        child: Stack(
-          children: [
-            Positioned(
-                left: 10,
-                top: 10,
-                child: Row(children: [
-                  Icon(
-                    planTypeIcons[plan.scheduleKey.type],
-                    color: Colors.black54,
-                    size: 56,
-                    shadows: const [
-                      Shadow(
-                          offset: Offset(-1, -1),
-                          color: Colors.black26,
-                          blurRadius: 2),
-                      Shadow(
-                          offset: Offset(1, 1),
-                          color: Colors.white,
-                          blurRadius: 2)
-                    ],
-                  ),
-                  Text(
-                    plan.name,
-                    style: Theme.of(context).textTheme.headlineMedium,
-                  )
-                ])),
-            Positioned(
-                right: 15,
-                bottom: 15,
-                child: Stack(alignment: Alignment.center, children: [
-                  Text(AppLocalizations.of(context)
-                      .plansPageCardRemainingDays(remainingDays)),
-                  SizedBox(
-                      width: 60,
-                      height: 60,
-                      child: CircularProgressIndicator(
-                        strokeWidth: 6,
-                        value: progress,
-                      ))
-                ])),
-          ],
-        ));
+      key: Key('plan-$planId'),
+      child: Stack(
+        children: [
+          Positioned(left: 10, top: 10, child: buildNameTitle()),
+          Positioned(right: 15, bottom: 15, child: buildRemainingDaysStatus()),
+          Positioned(left: 20, bottom: 0, child: buildYearText()),
+        ],
+      ),
+    );
+
     return GestureDetector(
         onTap: () {
           Navigator.restorablePushNamed(context, SchedulePage.routeName,
               arguments: planId);
         },
-        child: deviationDays == 0
+        child: deviationDays == 0 || isFinished
             ? card
             : Badge(
                 key: Key('badge-$planId'),
diff --git a/lib/src/theme.dart b/lib/src/theme.dart
@@ -1,35 +1,29 @@
 import 'package:flutter/material.dart';
 
+final seedColor = const Color(0xff007bff);
+
+final ColorScheme lightColorScheme = ColorScheme.fromSeed(seedColor: seedColor);
+final ColorScheme darkColorScheme =
+    ColorScheme.fromSeed(seedColor: seedColor, brightness: Brightness.dark);
+final CardTheme cardTheme = const CardTheme(
+  clipBehavior: Clip.antiAliasWithSaveLayer,
+  elevation: 10,
+  shape: RoundedRectangleBorder(
+      borderRadius: BorderRadius.all(Radius.circular(20.0))),
+);
+
 final lightTheme = ThemeData(
-  colorSchemeSeed: const Color(0xff007bff),
-  brightness: Brightness.light,
-  appBarTheme: const AppBarTheme(
-    actionsIconTheme: IconThemeData(color: Color(0xff007bff)),
-  ),
-  cardTheme: const CardTheme(
-    clipBehavior: Clip.antiAliasWithSaveLayer,
-    elevation: 10,
-    shape: RoundedRectangleBorder(
-        borderRadius: BorderRadius.all(Radius.circular(20.0))),
-  ),
-  progressIndicatorTheme: const ProgressIndicatorThemeData(
-    circularTrackColor: Colors.black12,
+  colorScheme: lightColorScheme,
+  cardTheme: cardTheme,
+  progressIndicatorTheme: ProgressIndicatorThemeData(
+    circularTrackColor: lightColorScheme.surfaceDim,
   ),
 );
 
 final darkTheme = ThemeData(
-  colorSchemeSeed: const Color(0xff007bff),
-  brightness: Brightness.dark,
-  appBarTheme: const AppBarTheme(
-    actionsIconTheme: IconThemeData(color: Color(0xff007bff)),
-  ),
-  cardTheme: const CardTheme(
-    clipBehavior: Clip.antiAliasWithSaveLayer,
-    elevation: 10,
-    shape: RoundedRectangleBorder(
-        borderRadius: BorderRadius.all(Radius.circular(20.0))),
-  ),
-  progressIndicatorTheme: const ProgressIndicatorThemeData(
-    circularTrackColor: Colors.black12,
+  colorScheme: darkColorScheme,
+  cardTheme: cardTheme,
+  progressIndicatorTheme: ProgressIndicatorThemeData(
+    circularTrackColor: darkColorScheme.surfaceDim,
   ),
 );
diff --git a/test/test_plans.dart b/test/test_plans.dart
@@ -5,7 +5,7 @@ import 'package:nwt_reading/src/schedules/entities/schedule.dart';
 const legacyExportPreferenceKey = 'legacyExport';
 const plansPreferenceKey = 'plans';
 
-final Plans testPlans = Plans(const [
+final Plans testPlans = Plans([
   Plan(
       id: '5aa4de9e-036b-42cd-8bcb-a92cae46db27',
       name: 'Chronological y1',
@@ -39,6 +39,7 @@ final Plans testPlans = Plans(const [
           version: '1.0'),
       language: 'ro',
       bookmark: Bookmark(dayIndex: 364, sectionIndex: 1),
+      lastDate: DateTime(2024, 11, 21),
       withTargetDate: true,
       showEvents: true,
       showLocations: true),
@@ -59,7 +60,7 @@ final Plans testPlans = Plans(const [
 const List<String> testPlansSerialized = [
   '{"id":"5aa4de9e-036b-42cd-8bcb-a92cae46db27","name":"Chronological y1","scheduleKey":{"type":0,"duration":2,"version":"1.0"},"language":"en","bookmark":{"dayIndex":75,"sectionIndex":0},"withTargetDate":true,"showEvents":true,"showLocations":true}',
   '{"id":"0da6b8a7-ccd4-4270-8058-9e30a3f55ceb","name":"Written","scheduleKey":{"type":2,"duration":2,"version":"1.0"},"language":"de","bookmark":{"dayIndex":0,"sectionIndex":-1},"withTargetDate":true,"showEvents":true,"showLocations":true}',
-  '{"id":"2dab49f3-aecf-4aba-9e91-d75c297d4b7e","name":"Sequential","scheduleKey":{"type":1,"duration":2,"version":"1.0"},"language":"ro","bookmark":{"dayIndex":364,"sectionIndex":1},"withTargetDate":true,"showEvents":true,"showLocations":true}',
+  '{"id":"2dab49f3-aecf-4aba-9e91-d75c297d4b7e","name":"Sequential","scheduleKey":{"type":1,"duration":2,"version":"1.0"},"language":"ro","bookmark":{"dayIndex":364,"sectionIndex":1},"lastDate":"2024-11-21T00:00:00.000","withTargetDate":true,"showEvents":true,"showLocations":true}',
   '{"id":"e37bf9df-077a-49db-adcb-d56384906103","name":"Chronological","scheduleKey":{"type":0,"duration":1,"version":"1.0"},"language":"en","bookmark":{"dayIndex":182,"sectionIndex":1},"withTargetDate":true,"showEvents":true,"showLocations":true}'
 ];
 
