value-object-pattern 0.1.0__tar.gz → 0.2.0__tar.gz

{value_object_pattern-0.1.0 → value_object_pattern-0.2.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: value-object-pattern
-Version: 0.1.0
+Version: 0.2.0
 Summary: The Value Object Pattern is a Python package that streamlines the creation and management of value objects in your projects.
 Project-URL: Homepage, https://github.com/adriamontoto/value-object-pattern
 Project-URL: Repository, https://github.com/adriamontoto/value-object-pattern

{value_object_pattern-0.1.0 → value_object_pattern-0.2.0}/value_object_pattern/__init__.py

@@ -1,4 +1,4 @@
-__version__ = '0.1.0'
+__version__ = '0.2.0'
 
 from .decorators import process, validation
 from .models import ValueObject

{value_object_pattern-0.1.0/value_object_pattern/usables/identifiers/country_ids → value_object_pattern-0.2.0/value_object_pattern/usables/identifiers/countries}/spain/dni_value_object.py

@@ -3,6 +3,7 @@ DniValueObject value object.
 """
 
 from re import Pattern, compile as re_compile
+from typing import NoReturn
 
 from value_object_pattern.decorators import process, validation
 from value_object_pattern.usables import NotEmptyStringValueObject, TrimmedStringValueObject
@@ -16,7 +17,7 @@ class DniValueObject(NotEmptyStringValueObject, TrimmedStringValueObject):
 
     Example:
     ```python
-    from value_object_pattern.usables.identifiers.country_ids import DniValueObject
+    from value_object_pattern.usables.identifiers.countries.spain import DniValueObject
 
     dni = DniValueObject(value='87654321X')
 
@@ -54,10 +55,22 @@ class DniValueObject(NotEmptyStringValueObject, TrimmedStringValueObject):
         """
         match = self.__DNI_VALUE_OBJECT_REGEX.fullmatch(string=value)
         if not match:
-            raise ValueError(f'DniValueObject value <<<{value}>>> is not a valid Spanish DNI.')
+            self._raise_value_is_not_dni(value=value)
 
         number, letter = match.groups()
 
         expected_letter = self.__DNI_VALUE_OBJECT_LETTERS[int(number) % 23]
         if letter.upper() != expected_letter:
-            raise ValueError(f'DniValueObject value <<<{value}>>> is not a valid Spanish DNI.')
+            self._raise_value_is_not_dni(value=value)
+
+    def _raise_value_is_not_dni(self, value: str) -> NoReturn:
+        """
+        Raises a ValueError if the value object `value` is not a Spanish DNI.
+
+        Args:
+            value (str): The provided value.
+
+        Raises:
+            ValueError: If the `value` is not a Spanish DNI.
+        """
+        raise ValueError(f'DniValueObject value <<<{value}>>> is not a valid Spanish DNI.')

{value_object_pattern-0.1.0 → value_object_pattern-0.2.0}/value_object_pattern/usables/identifiers/string_uuid_value_object.py

@@ -2,8 +2,7 @@
 StringUuidValueObject value object.
 """
 
-from __future__ import annotations
-
+from typing import NoReturn
 from uuid import UUID
 
 from value_object_pattern.decorators import process, validation
@@ -52,5 +51,17 @@ class StringUuidValueObject(NotEmptyStringValueObject, TrimmedStringValueObject)
         try:
             UUID(hex=value)
 
-        except ValueError as error:
-            raise ValueError(f'StringUuidValueObject value <<<{value}>>> is not a valid UUID.') from error
+        except ValueError:
+            self._raise_value_is_not_uuid(value=value)
+
+    def _raise_value_is_not_uuid(self, value: str) -> NoReturn:
+        """
+        Raises a ValueError if the value object `value` is not a UUID.
+
+        Args:
+            value (str): The provided value.
+
+        Raises:
+            ValueError: If the `value` is not a UUID.
+        """
+        raise ValueError(f'StringUuidValueObject value <<<{value}>>> is not a valid UUID.')

{value_object_pattern-0.1.0 → value_object_pattern-0.2.0}/value_object_pattern/usables/identifiers/uuid_value_object.py

@@ -2,6 +2,7 @@
 UuidValueObject value object.
 """
 
+from typing import Any, NoReturn
 from uuid import UUID
 
 from value_object_pattern.decorators import validation
@@ -37,4 +38,16 @@ class UuidValueObject(ValueObject[UUID]):
             TypeError: If the `value` is not a UUID.
         """
         if type(value) is not UUID:
-            raise TypeError(f'UuidValueObject value <<<{value}>>> must be a UUID. Got <<<{type(value).__name__}>>> type.')  # noqa: E501  # fmt: skip
+            self._raise_value_is_not_uuid(value=value)
+
+    def _raise_value_is_not_uuid(self, value: Any) -> NoReturn:
+        """
+        Raises a TypeError if the value object `value` is not a UUID.
+
+        Args:
+            value (Any): The provided value.
+
+        Raises:
+            TypeError: If the `value` is not a UUID.
+        """
+        raise TypeError(f'UuidValueObject value <<<{value}>>> must be a UUID. Got <<<{type(value).__name__}>>> type.')

{value_object_pattern-0.1.0 → value_object_pattern-0.2.0}/value_object_pattern/usables/internet/__init__.py

@@ -1,10 +1,3 @@
-from .api_keys import (
-    AwsAccessKeyValueObject,
-    AwsSecretAccessKeyValueObject,
-    GitHubPersonalAccessTokenValueObject,
-    OpenaiApiKeyValueObject,
-    ResendApiKeyValueObject,
-)
 from .aws_cloud_region_value_object import AwsCloudRegionValueObject
 from .domain_value_object import DomainValueObject
 from .host_value_object import HostValueObject
@@ -17,11 +10,8 @@ from .port_value_object import PortValueObject
 from .uri import HttpHttpsUrlValueObject, HttpUrlValueObject, HttpsUrlValueObject, UrlValueObject
 
 __all__ = (
-    'AwsAccessKeyValueObject',
     'AwsCloudRegionValueObject',
-    'AwsSecretAccessKeyValueObject',
     'DomainValueObject',
-    'GitHubPersonalAccessTokenValueObject',
     'HostValueObject',
     'HttpHttpsUrlValueObject',
     'HttpUrlValueObject',
@@ -31,8 +21,6 @@ __all__ = (
     'Ipv6AddressValueObject',
     'Ipv6NetworkValueObject',
     'MacAddressValueObject',
-    'OpenaiApiKeyValueObject',
     'PortValueObject',
-    'ResendApiKeyValueObject',
     'UrlValueObject',
 )

{value_object_pattern-0.1.0 → value_object_pattern-0.2.0}/value_object_pattern/usables/primitives/boolean/boolean_value_object.py

@@ -2,6 +2,8 @@
 BooleanValueObject value object.
 """
 
+from typing import Any, NoReturn
+
 from value_object_pattern.decorators import validation
 from value_object_pattern.models import ValueObject
 
@@ -33,4 +35,16 @@ class BooleanValueObject(ValueObject[bool]):
             TypeError: If the `value` is not a boolean.
         """
         if type(value) is not bool:
-            raise TypeError(f'BooleanValueObject value <<<{value}>>> must be a boolean. Got <<<{type(value).__name__}>>> type.')  # noqa: E501  # fmt: skip
+            self._raise_value_is_not_boolean(value=value)
+
+    def _raise_value_is_not_boolean(self, value: Any) -> NoReturn:
+        """
+        Raises a TypeError if the value object `value` is not a boolean.
+
+        Args:
+            value (Any): The provided value.
+
+        Raises:
+            TypeError: If the `value` is not a boolean.
+        """
+        raise TypeError(f'BooleanValueObject value <<<{value}>>> must be a boolean. Got <<<{type(value).__name__}>>> type.')  # noqa: E501  # fmt: skip

{value_object_pattern-0.1.0 → value_object_pattern-0.2.0}/value_object_pattern/usables/primitives/boolean/false_value_object.py

@@ -2,6 +2,8 @@
 FalseValueObject value object.
 """
 
+from typing import NoReturn
+
 from value_object_pattern.decorators import validation
 
 from .boolean_value_object import BooleanValueObject
@@ -34,4 +36,16 @@ class FalseValueObject(BooleanValueObject):
             ValueError: If the `value` is not false.
         """
         if value:
-            raise ValueError(f'FalseValueObject value <<<{value}>>> must be false.')
+            self._raise_value_is_not_false(value=value)
+
+    def _raise_value_is_not_false(self, value: bool) -> NoReturn:
+        """
+        Raises a ValueError if the value object `value` is not false.
+
+        Args:
+            value (bool): The provided value.
+
+        Raises:
+            ValueError: If the `value` is not false.
+        """
+        raise ValueError(f'FalseValueObject value <<<{value}>>> must be false.')

{value_object_pattern-0.1.0 → value_object_pattern-0.2.0}/value_object_pattern/usables/primitives/boolean/true_value_object.py

@@ -2,6 +2,8 @@
 TrueValueObject value object.
 """
 
+from typing import NoReturn
+
 from value_object_pattern.decorators import validation
 
 from .boolean_value_object import BooleanValueObject
@@ -34,4 +36,16 @@ class TrueValueObject(BooleanValueObject):
             ValueError: If the `value` is not true.
         """
         if not value:
-            raise ValueError(f'TrueValueObject value <<<{value}>>> must be true.')
+            self._raise_value_is_not_true(value=value)
+
+    def _raise_value_is_not_true(self, value: bool) -> NoReturn:
+        """
+        Raises a ValueError if the value object `value` is not true.
+
+        Args:
+            value (bool): The provided value.
+
+        Raises:
+            ValueError: If the `value` is not true.
+        """
+        raise ValueError(f'TrueValueObject value <<<{value}>>> must be true.')

{value_object_pattern-0.1.0 → value_object_pattern-0.2.0}/value_object_pattern/usables/primitives/bytes/bytes_value_object.py

@@ -2,6 +2,8 @@
 BytesValueObject value object.
 """
 
+from typing import Any, NoReturn
+
 from value_object_pattern.decorators import validation
 from value_object_pattern.models import ValueObject
 
@@ -33,4 +35,16 @@ class BytesValueObject(ValueObject[bytes]):
             TypeError: If the `value` is not bytes.
         """
         if type(value) is not bytes:
-            raise TypeError(f'BytesValueObject value <<<{str(object=value)}>>> must be bytes. Got <<<{type(value).__name__}>>> type.')  # noqa: E501  # fmt: skip
+            self._raise_value_is_not_bytes(value=value)
+
+    def _raise_value_is_not_bytes(self, value: Any) -> NoReturn:
+        """
+        Raises a TypeError if the value object `value` is not bytes.
+
+        Args:
+            value (Any): The provided value.
+
+        Raises:
+            TypeError: If the `value` is not bytes.
+        """
+        raise TypeError(f'BytesValueObject value <<<{str(object=value)}>>> must be bytes. Got <<<{type(value).__name__}>>> type.')  # noqa: E501  # fmt: skip

{value_object_pattern-0.1.0 → value_object_pattern-0.2.0}/value_object_pattern/usables/primitives/float/float_value_object.py

@@ -2,6 +2,8 @@
 FloatValueObject value object.
 """
 
+from typing import Any, NoReturn
+
 from value_object_pattern.decorators import validation
 from value_object_pattern.models import ValueObject
 
@@ -33,4 +35,16 @@ class FloatValueObject(ValueObject[float]):
             TypeError: If the `value` is not a float.
         """
         if type(value) is not float:
-            raise TypeError(f'FloatValueObject value <<<{value}>>> must be a float. Got <<<{type(value).__name__}>>> type.')  # noqa: E501  # fmt: skip
+            self._raise_value_is_not_float(value=value)
+
+    def _raise_value_is_not_float(self, value: Any) -> NoReturn:
+        """
+        Raises a TypeError if the value object `value` is not a float.
+
+        Args:
+            value (Any): The provided value.
+
+        Raises:
+            TypeError: If the `value` is not a float.
+        """
+        raise TypeError(f'FloatValueObject value <<<{value}>>> must be a float. Got <<<{type(value).__name__}>>> type.')  # noqa: E501  # fmt: skip

{value_object_pattern-0.1.0 → value_object_pattern-0.2.0}/value_object_pattern/usables/primitives/float/negative_float_value_object.py

@@ -2,6 +2,8 @@
 NegativeFloatValueObject value object.
 """
 
+from typing import NoReturn
+
 from value_object_pattern.decorators import validation
 
 from .float_value_object import FloatValueObject
@@ -34,4 +36,16 @@ class NegativeFloatValueObject(FloatValueObject):
             ValueError: If the `value` is not a negative float.
         """
         if value >= 0:
-            raise ValueError(f'NegativeFloatValueObject value <<<{value}>>> must be a negative float.')
+            self._raise_value_is_not_negative_float(value=value)
+
+    def _raise_value_is_not_negative_float(self, value: float) -> NoReturn:
+        """
+        Raises a ValueError if the value object `value` is not a negative float.
+
+        Args:
+            value (float): The provided value.
+
+        Raises:
+            ValueError: If the `value` is not a negative float.
+        """
+        raise ValueError(f'NegativeFloatValueObject value <<<{value}>>> must be a negative float.')

{value_object_pattern-0.1.0 → value_object_pattern-0.2.0}/value_object_pattern/usables/primitives/float/positive_float_value_object.py

@@ -2,6 +2,8 @@
 PositiveFloatValueObject value object.
 """
 
+from typing import NoReturn
+
 from value_object_pattern.decorators import validation
 
 from .float_value_object import FloatValueObject
@@ -34,4 +36,16 @@ class PositiveFloatValueObject(FloatValueObject):
             ValueError: If the `value` is not a positive float.
         """
         if value <= 0:
-            raise ValueError(f'PositiveFloatValueObject value <<<{value}>>> must be a positive float.')
+            self._raise_value_is_not_positive_float(value=value)
+
+    def _raise_value_is_not_positive_float(self, value: float) -> NoReturn:
+        """
+        Raises a ValueError if the value object `value` is not a positive float.
+
+        Args:
+            value (float): The provided value.
+
+        Raises:
+            ValueError: If the `value` is not a positive float.
+        """
+        raise ValueError(f'PositiveFloatValueObject value <<<{value}>>> must be a positive float.')

{value_object_pattern-0.1.0 → value_object_pattern-0.2.0}/value_object_pattern/usables/primitives/integer/even_integer_value_object.py

@@ -2,6 +2,8 @@
 EvenIntegerValueObject value object.
 """
 
+from typing import NoReturn
+
 from value_object_pattern.decorators import validation
 
 from .integer_value_object import IntegerValueObject
@@ -34,4 +36,16 @@ class EvenIntegerValueObject(IntegerValueObject):
             ValueError: If the `value` is not an even number.
         """
         if value % 2 != 0:
-            raise ValueError(f'EvenIntegerValueObject value <<<{value}>>> must be an even number.')
+            self._raise_value_is_not_even_number(value=value)
+
+    def _raise_value_is_not_even_number(self, value: int) -> NoReturn:
+        """
+        Raises a ValueError if the value object `value` is not an even number.
+
+        Args:
+            value (int): The provided value.
+
+        Raises:
+            ValueError: If the `value` is not an even number.
+        """
+        raise ValueError(f'EvenIntegerValueObject value <<<{value}>>> must be an even number.')

{value_object_pattern-0.1.0 → value_object_pattern-0.2.0}/value_object_pattern/usables/primitives/integer/integer_value_object.py

@@ -2,6 +2,8 @@
 IntegerValueObject value object.
 """
 
+from typing import Any, NoReturn
+
 from value_object_pattern.decorators import validation
 from value_object_pattern.models import ValueObject
 
@@ -33,4 +35,16 @@ class IntegerValueObject(ValueObject[int]):
             TypeError: If the `value` is not an integer.
         """
         if type(value) is not int:
-            raise TypeError(f'IntegerValueObject value <<<{value}>>> must be an integer. Got <<<{type(value).__name__}>>> type.')  # noqa: E501  # fmt: skip
+            self._raise_value_is_not_integer(value=value)
+
+    def _raise_value_is_not_integer(self, value: Any) -> NoReturn:
+        """
+        Raises a TypeError if the value object `value` is not an integer.
+
+        Args:
+            value (Any): The provided value.
+
+        Raises:
+            TypeError: If the `value` is not an integer.
+        """
+        raise TypeError(f'IntegerValueObject value <<<{value}>>> must be an integer. Got <<<{type(value).__name__}>>> type.')  # noqa: E501  # fmt: skip

{value_object_pattern-0.1.0 → value_object_pattern-0.2.0}/value_object_pattern/usables/primitives/integer/negative_integer_value_object.py

@@ -2,6 +2,8 @@
 NegativeIntegerValueObject value object.
 """
 
+from typing import NoReturn
+
 from value_object_pattern.decorators import validation
 
 from .integer_value_object import IntegerValueObject
@@ -34,4 +36,16 @@ class NegativeIntegerValueObject(IntegerValueObject):
             ValueError: If the `value` is not a negative integer.
         """
         if value >= 0:
-            raise ValueError(f'NegativeIntegerValueObject value <<<{value}>>> must be a negative integer.')
+            self._raise_value_is_not_negative_integer(value=value)
+
+    def _raise_value_is_not_negative_integer(self, value: int) -> NoReturn:
+        """
+        Raises a ValueError if the value object `value` is not a negative integer.
+
+        Args:
+            value (int): The provided value.
+
+        Raises:
+            ValueError: If the `value` is not a negative integer.
+        """
+        raise ValueError(f'NegativeIntegerValueObject value <<<{value}>>> must be a negative integer.')

{value_object_pattern-0.1.0 → value_object_pattern-0.2.0}/value_object_pattern/usables/primitives/integer/odd_integer_value_object.py

@@ -2,6 +2,8 @@
 OddIntegerValueObject value object.
 """
 
+from typing import NoReturn
+
 from value_object_pattern.decorators import validation
 
 from .integer_value_object import IntegerValueObject
@@ -34,4 +36,16 @@ class OddIntegerValueObject(IntegerValueObject):
             ValueError: If the `value` is not an odd number.
         """
         if value % 2 == 0:
-            raise ValueError(f'OddIntegerValueObject value <<<{value}>>> must be an odd number.')
+            self._raise_value_is_not_odd_number(value=value)
+
+    def _raise_value_is_not_odd_number(self, value: int) -> NoReturn:
+        """
+        Raises a ValueError if the value object `value` is not an odd number.
+
+        Args:
+            value (int): The provided value.
+
+        Raises:
+            ValueError: If the `value` is not an odd number.
+        """
+        raise ValueError(f'OddIntegerValueObject value <<<{value}>>> must be an odd number.')

{value_object_pattern-0.1.0 → value_object_pattern-0.2.0}/value_object_pattern/usables/primitives/integer/positive_integer_value_object.py

@@ -2,6 +2,8 @@
 PositiveIntegerValueObject value object.
 """
 
+from typing import NoReturn
+
 from value_object_pattern.decorators import validation
 
 from .integer_value_object import IntegerValueObject
@@ -34,4 +36,16 @@ class PositiveIntegerValueObject(IntegerValueObject):
             ValueError: If the `value` is not a positive integer.
         """
         if value <= 0:
-            raise ValueError(f'PositiveIntegerValueObject value <<<{value}>>> must be a positive integer.')
+            self._raise_value_is_not_positive_integer(value=value)
+
+    def _raise_value_is_not_positive_integer(self, value: int) -> NoReturn:
+        """
+        Raises a ValueError if the value object `value` is not a positive integer.
+
+        Args:
+            value (int): The provided value.
+
+        Raises:
+            ValueError: If the `value` is not a positive integer.
+        """
+        raise ValueError(f'PositiveIntegerValueObject value <<<{value}>>> must be a positive integer.')

{value_object_pattern-0.1.0 → value_object_pattern-0.2.0}/value_object_pattern/usables/primitives/string/alpha_value_object.py

@@ -2,6 +2,8 @@
 AlphaStringValueObject value object.
 """
 
+from typing import NoReturn
+
 from value_object_pattern.decorators import validation
 
 from .string_value_object import StringValueObject
@@ -34,4 +36,16 @@ class AlphaStringValueObject(StringValueObject):
             ValueError: If the `value` is not alpha.
         """
         if not value.isalpha():
-            raise ValueError(f'AlphaStringValueObject value <<<{value}>>> contains invalid characters. Only alpha characters are allowed.')  # noqa: E501  # fmt: skip
+            self._raise_value_is_not_alpha(value=value)
+
+    def _raise_value_is_not_alpha(self, value: str) -> NoReturn:
+        """
+        Raises a ValueError if the value object `value` is not alpha.
+
+        Args:
+            value (str): The provided value.
+
+        Raises:
+            ValueError: If the `value` is not alpha.
+        """
+        raise ValueError(f'AlphaStringValueObject value <<<{value}>>> contains invalid characters. Only alpha characters are allowed.')  # noqa: E501  # fmt: skip

{value_object_pattern-0.1.0 → value_object_pattern-0.2.0}/value_object_pattern/usables/primitives/string/alphanumeric_value_object.py

@@ -2,6 +2,8 @@
 AlphanumericStringValueObject value object.
 """
 
+from typing import NoReturn
+
 from value_object_pattern.decorators import validation
 
 from .string_value_object import StringValueObject
@@ -34,4 +36,16 @@ class AlphanumericStringValueObject(StringValueObject):
             ValueError: If the `value` is not alphanumeric.
         """
         if not value.isalnum():
-            raise ValueError(f'AlphanumericStringValueObject value <<<{value}>>> contains invalid characters. Only alphanumeric characters are allowed.')  # noqa: E501  # fmt: skip
+            self._raise_value_is_not_alphanumeric(value=value)
+
+    def _raise_value_is_not_alphanumeric(self, value: str) -> NoReturn:
+        """
+        Raises a ValueError if the value object `value` is not alphanumeric.
+
+        Args:
+            value (str): The provided value.
+
+        Raises:
+            ValueError: If the `value` is not alphanumeric.
+        """
+        raise ValueError(f'AlphanumericStringValueObject value <<<{value}>>> contains invalid characters. Only alphanumeric characters are allowed.')  # noqa: E501  # fmt: skip

{value_object_pattern-0.1.0 → value_object_pattern-0.2.0}/value_object_pattern/usables/primitives/string/digit_value_object.py

@@ -2,6 +2,8 @@
 DigitStringValueObject value object.
 """
 
+from typing import NoReturn
+
 from value_object_pattern.decorators import validation
 
 from .string_value_object import StringValueObject
@@ -34,4 +36,16 @@ class DigitStringValueObject(StringValueObject):
             ValueError: If the `value` is not digit.
         """
         if not value.isdigit():
-            raise ValueError(f'DigitStringValueObject value <<<{value}>>> contains invalid characters. Only digit characters are allowed.')  # noqa: E501  # fmt: skip
+            self._raise_value_is_not_digit(value=value)
+
+    def _raise_value_is_not_digit(self, value: str) -> NoReturn:
+        """
+        Raises a ValueError if the value object `value` is not digit.
+
+        Args:
+            value (str): The provided value.
+
+        Raises:
+            ValueError: If the `value` is not digit.
+        """
+        raise ValueError(f'DigitStringValueObject value <<<{value}>>> contains invalid characters. Only digit characters are allowed.')  # noqa: E501  # fmt: skip

{value_object_pattern-0.1.0 → value_object_pattern-0.2.0}/value_object_pattern/usables/primitives/string/lowercase_string_value_object.py

@@ -2,6 +2,8 @@
 LowercaseStringValueObject value object.
 """
 
+from typing import NoReturn
+
 from value_object_pattern.decorators import validation
 
 from .string_value_object import StringValueObject
@@ -34,4 +36,16 @@ class LowercaseStringValueObject(StringValueObject):
             ValueError: If the `value` is not lowercase.
         """
         if not value.islower():
-            raise ValueError(f'LowercaseStringValueObject value <<<{value}>>> contains uppercase characters. Only lowercase characters are allowed.')  # noqa: E501  # fmt: skip
+            self._raise_value_is_not_lowercase(value=value)
+
+    def _raise_value_is_not_lowercase(self, value: str) -> NoReturn:
+        """
+        Raises a ValueError if the value object `value` is not lowercase.
+
+        Args:
+            value (str): The provided value.
+
+        Raises:
+            ValueError: If the `value` is not lowercase.
+        """
+        raise ValueError(f'LowercaseStringValueObject value <<<{value}>>> contains uppercase characters. Only lowercase characters are allowed.')  # noqa: E501  # fmt: skip

{value_object_pattern-0.1.0 → value_object_pattern-0.2.0}/value_object_pattern/usables/primitives/string/non_empty_string_value_object.py

@@ -2,6 +2,8 @@
 NotEmptyStringValueObject value object.
 """
 
+from typing import NoReturn
+
 from value_object_pattern.decorators import validation
 
 from .string_value_object import StringValueObject
@@ -34,4 +36,16 @@ class NotEmptyStringValueObject(StringValueObject):
             ValueError: If the `value` is an empty string.
         """
         if not value:
-            raise ValueError(f'NotEmptyStringValueObject value <<<{value}>>> is an empty string. Only non-empty strings are allowed.')  # noqa: E501  # fmt: skip
+            self._raise_value_is_empty_string(value=value)
+
+    def _raise_value_is_empty_string(self, value: str) -> NoReturn:
+        """
+        Raises a ValueError if the value object `value` is an empty string.
+
+        Args:
+            value (str): The provided value.
+
+        Raises:
+            ValueError: If the `value` is an empty string.
+        """
+        raise ValueError(f'NotEmptyStringValueObject value <<<{value}>>> is an empty string. Only non-empty strings are allowed.')  # noqa: E501  # fmt: skip

{value_object_pattern-0.1.0 → value_object_pattern-0.2.0}/value_object_pattern/usables/primitives/string/printable_string_value_object.py

@@ -2,6 +2,8 @@
 PrintableStringValueObject value object.
 """
 
+from typing import NoReturn
+
 from value_object_pattern.decorators import validation
 
 from .string_value_object import StringValueObject
@@ -34,4 +36,16 @@ class PrintableStringValueObject(StringValueObject):
             ValueError: If the `value` is not printable.
         """
         if not value.isprintable():
-            raise ValueError(f'PrintableStringValueObject value <<<{value}>>> contains invalid characters. Only printable characters are allowed.')  # noqa: E501  # fmt: skip
+            self._raise_value_is_not_printable(value=value)
+
+    def _raise_value_is_not_printable(self, value: str) -> NoReturn:
+        """
+        Raises a ValueError if the value object `value` is not printable.
+
+        Args:
+            value (str): The provided value.
+
+        Raises:
+            ValueError: If the `value` is not printable.
+        """
+        raise ValueError(f'PrintableStringValueObject value <<<{value}>>> contains invalid characters. Only printable characters are allowed.')  # noqa: E501  # fmt: skip

{value_object_pattern-0.1.0 → value_object_pattern-0.2.0}/value_object_pattern/usables/primitives/string/string_value_object.py

@@ -2,6 +2,8 @@
 StringValueObject value object.
 """
 
+from typing import Any, NoReturn
+
 from value_object_pattern.decorators import validation
 from value_object_pattern.models import ValueObject
 
@@ -33,4 +35,16 @@ class StringValueObject(ValueObject[str]):
             TypeError: If the `value` is not a string.
         """
         if type(value) is not str:
-            raise TypeError(f'StringValueObject value <<<{value}>>> must be a string. Got <<<{type(value).__name__}>>> type.')  # noqa: E501  # fmt: skip
+            self._raise_value_is_not_string(value=value)
+
+    def _raise_value_is_not_string(self, value: Any) -> NoReturn:
+        """
+        Raises a TypeError if the value object `value` is not a string.
+
+        Args:
+            value (Any): The provided value.
+
+        Raises:
+            TypeError: If the `value` is not a string.
+        """
+        raise TypeError(f'StringValueObject value <<<{value}>>> must be a string. Got <<<{type(value).__name__}>>> type.')  # noqa: E501  # fmt: skip

{value_object_pattern-0.1.0 → value_object_pattern-0.2.0}/value_object_pattern/usables/primitives/string/trimmed_string_value_object.py

@@ -2,6 +2,8 @@
 TrimmedStringValueObject value object.
 """
 
+from typing import NoReturn
+
 from value_object_pattern.decorators import validation
 
 from .string_value_object import StringValueObject
@@ -34,4 +36,16 @@ class TrimmedStringValueObject(StringValueObject):
             ValueError: If the `value` is not trimmed.
         """
         if value != value.strip():
-            raise ValueError(f'TrimmedStringValueObject value <<<{value}>>> contains leading or trailing whitespaces. Only trimmed values are allowed.')  # noqa: E501  # fmt: skip
+            self._raise_value_is_not_trimmed(value=value)
+
+    def _raise_value_is_not_trimmed(self, value: str) -> NoReturn:
+        """
+        Raises a ValueError if the value object `value` is not trimmed.
+
+        Args:
+            value (str): The provided value.
+
+        Raises:
+            ValueError: If the `value` is not trimmed.
+        """
+        raise ValueError(f'TrimmedStringValueObject value <<<{value}>>> contains leading or trailing whitespaces. Only trimmed values are allowed.')  # noqa: E501  # fmt: skip

{value_object_pattern-0.1.0 → value_object_pattern-0.2.0}/value_object_pattern/usables/primitives/string/uppercase_string_value_object.py

@@ -2,6 +2,8 @@
 UppercaseStringValueObject value object.
 """
 
+from typing import NoReturn
+
 from value_object_pattern.decorators import validation
 
 from .string_value_object import StringValueObject
@@ -34,4 +36,16 @@ class UppercaseStringValueObject(StringValueObject):
             ValueError: If the `value` is not uppercase.
         """
         if not value.isupper():
-            raise ValueError(f'UppercaseStringValueObject value <<<{value}>>> contains lowercase characters. Only uppercase characters are allowed.')  # noqa: E501  # fmt: skip
+            self._raise_value_is_not_uppercase(value=value)
+
+    def _raise_value_is_not_uppercase(self, value: str) -> NoReturn:
+        """
+        Raises a ValueError if the value object `value` is not uppercase.
+
+        Args:
+            value (str): The provided value.
+
+        Raises:
+            ValueError: If the `value` is not uppercase.
+        """
+        raise ValueError(f'UppercaseStringValueObject value <<<{value}>>> contains lowercase characters. Only uppercase characters are allowed.')  # noqa: E501  # fmt: skip

value_object_pattern-0.1.0/value_object_pattern/usables/identifiers/country_ids/__init__.py

@@ -1,3 +0,0 @@
-from .spain import DniValueObject
-
-__all__ = ('DniValueObject',)

value_object_pattern-0.1.0/value_object_pattern/usables/internet/api_keys/__init__.py

@@ -1,13 +0,0 @@
-from .aws_access_key_id_value_object import AwsAccessKeyValueObject
-from .aws_secret_access_key_value_object import AwsSecretAccessKeyValueObject
-from .github_personal_access_token_value_object import GitHubPersonalAccessTokenValueObject
-from .openai_api_key_value_object import OpenaiApiKeyValueObject
-from .resend_api_key_value_object import ResendApiKeyValueObject
-
-__all__ = (
-    'AwsAccessKeyValueObject',
-    'AwsSecretAccessKeyValueObject',
-    'GitHubPersonalAccessTokenValueObject',
-    'OpenaiApiKeyValueObject',
-    'ResendApiKeyValueObject',
-)

value_object_pattern-0.1.0/value_object_pattern/usables/internet/api_keys/aws_access_key_id_value_object.py

@@ -1,40 +0,0 @@
-"""
-AwsAccessKeyValueObject value object.
-"""
-
-from re import Pattern, compile as re_compile
-
-from value_object_pattern.decorators import validation
-from value_object_pattern.usables import NotEmptyStringValueObject, TrimmedStringValueObject
-
-
-class AwsAccessKeyValueObject(NotEmptyStringValueObject, TrimmedStringValueObject):
-    """
-    AwsAccessKeyValueObject value object ensures the provided value is a valid AWS Access Key ID.
-
-    Example:
-    ```python
-    from value_object_pattern.usables.internet import AwsAccessKeyValueObject
-
-    key = AwsAccessKeyValueObject(value='AKIAIOSFODNN7EXAMPLE')  # gitleaks:allow
-
-    print(repr(key))
-    # >>> AwsAccessKeyValueObject(value=AKIAIOSFODNN7EXAMPLE)  # gitleaks:allow
-    ```
-    """
-
-    __AWS_ACCESS_KEY_VALUE_OBJECT_REGEX: Pattern[str] = re_compile(pattern=r'^(AKIA|ASIA)[A-Z0-9]{16}$')
-
-    @validation(order=0)
-    def _ensure_value_is_valid_aws_access_key(self, value: str) -> None:
-        """
-        Ensures the value object value is a valid AWS Access Key ID.
-
-        Args:
-            value (str): Value.
-
-        Raises:
-            ValueError: If the value is not a valid AWS Access Key ID.
-        """
-        if not self.__AWS_ACCESS_KEY_VALUE_OBJECT_REGEX.fullmatch(string=value):
-            raise ValueError(f'AwsAccessKeyValueObject value <<<{value}>>> is not a valid AWS Access Key ID.')

value_object_pattern-0.1.0/value_object_pattern/usables/internet/api_keys/aws_secret_access_key_value_object.py

@@ -1,40 +0,0 @@
-"""
-AwsSecretAccessKeyValueObject value object.
-"""
-
-from re import Pattern, compile as re_compile
-
-from value_object_pattern.decorators import validation
-from value_object_pattern.usables import NotEmptyStringValueObject, TrimmedStringValueObject
-
-
-class AwsSecretAccessKeyValueObject(NotEmptyStringValueObject, TrimmedStringValueObject):
-    """
-    AwsSecretAccessKeyValueObject value object ensures the provided value is a valid AWS Secret Access Key.
-
-    Example:
-    ```python
-    from value_object_pattern.usables.internet import AwsSecretAccessKeyValueObject
-
-    key = AwsSecretAccessKeyValueObject(value='wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY')  # gitleaks:allow
-
-    print(repr(key))
-    # >>> AwsSecretAccessKeyValueObject(value=wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY)  # gitleaks:allow
-    ```
-    """
-
-    __AWS_SECRET_ACCESS_KEY_VALUE_OBJECT_REGEX: Pattern[str] = re_compile(pattern=r'^[a-zA-Z0-9/+=]{40}$')
-
-    @validation(order=0)
-    def _ensure_value_is_valid_aws_secret_access_key(self, value: str) -> None:
-        """
-        Ensures the value object value is a valid AWS Secret Access Key.
-
-        Args:
-            value (str): Value.
-
-        Raises:
-            ValueError: If the value is not a valid AWS Secret Access Key.
-        """
-        if not self.__AWS_SECRET_ACCESS_KEY_VALUE_OBJECT_REGEX.fullmatch(string=value):
-            raise ValueError(f'AwsSecretAccessKeyValueObject value <<<{value}>>> is not a valid AWS Secret Access Key.')

value_object_pattern-0.1.0/value_object_pattern/usables/internet/api_keys/github_personal_access_token_value_object.py

@@ -1,41 +0,0 @@
-"""
-GitHubPersonalAccessTokenValueObject value object.
-"""
-
-from re import Pattern, compile as re_compile
-
-from value_object_pattern.decorators import validation
-from value_object_pattern.usables import NotEmptyStringValueObject, TrimmedStringValueObject
-
-
-class GitHubPersonalAccessTokenValueObject(NotEmptyStringValueObject, TrimmedStringValueObject):
-    """
-    GitHubPersonalAccessTokenValueObject value object ensures the provided value is a valid GitHub Personal Access
-    Token.
-
-    Example:
-    ```python
-    from value_object_pattern.usables.internet import GitHubPersonalAccessTokenValueObject
-
-    key = GitHubPersonalAccessTokenValueObject(value='ghp_cgq4ZrHmFu0lLPl7ajKAwgMPnT5zhF000000')  # gitleaks:allow
-
-    print(repr(key))
-    # >>> GitHubPersonalAccessTokenValueObject(value=ghp_cgq4ZrHmFu0lLPl7ajKAwgMPnT5zhF000000)  # gitleaks:allow
-    ```
-    """
-
-    __GITHUB_PERSONAL_ACCESS_TOKEN_VALUE_OBJECT_REGEX: Pattern[str] = re_compile(pattern=r'^ghp_[a-zA-Z0-9]{36}$')
-
-    @validation(order=0)
-    def _ensure_value_is_valid_github_pat(self, value: str) -> None:
-        """
-        Ensures the value object value is a valid GitHub Personal Access Token.
-
-        Args:
-            value (str): Value.
-
-        Raises:
-            ValueError: If the value is not a valid GitHub Personal Access Token
-        """
-        if not self.__GITHUB_PERSONAL_ACCESS_TOKEN_VALUE_OBJECT_REGEX.fullmatch(string=value):
-            raise ValueError(f'GitHubPersonalAccessTokenValueObject value <<<{value}>>> is not a valid GitHub Personal Access Token.')  # noqa: E501  # fmt: skip

value_object_pattern-0.1.0/value_object_pattern/usables/internet/api_keys/openai_api_key_value_object.py

@@ -1,40 +0,0 @@
-"""
-OpenaiApiKeyValueObject value object.
-"""
-
-from re import Pattern, compile as re_compile
-
-from value_object_pattern.decorators import validation
-from value_object_pattern.usables import NotEmptyStringValueObject, TrimmedStringValueObject
-
-
-class OpenaiApiKeyValueObject(NotEmptyStringValueObject, TrimmedStringValueObject):
-    """
-    OpenaiApiKeyValueObject value object ensures the provided value is a valid OpenAI API Key.
-
-    Example:
-    ```python
-    from value_object_pattern.usables.internet import OpenaiApiKeyValueObject
-
-    key = OpenaiApiKeyValueObject(value='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')  # gitleaks:allow
-
-    print(repr(key))
-    # >>> OpenaiApiKeyValueObject(value=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)  # gitleaks:allow
-    ```
-    """
-
-    __OPENAI_API_KEY_VALUE_OBJECT_REGEX: Pattern[str] = re_compile(pattern=r'^sk-[a-zA-Z0-9]{20}T3BlbkFJ[a-zA-Z0-9]{20}$')  # noqa: E501  # fmt: skip
-
-    @validation(order=0)
-    def _ensure_value_is_valid_openai_api_key(self, value: str) -> None:
-        """
-        Ensures the value object value is a valid OpenAI API Key.
-
-        Args:
-            value (str): Value.
-
-        Raises:
-            ValueError: If the value is not a valid OpenAI API Key.
-        """
-        if not self.__OPENAI_API_KEY_VALUE_OBJECT_REGEX.fullmatch(string=value):
-            raise ValueError(f'OpenaiApiKeyValueObject value <<<{value}>>> is not a valid OpenAI API Key.')

value_object_pattern-0.1.0/value_object_pattern/usables/internet/api_keys/resend_api_key_value_object.py

@@ -1,40 +0,0 @@
-"""
-ResendApiKeyValueObject value object.
-"""
-
-from re import Pattern, compile as re_compile
-
-from value_object_pattern.decorators import validation
-from value_object_pattern.usables import NotEmptyStringValueObject, TrimmedStringValueObject
-
-
-class ResendApiKeyValueObject(NotEmptyStringValueObject, TrimmedStringValueObject):
-    """
-    ResendApiKeyValueObject value object ensures the provided value is a valid Resend API Key.
-
-    Example:
-    ```python
-    from value_object_pattern.usables.internet import ResendApiKeyValueObject
-
-    key = ResendApiKeyValueObject(value='re_c1tpEyD8_NKFusih9vKVQknRAQfmFcWCv')  # gitleaks:allow
-
-    print(repr(key))
-    # >>> ResendApiKeyValueObject(value=re_c1tpEyD8_NKFusih9vKVQknRAQfmFcWCv)  # gitleaks:allow
-    ```
-    """
-
-    __RESEND_API_KEY_VALUE_OBJECT_REGEX: Pattern[str] = re_compile(pattern=r'^re_[a-zA-Z0-9-_]{30,}$')
-
-    @validation(order=0)
-    def _ensure_value_is_valid_resend_api_key(self, value: str) -> None:
-        """
-        Ensures the value object value is a valid Resend API Key.
-
-        Args:
-            value (str): Value.
-
-        Raises:
-            ValueError: If the value is not a valid Resend API Key.
-        """
-        if not self.__RESEND_API_KEY_VALUE_OBJECT_REGEX.fullmatch(string=value):
-            raise ValueError(f'ResendApiKeyValueObject value <<<{value}>>> is not a valid Resend API Key.')