feat: updates the exception class name and changes its message type to

Map

Author: LeadcodeDev

CHANGELOG.md

@@ -1,3 +1,8 @@
+## 1.7.1
+
+- Rename `ValidationException` class to `VineValidationException` to prevent collision with `ValidationException` class from another packages
+- Change `ValidationException.message` from `String` to `Map<String, dynamic>`
+
 ## 1.7.0
 
 - Rename `Field` class to `VineField`

lib/src/contracts/vine.dart

@@ -10,7 +10,7 @@ abstract interface class VineErrorReporter {
 
   void report(String rule, List<String> keys, String message);
 
-  Exception createError(Object message);
+  Exception createError(Map<String, dynamic> message);
 
   void clear();
 }

lib/src/error_reporter.dart

@@ -1,5 +1,3 @@
-import 'dart:convert';
-
 import 'package:vine/src/contracts/vine.dart';
 import 'package:vine/src/exceptions/validation_exception.dart';
 import 'package:vine/src/mapped_errors.dart';
@@ -42,8 +40,8 @@ class SimpleErrorReporter implements VineErrorReporter {
   }
 
   @override
-  Exception createError(Object message) {
-    return ValidationException(json.encode(message));
+  Exception createError(Map<String, dynamic> message) {
+    return VineValidationException(message);
   }
 
   @override

lib/src/exceptions/validation_exception.dart

@@ -1,11 +1,12 @@
-class ValidationException implements Exception {
+import 'dart:convert';
+
+class VineValidationException implements Exception {
   String code = 'E_VALIDATION_ERROR';
   final statusCode = 422;
 
-  final String message;
-  ValidationException(this.message);
-
+  final Map<String, dynamic> message;
+  VineValidationException(this.message);
 
   @override
-  String toString() => '[$code]: $message';
+  String toString() => '[$code]: ${json.encode(message)}';
 }

lib/src/vine.dart

@@ -132,11 +132,11 @@ final class Validator implements VineValidatorContract {
 
   VineSchema get schema => _schema.clone();
 
-  (ValidationException?, T?) tryValidate<T>(dynamic data) {
+  (VineValidationException?, T?) tryValidate<T>(dynamic data) {
     try {
       final result = validate(data);
       return (null, result);
-    } on ValidationException catch (exception) {
+    } on VineValidationException catch (exception) {
       return (exception, null);
     }
   }

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.7.0
+version: 1.7.1
 repository: https://github.com/LeadcodeDev/vine
 
 platforms:

test/rules/array_test.dart

@@ -95,15 +95,15 @@ void main() {
           () => validator.validate({
                 'value': ['foo', 1, true]
               }),
-          throwsA(isA<ValidationException>()));
+          throwsA(isA<VineValidationException>()));
     });
 
     test('is invalid when value is not array', () {
       final validator =
           vine.compile(vine.object({'value': vine.array(vine.string())}));
 
       expect(() => validator.validate({'value': 'foo'}),
-          throwsA(isA<ValidationException>()));
+          throwsA(isA<VineValidationException>()));
     });
   });
 
@@ -138,7 +138,7 @@ void main() {
           () => validator.validate({
                 'array': ['foo']
               }),
-          throwsA(isA<ValidationException>()));
+          throwsA(isA<VineValidationException>()));
     });
   });
 }

test/rules/boolean_test.dart

@@ -51,7 +51,7 @@ void main() {
       final validator = vine.compile(vine.object({'value': vine.boolean()}));
 
       expect(() => validator.validate({'value': 'foo'}),
-          throwsA(isA<ValidationException>()));
+          throwsA(isA<VineValidationException>()));
     });
   });
 }

test/rules/date_test.dart

@@ -51,8 +51,8 @@ void main() {
       'date': vine.date(),
     }));
 
-    expect(
-        () => validator.validate(payload), throwsA(isA<ValidationException>()));
+    expect(() => validator.validate(payload),
+        throwsA(isA<VineValidationException>()));
   });
 
   test('should be valid when value is between dates', () {
@@ -70,8 +70,8 @@ void main() {
       'date': vine.date().between(DateTime(2022), DateTime(2023)),
     }));
 
-    expect(
-        () => validator.validate(payload), throwsA(isA<ValidationException>()));
+    expect(() => validator.validate(payload),
+        throwsA(isA<VineValidationException>()));
   });
 
   group('Date rules', () {
@@ -97,7 +97,7 @@ void main() {
       }));
 
       expect(() => validator.validate(payload),
-          throwsA(isA<ValidationException>()));
+          throwsA(isA<VineValidationException>()));
     });
 
     test('should be valid when value is after the target date', () {
@@ -122,7 +122,7 @@ void main() {
       }));
 
       expect(() => validator.validate(payload),
-          throwsA(isA<ValidationException>()));
+          throwsA(isA<VineValidationException>()));
     });
 
     test('should be valid when value is before the target field', () {
@@ -150,7 +150,7 @@ void main() {
       }));
 
       expect(() => validator.validate(payload),
-          throwsA(isA<ValidationException>()));
+          throwsA(isA<VineValidationException>()));
     });
 
     test('should be valid when value is after the target field', () {
@@ -178,7 +178,7 @@ void main() {
       }));
 
       expect(() => validator.validate(payload),
-          throwsA(isA<ValidationException>()));
+          throwsA(isA<VineValidationException>()));
     });
 
     test('should be valid when value is between date fields', () {
@@ -210,7 +210,7 @@ void main() {
       }));
 
       expect(() => validator.validate(payload),
-          throwsA(isA<ValidationException>()));
+          throwsA(isA<VineValidationException>()));
     });
 
     test(
@@ -227,7 +227,7 @@ void main() {
       }));
 
       expect(() => validator.validate(payload),
-          throwsA(isA<ValidationException>()));
+          throwsA(isA<VineValidationException>()));
     });
 
     test(
@@ -245,7 +245,7 @@ void main() {
       }));
 
       expect(() => validator.validate(payload),
-          throwsA(isA<ValidationException>()));
+          throwsA(isA<VineValidationException>()));
     });
 
     test('should be valid when value has attempted value after transformation',

test/rules/enum_test.dart

@@ -32,7 +32,7 @@ void main() {
           vine.compile(vine.object({'value': vine.enumerate(MyEnum.values)}));
 
       expect(() => validator.validate({'value': 'value4'}),
-          throwsA(isA<ValidationException>()));
+          throwsA(isA<VineValidationException>()));
     });
 
     test('is valid when value is nullable', () {