value-object-pattern 1.27.0__tar.gz → 1.29.0__tar.gz

{value_object_pattern-1.27.0 → value_object_pattern-1.29.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: value-object-pattern
-Version: 1.27.0
+Version: 1.29.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.27.0 → value_object_pattern-1.29.0}/pyproject.toml

@@ -50,7 +50,6 @@ Issues = 'https://github.com/adriamontoto/value-object-pattern/issues'
 
 
 [dependency-groups]
-audit = ['pip-audit>=2.9.0']
 coverage = ['coverage[toml]>=7.0.0', 'smokeshow>=0.5.0']
 develop = ['pre-commit>=3.0.0']
 format = ['ruff>=0.11.10']
@@ -69,7 +68,6 @@ test = [
 ]
 types = ['types-python-dateutil>=2.9.0.20241206']
 all = [
-    { include-group = 'audit' },
     { include-group = 'coverage' },
     { include-group = 'develop' },
     { include-group = 'format' },

{value_object_pattern-1.27.0 → value_object_pattern-1.29.0}/value_object_pattern/__init__.py

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

{value_object_pattern-1.27.0 → value_object_pattern-1.29.0}/value_object_pattern/models/collections/list_value_object.py

@@ -204,7 +204,15 @@ class ListValueObject(ValueObject[list[T]], Generic[T]):  # noqa: UP046
             elif isinstance(item, Enum):
                 list_to_return.append(item.value)
 
-            elif isinstance(item, ValueObject) or hasattr(item, 'value'):
+            elif isinstance(item, ValueObject):
+                value = item._value_for_display()
+
+                if isinstance(value, Enum):
+                    value = value.value
+
+                list_to_return.append(repr(value))
+
+            elif hasattr(item, 'value'):
                 value = item.value
 
                 if isinstance(value, Enum):
@@ -256,7 +264,15 @@ class ListValueObject(ValueObject[list[T]], Generic[T]):  # noqa: UP046
             elif isinstance(item, Enum):
                 list_to_return.append(item.value)
 
-            elif isinstance(item, ValueObject) or hasattr(item, 'value'):
+            elif isinstance(item, ValueObject):
+                value = item._value_for_display()
+
+                if isinstance(value, Enum):
+                    value = value.value
+
+                list_to_return.append(str(object=value))
+
+            elif hasattr(item, 'value'):
                 value = item.value
 
                 if isinstance(value, Enum):

{value_object_pattern-1.27.0 → value_object_pattern-1.29.0}/value_object_pattern/models/primitive_conversion.py

@@ -101,7 +101,14 @@ def _convert_with_value_attribute(*, value: Any) -> Any:
     Returns:
         Any: Converted value or sentinel when the branch does not apply.
     """
-    if not (isinstance(value, ValueObject) or hasattr(value, 'value')):
+    if isinstance(value, ValueObject):
+        nested_value = value._value_for_display()
+        if nested_value is value:
+            return str(object=value)
+
+        return to_primitive(value=nested_value)
+
+    if not hasattr(value, 'value'):
         return _MISSING
 
     nested_value = getattr(value, 'value', value)

{value_object_pattern-1.27.0 → value_object_pattern-1.29.0}/value_object_pattern/models/value_object.py

@@ -136,7 +136,7 @@ class ValueObject(ABC, Generic[T]):  # noqa: UP046
         # >>> IntegerValueObject(value=10)
         ```
         """
-        return f'{self.__class__.__name__}(value={self.value!r})'
+        return f'{self.__class__.__name__}(value={self._value_for_display()!r})'
 
     @override
     def __str__(self) -> str:
@@ -160,7 +160,7 @@ class ValueObject(ABC, Generic[T]):  # noqa: UP046
         # >>> 10
         ```
         """
-        return str(object=self.value)
+        return str(object=self._value_for_display())
 
     @override
     def __hash__(self) -> int:
@@ -367,6 +367,15 @@ class ValueObject(ABC, Generic[T]):  # noqa: UP046
 
             raise error
 
+    def _value_for_display(self) -> Any:
+        """
+        Returns the value used by display-oriented representations.
+
+        Returns:
+            Any: Value safe for string, repr, and primitive display paths.
+        """
+        return self.value
+
     def _post_order_dfs_mro(self, cls: type, visited: set[type] | None = None, cut_off: type = object) -> list[type]:
         """
         Computes the Post-Order Depth-First Search (DFS) Method Resolution Order (MRO) of a class.

{value_object_pattern-1.27.0 → value_object_pattern-1.29.0}/value_object_pattern/usables/__init__.py

@@ -19,12 +19,14 @@ from .primitives import (
     NotEmptyStringValueObject,
     NotNoneValueObject,
     OddIntegerValueObject,
+    PascalCaseStringValueObject,
     PositiveFloatValueObject,
     PositiveIntegerValueObject,
     PositiveOrZeroFloatValueObject,
     PositiveOrZeroIntegerValueObject,
     PrintableStringValueObject,
     ScreamingSnakeCaseStringValueObject,
+    SecretStringValueObject,
     SnakeCaseStringValueObject,
     StringValueObject,
     TrimmedStringValueObject,
@@ -55,6 +57,7 @@ __all__ = (
     'NotEmptyStringValueObject',
     'NotNoneValueObject',
     'OddIntegerValueObject',
+    'PascalCaseStringValueObject',
     'PositiveFloatValueObject',
     'PositiveIntegerValueObject',
     'PositiveOrZeroFloatValueObject',
@@ -62,6 +65,7 @@ __all__ = (
     'PrintableStringValueObject',
     'PrintableStringValueObject',
     'ScreamingSnakeCaseStringValueObject',
+    'SecretStringValueObject',
     'SnakeCaseStringValueObject',
     'StringValueObject',
     'StringValueObject',

{value_object_pattern-1.27.0 → value_object_pattern-1.29.0}/value_object_pattern/usables/internet/utils/tld_domains.txt

@@ -1,4 +1,4 @@
-# This file was automatically updated using "update_lists.py" on 2026-02-15T03:55:23.881612+00:00
+# This file was automatically updated using "update_lists.py" on 2026-04-19T04:07:29.141154+00:00
 
 aaa
 aarp
@@ -742,6 +742,7 @@ meme
 memorial
 men
 menu
+merck
 merckmsd
 mg
 mh

{value_object_pattern-1.27.0 → value_object_pattern-1.29.0}/value_object_pattern/usables/primitives/__init__.py

@@ -25,8 +25,10 @@ from .string import (
     KebabCaseStringValueObject,
     LowercaseStringValueObject,
     NotEmptyStringValueObject,
+    PascalCaseStringValueObject,
     PrintableStringValueObject,
     ScreamingSnakeCaseStringValueObject,
+    SecretStringValueObject,
     SnakeCaseStringValueObject,
     StringValueObject,
     TrimmedStringValueObject,
@@ -54,12 +56,14 @@ __all__ = (
     'NotEmptyStringValueObject',
     'NotNoneValueObject',
     'OddIntegerValueObject',
+    'PascalCaseStringValueObject',
     'PositiveFloatValueObject',
     'PositiveIntegerValueObject',
     'PositiveOrZeroFloatValueObject',
     'PositiveOrZeroIntegerValueObject',
     'PrintableStringValueObject',
     'ScreamingSnakeCaseStringValueObject',
+    'SecretStringValueObject',
     'SnakeCaseStringValueObject',
     'StringValueObject',
     'TrimmedStringValueObject',

{value_object_pattern-1.27.0 → value_object_pattern-1.29.0}/value_object_pattern/usables/primitives/string/__init__.py

@@ -5,8 +5,10 @@ from .digit_value_object import DigitStringValueObject
 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 .secret_string_value_object import SecretStringValueObject
 from .snake_case_string_value_object import SnakeCaseStringValueObject
 from .string_value_object import StringValueObject
 from .trimmed_string_value_object import TrimmedStringValueObject
@@ -20,8 +22,10 @@ __all__ = (
     'KebabCaseStringValueObject',
     'LowercaseStringValueObject',
     'NotEmptyStringValueObject',
+    'PascalCaseStringValueObject',
     'PrintableStringValueObject',
     'ScreamingSnakeCaseStringValueObject',
+    'SecretStringValueObject',
     'SnakeCaseStringValueObject',
     'StringValueObject',
     'TrimmedStringValueObject',

value_object_pattern-1.29.0/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

value_object_pattern-1.29.0/value_object_pattern/usables/primitives/string/secret_string_value_object.py

@@ -0,0 +1,40 @@
+"""
+SecretStringValueObject value object.
+"""
+
+from sys import version_info
+
+if version_info >= (3, 12):
+    from typing import override  # pragma: no cover
+else:
+    from typing_extensions import override  # pragma: no cover
+
+from .string_value_object import StringValueObject
+
+
+class SecretStringValueObject(StringValueObject):
+    """
+    SecretStringValueObject stores a string that is redacted in display-oriented output.
+
+    Example:
+    ```python
+    from value_object_pattern.usables import SecretStringValueObject
+
+    secret = SecretStringValueObject(value='hidden-value')
+
+    print(secret)
+    # >>> ********
+    ```
+    """
+
+    _MASK: str = '********'
+
+    @override
+    def _value_for_display(self) -> str:
+        """
+        Returns the display-safe representation of the secret value.
+
+        Returns:
+            str: The redacted secret value.
+        """
+        return self._MASK