Merge pull request #61 from NoxOrg/NoxTypes/20-StreetAddress

Nox types/20 street address

src/Nox.Types/Types/StreetAddress/CountryPostalCodeValidator.cs

@@ -0,0 +1,242 @@
+using System.Collections.Generic;
+using System.Linq;
+using System.Text.RegularExpressions;
+
+namespace Nox.Types;
+
+/// <summary>
+/// Validates Postal Code against country postal code formats.
+/// </summary>
+internal static class CountryPostalCodeValidator
+{
+    private const int PostCodeMaxLength = 15;
+
+    /// <summary>
+    /// Checks whether given Postal Code matches  country postal code pattern.
+    /// </summary>
+    /// <param name="countryCode">Input Country Code.</param>
+    /// <param name="postalCode">Input Postal Code.</param>
+    /// <returns>True if postal code matches pattern.</returns>
+    public static bool IsValid(string countryCode, string postalCode)
+    {
+        if (postalCode.Length > PostCodeMaxLength)
+        {
+            return false;
+        }
+
+        var patterns = _postalCodeMapping
+            .Where(x => x.CountryCode == countryCode)
+            .Select(x => x.Pattern)
+            .ToList();
+
+        var isValid = true;
+
+        foreach (var pattern in patterns)
+        {
+            var isMath = Regex.IsMatch(postalCode, pattern);
+
+            if (!isMath)
+            {
+                isValid = false;
+                break;
+            }
+        }
+
+        return isValid;
+    }
+
+    private static readonly List<(string CountryCode, string Pattern)> _postalCodeMapping = new()
+    {
+        ("AF",@"^\d{4}$"),
+        ("AX",@"^\d{5}$"),
+        ("AL",@"^\d{4}$"),
+        ("DZ",@"^\d{5}$"),
+        ("AS",@"^\d{5}(-{1}\d{4,6})$"),
+        ("AD",@"^[Aa][Dd]\d{3}$"),
+        ("AI",@"^[Aa][I][-][2][6][4][0]$"),
+        ("AR",@"^\d{4}|[A-Za-z]\d{4}[a-zA-Z]{3}$"),
+        ("AM",@"^\d{4}$"),
+        ("AC",@"^[Aa][Ss][Cc][Nn]\s{0,1}[1][Zz][Zz]$"),
+        ("AU",@"^\d{4}$"),
+        ("AT",@"^\d{4}$"),
+        ("AZ",@"^[Aa][Zz]\d{4}$"),
+        ("BH",@"^\d{3,4}$"),
+        ("BD",@"^\d{4}$"),
+        ("BB",@"^[Aa][Zz]\d{5}$"),
+        ("BY",@"^\d{6}$"),
+        ("BE",@"^\d{4}$"),
+        ("BM",@"^[A-Za-z]{2}\s([A-Za-z]{2}|\d{2})$"),
+        ("BT",@"^\d{5}$"),
+        ("BO",@"^\d{4}$"),
+        ("BA",@"^\d{5}$"),
+        ("BR",@"^\d{5}-\d{3}$"),
+        ("IO",@"^[Bb]{2}[Nn][Dd]\s{0,1}[1][Zz]{2}$"),
+        ("VG",@"^[Vv][Gg]\d{4}$"),
+        ("BN",@"^[A-Za-z]{2}\d{4}$"),
+        ("BG",@"^\d{4}$"),
+        ("KH",@"^\d{5}$"),
+        ("CA",@"^(?=[^DdFfIiOoQqUu\d\s])[A-Za-z]\d(?=[^DdFfIiOoQqUu\d\s])[A-Za-z]\s{0,1}\d(?=[^DdFfIiOoQqUu\d\s])[A-Za-z]\d$"),
+        ("CV",@"^\d{4}$"),
+        ("KY",@"^[Kk][Yy]\d[-\s]{0,1}\d{4}$"),
+        ("TD",@"^\d{5}$"),
+        ("CL",@"^\d{7}\s\(\d{3}-\d{4}\)$"),
+        ("CN",@"^\d{6}$"),
+        ("CX",@"^\d{4}$"),
+        ("CC",@"^\d{4}$"),
+        ("CO",@"^\d{6}$"),
+        ("CD",@"^[Cc][Dd]$"),
+        ("CR",@"^\d{4,5}$"),
+        ("HR",@"^\d{5}$"),
+        ("CU",@"^\d{5}$"),
+        ("CY",@"^\d{4}$"),
+        ("CZ",@"^\d{5}\s\(\d{3}\s\d{2}\)$"),
+        ("DK",@"^\d{4}$"),
+        ("DO",@"^\d{5}$"),
+        ("EC",@"^\d{6}$"),
+        ("SV",@"^1101$"),
+        ("EG",@"^\d{5}$"),
+        ("EE",@"^\d{5}$"),
+        ("ET",@"^\d{4}$"),
+        ("FK",@"^[Ff][Ii][Qq]{2}\s{0,1}[1][Zz]{2}$"),
+        ("FO",@"^\d{3}$"),
+        ("FI",@"^\d{5}$"),
+        ("FR",@"^\d{5}$"),
+        ("GF",@"^973\d{2}$"),
+        ("PF",@"^987\d{2}$"),
+        ("GA",@"^\d{2}\s[a-zA-Z-_ ]\s\d{2}$"),
+        ("GE",@"^\d{4}$"),
+        ("DE",@"^\d{2}$"),
+        ("DE",@"^\d{4}$"),
+        ("DE",@"^\d{5}$"),
+        ("GI",@"^[Gg][Xx][1]{2}\s{0,1}[1][Aa]{2}$"),
+        ("GR",@"^\d{3}\s{0,1}\d{2}$"),
+        ("GL",@"^\d{4}$"),
+        ("GP",@"^971\d{2}$"),
+        ("GU",@"^\d{5}$"),
+        ("GT",@"^\d{5}$"),
+        ("GG",@"^[A-Za-z]{2}\d\s{0,1}\d[A-Za-z]{2}$"),
+        ("GW",@"^\d{4}$"),
+        ("HT",@"^\d{4}$"),
+        ("HM",@"^\d{4}$"),
+        ("HN",@"^\d{5}$"),
+        ("HU",@"^\d{4}$"),
+        ("IS",@"^\d{3}$"),
+        ("IN",@"^\d{6}$"),
+        ("ID",@"^\d{5}$"),
+        ("IR",@"^\d{5}-\d{5}$"),
+        ("IQ",@"^\d{5}$"),
+        ("IM",@"^[Ii[Mm]\d{1,2}\s\d\[A-Z]{2}$"),
+        ("IL",@"^\b\d{5}(\d{2})?$"),
+        ("IT",@"^\d{5}$"),
+        ("JM",@"^\d{2}$"),
+        ("JP",@"^\d{7}\s\(\d{3}-\d{4}\)$"),
+        ("JE",@"^[Jj][Ee]\d\s{0,1}\d[A-Za-z]{2}$"),
+        ("JO",@"^\d{5}$"),
+        ("KZ",@"^\d{6}$"),
+        ("KE",@"^\d{5}$"),
+        ("KR",@"^\d{6}\s\(\d{3}-\d{3}\)$"),
+        ("XK",@"^\d{5}$"),
+        ("KW",@"^\d{5}$"),
+        ("KG",@"^\d{6}$"),
+        ("LV",@"^[Ll][Vv][- ]{0,1}\d{4}$"),
+        ("LA",@"^\d{5}$"),
+        ("LB",@"^\d{4}\s{0,1}\d{4}$"),
+        ("LS",@"^\d{3}$"),
+        ("LR",@"^\d{4}$"),
+        ("LY",@"^\d{5}$"),
+        ("LI",@"^\d{4}$"),
+        ("LT",@"^[Ll][Tt][- ]{0,1}\d{5}$"),
+        ("LU",@"^\d{4}$"),
+        ("MK",@"^\d{4}$"),
+        ("MG",@"^\d{3}$"),
+        ("MV",@"^\d{4,5}$"),
+        ("MY",@"^\d{5}$"),
+        ("MT",@"^[A-Za-z]{3}\s{0,1}\d{4}$"),
+        ("MH",@"^\d{5}$"),
+        ("MQ",@"^972\d{2}$"),
+        ("YT",@"^976\d{2}$"),
+        ("FM",@"^\d{5}(-{1}\d{4})$"),
+        ("MX",@"^\d{5}$"),
+        ("FM",@"^\d{5}$"),
+        ("MD",@"^[Mm][Dd][- ]{0,1}\d{4}$"),
+        ("MC",@"^980\d{2}$"),
+        ("MN",@"^\d{5}$"),
+        ("ME",@"^\d{5}$"),
+        ("MS",@"^[Mm][Ss][Rr]\s{0,1}\d{4}$"),
+        ("MA",@"^\d{5}$"),
+        ("MZ",@"^\d{4}$"),
+        ("MM",@"^\d{5}$"),
+        ("NA",@"^\d{5}$"),
+        ("NP",@"^\d{5}$"),
+        ("NL",@"^\d{4}\s{0,1}[A-Za-z]{2}$"),
+        ("NC",@"^988\d{2}$"),
+        ("NZ",@"^\d{4}$"),
+        ("NI",@"^\d{5}$"),
+        ("NE",@"^\d{4}$"),
+        ("NG",@"^\d{6}$"),
+        ("NF",@"^\d{4}$"),
+        ("MP",@"^\d{5}$"),
+        ("NO",@"^\d{4}$"),
+        ("OM",@"^\d{3}$"),
+        ("PK",@"^\d{5}$"),
+        ("PW",@"^\d{5}$"),
+        ("PA",@"^\d{6}$"),
+        ("PG",@"^\d{3}$"),
+        ("PY",@"^\d{4}$"),
+        ("PE",@"^\d{5}$"),
+        ("PH",@"^\d{4}$"),
+        ("PN",@"^[Pp][Cc][Rr][Nn]\s{0,1}[1][Zz]{2}$"),
+        ("PL",@"^\d{2}[- ]{0,1}\d{3}$"),
+        ("PT",@"^\d{4}$"),
+        ("PT",@"^\d{4}[- ]{0,1}\d{3}$"),
+        ("PR",@"^\d{5}$"),
+        ("RE",@"^974\d{2}$"),
+        ("RO",@"^\d{6}$"),
+        ("RU",@"^\d{6}$"),
+        ("BL",@"^97133$"),
+        ("SH",@"^[Ss][Tt][Hh][Ll]\s{0,1}[1][Zz]{2}$"),
+        ("MF",@"^97150$"),
+        ("PM",@"^97500$"),
+        ("VC",@"^[Vv][Cc]\d{4}$"),
+        ("SM",@"^4789\d$"),
+        ("SA",@"^\d{5}(-{1}\d{4})?$"),
+        ("SN",@"^\d{5}$"),
+        ("RS",@"^\d{5}$"),
+        ("RS",@"^\d{5}$"),
+        ("SG",@"^\d{2}$"),
+        ("SG",@"^\d{4}$"),
+        ("SG",@"^\d{6}$"),
+        ("SK",@"^\d{5}\s\(\d{3}\s\d{2}\)$"),
+        ("SI",@"^([Ss][Ii][- ]{0,1}){0,1}\d{4}$"),
+        ("ZA",@"^\d{4}$"),
+        ("GS",@"^[Ss][Ii][Qq]{2}\s{0,1}[1][Zz]{2}$"),
+        ("KR",@"^\d{6}\s\(\d{3}-\d{3}\)$"),
+        ("ES",@"^\d{5}$"),
+        ("LK",@"^\d{5}$"),
+        ("SD",@"^\d{5}$"),
+        ("SZ",@"^[A-Za-z]\d{3}$"),
+        ("SE",@"^\d{3}\s*\d{2}$"),
+        ("CH",@"^\d{4}$"),
+        ("SJ",@"^\d{4}$"),
+        ("TW",@"^\d{5}$"),
+        ("TJ",@"^\d{6}$"),
+        ("TH",@"^\d{5}$"),
+        ("TT",@"^\d{6}$"),
+        ("SH",@"^[Tt][Dd][Cc][Uu]\s{0,1}[1][Zz]{2}$"),
+        ("TN",@"^\d{4}$"),
+        ("TR",@"^\d{5}$"),
+        ("TM",@"^\d{6}$"),
+        ("TC",@"^[Tt][Kk][Cc][Aa]\s{0,1}[1][Zz]{2}$"),
+        ("UA",@"^\d{5}$"),
+        ("GB",@"^[A-Z]{1,2}[0-9R][0-9A-Z]?\s*[0-9][A-Z-[CIKMOV]]{2}"),
+        ("US",@"^\b\d{5}\b(?:[- ]{1}\d{4})?$"),
+        ("UY",@"^\d{5}$"),
+        ("VI",@"^\d{5}$"),
+        ("UZ",@"^\d{3} \d{3}$"),
+        ("VA",@"^120$"),
+        ("VE",@"^\d{4}(\s[a-zA-Z]{1})?$"),
+        ("VN",@"^\d{6}$"),
+        ("WF",@"^986\d{2}$"),
+        ("ZM",@"^\d{5}$"),
+    };
+}

