firka/flutter
firka/flutter
4
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

fix: CupertinoDatePicker.DateAndTime using showDayOfWeek (#155260)

Browse Source 
As mentioned in the issue https://github.com/flutter/flutter/issues/153576, even if we declare the 'showDayOfWeek' value as false, when using the mode CupertinoDatePickerMode.dateAndTime, the days of week still shows in the screen.

This PR is about making an assert that prevent developers from using `DateTimePicker.DateAndTime` with `showDayOfWeek` as false (because it only works on date mode) as suggested by @Piinks.
This commit is contained in:
João Victor Schramm 2024-10-22 16:37:19 -03:00 committed by GitHub
parent 21814805c1
commit 1d5087eb30
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
2 changed files with 84 additions and 38 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

73
packages/flutter/lib/src/cupertino/date_picker.dart
View File

@ -301,43 +301,38 @@ class CupertinoDatePicker extends StatefulWidget {
this.itemExtent = _kItemExtent,
this.selectionOverlayBuilder,
}) : initialDateTime = initialDateTime ?? DateTime.now(),
assert(
itemExtent > 0,
'item extent should be greater than 0',
),
assert(
minuteInterval > 0 && 60 % minuteInterval == 0,
'minute interval is not a positive integer factor of 60',
) {
assert(
mode != CupertinoDatePickerMode.dateAndTime || minimumDate == null || !this.initialDateTime.isBefore(minimumDate!),
'initial date is before minimum date',
);
assert(
mode != CupertinoDatePickerMode.dateAndTime || maximumDate == null || !this.initialDateTime.isAfter(maximumDate!),
'initial date is after maximum date',
);
assert(
(mode != CupertinoDatePickerMode.date && mode != CupertinoDatePickerMode.monthYear) || (minimumYear >= 1 && this.initialDateTime.year >= minimumYear),
'initial year is not greater than minimum year, or minimum year is not positive',
);
assert(
(mode != CupertinoDatePickerMode.date && mode != CupertinoDatePickerMode.monthYear) || maximumYear == null || this.initialDateTime.year <= maximumYear!,
'initial year is not smaller than maximum year',
);
assert(
(mode != CupertinoDatePickerMode.date && mode != CupertinoDatePickerMode.monthYear) || minimumDate == null || !minimumDate!.isAfter(this.initialDateTime),
'initial date ${this.initialDateTime} is not greater than or equal to minimumDate $minimumDate',
);
assert(
(mode != CupertinoDatePickerMode.date && mode != CupertinoDatePickerMode.monthYear) || maximumDate == null || !maximumDate!.isBefore(this.initialDateTime),
'initial date ${this.initialDateTime} is not less than or equal to maximumDate $maximumDate',
);
assert(
this.initialDateTime.minute % minuteInterval == 0,
'initial minute is not divisible by minute interval',
);
}
assert(itemExtent > 0, 'item extent should be greater than 0'),
assert(minuteInterval > 0 && 60 % minuteInterval == 0, 'minute interval is not a positive integer factor of 60'),
assert(
mode != CupertinoDatePickerMode.dateAndTime || minimumDate == null || !(initialDateTime ?? DateTime.now()).isBefore(minimumDate),
'initial date is before minimum date',
),
assert(
mode != CupertinoDatePickerMode.dateAndTime || maximumDate == null || !(initialDateTime ?? DateTime.now()).isAfter(maximumDate),
'initial date is after maximum date',
),
assert(
(mode != CupertinoDatePickerMode.date && mode != CupertinoDatePickerMode.monthYear) || (minimumYear >= 1 && (initialDateTime ?? DateTime.now()).year >= minimumYear),
'initial year is not greater than minimum year, or minimum year is not positive',
),
assert(
(mode != CupertinoDatePickerMode.date && mode != CupertinoDatePickerMode.monthYear) || maximumYear == null || (initialDateTime ?? DateTime.now()).year <= maximumYear,
'initial year is not smaller than maximum year',
),
assert(
(mode != CupertinoDatePickerMode.date && mode != CupertinoDatePickerMode.monthYear) || minimumDate == null || !minimumDate.isAfter(initialDateTime ?? DateTime.now()),
'initial date ${initialDateTime ?? DateTime.now()} is not greater than or equal to minimumDate $minimumDate',
),
assert(
(mode != CupertinoDatePickerMode.date && mode != CupertinoDatePickerMode.monthYear) || maximumDate == null || !maximumDate.isBefore(initialDateTime ?? DateTime.now()),
'initial date ${initialDateTime ?? DateTime.now()} is not less than or equal to maximumDate $maximumDate',
),
assert(
(mode == CupertinoDatePickerMode.date) || !showDayOfWeek,
'showDayOfWeek is only supported in date mode',
),
assert((initialDateTime ?? DateTime.now()).minute % minuteInterval == 0, 'initial minute is not divisible by minute interval');
/// The mode of the date picker as one of [CupertinoDatePickerMode]. Defaults
/// to [CupertinoDatePickerMode.dateAndTime]. Value cannot change after
@ -414,7 +409,9 @@ class CupertinoDatePicker extends StatefulWidget {
/// Defaults to null, which disables background painting entirely.
final Color? backgroundColor;
/// Whether to show day of week alongside day. Defaults to false.
/// Whether to show the day of week alongside the day in [CupertinoDatePickerMode.date] mode.
///
/// Defaults to false.
final bool showDayOfWeek;
/// {@macro flutter.cupertino.picker.itemExtent}

49
packages/flutter/test/cupertino/date_picker_test.dart
View File

@ -261,6 +261,55 @@ void main() {
});
});
testWidgets('showDayOfWeek is only supported in date mode', (WidgetTester tester) async {
expect(
() => CupertinoDatePicker(
mode: CupertinoDatePickerMode.date,
onDateTimeChanged: (DateTime _) {},
showDayOfWeek: true,
),
returnsNormally,
);
expect(
() => CupertinoDatePicker(
mode: CupertinoDatePickerMode.time,
onDateTimeChanged: (DateTime _) {},
showDayOfWeek: true,
),
throwsA(isA<AssertionError>().having(
(AssertionError e) => e.message ?? 'Unknown error',
'message',
contains('showDayOfWeek is only supported in date mode'),
)),
);
expect(
() => CupertinoDatePicker(
mode: CupertinoDatePickerMode.monthYear,
onDateTimeChanged: (DateTime _) {},
showDayOfWeek: true,
),
throwsA(isA<AssertionError>().having(
(AssertionError e) => e.message ?? 'Unknown error',
'message',
contains('showDayOfWeek is only supported in date mode'),
)),
);
expect(
() => CupertinoDatePicker(
onDateTimeChanged: (DateTime _) {},
showDayOfWeek: true,
),
throwsA(isA<AssertionError>().having(
(AssertionError e) => e.message ?? 'Unknown error',
'message',
contains('showDayOfWeek is only supported in date mode'),
)),
);
});
testWidgets('picker honors minuteInterval and secondInterval', (WidgetTester tester) async {
late Duration duration;
await tester.pumpWidget(