Rename Settings class to EasySettings

Author: zeyus

CHANGELOG.md

@@ -1,3 +1,7 @@
+## 1.1.0
+
+* **Breaking**: Renamed `Settings` to `EasySettings` to avoid potential conflicts with a commonly used name.
+
 ## 1.0.1
 
 * Updated `shared_preferences` and `logging` dependencies

README.md

@@ -251,7 +251,7 @@ void main() {
     late Settings settings;
     
     setUp(() {
-      settings = Settings();
+      settings = EasySettings();
       settings.register(SettingsGroup.forTesting(
         key: 'test',
         items: [
@@ -282,7 +282,7 @@ void main() {
 
 ### Main API
 
-- `Settings()`: Main settings manager
+- `EasySettings()`: Main settings manager
 - `SettingsGroup()`: Container for related settings
 - `settings.register()`: Register a settings group
 - `settings.init()`: Initialize the settings system

example/integration_test/app_test.dart

@@ -8,12 +8,12 @@ void main() {
 
   group('Easy Shared Preferences Integration Tests', () {
     late SettingsStore store;
-    late Settings settings;
+    late EasySettings settings;
 
     setUp(() async {
       // Initialize store and settings for each test
       store = SettingsStore();
-      settings = Settings(store: store);
+      settings = EasySettings(store: store);
 
       // Clear any existing data
       await store.readyFuture;
@@ -63,7 +63,7 @@ void main() {
       settings.dispose();
 
       final newStore = SettingsStore();
-      final newSettings = Settings(store: newStore);
+      final newSettings = EasySettings(store: newStore);
       final newTestGroup = SettingsGroup(
         key: 'integration_test',
         items: [

example/lib/main.dart

@@ -4,14 +4,14 @@ import 'package:easy_shared_preferences/easy_shared_preferences.dart';
 late SettingsStore store;
 late SettingsGroup gameSettings;
 late SettingsGroup uiSettings;
-late Settings settings;
+late EasySettings settings;
 
 void main() async {
   WidgetsFlutterBinding.ensureInitialized();
 
   // Initialize store and settings
   store = SettingsStore();
-  settings = Settings(store: store);
+  settings = EasySettings(store: store);
 
   // Define your settings groups with both function and class validators
   gameSettings = SettingsGroup(

example/lib/type_system_example.dart

@@ -10,7 +10,7 @@ void main() async {
   // Initialize settings
   WidgetsFlutterBinding.ensureInitialized();
   final store = SettingsStore();
-  final settings = Settings(store: store);
+  final settings = EasySettings(store: store);
 
   final gameSettings = SettingsGroup(
     key: 'game',

lib/src/global_settings.dart

@@ -59,10 +59,10 @@ class GroupConfig {
 /// Helper class that eliminates duplication by providing a single method
 /// to check initialization and delegate to the underlying instance.
 class _GlobalSettingsDelegate {
-  static Settings? _instance;
+  static EasySettings? _instance;
 
   /// Get the instance and ensure it's initialized
-  static Settings get instance {
+  static EasySettings get instance {
     if (_instance == null) {
       throw StateError(
           'GlobalSettings has not been initialized. Call GlobalSettings.initialize() first.');
@@ -71,7 +71,7 @@ class _GlobalSettingsDelegate {
   }
 
   /// Set the instance (internal use only)
-  static void _setInstance(Settings? instance) {
+  static void _setInstance(EasySettings? instance) {
     _instance = instance;
   }
 }
@@ -123,10 +123,10 @@ class GlobalSettings {
     _logger
         .info('Initializing GlobalSettings with ${groupConfigs.length} groups');
 
-    Settings? tempInstance;
+    EasySettings? tempInstance;
     try {
       final settingsStore = store ?? SettingsStore();
-      tempInstance = Settings(store: settingsStore);
+      tempInstance = EasySettings(store: settingsStore);
 
       // Create and register all groups
       for (final config in groupConfigs) {
@@ -207,7 +207,7 @@ class GlobalSettings {
   /// Most users should use the convenience methods instead.
   ///
   /// Throws [StateError] if not initialized.
-  static Settings get instance => _GlobalSettingsDelegate.instance;
+  static EasySettings get instance => _GlobalSettingsDelegate.instance;
 
   /// Dispose the global settings and cleanup all resources.
   ///

lib/src/settings_manager.dart

@@ -7,7 +7,7 @@ import 'typed_setting_access.dart';
 
 /// Settings manager providing centralized access to all setting groups.
 ///
-/// The [Settings] class serves as the main entry point for the settings framework,
+/// The [EasySettings] class serves as the main entry point for the settings framework,
 /// offering instance methods for registration, initialization, and access to settings
 /// across your entire application. It manages multiple [SettingsGroup] instances and
 /// provides both individual and batch operations with proper resource management.
@@ -16,7 +16,7 @@ import 'typed_setting_access.dart';
 ///
 /// The settings framework follows a hierarchical structure:
 /// ```
-/// Settings (Global Manager)
+/// EasySettings (Manager)
 /// │
 /// ├── SettingsGroup (Group: "game")
 /// │   ├── BoolSetting ("soundEnabled")
@@ -92,7 +92,7 @@ import 'typed_setting_access.dart';
 ///
 /// This prevents key conflicts between different setting groups and provides
 /// logical organization of related settings.
-class Settings with TypedSettingAccess {
+class EasySettings with TypedSettingAccess {
   static final _logger = EspLogger.forComponent('Settings');
 
   /// The settings store instance used by this manager.
@@ -121,7 +121,7 @@ class Settings with TypedSettingAccess {
   ///
   /// Parameters:
   /// - [store]: The SettingsStore to use for persistence. If not provided, creates a new one.
-  Settings({SettingsStore? store}) : _store = store ?? SettingsStore() {
+  EasySettings({SettingsStore? store}) : _store = store ?? SettingsStore() {
     _logger.info('Creating Settings manager');
   }
 

pubspec.yaml

@@ -1,6 +1,6 @@
 name: easy_shared_preferences
 description: A flexible, hierarchical wrapper for flutter's shared_preferences package.
-version: 1.0.1
+version: 1.1.0
 homepage: https://github.com/NexusDynamic/easy_shared_preferences
 repository: https://github.com/NexusDynamic/easy_shared_preferences
 issue_tracker: https://github.com/NexusDynamic/easy_shared_preferences/issues

test/easy_shared_preferences_test.dart

@@ -5,19 +5,19 @@ import 'package:easy_shared_preferences/easy_shared_preferences.dart';
 void main() {
   // Set up Flutter test environment
   TestWidgetsFlutterBinding.ensureInitialized();
-  
+
   group('Settings Framework Tests', () {
-    late Settings appSettings;
+    late EasySettings appSettings;
     late SettingsStore store;
-    
+
     setUp(() async {
       // Clear SharedPreferences before each test using the simpler mock approach
       // This is compatible with both SharedPreferences and SharedPreferencesWithCache
       SharedPreferences.setMockInitialValues({});
 
       // Create fresh instances for each test
       store = SettingsStore(forceRegularSharedPreferences: true);
-      appSettings = Settings(store: store);
+      appSettings = EasySettings(store: store);
     });
 
     tearDown(() async {
@@ -560,8 +560,8 @@ void main() {
 
         // Create new Settings instance and store for second initialization
         final newStore = SettingsStore(forceRegularSharedPreferences: true);
-        final newSettings = Settings(store: newStore);
-        
+        final newSettings = EasySettings(store: newStore);
+
         // Second initialization with same structure
         final settings2 = SettingsGroup.forTesting(
           key: 'persist-test',
@@ -969,8 +969,8 @@ void main() {
 
         // Create new Settings instance and store
         final newStore = SettingsStore(forceRegularSharedPreferences: true);
-        final newSettings = Settings(store: newStore);
-        
+        final newSettings = EasySettings(store: newStore);
+
         // Create new instance with same key structure
         final settings2 = SettingsGroup.forTesting(
           key: 'persist',
@@ -986,7 +986,7 @@ void main() {
         // Values should be persisted
         expect(newSettings.getBool('persist.flag'), isTrue);
         expect(newSettings.getString('persist.text'), equals('persisted'));
-        
+
         // Clean up
         newSettings.dispose();
       });
@@ -1006,8 +1006,8 @@ void main() {
 
         // Create new Settings instance and store
         final newStore = SettingsStore(forceRegularSharedPreferences: true);
-        final newSettings = Settings(store: newStore);
-        
+        final newSettings = EasySettings(store: newStore);
+
         // Create expanded settings with new setting
         final expandedSettings = SettingsGroup.forTesting(
           key: 'expand',
@@ -1025,7 +1025,7 @@ void main() {
 
         // New setting should use default
         expect(newSettings.getInt('expand.newSetting'), equals(42));
-        
+
         // Clean up
         newSettings.dispose();
       });

test/global_settings_test.dart

@@ -4,7 +4,7 @@ import 'package:easy_shared_preferences/easy_shared_preferences.dart';
 
 void main() {
   TestWidgetsFlutterBinding.ensureInitialized();
-  
+
   group('GlobalSettings Tests', () {
     setUp(() async {
       SharedPreferences.setMockInitialValues({});
@@ -118,7 +118,8 @@ void main() {
         GlobalSettings.dispose();
 
         expect(() => GlobalSettings.getBool('app.darkMode'), throwsStateError);
-        expect(() => GlobalSettings.setBool('app.darkMode', true), throwsA(isA<StateError>()));
+        expect(() => GlobalSettings.setBool('app.darkMode', true),
+            throwsA(isA<StateError>()));
       });
     });
 
@@ -186,7 +187,7 @@ void main() {
 
       test('should call change callbacks', () async {
         final changeEvents = <Map<String, dynamic>>[];
-        
+
         GlobalSettings.addChangeCallback((key, oldValue, newValue) {
           changeEvents.add({
             'key': key,
@@ -205,7 +206,7 @@ void main() {
 
       test('should remove change callbacks', () async {
         final changeEvents = <Map<String, dynamic>>[];
-        
+
         void callback(String key, dynamic oldValue, dynamic newValue) {
           changeEvents.add({
             'key': key,
@@ -290,7 +291,7 @@ void main() {
         await GlobalSettings.initialize(groups);
 
         final instance = GlobalSettings.instance;
-        expect(instance, isA<Settings>());
+        expect(instance, isA<EasySettings>());
         expect(instance.getBool('test.flag'), isFalse);
       });
 
@@ -333,4 +334,4 @@ void main() {
       });
     });
   });
-}
+}