null safety update

Author: suragch

CHANGELOG.md

@@ -1,5 +1,9 @@
 # Changes
 
+## 0.2.0-nullsafety.0
+
+- Updated for null safety
+
 ## 0.1.4
 
 - Bug fix for `isURL()` with `require_protocol` option.

README.md

@@ -11,7 +11,7 @@ The is a new fork of [validator.dart](https://github.com/karan/validator.dart),
 - **contains(String str, seed)** - check if the string contains the seed.
 - **matches(String str, pattern)** - check if string matches the pattern. `matches('foobar', 'foo')`.
 - **isEmail(String str)** - check if the string is an email.
-- **isURL(String str [, options])** - check if the string is an URL. `options` is an object which defaults to `{ protocols: ['http','https','ftp'], require_tld: true, require_protocol: false, allow_underscores: false, host_whitelist: false, host_blacklist: false }`.
+- **isURL(String str [, options])** - check if the string is an URL. `options` is an object which defaults to `{ protocols: ['http','https','ftp'], require_tld: true, require_protocol: false, allow_underscores: false }`.
 - **isFQDN(String str [, options])** - check if the string is a fully qualified domain name (e.g. domain.com). `options` is an object which defaults to `{ require_tld: true, allow_underscores: false }`.
 - **isIP(String str [, version])** - check if the string is an IP (version 4 or 6).
 - **isAlpha(String str)** - check if the string contains only letters (a-zA-Z).
@@ -58,12 +58,4 @@ The is a new fork of [validator.dart](https://github.com/karan/validator.dart),
 - **stripLow(String input [, keep_new_lines])** - remove characters with a numerical value < 32 and 127, mostly control characters. If `keep_new_lines` is `true`, newline characters are preserved (`\n` and `\r`, hex `0xA` and `0xD`). Unicode-safe in JavaScript.
 - **whitelist(String input, chars)** - remove characters that do not appear in the whitelist. The characters are used in a RegExp and so you will need to escape some chars, e.g. whitelist(String input, '\\[\\]').
 - **blacklist(String input, chars)** - remove characters that appear in the blacklist. The characters are used in a RegExp and so you will need to escape some chars, e.g. blacklist(String input, '\\[\\]').
-- **normalizeEmail(String email [, options])** - canonicalize an email address. `options` is an object which defaults to `{ lowercase: true }`. With `lowercase` set to `true`, the local part of the email address is lowercased for all domains; the hostname is always lowercased and the local part of the email address is always lowercased for hosts that are known to be case-insensitive (currently only GMail). Normalization follows special rules for known providers: currently, GMail addresses have dots removed in the local part and are stripped of tags (e.g. `some.one+tag@gmail.com` becomes `someone@gmail.com`) and all `@googlemail.com` addresses are normalized to `@gmail.com`.
-
-## Tests
-
-To test the package, run:
-
-```
-$ pub run test test/test_all.dart
-```
+- **normalizeEmail(String email [, options])** - canonicalize an email address. `options` is an object which defaults to `{ lowercase: true }`. With `lowercase` set to `true`, the local part of the email address is lowercased for all domains; the hostname is always lowercased and the local part of the email address is always lowercased for hosts that are known to be case-insensitive (currently only GMail). Normalization follows special rules for known providers: currently, GMail addresses have dots removed in the local part and are stripped of tags (e.g. `some.one+tag@gmail.com` becomes `someone@gmail.com`) and all `@googlemail.com` addresses are normalized to `@gmail.com`.

example/example.dart

@@ -1,12 +1,15 @@
 import 'package:string_validator/string_validator.dart';
 
-main() {
+void main() {
   String userInput = 'http://localhost:61500this is an invalid url!!!!';
   bool isValid = isURL(userInput); // false
+  print(isValid);
 
   userInput = 'me@example.com';
   isValid = isEmail(userInput); // true
+  print(isValid);
 
   userInput = 'password1';
   isValid = isLength(userInput, 12); // false
+  print(isValid);
 }

lib/src/helpers.dart

@@ -9,9 +9,9 @@ shift(List l) {
   return null;
 }
 
-Map merge(Map obj, defaults) {
+Map<String, Object> merge(Map<String, Object>? obj, Map<String, Object> defaults) {
   if (obj == null) {
-    obj = Map();
+    return defaults;
   }
   defaults.forEach((key, val) => obj.putIfAbsent(key, () => val));
   return obj;

lib/src/sanitizer.dart

@@ -1,7 +1,7 @@
 import 'helpers.dart';
 import 'validator.dart';
 
-Map _default_normalize_email_options = {'lowercase': true};
+Map<String, Object> _default_normalize_email_options = {'lowercase': true};
 
 /// convert the input to a string
 String toString(input) {
@@ -12,7 +12,7 @@ String toString(input) {
 }
 
 /// convert the input to a date, or null if the input is not a date
-DateTime toDate(String str) {
+DateTime? toDate(String str) {
   try {
     return DateTime.parse(str);
   } catch (e) {
@@ -51,29 +51,29 @@ num toInt(String str, {int radix = 10}) {
 ///
 /// Everything except for '0', 'false' and ''
 /// returns `true`. In `strict` mode only '1' and 'true' return `true`.
-bool toBoolean(String str, [bool strict]) {
+bool toBoolean(String str, [bool strict = false]) {
   if (strict == true) {
     return str == '1' || str == 'true';
   }
   return str != '0' && str != 'false' && str != '';
 }
 
 /// trim characters (whitespace by default) from both sides of the input
-String trim(String str, [String chars]) {
+String trim(String str, [String? chars]) {
   RegExp pattern = (chars != null)
       ? RegExp('^[$chars]+|[$chars]+\$')
       : RegExp(r'^\s+|\s+$');
   return str.replaceAll(pattern, '');
 }
 
 /// trim characters from the left-side of the input
-String ltrim(String str, [String chars]) {
+String ltrim(String str, [String? chars]) {
   var pattern = chars != null ? RegExp('^[$chars]+') : RegExp(r'^\s+');
   return str.replaceAll(pattern, '');
 }
 
 /// trim characters from the right-side of the input
-String rtrim(String str, [String chars]) {
+String rtrim(String str, [String? chars]) {
   var pattern = chars != null ? RegExp('[$chars]+\$') : RegExp(r'\s+$');
   return str.replaceAll(pattern, '');
 }
@@ -98,7 +98,7 @@ String blacklist(String str, String chars) {
 ///
 /// If `keep_new_lines` is `true`, newline characters are preserved
 /// `(\n and \r, hex 0xA and 0xD)`.
-String stripLow(String str, [bool keep_new_lines]) {
+String stripLow(String str, [bool keep_new_lines = false]) {
   String chars = keep_new_lines == true
       ? '\x00-\x09\x0B\x0C\x0E-\x1F\x7F'
       : '\x00-\x1F\x7F';
@@ -117,7 +117,7 @@ String escape(String str) {
 
 /// canonicalize an email address.
 ///
-/// `options` is an `Map` which defaults to
+/// `options` is a `Map` which defaults to
 /// `{ lowercase: true }`. With lowercase set to true, the local part of the
 /// email address is lowercased for all domains; the hostname is always
 /// lowercased and the local part of the email address is always lowercased
@@ -126,7 +126,7 @@ String escape(String str) {
 /// GMail addresses have dots removed in the local part and are stripped of
 /// tags (e.g. `some.one+tag@gmail.com` becomes `someone@gmail.com`) and all
 /// `@googlemail.com` addresses are normalized to `@gmail.com`.
-String normalizeEmail(String email, [Map options]) {
+String normalizeEmail(String email, [Map<String, Object>? options]) {
   options = merge(options, _default_normalize_email_options);
   if (isEmail(email) == false) {
     return '';

lib/src/validator.dart

@@ -72,21 +72,17 @@ bool isEmail(String str) {
 ///
 /// `options` is a `Map` which defaults to
 /// `{ 'protocols': ['http','https','ftp'], 'require_tld': true,
-/// 'require_protocol': false, 'allow_underscores': false,
-/// 'host_whitelist': false, 'host_blacklist': false }`.
-bool isURL(String str, [Map options]) {
-  if (str == null ||
-      str.isEmpty ||
-      str.length > 2083 ||
-      str.indexOf('mailto:') == 0) {
+/// 'require_protocol': false, 'allow_underscores': false }`.
+bool isURL(String str, [Map<String, Object>? options]) {
+  if (str.isEmpty || str.length > 2083 || str.indexOf('mailto:') == 0) {
     return false;
   }
 
-  Map default_url_options = {
+  final default_url_options = {
     'protocols': ['http', 'https', 'ftp'],
     'require_tld': true,
     'require_protocol': false,
-    'allow_underscores': false
+    'allow_underscores': false,
   };
 
   options = merge(options, default_url_options);
@@ -108,7 +104,8 @@ bool isURL(String str, [Map options]) {
   split = str.split('://');
   if (split.length > 1) {
     protocol = shift(split);
-    if (options['protocols'].indexOf(protocol) == -1) {
+    final protocols = options['protocols'] as List<String>;
+    if (protocols.indexOf(protocol) == -1) {
       return false;
     }
   } else if (options['require_protocol'] == true) {
@@ -177,16 +174,6 @@ bool isURL(String str, [Map options]) {
     return false;
   }
 
-  if (options['host_whitelist'] == true &&
-      options['host_whitelist'].indexOf(host) == -1) {
-    return false;
-  }
-
-  if (options['host_blacklist'] == true &&
-      options['host_blacklist'].indexOf(host) != -1) {
-    return false;
-  }
-
   return true;
 }
 
@@ -211,12 +198,15 @@ bool isIP(String str, [version]) {
 /// check if the string is a fully qualified domain name (e.g. domain.com).
 ///
 /// `options` is a `Map` which defaults to `{ 'require_tld': true, 'allow_underscores': false }`.
-bool isFQDN(str, [options]) {
-  Map default_fqdn_options = {'require_tld': true, 'allow_underscores': false};
+bool isFQDN(String str, [Map<String, Object>? options]) {
+  final default_fqdn_options = {
+    'require_tld': true,
+    'allow_underscores': false
+  };
 
   options = merge(options, default_fqdn_options);
   List parts = str.split('.');
-  if (options['require_tld']) {
+  if (options['require_tld'] as bool) {
     var tld = parts.removeLast();
     if (parts.isEmpty || !RegExp(r'^[a-z]{2,}$').hasMatch(tld)) {
       return false;
@@ -225,7 +215,7 @@ bool isFQDN(str, [options]) {
 
   for (var part, i = 0; i < parts.length; i++) {
     part = parts[i];
-    if (options['allow_underscores']) {
+    if (options['allow_underscores'] as bool) {
       if (part.indexOf('__') >= 0) {
         return false;
       }
@@ -303,23 +293,18 @@ bool isDivisibleBy(String str, n) {
   }
 }
 
-/// check if the string is null
-bool isNull(String str) {
-  return str == null || str.isEmpty;
-}
-
 /// check if the string's length falls in a range
 /// If no max is given then any length above min is ok.
 ///
 /// Note: this function takes into account surrogate pairs.
-bool isLength(String str, int min, [int max]) {
+bool isLength(String str, int min, [int? max]) {
   List surrogatePairs = _surrogatePairsRegExp.allMatches(str).toList();
   int len = str.length - surrogatePairs.length;
   return len >= min && (max == null || len <= max);
 }
 
 /// check if the string's length (in bytes) falls in a range.
-bool isByteLength(String str, int min, [int max]) {
+bool isByteLength(String str, int min, [int? max]) {
   return str.length >= min && (max == null || str.length <= max);
 }
 
@@ -331,7 +316,7 @@ bool isUUID(String str, [version]) {
     version = version.toString();
   }
 
-  RegExp pat = _uuid[version];
+  RegExp? pat = _uuid[version];
   return (pat != null && pat.hasMatch(str.toUpperCase()));
 }
 

pubspec.yaml

@@ -1,8 +1,11 @@
 name: string_validator
-version: 0.1.4
+version: 0.2.0-nullsafety.0
 description: Dart library for validating and sanitizing strings, especially those from user input.
 homepage: https://github.com/suragch/string_validator
+
 environment:
-  sdk: '>=2.0.0 <3.0.0'
+  sdk: '>=2.12.0-29.10.beta <3.0.0'
+  
 dev_dependencies:
-  test: ^1.5.3
+  pedantic: ^1.10.0-nullsafety.3
+  test: ^1.16.0-nullsafety.11

test/sanitizer_test.dart

@@ -1,4 +1,4 @@
-import "package:test/test.dart";
+import 'package:test/test.dart';
 import 'package:string_validator/string_validator.dart' as s;
 
 void main() {

test/test_all.dart

@@ -98,7 +98,7 @@ void main() {
     expect(v.isURL('http://www.foo---bar.com/'), equals(false));
     expect(v.isURL('http://www.foo_bar.com/'), equals(false));
     expect(v.isURL(''), equals(false));
-    expect(v.isURL('http://foobar.com/' + new List(2083).join('f')),
+    expect(v.isURL('http://foobar.com/' + ('f' * 2083)),
         equals(false));
     expect(v.isURL('http://*.foo.com'), equals(false));
     expect(v.isURL('*.foo.com'), equals(false));
@@ -269,15 +269,6 @@ void main() {
     expect(v.isDivisibleBy('abc', '2'), equals(false));
   });
 
-  test('string is null', () {
-    // valid
-    expect(v.isNull(null), equals(true));
-    expect(v.isNull(''), equals(true));
-    // invalid
-    expect(v.isNull(' '), equals(false));
-    expect(v.isNull('foo'), equals(false));
-  });
-
   test('length at least', () {
     // valid
     expect(v.isLength('ab', 2), equals(true));