Implement Custom Validation Messages With localization support

Author: Alhiane

Package.swift

@@ -4,6 +4,7 @@ import PackageDescription
 
 let package = Package(
     name: "ValidatorKit",
+    defaultLocalization: "en",
     platforms: [
         .iOS(.v13),
         .macOS(.v10_15),
@@ -17,7 +18,11 @@ let package = Package(
     ],
     targets: [
         .target(
-            name: "ValidatorKit"),
+            name: "ValidatorKit",
+            resources: [
+                .process("Resources/Localization")
+            ]
+        ),
         .testTarget(
             name: "ValidatorKitTests",
             dependencies: ["ValidatorKit"]

Sources/ValidatorKit/Resources/Localization/ar.lproj/Localizable.strings

@@ -0,0 +1,24 @@
+//
+//  Localizable.strings
+//  ValidatorKit
+//
+//  Created by Alhiane on 26/9/2024.
+//
+
+/* Localizable.strings (Arabic) */
+"validation.custom" = "فشلت عملية التحقق.";
+"validation.email" = "يرجى إدخال عنوان بريد إلكتروني صالح.";
+"validation.min" = "يجب أن تكون القيمة على الأقل %@.";
+"validation.max" = "يجب ألا تتجاوز القيمة %@.";
+"validation.numeric" = "يرجى إدخال قيمة رقمية.";
+"validation.date" = "يرجى إدخال تاريخ صالح.";
+"validation.range" = "يجب أن تكون القيمة بين %@ و %@.";
+"validation.pattern" = "القيمة لا تتطابق مع النموذج المطلوب.";
+"validation.url" = "يرجى إدخال عنوان URL صالح.";
+"validation.inArray" = "يجب أن تكون القيمة واحدة من الخيارات المسموح بها.";
+"validation.requiredIf" = "هذا الحقل مطلوب بناءً على الشرط المحدد.";
+"validation.required" = "هذا الحقل مطلوب.";
+"validation.greaterThan" = "يجب أن تكون القيمة أكبر من %@.";
+"validation.lessThan" = "يجب أن تكون القيمة أقل من %@.";
+"validation.mimeTypes" = "يجب أن يكون نوع الملف واحدًا من الأنواع المسموح بها: %@.";
+

Sources/ValidatorKit/Resources/Localization/en.lproj/Localizable.strings

@@ -0,0 +1,24 @@
+//
+//  Localizable.strings
+//  ValidatorKit
+//
+//  Created by Alhiane on 26/9/2024.
+//
+
+/* Localizable.strings (English) */
+"validation.custom" = "Validation failed.";
+"validation.email" = "Please enter a valid email address.";
+"validation.min" = "Value must be at least %@.";
+"validation.max" = "Value must be no more than %@.";
+"validation.numeric" = "Please enter a numeric value.";
+"validation.date" = "Please enter a valid date.";
+"validation.range" = "Value must be between %@ and %@.";
+"validation.pattern" = "Value does not match the required pattern.";
+"validation.url" = "Please enter a valid URL.";
+"validation.inArray" = "Value must be one of the allowed options.";
+"validation.requiredIf" = "This field is required based on the specified condition.";
+"validation.required" = "This field is required.";
+"validation.greaterThan" = "Value must be greater than %@.";
+"validation.lessThan" = "Value must be less than %@.";
+"validation.mimeTypes" = "File type must be one of the allowed types: %@.";
+

Sources/ValidatorKit/Resources/Localization/es.lproj/Localizable.strings

@@ -0,0 +1,23 @@
+//
+//  Localizable.strings
+//  ValidatorKit
+//
+//  Created by Alhiane on 26/9/2024.
+//
+
+/* Localizable.strings (Spanish) */
+"validation.custom" = "La validación falló.";
+"validation.email" = "Por favor, introduce una dirección de correo electrónico válida.";
+"validation.min" = "El valor debe ser al menos %@.";
+"validation.max" = "El valor no debe exceder %@.";
+"validation.numeric" = "Por favor, introduce un valor numérico.";
+"validation.date" = "Por favor, introduce una fecha válida.";
+"validation.range" = "El valor debe estar entre %@ y %@.";
+"validation.pattern" = "El valor no coincide con el patrón requerido.";
+"validation.url" = "Por favor, introduce una URL válida.";
+"validation.inArray" = "El valor debe ser una de las opciones permitidas.";
+"validation.requiredIf" = "Este campo es obligatorio según la condición especificada.";
+"validation.required" = "Este campo es obligatorio.";
+"validation.greaterThan" = "El valor debe ser mayor que %@.";
+"validation.lessThan" = "El valor debe ser menor que %@.";
+"validation.mimeTypes" = "El tipo de archivo debe ser uno de los tipos permitidos: %@.";

Sources/ValidatorKit/Resources/Localization/fr.lproj/Localizable.strings

@@ -0,0 +1,24 @@
+//
+//  Localizable.strings
+//  ValidatorKit
+//
+//  Created by Alhiane on 26/9/2024.
+//
+
+/* Localizable.strings (French) */
+"validation.custom" = "La validation a échoué.";
+"validation.email" = "Veuillez saisir une adresse e-mail valide.";
+"validation.min" = "La valeur doit être au moins %@.";
+"validation.max" = "La valeur ne doit pas dépasser %@.";
+"validation.numeric" = "Veuillez saisir une valeur numérique.";
+"validation.date" = "Veuillez saisir une date valide.";
+"validation.range" = "La valeur doit être entre %@ et %@.";
+"validation.pattern" = "La valeur ne correspond pas au modèle requis.";
+"validation.url" = "Veuillez saisir une URL valide.";
+"validation.inArray" = "La valeur doit être l'une des options autorisées.";
+"validation.requiredIf" = "Ce champ est obligatoire en fonction de la condition spécifiée.";
+"validation.required" = "Ce champ est obligatoire.";
+"validation.greaterThan" = "La valeur doit être supérieure à %@.";
+"validation.lessThan" = "La valeur doit être inférieure à %@.";
+"validation.mimeTypes" = "Le type de fichier doit être l'un des types autorisés : %@.";
+

Sources/ValidatorKit/Rules/AnyValidationRule.swift

@@ -6,9 +6,11 @@
 //
 public struct AnyValidationRule: ValidationRule {
     private let _validate: (Any?) -> ValidationError?
+    public let message: String
 
     public init<R: ValidationRule>(_ rule: R) {
         _validate = rule.validate
+        self.message = rule.message
     }
 
     public func validate(_ value: Any?) -> ValidationError? {

Sources/ValidatorKit/Rules/DateRule.swift

@@ -7,11 +7,15 @@
 import Foundation
 
 public struct DateRule: ValidationRule {
-    public init() {}
+    public let message: String
+
+    public init(message: String? = nil) {
+        self.message = message ?? ValidationMessage.message(for: ValidationMessage.dateKey, defaultMessage: ValidationMessage.date)
+    }
 
     public func validate(_ value: Any?) -> ValidationError? {
         if !(value is Date) {
-            return ValidationError(message: "Invalid date")
+            return ValidationError(message: message)
         }
         return nil
     }

Sources/ValidatorKit/Rules/EmailRule.swift

@@ -8,18 +8,23 @@
 import Foundation
 
 public struct EmailRule: ValidationRule {
-    public init() {}
+    public let message: String
+    
+    public init(message: String? = nil) {
+        self.message = message ?? ValidationMessage.message(for: ValidationMessage.emailKey, defaultMessage: ValidationMessage.email)
+
+    }
 
     public func validate(_ value: Any?) -> ValidationError? {
         guard let email = value as? String else {
-            return ValidationError(message: "Invalid email format")
+            return ValidationError(message: message)
         }
 
         let emailRegex = "[A-Z0-9a-z._%+-]+@[A-Za-z0-9.-]+\\.[A-Za-z]{2,64}"
         let emailPredicate = NSPredicate(format:"SELF MATCHES %@", emailRegex)
 
         guard emailPredicate.evaluate(with: email) else {
-            return ValidationError(message: "Invalid email format")
+            return ValidationError(message: message)
         }
 
         return nil

Sources/ValidatorKit/Rules/FileExtensionsRule.swift

@@ -7,18 +7,20 @@
 
 public struct FileExtensionsRule: ValidationRule {
     private let allowedExtensions: [String]
+    public let message: String
 
-    public init(allowedExtensions: [String]) {
+    public init(allowedExtensions: [String], message: String? = nil) {
         self.allowedExtensions = allowedExtensions
+        self.message = message ?? ValidationMessage.message(for: ValidationMessage.mimeTypesKey, defaultMessage: ValidationMessage.mimeTypes)
     }
 
     public func validate(_ value: Any?) -> ValidationError? {
         guard let filename = value as? String, let fileExtension = filename.split(separator: ".").last?.lowercased() else {
-            return ValidationError(message: "Invalid file")
+            return ValidationError(message: ValidationMessage.message(for: ValidationMessage.invalidFileKey, defaultMessage: ValidationMessage.invalidFile))
         }
 
         if !allowedExtensions.contains(fileExtension) {
-            return ValidationError(message: "File extension not allowed")
+            return ValidationError(message: message)
         }
         return nil
     }

Sources/ValidatorKit/Rules/GreaterThanRule.swift

@@ -5,16 +5,18 @@
 //  Created by Alhiane on 23/9/2024.
 //
 public struct GreaterThanRule: ValidationRule {
+    public let message: String
     private let minValue: Double
 
-    public init(minValue: Double) {
-        self.minValue = minValue
+    public init(minValue: Double, message: String? = nil) {
+        self.minValue = minValue        
+        self.message = message ?? ValidationMessage.message(for: ValidationMessage.greaterThanKey, defaultMessage: ValidationMessage.greaterThan,dynamicValues: [String(minValue)])
     }
 
     public func validate(_ value: Any?) -> ValidationError? {
-        guard let doubleValue = value as? Double else { return ValidationError(message: "Invalid value") }
+        guard let doubleValue = value as? Double else { return ValidationError(message: ValidationMessage.message(for: ValidationMessage.invalidValueKey, defaultMessage: ValidationMessage.invalidValue)) }
         if doubleValue <= minValue {
-            return ValidationError(message: "Must be greater than \(minValue)")
+            return ValidationError(message: message)
         }
         return nil
     }