value-object-pattern 0.7.4__tar.gz → 0.8.0__tar.gz

{value_object_pattern-0.7.4 → value_object_pattern-0.8.0}/PKG-INFO

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

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

value_object_pattern-0.8.0/value_object_pattern/models/collections/__init__.py

@@ -0,0 +1,11 @@
+from .collection_value_object import CollectionValueObject
+from .iterable_value_object import IterableValueObject
+from .not_empty_sequence_value_object import NotEmptySequenceValueObject
+from .sequence_value_object import SequenceValueObject
+
+__all__ = (
+    'CollectionValueObject',
+    'IterableValueObject',
+    'NotEmptySequenceValueObject',
+    'SequenceValueObject',
+)

value_object_pattern-0.8.0/value_object_pattern/models/collections/collection_value_object.py

@@ -0,0 +1,107 @@
+"""
+CollectionValueObject module.
+"""
+
+from collections.abc import Collection
+from typing import Any, NoReturn
+
+from value_object_pattern.decorators import validation
+from value_object_pattern.models.value_object import ValueObject
+
+
+class CollectionValueObject(ValueObject[Collection[Any]]):
+    """
+    CollectionValueObject is a value object that ensures the provided value is from a collection.
+
+    Example:
+    ```python
+    from value_object_pattern.models.collections import CollectionValueObject
+
+    collection = CollectionValueObject(value=[1, 2, 3])
+    print(collection)
+    # >>> [1, 2, 3]
+    ```
+    """
+
+    def __contains__(self, item: Any) -> bool:
+        """
+        Returns True if the value object value contains the item, otherwise False.
+
+        Args:
+            item (Any): The item to check.
+
+        Returns:
+            bool: True if the value object value contains the item, otherwise False.
+
+        Example:
+        ```python
+        from value_object_pattern.models.collections import CollectionValueObject
+
+        collection = CollectionValueObject(value=[1, 2, 3])
+        print(1 in collection)
+        # >>> True
+        ```
+        """
+        return item in self._value
+
+    def __len__(self) -> int:
+        """
+        Returns the length of the value object value.
+
+        Returns:
+            int: The length of the value object value.
+
+        Example:
+        ```python
+        from value_object_pattern.models.collections import CollectionValueObject
+
+        collection = CollectionValueObject(value=[1, 2, 3])
+        print(len(collection))
+        # >>> 3
+        ```
+        """
+        return len(self._value)
+
+    @validation(order=0)
+    def _ensure_value_is_from_collection(self, value: Collection[Any]) -> None:
+        """
+        Ensures the value object `value` is a collection.
+
+        Args:
+            value (Collection[Any]): The provided value.
+
+        Raises:
+            TypeError: If the `value` is not a collection.
+        """
+        if not isinstance(value, Collection):
+            self._raise_value_is_not_collection(value=value)
+
+    def _raise_value_is_not_collection(self, value: Any) -> NoReturn:
+        """
+        Raises a TypeError if the value object `value` is not a collection.
+
+        Args:
+            value (Any): The provided value.
+
+        Raises:
+            TypeError: If the `value` is not a collection.
+        """
+        raise TypeError(f'CollectionValueObject value <<<{value}>>> must be a collection. Got <<<{type(value).__name__}>>> type.')  # noqa: E501  # fmt: skip
+
+    def is_empty(self) -> bool:
+        """
+        Returns True if the value object value is empty, otherwise False.
+
+        Returns:
+            bool: True if the value object value is empty, otherwise False.
+
+        Example:
+        ```python
+        from value_object_pattern.models.collections import CollectionValueObject
+
+        collection = CollectionValueObject(value=[])
+        print(collection.is_empty())
+        # >>> True
+        ```
+        """
+        return not self._value

value_object_pattern-0.8.0/value_object_pattern/models/collections/iterable_value_object.py

