feat: add regex validation

Author: DanielleHuisman

Cargo.lock

@@ -12,6 +12,7 @@ version = "0.0.1"
 [workspace.dependencies]
 fortifier = { path = "./packages/fortifier", version = "0.0.1" }
 fortifier-macros = { path = "./packages/fortifier-macros", version = "0.0.1" }
+regex = "1.12.2"
 tokio = "1.48.0"
 
 [workspace.lints.rust]

Cargo.toml

@@ -10,6 +10,7 @@ version.workspace = true
 
 [dependencies]
 fortifier.workspace = true
+regex.workspace = true
 tokio = { workspace = true, features = ["macros", "rt-multi-thread"] }
 
 [lints]

example/Cargo.toml

@@ -1,6 +1,10 @@
-use std::error::Error;
+use std::{error::Error, sync::LazyLock};
 
 use fortifier::Validate;
+use regex::Regex;
+
+static COUNTRY_CODE_REGEX: LazyLock<Regex> =
+    LazyLock::new(|| Regex::new(r"[A-Z]{2}").expect("Regex should be valid."));
 
 #[derive(Validate)]
 struct CreateUser {
@@ -13,6 +17,9 @@ struct CreateUser {
     #[validate(url)]
     url: String,
 
+    #[validate(regex(expr = &COUNTRY_CODE_REGEX))]
+    country_code: String,
+
     #[validate(custom(function = validate_one_locale_required, error = OneLocaleRequiredError))]
     #[validate(length(min = 1))]
     locales: Vec<String>,
@@ -35,6 +42,7 @@ async fn main() -> Result<(), Box<dyn Error>> {
         email: "john@doe.com".to_owned(),
         name: "John Doe".to_owned(),
         url: "https://john.doe.com".to_owned(),
+        country_code: "GB".to_owned(),
         locales: vec!["en_GB".to_owned()],
     };
 

example/src/main.rs

@@ -5,7 +5,7 @@ use syn::{Field, Ident, Result};
 
 use crate::{
     validation::Validation,
-    validations::{Custom, Email, Length, Url},
+    validations::{Custom, Email, Length, Regex, Url},
 };
 
 pub struct ValidateField {
@@ -44,13 +44,17 @@ impl ValidateField {
                     } else if meta.path.is_ident("length") {
                         result.validations.push(Box::new(Length::parse(&meta)?));
 
+                        Ok(())
+                    } else if meta.path.is_ident("regex") {
+                        result.validations.push(Box::new(Regex::parse(&meta)?));
+
                         Ok(())
                     } else if meta.path.is_ident("url") {
                         result.validations.push(Box::new(Url::parse(&meta)?));
 
                         Ok(())
                     } else {
-                        Err(meta.error("unknown validate parameter"))
+                        Err(meta.error("unknown parameter"))
                     }
                 })?;
             }

packages/fortifier-macros/src/validate/field.rs

@@ -1,9 +1,11 @@
 mod custom;
 mod email;
 mod length;
+mod regex;
 mod url;
 
 pub use custom::*;
 pub use email::*;
 pub use length::*;
+pub use regex::*;
 pub use url::*;

packages/fortifier-macros/src/validations.rs

@@ -32,7 +32,7 @@ impl Validation for Length {
 
                 Ok(())
             } else {
-                Err(meta.error("unknown length parameter"))
+                Err(meta.error("unknown parameter"))
             }
         })?;
 

packages/fortifier-macros/src/validations/length.rs

@@ -0,0 +1,51 @@
+use proc_macro2::TokenStream;
+use quote::{format_ident, quote};
+use syn::{Expr, Ident, Result, meta::ParseNestedMeta};
+
+use crate::validation::Validation;
+
+pub struct Regex {
+    pub expr: Expr,
+}
+
+impl Validation for Regex {
+    fn parse(meta: &ParseNestedMeta<'_>) -> Result<Self> {
+        let mut expr: Option<Expr> = None;
+
+        meta.parse_nested_meta(|meta| {
+            if meta.path.is_ident("expr") {
+                expr = Some(meta.value()?.parse()?);
+
+                Ok(())
+            } else {
+                Err(meta.error("unknown parameter"))
+            }
+        })?;
+
+        let Some(expr) = expr else {
+            return Err(meta.error("missing expr parameter"));
+        };
+
+        Ok(Regex { expr })
+    }
+
+    fn is_async(&self) -> bool {
+        false
+    }
+
+    fn ident(&self) -> Ident {
+        format_ident!("Regex")
+    }
+
+    fn error_type(&self) -> TokenStream {
+        quote!(RegexError)
+    }
+
+    fn tokens(&self, expr: &TokenStream) -> TokenStream {
+        let regex_expr = &self.expr;
+
+        quote! {
+            #expr.validate_regex(#regex_expr)
+        }
+    }
+}

packages/fortifier-macros/src/validations/regex.rs

@@ -9,14 +9,16 @@ repository.workspace = true
 version.workspace = true
 
 [features]
-default = ["macros", "url"]
+default = ["macros", "regex", "url"]
 indexmap = ["dep:indexmap"]
 macros = ["dep:fortifier-macros"]
+regex = ["dep:regex"]
 url = ["dep:url"]
 
 [dependencies]
 fortifier-macros = { workspace = true, optional = true }
 indexmap = { version = "2.12.0", optional = true }
+regex = { workspace = true, optional = true }
 url = { version = "2.5.7", optional = true }
 
 [lints]

packages/fortifier/Cargo.toml

@@ -1,9 +1,13 @@
 mod email;
 mod length;
+#[cfg(feature = "regex")]
+mod regex;
 #[cfg(feature = "url")]
 mod url;
 
 pub use email::*;
 pub use length::*;
+#[cfg(feature = "regex")]
+pub use regex::*;
 #[cfg(feature = "url")]
 pub use url::*;