Implemented lint, added example

Author: Daniel Martin

.vscode/launch.json

@@ -0,0 +1 @@
+include: package:lint/analysis_options_package.yaml

analysis_options.yaml

@@ -0,0 +1,30 @@
+import 'package:temp_cache/cache.dart';
+
+void main(List<String> args) {
+  final cache = Cache<TestItem>();
+  final item1 = TestItem('1');
+  final item2 = TestItem('2');
+  final item3 = TestItem('3');
+
+  // put one
+  cache.put(item1.id, item1);
+
+  // put many
+  final List<TestItem> items = [item2, item3];
+  cache.putMany(items, (item) => item.id);
+
+  // get one
+  // ignore: unused_local_variable
+  final i1 = cache.get('1');
+
+  // get all
+  // ignore: unused_local_variable
+  final retrievedList = cache.getAll();
+}
+
+class TestItem {
+  late final String id;
+  late final bool isTrue;
+
+  TestItem(this.id);
+}

example/main.dart

@@ -14,7 +14,7 @@ class Cache<T> {
   Timer? _timer;
 
   Cache({Duration? duration}) {
-    _duration = duration ?? Duration(minutes: 60);
+    _duration = duration ?? const Duration(minutes: 60);
   }
 
   /// Gets a cached item with the given key
@@ -41,7 +41,7 @@ class Cache<T> {
     List<T>? list;
 
     for (int index = _cache.length - 1; index >= 0; index--) {
-      var item = _cache[index];
+      final item = _cache[index];
 
       if (_isItemOutdated(item)) {
         removeItem(item);
@@ -61,7 +61,7 @@ class Cache<T> {
 
   /// Inserts an item with the given key and duration into the cache
   void putWithDuration(String key, T item, Duration duration) {
-    var endTime = _nowInSeconds() + duration.inSeconds;
+    final endTime = _nowInSeconds() + duration.inSeconds;
 
     final CacheItem<T> cacheItem = CacheItem<T>(key, item, endTime);
     _cache.add(cacheItem);
@@ -78,13 +78,13 @@ 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) {
-    var endTime = _nowInSeconds() + duration.inSeconds;
+    final endTime = _nowInSeconds() + duration.inSeconds;
 
-    items.forEach((item) {
-      var key = getKey(item);
+    for (final item in items) {
+      final key = getKey(item);
       final CacheItem<T> cacheItem = CacheItem<T>(key, item, endTime);
       _cache.add(cacheItem);
-    });
+    }
 
     // Try to start the timer if not done yet
     _tryStartTimer();
@@ -106,6 +106,7 @@ class Cache<T> {
   }
 
   /// Sets a new default duration
+  // ignore: avoid_setters_without_getters
   set duration(Duration dur) {
     _duration = dur;
   }
@@ -118,7 +119,7 @@ class Cache<T> {
       return;
     }
 
-    _timer = Timer.periodic(Duration(seconds: 10), _timerCallBack);
+    _timer = Timer.periodic(const Duration(seconds: 10), _timerCallBack);
   }
 
   void _timerCallBack(Timer timer) {

lib/cache.dart

@@ -60,6 +60,13 @@ packages:
     description: flutter
     source: sdk
     version: "0.0.0"
+  lint:
+    dependency: "direct dev"
+    description:
+      name: lint
+      url: "https://pub.dartlang.org"
+    source: hosted
+    version: "1.6.0"
   matcher:
     dependency: transitive
     description:
@@ -143,5 +150,5 @@ packages:
     source: hosted
     version: "2.1.0"
 sdks:
-  dart: ">=2.12.0 <3.0.0"
+  dart: ">=2.13.0 <3.0.0"
   flutter: ">=1.17.0"

pubspec.lock

@@ -1,19 +1,21 @@
 name: temp_cache
 description: A package which provides functionality to store objects inside a temporary cache inside memory
-version: 0.0.1
+version: 0.0.4
 homepage: https://github.com/DirtyNative/temp_cache
 
 environment:
   sdk: ">=2.12.0 <3.0.0"
   flutter: ">=1.17.0"
 
 dependencies:
+  collection: ^1.15.0
   flutter:
     sdk: flutter
-  collection: ^1.15.0
-
+  
 dev_dependencies:
   flutter_test:
     sdk: flutter
 
+  lint:
+
 flutter:

pubspec.yaml

@@ -3,11 +3,11 @@ import 'package:temp_cache/temp_cache.dart';
 
 void main() {
   test('Cache single', () {
-    var cache = Cache<TestItem>();
+    final cache = Cache<TestItem>();
 
-    final item1 = TestItem('1', true);
-    final item2 = TestItem('2', true);
-    final item3 = TestItem('3', false);
+    final item1 = TestItem('1');
+    final item2 = TestItem('2');
+    final item3 = TestItem('3');
 
     cache.put(item1.id, item1);
     cache.put(item2.id, item2);
@@ -19,11 +19,11 @@ void main() {
   });
 
   test('Cache multiple', () {
-    var cache = Cache<TestItem>();
+    final cache = Cache<TestItem>();
 
-    final item1 = TestItem('1', true);
-    final item2 = TestItem('2', true);
-    final item3 = TestItem('3', false);
+    final item1 = TestItem('1');
+    final item2 = TestItem('2');
+    final item3 = TestItem('3');
 
     final List<TestItem> items = [item1, item2, item3];
 
@@ -35,11 +35,11 @@ void main() {
   });
 
   test('Get all', () {
-    var cache = Cache<TestItem>();
+    final cache = Cache<TestItem>();
 
-    final item1 = TestItem('1', true);
-    final item2 = TestItem('2', true);
-    final item3 = TestItem('3', false);
+    final item1 = TestItem('1');
+    final item2 = TestItem('2');
+    final item3 = TestItem('3');
 
     final List<TestItem> items = [item1, item2, item3];
 
@@ -49,11 +49,11 @@ void main() {
   });
 
   test('Remove item', () {
-    var cache = Cache<TestItem>();
+    final cache = Cache<TestItem>();
 
-    final item1 = TestItem('1', true);
-    final item2 = TestItem('2', true);
-    final item3 = TestItem('3', false);
+    final item1 = TestItem('1');
+    final item2 = TestItem('2');
+    final item3 = TestItem('3');
 
     final List<TestItem> items = [item1, item2, item3];
 
@@ -67,7 +67,6 @@ void main() {
 
 class TestItem {
   late final String id;
-  late final bool isTrue;
 
-  TestItem(this.id, this.isTrue);
+  TestItem(this.id);
 }