Implemented function 'getWhere()' which helps retrieving the correct items

Author: Daniel Martin

CHANGELOG.md

@@ -1,3 +1,7 @@
 ## 0.0.1
 
-* TODO: Describe initial release.
+Implemented basic functionality
+
+## 0.0.5
+
+Implemented function 'getWhere()' which helps retrieving the correct items

README.md

@@ -4,6 +4,18 @@ A package which provides functionality to store objects inside a temporary cache
 
 ## Getting Started
 
+Import the package within your **pubspec.yaml**
+
+```yaml
+temp_cache:
+```
+
+Then you can use the classes via importing the lib:
+
+``` dart
+import 'package:temp_cache/temp_cache.dart';
+```
+
 Store objects:
 
 ``` dart

lib/cache.dart

@@ -54,6 +54,23 @@ class Cache<T> {
     return list;
   }
 
+  List<T>? getWhere(bool Function(CacheItem<T>) function) {
+    final items = _cache.where(function);
+
+    List<T>? list;
+
+    for (final item in items) {
+      if (_isItemOutdated(item)) {
+        removeItem(item);
+      } else {
+        list ??= [];
+        list.add(item.item);
+      }
+    }
+
+    return list;
+  }
+
   /// Inserts an item with the given key into the cache
   void put(String key, T item) {
     putWithDuration(key, item, _duration);

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.4
+version: 0.0.5
 homepage: https://github.com/DirtyNative/temp_cache
 
 environment:

test/temp_cache_test.dart

@@ -48,6 +48,22 @@ void main() {
     expect(cache.getAll(), [item3, item2, item1]);
   });
 
+  test('Get where', () {
+    final cache = Cache<TestItem2>();
+
+    final item1 = TestItem2('1', 10);
+    final item2 = TestItem2('2', 20);
+    final item3 = TestItem2('3', 30);
+
+    final List<TestItem2> items = [item1, item2, item3];
+
+    cache.putMany(items, (item) => item.id);
+
+    final retrievedItems = cache.getWhere((item) => item.item.number > 15);
+
+    expect(retrievedItems, [item2, item3]);
+  });
+
   test('Remove item', () {
     final cache = Cache<TestItem>();
 
@@ -70,3 +86,10 @@ class TestItem {
 
   TestItem(this.id);
 }
+
+class TestItem2 {
+  late final String id;
+  late final int number;
+
+  TestItem2(this.id, this.number);
+}