value-object-pattern 1.31.1__tar.gz → 1.33.0__tar.gz

{value_object_pattern-1.31.1 → value_object_pattern-1.33.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: value-object-pattern
-Version: 1.31.1
+Version: 1.33.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-1.31.1 → value_object_pattern-1.33.0}/value_object_pattern/__init__.py

@@ -1,4 +1,4 @@
-__version__ = '1.31.1'
+__version__ = '1.33.0'
 
 from .decorators import process, validation
 from .models import BaseModel, EnumerationValueObject, UnionValueObject, ValueObject

{value_object_pattern-1.31.1 → value_object_pattern-1.33.0}/value_object_pattern/usables/__init__.py

@@ -1,6 +1,7 @@
 from .primitives import (
     AlphaStringValueObject,
     AlphanumericStringValueObject,
+    Base64StringValueObject,
     BooleanValueObject,
     BytesValueObject,
     CamelCaseStringValueObject,
@@ -37,6 +38,7 @@ from .primitives import (
 __all__ = (
     'AlphaStringValueObject',
     'AlphanumericStringValueObject',
+    'Base64StringValueObject',
     'BooleanValueObject',
     'BytesValueObject',
     'CamelCaseStringValueObject',

{value_object_pattern-1.31.1 → value_object_pattern-1.33.0}/value_object_pattern/usables/internet/__init__.py

@@ -1,4 +1,5 @@
 from .aws_cloud_region_value_object import AwsCloudRegionValueObject
+from .domain_or_localhost_value_object import DomainOrLocalhostValueObject
 from .domain_value_object import DomainValueObject
 from .email_address_value_object import EmailAddressValueObject
 from .host_value_object import HostValueObject
@@ -16,6 +17,7 @@ from .user_agent_value_object import UserAgentValueObject
 
 __all__ = (
     'AwsCloudRegionValueObject',
+    'DomainOrLocalhostValueObject',
     'DomainValueObject',
     'EmailAddressValueObject',
     'HostValueObject',

value_object_pattern-1.33.0/value_object_pattern/usables/internet/domain_or_localhost_value_object.py

@@ -0,0 +1,22 @@
+"""
+DomainOrLocalhostValueObject value object.
+"""
+
+from .domain_value_object import DomainValueObject
+
+
+class DomainOrLocalhostValueObject(DomainValueObject):
+    """
+    DomainOrLocalhostValueObject ensures the provided value is a valid domain or localhost.
+
+    Example:
+    ```python
+    from value_object_pattern.usables.internet import DomainOrLocalhostValueObject
+
+    domain = DomainOrLocalhostValueObject(value='localhost')
+    print(repr(domain))
+    # >>> DomainOrLocalhostValueObject(value=localhost)
+    ```
+    """
+
+    _DOMAIN_VALID_SINGLE_LABELS: frozenset[str] = frozenset({'localhost'})

{value_object_pattern-1.31.1 → value_object_pattern-1.33.0}/value_object_pattern/usables/internet/domain_value_object.py

@@ -32,6 +32,7 @@ class DomainValueObject(NotEmptyStringValueObject, TrimmedStringValueObject):
     _DOMAIN_MAX_LABEL_LENGTH: int = 63
     _DOMAIN_MAX_DOMAIN_LENGTH: int = 253
     _DOMAIN_REGEX: Pattern[str] = re_compile(pattern=r'[0-9a-zA-Z-]+')
+    _DOMAIN_VALID_SINGLE_LABELS: frozenset[str] = frozenset()
 
     @process(order=0)
     def _ensure_domain_is_in_lowercase(self, value: str) -> str:
@@ -72,7 +73,10 @@ class DomainValueObject(NotEmptyStringValueObject, TrimmedStringValueObject):
             ValueError: If domain value has not a valid top level domain.
         """
         if '.' not in processed_value:
-            self._raise_value_has_not_valid_top_level_domain(value=value)
+            if processed_value not in self._DOMAIN_VALID_SINGLE_LABELS:
+                self._raise_value_has_not_valid_top_level_domain(value=value)
+
+            return
 
         tdl = processed_value.split(sep='.')[-1]
         if tdl not in get_tld_dict():

{value_object_pattern-1.31.1 → value_object_pattern-1.33.0}/value_object_pattern/usables/internet/host_value_object.py

@@ -7,7 +7,7 @@ from typing import NoReturn
 from value_object_pattern import process, validation
 from value_object_pattern.usables import NotEmptyStringValueObject, TrimmedStringValueObject
 
-from .domain_value_object import DomainValueObject
+from .domain_or_localhost_value_object import DomainOrLocalhostValueObject
 from .ipv4_address_value_object import Ipv4AddressValueObject
 from .ipv6_address_value_object import Ipv6AddressValueObject
 
@@ -38,7 +38,7 @@ class HostValueObject(NotEmptyStringValueObject, TrimmedStringValueObject):
             str: The host value stored in respective format.
         """
         if self._is_domain(value=value):
-            return DomainValueObject(value=value).value
+            return DomainOrLocalhostValueObject(value=value).value
 
         if self._is_ipv4_address(value=value):
             return Ipv4AddressValueObject(value=value).value
@@ -104,7 +104,7 @@ class HostValueObject(NotEmptyStringValueObject, TrimmedStringValueObject):
             bool: True if the value is a domain, False otherwise.
         """
         try:
-            DomainValueObject(value=value)
+            DomainOrLocalhostValueObject(value=value)
             return True
 
         except (TypeError, ValueError):

{value_object_pattern-1.31.1 → value_object_pattern-1.33.0}/value_object_pattern/usables/internet/uri/url_value_object.py

@@ -37,6 +37,9 @@ def join_url(
     Returns:
         str: The URL joined.
     """
+    if ':' in host and not host.startswith('['):
+        host = f'[{host}]'
+
     netloc = host
     if user_information:
         netloc = f'{user_information}@{netloc}'
@@ -88,9 +91,18 @@ def split_netloc(value: str) -> tuple[str | None, str, int | None]:
         # prevent splitting passwords with @
         user_information, host_port = value.rsplit(sep='@', maxsplit=1)
 
+    if host_port.startswith('['):
+        host, _, port_string = host_port[1:].partition(']')
+        if port_string:
+            port = int(port_string.removeprefix(':'))
+
+        return user_information, host, port
+
+    if host_port.count(':') > 1:
+        raise ValueError('IPv6 URL hosts must be enclosed in brackets.')
+
     host = host_port
-    if ':' in host_port and host_port.count(':') == 1:
-        # prevent splitting IPv6 addresses
+    if ':' in host_port:
         host, port_string = host_port.rsplit(sep=':', maxsplit=1)
         port = int(port_string)
 
@@ -207,7 +219,11 @@ class UrlValueObject(NotEmptyStringValueObject, TrimmedStringValueObject):
             https://www.rfc-editor.org/rfc/rfc3986#section-3.2.3
         """
         _, netloc, *_ = split_url(value=value)
-        user_information, host, port = split_netloc(value=netloc)
+        try:
+            user_information, host, port = split_netloc(value=netloc)
+
+        except ValueError as error:
+            raise ValueError(f'UrlValueObject value <<<{value}>>> is not a valid url.') from error
 
         if user_information is not None and not self._URL_USER_INFORMATION_REGEX.match(string=user_information):  # noqa: E501  # fmt: skip
             raise ValueError(f'UrlValueObject value <<<{value}>>> has not a valid user information <<<{user_information}>>>.')  # noqa: E501  # fmt: skip

{value_object_pattern-1.31.1 → value_object_pattern-1.33.0}/value_object_pattern/usables/primitives/__init__.py

@@ -20,6 +20,7 @@ from .none import NoneValueObject, NotNoneValueObject
 from .string import (
     AlphaStringValueObject,
     AlphanumericStringValueObject,
+    Base64StringValueObject,
     CamelCaseStringValueObject,
     DigitStringValueObject,
     KebabCaseStringValueObject,
@@ -38,6 +39,7 @@ from .string import (
 __all__ = (
     'AlphaStringValueObject',
     'AlphanumericStringValueObject',
+    'Base64StringValueObject',
     'BooleanValueObject',
     'BytesValueObject',
     'CamelCaseStringValueObject',

{value_object_pattern-1.31.1 → value_object_pattern-1.33.0}/value_object_pattern/usables/primitives/string/__init__.py

@@ -1,5 +1,6 @@
 from .alpha_value_object import AlphaStringValueObject
 from .alphanumeric_value_object import AlphanumericStringValueObject
+from .base64_value_object import Base64StringValueObject
 from .camel_case_string_value_object import CamelCaseStringValueObject
 from .digit_value_object import DigitStringValueObject
 from .kebab_case_string_value_object import KebabCaseStringValueObject
@@ -17,6 +18,7 @@ from .uppercase_string_value_object import UppercaseStringValueObject
 __all__ = (
     'AlphaStringValueObject',
     'AlphanumericStringValueObject',
+    'Base64StringValueObject',
     'CamelCaseStringValueObject',
     'DigitStringValueObject',
     'KebabCaseStringValueObject',

value_object_pattern-1.33.0/value_object_pattern/usables/primitives/string/base64_value_object.py

@@ -0,0 +1,60 @@
+"""
+Base64StringValueObject value object.
+"""
+
+from base64 import b64decode, b64encode
+from binascii import Error
+from typing import NoReturn
+
+from value_object_pattern.decorators import validation
+
+from .trimmed_string_value_object import TrimmedStringValueObject
+
+
+class Base64StringValueObject(TrimmedStringValueObject):
+    """
+    Ensure the provided value is canonical standard Base64. The empty string is accepted as the Base64 encoding of
+    empty bytes.
+
+    Example:
+    ```python
+    from value_object_pattern.usables import Base64StringValueObject
+
+    string = Base64StringValueObject(value='aGVsbG8gd29ybGQ=')
+
+    print(repr(string))
+    # >>> Base64StringValueObject(value='aGVsbG8gd29ybGQ=')
+    ```
+    """
+
+    @validation(order=0)
+    def _ensure_value_is_base64(self, value: str) -> None:
+        """
+        Ensure the value is canonical standard Base64.
+
+        Args:
+            value (str): The provided value.
+
+        Raises:
+            ValueError: If the value is not canonical standard Base64.
+        """
+        try:
+            decoded_value = b64decode(s=value, validate=True)
+
+        except (Error, ValueError):
+            self._raise_value_is_not_base64(value=value)
+
+        if b64encode(s=decoded_value).decode() != value:
+            self._raise_value_is_not_base64(value=value)
+
+    def _raise_value_is_not_base64(self, value: str) -> NoReturn:
+        """
+        Raise a ValueError when the value is not canonical standard Base64.
+
+        Args:
+            value (str): The provided value.
+
+        Raises:
+            ValueError: Always raised because the value is not canonical standard Base64.
+        """
+        raise ValueError(f'Base64StringValueObject value <<<{value}>>> must be canonical standard Base64.')