Code Refactor & Updated plugins

Author: ProjectAJ14

.gitignore

@@ -18,7 +18,7 @@
 # The .vscode folder contains launch configuration and tasks you configure in
 # VS Code which you may wish to be included in version control, so this line
 # is commented out by default.
-#.vscode/
+.vscode/
 
 # Flutter/Dart/Pub related
 **/doc/api/

CHANGELOG.md

@@ -1,9 +1,8 @@
 ## [1.1.2]
-- Code Refactor & Updated plugins
-- Add String extensions for firstNChars, lastNChars, truncateMiddle.
-- Add Map extensions for getSDMap which returns Map<String, dynamic>.
-- Add Map extensions for getBoolWithDefaultValue which returns bool.
-- Add List<String> extensions for check containWithoutCase which returns bool.
+- Add String extensions for `firstNChars`, `lastNChars`, `truncateMiddle`.
+- Add Map extensions for `getSDMap` which returns `Map<String, dynamic>`.
+- Add Map extensions for `getBoolWithDefaultValue` which returns bool.
+- Add List\<String> extensions for check `containWithoutCase` which returns bool.
 
 ## [1.1.1]
 - Updated plugins

lib/constants.dart

@@ -16,10 +16,12 @@ const String defaultString = '';
 
 /// Default value for Map
 ///
-// ignore: always_specify_types
 const Map defaultMap = {};
 
+/// Default value for Map<String, dynamic>
+///
+const Map<String, dynamic> defaultSDMap = {};
+
 /// Default value for List
 ///
-// ignore: always_specify_types
 const List defaultList = [];

lib/extensions/context.dart

