refactor

Author: ArturAssisComp

example/lib/password_benchmark.dart

@@ -1,6 +1,6 @@
 import 'package:benchmark_harness/benchmark_harness.dart';
 import 'package:form_builder_validators/form_builder_validators.dart';
-import 'package:form_builder_validators/new_api_prototype.dart'
+import 'package:form_builder_validators/new_api_prototype/new_api_prototype.dart'
     show isReq, password;
 
 import 'package:flutter/material.dart';

lib/form_builder_validators.dart

@@ -31,7 +31,7 @@ export 'localization/intl/messages_tr.dart';
 export 'localization/intl/messages_uk.dart';
 export 'localization/intl/messages_zh.dart';
 export 'localization/l10n.dart';
-export 'new_api_prototype.dart'; // This is the new api prototype
+export 'new_api_prototype/new_api_prototype.dart'; // This is the new api prototype
 export 'src/base_validator.dart';
 export 'src/bool/bool.dart';
 export 'src/collection/collection.dart';

lib/new_api_prototype/collection_validators.dart

@@ -0,0 +1,36 @@
+import '../localization/l10n.dart';
+import 'constants.dart';
+
+Validator<T> minLength<T extends Object>(int minLength,
+    {String Function(int)? minLengthMsg}) {
+  return (value) {
+    // I think it makes more sense to say that scalar objects has length 1 instead of 0.
+    int valueLength = 1;
+
+    if (value is String) valueLength = value.length;
+    if (value is Iterable) valueLength = value.length;
+    if (value is Map) valueLength = value.length;
+
+    return valueLength < minLength
+        ? minLengthMsg?.call(minLength) ??
+            FormBuilderLocalizations.current.minLengthErrorText(minLength)
+        : null;
+  };
+}
+
+Validator<T> maxLength<T extends Object>(int maxLength,
+    {String Function(int)? maxLengthMsg}) {
+  return (value) {
+    // I think it makes more sense to say that scalar objects has length 1 instead of 0.
+    int valueLength = 1;
+
+    if (value is String) valueLength = value.length;
+    if (value is Iterable) valueLength = value.length;
+    if (value is Map) valueLength = value.length;
+
+    return valueLength > maxLength
+        ? maxLengthMsg?.call(maxLength) ??
+            FormBuilderLocalizations.current.maxLengthErrorText(maxLength)
+        : null;
+  };
+}

lib/new_api_prototype/composition_validators.dart

@@ -0,0 +1,39 @@
+// Composition validators
+import 'constants.dart';
+
+Validator<T> and<T extends Object>(
+  List<Validator<T>> validators, {
+  bool printErrorAsSoonAsPossible = true,
+}) {
+  return (T value) {
+    final errorMessageBuilder = <String>[];
+    for (final validator in validators) {
+      final errorMessage = validator(value);
+      if (errorMessage != null) {
+        if (printErrorAsSoonAsPossible) {
+          return errorMessage;
+        }
+        errorMessageBuilder.add(errorMessage);
+      }
+    }
+    if (errorMessageBuilder.isNotEmpty) {
+      return errorMessageBuilder.join(' AND ');
+    }
+
+    return null;
+  };
+}
+
+Validator<T> or<T extends Object>(List<Validator<T>> validators) {
+  return (T value) {
+    final errorMessageBuilder = <String>[];
+    for (final validator in validators) {
+      final errorMessage = validator(value);
+      if (errorMessage == null) {
+        return null;
+      }
+      errorMessageBuilder.add(errorMessage);
+    }
+    return errorMessageBuilder.join(' OR ');
+  };
+}

lib/new_api_prototype/constants.dart

@@ -0,0 +1 @@
+typedef Validator<T extends Object?> = String? Function(T);

lib/new_api_prototype/generic_type_validators.dart

