settings [nfc]: Have settingsOf return whole store, not just data

To save code that consults the settings from an extra indirection
".data", we equip GlobalSettingsStore with getters for all the
fields of the data class.  This also makes the store now the natural
home for the additional members that had been in an extension on the
data class.

Author: gnprice

lib/model/settings.dart

@@ -44,7 +44,26 @@ enum BrowserPreference {
   external,
 }
 
-extension GlobalSettingsHelpers on GlobalSettingsData {
+/// Store for the user's account-independent settings.
+///
+/// From UI code, use [GlobalStoreWidget.settingsOf] to get hold of
+/// an appropriate instance of this class.
+class GlobalSettingsStore extends ChangeNotifier {
+  GlobalSettingsStore({required GlobalSettingsData data}) : _data = data;
+
+  /// A cache of the [GlobalSettingsData] singleton in the underlying data store.
+  GlobalSettingsData _data;
+
+  /// The user's choice of [ThemeSetting];
+  /// null means the device-level choice of theme.
+  ThemeSetting? get themeSetting => _data.themeSetting;
+
+  /// The user's choice of [BrowserPreference];
+  /// null means use our default choice.
+  ///
+  /// Consider using [effectiveBrowserPreference] or [getUrlLaunchMode].
+  BrowserPreference? get browserPreference => _data.browserPreference;
+
   /// The value of [BrowserPreference] to use:
   /// the user's choice [browserPreference] if any, else our default.
   ///
@@ -84,18 +103,6 @@ extension GlobalSettingsHelpers on GlobalSettingsData {
         return UrlLaunchMode.externalApplication;
     }
   }
-}
-
-/// Store for the user's account-independent settings.
-///
-/// From UI code, use [GlobalStoreWidget.settingsOf] to get hold of
-/// the settings data.
-class GlobalSettingsStore extends ChangeNotifier {
-  GlobalSettingsStore({required GlobalSettingsData data}) : _data = data;
-
-  /// A cache of the [GlobalSettingsData] singleton in the underlying data store.
-  GlobalSettingsData get data => _data;
-  GlobalSettingsData _data;
 
   /// (Should only be called by [GlobalStore].)
   void update(GlobalSettingsCompanion data) {

lib/model/store.dart

@@ -63,12 +63,13 @@ abstract class GlobalStore extends ChangeNotifier {
 
   final GlobalSettingsStore settingsNotifier; // TODO rename as the store
 
-  /// A cache of the [GlobalSettingsData] singleton in the underlying data store.
+  /// The store for the user's account-independent settings.
   ///
-  /// To be notified for changes to this value, subscribe to [settingsNotifier]
-  /// (usually by calling [GlobalStoreWidget.settingsOf]).
-  /// The [GlobalStore] itself will not notify its own listeners.
-  GlobalSettingsData get globalSettings => settingsNotifier.data;
+  /// When the settings data changes, the [GlobalSettingsStore] will notify
+  /// its listeners, but the [GlobalStore] will not notify its own listeners.
+  /// Consider using [GlobalStoreWidget.settingsOf], which automatically
+  /// subscribes to changes in the [GlobalSettingsStore].
+  GlobalSettingsStore get globalSettings => settingsNotifier;
 
   /// Update the global settings in the store.
   Future<void> updateGlobalSettings(GlobalSettingsCompanion data) async {

lib/widgets/content.dart

@@ -15,7 +15,6 @@ import '../model/avatar_url.dart';
 import '../model/binding.dart';
 import '../model/content.dart';
 import '../model/internal_link.dart';
-import '../model/settings.dart';
 import 'code_block.dart';
 import 'dialog.dart';
 import 'icons.dart';

lib/widgets/store.dart

@@ -53,10 +53,10 @@ class GlobalStoreWidget extends StatefulWidget {
     return widget!.store;
   }
 
-  /// The user's [GlobalSettings] data, from the app's global data store.
+  /// The user's [GlobalSettings] data within the app's global data store.
   ///
   /// The given build context will be registered as a dependency and
-  /// subscribed to changes in the [GlobalSettingsStore].
+  /// subscribed to changes in the returned [GlobalSettingsStore].
   /// This means that when the setting values in the store change,
   /// the element at that build context will be rebuilt.
   ///
@@ -69,10 +69,10 @@ class GlobalStoreWidget extends StatefulWidget {
   /// ```
   ///
   /// See [of] for further discussion of how to use this kind of method.
-  static GlobalSettingsData settingsOf(BuildContext context) {
+  static GlobalSettingsStore settingsOf(BuildContext context) {
     final widget = context.dependOnInheritedWidgetOfExactType<_GlobalSettingsStoreInheritedWidget>();
     assert(widget != null, 'No GlobalStoreWidget ancestor');
-    return widget!.store.data;
+    return widget!.store;
   }
 
   @override

test/model/store_checks.dart

@@ -10,6 +10,11 @@ import 'package:zulip/model/settings.dart';
 import 'package:zulip/model/store.dart';
 import 'package:zulip/model/unreads.dart';
 
+extension GlobalSettingsDataChecks on Subject<GlobalSettingsData> {
+  Subject<ThemeSetting?> get themeSetting => has((x) => x.themeSetting, 'themeSetting');
+  Subject<BrowserPreference?> get browserPreference => has((x) => x.browserPreference, 'browserPreference');
+}
+
 extension AccountChecks on Subject<Account> {
   Subject<int> get id => has((x) => x.id, 'id');
   Subject<Uri> get realmUrl => has((x) => x.realmUrl, 'realmUrl');
@@ -22,21 +27,21 @@ extension AccountChecks on Subject<Account> {
   Subject<String?> get ackedPushToken => has((x) => x.ackedPushToken, 'ackedPushToken');
 }
 
+extension GlobalSettingsStoreChecks on Subject<GlobalSettingsStore> {
+  Subject<ThemeSetting?> get themeSetting => has((x) => x.themeSetting, 'themeSetting');
+  Subject<BrowserPreference?> get browserPreference => has((x) => x.browserPreference, 'browserPreference');
+  Subject<BrowserPreference> get effectiveBrowserPreference => has((x) => x.effectiveBrowserPreference, 'effectiveBrowserPreference');
+  Subject<UrlLaunchMode> getUrlLaunchMode(Uri url) => has((x) => x.getUrlLaunchMode(url), 'getUrlLaunchMode');
+}
+
 extension GlobalStoreChecks on Subject<GlobalStore> {
-  Subject<GlobalSettingsData> get globalSettings => has((x) => x.globalSettings, 'globalSettings');
+  Subject<GlobalSettingsStore> get globalSettings => has((x) => x.globalSettings, 'globalSettings');
   Subject<Iterable<Account>> get accounts => has((x) => x.accounts, 'accounts');
   Subject<Iterable<int>> get accountIds => has((x) => x.accountIds, 'accountIds');
   Subject<Iterable<({ int accountId, Account account })>> get accountEntries => has((x) => x.accountEntries, 'accountEntries');
   Subject<Account?> getAccount(int id) => has((x) => x.getAccount(id), 'getAccount($id)');
 }
 
-extension GlobalSettingsDataChecks on Subject<GlobalSettingsData> {
-  Subject<ThemeSetting?> get themeSetting => has((x) => x.themeSetting, 'themeSetting');
-  Subject<BrowserPreference?> get browserPreference => has((x) => x.browserPreference, 'browserPreference');
-  Subject<BrowserPreference> get effectiveBrowserPreference => has((x) => x.effectiveBrowserPreference, 'effectiveBrowserPreference');
-  Subject<UrlLaunchMode> getUrlLaunchMode(Uri url) => has((x) => x.getUrlLaunchMode(url), 'getUrlLaunchMode');
-}
-
 extension PerAccountStoreChecks on Subject<PerAccountStore> {
   Subject<ApiConnection> get connection => has((x) => x.connection, 'connection');
   Subject<bool> get isLoading => has((x) => x.isLoading, 'isLoading');