Updated: LocalStorage, comments, async gap

Updated: documentation comments

Fixed: async gap error

Author: we-mohd-i001

lib/vaahextendflutter/services/storage/local/services/base_service.dart

@@ -1,5 +1,5 @@
 abstract class LocalStorageService {
-  Future<void> add(String collectionName);
+  void add(String collectionName);
 
   Future<void> create({String collectionName, required String key, required String value});
 

lib/vaahextendflutter/services/storage/local/services/flutter_secure_storage.dart

@@ -8,7 +8,7 @@ class LocalStorageWithFlutterSecureStorage implements LocalStorageService {
   final _storage = const FlutterSecureStorage();
 
   @override
-  Future<void> add(String name) async {}
+  void add(String name) {}
 
   @override
   Future<void> create({

lib/vaahextendflutter/services/storage/local/services/hive.dart

@@ -4,13 +4,13 @@ import 'base_service.dart';
 
 /// A class implementing LocalStorageService interface using Hive as storage backend.
 class LocalStorageWithHive implements LocalStorageService {
-  final Map<String, Box> _collections = {};
+  final Map<String, Future<Box>> _collections = {};
 
   @override
-  Future<void> add(String collectionName) async {
+  void add(String collectionName) {
     assert(!_collections.containsKey(collectionName), 'The Box "$collectionName" already exists');
 
-    _collections[collectionName] = await Hive.openBox(collectionName);
+    _collections[collectionName] = Hive.openBox(collectionName);
   }
 
   @override
@@ -20,9 +20,11 @@ class LocalStorageWithHive implements LocalStorageService {
     required String value,
   }) async {
     assert(_collections.containsKey(collectionName), 'The Box "$collectionName" does not exists.');
-    assert(_collections[collectionName]!.containsKey(key), 'The key ($key) already exists.');
 
-    await _collections[collectionName]!.put(key, value);
+    Box box = await _collections[collectionName]!;
+    assert(!box.containsKey(key), 'The key "$key" already exists.');
+
+    await box.put(key, value);
   }
 
   @override
@@ -36,7 +38,8 @@ class LocalStorageWithHive implements LocalStorageService {
   Future<String?> read({String collectionName = '', required String key}) async {
     assert(_collections.containsKey(collectionName), 'The Box "$collectionName" does not exists.');
 
-    String? result = _collections[collectionName]!.get(key);
+    Box box = await _collections[collectionName]!;
+    String? result = box.get(key);
     return result;
   }
 
@@ -45,8 +48,6 @@ class LocalStorageWithHive implements LocalStorageService {
     String collectionName = '',
     required List<String> keys,
   }) async {
-    assert(_collections.containsKey(collectionName), 'The Box "$collectionName" does not exists.');
-
     if (keys.isNotEmpty) {
       Map<String, String?> result = {};
       for (String k in keys) {
@@ -62,9 +63,13 @@ class LocalStorageWithHive implements LocalStorageService {
   Future<Map<String, String?>> readAll({String collectionName = ''}) async {
     assert(_collections.containsKey(collectionName), 'The Box "$collectionName" does not exists.');
 
-    Map<String, String?> result = _collections[collectionName]!
-        .toMap()
-        .map((key, value) => MapEntry(key.toString(), value?.toString()));
+    Box box = await _collections[collectionName]!;
+    Map<String, String?> result = box.toMap().map(
+          (key, value) => MapEntry(
+            key.toString(),
+            value?.toString(),
+          ),
+        );
     return result;
   }
 
@@ -75,9 +80,11 @@ class LocalStorageWithHive implements LocalStorageService {
     required String value,
   }) async {
     assert(_collections.containsKey(collectionName), 'The Box "$collectionName" does not exists.');
-    assert(!_collections[collectionName]!.containsKey(key), 'The key ($key) does not exist.');
 
-    _collections[collectionName]!.put(key, value);
+    Box box = await _collections[collectionName]!;
+    assert(box.containsKey(key), 'The key "$key" does not exist.');
+
+    box.put(key, value);
   }
 
   @override
@@ -95,7 +102,8 @@ class LocalStorageWithHive implements LocalStorageService {
   }) async {
     assert(_collections.containsKey(collectionName), 'The Box "$collectionName" does not exists.');
 
-    _collections[collectionName]!.put(key, value);
+    Box box = await _collections[collectionName]!;
+    box.put(key, value);
   }
 
   @override
@@ -112,22 +120,25 @@ class LocalStorageWithHive implements LocalStorageService {
   Future<void> delete({String collectionName = '', dynamic key}) async {
     assert(_collections.containsKey(collectionName), 'The Box "$collectionName" does not exists.');
 
-    await _collections[collectionName]!.delete(key);
+    Box box = await _collections[collectionName]!;
+    await box.delete(key);
   }
 
   @override
   Future<void> deleteMany({String collectionName = '', List<String> keys = const []}) async {
     assert(_collections.containsKey(collectionName), 'The Box "$collectionName" does not exists.');
 
+    Box box = await _collections[collectionName]!;
     if (keys.isNotEmpty) {
-      _collections[collectionName]!.deleteAll(keys);
+      await box.deleteAll(keys);
     }
   }
 
   @override
   Future<void> deleteAll({String collectionName = ''}) async {
     assert(_collections.containsKey(collectionName), 'The Box "$collectionName" does not exists.');
 
-    await _collections[collectionName]!.clear();
+    Box box = await _collections[collectionName]!;
+    await box.clear();
   }
 }

lib/vaahextendflutter/services/storage/local/services/no_op_storage.dart

@@ -3,7 +3,7 @@ import 'base_service.dart';
 /// A placeholder storage class when [LocalStorageType.none] is selected in env.dart.
 class NoOpStorage implements LocalStorageService {
   @override
-  Future<void> add(String name) async {}
+  void add(String name) {}
 
   @override
   Future<void> create({

lib/vaahextendflutter/services/storage/local/storage.dart

@@ -24,20 +24,26 @@ abstract class LocalStorage {
   ///
   /// It's not required in the case of [LocalStorageWithFlutterSecureStorage].
   ///
+  /// Throws an assertion error if [collectionName] exists already.
+  ///
   /// Example:
   /// ```dart
   /// LocalStorage.add('posts');
   /// //used only with Hive
   /// ```
-  Future<void> add(String collectionName) {
+  void add(String collectionName) {
     return _instanceLocal.add(collectionName);
   }
 
   /// Creates a new item in the [collectionName] of [LocalStorage].
   ///
   /// To create a single key-value pair pass the [key] and the [value] as String, the
   /// String could be a JSON String or a simple text according to your requirement.
-  /// If the key is already present in the [LocalStorage] an assertion error will be thrown.
+  ///
+  /// Throws an assertion error if the key is already present in the [LocalStorage] or
+  /// [collectionName] is not added.
+  ///
+  /// Try [LocalStorage.createOrUpdate], [LocalStorage.update].
   ///
   /// Example:
   ///
@@ -60,8 +66,11 @@ abstract class LocalStorage {
   /// Creates new items in the[collectionName] of [LocalStorage].
   /// If you want to create multiple entries pass the [values] as a Map<String, String>, then it
   /// will create all the key-value pairs from the [values] map.
-  /// If any key from the [values] is already present in the [LocalStorage] an assertion error will
-  /// be thrown.
+  ///
+  /// Throws an assertion error if the key is already present in the [LocalStorage] or
+  /// [collectionName] is not added.
+  ///
+  /// Try [LocalStorage.createOrUpdateMany], [LocalStorage.updateMany].
   ///
   /// Example:
   ///
@@ -101,7 +110,10 @@ abstract class LocalStorage {
   /// Reads the value of the item at [key] from the [LocalStorage] and returns the value.
   ///
   /// Read a single value by passing [key] as String, it will return the value as String?.
-  /// If the [key] already exists an assertion error will be thrown.
+  ///
+  /// Throws an assertion error if [key] already exists or [collectionName] is not added.
+  ///
+  /// Try [LocalStorage.createOrUpdateMany], [LocalStorage.updateMany].
   ///
   /// Example:
   /// ```dart
@@ -148,7 +160,11 @@ abstract class LocalStorage {
 
   /// Updates an item in [collectionName] of the [LocalStorage].
   ///
-  /// To update a single key-value pair pass the [key] and the [value] as String, the
+  /// To update a single key-value pair pass the [key] and the [value] as String.
+  ///
+  /// Throws asserstion error if [key] does not exists or [collectionName] is not added.
+  ///
+  /// Try [LocalStorage.createOrUpdate], [LocalStorage.create].
   ///
   /// Example:
   /// ```dart
@@ -167,6 +183,10 @@ abstract class LocalStorage {
   /// If you want to update multiple entries pass the [values] as a Map<String, String>, then it
   /// will update all the key-value pairs in the [values] map.
   ///
+  /// Throws asserstion error if [key] does not exists or [collectionName] is not added.
+  ///
+  /// Try [LocalStorage.createOrUpdateMany], [LocalStorage.createMany].
+  ///
   /// Example:
   /// ```dart
   /// await LocalStorage.updateMany(
@@ -191,8 +211,7 @@ abstract class LocalStorage {
 
   /// Creates or updates an item in [collectionName] of [LocalStorage].
   ///
-  /// To create or update a single key-value pair pass the [key] and the [value] as String, the
-  /// If the [key] is already present in the [LocalStorage] it's value will be overwritten.
+  /// To create or update a single key-value pair pass the [key] and the [value] as String.
   ///
   /// Example:
   /// ```dart
@@ -210,7 +229,7 @@ abstract class LocalStorage {
   /// Creates or updates items in [collectionName] of [LocalStorage].
   /// If you want to create or update multiple entries pass the [values] as a Map<String, String>, then it
   /// will create all the key-value pairs from the [values] map.
-  /// If any key from the [values] is already present in the [LocalStorage] it's value will be
+  /// If any key from the [values] is already present in the [collectionName] of [LocalStorage] it's value will be
   /// overwritten.
   ///
   /// Example: