refactor: rename email to email address

Author: DanielleHuisman

benchmarks/compile/Cargo.toml

@@ -17,7 +17,7 @@ validator = ["dep:validator"]
 
 [dependencies]
 fortifier = { workspace = true, features = [
-    "email",
+    "email-address",
     "serde",
     "url",
 ], optional = true }

book/src/SUMMARY.md

@@ -7,7 +7,7 @@
     - [Enum](./validate/enum.md)
     - [Struct](./validate/struct.md)
 - [Validations](./validations/README.md)
-    - [Email](./validations/email.md)
+    - [Email Address](./validations/email-address.md)
     - [Length](./validations/length.md)
     - [Phone Number](./validations/phone-number.md)
     - [Regex]()

book/src/getting-started.md

@@ -5,7 +5,7 @@
 Add Fortifier to your project:
 
 ```shell
-cargo add fortifier --features email
+cargo add fortifier --features email-address
 ```
 
 See [Installation](installation.md) for more details.
@@ -46,7 +46,7 @@ use fortifier::Validate;
 
 #[derive(Validate)]
 struct CreateUser {
-    #[validate(email)]
+    #[validate(email_address)]
     email_address: String,
 
     #[validate(length(min = 1, max = 256))]
@@ -62,11 +62,11 @@ Call the `validate_sync` method on the data structure:
 
 ```rust
 # extern crate fortifier;
-use fortifier::{EmailError, LengthError, Validate, ValidationErrors};
+use fortifier::{EmailAddressError, LengthError, Validate, ValidationErrors};
 
 #[derive(Validate)]
 struct CreateUser {
-    #[validate(email)]
+    #[validate(email_address)]
     email_address: String,
 
     #[validate(length(min = 1, max = 256))]
@@ -90,7 +90,7 @@ fn main() {
         data.validate_sync(),
         Err(ValidationErrors::from_iter([
             CreateUserValidationError::EmailAddress(
-                EmailError::MissingSeparator {},
+                EmailAddressError::MissingSeparator {},
             ),
             CreateUserValidationError::Name(
                 LengthError::Min {

book/src/installation.md

@@ -22,7 +22,8 @@ cargo add fortifier
 ### Validations
 
 - `all-validations` - Enable all features below.
-- `email` - Email address validation using the [`email_address`](https://docs.rs/email_address/latest/email_address/) crate.
+- `email-address` - Email address validation using the [`email_address`](https://docs.rs/email_address/latest/email_address/) crate.
+- `phone-number` - Phone number validation using the [`phonenumber`](https://docs.rs/phonenumber/latest/phonenumber/) crate.
 - `regex` - Regular expression validation using the [`regex`](https://docs.rs/regex/latest/regex/) crate.
 - `url` - URL validation using the [`url`](https://docs.rs/url/latest/url/) crate.
 

book/src/introduction.md

@@ -6,7 +6,7 @@ Schema validation.
 - Enums & structs
 - Typed errors
 - Built-in validations
-    - Email
+    - Email address
     - Length
     - Phone number
     - Regex

book/src/validations/README.md

@@ -1,6 +1,6 @@
 # Validations
 
-- [Email](./email.md)
+- [Email Address](./email-address.md)
 - [Length](./length.md)
 - [Phone Number](./phone-number.md)
 - [URL](./url.md)

book/src/validations/email.md book/src/validations/email-address.mdbook/src/validations/email.md renamed to book/src/validations/email-address.md

@@ -1,7 +1,7 @@
-# Email
+# Email Address
 
 > [!NOTE]
-> Requires the `email` feature.
+> Requires the `email-address` feature.
 
 Validate a string is an RFC-compliant email address using the [`email_address`](https://docs.rs/email_address/latest/email_address/) crate.
 
@@ -11,7 +11,7 @@ Validate a string is an RFC-compliant email address using the [`email_address`](
 #
 ##[derive(Validate)]
 struct User {
-    #[validate(email)]
+    #[validate(email_address)]
     email_address: String
 }
 ```
@@ -47,7 +47,7 @@ See [`Options::allow_display_text`](https://docs.rs/email_address/latest/email_a
 #
 ##[derive(Validate)]
 struct User<'a> {
-    #[validate(email(allow_display_text = false))]
+    #[validate(email_address(allow_display_text = false))]
     email_address: &'a str
 }
 
@@ -76,7 +76,7 @@ See [`Options::allow_domain_literal`](https://docs.rs/email_address/latest/email
 #
 ##[derive(Validate)]
 struct User<'a> {
-    #[validate(email(allow_domain_literal = false))]
+    #[validate(email_address(allow_domain_literal = false))]
     email_address: &'a str
 }
 
@@ -105,7 +105,7 @@ See [`Options::minimum_sub_domains`](https://docs.rs/email_address/latest/email_
 #
 ##[derive(Validate)]
 struct User<'a> {
-    #[validate(email(minimum_sub_domains = 2))]
+    #[validate(email_address(minimum_sub_domains = 2))]
     email_address: &'a str
 }
 

examples/basic/Cargo.toml

@@ -10,7 +10,7 @@ version.workspace = true
 
 [dependencies]
 fortifier = { workspace = true, features = [
-    "email",
+    "email-address",
     "phone-number",
     "regex",
     "url",

examples/basic/src/email_address.rs

@@ -3,13 +3,13 @@ use fortifier::Validate;
 #[derive(Validate)]
 pub enum ChangeEmailAddressRelation {
     Create {
-        #[validate(email)]
+        #[validate(email_address)]
         email_address: String,
     },
     Update {
         id: String,
 
-        #[validate(email)]
+        #[validate(email_address)]
         email_address: String,
     },
     Delete {

examples/basic/src/main.rs

@@ -11,7 +11,7 @@ use crate::{email_address::ChangeEmailAddressRelation, user::CreateUser};
 async fn main() -> Result<(), Box<dyn Error>> {
     let data = CreateUser {
         name: "John Doe".to_owned(),
-        email: "john@doe.com".to_owned(),
+        email_address: "john@doe.com".to_owned(),
         phone_number: "+44 20 7946 0000".to_owned(),
         url: "https://john.doe.com".to_owned(),
         country_code: "GB".to_owned(),