sindripy 0.1.6__tar.gz → 1.0.0__tar.gz

{sindripy-0.1.6 → sindripy-1.0.0}/.gitignore

@@ -161,4 +161,7 @@ dmypy.json
 cython_debug/
 
 # PyPI configuration file
-.pypirc
+.pypirc
+
+#IDEs and editors
+.idea

{sindripy-0.1.6 → sindripy-1.0.0}/CHANGELOG.md

@@ -2,6 +2,61 @@
 
 <!-- version list -->
 
+## v1.0.0 (2026-02-03)
+
+### Build System
+
+- Update dependencies to avoid vulnerabilities
+  ([`d863cce`](https://github.com/dimanu-py/sindri/commit/d863cce206199d53a745aec3e5be54d559c1b671))
+
+- Update sindripy version to 0.1.7 in uv.lock file
+  ([`d67bb2f`](https://github.com/dimanu-py/sindri/commit/d67bb2f15babf745650d12a43c17e6bc98d178ba))
+
+- **pyproject**: Add 'docs' to include groups
+  ([`bd8c7b7`](https://github.com/dimanu-py/sindri/commit/bd8c7b7ad1c06e080277173ee4ad83eea8885488))
+
+- **pyproject**: Add keywords for pypi seo discovery
+  ([`d36bf42`](https://github.com/dimanu-py/sindri/commit/d36bf42087994950ffacc7db37d11523e4d18da8))
+
+- **pyproject**: Remove pip install command from build_command
+  ([`842e8d7`](https://github.com/dimanu-py/sindri/commit/842e8d7195cb4e8041fd66dc268cd15446c4dbaf))
+
+- **pyproject**: Set major_on_zero to true for versioning to bump major version on breaking changes
+  ([`38d1329`](https://github.com/dimanu-py/sindri/commit/38d1329f09e4164bcbbff79b69b0108262636021))
+
+### Documentation
+
+- Update README to enhance clarity and structure for Value Object and Object Mother patterns
+  ([`ff8a3a5`](https://github.com/dimanu-py/sindri/commit/ff8a3a5a8591178eb793f6cc5eb557bfbad5ff80))
+
+- Update validation documentation and add migration guide for validator signature changes
+  ([`e38b62d`](https://github.com/dimanu-py/sindri/commit/e38b62df0ac4719601dad2a9d3ab2c461b8cfe5b))
+
+### Features
+
+- **value-objects**: Add adapter pattern to ensure backward compatibility between new and old
+  validators until old version gets deprecated
+  ([`39c3bf8`](https://github.com/dimanu-py/sindri/commit/39c3bf80136a130f6795287498eb7ae71685c3f1))
+
+- **value-objects**: Store first the value inside attribute and then perform validation instead of
+  first perform validation and then assign the attribute
+  ([`86d24b2`](https://github.com/dimanu-py/sindri/commit/86d24b2b6d96043863e27fe79ef33f407817fcd0))
+
+
+## v0.1.7 (2025-11-21)
+
+### Bug Fixes
+
+- **pyproject**: Put faker dependency as a prod dependency of sindripy to avoid errors when using
+  object mothers
+  ([`c478887`](https://github.com/dimanu-py/sindri/commit/c47888754e1b1776c917cf5c81aec05d2b0be65d))
+
+### Build System
+
+- **pyproject**: Modify build_command to try and update uv.lock with new version released
+  ([`41082cf`](https://github.com/dimanu-py/sindri/commit/41082cf3eb7e602f42a5cbf19ca8f156abdc5c43))
+
+
 ## v0.1.6 (2025-11-15)
 
 ### Build System

{sindripy-0.1.6 → sindripy-1.0.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: sindripy
-Version: 0.1.6
+Version: 1.0.0
 Summary: Value Object and Object Mother patterns implementation for Python
 Project-URL: documentation, https://dimanu-py.github.io/sindri/home/
 Project-URL: repository, https://github.com/dimanu-py/sindri/
@@ -28,6 +28,7 @@ License: MIT License
         SOFTWARE.
         
 License-File: LICENSE
+Keywords: Object Mother,Value Object,bdd,clean architecture,ddd,design patterns,domain driven design,hexagonal architecture,object mother,object mothers,object-mother,object-mothers,testing,unit tests,value object,value objects,value-object,value-objects
 Classifier: Framework :: FastAPI
 Classifier: Intended Audience :: Developers
 Classifier: Operating System :: OS Independent
@@ -43,12 +44,14 @@ Classifier: Topic :: Software Development :: Testing :: BDD
 Classifier: Topic :: Software Development :: Testing :: Unit
 Classifier: Typing :: Typed
 Requires-Python: <3.14,>=3.10
+Requires-Dist: faker
 Description-Content-Type: text/markdown
 
-<div align="center">
-  <h1>🛠️ Sindripy 🛠️</h1>
-  <strong>Easy use and customizable implementation for Value Object and Object Mother patterns.</strong>
-</div>
+# Sindripy
+
+### Value Object and Object Mother patterns for Python and Domain Driven Design applications
+
+Easy use and customizable implementation for Value Object and Object Mother patterns.
 
 <p align="center">
   <a href="https://dimanu-py.github.io/sindri/getting_started/">Getting Started</a>&nbsp;&nbsp;•&nbsp;
@@ -134,6 +137,30 @@ random_age = IntegerPrimitivesMother.any()
 random_name = StringPrimitivesMother.any()
 ```
 
+# Migrating to v1.0.0
+
+This release includes a breaking change to the validator API used by value objects:
+
+- Validators no longer accept the incoming value as a parameter. Instead, the value is assigned to `self._value` before validators run, and validator methods have the signature `def _validate_xxx(self) -> None:`.
+- This simplifies validator signatures and reduces repetition across validation methods.
+
+Why this is a breaking change
+
+- Existing validator methods that still declare a `value` parameter will receive the wrong signature and raise a `TypeError` when the framework calls them. Custom code that expects the old parameter (for example, custom exception constructors or external utilities) may also need small updates.
+
+How to migrate
+
+- Follow the step-by-step migration guide which shows the exact edits and examples: [Validator Signature Migration Guide](docs/value_objects/migration_guide.md).
+- In short: find all methods decorated with `@validate`, remove the `value` parameter, replace uses of `value` with `self._value`, and update any error messages or custom exceptions that referenced the old parameter.
+
+A quick checklist:
+
+- [ ] Update `@validate` methods to `def _... (self) -> None`
+- [ ] Replace `value` references with `self._value`
+- [ ] Update error messages and custom exception usages
+- [ ] Run your tests
+
+
 <div style="background-color: #1e2d3d; border: 1px solid #00d9ff; border-radius: 8px; padding: 16px; margin: 16px 0; display: flex; align-items: flex-start; gap: 12px;">
   <div style="font-size: 20px; color: #00d9ff; flex-shrink: 0;">ℹ️</div>
   <div>

{sindripy-0.1.6 → sindripy-1.0.0}/README.md

@@ -1,7 +1,8 @@
-<div align="center">
-  <h1>🛠️ Sindripy 🛠️</h1>
-  <strong>Easy use and customizable implementation for Value Object and Object Mother patterns.</strong>
-</div>
+# Sindripy
+
+### Value Object and Object Mother patterns for Python and Domain Driven Design applications
+
+Easy use and customizable implementation for Value Object and Object Mother patterns.
 
 <p align="center">
   <a href="https://dimanu-py.github.io/sindri/getting_started/">Getting Started</a>&nbsp;&nbsp;•&nbsp;
@@ -87,6 +88,30 @@ random_age = IntegerPrimitivesMother.any()
 random_name = StringPrimitivesMother.any()
 ```
 
+# Migrating to v1.0.0
+
+This release includes a breaking change to the validator API used by value objects:
+
+- Validators no longer accept the incoming value as a parameter. Instead, the value is assigned to `self._value` before validators run, and validator methods have the signature `def _validate_xxx(self) -> None:`.
+- This simplifies validator signatures and reduces repetition across validation methods.
+
+Why this is a breaking change
+
+- Existing validator methods that still declare a `value` parameter will receive the wrong signature and raise a `TypeError` when the framework calls them. Custom code that expects the old parameter (for example, custom exception constructors or external utilities) may also need small updates.
+
+How to migrate
+
+- Follow the step-by-step migration guide which shows the exact edits and examples: [Validator Signature Migration Guide](docs/value_objects/migration_guide.md).
+- In short: find all methods decorated with `@validate`, remove the `value` parameter, replace uses of `value` with `self._value`, and update any error messages or custom exceptions that referenced the old parameter.
+
+A quick checklist:
+
+- [ ] Update `@validate` methods to `def _... (self) -> None`
+- [ ] Replace `value` references with `self._value`
+- [ ] Update error messages and custom exception usages
+- [ ] Run your tests
+
+
 <div style="background-color: #1e2d3d; border: 1px solid #00d9ff; border-radius: 8px; padding: 16px; margin: 16px 0; display: flex; align-items: flex-start; gap: 12px;">
   <div style="font-size: 20px; color: #00d9ff; flex-shrink: 0;">ℹ️</div>
   <div>

{sindripy-0.1.6 → sindripy-1.0.0}/pyproject.toml

@@ -1,13 +1,34 @@
 [project]
 name = "sindripy"
-version = "0.1.6"
+version = "1.0.0"
 description = "Value Object and Object Mother patterns implementation for Python"
 authors = [{name = "dimanu-py", email = "dimanu.py@gmail.com"}]
 dependencies = [
+    "faker",
 ]
 requires-python = ">=3.10, <3.14"
 readme = "README.md"
 license = { file = "LICENSE" }
+keywords = [
+    "value object",
+    "value-object",
+    "value objects",
+    "value-objects",
+    "Value Object",
+    "object mother",
+    "object-mother",
+    "object mothers",
+    "object-mothers",
+    "Object Mother",
+    "domain driven design",
+    "ddd",
+    "clean architecture",
+    "hexagonal architecture",
+    "design patterns",
+    "testing",
+    "bdd",
+    "unit tests",
+]
 classifiers = [
     "Typing :: Typed",
     "Programming Language :: Python",
@@ -22,6 +43,7 @@ classifiers = [
     "Operating System :: OS Independent",
     "Topic :: Software Development :: Testing :: Unit",
     "Topic :: Software Development :: Testing :: BDD",
+    "Topic :: Software Development :: Libraries",
     "Framework :: FastAPI"
 ]
 
@@ -34,6 +56,7 @@ dev = [
     {include-group = "lint"},
     {include-group = "test"},
     {include-group = "release"},
+    {include-group = "docs"},
 ]
 
 release = [
@@ -47,7 +70,6 @@ lint = [
 ]
 test = [
     "expects>=0.9.0",
-    "faker",
     "pytest",
     "pytest-asyncio",
     "pytest-sugar>=1.1.1",
@@ -98,19 +120,17 @@ markers = [
 ]
 testpaths = ["test"]
 asyncio_default_fixture_loop_scope = "function"
-asyncio_mode = "auto"
 
 [tool.semantic_release]
 version_toml = ["pyproject.toml:project.version"]
 version_variables = ["src/sindripy/__init__.py:__version__"]
 commit_message = "bump: new version {version} created"
 commit_parser = "conventional"
-major_on_zero = false
+major_on_zero = true
 allow_zero_version = true
 no_git_verify = false
 tag_format = "{version}"
 build_command = """
-    pip install -e '.[build]'
     uv lock --upgrade-package sindripy
     git add uv.lock
 """

{sindripy-0.1.6 → sindripy-1.0.0}/src/sindripy/__init__.py

@@ -8,4 +8,4 @@ installed as a dependency.
 from sindripy import mothers, value_objects
 
 __all__ = ["mothers", "value_objects"]
-__version__ = "0.1.6"
+__version__ = "1.0.0"

{sindripy-0.1.6 → sindripy-1.0.0}/src/sindripy/value_objects/identifiers/string_uuid.py

@@ -27,8 +27,8 @@ class StringUuid(ValueObject[str]):
         ```python
         class UserId(StringUuid):
             @validate
-            def _validate_version(self, value: str) -> None:
-                parsed_uuid = UUID(value)
+            def _validate_version(self) -> None:
+                parsed_uuid = UUID(self._value)
                 if parsed_uuid.version != 4:
                     raise ValueError("Only UUID version 4 allowed")
 
@@ -38,18 +38,18 @@ class StringUuid(ValueObject[str]):
     """
 
     @validate
-    def _ensure_has_value(self, value: str) -> None:
-        if value is None:
+    def _ensure_has_value(self) -> None:
+        if self._value is None:
             raise RequiredValueError
 
     @validate
-    def _ensure_value_is_string(self, value: str) -> None:
-        if not isinstance(value, str):
-            raise IncorrectValueTypeError(value, str)
+    def _ensure_value_is_string(self) -> None:
+        if not isinstance(self._value, str):
+            raise IncorrectValueTypeError(self._value, str)
 
     @validate
-    def _ensure_value_has_valid_uuid_format(self, value: str) -> None:
+    def _ensure_value_has_valid_uuid_format(self) -> None:
         try:
-            UUID(value)
+            UUID(self._value)
         except ValueError as error:
             raise InvalidIdFormatError from error

{sindripy-0.1.6 → sindripy-1.0.0}/src/sindripy/value_objects/primitives/boolean.py

@@ -23,7 +23,7 @@ class Boolean(ValueObject[bool]):
         ```python
         class IsActive(Boolean):
              @validate
-             def _validate_true_for_premium(self, value: bool) -> None:
+             def _validate_true_for_premium(self) -> None:
                  # Custom business logic can be added here
                  pass
 
@@ -34,11 +34,11 @@ class Boolean(ValueObject[bool]):
     """
 
     @validate
-    def _ensure_has_value(self, value: bool) -> None:
-        if value is None:
+    def _ensure_has_value(self) -> None:
+        if self._value is None:
             raise RequiredValueError
 
     @validate
-    def _ensure_value_is_boolean(self, value: bool) -> None:
-        if not isinstance(value, bool):
-            raise IncorrectValueTypeError(value, bool)
+    def _ensure_value_is_boolean(self) -> None:
+        if not isinstance(self._value, bool):
+            raise IncorrectValueTypeError(self._value, bool)

{sindripy-0.1.6 → sindripy-1.0.0}/src/sindripy/value_objects/primitives/float.py

@@ -23,8 +23,8 @@ class Float(ValueObject[float]):
         ```python
         class Price(Float):
             @validate
-            def _validate_positive(self, value: float) -> None:
-                if value < 0:
+            def _validate_positive(self) -> None:
+                if self._value < 0:
                     raise ValueError("Price cannot be negative")
 
         price = Price(29.99)
@@ -34,11 +34,11 @@ class Float(ValueObject[float]):
     """
 
     @validate
-    def _ensure_has_value(self, value: float) -> None:
-        if value is None:
+    def _ensure_has_value(self) -> None:
+        if self._value is None:
             raise RequiredValueError
 
     @validate
-    def _ensure_value_is_float(self, value: float) -> None:
-        if not isinstance(value, float):
-            raise IncorrectValueTypeError(value, float)
+    def _ensure_value_is_float(self) -> None:
+        if not isinstance(self._value, float):
+            raise IncorrectValueTypeError(self._value, float)

{sindripy-0.1.6 → sindripy-1.0.0}/src/sindripy/value_objects/primitives/integer.py

@@ -23,8 +23,8 @@ class Integer(ValueObject[int]):
         ```python
         class Age(Integer):
             @validate
-            def _validate_positive(self, value: int) -> None:
-                if value < 0:
+            def _validate_positive(self) -> None:
+                if self._value < 0:
                     raise ValueError("Age cannot be negative")
 
         age = Age(25)
@@ -34,11 +34,11 @@ class Integer(ValueObject[int]):
     """
 
     @validate
-    def _ensure_has_value(self, value: int) -> None:
-        if value is None:
+    def _ensure_has_value(self) -> None:
+        if self._value is None:
             raise RequiredValueError
 
     @validate
-    def _ensure_value_is_integer(self, value: int) -> None:
-        if not isinstance(value, int):
-            raise IncorrectValueTypeError(value, int)
+    def _ensure_value_is_integer(self) -> None:
+        if not isinstance(self._value, int):
+            raise IncorrectValueTypeError(self._value, int)

{sindripy-0.1.6 → sindripy-1.0.0}/src/sindripy/value_objects/primitives/list.py

@@ -14,7 +14,7 @@ class List(ValueObject[list[T]], Generic[T]):
     @override
     def __init_subclass__(cls, **kwargs: Any) -> None:
         """
-        Initialize subclass with proper type parameter validation.
+        Initialize a subclass with proper type parameter validation.
 
         This method ensures that any subclass of List is properly parameterized
         with a type argument and extracts the element type for validation purposes. It
@@ -41,17 +41,17 @@ class List(ValueObject[list[T]], Generic[T]):
         return cls(elements)
 
     @validate
-    def _ensure_has_value(self, value: list[T]) -> None:
-        if value is None:
+    def _ensure_has_value(self) -> None:
+        if self._value is None:
             raise RequiredValueError
 
     @validate
-    def _ensure_is_list(self, value: list[T]) -> None:
-        if not isinstance(value, list):
-            raise IncorrectValueTypeError(value, type[Any])
+    def _ensure_is_list(self) -> None:
+        if not isinstance(self._value, list):
+            raise IncorrectValueTypeError(self._value, type[Any])
 
     @validate
-    def _ensure_list_elements_have_expected_type(self, value: list[T]) -> None:
+    def _ensure_list_elements_have_expected_type(self) -> None:
         cls = self.__class__
 
         if not hasattr(cls, "_element_type"):
@@ -66,7 +66,7 @@ class List(ValueObject[list[T]], Generic[T]):
             return
 
         if cls._element_is_a_value_object_instance() or cls._element_is_a_primitive_type():
-            for item in value:
+            for item in self._value:
                 if not isinstance(item, element_type):
                     raise IncorrectValueTypeError(item, list)
 

{sindripy-0.1.6 → sindripy-1.0.0}/src/sindripy/value_objects/primitives/string.py

@@ -23,8 +23,8 @@ class String(ValueObject[str]):
         ```python
         class Email(String):
             @validate
-            def _validate_email_format(self, value: str) -> None:
-                if "@" not in value:
+            def _validate_email_format(self) -> None:
+                if "@" not in self._value:
                     raise ValueError("Invalid email format")
 
         email = Email("user@example.com")
@@ -33,11 +33,11 @@ class String(ValueObject[str]):
     """
 
     @validate
-    def _ensure_has_value(self, value: str) -> None:
-        if value is None:
+    def _ensure_has_value(self) -> None:
+        if self._value is None:
             raise RequiredValueError
 
     @validate
-    def _ensure_is_string(self, value: str) -> None:
-        if not isinstance(value, str):
-            raise IncorrectValueTypeError(value, str)
+    def _ensure_is_string(self) -> None:
+        if not isinstance(self._value, str):
+            raise IncorrectValueTypeError(self._value, str)

{sindripy-0.1.6 → sindripy-1.0.0}/src/sindripy/value_objects/value_object.py

@@ -41,8 +41,8 @@ class ValueObject(ABC, Generic[T]):
         """
         Initialize the value object with the given value.
 
-        The value is validated using all methods decorated with @validate before
-        being stored. Once initialized, the value cannot be modified.
+        The value is validated using all methods decorated with @validate once it has
+        been stored. Once initialized and validated, the value cannot be modified.
 
         Args:
             value: The value to be wrapped by this value object.
@@ -60,20 +60,52 @@ class ValueObject(ABC, Generic[T]):
             repr(email)  # String(_value='Hello World')
             ```
         """
-        self._validate(value)
         object.__setattr__(self, "_value", value)
+        self._validate()
 
-    def _validate(self, value: T) -> None:
+    def _call_validator_with_adapter(self, validator: Callable) -> None:
         """
-        Validates the given value using all methods decorated with @validate.
+        Call validator method with backward compatibility support.
+
+        Supports both old signature (method(self, value)) and new signature (method(self)).
+        Detects the validator signature and calls it appropriately.
+        """
+        import inspect
+
+        try:
+            # Get the signature of the validator method
+            sig = inspect.signature(validator)
+            params = list(sig.parameters.keys())
+
+            # Check if it expects a value parameter (old signature)
+            if len(params) == 2 and params[1] != "self":
+                # Old signature: method(self, value) - emit deprecation warning
+                _warn_deprecation(validator.__name__)
+                validator(self._value)  # type: ignore[arg-type]
+            else:
+                # New signature: method(self)
+                validator()
+        except (ValueError, TypeError):
+            # If signature inspection fails, try new signature first, then old
+            try:
+                validator()
+            except Exception:
+                # Try old signature as fallback
+                _warn_deprecation(validator.__name__)
+                try:
+                    validator(self._value)  # type: ignore[arg-type]
+                except Exception:
+                    # If both fail, re-raise the original error
+                    raise
+
+    def _validate(self) -> None:
+        """
+        Validates the stored value using all methods decorated with @validate.
 
         This method collects all validator methods from the class hierarchy (in reverse MRO order)
         and executes them in the order specified by their _order attribute. All validators
         must pass for the value to be considered valid.
 
-        Args:
-            value: The value to validate.
-
         Raises:
             Various validation errors if any validator fails.
 
@@ -81,25 +113,25 @@ class ValueObject(ABC, Generic[T]):
             ```python
             class Username(ValueObject[str]):
                 @validate(order=1)
-                def _validate_not_empty(self, value: str) -> None:
-                    if not value.strip():
+                def _validate_not_empty(self) -> None:
+                    if not self._value.strip():
                         raise ValueError("Username cannot be empty")
 
                 @validate(order=2)
-                def _validate_length(self, value: str) -> None:
-                    if len(value) < 3:
+                def _validate_length(self) -> None:
+                    if len(self._value) < 3:
                         raise ValueError("Username must be at least 3 characters")
 
             username = Username("john")  # Both validators pass
-            username._validate("ab")  # Would raise ValueError for length
+            username._validate()  # Would raise ValueError for length
             ```
         """
-        validators: list[Callable[[T], None]] = []
+        validators: list[Callable[[], None]] = []
         for cls in reversed(self.__class__.__mro__):
             if cls is object:
                 continue
 
-            methods: list[tuple[int, Callable[[T], None]]] = []
+            methods: list[tuple[int, Callable[[], None]]] = []
             for name, member in cls.__dict__.items():
                 if getattr(member, "_is_validator", False):
                     validators.append(getattr(self, name))
@@ -110,7 +142,7 @@ class ValueObject(ABC, Generic[T]):
                 validators.append(method)
 
         for validator in validators:
-            validator(value)
+            self._call_validator_with_adapter(validator)
 
     @property
     def value(self) -> T:
@@ -161,7 +193,7 @@ class ValueObject(ABC, Generic[T]):
         if not isinstance(other, self.__class__):
             return False
 
-        return self.value == other.value
+        return self._value == other._value
 
     @override
     def __repr__(self) -> str:
@@ -267,3 +299,15 @@ class ValueObject(ABC, Generic[T]):
             raise AttributeError("Cannot modify the value of a ValueObject")
 
         raise AttributeError(f"Class {self.__class__.__name__} object has no attribute '{name}'")
+
+
+def _warn_deprecation(validator_name: str) -> None:
+    import warnings
+
+    warnings.warn(
+        f"Validator '{validator_name}' may use deprecated signature. "
+        f"Update to '{validator_name}(self)' instead of '{validator_name}(self, value)'. "
+        "See migration guide for details: https://dimanu-py.github.io/sindri/value_objects/mibration_guide/",
+        DeprecationWarning,
+        stacklevel=4,
+    )