implement isEqual

Author: ArturAssisComp

example/lib/new_api_examples/static_vs_dynamic_value_example_main.dart renamed to example/lib/new_api_examples/is_equal_main.dart

@@ -79,14 +79,6 @@ class _HomePageState extends State<_HomePage> {
                       validator: isRequired(isInt(isEqual(referenceValue))),
                     ),
                     const SizedBox(height: 5),
-                    TextFormField(
-                      decoration:
-                          const InputDecoration(labelText: 'isEqual (dynamic)'),
-                      autovalidateMode: AutovalidateMode.always,
-                      validator: isRequired(
-                          isInt(isEqual(null, dynValue: () => referenceValue))),
-                    ),
-                    const SizedBox(height: 5),
                     TextFormField(
                       decoration:
                           const InputDecoration(labelText: 'isEqual (old API)'),
@@ -105,15 +97,6 @@ class _HomePageState extends State<_HomePage> {
                       validator: isRequired(isInt(isEqual(referenceValue))),
                     ),
                     const SizedBox(height: 5),
-                    FormBuilderTextField(
-                      name: 'isEqual (dynamic)',
-                      autovalidateMode: AutovalidateMode.always,
-                      decoration:
-                          const InputDecoration(labelText: 'isEqual (dynamic)'),
-                      validator: isRequired(
-                          isInt(isEqual(null, dynValue: () => referenceValue))),
-                    ),
-                    const SizedBox(height: 5),
                     FormBuilderTextField(
                       name: 'isEqual (old API)',
                       autovalidateMode: AutovalidateMode.always,
@@ -138,14 +121,6 @@ class _HomePageState extends State<_HomePage> {
                                 isRequired(isInt(isEqual(referenceValue))),
                           ),
                           const SizedBox(height: 5),
-                          FormBuilderTextField(
-                            name: 'isEqual (dynamic)',
-                            decoration: const InputDecoration(
-                                labelText: 'isEqual (dynamic)'),
-                            validator: isRequired(isInt(
-                                isEqual(null, dynValue: () => referenceValue))),
-                          ),
-                          const SizedBox(height: 5),
                           FormBuilderTextField(
                             name: 'isEqual (old API)',
                             decoration: const InputDecoration(

lib/new_api_prototype/core_validators/equality_validators.dart

@@ -2,33 +2,23 @@ import '../../localization/l10n.dart';
 import '../constants.dart';
 
 /// This function returns a validator that checks if the user input is equal (using
-/// the == operator) to either `value` or `dynValue()`. If the condition is satisfied,
+/// the == operator) to either `value`. If the condition is satisfied,
 /// the validator returns null, otherwise, it returns
 /// `FormBuilderLocalizations.current.equalErrorText(userInput.toString())`, if
 /// `equalMsg` is not provided.
 ///
-/// # Parameters
-/// Exactly one of the inputs `value` or `dynValue` must be provided. If the value
-/// to be compared with is static, provide `value`. Otherwise, provide `dynValue`.
-///
 /// # Error
 /// - Throws [AssertionError] if not exactly one of `value` or `dynValue` was
 /// provided.
 Validator<T> isEqual<T extends Object?>(
-  T? value, {
-  T Function()? dynValue,
-  String Function(String)? equalMsg,
+  T value, {
+  String Function(String)? isEqualMsg,
 }) {
-  assert(
-      (value != null && dynValue == null) ||
-          (value == null && dynValue != null),
-      'Exactly one of "value" or "dynValue" must be provided');
   return (T input) {
-    final T? currentValue = value ?? dynValue?.call();
-    final String valueString = currentValue!.toString();
-    return currentValue == input
+    final String valueString = value.toString();
+    return value == input
         ? null
-        : equalMsg?.call(valueString) ??
+        : isEqualMsg?.call(valueString) ??
             FormBuilderLocalizations.current.equalErrorText(valueString);
   };
 }

test/new_api_testing/core_validators/equality_validators/is_equal_validator_test.dart

@@ -0,0 +1,111 @@
+import 'package:flutter_test/flutter_test.dart';
+import 'package:form_builder_validators/form_builder_validators.dart';
+
+class _CustomClass {}
+
+void main() {
+  final _CustomClass myObject = _CustomClass();
+
+  group('Validator: isEqual', () {
+    final List<
+        ({
+          String description,
+          bool testFails,
+          Object? referenceValue,
+          Object? userInput
+        })> testCases = <({
+      String description,
+      Object? referenceValue,
+      Object? userInput,
+      bool testFails
+    })>[
+      // Edge cases
+      (
+        description: 'Should match the null',
+        referenceValue: null,
+        userInput: null,
+        testFails: false
+      ),
+      (
+        description: 'Should not match the null',
+        referenceValue: null,
+        userInput: 123,
+        testFails: true
+      ),
+      (
+        description: 'Should match the empty string',
+        referenceValue: '',
+        userInput: '',
+        testFails: false
+      ),
+      (
+        description: 'Should not match the empty string',
+        referenceValue: '',
+        userInput: ' ',
+        testFails: true
+      ),
+      // Domain cases
+      (
+        description: 'Should match the integer 123',
+        referenceValue: 123,
+        userInput: 123,
+        testFails: false
+      ),
+      (
+        description: 'Should match the string "Hello, World!"',
+        referenceValue: 'Hello, World!',
+        userInput: 'Hello, World!',
+        testFails: false
+      ),
+      (
+        description: 'Should not match the string "Hello, World!"',
+        referenceValue: 'Hello, World!',
+        userInput: 'Hello, World!\n',
+        testFails: true
+      ),
+      (
+        description: 'Should match a custom class object',
+        referenceValue: myObject,
+        userInput: myObject,
+        testFails: false
+      ),
+      (
+        description: 'Should not match a custom class object',
+        referenceValue: myObject,
+        userInput: _CustomClass(),
+        testFails: true
+      ),
+    ];
+
+    for (final (
+          description: String desc,
+          referenceValue: Object? referenceValue,
+          userInput: Object? userInput,
+          testFails: bool testFails
+        ) in testCases) {
+      test(desc, () {
+        final Validator<Object?> v = isEqual(referenceValue);
+
+        expect(
+            v(userInput),
+            testFails
+                ? equals(FormBuilderLocalizations.current
+                    .equalErrorText(referenceValue.toString()))
+                : isNull);
+      });
+    }
+
+    test('Should return custom error message', () {
+      const String ref = 'hello';
+      const String customErrorMessage = 'custom error';
+      final Validator<Object> v =
+          isEqual(ref, isEqualMsg: (_) => customErrorMessage);
+
+      // success
+      expect(v(ref), isNull);
+
+      // failure
+      expect(v(123), customErrorMessage);
+    });
+  });
+}