From 24e220fbf5e4d83a2d421268d2a8d14f44bc6fc3 Mon Sep 17 00:00:00 2001 From: Christopher Gammie Date: Sun, 25 May 2025 20:16:07 +0100 Subject: [PATCH 1/8] docs: remove build status from readme --- README.md | 2 -- 1 file changed, 2 deletions(-) diff --git a/README.md b/README.md index 7f34ee7..dc324b8 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,3 @@ -[![Build Status](https://travis-ci.org/cloudcreativity/utils-value.svg?branch=master)](https://travis-ci.org/cloudcreativity/utils-value) - # cloudcreativity/utils-value A small library to handle scalar values that have meaning. From c8fe15668e0719e76ad92938eda00e3529f70f3d Mon Sep 17 00:00:00 2001 From: Christopher Gammie Date: Sun, 25 May 2025 20:18:49 +0100 Subject: [PATCH 2/8] feat!: set minimum php version to 8.2 --- .github/workflows/tests.yml | 8 ++++---- CHANGELOG.md | 6 ++++++ composer.json | 4 ++-- 3 files changed, 12 insertions(+), 6 deletions(-) diff --git a/.github/workflows/tests.yml b/.github/workflows/tests.yml index 58e26ae..2efd246 100644 --- a/.github/workflows/tests.yml +++ b/.github/workflows/tests.yml @@ -14,11 +14,11 @@ jobs: strategy: fail-fast: true matrix: - php: [7.1, 7.2, 7.3, 7.4, '8.0', 8.1] + php: [8.2, 8.3, 8.4] steps: - name: Checkout Code - uses: actions/checkout@v2 + uses: actions/checkout@v4 - name: Setup PHP uses: shivammathur/setup-php@v2 @@ -30,11 +30,11 @@ jobs: ini-values: error_reporting=E_ALL - name: Install dependencies - uses: nick-invision/retry@v1 + uses: nick-fields/retry@v3 with: timeout_minutes: 5 max_attempts: 5 - command: composer install --no-suggest --prefer-dist -n -o + command: composer up --no-suggest --prefer-dist -n -o - name: Execute tests run: vendor/bin/phpunit diff --git a/CHANGELOG.md b/CHANGELOG.md index 1b13604..bab24ec 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -3,6 +3,12 @@ All notable changes to this project will be documented in this file. This project adheres to [Semantic Versioning](http://semver.org/) and [this changelog format](http://keepachangelog.com/). +## Unreleased + +### Changed + +- Minimum PHP version is now 8.2. + ## [2.2.0] - 2022-03-04 ### Added diff --git a/composer.json b/composer.json index cbc4429..e38e175 100644 --- a/composer.json +++ b/composer.json @@ -17,11 +17,11 @@ } ], "require": { - "php": "^7.1.3|^8.0", + "php": "^8.2", "ext-json": "*" }, "require-dev": { - "phpunit/phpunit": "^7.0|^8.0|^9.0" + "phpunit/phpunit": "^9.0" }, "autoload": { "psr-4": { From 1fdc0900bd72d1b2d6e4115acaa131d73a6b9977 Mon Sep 17 00:00:00 2001 From: Christopher Gammie Date: Sun, 25 May 2025 20:28:58 +0100 Subject: [PATCH 3/8] feat!: add php8 type-hinting --- src/AbstractValue.php | 68 +++++++++++++++++++++++++++--------------- src/ValueException.php | 5 ---- src/ValueInterface.php | 20 ++++--------- src/ValueTrait.php | 15 ++++------ tests/IntegerValue.php | 6 +--- tests/StringValue.php | 9 +----- 6 files changed, 57 insertions(+), 66 deletions(-) diff --git a/src/AbstractValue.php b/src/AbstractValue.php index 2539433..15e0583 100644 --- a/src/AbstractValue.php +++ b/src/AbstractValue.php @@ -19,67 +19,87 @@ namespace CloudCreativity\Utils\Value; -/** - * Class AbstractValue - * - * @package CloudCreativity\Utils\Value - */ abstract class AbstractValue implements ValueInterface { - use ValueTrait; /** * Is the supplied scalar value acceptable for this value class? * - * @param $value + * @param mixed $value * @return bool */ - abstract protected function accept($value): bool; + abstract protected function accept(mixed $value): bool; /** * Fluent constructor. * - * @param $value + * @param mixed $value * @return static */ - public static function create($value): ValueInterface + public static function create(mixed $value): static { return new static($value); } /** - * Cast the provided value. + * Create a value. * * @param mixed $value * @return static */ - public static function cast($value): ValueInterface + public static function from(mixed $value): static + { + return match (true) { + $value instanceof static => $value, + $value instanceof ValueInterface => new static($value->get()), + default => new static($value), + }; + } + + /** + * Create a value if it is acceptable, otherwise return null. + * + * @param mixed $value + * @return static|null + */ + public static function tryFrom(mixed $value): ?static { - if ($value instanceof static) { - return $value; + if ($value === null) { + return null; } - if ($value instanceof ValueInterface) { - $value = $value->get(); + try { + return static::from($value); + } catch (ValueException) { + return null; } + } - return new static($value); + /** + * Backward compatibility method for casting values. + * + * @param mixed $value + * @return static + */ + public static function cast(mixed $value): static + { + return static::from($value); } /** - * Cast the provided value, if it is not null. + * Cast the provided value if it is not null. * * @param mixed|null $value - * @return ValueInterface|null + * @return static|null */ - public static function nullable($value): ?ValueInterface + public static function nullable(mixed $value): ?static { - if (is_null($value)) { + if ($value === null) { return null; } - return static::cast($value); + return static::from($value); } /** @@ -88,7 +108,7 @@ public static function nullable($value): ?ValueInterface * @param mixed $value * @throws ValueException */ - public function __construct($value) + public function __construct(mixed $value) { if ($this->notAcceptable($value)) { throw new ValueException('Expecting a valid value.'); @@ -103,7 +123,7 @@ public function __construct($value) * @param mixed $value * @return bool */ - protected function notAcceptable($value): bool + protected function notAcceptable(mixed $value): bool { return !$this->accept($value); } diff --git a/src/ValueException.php b/src/ValueException.php index 1e3ffef..fee88e8 100644 --- a/src/ValueException.php +++ b/src/ValueException.php @@ -21,11 +21,6 @@ use InvalidArgumentException; -/** - * Class ValueException - * - * @package CloudCreativity\Utils\Value - */ class ValueException extends InvalidArgumentException { } diff --git a/src/ValueInterface.php b/src/ValueInterface.php index 34bfdc7..f059459 100644 --- a/src/ValueInterface.php +++ b/src/ValueInterface.php @@ -19,21 +19,12 @@ namespace CloudCreativity\Utils\Value; +use BadMethodCallException; use JsonSerializable; +use Stringable; -/** - * Interface ValueInterface - * - * @package CloudCreativity\Utils\Value - */ -interface ValueInterface extends JsonSerializable +interface ValueInterface extends JsonSerializable, Stringable { - - /** - * @return string - */ - public function __toString(); - /** * Fluent string method. * @@ -44,15 +35,14 @@ public function toString(): string; /** * @return mixed */ - public function get(); + public function get(): mixed; /** * Is the value any of the provided values? * * @param mixed ...$values * @return bool - * @throws \BadMethodCallException - * if invoked without any values. + * @throws BadMethodCallException if invoked without any values. */ public function is(...$values): bool; diff --git a/src/ValueTrait.php b/src/ValueTrait.php index 1f0ba85..3d20e0c 100644 --- a/src/ValueTrait.php +++ b/src/ValueTrait.php @@ -28,16 +28,15 @@ */ trait ValueTrait { - /** * @var mixed */ - protected $value; + protected mixed $value; /** * @return string */ - public function __toString() + public function __toString(): string { return $this->toString(); } @@ -55,7 +54,7 @@ public function toString(): string /** * @return mixed */ - public function get() + public function get(): mixed { return $this->value; } @@ -68,7 +67,7 @@ public function get() */ public function is(...$values): bool { - if (empty($values)) { + if (count($values) === 0) { throw new BadMethodCallException('Values must be provided.'); } @@ -100,8 +99,7 @@ public function isNotEmpty(): bool /** * @inheritDoc */ - #[\ReturnTypeWillChange] - public function jsonSerialize() + public function jsonSerialize(): mixed { return $this->get(); } @@ -112,7 +110,7 @@ public function jsonSerialize() * @param mixed $value * @return bool */ - protected function matches($value): bool + protected function matches(mixed $value): bool { if ($value instanceof ValueInterface) { $value = $value->get(); @@ -134,5 +132,4 @@ protected function useStrict(): bool { return true; } - } diff --git a/tests/IntegerValue.php b/tests/IntegerValue.php index 2560610..0b1ac60 100644 --- a/tests/IntegerValue.php +++ b/tests/IntegerValue.php @@ -23,11 +23,7 @@ class IntegerValue extends AbstractValue { - - /** - * @inheritdoc - */ - protected function accept($value): bool + protected function accept(mixed $value): bool { return is_int($value); } diff --git a/tests/StringValue.php b/tests/StringValue.php index 49c9f47..8650f63 100644 --- a/tests/StringValue.php +++ b/tests/StringValue.php @@ -23,18 +23,11 @@ class StringValue extends AbstractValue { - - /** - * @inheritdoc - */ - protected function accept($value): bool + protected function accept(mixed $value): bool { return is_string($value) && 2 < strlen($value); } - /** - * @inheritdoc - */ protected function useStrict(): bool { return false; From 50e930cf9f50cbb98bf3430403bba9a8eb818b60 Mon Sep 17 00:00:00 2001 From: Christopher Gammie Date: Sun, 25 May 2025 20:47:30 +0100 Subject: [PATCH 4/8] feat!: add phpstan and value interface generics --- .github/workflows/tests.yml | 5 ++++- composer.json | 11 ++++++++++- phpstan.neon | 6 ++++++ src/AbstractValue.php | 7 ++++++- src/ValueInterface.php | 9 +++++++-- src/ValueTrait.php | 17 ++++++++++------- tests/IntegerValue.php | 3 +++ tests/StringValue.php | 3 +++ 8 files changed, 49 insertions(+), 12 deletions(-) create mode 100644 phpstan.neon diff --git a/.github/workflows/tests.yml b/.github/workflows/tests.yml index 2efd246..a39561c 100644 --- a/.github/workflows/tests.yml +++ b/.github/workflows/tests.yml @@ -36,5 +36,8 @@ jobs: max_attempts: 5 command: composer up --no-suggest --prefer-dist -n -o + - name : Run static analysis + run: composer run static + - name: Execute tests - run: vendor/bin/phpunit + run: composer run test diff --git a/composer.json b/composer.json index e38e175..97813be 100644 --- a/composer.json +++ b/composer.json @@ -21,7 +21,8 @@ "ext-json": "*" }, "require-dev": { - "phpunit/phpunit": "^9.0" + "phpunit/phpunit": "^9.0", + "phpstan/phpstan": "^2.1" }, "autoload": { "psr-4": { @@ -33,6 +34,14 @@ "CloudCreativity\\Utils\\Value\\Tests\\": "tests/" } }, + "scripts": { + "all": [ + "@static", + "@test" + ], + "static": "phpstan analyse -c phpstan.neon", + "test": "phpunit" + }, "minimum-stability": "stable", "prefer-stable": true, "extra": { diff --git a/phpstan.neon b/phpstan.neon new file mode 100644 index 0000000..ccf7355 --- /dev/null +++ b/phpstan.neon @@ -0,0 +1,6 @@ +parameters: + level: 10 + paths: + - src + - tests + treatPhpDocTypesAsCertain: false \ No newline at end of file diff --git a/src/AbstractValue.php b/src/AbstractValue.php index 15e0583..8aa53ff 100644 --- a/src/AbstractValue.php +++ b/src/AbstractValue.php @@ -19,8 +19,13 @@ namespace CloudCreativity\Utils\Value; +/** + * @template TValue + * @implements ValueInterface + */ abstract class AbstractValue implements ValueInterface { + /** @use ValueTrait */ use ValueTrait; /** @@ -39,7 +44,7 @@ abstract protected function accept(mixed $value): bool; */ public static function create(mixed $value): static { - return new static($value); + return static::from($value); } /** diff --git a/src/ValueInterface.php b/src/ValueInterface.php index f059459..8288be7 100644 --- a/src/ValueInterface.php +++ b/src/ValueInterface.php @@ -23,8 +23,13 @@ use JsonSerializable; use Stringable; +/** + * @template TValue of mixed + */ interface ValueInterface extends JsonSerializable, Stringable { + public function __construct(mixed $value); + /** * Fluent string method. * @@ -33,7 +38,7 @@ interface ValueInterface extends JsonSerializable, Stringable public function toString(): string; /** - * @return mixed + * @return TValue */ public function get(): mixed; @@ -44,6 +49,6 @@ public function get(): mixed; * @return bool * @throws BadMethodCallException if invoked without any values. */ - public function is(...$values): bool; + public function is(mixed ...$values): bool; } diff --git a/src/ValueTrait.php b/src/ValueTrait.php index 3d20e0c..5545d4d 100644 --- a/src/ValueTrait.php +++ b/src/ValueTrait.php @@ -20,16 +20,15 @@ namespace CloudCreativity\Utils\Value; use BadMethodCallException; +use LogicException; /** - * Class ValueTrait - * - * @package CloudCreativity\Utils\Value + * @template TValue */ trait ValueTrait { /** - * @var mixed + * @var TValue */ protected mixed $value; @@ -48,11 +47,15 @@ public function __toString(): string */ public function toString(): string { - return (string) $this->value; + if (is_scalar($this->value)) { + return (string) $this->value; + } + + throw new LogicException('Cannot convert value to string - override the toString method.'); } /** - * @return mixed + * @return TValue */ public function get(): mixed { @@ -97,7 +100,7 @@ public function isNotEmpty(): bool } /** - * @inheritDoc + * @return TValue */ public function jsonSerialize(): mixed { diff --git a/tests/IntegerValue.php b/tests/IntegerValue.php index 0b1ac60..9cbb5a3 100644 --- a/tests/IntegerValue.php +++ b/tests/IntegerValue.php @@ -21,6 +21,9 @@ use CloudCreativity\Utils\Value\AbstractValue; +/** + * @extends AbstractValue + */ class IntegerValue extends AbstractValue { protected function accept(mixed $value): bool diff --git a/tests/StringValue.php b/tests/StringValue.php index 8650f63..12050de 100644 --- a/tests/StringValue.php +++ b/tests/StringValue.php @@ -21,6 +21,9 @@ use CloudCreativity\Utils\Value\AbstractValue; +/** + * @extends AbstractValue + */ class StringValue extends AbstractValue { protected function accept(mixed $value): bool From e4e1c9bad61bff67f8597000865e1b060e9c488f Mon Sep 17 00:00:00 2001 From: Christopher Gammie Date: Sun, 25 May 2025 20:50:18 +0100 Subject: [PATCH 5/8] style: add pint and fix styles --- .github/workflows/tests.yml | 3 +++ CHANGELOG.md | 1 + composer.json | 6 +++++- pint.json | 13 +++++++++++++ src/AbstractValue.php | 1 + src/ValueException.php | 1 + src/ValueInterface.php | 1 + src/ValueTrait.php | 1 + tests/IntegerValue.php | 1 + tests/StringValue.php | 1 + tests/Unit/ValueTest.php | 2 +- 11 files changed, 29 insertions(+), 2 deletions(-) create mode 100644 pint.json diff --git a/.github/workflows/tests.yml b/.github/workflows/tests.yml index a39561c..07e65cb 100644 --- a/.github/workflows/tests.yml +++ b/.github/workflows/tests.yml @@ -39,5 +39,8 @@ jobs: - name : Run static analysis run: composer run static + - name: Execute style + run: composer run style + - name: Execute tests run: composer run test diff --git a/CHANGELOG.md b/CHANGELOG.md index bab24ec..fc97135 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -8,6 +8,7 @@ All notable changes to this project will be documented in this file. This projec ### Changed - Minimum PHP version is now 8.2. +- Added generics to the value interface, abstract class and trait. This will be breaking if you are running PHPStan. ## [2.2.0] - 2022-03-04 diff --git a/composer.json b/composer.json index 97813be..6aa5538 100644 --- a/composer.json +++ b/composer.json @@ -22,7 +22,8 @@ }, "require-dev": { "phpunit/phpunit": "^9.0", - "phpstan/phpstan": "^2.1" + "phpstan/phpstan": "^2.1", + "laravel/pint": "^1.22" }, "autoload": { "psr-4": { @@ -37,9 +38,12 @@ "scripts": { "all": [ "@static", + "@style", "@test" ], "static": "phpstan analyse -c phpstan.neon", + "style": "pint --test", + "style:fix": "pint", "test": "phpunit" }, "minimum-stability": "stable", diff --git a/pint.json b/pint.json new file mode 100644 index 0000000..8b2632e --- /dev/null +++ b/pint.json @@ -0,0 +1,13 @@ +{ + "preset": "psr12", + "rules": { + "declare_strict_types": true, + "trailing_comma_in_multiline": { + "elements": ["arguments", "arrays", "match", "parameters"] + }, + "nullable_type_declaration": true + }, + "notPath": [ + "tests/Unit/Domain/TestReadOnlyEntity.php" + ] +} \ No newline at end of file diff --git a/src/AbstractValue.php b/src/AbstractValue.php index 8aa53ff..11147cd 100644 --- a/src/AbstractValue.php +++ b/src/AbstractValue.php @@ -1,4 +1,5 @@ Date: Sun, 25 May 2025 20:53:32 +0100 Subject: [PATCH 6/8] build: switch to an MIT licence and update copyright notices --- LICENSE | 223 ++++----------------------------------- src/AbstractValue.php | 16 +-- src/ValueException.php | 16 +-- src/ValueInterface.php | 16 +-- src/ValueTrait.php | 16 +-- tests/IntegerValue.php | 16 +-- tests/StringValue.php | 16 +-- tests/Unit/ValueTest.php | 16 +-- 8 files changed, 49 insertions(+), 286 deletions(-) diff --git a/LICENSE b/LICENSE index d645695..c587f9b 100644 --- a/LICENSE +++ b/LICENSE @@ -1,202 +1,21 @@ - - Apache License - Version 2.0, January 2004 - http://www.apache.org/licenses/ - - TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION - - 1. Definitions. - - "License" shall mean the terms and conditions for use, reproduction, - and distribution as defined by Sections 1 through 9 of this document. - - "Licensor" shall mean the copyright owner or entity authorized by - the copyright owner that is granting the License. - - "Legal Entity" shall mean the union of the acting entity and all - other entities that control, are controlled by, or are under common - control with that entity. For the purposes of this definition, - "control" means (i) the power, direct or indirect, to cause the - direction or management of such entity, whether by contract or - otherwise, or (ii) ownership of fifty percent (50%) or more of the - outstanding shares, or (iii) beneficial ownership of such entity. - - "You" (or "Your") shall mean an individual or Legal Entity - exercising permissions granted by this License. - - "Source" form shall mean the preferred form for making modifications, - including but not limited to software source code, documentation - source, and configuration files. - - "Object" form shall mean any form resulting from mechanical - transformation or translation of a Source form, including but - not limited to compiled object code, generated documentation, - and conversions to other media types. - - "Work" shall mean the work of authorship, whether in Source or - Object form, made available under the License, as indicated by a - copyright notice that is included in or attached to the work - (an example is provided in the Appendix below). - - "Derivative Works" shall mean any work, whether in Source or Object - form, that is based on (or derived from) the Work and for which the - editorial revisions, annotations, elaborations, or other modifications - represent, as a whole, an original work of authorship. For the purposes - of this License, Derivative Works shall not include works that remain - separable from, or merely link (or bind by name) to the interfaces of, - the Work and Derivative Works thereof. - - "Contribution" shall mean any work of authorship, including - the original version of the Work and any modifications or additions - to that Work or Derivative Works thereof, that is intentionally - submitted to Licensor for inclusion in the Work by the copyright owner - or by an individual or Legal Entity authorized to submit on behalf of - the copyright owner. For the purposes of this definition, "submitted" - means any form of electronic, verbal, or written communication sent - to the Licensor or its representatives, including but not limited to - communication on electronic mailing lists, source code control systems, - and issue tracking systems that are managed by, or on behalf of, the - Licensor for the purpose of discussing and improving the Work, but - excluding communication that is conspicuously marked or otherwise - designated in writing by the copyright owner as "Not a Contribution." - - "Contributor" shall mean Licensor and any individual or Legal Entity - on behalf of whom a Contribution has been received by Licensor and - subsequently incorporated within the Work. - - 2. Grant of Copyright License. Subject to the terms and conditions of - this License, each Contributor hereby grants to You a perpetual, - worldwide, non-exclusive, no-charge, royalty-free, irrevocable - copyright license to reproduce, prepare Derivative Works of, - publicly display, publicly perform, sublicense, and distribute the - Work and such Derivative Works in Source or Object form. - - 3. Grant of Patent License. Subject to the terms and conditions of - this License, each Contributor hereby grants to You a perpetual, - worldwide, non-exclusive, no-charge, royalty-free, irrevocable - (except as stated in this section) patent license to make, have made, - use, offer to sell, sell, import, and otherwise transfer the Work, - where such license applies only to those patent claims licensable - by such Contributor that are necessarily infringed by their - Contribution(s) alone or by combination of their Contribution(s) - with the Work to which such Contribution(s) was submitted. If You - institute patent litigation against any entity (including a - cross-claim or counterclaim in a lawsuit) alleging that the Work - or a Contribution incorporated within the Work constitutes direct - or contributory patent infringement, then any patent licenses - granted to You under this License for that Work shall terminate - as of the date such litigation is filed. - - 4. Redistribution. You may reproduce and distribute copies of the - Work or Derivative Works thereof in any medium, with or without - modifications, and in Source or Object form, provided that You - meet the following conditions: - - (a) You must give any other recipients of the Work or - Derivative Works a copy of this License; and - - (b) You must cause any modified files to carry prominent notices - stating that You changed the files; and - - (c) You must retain, in the Source form of any Derivative Works - that You distribute, all copyright, patent, trademark, and - attribution notices from the Source form of the Work, - excluding those notices that do not pertain to any part of - the Derivative Works; and - - (d) If the Work includes a "NOTICE" text file as part of its - distribution, then any Derivative Works that You distribute must - include a readable copy of the attribution notices contained - within such NOTICE file, excluding those notices that do not - pertain to any part of the Derivative Works, in at least one - of the following places: within a NOTICE text file distributed - as part of the Derivative Works; within the Source form or - documentation, if provided along with the Derivative Works; or, - within a display generated by the Derivative Works, if and - wherever such third-party notices normally appear. The contents - of the NOTICE file are for informational purposes only and - do not modify the License. You may add Your own attribution - notices within Derivative Works that You distribute, alongside - or as an addendum to the NOTICE text from the Work, provided - that such additional attribution notices cannot be construed - as modifying the License. - - You may add Your own copyright statement to Your modifications and - may provide additional or different license terms and conditions - for use, reproduction, or distribution of Your modifications, or - for any such Derivative Works as a whole, provided Your use, - reproduction, and distribution of the Work otherwise complies with - the conditions stated in this License. - - 5. Submission of Contributions. Unless You explicitly state otherwise, - any Contribution intentionally submitted for inclusion in the Work - by You to the Licensor shall be under the terms and conditions of - this License, without any additional terms or conditions. - Notwithstanding the above, nothing herein shall supersede or modify - the terms of any separate license agreement you may have executed - with Licensor regarding such Contributions. - - 6. Trademarks. This License does not grant permission to use the trade - names, trademarks, service marks, or product names of the Licensor, - except as required for reasonable and customary use in describing the - origin of the Work and reproducing the content of the NOTICE file. - - 7. Disclaimer of Warranty. Unless required by applicable law or - agreed to in writing, Licensor provides the Work (and each - Contributor provides its Contributions) on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or - implied, including, without limitation, any warranties or conditions - of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A - PARTICULAR PURPOSE. You are solely responsible for determining the - appropriateness of using or redistributing the Work and assume any - risks associated with Your exercise of permissions under this License. - - 8. Limitation of Liability. In no event and under no legal theory, - whether in tort (including negligence), contract, or otherwise, - unless required by applicable law (such as deliberate and grossly - negligent acts) or agreed to in writing, shall any Contributor be - liable to You for damages, including any direct, indirect, special, - incidental, or consequential damages of any character arising as a - result of this License or out of the use or inability to use the - Work (including but not limited to damages for loss of goodwill, - work stoppage, computer failure or malfunction, or any and all - other commercial damages or losses), even if such Contributor - has been advised of the possibility of such damages. - - 9. Accepting Warranty or Additional Liability. While redistributing - the Work or Derivative Works thereof, You may choose to offer, - and charge a fee for, acceptance of support, warranty, indemnity, - or other liability obligations and/or rights consistent with this - License. However, in accepting such obligations, You may act only - on Your own behalf and on Your sole responsibility, not on behalf - of any other Contributor, and only if You agree to indemnify, - defend, and hold each Contributor harmless for any liability - incurred by, or claims asserted against, such Contributor by reason - of your accepting any such warranty or additional liability. - - END OF TERMS AND CONDITIONS - - APPENDIX: How to apply the Apache License to your work. - - To apply the Apache License to your work, attach the following - boilerplate notice, with the fields enclosed by brackets "[]" - replaced with your own identifying information. (Don't include - the brackets!) The text should be enclosed in the appropriate - comment syntax for the file format. We also recommend that a - file or class name and description of purpose be included on the - same "printed page" as the copyright notice for easier - identification within third-party archives. - - Copyright [yyyy] [name of copyright owner] - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. +The MIT License (MIT) + +Copyright (c) 2024 Cloud Creativity Ltd + +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. \ No newline at end of file diff --git a/src/AbstractValue.php b/src/AbstractValue.php index 11147cd..36319a5 100644 --- a/src/AbstractValue.php +++ b/src/AbstractValue.php @@ -1,19 +1,11 @@ Date: Sun, 25 May 2025 20:57:31 +0100 Subject: [PATCH 7/8] tests: upgrade to PHPUnit 11 --- .gitignore | 2 +- composer.json | 4 ++-- phpunit.xml | 11 +++-------- 3 files changed, 6 insertions(+), 11 deletions(-) diff --git a/.gitignore b/.gitignore index 3d7e132..d0757eb 100644 --- a/.gitignore +++ b/.gitignore @@ -1,3 +1,3 @@ vendor/ composer.lock -.phpunit.result.cache +.phpunit.cache/ diff --git a/composer.json b/composer.json index 6aa5538..fe0e379 100644 --- a/composer.json +++ b/composer.json @@ -21,7 +21,7 @@ "ext-json": "*" }, "require-dev": { - "phpunit/phpunit": "^9.0", + "phpunit/phpunit": "^11.5", "phpstan/phpstan": "^2.1", "laravel/pint": "^1.22" }, @@ -50,7 +50,7 @@ "prefer-stable": true, "extra": { "branch-alias": { - "dev-develop": "2.x-dev" + "dev-develop": "3.x-dev" } } } diff --git a/phpunit.xml b/phpunit.xml index 29d4b2a..d281379 100644 --- a/phpunit.xml +++ b/phpunit.xml @@ -1,20 +1,15 @@ + xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/10.5/phpunit.xsd" + cacheDirectory=".phpunit.cache" + backupStaticProperties="false"> ./tests/Unit/ From 2951f7856e3c3406bfc0b86db6c950168134a75a Mon Sep 17 00:00:00 2001 From: Christopher Gammie Date: Sun, 25 May 2025 21:04:34 +0100 Subject: [PATCH 8/8] feat!: make abstract value and trait readonly --- CHANGELOG.md | 1 + src/AbstractValue.php | 2 +- src/ValueTrait.php | 23 +++-------------------- tests/IntegerValue.php | 2 +- tests/StringValue.php | 2 +- 5 files changed, 7 insertions(+), 23 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index fc97135..cd6c8fb 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -9,6 +9,7 @@ All notable changes to this project will be documented in this file. This projec - Minimum PHP version is now 8.2. - Added generics to the value interface, abstract class and trait. This will be breaking if you are running PHPStan. +- **BREAKING**: The abstract value and value trait are now both readonly. This is because value objects should always be immutable. ## [2.2.0] - 2022-03-04 diff --git a/src/AbstractValue.php b/src/AbstractValue.php index 36319a5..90eb20f 100644 --- a/src/AbstractValue.php +++ b/src/AbstractValue.php @@ -16,7 +16,7 @@ * @template TValue * @implements ValueInterface */ -abstract class AbstractValue implements ValueInterface +abstract readonly class AbstractValue implements ValueInterface { /** @use ValueTrait */ use ValueTrait; diff --git a/src/ValueTrait.php b/src/ValueTrait.php index c3d0448..f37422c 100644 --- a/src/ValueTrait.php +++ b/src/ValueTrait.php @@ -23,11 +23,8 @@ trait ValueTrait /** * @var TValue */ - protected mixed $value; + public readonly mixed $value; - /** - * @return string - */ public function __toString(): string { return $this->toString(); @@ -35,8 +32,6 @@ public function __toString(): string /** * Fluent to string method. - * - * @return string */ public function toString(): string { @@ -58,8 +53,7 @@ public function get(): mixed /** * Is the value any of the provided values? * - * @param mixed ...$values - * @return bool + * @param mixed ...$values */ public function is(...$values): bool { @@ -76,20 +70,14 @@ public function is(...$values): bool return false; } - /** - * @return bool - */ public function isEmpty(): bool { return empty($this->value); } - /** - * @return bool - */ public function isNotEmpty(): bool { - return !$this->isEmpty(); + return ! $this->isEmpty(); } /** @@ -102,9 +90,6 @@ public function jsonSerialize(): mixed /** * Does the value match the provided value? - * - * @param mixed $value - * @return bool */ protected function matches(mixed $value): bool { @@ -121,8 +106,6 @@ protected function matches(mixed $value): bool /** * Should strict comparison be used for comparing values? - * - * @return bool */ protected function useStrict(): bool { diff --git a/tests/IntegerValue.php b/tests/IntegerValue.php index 1e250b5..2bccb19 100644 --- a/tests/IntegerValue.php +++ b/tests/IntegerValue.php @@ -17,7 +17,7 @@ /** * @extends AbstractValue */ -class IntegerValue extends AbstractValue +final readonly class IntegerValue extends AbstractValue { protected function accept(mixed $value): bool { diff --git a/tests/StringValue.php b/tests/StringValue.php index 287ae2f..7b082bd 100644 --- a/tests/StringValue.php +++ b/tests/StringValue.php @@ -17,7 +17,7 @@ /** * @extends AbstractValue */ -class StringValue extends AbstractValue +final readonly class StringValue extends AbstractValue { protected function accept(mixed $value): bool {