refactor: reworked settings, added settings service

Author: hawkkiller

app/lib/src/logic/composition_root.dart

@@ -58,8 +58,7 @@ Future<DependenciesContainer> createDependenciesContainer(
 
   // Get package info.
   final packageInfo = await PackageInfo.fromPlatform();
-
-  final settingsContainer = await SettingsContainer.create(sharedPreferences);
+  final settingsContainer = await SettingsContainer.create(sharedPreferences: sharedPreferences);
 
   return DependenciesContainer(
     logger: logger,

core/common/lib/common.dart

@@ -1,6 +1,6 @@
 export 'src/extensions/inherited_extension.dart';
 export 'src/extensions/string_extension.dart';
-export 'src/mutex/mutext.dart';
+export 'src/mutex/mutex_lock.dart';
 export 'src/persisted_column/persisted_column.dart';
 export 'src/persisted_column/shared_preferences_column.dart';
 export 'src/utils/jsonmap_codec.dart';

core/common/lib/src/mutex/mutext.dart core/common/lib/src/mutex/mutex_lock.dartcore/common/lib/src/mutex/mutext.dart renamed to core/common/lib/src/mutex/mutex_lock.dart

@@ -4,8 +4,8 @@ import 'dart:collection';
 /// A simple mutex implementation using a queue of completers.
 /// This allows for synchronizing access to a critical section of code,
 /// ensuring that only one task can execute the critical section at a time.
-class Mutext {
-  Mutext();
+class MutexLock {
+  MutexLock();
 
   final _queue = DoubleLinkedQueue<Completer<void>>();
 

feature/home/lib/src/presentation/widget/home_screen.dart

@@ -18,11 +18,9 @@ class _HomeScreenState extends State<HomeScreen> {
   }
 
   void _onSeedColorChanged(Color color) {
-    SettingsScope.of(context).settingsBloc.add(
-      SettingsEventUpdate(
-        onUpdate: (settings) => settings.copyWith(
-          general: settings.general.copyWith(seedColor: color),
-        ),
+    SettingsScope.of(context).settingsService.update(
+      (settings) => settings.copyWith(
+        general: settings.general.copyWith(seedColor: color),
       ),
     );
   }

feature/settings/lib/settings.dart

@@ -1,7 +1,7 @@
+export 'src/application/settings_service.dart';
 export 'src/domain/model/general.dart';
 export 'src/domain/model/settings.dart';
 export 'src/domain/repositories/settings_repository.dart';
 export 'src/injection.dart';
-export 'src/presentation/bloc/settings_bloc.dart';
 export 'src/presentation/settings_builder.dart';
 export 'src/presentation/settings_scope.dart';

feature/settings/lib/src/application/settings_service.dart

@@ -0,0 +1,44 @@
+import 'dart:async';
+
+import 'package:common/common.dart';
+import 'package:settings/settings.dart';
+
+abstract interface class SettingsService {
+  /// Emits settings whenever they change.
+  Stream<Settings> get stream;
+
+  /// Current in-memory settings.
+  Settings get current;
+
+  /// Update settings transactionally and persist them.
+  Future<void> update(Settings Function(Settings current) transform);
+}
+
+final class SettingsServiceImpl implements SettingsService {
+  SettingsServiceImpl._(this._repository, this._current);
+
+  /// Create a new [SettingsServiceImpl] with the given [repository].
+  static Future<SettingsServiceImpl> create({required SettingsRepository repository}) async {
+    final current = await repository.read();
+    return SettingsServiceImpl._(repository, current);
+  }
+
+  final SettingsRepository _repository;
+  final _controller = StreamController<Settings>.broadcast();
+  final _mutex = MutexLock();
+  Settings _current;
+
+  @override
+  Stream<Settings> get stream => _controller.stream;
+
+  @override
+  Settings get current => _current;
+
+  @override
+  Future<void> update(Settings Function(Settings) transform) => _mutex.runLocked(() async {
+    final updated = transform(current);
+    await _repository.save(updated);
+    _current = updated;
+    _controller.add(updated);
+  });
+}

feature/settings/lib/src/data/mappers/general_settings_codec.dart

@@ -16,8 +16,6 @@ class GeneralSettingsCodec extends JsonMapCodec<GeneralSettings> {
     final themeMode = input['themeMode'] as String?;
     final seedColor = input['seedColor'] as Map<String, Object?>?;
 
-    const defaults = GeneralSettings();
-
     Color? seedColorValue;
 
     if (seedColor case {
@@ -29,6 +27,8 @@ class GeneralSettingsCodec extends JsonMapCodec<GeneralSettings> {
       seedColorValue = Color.from(alpha: a, red: r, green: g, blue: b);
     }
 
+    const defaults = GeneralSettings();
+
     return GeneralSettings(
       themeMode: themeMode != null ? ThemeModeVO.values.byName(themeMode) : defaults.themeMode,
       seedColor: seedColorValue ?? defaults.seedColor,

feature/settings/lib/src/data/repositories/settings_repository_impl.dart

@@ -1,43 +1,20 @@
 import 'dart:async';
 
-import 'package:common/common.dart';
 import 'package:settings/settings.dart';
 import 'package:settings/src/data/datasources/settings_local_datasource.dart';
 
 final class SettingsRepositoryImpl implements SettingsRepository {
-  SettingsRepositoryImpl({
-    required this.localDatasource,
-    required this.current,
-  });
-
-  final _controller = StreamController<Settings>.broadcast();
-
-  static Future<SettingsRepositoryImpl> init(SettingsLocalDatasource localDatasource) async {
-    final currentSettings = await localDatasource.read();
-
-    return SettingsRepositoryImpl(
-      localDatasource: localDatasource,
-      current: currentSettings,
-    );
-  }
+  const SettingsRepositoryImpl({required this.localDatasource});
 
   final SettingsLocalDatasource localDatasource;
-  final _mutex = Mutext();
-
-  @override
-  Future<Settings> save(Settings Function(Settings settings) fn) => _mutex.runLocked(() async {
-    final newSettings = fn(current);
-
-    await localDatasource.save(newSettings);
-    current = newSettings;
-    _controller.add(current);
-
-    return current;
-  });
 
   @override
-  Stream<Settings> watch() => _controller.stream;
+  Future<void> save(Settings settings) async {
+    await localDatasource.save(settings);
+  }
 
   @override
-  Settings current;
+  Future<Settings> read() async {
+    return await localDatasource.read();
+  }
 }

feature/settings/lib/src/domain/repositories/settings_repository.dart

@@ -1,9 +1,6 @@
 import 'package:settings/settings.dart';
 
 abstract interface class SettingsRepository {
-  Settings get current;
-
-  Stream<Settings> watch();
-
-  Future<Settings> save(Settings Function(Settings settings) fn);
+  Future<void> save(Settings settings);
+  Future<Settings> read();
 }

feature/settings/lib/src/injection.dart

@@ -1,30 +1,27 @@
-import 'package:settings/settings.dart';
+import 'package:settings/src/application/settings_service.dart';
 import 'package:settings/src/data/datasources/settings_local_datasource.dart';
 import 'package:settings/src/data/repositories/settings_repository_impl.dart';
 import 'package:shared_preferences/shared_preferences.dart';
 
-Future<SettingsRepository> _createSettingsRepository(SharedPreferencesAsync sharedPreferences) {
-  return SettingsRepositoryImpl.init(
-    SettingsLocalDatasourceSharedPreferences(sharedPreferences: sharedPreferences),
-  );
-}
-
 /// Container with global settings state.
 class SettingsContainer {
-  const SettingsContainer({
-    required this.settingsRepository,
-    required this.settingsBloc,
-  });
-
-  final SettingsRepository settingsRepository;
-  final SettingsBloc settingsBloc;
+  const SettingsContainer._(this.settingsService);
 
-  static Future<SettingsContainer> create(SharedPreferencesAsync sharedPreferences) async {
-    final settingsRepository = await _createSettingsRepository(sharedPreferences);
+  /// Service for managing settings.
+  final SettingsService settingsService;
 
-    return SettingsContainer(
-      settingsRepository: settingsRepository,
-      settingsBloc: SettingsBloc(settingsRepository: settingsRepository),
+  /// Create a new [SettingsContainer] with the given [sharedPreferences].
+  static Future<SettingsContainer> create({
+    required SharedPreferencesAsync sharedPreferences,
+  }) async {
+    final settingsRepository = SettingsRepositoryImpl(
+      localDatasource: SettingsLocalDatasourceSharedPreferences(
+        sharedPreferences: sharedPreferences,
+      ),
     );
+
+    final settingsService = await SettingsServiceImpl.create(repository: settingsRepository);
+
+    return SettingsContainer._(settingsService);
   }
 }