@@ -0,0 +1,71 @@
+"""
+IterableValueObject module.
+"""
+
+from collections.abc import Iterable
+from typing import Any, NoReturn
+
+from value_object_pattern.decorators import validation
+from value_object_pattern.models.value_object import ValueObject
+
+
+class IterableValueObject(ValueObject[Iterable[Any]]):
+    """
+    IterableValueObject is a value object that ensures the provided value is from an iterable.
+
+    Example:
+    ```python
+    from value_object_pattern.models.collections import IterableValueObject
+
+    iterable = IterableValueObject(value=[1, 2, 3])
+    print(iterable)
+    # >>> [1, 2, 3]
+    ```
+    """
+
+    def __contains__(self, item: Any) -> bool:
+        """
+        Returns True if the value object value contains the item, otherwise False.
+
+        Args:
+            item (Any): The item to check.
+
+        Returns:
+            bool: True if the value object value contains the item, otherwise False.
+
+        Example:
+        ```python
+        from value_object_pattern.models.collections import IterableValueObject
+
+        iterable = IterableValueObject(value=[1, 2, 3])
+        print(1 in iterable)
+        # >>> True
+        ```
+        """
+        return item in self._value
+
+    @validation(order=0)
+    def _ensure_value_is_from_iterable(self, value: Iterable[Any]) -> None:
+        """
+        Ensures the value object `value` is an iterable.
+
+        Args:
+            value (Iterable[Any]): The provided value.
+
+        Raises:
+            TypeError: If the `value` is not an iterable.
+        """
+        if not isinstance(value, Iterable):
+            self._raise_value_is_not_iterable(value=value)
+
+    def _raise_value_is_not_iterable(self, value: Any) -> NoReturn:
+        """
+        Raises a TypeError if the value object `value` is not an iterable.
+
+        Args:
+            value (Any): The provided value.
+
+        Raises:
+            TypeError: If the `value` is not an iterable.
+        """
+        raise TypeError(f'IterableValueObject value <<<{value}>>> must be an iterable. Got <<<{type(value).__name__}>>> type.')  # noqa: E501  # fmt: skip

value_object_pattern-0.8.0/value_object_pattern/models/collections/not_empty_sequence_value_object.py

@@ -0,0 +1,51 @@
+"""
+NotEmptySequenceValueObject module.
+"""
+
+from collections.abc import Sequence
+from typing import Any, NoReturn
+
+from value_object_pattern.decorators import validation
+
+from .sequence_value_object import SequenceValueObject
+
+
+class NotEmptySequenceValueObject(SequenceValueObject):
+    """
+    NotEmptySequenceValueObject is a value object that ensures the provided value is from a sequence.
+
+    Example:
+    ```python
+    from value_object_pattern.models.collections import NotEmptySequenceValueObject
+
+    sequence = NotEmptySequenceValueObject(value=[1, 2, 3])
+    print(sequence)
+    # >>> [1, 2, 3]
+    ```
+    """
+
+    @validation(order=0)
+    def _ensure_value_is_not_empty_sequence(self, value: Sequence[Any]) -> None:
+        """
+        Ensures the value object `value` is not an empty sequence.
+
+        Args:
+            value (Sequence[Any]): The provided value.
+
+        Raises:
+            TypeError: If the `value` is an empty sequence.
+        """
+        if not value:
+            self._raise_value_is_empty_sequence(value=value)
+
+    def _raise_value_is_empty_sequence(self, value: Any) -> NoReturn:
+        """
+        Raises a TypeError if the value object `value` is an empty sequence.
+
+        Args:
+            value (Any): The provided value.
+
+        Raises:
+            TypeError: If the `value` is an empty sequence.
+        """
+        raise TypeError(f'NotEmptySequenceValueObject value <<<{value}>>> must not be an empty sequence.')

value_object_pattern-0.8.0/value_object_pattern/models/collections/sequence_value_object.py

