Made default list null

Author: Daniel Martin

CHANGELOG.md

@@ -5,3 +5,11 @@ Implemented basic functionality
 ## 0.0.5
 
 Implemented function 'getWhere()' which helps retrieving the correct items
+
+## 0.0.6
+
+Made 'getAll()' and 'getWhere()' returning a nun-nullable List<T>. If no item was found, it returns now an empty List<T>
+
+## 0.0.7
+
+Partially reverted the last changes, but "get()" and "getWhere()" returns now null if the cache has never been used.

lib/cache.dart

@@ -8,7 +8,7 @@ class Cache<T> {
   late Duration _duration;
 
   /// The cache itself
-  final List<CacheItem<T>> _cache = [];
+  List<CacheItem<T>>? _cache;
 
   /// The timer which handles the loop
   Timer? _timer;
@@ -19,8 +19,12 @@ class Cache<T> {
 
   /// Gets a cached item with the given key
   T? get(String key) {
+    if (_cache == null) {
+      return null;
+    }
+
     final CacheItem<T>? cacheItem =
-        _cache.firstWhereOrNull((element) => element.key == key);
+        _cache!.firstWhereOrNull((element) => element.key == key);
 
     // If there is no item cached
     if (cacheItem == null) {
@@ -38,15 +42,18 @@ class Cache<T> {
 
   /// Gets all cached items
   List<T>? getAll() {
-    List<T>? list;
+    if (_cache == null) {
+      return null;
+    }
+
+    final List<T> list = [];
 
-    for (int index = _cache.length - 1; index >= 0; index--) {
-      final item = _cache[index];
+    for (int index = _cache!.length - 1; index >= 0; index--) {
+      final item = _cache![index];
 
       if (_isItemOutdated(item)) {
         removeItem(item);
       } else {
-        list ??= [];
         list.add(item.item);
       }
     }
@@ -55,15 +62,18 @@ class Cache<T> {
   }
 
   List<T>? getWhere(bool Function(CacheItem<T>) function) {
-    final items = _cache.where(function);
+    if (_cache == null) {
+      return null;
+    }
+
+    final items = _cache!.where(function);
 
-    List<T>? list;
+    final List<T> list = [];
 
     for (final item in items) {
       if (_isItemOutdated(item)) {
         removeItem(item);
       } else {
-        list ??= [];
         list.add(item.item);
       }
     }
@@ -78,10 +88,13 @@ class Cache<T> {
 
   /// Inserts an item with the given key and duration into the cache
   void putWithDuration(String key, T item, Duration duration) {
+    // Initialize the cache if needed
+    _cache ??= [];
+
     final endTime = _nowInSeconds() + duration.inSeconds;
 
     final CacheItem<T> cacheItem = CacheItem<T>(key, item, endTime);
-    _cache.add(cacheItem);
+    _cache!.add(cacheItem);
 
     // Try to start the timer if not done yet
     _tryStartTimer();
@@ -95,12 +108,15 @@ class Cache<T> {
   /// Inserts many items into the cache with the given duration
   void putManyWithDuration(
       List<T> items, String Function(T item) getKey, Duration duration) {
+    // Initialize the cache if needed
+    _cache ??= [];
+
     final endTime = _nowInSeconds() + duration.inSeconds;
 
     for (final item in items) {
       final key = getKey(item);
       final CacheItem<T> cacheItem = CacheItem<T>(key, item, endTime);
-      _cache.add(cacheItem);
+      _cache!.add(cacheItem);
     }
 
     // Try to start the timer if not done yet
@@ -109,17 +125,17 @@ class Cache<T> {
 
   /// Removes the item with the given key from the cache
   void remove(String key) {
-    _cache.removeWhere((element) => element.key == key);
+    _cache?.removeWhere((element) => element.key == key);
   }
 
   /// Removes the given item from the cache
   void removeItem(CacheItem item) {
-    _cache.remove(item);
+    _cache?.remove(item);
   }
 
   /// Removes all items from the cache
   void removeAll() {
-    _cache.clear();
+    _cache?.clear();
   }
 
   /// Sets a new default duration
@@ -132,15 +148,17 @@ class Cache<T> {
   bool _isItemOutdated(CacheItem<T> item) => item.endTime <= _nowInSeconds();
 
   void _tryStartTimer() {
-    if (_cache.isEmpty || (_timer != null && _timer!.isActive)) {
+    if (_cache == null ||
+        _cache!.isEmpty ||
+        (_timer != null && _timer!.isActive)) {
       return;
     }
 
     _timer = Timer.periodic(const Duration(seconds: 10), _timerCallBack);
   }
 
   void _timerCallBack(Timer timer) {
-    if (_cache.isEmpty) {
+    if (_cache == null || _cache!.isEmpty) {
       _timer?.cancel();
       return;
     }

pubspec.lock

@@ -7,7 +7,7 @@ packages:
       name: async
       url: "https://pub.dartlang.org"
     source: hosted
-    version: "2.6.1"
+    version: "2.8.1"
   boolean_selector:
     dependency: transitive
     description:
@@ -28,7 +28,7 @@ packages:
       name: charcode
       url: "https://pub.dartlang.org"
     source: hosted
-    version: "1.2.0"
+    version: "1.3.1"
   clock:
     dependency: transitive
     description:
@@ -80,7 +80,7 @@ packages:
       name: meta
       url: "https://pub.dartlang.org"
     source: hosted
-    version: "1.3.0"
+    version: "1.7.0"
   path:
     dependency: transitive
     description:
@@ -134,7 +134,7 @@ packages:
       name: test_api
       url: "https://pub.dartlang.org"
     source: hosted
-    version: "0.3.0"
+    version: "0.4.2"
   typed_data:
     dependency: transitive
     description:

pubspec.yaml

@@ -1,6 +1,6 @@
 name: temp_cache
 description: A package which provides functionality to store objects inside a temporary cache inside memory
-version: 0.0.5
+version: 0.0.7
 homepage: https://github.com/DirtyNative/temp_cache
 
 environment: