binding [nfc]: Rename ZulipBinding from DataBinding

We'll need some more bindings in this spirit.  It's not clear there'll
be enough of them that we need to split them into mixins across
multiple files, like Flutter upstream does, so we'll try just putting
them all in a single bindings class.  Start by giving that one class a
more generic name to fit.

Author: gnprice

lib/main.dart

@@ -12,6 +12,6 @@ void main() {
     return true;
   }());
   LicenseRegistry.addLicense(additionalLicenses);
-  LiveDataBinding.ensureInitialized();
+  LiveZulipBinding.ensureInitialized();
   runApp(const ZulipApp());
 }

lib/model/binding.dart

@@ -18,27 +18,27 @@ import 'store.dart';
 /// [TestWidgetsFlutterBinding].
 /// This version is simplified because we don't (yet?) have enough complexity
 /// to put into these bindings to need to use mixins to split them up.
-abstract class DataBinding {
-  DataBinding() {
+abstract class ZulipBinding {
+  ZulipBinding() {
     assert(_instance == null);
     initInstance();
   }
 
-  /// The single instance of [DataBinding].
-  static DataBinding get instance => checkInstance(_instance);
-  static DataBinding? _instance;
+  /// The single instance of [ZulipBinding].
+  static ZulipBinding get instance => checkInstance(_instance);
+  static ZulipBinding? _instance;
 
-  static T checkInstance<T extends DataBinding>(T? instance) {
+  static T checkInstance<T extends ZulipBinding>(T? instance) {
     assert(() {
       if (instance == null) {
         throw FlutterError.fromParts([
           ErrorSummary('Zulip binding has not yet been initialized.'),
           ErrorHint(
-            'In the app, this is done by the `LiveDataBinding.ensureInitialized()` call '
+            'In the app, this is done by the `LiveZulipBinding.ensureInitialized()` call '
             'in the `void main()` method.',
           ),
           ErrorHint(
-            'In a test, one can call `TestDataBinding.ensureInitialized()` as the '
+            'In a test, one can call `TestZulipBinding.ensureInitialized()` as the '
             'first line in the test\'s `main()` method to initialize the binding.',
           ),
         ]);
@@ -69,13 +69,13 @@ abstract class DataBinding {
 /// The global store returned by [loadGlobalStore], and consequently by
 /// [GlobalStoreWidget.of] in application code, will be a [LiveGlobalStore].
 /// It therefore uses a live server and live, persistent local database.
-class LiveDataBinding extends DataBinding {
-  /// Initialize the binding if necessary, and ensure it is a [LiveDataBinding].
-  static LiveDataBinding ensureInitialized() {
-    if (DataBinding._instance == null) {
-      LiveDataBinding();
+class LiveZulipBinding extends ZulipBinding {
+  /// Initialize the binding if necessary, and ensure it is a [LiveZulipBinding].
+  static LiveZulipBinding ensureInitialized() {
+    if (ZulipBinding._instance == null) {
+      LiveZulipBinding();
     }
-    return DataBinding.instance as LiveDataBinding;
+    return ZulipBinding.instance as LiveZulipBinding;
   }
 
   @override

lib/widgets/store.dart

@@ -55,7 +55,7 @@ class _GlobalStoreWidgetState extends State<GlobalStoreWidget> {
   void initState() {
     super.initState();
     (() async {
-      final store = await DataBinding.instance.loadGlobalStore();
+      final store = await ZulipBinding.instance.loadGlobalStore();
       setState(() {
         this.store = store;
       });

test/model/binding.dart

@@ -16,24 +16,24 @@ import 'test_store.dart';
 ///
 /// The global store returned by [loadGlobalStore], and consequently by
 /// [GlobalStoreWidget.of] in application code, will be a [TestGlobalStore].
-class TestDataBinding extends DataBinding {
-  /// Initialize the binding if necessary, and ensure it is a [TestDataBinding].
+class TestZulipBinding extends ZulipBinding {
+  /// Initialize the binding if necessary, and ensure it is a [TestZulipBinding].
   ///
   /// This method is idempotent; calling it repeatedly simply returns the
   /// existing binding.
   ///
-  /// If there is an existing binding but it is not a [TestDataBinding],
+  /// If there is an existing binding but it is not a [TestZulipBinding],
   /// this method throws an error.
-  static TestDataBinding ensureInitialized() {
+  static TestZulipBinding ensureInitialized() {
     if (_instance == null) {
-      TestDataBinding();
+      TestZulipBinding();
     }
     return instance;
   }
 
   /// The single instance of the binding.
-  static TestDataBinding get instance => DataBinding.checkInstance(_instance);
-  static TestDataBinding? _instance;
+  static TestZulipBinding get instance => ZulipBinding.checkInstance(_instance);
+  static TestZulipBinding? _instance;
 
   @override
   void initInstance() {
@@ -58,7 +58,7 @@ class TestDataBinding extends DataBinding {
   ///
   /// Tests that mount a [GlobalStoreWidget], or that access [globalStore],
   /// should clean up by calling this method.  Typically this is done using
-  /// [addTearDown], like `addTearDown(TestDataBinding.instance.reset);`.
+  /// [addTearDown], like `addTearDown(TestZulipBinding.instance.reset);`.
   void reset() {
     _globalStore?.dispose();
     _globalStore = null;
@@ -83,7 +83,7 @@ class TestDataBinding extends DataBinding {
           ),
           ErrorHint(
             'Typically this is accomplished using [addTearDown], like '
-            '`addTearDown(TestDataBinding.instance.reset);`.',
+            '`addTearDown(TestZulipBinding.instance.reset);`.',
           ),
         ]);
       }

test/model/test_store.dart

@@ -13,7 +13,7 @@ import '../api/fake_api.dart';
 ///
 /// The per-account stores will use [FakeApiConnection].
 ///
-/// See also [TestDataBinding.globalStore], which provides one of these.
+/// See also [TestZulipBinding.globalStore], which provides one of these.
 class TestGlobalStore extends GlobalStore {
   TestGlobalStore({required super.accounts});
 

test/widgets/action_sheet_test.dart

@@ -24,10 +24,10 @@ Future<void> setupToMessageActionSheet(WidgetTester tester, {
   required Message message,
   required Narrow narrow,
 }) async {
-  addTearDown(TestDataBinding.instance.reset);
+  addTearDown(TestZulipBinding.instance.reset);
 
-  await TestDataBinding.instance.globalStore.add(eg.selfAccount, eg.initialSnapshot());
-  final store = await TestDataBinding.instance.globalStore.perAccount(eg.selfAccount.id);
+  await TestZulipBinding.instance.globalStore.add(eg.selfAccount, eg.initialSnapshot());
+  final store = await TestZulipBinding.instance.globalStore.perAccount(eg.selfAccount.id);
   store.addUser(eg.user(userId: message.senderId));
   if (message is StreamMessage) {
     store.addStream(eg.stream(streamId: message.streamId));
@@ -61,7 +61,7 @@ Future<void> setupToMessageActionSheet(WidgetTester tester, {
 }
 
 void main() {
-  TestDataBinding.ensureInitialized();
+  TestZulipBinding.ensureInitialized();
 
   group('QuoteAndReplyButton', () {
     ComposeBoxController? findComposeBoxController(WidgetTester tester) {
@@ -133,7 +133,7 @@ void main() {
     testWidgets('in stream narrow', (WidgetTester tester) async {
       final message = eg.streamMessage();
       await setupToMessageActionSheet(tester, message: message, narrow: StreamNarrow(message.streamId));
-      final store = await TestDataBinding.instance.globalStore.perAccount(eg.selfAccount.id);
+      final store = await TestZulipBinding.instance.globalStore.perAccount(eg.selfAccount.id);
 
       final composeBoxController = findComposeBoxController(tester)!;
       final contentController = composeBoxController.contentController;
@@ -151,7 +151,7 @@ void main() {
     testWidgets('in topic narrow', (WidgetTester tester) async {
       final message = eg.streamMessage();
       await setupToMessageActionSheet(tester, message: message, narrow: TopicNarrow.ofMessage(message));
-      final store = await TestDataBinding.instance.globalStore.perAccount(eg.selfAccount.id);
+      final store = await TestZulipBinding.instance.globalStore.perAccount(eg.selfAccount.id);
 
       final composeBoxController = findComposeBoxController(tester)!;
       final contentController = composeBoxController.contentController;
@@ -170,7 +170,7 @@ void main() {
       final message = eg.dmMessage(from: eg.selfUser, to: [eg.otherUser]);
       await setupToMessageActionSheet(tester,
         message: message, narrow: DmNarrow.ofMessage(message, selfUserId: eg.selfUser.userId));
-      final store = await TestDataBinding.instance.globalStore.perAccount(eg.selfAccount.id);
+      final store = await TestZulipBinding.instance.globalStore.perAccount(eg.selfAccount.id);
 
       final composeBoxController = findComposeBoxController(tester)!;
       final contentController = composeBoxController.contentController;
@@ -188,7 +188,7 @@ void main() {
     testWidgets('request has an error', (WidgetTester tester) async {
       final message = eg.streamMessage();
       await setupToMessageActionSheet(tester, message: message, narrow: TopicNarrow.ofMessage(message));
-      final store = await TestDataBinding.instance.globalStore.perAccount(eg.selfAccount.id);
+      final store = await TestZulipBinding.instance.globalStore.perAccount(eg.selfAccount.id);
 
       final composeBoxController = findComposeBoxController(tester)!;
       final contentController = composeBoxController.contentController;

test/widgets/content_test.dart

@@ -12,14 +12,14 @@ import '../example_data.dart' as eg;
 import '../model/binding.dart';
 
 void main() {
-  TestDataBinding.ensureInitialized();
+  TestZulipBinding.ensureInitialized();
 
   group('RealmContentNetworkImage', () {
     final authHeaders = authHeader(email: eg.selfAccount.email, apiKey: eg.selfAccount.apiKey);
 
     Future<String?> actualAuthHeader(WidgetTester tester, String src) async {
-      final globalStore = TestDataBinding.instance.globalStore;
-      addTearDown(TestDataBinding.instance.reset);
+      final globalStore = TestZulipBinding.instance.globalStore;
+      addTearDown(TestZulipBinding.instance.reset);
       await globalStore.add(eg.selfAccount, eg.initialSnapshot());
 
       final httpClient = _FakeHttpClient();

test/widgets/store_test.dart

@@ -9,10 +9,10 @@ import '../example_data.dart' as eg;
 import '../model/store_checks.dart';
 
 void main() {
-  TestDataBinding.ensureInitialized();
+  TestZulipBinding.ensureInitialized();
 
   testWidgets('GlobalStoreWidget', (WidgetTester tester) async {
-    addTearDown(TestDataBinding.instance.reset);
+    addTearDown(TestZulipBinding.instance.reset);
 
     GlobalStore? globalStore;
     await tester.pumpWidget(
@@ -29,17 +29,17 @@ void main() {
     await tester.pump();
     // Then after loading, mounts child instead, with provided store.
     check(tester.any(find.byType(CircularProgressIndicator))).isFalse();
-    check(globalStore).identicalTo(TestDataBinding.instance.globalStore);
+    check(globalStore).identicalTo(TestZulipBinding.instance.globalStore);
 
-    await TestDataBinding.instance.globalStore.add(eg.selfAccount, eg.initialSnapshot());
+    await TestZulipBinding.instance.globalStore.add(eg.selfAccount, eg.initialSnapshot());
     check(globalStore).isNotNull()
       .accountEntries.single
       .equals((accountId: eg.selfAccount.id, account: eg.selfAccount));
   });
 
   testWidgets('PerAccountStoreWidget basic', (tester) async {
-    final globalStore = TestDataBinding.instance.globalStore;
-    addTearDown(TestDataBinding.instance.reset);
+    final globalStore = TestZulipBinding.instance.globalStore;
+    addTearDown(TestZulipBinding.instance.reset);
     await globalStore.add(eg.selfAccount, eg.initialSnapshot());
 
     await tester.pumpWidget(
@@ -60,8 +60,8 @@ void main() {
   });
 
   testWidgets('PerAccountStoreWidget immediate data after first loaded', (tester) async {
-    final globalStore = TestDataBinding.instance.globalStore;
-    addTearDown(TestDataBinding.instance.reset);
+    final globalStore = TestZulipBinding.instance.globalStore;
+    addTearDown(TestZulipBinding.instance.reset);
     await globalStore.add(eg.selfAccount, eg.initialSnapshot());
 
     await tester.pumpWidget(