@@ -0,0 +1,143 @@
+"""
+SequenceValueObject module.
+"""
+
+from collections.abc import Iterator, Sequence
+from typing import Any, NoReturn
+
+from value_object_pattern.decorators import validation
+from value_object_pattern.models.value_object import ValueObject
+
+
+class SequenceValueObject(ValueObject[Sequence[Any]]):
+    """
+    SequenceValueObject is a value object that ensures the provided value is from a sequence.
+
+    Example:
+    ```python
+    from value_object_pattern.models.collections import SequenceValueObject
+
+    sequence = SequenceValueObject(value=[1, 2, 3])
+    print(sequence)
+    # >>> [1, 2, 3]
+    ```
+    """
+
+    def __contains__(self, item: Any) -> bool:
+        """
+        Returns True if the value object value contains the item, otherwise False.
+
+        Args:
+            item (Any): The item to check.
+
+        Returns:
+            bool: True if the value object value contains the item, otherwise False.
+
+        Example:
+        ```python
+        from value_object_pattern.models.collections import SequenceValueObject
+
+        sequence = SequenceValueObject(value=[1, 2, 3])
+        print(1 in sequence)
+        # >>> True
+        ```
+        """
+        return item in self._value
+
+    def __iter__(self) -> Iterator[Any]:
+        """
+        Returns an iterator over the value object value.
+
+        Returns:
+            Iterator[Any]: An iterator over the value object value.
+
+        Example:
+        ```python
+        from value_object_pattern.models.collections import SequenceValueObject
+
+        sequence = SequenceValueObject(value=[1, 2, 3])
+        print(list(sequence))
+        # >>> [1, 2, 3]
+        ```
+        """
+        return iter(self._value)
+
+    def __len__(self) -> int:
+        """
+        Returns the length of the value object value.
+
+        Returns:
+            int: The length of the value object value.
+
+        Example:
+        ```python
+        from value_object_pattern.models.collections import SequenceValueObject
+
+        sequence = SequenceValueObject(value=[1, 2, 3])
+        print(len(sequence))
+        # >>> 3
+        ```
+        """
+        return len(self._value)
+
+    def __reversed__(self) -> Iterator[Any]:
+        """
+        Returns a reversed iterator over the value object value.
+
+        Returns:
+            Iterator[Any]: A reversed iterator over the value object value.
+
+        Example:
+        ```python
+        from value_object_pattern.models.collections import SequenceValueObject
+
+        sequence = SequenceValueObject(value=[1, 2, 3])
+        print(list(reversed(sequence)))
+        # >>> [3, 2, 1]
+        ```
+        """
+        return reversed(self._value)
+
+    @validation(order=0)
+    def _ensure_value_is_from_sequence(self, value: Sequence[Any]) -> None:
+        """
+        Ensures the value object `value` is a sequence.
+
+        Args:
+            value (Sequence[Any]): The provided value.
+
+        Raises:
+            TypeError: If the `value` is not a sequence.
+        """
+        if not isinstance(value, Sequence):
+            self._raise_value_is_not_sequence(value=value)
+
+    def _raise_value_is_not_sequence(self, value: Any) -> NoReturn:
+        """
+        Raises a TypeError if the value object `value` is not a sequence.
+
+        Args:
+            value (Any): The provided value.
+
+        Raises:
+            TypeError: If the `value` is not a sequence.
+        """
+        raise TypeError(f'SequenceValueObject value <<<{value}>>> must be a sequence. Got <<<{type(value).__name__}>>> type.')  # noqa: E501  # fmt: skip
+
+    def is_empty(self) -> bool:
+        """
+        Returns True if the value object value is empty, otherwise False.
+
+        Returns:
+            bool: True if the value object value is empty, otherwise False.
+
+        Example:
+        ```python
+        from value_object_pattern.models.collections import SequenceValueObject
+
+        sequence = SequenceValueObject(value=[])
+        print(sequence.is_empty())
+        # >>> True
+        ```
+        """
+        return not self._value

{value_object_pattern-0.7.4 → value_object_pattern-0.8.0}/value_object_pattern/models/enumeration_value_object.py

@@ -165,7 +165,7 @@ class EnumerationValueObject(ValueObject[Any | E], Generic[E]):  # noqa: UP046
             if member.value == value:
                 return member
 
-        raise TypeError(f'EnumerationValueObject value <<<{value}>>> must be from the enumeration <<<{self._title}>>>.')
+        raise TypeError(f'EnumerationValueObject value <<<{value}>>> must be from the enumeration <<<{self._enumeration.__name__}>>>. Got <<<{type(value).__name__}>>> type.')  # noqa: E501  # fmt: skip
 
     @validation(order=0)
     def _ensure_value_is_from_enumeration(self, value: Any | E) -> None:
@@ -184,7 +184,7 @@ class EnumerationValueObject(ValueObject[Any | E], Generic[E]):  # noqa: UP046
         if any(value == member.value for member in self._enumeration):
             return
 
-        raise TypeError(f'EnumerationValueObject value <<<{value}>>> must be from the enumeration <<<{self._title}>>>.')
+        raise TypeError(f'EnumerationValueObject value <<<{value}>>> must be from the enumeration <<<{self._enumeration.__name__}>>>. Got <<<{type(value).__name__}>>> type.')  # noqa: E501  # fmt: skip
 
     @override
     @property