@@ -0,0 +1,120 @@
+import '../localization/l10n.dart';
+import 'constants.dart';
+
+Validator<T> containsElement<T extends Object>(
+  List<T> values, {
+  String? containsElementMsg,
+}) {
+  return (T value) {
+    return values.contains(value)
+        ? null
+        : containsElementMsg ??
+            FormBuilderLocalizations.current.containsElementErrorText;
+  };
+}
+
+Validator<T> isEqual<T extends Object?>(T value,
+    {String Function(String)? equalMsg}) {
+  return (input) {
+    final valueString = value.toString();
+    return value == input
+        ? null
+        : equalMsg?.call(valueString) ??
+            FormBuilderLocalizations.current.equalErrorText(valueString);
+  };
+}
+
+/// Returns a [Validator] function that checks if its `T` input is a `true`
+/// boolean or a [String] parsable to a `true` boolean. If the input satisfies
+/// this condition, the validator returns `null`. Otherwise, it returns the
+/// default error message
+/// `FormBuilderLocalizations.current.mustBeTrueErrorText`, if [isTrueMsg]
+/// is not provided.
+///
+/// # Parsing rules
+/// If the input of the validator is a [String], it will be parsed using
+/// the rules specified by the combination of [caseSensitive] and [trim].
+/// [caseSensitive] indicates whether the lowercase must be considered equal to
+/// uppercase or not, and [trim] indicates whether whitespaces from both sides
+/// of the string will be ignored or not.
+///
+/// The default behavior is to ignore leading and trailing whitespaces and be
+/// case insensitive.
+///
+/// # Examples
+/// ```dart
+/// // The following examples must pass:
+/// assert(isTrue()(' true ') == null);
+/// assert(isTrue(trim:false)(' true ') != null);
+/// assert(isTrue()('TRue') == null);
+/// assert(isTrue(caseSensitive:true)('TRue') != null);
+/// ```
+Validator<T> isTrue<T extends Object>(
+    {String? isTrueMsg, bool caseSensitive = false, bool trim = true}) {
+  return (value) {
+    final (isValid, typeTransformedValue) = _isBoolValidateAndConvert(
+      value,
+      caseSensitive: caseSensitive,
+      trim: trim,
+    );
+    if (isValid && typeTransformedValue! == true) {
+      return null;
+    }
+    return isTrueMsg ?? FormBuilderLocalizations.current.mustBeTrueErrorText;
+  };
+}
+
+/// Returns a [Validator] function that checks if its `T` input is a `false`
+/// boolean or a [String] parsable to a `false` boolean. If the input satisfies
+/// this condition, the validator returns `null`. Otherwise, it returns the
+/// default error message
+/// `FormBuilderLocalizations.current.mustBeFalseErrorText`, if [isFalseMsg]
+/// is not provided.
+///
+/// # Parsing rules
+/// If the input of the validator is a [String], it will be parsed using
+/// the rules specified by the combination of [caseSensitive] and [trim].
+/// [caseSensitive] indicates whether the lowercase must be considered equal to
+/// uppercase or not, and [trim] indicates whether whitespaces from both sides
+/// of the string will be ignored or not.
+///
+/// The default behavior is to ignore leading and trailing whitespaces and be
+/// case insensitive.
+///
+/// # Examples
+/// ```dart
+/// // The following examples must pass:
+/// assert(isFalse()(' false ') == null);
+/// assert(isFalse(trim:false)(' false ') != null);
+/// assert(isFalse()('FAlse') == null);
+/// assert(isFalse(caseSensitive:true)('FAlse') != null);
+/// ```
+Validator<T> isFalse<T extends Object>(
+    {String? isFalseMsg, bool caseSensitive = false, bool trim = true}) {
+  return (value) {
+    final (isValid, typeTransformedValue) = _isBoolValidateAndConvert(
+      value,
+      caseSensitive: caseSensitive,
+      trim: trim,
+    );
+    if (isValid && typeTransformedValue! == false) {
+      return null;
+    }
+    return isFalseMsg ?? FormBuilderLocalizations.current.mustBeFalseErrorText;
+  };
+}
+
+(bool, bool?) _isBoolValidateAndConvert<T extends Object>(T value,
+    {bool caseSensitive = false, bool trim = true}) {
+  if (value is bool) {
+    return (true, value);
+  }
+  if (value is String) {
+    final bool? candidateValue = bool.tryParse(trim ? value.trim() : value,
+        caseSensitive: caseSensitive);
+    if (candidateValue != null) {
+      return (true, candidateValue);
+    }
+  }
+  return (false, null);
+}

lib/new_api_prototype/new_api_prototype.dart

@@ -0,0 +1,8 @@
+export 'composition_validators.dart';
+export 'constants.dart';
+export 'generic_type_validators.dart';
+export 'numeric_validators.dart';
+export 'override_error_msg.dart';
+export 'required_validators.dart';
+export 'string_validators.dart';
+export 'type_validators.dart';