src/Nox.Types/Types/StreetAddress/StreetAddress.cs

@@ -1,10 +1,106 @@
+using System.Linq;
+
 namespace Nox.Types;
 
-    /// <summary>
-    /// Represents a Nox <see cref="StreetAddress"/> type and value object.
-    /// </summary>
-    /// <remarks>Placeholder, needs to be implemented</remarks>
-    public sealed class StreetAddress : ValueObject<(string Line1,string Line2, string Line3,string ZipCode,string City, CountryCode2 CountryCode2), StreetAddress>
+/// <summary>
+/// Represents a Nox <see cref="StreetAddress"/> type and value object.
+/// </summary>
+/// <remarks>Compound type that represents street address.</remarks>
+public sealed class StreetAddress : ValueObject<StreetAddressItem, StreetAddress>
+{
+    public override StreetAddressItem Value { get; protected set; } = new StreetAddressItem();
+
+    public int StreetNumber
+    {
+        get => Value.StreetNumber;
+        private set => Value.StreetNumber = value;
+    }
+
+    public string AddressLine1
+    {
+        get => Value.AddressLine1;
+        private set => Value.AddressLine1 = value;
+    }
+
+    public string AddressLine2
+    {
+        get => Value.AddressLine2;
+        private set => Value.AddressLine2 = value;
+    }
+
+    public string Route
     {
+        get => Value.Route;
+        private set => Value.Route = value;
+    }
+
+    public string Locality
+    {
+        get => Value.Locality;
+        private set => Value.Locality = value;
+    }
+
+    public string Neighborhood
+    {
+        get => Value.Neighborhood;
+        private set => Value.Neighborhood = value;
+    }
+
+    public string AdministrativeArea1
+    {
+        get => Value.AdministrativeArea1;
+        private set => Value.AdministrativeArea1 = value;
+    }
 
+    public string AdministrativeArea2
+    {
+        get => Value.AdministrativeArea2;
+        private set => Value.AdministrativeArea2 = value;
+    }
+
+    public string PostalCode
+    {
+        get => Value.PostalCode;
+        private set => Value.PostalCode = value;
+    }
+
+    public CountryCode2 CountryId
+    {
+        get => Value.CountryId;
+        private set => Value.CountryId = value;
+    }
+
+    internal override ValidationResult Validate()
+    {
+        var result = base.Validate();
+
+        var isPostalCodeMatch = CountryPostalCodeValidator.IsValid(Value.CountryId.Value, Value.PostalCode);
+        if (!isPostalCodeMatch)
+        {
+            result.Errors.Add(new ValidationFailure(nameof(Value.PostalCode), "PostalCode value doesn't match valid postal code pattern."));
+        }
+
+        var countryValidation = Value.CountryId.Validate();
+        result.Errors.AddRange(countryValidation.Errors);
+
+        return result;
+    }
+
+    public override string ToString()
+    {
+        var addressLine = JoinStringParts(" ", Value.AddressLine1, Value.AddressLine2);
+        var areaLine = JoinStringParts(" ", Value.AdministrativeArea1, Value.AdministrativeArea2, Value.PostalCode);
+
+        return JoinStringParts(", ",
+            addressLine,
+            Value.Locality,
+            areaLine,
+            Value.CountryId.Value ?? string.Empty);
+    }
+
+    private string JoinStringParts(string separator, params string[] parts)
+    {
+        return string.Join(separator, parts
+            .Where(x => !string.IsNullOrWhiteSpace(x)));
     }
+}

src/Nox.Types/Types/StreetAddress/StreetAddressItem.cs

@@ -0,0 +1,18 @@
+namespace Nox.Types;
+
+/// <summary>
+/// Introduces POCO object to hold address data.
+/// </summary>
+public class StreetAddressItem
+{
+    public int StreetNumber { get; set; }
+    public string AddressLine1 { get; set; } = string.Empty;
+    public string AddressLine2 { get; set; } = string.Empty;
+    public string Route { get; set; } = string.Empty;
+    public string Locality { get; set; } = string.Empty;
+    public string Neighborhood { get; set; } = string.Empty;
+    public string AdministrativeArea1 { get; set; } = string.Empty;
+    public string AdministrativeArea2 { get; set; } = string.Empty;
+    public string PostalCode { get; set; } = string.Empty;
+    public CountryCode2 CountryId { get; set; } = null!;
+}