@@ -77,7 +77,6 @@ extension ContextExtensions on BuildContext {
       name: screen.toString(),
     );
     if (transparent) {
-      // ignore: always_specify_types
       return Navigator.of(this).pushReplacement(
         TransparentRoute(
           builder: (_) => screen,
@@ -86,15 +85,13 @@ extension ContextExtensions on BuildContext {
       );
     } else {
       if (isCupertino) {
-        // ignore: always_specify_types
         return Navigator.of(this).pushReplacement(
           CupertinoPageRoute(
             builder: (_) => screen,
             settings: settings,
           ),
         );
       }
-      // ignore: always_specify_types
       return Navigator.of(this).pushReplacement(
         MaterialPageRoute(
           builder: (_) => screen,
@@ -149,7 +146,6 @@ extension ContextExtensions on BuildContext {
   /// Pops the top-most route off the navigator till the first route.
   ///
   void popToFirst() {
-    // ignore: always_specify_types
     Navigator.of(this).popUntil((predicate) {
       return predicate.isFirst;
     });

lib/extensions/list.dart

@@ -5,7 +5,6 @@ import '../src.dart';
 
 /// extension methods for List
 ///
-// ignore: always_specify_types
 extension ListExtensions on List {
   ///List to JSON using[json.encode]
   ///
@@ -31,3 +30,10 @@ extension ListExtensions on List {
     return data;
   }
 }
+
+extension ListStringExtension on List<String> {
+  /// check if list contains value without considering case
+  bool containWithoutCase(String value) {
+    return any((element) => element.toLowerCase() == value.toLowerCase());
+  }
+}

lib/extensions/map.dart

@@ -5,7 +5,6 @@ import '../src.dart';
 
 /// extension methods for Map
 ///
-// ignore: always_specify_types
 extension MapExtensions on Map {
   /// Reads a [key] value of [bool] type from [Map].
   ///
@@ -57,7 +56,6 @@ extension MapExtensions on Map {
   ///
   /// If value is NULL or not [List] type return empty List[defaultList]
   ///
-  // ignore: always_specify_types
   List getList(String key) {
     if (containsKey(key)) {
       if (this[key] is List) {
@@ -72,7 +70,6 @@ extension MapExtensions on Map {
   ///
   /// If value is NULL or not [List] type return default value [defaultString]
   ///
-  // ignore: always_specify_types
   Map getMap(String key) {
     if (containsKey(key)) {
       if (this[key] is Map) {
@@ -83,6 +80,20 @@ extension MapExtensions on Map {
     return defaultMap;
   }
 
+  /// Reads a [key] value of [Map<String, dynamic>] type from [Map].
+  ///
+  /// If value is NULL or not [Map<String, dynamic>] type return default value [defaultSDMap]
+  ///
+  Map<String, dynamic> getSDMap(String key) {
+    if (containsKey(key)) {
+      if (this[key] is Map) {
+        return this[key] ?? defaultSDMap;
+      }
+    }
+    errorLogsNS("Map.getMap[$key] has incorrect data :  ${this[key]}");
+    return defaultSDMap;
+  }
+
   ///Add value to map if value is not null
   ///
   T add<T>({required String? key, required T? value}) =>
@@ -115,13 +126,22 @@ extension MapExtensions on Map {
 
   /// Returns a new map with null keys or values removed
   ///
-  // ignore: always_specify_types
-  Map<String, dynamic> get nullProtected => {...this}
-    // ignore: always_specify_types
-    ..removeWhere((String key, value) => value == null);
+  Map<String, dynamic> get nullProtected =>
+      {...this}..removeWhere((String key, value) => value == null);
+
+  /// Reads a [key] value of [bool] type from [Map].
+  /// If value is NULL or not [bool] type return default value [defaultBool]
+  ///
+  bool getBoolWithDefaultValue(String key, {bool defaultValue = defaultBool}) {
+    if (containsKey(key)) {
+      if (this[key] is bool) {
+        return this[key] ?? defaultValue;
+      }
+    }
+    return defaultValue;
+  }
 }
 
-// ignore: always_specify_types, type_annotate_public_apis
 dynamic toEncodable(object) {
   if (object is String ||
       object is num ||

lib/extensions/string.dart

@@ -9,7 +9,6 @@ import '../src.dart';
 extension StringExtensions on String {
   ///JSON String to Map using[json.decode]
   ///
-  // ignore: always_specify_types
   Map toMap() {
     try {
       if (isEmpty) return defaultMap;
@@ -22,7 +21,6 @@ extension StringExtensions on String {
 
   ///JSON String to List using[json.decode]
   ///
-  // ignore: always_specify_types
   List toList() {
     try {
       return json.decode(this);
@@ -120,6 +118,36 @@ extension StringExtensions on String {
   ///Add prefix if not empty else return empty string
   ///
   String get showDashIfEmpty => isEmpty ? '-' : this;
+
+  /// this will give last n characters of string
+  String lastNChars({int n = 1}) {
+    if (n > length || n < 1) return this;
+
+    return substring(length - n);
+  }
+
+  ///this will give first n characters of string
+  String firstNChars({int n = 1}) {
+    if (n > length || n < 1) return this;
+    return substring(0, n);
+  }
+
+  /// Truncates a long `String` in the middle while retaining the beginning and the end.
+  ///
+  /// Example :
+  ///   'Hello World'.truncateMiddle(3) // 'Hel...rld'
+  ///
+  String truncateMiddle({int maxChars = 3, String truncateKey = '...'}) {
+    if (isEmptyOrNull || maxChars < 1) {
+      return this;
+    }
+
+    if ((maxChars * 2) >= length) {
+      return this;
+    }
+
+    return '${firstNChars(n: maxChars)}$truncateKey${lastNChars(n: maxChars)}';
+  }
 }
 
 extension StringNullExtensions on String? {

test/extensions/list_test.dart

@@ -8,5 +8,11 @@ void main() {
       expect([].toJson(), '[]');
       expect(['123', '1234'].toJson(), '["123","1234"]');
     });
+
+    test('containWithoutCase', () {
+      List<String> list = ['Test', 'User'];
+      expect(list.containWithoutCase('test'), true);
+      expect(list.containWithoutCase('User1'), false);
+    });
   });
 }

test/extensions/map_test.dart

@@ -34,7 +34,6 @@ void main() {
       expect(data.getDouble('key'), 0);
     });
     test('getString', () {
-      // ignore: omit_local_variable_types
       Map data = {'id': null};
       expect(data.getString('key'), '');
       expect(data.getString('id'), '');
@@ -91,8 +90,7 @@ void main() {
         "phone": "+1 (985) 469-2418",
         "address": "181 Tilden Avenue, Hamilton, Idaho, 2062",
         "about":
-            // ignore: lines_longer_than_80_chars
-            "Fugiat consectetur exercitation ex eiusmod officia ex exercitation et est enim cillum consectetur deserunt fugiat. Ex aliqua cupidatat consectetur reprehenderit. Voluptate nisi ipsum magna aliqua deserunt consectetur dolor occaecat fugiat labore. Sit Lorem elit duis deserunt ipsum adipisicing amet. Ullamco esse commodo et laborum minim. Sunt et exercitation veniam magna aute.",
+            """Fugiat consectetur exercitation ex eiusmod officia ex exercitation et est enim cillum consectetur deserunt fugiat. Ex aliqua cupidatat consectetur reprehenderit. Voluptate nisi ipsum magna aliqua deserunt consectetur dolor occaecat fugiat labore. Sit Lorem elit duis deserunt ipsum adipisicing amet. Ullamco esse commodo et laborum minim. Sunt et exercitation veniam magna aute.""",
         "registered": "Thursday, November 2, 2017 10:07 PM",
         "latitude": "-36.620306",
         "longitude": "128.527698",
@@ -120,5 +118,30 @@ void main() {
       };
       expect(data.nullProtected, {"key": 1});
     });
+
+    test("getSDMap", (() {
+      Map data = {
+        'key': 1,
+        'key2': null,
+        'key3': {
+          'key4': 1,
+          'key5': null,
+        }
+      };
+      expect(data.getSDMap('key'), {});
+      expect(data.getSDMap('key2'), isA<Map<String, dynamic>>());
+      expect(data.getSDMap('key3'), {"key4": 1, "key5": null});
+    }));
+
+    test("getBoolWithDefaultValue", (() {
+      Map data = {
+        'key': false,
+        'key2': null,
+        'key3': true,
+      };
+      expect(data.getBoolWithDefaultValue('key', defaultValue: true), false);
+      expect(data.getBoolWithDefaultValue('key2', defaultValue: true), true);
+      expect(data.getBoolWithDefaultValue('key3', defaultValue: true), true);
+    }));
   });
 }

test/extensions/string_test.dart

@@ -59,5 +59,33 @@ void main() {
       String value = DateTime(2020, 08, 01).toIso8601String();
       expect(value.toDateTime(), DateTime(2020, 08, 01));
     });
+
+    test('truncate Middle', () {
+      expect(''.truncateMiddle(), '');
+      expect('12'.truncateMiddle(), '12');
+      expect('123456'.truncateMiddle(), '123456');
+      expect('1234567'.truncateMiddle(), '123...567');
+      expect('1234567890'.truncateMiddle(maxChars: 2), '12...90');
+      expect(
+        '1234567890'.truncateMiddle(maxChars: 2, truncateKey: "-"),
+        '12-90',
+      );
+    });
+
+    test('first N char', () {
+      expect(''.firstNChars(), '');
+      expect('12'.firstNChars(n: 5), '12');
+      expect('123456'.firstNChars(n: 2), '12');
+      expect('1234567'.firstNChars(n: 20), '1234567');
+      expect('1234567'.firstNChars(n: -20), '1234567');
+    });
+
+    test('last N char', () {
+      expect(''.lastNChars(), '');
+      expect('12'.lastNChars(n: 5), '12');
+      expect('123456'.lastNChars(n: 2), '56');
+      expect('1234567'.lastNChars(n: 20), '1234567');
+      expect('1234567'.lastNChars(n: -20), '1234567');
+    });
   });
 }