mirror of
https://github.com/flutter/flutter.git
synced 2026-02-20 02:29:02 +08:00
WIP Commits separated as follows: - Update lints in analysis_options files - Run `dart fix --apply` - Clean up leftover analysis issues - Run `dart format .` in the right places. Local analysis and testing passes. Checking CI now. Part of https://github.com/flutter/flutter/issues/178827 - Adoption of flutter_lints in examples/api coming in a separate change (cc @loic-sharma) ## Pre-launch Checklist - [ ] I read the [Contributor Guide] and followed the process outlined there for submitting PRs. - [ ] I read the [Tree Hygiene] wiki page, which explains my responsibilities. - [ ] I read and followed the [Flutter Style Guide], including [Features we expect every widget to implement]. - [ ] I signed the [CLA]. - [ ] I listed at least one issue that this PR fixes in the description above. - [ ] I updated/added relevant documentation (doc comments with `///`). - [ ] I added new tests to check the change I am making, or this PR is [test-exempt]. - [ ] I followed the [breaking change policy] and added [Data Driven Fixes] where supported. - [ ] All existing and new tests are passing. If you need help, consider asking for advice on the #hackers-new channel on [Discord]. **Note**: The Flutter team is currently trialing the use of [Gemini Code Assist for GitHub](https://developers.google.com/gemini-code-assist/docs/review-github-code). Comments from the `gemini-code-assist` bot should not be taken as authoritative feedback from the Flutter team. If you find its comments useful you can update your code accordingly, but if you are unsure or disagree with the feedback, please feel free to wait for a Flutter team member's review for guidance on which automated comments should be addressed. <!-- Links --> [Contributor Guide]: https://github.com/flutter/flutter/blob/main/docs/contributing/Tree-hygiene.md#overview [Tree Hygiene]: https://github.com/flutter/flutter/blob/main/docs/contributing/Tree-hygiene.md [test-exempt]: https://github.com/flutter/flutter/blob/main/docs/contributing/Tree-hygiene.md#tests [Flutter Style Guide]: https://github.com/flutter/flutter/blob/main/docs/contributing/Style-guide-for-Flutter-repo.md [Features we expect every widget to implement]: https://github.com/flutter/flutter/blob/main/docs/contributing/Style-guide-for-Flutter-repo.md#features-we-expect-every-widget-to-implement [CLA]: https://cla.developers.google.com/ [flutter/tests]: https://github.com/flutter/tests [breaking change policy]: https://github.com/flutter/flutter/blob/main/docs/contributing/Tree-hygiene.md#handling-breaking-changes [Discord]: https://github.com/flutter/flutter/blob/main/docs/contributing/Chat.md [Data Driven Fixes]: https://github.com/flutter/flutter/blob/main/docs/contributing/Data-driven-Fixes.md
727 lines
26 KiB
Dart
727 lines
26 KiB
Dart
// Copyright 2014 The Flutter Authors. All rights reserved.
|
|
// Use of this source code is governed by a BSD-style license that can be
|
|
// found in the LICENSE file.
|
|
|
|
import 'package:flutter/widgets.dart';
|
|
import 'package:flutter_test/flutter_test.dart';
|
|
import 'package:leak_tracker_flutter_testing/leak_tracker_flutter_testing.dart';
|
|
|
|
void main() {
|
|
testWidgets('value is not accessible when not registered', (WidgetTester tester) async {
|
|
final numValue = RestorableNum<num>(0);
|
|
addTearDown(numValue.dispose);
|
|
expect(() => numValue.value, throwsAssertionError);
|
|
final doubleValue = RestorableDouble(1.0);
|
|
addTearDown(doubleValue.dispose);
|
|
expect(() => doubleValue.value, throwsAssertionError);
|
|
final intValue = RestorableInt(1);
|
|
addTearDown(intValue.dispose);
|
|
expect(() => intValue.value, throwsAssertionError);
|
|
final stringValue = RestorableString('hello');
|
|
addTearDown(stringValue.dispose);
|
|
expect(() => stringValue.value, throwsAssertionError);
|
|
final boolValue = RestorableBool(true);
|
|
addTearDown(boolValue.dispose);
|
|
expect(() => boolValue.value, throwsAssertionError);
|
|
final nullableNumValue = RestorableNumN<num?>(0);
|
|
addTearDown(nullableNumValue.dispose);
|
|
expect(() => nullableNumValue.value, throwsAssertionError);
|
|
final nullableDoubleValue = RestorableDoubleN(1.0);
|
|
addTearDown(nullableDoubleValue.dispose);
|
|
expect(() => nullableDoubleValue.value, throwsAssertionError);
|
|
final nullableIntValue = RestorableIntN(1);
|
|
addTearDown(nullableIntValue.dispose);
|
|
expect(() => nullableIntValue.value, throwsAssertionError);
|
|
final nullableStringValue = RestorableStringN('hello');
|
|
addTearDown(nullableStringValue.dispose);
|
|
expect(() => nullableStringValue.value, throwsAssertionError);
|
|
final nullableBoolValue = RestorableBoolN(true);
|
|
addTearDown(nullableBoolValue.dispose);
|
|
expect(() => nullableBoolValue.value, throwsAssertionError);
|
|
final controllerValue = RestorableTextEditingController();
|
|
addTearDown(controllerValue.dispose);
|
|
expect(() => controllerValue.value, throwsAssertionError);
|
|
final dateTimeValue = RestorableDateTime(DateTime(2020, 4, 3));
|
|
addTearDown(dateTimeValue.dispose);
|
|
expect(() => dateTimeValue.value, throwsAssertionError);
|
|
final nullableDateTimeValue = RestorableDateTimeN(DateTime(2020, 4, 3));
|
|
addTearDown(nullableDateTimeValue.dispose);
|
|
expect(() => nullableDateTimeValue.value, throwsAssertionError);
|
|
final nullableEnumValue = RestorableEnumN<TestEnum>(TestEnum.one, values: TestEnum.values);
|
|
addTearDown(nullableEnumValue.dispose);
|
|
expect(() => nullableEnumValue.value, throwsAssertionError);
|
|
final enumValue = RestorableEnum<TestEnum>(TestEnum.one, values: TestEnum.values);
|
|
addTearDown(enumValue.dispose);
|
|
expect(() => enumValue.value, throwsAssertionError);
|
|
final objectValue = _TestRestorableValue();
|
|
addTearDown(objectValue.dispose);
|
|
expect(() => objectValue.value, throwsAssertionError);
|
|
});
|
|
|
|
testWidgets('$RestorableProperty dispatches creation in constructor', (
|
|
WidgetTester widgetTester,
|
|
) async {
|
|
await expectLater(
|
|
await memoryEvents(() => RestorableDateTimeN(null).dispose(), RestorableDateTimeN),
|
|
areCreateAndDispose,
|
|
);
|
|
});
|
|
|
|
testWidgets('work when not in restoration scope', (WidgetTester tester) async {
|
|
await tester.pumpWidget(const _RestorableWidget());
|
|
|
|
expect(find.text('hello world'), findsOneWidget);
|
|
final _RestorableWidgetState state = tester.state(find.byType(_RestorableWidget));
|
|
|
|
// Initialized to default values.
|
|
expect(state.numValue.value, 99);
|
|
expect(state.doubleValue.value, 123.2);
|
|
expect(state.intValue.value, 42);
|
|
expect(state.stringValue.value, 'hello world');
|
|
expect(state.boolValue.value, false);
|
|
expect(state.dateTimeValue.value, DateTime(2021, 3, 16));
|
|
expect(state.enumValue.value, TestEnum.one);
|
|
expect(state.nullableNumValue.value, null);
|
|
expect(state.nullableDoubleValue.value, null);
|
|
expect(state.nullableIntValue.value, null);
|
|
expect(state.nullableStringValue.value, null);
|
|
expect(state.nullableBoolValue.value, null);
|
|
expect(state.nullableDateTimeValue.value, null);
|
|
expect(state.nullableEnumValue.value, null);
|
|
expect(state.controllerValue.value.text, 'FooBar');
|
|
expect(state.objectValue.value, 55);
|
|
|
|
// Modify values.
|
|
state.setProperties(() {
|
|
state.numValue.value = 42.2;
|
|
state.doubleValue.value = 441.3;
|
|
state.intValue.value = 10;
|
|
state.stringValue.value = 'guten tag';
|
|
state.boolValue.value = true;
|
|
state.dateTimeValue.value = DateTime(2020, 7, 4);
|
|
state.enumValue.value = TestEnum.two;
|
|
state.nullableNumValue.value = 5.0;
|
|
state.nullableDoubleValue.value = 2.0;
|
|
state.nullableIntValue.value = 1;
|
|
state.nullableStringValue.value = 'hullo';
|
|
state.nullableBoolValue.value = false;
|
|
state.nullableDateTimeValue.value = DateTime(2020, 4, 4);
|
|
state.nullableEnumValue.value = TestEnum.three;
|
|
state.controllerValue.value.text = 'blabla';
|
|
state.objectValue.value = 53;
|
|
});
|
|
await tester.pump();
|
|
|
|
expect(state.numValue.value, 42.2);
|
|
expect(state.doubleValue.value, 441.3);
|
|
expect(state.intValue.value, 10);
|
|
expect(state.stringValue.value, 'guten tag');
|
|
expect(state.boolValue.value, true);
|
|
expect(state.dateTimeValue.value, DateTime(2020, 7, 4));
|
|
expect(state.enumValue.value, TestEnum.two);
|
|
expect(state.nullableNumValue.value, 5.0);
|
|
expect(state.nullableDoubleValue.value, 2.0);
|
|
expect(state.nullableIntValue.value, 1);
|
|
expect(state.nullableStringValue.value, 'hullo');
|
|
expect(state.nullableBoolValue.value, false);
|
|
expect(state.nullableDateTimeValue.value, DateTime(2020, 4, 4));
|
|
expect(state.nullableEnumValue.value, TestEnum.three);
|
|
expect(state.controllerValue.value.text, 'blabla');
|
|
expect(state.objectValue.value, 53);
|
|
expect(find.text('guten tag'), findsOneWidget);
|
|
});
|
|
|
|
testWidgets('restart and restore', (WidgetTester tester) async {
|
|
await tester.pumpWidget(
|
|
const RootRestorationScope(restorationId: 'root-child', child: _RestorableWidget()),
|
|
);
|
|
|
|
expect(find.text('hello world'), findsOneWidget);
|
|
_RestorableWidgetState state = tester.state(find.byType(_RestorableWidget));
|
|
|
|
// Initialized to default values.
|
|
expect(state.numValue.value, 99);
|
|
expect(state.doubleValue.value, 123.2);
|
|
expect(state.intValue.value, 42);
|
|
expect(state.stringValue.value, 'hello world');
|
|
expect(state.boolValue.value, false);
|
|
expect(state.dateTimeValue.value, DateTime(2021, 3, 16));
|
|
expect(state.enumValue.value, TestEnum.one);
|
|
expect(state.nullableNumValue.value, null);
|
|
expect(state.nullableDoubleValue.value, null);
|
|
expect(state.nullableIntValue.value, null);
|
|
expect(state.nullableStringValue.value, null);
|
|
expect(state.nullableBoolValue.value, null);
|
|
expect(state.nullableDateTimeValue.value, null);
|
|
expect(state.nullableEnumValue.value, null);
|
|
expect(state.controllerValue.value.text, 'FooBar');
|
|
expect(state.objectValue.value, 55);
|
|
|
|
// Modify values.
|
|
state.setProperties(() {
|
|
state.numValue.value = 42.2;
|
|
state.doubleValue.value = 441.3;
|
|
state.intValue.value = 10;
|
|
state.stringValue.value = 'guten tag';
|
|
state.boolValue.value = true;
|
|
state.dateTimeValue.value = DateTime(2020, 7, 4);
|
|
state.enumValue.value = TestEnum.two;
|
|
state.nullableNumValue.value = 5.0;
|
|
state.nullableDoubleValue.value = 2.0;
|
|
state.nullableIntValue.value = 1;
|
|
state.nullableStringValue.value = 'hullo';
|
|
state.nullableBoolValue.value = false;
|
|
state.nullableDateTimeValue.value = DateTime(2020, 4, 4);
|
|
state.nullableEnumValue.value = TestEnum.three;
|
|
state.controllerValue.value.text = 'blabla';
|
|
state.objectValue.value = 53;
|
|
});
|
|
await tester.pump();
|
|
|
|
expect(state.numValue.value, 42.2);
|
|
expect(state.doubleValue.value, 441.3);
|
|
expect(state.intValue.value, 10);
|
|
expect(state.stringValue.value, 'guten tag');
|
|
expect(state.boolValue.value, true);
|
|
expect(state.dateTimeValue.value, DateTime(2020, 7, 4));
|
|
expect(state.enumValue.value, TestEnum.two);
|
|
expect(state.nullableNumValue.value, 5.0);
|
|
expect(state.nullableDoubleValue.value, 2.0);
|
|
expect(state.nullableIntValue.value, 1);
|
|
expect(state.nullableStringValue.value, 'hullo');
|
|
expect(state.nullableBoolValue.value, false);
|
|
expect(state.nullableDateTimeValue.value, DateTime(2020, 4, 4));
|
|
expect(state.nullableEnumValue.value, TestEnum.three);
|
|
expect(state.controllerValue.value.text, 'blabla');
|
|
expect(state.objectValue.value, 53);
|
|
expect(find.text('guten tag'), findsOneWidget);
|
|
|
|
// Restores to previous values.
|
|
await tester.restartAndRestore();
|
|
final oldState = state;
|
|
state = tester.state(find.byType(_RestorableWidget));
|
|
expect(state, isNot(same(oldState)));
|
|
|
|
expect(state.numValue.value, 42.2);
|
|
expect(state.doubleValue.value, 441.3);
|
|
expect(state.intValue.value, 10);
|
|
expect(state.stringValue.value, 'guten tag');
|
|
expect(state.boolValue.value, true);
|
|
expect(state.dateTimeValue.value, DateTime(2020, 7, 4));
|
|
expect(state.enumValue.value, TestEnum.two);
|
|
expect(state.nullableNumValue.value, 5.0);
|
|
expect(state.nullableDoubleValue.value, 2.0);
|
|
expect(state.nullableIntValue.value, 1);
|
|
expect(state.nullableStringValue.value, 'hullo');
|
|
expect(state.nullableBoolValue.value, false);
|
|
expect(state.nullableDateTimeValue.value, DateTime(2020, 4, 4));
|
|
expect(state.nullableEnumValue.value, TestEnum.three);
|
|
expect(state.controllerValue.value.text, 'blabla');
|
|
expect(state.objectValue.value, 53);
|
|
expect(find.text('guten tag'), findsOneWidget);
|
|
});
|
|
|
|
testWidgets('restore to older state', (WidgetTester tester) async {
|
|
await tester.pumpWidget(
|
|
const RootRestorationScope(restorationId: 'root-child', child: _RestorableWidget()),
|
|
);
|
|
|
|
expect(find.text('hello world'), findsOneWidget);
|
|
final _RestorableWidgetState state = tester.state(find.byType(_RestorableWidget));
|
|
|
|
// Modify values.
|
|
state.setProperties(() {
|
|
state.numValue.value = 42.2;
|
|
state.doubleValue.value = 441.3;
|
|
state.intValue.value = 10;
|
|
state.stringValue.value = 'guten tag';
|
|
state.boolValue.value = true;
|
|
state.dateTimeValue.value = DateTime(2020, 7, 4);
|
|
state.enumValue.value = TestEnum.two;
|
|
state.nullableNumValue.value = 5.0;
|
|
state.nullableDoubleValue.value = 2.0;
|
|
state.nullableIntValue.value = 1;
|
|
state.nullableStringValue.value = 'hullo';
|
|
state.nullableBoolValue.value = false;
|
|
state.nullableDateTimeValue.value = DateTime(2020, 4, 4);
|
|
state.nullableEnumValue.value = TestEnum.three;
|
|
state.controllerValue.value.text = 'blabla';
|
|
state.objectValue.value = 53;
|
|
});
|
|
await tester.pump();
|
|
expect(find.text('guten tag'), findsOneWidget);
|
|
|
|
final TestRestorationData restorationData = await tester.getRestorationData();
|
|
|
|
// Modify values.
|
|
state.setProperties(() {
|
|
state.numValue.value = 20;
|
|
state.doubleValue.value = 20.0;
|
|
state.intValue.value = 20;
|
|
state.stringValue.value = 'ciao';
|
|
state.boolValue.value = false;
|
|
state.dateTimeValue.value = DateTime(2020, 3, 2);
|
|
state.enumValue.value = TestEnum.four;
|
|
state.nullableNumValue.value = 20.0;
|
|
state.nullableDoubleValue.value = 20.0;
|
|
state.nullableIntValue.value = 20;
|
|
state.nullableStringValue.value = 'ni hao';
|
|
state.nullableBoolValue.value = null;
|
|
state.nullableDateTimeValue.value = DateTime(2020, 5, 5);
|
|
state.nullableEnumValue.value = TestEnum.two;
|
|
state.controllerValue.value.text = 'blub';
|
|
state.objectValue.value = 20;
|
|
});
|
|
await tester.pump();
|
|
expect(find.text('ciao'), findsOneWidget);
|
|
final TextEditingController controller = state.controllerValue.value;
|
|
|
|
// Restore to previous.
|
|
await tester.restoreFrom(restorationData);
|
|
expect(state.numValue.value, 42.2);
|
|
expect(state.doubleValue.value, 441.3);
|
|
expect(state.intValue.value, 10);
|
|
expect(state.stringValue.value, 'guten tag');
|
|
expect(state.boolValue.value, true);
|
|
expect(state.dateTimeValue.value, DateTime(2020, 7, 4));
|
|
expect(state.enumValue.value, TestEnum.two);
|
|
expect(state.nullableNumValue.value, 5.0);
|
|
expect(state.nullableDoubleValue.value, 2.0);
|
|
expect(state.nullableIntValue.value, 1);
|
|
expect(state.nullableStringValue.value, 'hullo');
|
|
expect(state.nullableBoolValue.value, false);
|
|
expect(state.nullableDateTimeValue.value, DateTime(2020, 4, 4));
|
|
expect(state.nullableEnumValue.value, TestEnum.three);
|
|
expect(state.controllerValue.value.text, 'blabla');
|
|
expect(state.objectValue.value, 53);
|
|
expect(find.text('guten tag'), findsOneWidget);
|
|
expect(state.controllerValue.value, isNot(same(controller)));
|
|
|
|
// Restore to empty data will re-initialize to default values.
|
|
await tester.restoreFrom(TestRestorationData.empty);
|
|
expect(state.numValue.value, 99);
|
|
expect(state.doubleValue.value, 123.2);
|
|
expect(state.intValue.value, 42);
|
|
expect(state.stringValue.value, 'hello world');
|
|
expect(state.boolValue.value, false);
|
|
expect(state.dateTimeValue.value, DateTime(2021, 3, 16));
|
|
expect(state.enumValue.value, TestEnum.one);
|
|
expect(state.nullableNumValue.value, null);
|
|
expect(state.nullableDoubleValue.value, null);
|
|
expect(state.nullableIntValue.value, null);
|
|
expect(state.nullableStringValue.value, null);
|
|
expect(state.nullableBoolValue.value, null);
|
|
expect(state.nullableDateTimeValue.value, null);
|
|
expect(state.nullableEnumValue.value, null);
|
|
expect(state.controllerValue.value.text, 'FooBar');
|
|
expect(state.objectValue.value, 55);
|
|
expect(find.text('hello world'), findsOneWidget);
|
|
});
|
|
|
|
testWidgets('call notifiers when value changes', (WidgetTester tester) async {
|
|
await tester.pumpWidget(
|
|
const RootRestorationScope(restorationId: 'root-child', child: _RestorableWidget()),
|
|
);
|
|
|
|
expect(find.text('hello world'), findsOneWidget);
|
|
final _RestorableWidgetState state = tester.state(find.byType(_RestorableWidget));
|
|
|
|
final notifyLog = <String>[];
|
|
|
|
state.numValue.addListener(() {
|
|
notifyLog.add('num');
|
|
});
|
|
state.doubleValue.addListener(() {
|
|
notifyLog.add('double');
|
|
});
|
|
state.intValue.addListener(() {
|
|
notifyLog.add('int');
|
|
});
|
|
state.stringValue.addListener(() {
|
|
notifyLog.add('string');
|
|
});
|
|
state.boolValue.addListener(() {
|
|
notifyLog.add('bool');
|
|
});
|
|
state.dateTimeValue.addListener(() {
|
|
notifyLog.add('date-time');
|
|
});
|
|
state.enumValue.addListener(() {
|
|
notifyLog.add('enum');
|
|
});
|
|
state.nullableNumValue.addListener(() {
|
|
notifyLog.add('nullable-num');
|
|
});
|
|
state.nullableDoubleValue.addListener(() {
|
|
notifyLog.add('nullable-double');
|
|
});
|
|
state.nullableIntValue.addListener(() {
|
|
notifyLog.add('nullable-int');
|
|
});
|
|
state.nullableStringValue.addListener(() {
|
|
notifyLog.add('nullable-string');
|
|
});
|
|
state.nullableBoolValue.addListener(() {
|
|
notifyLog.add('nullable-bool');
|
|
});
|
|
state.nullableDateTimeValue.addListener(() {
|
|
notifyLog.add('nullable-date-time');
|
|
});
|
|
state.nullableEnumValue.addListener(() {
|
|
notifyLog.add('nullable-enum');
|
|
});
|
|
state.controllerValue.addListener(() {
|
|
notifyLog.add('controller');
|
|
});
|
|
state.objectValue.addListener(() {
|
|
notifyLog.add('object');
|
|
});
|
|
|
|
state.setProperties(() {
|
|
state.numValue.value = 42.2;
|
|
});
|
|
expect(notifyLog.single, 'num');
|
|
notifyLog.clear();
|
|
|
|
state.setProperties(() {
|
|
state.doubleValue.value = 42.2;
|
|
});
|
|
expect(notifyLog.single, 'double');
|
|
notifyLog.clear();
|
|
|
|
state.setProperties(() {
|
|
state.intValue.value = 45;
|
|
});
|
|
expect(notifyLog.single, 'int');
|
|
notifyLog.clear();
|
|
|
|
state.setProperties(() {
|
|
state.stringValue.value = 'bar';
|
|
});
|
|
expect(notifyLog.single, 'string');
|
|
notifyLog.clear();
|
|
|
|
state.setProperties(() {
|
|
state.boolValue.value = true;
|
|
});
|
|
expect(notifyLog.single, 'bool');
|
|
notifyLog.clear();
|
|
|
|
state.setProperties(() {
|
|
state.dateTimeValue.value = DateTime(2020, 7, 4);
|
|
});
|
|
expect(notifyLog.single, 'date-time');
|
|
notifyLog.clear();
|
|
|
|
state.setProperties(() {
|
|
state.enumValue.value = TestEnum.two;
|
|
});
|
|
expect(notifyLog.single, 'enum');
|
|
notifyLog.clear();
|
|
|
|
state.setProperties(() {
|
|
state.nullableNumValue.value = 42.2;
|
|
});
|
|
expect(notifyLog.single, 'nullable-num');
|
|
notifyLog.clear();
|
|
|
|
state.setProperties(() {
|
|
state.nullableDoubleValue.value = 42.2;
|
|
});
|
|
expect(notifyLog.single, 'nullable-double');
|
|
notifyLog.clear();
|
|
|
|
state.setProperties(() {
|
|
state.nullableIntValue.value = 45;
|
|
});
|
|
expect(notifyLog.single, 'nullable-int');
|
|
notifyLog.clear();
|
|
|
|
state.setProperties(() {
|
|
state.nullableStringValue.value = 'bar';
|
|
});
|
|
expect(notifyLog.single, 'nullable-string');
|
|
notifyLog.clear();
|
|
|
|
state.setProperties(() {
|
|
state.nullableBoolValue.value = true;
|
|
});
|
|
expect(notifyLog.single, 'nullable-bool');
|
|
notifyLog.clear();
|
|
|
|
state.setProperties(() {
|
|
state.nullableDateTimeValue.value = DateTime(2020, 4, 4);
|
|
});
|
|
expect(notifyLog.single, 'nullable-date-time');
|
|
notifyLog.clear();
|
|
|
|
state.setProperties(() {
|
|
state.nullableEnumValue.value = TestEnum.three;
|
|
});
|
|
expect(notifyLog.single, 'nullable-enum');
|
|
notifyLog.clear();
|
|
|
|
state.setProperties(() {
|
|
state.controllerValue.value.text = 'foo';
|
|
});
|
|
expect(notifyLog.single, 'controller');
|
|
notifyLog.clear();
|
|
|
|
state.setProperties(() {
|
|
state.objectValue.value = 42;
|
|
});
|
|
expect(notifyLog.single, 'object');
|
|
notifyLog.clear();
|
|
|
|
await tester.pump();
|
|
expect(find.text('bar'), findsOneWidget);
|
|
|
|
// Does not notify when set to same value.
|
|
state.setProperties(() {
|
|
state.numValue.value = 42.2;
|
|
state.doubleValue.value = 42.2;
|
|
state.intValue.value = 45;
|
|
state.stringValue.value = 'bar';
|
|
state.boolValue.value = true;
|
|
state.dateTimeValue.value = DateTime(2020, 7, 4);
|
|
state.enumValue.value = TestEnum.two;
|
|
state.nullableNumValue.value = 42.2;
|
|
state.nullableDoubleValue.value = 42.2;
|
|
state.nullableIntValue.value = 45;
|
|
state.nullableStringValue.value = 'bar';
|
|
state.nullableBoolValue.value = true;
|
|
state.nullableDateTimeValue.value = DateTime(2020, 4, 4);
|
|
state.nullableEnumValue.value = TestEnum.three;
|
|
state.controllerValue.value.text = 'foo';
|
|
state.objectValue.value = 42;
|
|
});
|
|
|
|
expect(notifyLog, isEmpty);
|
|
});
|
|
|
|
testWidgets('RestorableValue calls didUpdateValue', (WidgetTester tester) async {
|
|
await tester.pumpWidget(
|
|
const RootRestorationScope(restorationId: 'root-child', child: _RestorableWidget()),
|
|
);
|
|
|
|
expect(find.text('hello world'), findsOneWidget);
|
|
final _RestorableWidgetState state = tester.state(find.byType(_RestorableWidget));
|
|
|
|
expect(state.objectValue.didUpdateValueCallCount, 0);
|
|
|
|
state.setProperties(() {
|
|
state.objectValue.value = 44;
|
|
});
|
|
expect(state.objectValue.didUpdateValueCallCount, 1);
|
|
|
|
await tester.pump();
|
|
|
|
state.setProperties(() {
|
|
state.objectValue.value = 44;
|
|
});
|
|
expect(state.objectValue.didUpdateValueCallCount, 1);
|
|
});
|
|
|
|
testWidgets('RestorableEnum and RestorableEnumN assert if default value is not in enum', (
|
|
WidgetTester tester,
|
|
) async {
|
|
expect(
|
|
() => RestorableEnum<TestEnum>(
|
|
TestEnum.four,
|
|
values: TestEnum.values.toSet().difference(<TestEnum>{TestEnum.four}),
|
|
),
|
|
throwsAssertionError,
|
|
);
|
|
expect(
|
|
() => RestorableEnumN<TestEnum>(
|
|
TestEnum.four,
|
|
values: TestEnum.values.toSet().difference(<TestEnum>{TestEnum.four}),
|
|
),
|
|
throwsAssertionError,
|
|
);
|
|
});
|
|
|
|
testWidgets('RestorableEnum and RestorableEnumN assert if unknown values are set', (
|
|
WidgetTester tester,
|
|
) async {
|
|
final enumMissingValue = RestorableEnum<TestEnum>(
|
|
TestEnum.one,
|
|
values: TestEnum.values.toSet().difference(<TestEnum>{TestEnum.four}),
|
|
);
|
|
addTearDown(enumMissingValue.dispose);
|
|
expect(() => enumMissingValue.value = TestEnum.four, throwsAssertionError);
|
|
final nullableEnumMissingValue = RestorableEnumN<TestEnum>(
|
|
null,
|
|
values: TestEnum.values.toSet().difference(<TestEnum>{TestEnum.four}),
|
|
);
|
|
addTearDown(nullableEnumMissingValue.dispose);
|
|
expect(() => nullableEnumMissingValue.value = TestEnum.four, throwsAssertionError);
|
|
});
|
|
|
|
testWidgets('RestorableEnum and RestorableEnumN assert if unknown values are restored', (
|
|
WidgetTester tester,
|
|
) async {
|
|
final enumMissingValue = RestorableEnum<TestEnum>(
|
|
TestEnum.one,
|
|
values: TestEnum.values.toSet().difference(<TestEnum>{TestEnum.four}),
|
|
);
|
|
addTearDown(enumMissingValue.dispose);
|
|
expect(() => enumMissingValue.fromPrimitives('four'), throwsAssertionError);
|
|
final nullableEnumMissingValue = RestorableEnumN<TestEnum>(
|
|
null,
|
|
values: TestEnum.values.toSet().difference(<TestEnum>{TestEnum.four}),
|
|
);
|
|
addTearDown(nullableEnumMissingValue.dispose);
|
|
expect(() => nullableEnumMissingValue.fromPrimitives('four'), throwsAssertionError);
|
|
});
|
|
|
|
testWidgets('RestorableN types are properly defined', (WidgetTester tester) async {
|
|
await tester.pumpWidget(
|
|
const RootRestorationScope(restorationId: 'root-child', child: _RestorableWidget()),
|
|
);
|
|
|
|
expect(find.text('hello world'), findsOneWidget);
|
|
final _RestorableWidgetState state = tester.state(find.byType(_RestorableWidget));
|
|
state.setProperties(() {
|
|
state.nullableIntValue.value = 24;
|
|
state.nullableDoubleValue.value = 1.5;
|
|
});
|
|
|
|
// The following types of asserts do not work. They pass even when the
|
|
// type of `value` is a `num` and not an `int` because `num` is a
|
|
// superclass of `int`. This test is intended to prevent a regression
|
|
// where RestorableIntN's value is of type `num?`, but it is passed into
|
|
// a function which requires an `int?` value. This resulted in Dart
|
|
// compile-time errors.
|
|
//
|
|
// expect(state.nullableIntValue.value, isA<int>());
|
|
// expect(state.nullableIntValue.value.runtimeType, int);
|
|
|
|
// A function that takes a nullable int value.
|
|
void takesInt(int? value) {}
|
|
// The following would result in a Dart compile-time error if `value` is
|
|
// a `num?` instead of an `int?`.
|
|
takesInt(state.nullableIntValue.value);
|
|
|
|
// A function that takes a nullable double value.
|
|
void takesDouble(double? value) {}
|
|
// The following would result in a Dart compile-time error if `value` is
|
|
// a `num?` instead of a `double?`.
|
|
takesDouble(state.nullableDoubleValue.value);
|
|
});
|
|
}
|
|
|
|
class _TestRestorableValue extends RestorableValue<Object?> {
|
|
@override
|
|
Object createDefaultValue() {
|
|
return 55;
|
|
}
|
|
|
|
int didUpdateValueCallCount = 0;
|
|
|
|
@override
|
|
void didUpdateValue(Object? oldValue) {
|
|
didUpdateValueCallCount++;
|
|
notifyListeners();
|
|
}
|
|
|
|
@override
|
|
Object? fromPrimitives(Object? data) {
|
|
return data;
|
|
}
|
|
|
|
@override
|
|
Object? toPrimitives() {
|
|
return value;
|
|
}
|
|
}
|
|
|
|
class _RestorableWidget extends StatefulWidget {
|
|
const _RestorableWidget();
|
|
|
|
@override
|
|
State<_RestorableWidget> createState() => _RestorableWidgetState();
|
|
}
|
|
|
|
class _RestorableWidgetState extends State<_RestorableWidget> with RestorationMixin {
|
|
final RestorableNum<num> numValue = RestorableNum<num>(99);
|
|
final RestorableDouble doubleValue = RestorableDouble(123.2);
|
|
final RestorableInt intValue = RestorableInt(42);
|
|
final RestorableString stringValue = RestorableString('hello world');
|
|
final RestorableBool boolValue = RestorableBool(false);
|
|
final RestorableDateTime dateTimeValue = RestorableDateTime(DateTime(2021, 3, 16));
|
|
final RestorableEnum<TestEnum> enumValue = RestorableEnum<TestEnum>(
|
|
TestEnum.one,
|
|
values: TestEnum.values,
|
|
);
|
|
final RestorableNumN<num?> nullableNumValue = RestorableNumN<num?>(null);
|
|
final RestorableDoubleN nullableDoubleValue = RestorableDoubleN(null);
|
|
final RestorableIntN nullableIntValue = RestorableIntN(null);
|
|
final RestorableStringN nullableStringValue = RestorableStringN(null);
|
|
final RestorableBoolN nullableBoolValue = RestorableBoolN(null);
|
|
final RestorableDateTimeN nullableDateTimeValue = RestorableDateTimeN(null);
|
|
final RestorableEnumN<TestEnum> nullableEnumValue = RestorableEnumN<TestEnum>(
|
|
null,
|
|
values: TestEnum.values,
|
|
);
|
|
final RestorableTextEditingController controllerValue = RestorableTextEditingController(
|
|
text: 'FooBar',
|
|
);
|
|
final _TestRestorableValue objectValue = _TestRestorableValue();
|
|
|
|
@override
|
|
void restoreState(RestorationBucket? oldBucket, bool initialRestore) {
|
|
registerForRestoration(numValue, 'num');
|
|
registerForRestoration(doubleValue, 'double');
|
|
registerForRestoration(intValue, 'int');
|
|
registerForRestoration(stringValue, 'string');
|
|
registerForRestoration(boolValue, 'bool');
|
|
registerForRestoration(dateTimeValue, 'dateTime');
|
|
registerForRestoration(enumValue, 'enum');
|
|
registerForRestoration(nullableNumValue, 'nullableNum');
|
|
registerForRestoration(nullableDoubleValue, 'nullableDouble');
|
|
registerForRestoration(nullableIntValue, 'nullableInt');
|
|
registerForRestoration(nullableStringValue, 'nullableString');
|
|
registerForRestoration(nullableBoolValue, 'nullableBool');
|
|
registerForRestoration(nullableDateTimeValue, 'nullableDateTime');
|
|
registerForRestoration(nullableEnumValue, 'nullableEnum');
|
|
registerForRestoration(controllerValue, 'controller');
|
|
registerForRestoration(objectValue, 'object');
|
|
}
|
|
|
|
@override
|
|
void dispose() {
|
|
numValue.dispose();
|
|
doubleValue.dispose();
|
|
intValue.dispose();
|
|
stringValue.dispose();
|
|
boolValue.dispose();
|
|
dateTimeValue.dispose();
|
|
enumValue.dispose();
|
|
nullableNumValue.dispose();
|
|
nullableDoubleValue.dispose();
|
|
nullableIntValue.dispose();
|
|
nullableStringValue.dispose();
|
|
nullableBoolValue.dispose();
|
|
nullableDateTimeValue.dispose();
|
|
nullableEnumValue.dispose();
|
|
controllerValue.dispose();
|
|
objectValue.dispose();
|
|
super.dispose();
|
|
}
|
|
|
|
void setProperties(VoidCallback callback) {
|
|
setState(callback);
|
|
}
|
|
|
|
@override
|
|
Widget build(BuildContext context) {
|
|
return Text(stringValue.value, textDirection: TextDirection.ltr);
|
|
}
|
|
|
|
@override
|
|
String get restorationId => 'widget';
|
|
}
|
|
|
|
enum TestEnum { one, two, three, four }
|