value-object-pattern 0.1.0__py3-none-any.whl

value_object_pattern/usables/primitives/string/trimmed_string_value_object.py

@@ -0,0 +1,37 @@
+"""
+TrimmedStringValueObject value object.
+"""
+
+from value_object_pattern.decorators import validation
+
+from .string_value_object import StringValueObject
+
+
+class TrimmedStringValueObject(StringValueObject):
+    """
+    TrimmedStringValueObject value object ensures the provided value is trimmed.
+
+    Example:
+    ```python
+    from value_object_pattern.usables import TrimmedStringValueObject
+
+    string = TrimmedStringValueObject(value='abcd1234')
+
+    print(repr(string))
+    # >>> TrimmedStringValueObject(value='abcd1234')
+    ```
+    """
+
+    @validation(order=0)
+    def _ensure_value_is_trimmed(self, value: str) -> None:
+        """
+        Ensures the value object `value` is trimmed.
+
+        Args:
+            value (str): The provided value.
+
+        Raises:
+            ValueError: If the `value` is not trimmed.
+        """
+        if value != value.strip():
+            raise ValueError(f'TrimmedStringValueObject value <<<{value}>>> contains leading or trailing whitespaces. Only trimmed values are allowed.')  # noqa: E501  # fmt: skip

value_object_pattern/usables/primitives/string/uppercase_string_value_object.py

@@ -0,0 +1,37 @@
+"""
+UppercaseStringValueObject value object.
+"""
+
+from value_object_pattern.decorators import validation
+
+from .string_value_object import StringValueObject
+
+
+class UppercaseStringValueObject(StringValueObject):
+    """
+    UppercaseStringValueObject value object ensures the provided value is uppercase.
+
+    Example:
+    ```python
+    from value_object_pattern.usables import UppercaseStringValueObject
+
+    string = UppercaseStringValueObject(value='ABCD1234')
+
+    print(repr(string))
+    # >>> UppercaseStringValueObject(value='ABCD1234')
+    ```
+    """
+
+    @validation(order=0)
+    def _ensure_value_is_uppercase(self, value: str) -> None:
+        """
+        Ensures the value object `value` is uppercase.
+
+        Args:
+            value (str): The provided value.
+
+        Raises:
+            ValueError: If the `value` is not uppercase.
+        """
+        if not value.isupper():
+            raise ValueError(f'UppercaseStringValueObject value <<<{value}>>> contains lowercase characters. Only uppercase characters are allowed.')  # noqa: E501  # fmt: skip

value_object_pattern-0.1.0.dist-info/METADATA

