value-object-pattern 1.24.0__tar.gz → 1.25.0__tar.gz

{value_object_pattern-1.24.0 → value_object_pattern-1.25.0}/PKG-INFO

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

@@ -1,4 +1,4 @@
-__version__ = '1.24.0'
+__version__ = '1.25.0'
 
 from .decorators import process, validation
 from .models import BaseModel, EnumerationValueObject, ValueObject

{value_object_pattern-1.24.0 → value_object_pattern-1.25.0}/value_object_pattern/usables/identifiers/__init__.py

@@ -1,4 +1,3 @@
-from .strict_string_identifier_value_object import StrictStringIdentifierValueObject
 from .uuid import (
     StringUuidV1ValueObject,
     StringUuidV3ValueObject,
@@ -19,7 +18,6 @@ from .uuid import (
 )
 
 __all__ = (
-    'StrictStringIdentifierValueObject',
     'StringUuidV1ValueObject',
     'StringUuidV3ValueObject',
     'StringUuidV4ValueObject',

{value_object_pattern-1.24.0 → value_object_pattern-1.25.0}/value_object_pattern/usables/internet/__init__.py

@@ -7,8 +7,10 @@ from .ipv4_address_value_object import Ipv4AddressValueObject
 from .ipv4_network_value_object import Ipv4NetworkValueObject
 from .ipv6_address_value_object import Ipv6AddressValueObject
 from .ipv6_network_value_object import Ipv6NetworkValueObject
+from .key_value_object import KeyValueObject
 from .mac_address_value_object import MacAddressValueObject
 from .port_value_object import PortValueObject
+from .slug_value_object import SlugValueObject
 from .uri import HttpHttpsUrlValueObject, HttpUrlValueObject, HttpsUrlValueObject, UrlValueObject
 
 __all__ = (
@@ -24,7 +26,9 @@ __all__ = (
     'Ipv4NetworkValueObject',
     'Ipv6AddressValueObject',
     'Ipv6NetworkValueObject',
+    'KeyValueObject',
     'MacAddressValueObject',
     'PortValueObject',
+    'SlugValueObject',
     'UrlValueObject',
 )

value_object_pattern-1.24.0/value_object_pattern/usables/identifiers/strict_string_identifier_value_object.py → value_object_pattern-1.25.0/value_object_pattern/usables/internet/key_value_object.py

@@ -1,5 +1,5 @@
 """
-StrictStringIdentifierValueObject value object.
+KeyValueObject value object.
 """
 
 from re import Pattern, compile as re_compile
@@ -9,14 +9,12 @@ from value_object_pattern.decorators import validation
 from value_object_pattern.usables import NotEmptyStringValueObject, TrimmedStringValueObject
 
 
-class StrictStringIdentifierValueObject(NotEmptyStringValueObject, TrimmedStringValueObject):
+class KeyValueObject(NotEmptyStringValueObject, TrimmedStringValueObject):
     """
-    StrictStringIdentifierValueObject ensures the provided value is a strict identifier string.
-
-    The allowed characters are lower-case letters (`a-z`), digits (`0-9`), and hyphen (`-`).
+    KeyValueObject ensures the provided value is a valid key string.
     """
 
-    _VALIDATION_REGEX: Pattern[str] = re_compile(pattern=r'[a-z0-9-]+')
+    _VALIDATION_REGEX: Pattern[str] = re_compile(pattern=r'^[a-z0-9]+(?:[.-][a-z0-9]+)*$')
 
     @validation(order=0)
     def _ensure_value_follows_validation_regex(self, value: str) -> None:
@@ -42,4 +40,4 @@ class StrictStringIdentifierValueObject(NotEmptyStringValueObject, TrimmedString
         Raises:
             ValueError: If the `value` contains invalid characters.
         """
-        raise ValueError(f'StrictStringIdentifierValueObject value <<<{value}>>> contains invalid characters. Only a-z, 0-9, and - are allowed.')  # noqa: E501  # fmt: skip
+        raise ValueError(f'KeyValueObject value <<<{value}>>> has invalid format. Only lowercase letters and digits separated by single hyphens or dots are allowed.')  # noqa: E501  # fmt: skip

value_object_pattern-1.25.0/value_object_pattern/usables/internet/slug_value_object.py

@@ -0,0 +1,43 @@
+"""
+SlugValueObject value object.
+"""
+
+from re import Pattern, compile as re_compile
+from typing import NoReturn
+
+from value_object_pattern.decorators import validation
+from value_object_pattern.usables import NotEmptyStringValueObject, TrimmedStringValueObject
+
+
+class SlugValueObject(NotEmptyStringValueObject, TrimmedStringValueObject):
+    """
+    SlugValueObject ensures the provided value is a valid slug string.
+    """
+
+    _VALIDATION_REGEX: Pattern[str] = re_compile(pattern=r'^[a-z0-9]+(?:-[a-z0-9]+)*$')
+
+    @validation(order=0)
+    def _ensure_value_follows_validation_regex(self, value: str) -> None:
+        """
+        Ensures the value object `value` only contains allowed characters.
+
+        Args:
+            value (str): The provided value.
+
+        Raises:
+            ValueError: If the `value` contains disallowed characters.
+        """
+        if not self._VALIDATION_REGEX.fullmatch(string=value):
+            self._raise_value_contains_invalid_characters(value=value)
+
+    def _raise_value_contains_invalid_characters(self, value: str) -> NoReturn:
+        """
+        Raises a ValueError if the value object `value` contains invalid characters.
+
+        Args:
+            value (str): The provided value.
+
+        Raises:
+            ValueError: If the `value` contains invalid characters.
+        """
+        raise ValueError(f'SlugValueObject value <<<{value}>>> has invalid format. Only lowercase letters and digits separated by single hyphens are allowed.')  # noqa: E501  # fmt: skip