feat: implement PascalCaseStringValueObject for PascalCase validation

Co-authored-by: Copilot <copilot@github.com>
Signed-off-by: Adria Montoto <75563346+adriamontoto@users.noreply.github.com>

Author: adriamontoto

value_object_pattern/usables/__init__.py

@@ -19,6 +19,7 @@
     NotEmptyStringValueObject,
     NotNoneValueObject,
     OddIntegerValueObject,
+    PascalCaseStringValueObject,
     PositiveFloatValueObject,
     PositiveIntegerValueObject,
     PositiveOrZeroFloatValueObject,
@@ -55,6 +56,7 @@
     'NotEmptyStringValueObject',
     'NotNoneValueObject',
     'OddIntegerValueObject',
+    'PascalCaseStringValueObject',
     'PositiveFloatValueObject',
     'PositiveIntegerValueObject',
     'PositiveOrZeroFloatValueObject',

value_object_pattern/usables/primitives/__init__.py

@@ -25,6 +25,7 @@
     KebabCaseStringValueObject,
     LowercaseStringValueObject,
     NotEmptyStringValueObject,
+    PascalCaseStringValueObject,
     PrintableStringValueObject,
     ScreamingSnakeCaseStringValueObject,
     SnakeCaseStringValueObject,
@@ -54,6 +55,7 @@
     'NotEmptyStringValueObject',
     'NotNoneValueObject',
     'OddIntegerValueObject',
+    'PascalCaseStringValueObject',
     'PositiveFloatValueObject',
     'PositiveIntegerValueObject',
     'PositiveOrZeroFloatValueObject',

value_object_pattern/usables/primitives/string/__init__.py

@@ -5,6 +5,7 @@
 from .kebab_case_string_value_object import KebabCaseStringValueObject
 from .lowercase_string_value_object import LowercaseStringValueObject
 from .non_empty_string_value_object import NotEmptyStringValueObject
+from .pascal_case_string_value_object import PascalCaseStringValueObject
 from .printable_string_value_object import PrintableStringValueObject
 from .screaming_snake_case_string_value_object import ScreamingSnakeCaseStringValueObject
 from .snake_case_string_value_object import SnakeCaseStringValueObject
@@ -20,6 +21,7 @@
     'KebabCaseStringValueObject',
     'LowercaseStringValueObject',
     'NotEmptyStringValueObject',
+    'PascalCaseStringValueObject',
     'PrintableStringValueObject',
     'ScreamingSnakeCaseStringValueObject',
     'SnakeCaseStringValueObject',

value_object_pattern/usables/primitives/string/pascal_case_string_value_object.py

@@ -0,0 +1,55 @@
+"""
+PascalCaseStringValueObject value object.
+"""
+
+from re import Pattern, compile as re_compile
+from typing import NoReturn
+
+from value_object_pattern.decorators import validation
+
+from .non_empty_string_value_object import NotEmptyStringValueObject
+from .trimmed_string_value_object import TrimmedStringValueObject
+
+
+class PascalCaseStringValueObject(NotEmptyStringValueObject, TrimmedStringValueObject):
+    """
+    PascalCaseStringValueObject value object ensures the provided value is PascalCase.
+
+    Example:
+    ```python
+    from value_object_pattern.usables import PascalCaseStringValueObject
+
+    string = PascalCaseStringValueObject(value='Abcd1234Word')
+
+    print(repr(string))
+    # >>> PascalCaseStringValueObject(value='Abcd1234Word')
+    ```
+    """
+
+    _VALIDATION_REGEX: Pattern[str] = re_compile(pattern=r'^[A-Z][a-z0-9]*(?:[A-Z][a-z0-9]*)*$')
+
+    @validation(order=0)
+    def _ensure_value_is_pascal_case(self, value: str) -> None:
+        """
+        Ensures the value object `value` is PascalCase.
+
+        Args:
+            value (str): The provided value.
+
+        Raises:
+            ValueError: If the `value` is not PascalCase.
+        """
+        if not self._VALIDATION_REGEX.fullmatch(string=value):
+            self._raise_value_is_not_pascal_case(value=value)
+
+    def _raise_value_is_not_pascal_case(self, value: str) -> NoReturn:
+        """
+        Raises a ValueError if the value object `value` is PascalCase.
+
+        Args:
+            value (str): The provided value.
+
+        Raises:
+            ValueError: If the `value` is not PascalCase.
+        """
+        raise ValueError(f'PascalCaseStringValueObject value <<<{value}>>> has invalid format. Only PascalCase strings starting with an uppercase letter and continuing with alphanumeric words are allowed.')  # noqa: E501  # fmt: skip