feat: implement new phone regexp property

Author: LeadcodeDev

CHANGELOG.md

@@ -1,3 +1,6 @@
+## 1.4.0
+- Add `RegExp` property in phone validation rule
+
 ## 1.3.0
 - Add missing `VineNotSameAsRule` implementation
 - Implement `VineRegexRule` validation rule

lib/src/contracts/schema.dart

@@ -112,7 +112,7 @@ abstract interface class VineString implements VineSchema, BasicSchema<VineStrin
   /// ```dart
   /// vine.string().phone(message: 'The value must be a valid phone number');
   /// ```
-  VineString phone({String? message});
+  VineString phone({RegExp? match, String? message});
 
   /// Check if the string is an IP address [version] the IP address version [message] the error message to display
   /// ```dart

lib/src/rules/string_rule.dart

@@ -4,7 +4,7 @@ import 'package:vine/src/contracts/schema.dart';
 import 'package:vine/src/contracts/vine.dart';
 import 'package:vine/src/helper.dart';
 
-final regex = RegExp(r'^\+?[0-9]{1,4}[-.\s]?[0-9]{1,4}[-.\s]?[0-9]{4,10}$');
+final europeanPhoneRegex = RegExp(r'^\+?[0-9]{1,4}[-.\s]?[0-9]{1,4}[-.\s]?[0-9]{4,10}$');
 
 final class VineStringRule implements VineRule {
   final String? message;
@@ -93,13 +93,15 @@ final class VineEmailRule implements VineRule {
 }
 
 final class VinePhoneRule implements VineRule {
+  final RegExp? regex;
   final String? message;
 
-  const VinePhoneRule(this.message);
+  const VinePhoneRule(this.regex, this.message);
 
   @override
   void handle(VineValidationContext ctx, FieldContext field) {
-    if (field.value case String value when !regex.hasMatch(value)) {
+    final currentRegexp = regex ?? europeanPhoneRegex;
+    if (field.value case String value when !currentRegexp.hasMatch(value)) {
       final error = ctx.errorReporter.format('phone', field, message, {});
       ctx.errorReporter.report('phone', [...field.customKeys, field.name], error);
     }
@@ -161,16 +163,18 @@ final class VineUrlRule implements VineRule {
   final bool allowUnderscores;
   final String? message;
 
-  const VineUrlRule(this.protocols, this.requireTld, this.requireProtocol, this.allowUnderscores, this.message);
+  const VineUrlRule(
+      this.protocols, this.requireTld, this.requireProtocol, this.allowUnderscores, this.message);
 
   @override
   void handle(VineValidationContext ctx, FieldContext field) {
-    if (field.value case String value when !value.isURL({
-      'protocols': protocols,
-      'requireTld': requireTld,
-      'requireProtocol': requireProtocol,
-      'allowUnderscores': allowUnderscores,
-    })) {
+    if (field.value case String value
+        when !value.isURL({
+          'protocols': protocols,
+          'requireTld': requireTld,
+          'requireProtocol': requireProtocol,
+          'allowUnderscores': allowUnderscores,
+        })) {
       final error = ctx.errorReporter.format('url', field, message, {});
       ctx.errorReporter.report('url', [...field.customKeys, field.name], error);
     }
@@ -214,7 +218,8 @@ final class VineStartWithRule implements VineRule {
   @override
   void handle(VineValidationContext ctx, FieldContext field) {
     if (field.value case String value when !value.startsWith(attemptedValue)) {
-      final error = ctx.errorReporter.format('startWith', field, message, {'value': attemptedValue});
+      final error =
+          ctx.errorReporter.format('startWith', field, message, {'value': attemptedValue});
       ctx.errorReporter.report('startWith', [...field.customKeys, field.name], error);
     }
   }
@@ -248,13 +253,15 @@ final class VineConfirmedRule implements VineRule {
     final hasKey = ctx.data.containsKey(confirmedKey);
 
     if (!hasKey) {
-      final error = ctx.errorReporter.format('missingProperty', field, message, {'field': confirmedKey});
+      final error =
+          ctx.errorReporter.format('missingProperty', field, message, {'field': confirmedKey});
       ctx.errorReporter.report('missingProperty', [...field.customKeys, field.name], error);
     }
 
     final currentValue = ctx.data[confirmedKey];
     if ((field.value as String) != currentValue) {
-      final error = ctx.errorReporter.format('confirmed', field, message, {'attemptedName': confirmedKey});
+      final error =
+          ctx.errorReporter.format('confirmed', field, message, {'attemptedName': confirmedKey});
       ctx.errorReporter.report('confirmed', [...field.customKeys, field.name], error);
     }
 

lib/src/schema/string_schema.dart

@@ -30,8 +30,8 @@ final class VineStringSchema extends RuleParser implements VineString {
   }
 
   @override
-  VineString phone({String? message}) {
-    super.addRule(VinePhoneRule(message));
+  VineString phone({RegExp? match, String? message}) {
+    super.addRule(VinePhoneRule(match, message));
     return this;
   }
 

pubspec.yaml

@@ -1,6 +1,6 @@
 name: vine
 description: Vine is a robust, typed validation library for Dart/Flutter, designed to simplify and secure data management in applications
-version: 1.3.0
+version: 1.4.0
 repository: https://github.com/LeadcodeDev/vine
 
 platforms:

test/rules/string_test.dart

@@ -94,6 +94,15 @@ void main() {
       expect(() => validator.validate(payload), throwsA(isA<ValidationException>()));
     });
 
+    test('valid custom phone regexp', () {
+      final payload = {'phone': '1230025900'};
+      final validator = vine.compile(vine.object({
+        'phone': vine.string().phone(match: RegExp(r'^\d{10}$')),
+      }));
+
+      expect(() => validator.validate(payload), returnsNormally);
+    });
+
     test('valid ipAddress IPv4', () {
       final payload = {'ip': '192.168.1.1'};
       final validator = vine.compile(vine.object({