@@ -0,0 +1,95 @@
+Metadata-Version: 2.4
+Name: value-object-pattern
+Version: 0.1.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
+Project-URL: Issues, https://github.com/adriamontoto/value-object-pattern/issues
+Author: Adria Montoto
+License-Expression: MIT
+License-File: LICENSE.md
+Keywords: development,domain-driven-design,encapsulation,pattern,python,tools,utilities,validation,value-object
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Typing :: Typed
+Requires-Python: >=3.11
+Requires-Dist: python-dateutil>=2.9.0
+Description-Content-Type: text/markdown
+
+<a name="readme-top"></a>
+
+# 📦 Value Object Pattern
+
+<p align="center">
+    <a href="https://github.com/adriamontoto/value-object-pattern/actions/workflows/ci.yaml?event=push&branch=master" target="_blank">
+        <img src="https://github.com/adriamontoto/value-object-pattern/actions/workflows/ci.yaml/badge.svg?event=push&branch=master" alt="CI Pipeline">
+    </a>
+        <a href="https://coverage-badge.samuelcolvin.workers.dev/redirect/adriamontoto/value-object-pattern" target="_blank">
+        <img src="https://coverage-badge.samuelcolvin.workers.dev/adriamontoto/value-object-pattern.svg" alt="Coverage Pipeline">
+    </a>
+    <a href="https://pypi.org/project/value-object-pattern" target="_blank">
+        <img src="https://img.shields.io/pypi/v/value-object-pattern?color=%2334D058&label=pypi%20package" alt="Package Version">
+    </a>
+    <a href="https://pypi.org/project/value-object-pattern/" target="_blank">
+        <img src="https://img.shields.io/pypi/pyversions/value-object-pattern.svg?color=%2334D058" alt="Supported Python Versions">
+    </a>
+</p>
+
+The **Value Object Pattern** is a Python 🐍 package that streamlines the creation and management of value objects 📦 in your projects. Value objects are immutable, self-validating objects that represent descriptive aspects of the domain with no conceptual identity. This pattern is essential for maintaining clean 🧹, maintainable, and bug-resistant 🐛 codebases by encapsulating domain-specific logic and ensuring consistency across your application 📱.
+<br><br>
+
+## Table of Contents
+
+- [📥 Installation](#installation)
+- [🤝 Contributing](#contributing)
+- [🔑 License](#license)
+
+<p align="right">
+    <a href="#readme-top">🔼 Back to top</a>
+</p><br><br>
+
+<a name="installation"></a>
+
+## 📥 Installation
+
+You can install **Value Object Pattern** using `pip`:
+
+```bash
+pip install value-object-pattern
+```
+
+<p align="right">
+    <a href="#readme-top">🔼 Back to top</a>
+</p><br><br>
+
+<a name="contributing"></a>
+
+## 🤝 Contributing
+
+We love community help! Before you open an issue or pull request, please read:
+
+- [`🤝 How to Contribute`](https://github.com/adriamontoto/value-object-pattern/blob/master/.github/CONTRIBUTING.md)
+- [`🧭 Code of Conduct`](https://github.com/adriamontoto/value-object-pattern/blob/master/.github/CODE_OF_CONDUCT.md)
+- [`🔐 Security Policy`](https://github.com/adriamontoto/value-object-pattern/blob/master/.github/SECURITY.md)
+
+_Thank you for helping make **📦 Value Object Pattern** package awesome! 🌟_
+
+<p align="right">
+    <a href="#readme-top">🔼 Back to top</a>
+</p><br><br>
+
+<a name="license"></a>
+
+## 🔑 License
+
+This project is licensed under the terms of the [`MIT license`](https://github.com/adriamontoto/value-object-pattern/blob/master/LICENSE.md).
+
+<p align="right">
+    <a href="#readme-top">🔼 Back to top</a>
+</p>

value_object_pattern-0.1.0.dist-info/RECORD

@@ -0,0 +1,73 @@
+value_object_pattern/__init__.py,sha256=0sYs7FT_KZf91Pqw1MKimsy-xZ2ltZOb51Cv28Ko-wA,166
+value_object_pattern/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+value_object_pattern/decorators/__init__.py,sha256=Ze0c0z3x5sdmV-KB7nljPsybpoTXAgjJDGfR8FCIxUQ,138
+value_object_pattern/decorators/value_object_process.py,sha256=Q_0w26XolcfZOE6avveA5OGs1yIMNAVC_AxsBV8F5D0,2621
+value_object_pattern/decorators/value_object_validation.py,sha256=ENAQuOLalc-dDzVEpRolbBg8Y0g7--4DRimHTPDD12U,2793
+value_object_pattern/models/__init__.py,sha256=Dx-VEvvCNyKmso8xWM69kz2pfTYuGxgZYD08VQPw1io,66
+value_object_pattern/models/value_object.py,sha256=nnMNv34An6nDMc215oDEAbhtDhkNoerbIJ9WAapwOuQ,11647
+value_object_pattern/usables/__init__.py,sha256=LsHh5uSECizrDXPogZC3zRMzcBIBPyiWXpqSrG2qHrg,1483
+value_object_pattern/usables/dates/__init__.py,sha256=x4MafCtJ1S9WN36cVGOfPdXeKgfptlg4QkcH9fPV4tA,253
+value_object_pattern/usables/dates/date/__init__.py,sha256=rSifr41n8gmqW80e0Ygzoj221dpVsZy7m4TecC_VJus,174
+value_object_pattern/usables/dates/date/date_value_object.py,sha256=f2JuxEJlZaMRMPq53qtDnFLxNC-uJLZJwt31_lVetqo,5054
+value_object_pattern/usables/dates/date/string_date_value_object.py,sha256=yT60yG4dTK8tffkzom05OcLpP7jHTzc0OqhU5fjTbvU,6327
+value_object_pattern/usables/dates/datetime/__init__.py,sha256=5WY9lBtGPf3p7Kb_0v7plLFrq4GzZCj8kw3cU7qHZjk,198
+value_object_pattern/usables/dates/datetime/datetime_value_object.py,sha256=-HvQz1ixAesh9HVafzejSOti88eORJ3aH8502kgqXhY,6759
+value_object_pattern/usables/dates/datetime/string_datetime_value_object.py,sha256=fm9t4N1oxfHPUgmw2RwVWq3W_NaOkpqwvSJapfNgjNM,8334
+value_object_pattern/usables/identifiers/__init__.py,sha256=0-JdvoXEqs_Y-XwVc-Jl2ak5wF4fp3XJXjUp0Z0qOxs,174
+value_object_pattern/usables/identifiers/string_uuid_value_object.py,sha256=Ph5gOFgFwr8T3zrgPT2oM1UVydcsLlTOidjzaCBWA-0,1538
+value_object_pattern/usables/identifiers/uuid_value_object.py,sha256=wL4yBVQSUvPb1cNy51_jswOgyQNJpDOTERUG0sSJS0E,1056
+value_object_pattern/usables/identifiers/country_ids/__init__.py,sha256=LppR-lkhPbYjK72x2cclB8fStBKQ7t8ZapSatISvBhk,65
+value_object_pattern/usables/identifiers/country_ids/spain/__init__.py,sha256=yye30yz-WsKCQyHd-mevxhMhLRPD5VBiZK8WjfCb8a4,76
+value_object_pattern/usables/identifiers/country_ids/spain/dni_value_object.py,sha256=gl3lhgJmmVKG1PdoTdsnjd12p0IqYdloM9oef9CaToY,2097
+value_object_pattern/usables/internet/__init__.py,sha256=rXh8kyX622qbOw_c8niU4SVW0mvV72e_hNrEIxnQxyQ,1358
+value_object_pattern/usables/internet/aws_cloud_region_value_object.py,sha256=XcO1upRhRc8X78kDYIggEXIpYgwS7v89Xlq1D7gIsPg,2404
+value_object_pattern/usables/internet/domain_value_object.py,sha256=9b8MyTWcLW1m9rOK2THkJ3oaFYPNB_kEq-feMpnluz4,5728
+value_object_pattern/usables/internet/host_value_object.py,sha256=P5YFSkrwM87WMs_9AhRE997UVg8t5oZCYGFSGwo1JKc,3890
+value_object_pattern/usables/internet/ipv4_address_value_object.py,sha256=OgoEXxDbYxVO25jOxYaWrfPKqCtgjJiu6zF2QSQetZU,8274
+value_object_pattern/usables/internet/ipv4_network_value_object.py,sha256=5VtqDmwUU3fd3GMzT24KMKIdhSxF9Bfj70i7MNdFtdA,4790
+value_object_pattern/usables/internet/ipv6_address_value_object.py,sha256=aeq4apze83ChbmfAUsZctz0gsRnXBPBgOJRovdFGW3s,7846
+value_object_pattern/usables/internet/ipv6_network_value_object.py,sha256=oERZ4Qgx8IhtiOulH_fH8_ce8BmQm5_oUlZvbjzjZvc,4242
+value_object_pattern/usables/internet/mac_address_value_object.py,sha256=ysI5ZdY2SzCJUY2D2ZNv_bzdrRM4zSC8RFoQdikFzCo,11771
+value_object_pattern/usables/internet/port_value_object.py,sha256=qQMX1fJC7ij60T41aV40VXu6AhqUARpzMy4ZoiSMiqI,15959
+value_object_pattern/usables/internet/api_keys/__init__.py,sha256=2wR-9WqSlJlF_AEMac5jt8fhqQqz0io2TFY8qABC6tY,557
+value_object_pattern/usables/internet/api_keys/aws_access_key_id_value_object.py,sha256=WVKAVa4Q7X14CsLrAnZWbqess8Ao85u1S93L3F8owd4,1366
+value_object_pattern/usables/internet/api_keys/aws_secret_access_key_value_object.py,sha256=JqX05Idd7kRHH8slIf_xXYJ_kIXyOoG_YYIWFUaj9Fs,1480
+value_object_pattern/usables/internet/api_keys/github_personal_access_token_value_object.py,sha256=YuNucb2XwUgDy6cLwn6evkfKB_jBv-z4G4oYY0AY9KQ,1591
+value_object_pattern/usables/internet/api_keys/openai_api_key_value_object.py,sha256=d70JRTeauV5hTRVOprszkR8ZeqZ_ixbV8UwNZEoyBxQ,1461
+value_object_pattern/usables/internet/api_keys/resend_api_key_value_object.py,sha256=qLyRtNwHPC1rKqFdWRdWVy-wRIKOm3j2x2CFEZ8ZNFQ,1384
+value_object_pattern/usables/internet/uri/__init__.py,sha256=se4zoQXVytMWGgqHRHQ_3XSDQlPPZ9_cPGgUJTMoV9o,341
+value_object_pattern/usables/internet/uri/http_https_url_value_object.py,sha256=0dGfi4pbRnI6DOudgasG9a4paSJb4lNtSTa9uE1Jv_o,1127
+value_object_pattern/usables/internet/uri/http_url_value_object.py,sha256=nU1IjKRmYAV2JWe-Fvji_PGti5qM540OWHf_qtDLiGw,1033
+value_object_pattern/usables/internet/uri/https_url_value_object.py,sha256=SpbIvKHn2kgXVSsxpa7dk5FEr7RwDsgjpSGqPfxl7rU,1048
+value_object_pattern/usables/internet/uri/url_value_object.py,sha256=03jHtGBCPjqhbGkSXtb8qoIv5QUF3ze-cC27-kEIWqA,12419
+value_object_pattern/usables/primitives/__init__.py,sha256=j4AatSdlRIUyQlwZuKMtGhtzgTI4F3lQXw1cC38--2w,1304
+value_object_pattern/usables/primitives/boolean/__init__.py,sha256=WhOVH2JAoQnhevx9pW1OsJh-nUF9qKpB4ZGybfSI0U4,237
+value_object_pattern/usables/primitives/boolean/boolean_value_object.py,sha256=-u6-C5JCPzik6KfrlpJRxMdWeeOCrcalhSf9wtcva20,994
+value_object_pattern/usables/primitives/boolean/false_value_object.py,sha256=fPnQLhCYtEOHVzrEm0yNyYwq-wH5Xiv5MYJyMwx_J5w,891
+value_object_pattern/usables/primitives/boolean/true_value_object.py,sha256=UmIcpgumLsjq5jeUPtTSG3g4z2MF4EY28YmPefU9QKM,884
+value_object_pattern/usables/primitives/bytes/__init__.py,sha256=QRqBTEXxNaKWDgusLCyW5OG_uFCfueV0WMm9pB7V8bk,82
+value_object_pattern/usables/primitives/bytes/bytes_value_object.py,sha256=sUmxZjTdDKjCKAV7p80xfSe9N4a5ZVIwvGmzM809Deo,1014
+value_object_pattern/usables/primitives/float/__init__.py,sha256=N28h_ApJgiqZKSHl-_57CZ1zj4b8y1UoHpolblv5dOI,284
+value_object_pattern/usables/primitives/float/float_value_object.py,sha256=6qFyCLZnQ0NBolVkYCW_9HAdIwj4VvwkKvcLpL8QJZY,970
+value_object_pattern/usables/primitives/float/negative_float_value_object.py,sha256=gfJD_LW2-iVh249S1cS84P5Xmk1ACVZCVNDm0UV_Wxk,967
+value_object_pattern/usables/primitives/float/positive_float_value_object.py,sha256=_gPQLGh3MxZ2DEf7t8RyWHZowLUu832xP9DbOS1RM6A,965
+value_object_pattern/usables/primitives/integer/__init__.py,sha256=IUtVH9mof3SSBH8v9KYJlgCcw85cOljBgsnRcoiE33s,483
+value_object_pattern/usables/primitives/integer/even_integer_value_object.py,sha256=c9DsRAIA2hnuoWyuFfZOHb8a0cBJVgZ12x_UhP5NExc,969
+value_object_pattern/usables/primitives/integer/integer_value_object.py,sha256=gR6Ua94tud92zaX2EblDdHOQIIqlQrPNPa_b9v2WBwQ,988
+value_object_pattern/usables/primitives/integer/negative_integer_value_object.py,sha256=uSUz-wOcKemwdcAwrpQUZc-vYeKIYCWM7lgbUZ4EEjw,991
+value_object_pattern/usables/primitives/integer/odd_integer_value_object.py,sha256=pE41h-FtXSe7rFQhFJeCd40yptNJHlbmNyEEW41Brvk,948
+value_object_pattern/usables/primitives/integer/positive_integer_value_object.py,sha256=e1OHlzaKkaFAJ_LVxdtxA1AqL4MF1pwZUL22s6vWyi0,1013
+value_object_pattern/usables/primitives/string/__init__.py,sha256=exdLDLKtfF4QNl5XdA916JqJd-5whAVDQfQcrRrDTzc,879
+value_object_pattern/usables/primitives/string/alpha_value_object.py,sha256=c26o-wTeTAEaEIoqkpAVOW5FZybb7Cft-IjtEvf2cew,1012
+value_object_pattern/usables/primitives/string/alphanumeric_value_object.py,sha256=_tSwQn1k7aCHPsiuS7w8qb8K4IxmC9PQRLs_RAj18S8,1104
+value_object_pattern/usables/primitives/string/digit_value_object.py,sha256=cFlEtXnA3tFGgIlz-6RJPnPcCP1Lme1xwVv2hNdVFs0,1012
+value_object_pattern/usables/primitives/string/lowercase_string_value_object.py,sha256=SD0ImkxALDDxLMTysy3rgM_jVqDEtNse8lSfEW3oDWg,1070
+value_object_pattern/usables/primitives/string/non_empty_string_value_object.py,sha256=F_nckagHDO17bnHvtks8Plso7mEjEtg9YasKB_BUfUY,1068
+value_object_pattern/usables/primitives/string/printable_string_value_object.py,sha256=pu5JoLUrxxELr_-r2b_uj-PRCeQQF7DfQSGmZevUdSs,1072
+value_object_pattern/usables/primitives/string/string_value_object.py,sha256=rHoKV4wAJheJuB2PG6jU56SPKq81fBhH_kvo8WaR0Os,988
+value_object_pattern/usables/primitives/string/trimmed_string_value_object.py,sha256=6mwcRz3zb0S48Q_6URtdKJy3-tPVOrujmOFSITO8iTs,1056
+value_object_pattern/usables/primitives/string/uppercase_string_value_object.py,sha256=SlLY1WMacc65fc7qgvLmAgL_FZKYDXCMogmPYYDis-k,1070
+value_object_pattern-0.1.0.dist-info/METADATA,sha256=Iwf18G4cZo9TM0Fs_2CBu03Xxagoa0e2kFF0Nx0KwU4,4018
+value_object_pattern-0.1.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+value_object_pattern-0.1.0.dist-info/licenses/LICENSE.md,sha256=6E0wpVdiB-k3oJ9cvVG9BPZ07yIevD3IuOECHKveFkM,1076
+value_object_pattern-0.1.0.dist-info/RECORD,,

value_object_pattern-0.1.0.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: hatchling 1.27.0
+Root-Is-Purelib: true
+Tag: py3-none-any

value_object_pattern-0.1.0.dist-info/licenses/LICENSE.md

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) (2024-2025) adriamontoto
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.