Skip to content

コンストラクタの不変条件アサーションで表明違反となった場合、何の違反なのか不明で辛い #58

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
endou-mame merged 1 commit into from
Aug 13, 2025
Merged

コンストラクタの不変条件アサーションで表明違反となった場合、何の違反なのか不明で辛い #58

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions phpunit.xml.dist
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@
timeoutForMediumTests="10"
timeoutForLargeTests="60"
displayDetailsOnPhpunitDeprecations="true"
displayDetailsOnTestsThatTriggerWarnings="true"
>
<testsuites>
<testsuite name="Unit">
Expand Down
3 changes: 2 additions & 1 deletion src/Boolean/Base/BooleanValueBase.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@
use WizDevelop\PhpMonad\Result;
use WizDevelop\PhpValueObject\Error\ValueObjectError;
use WizDevelop\PhpValueObject\IValueObject;
use WizDevelop\PhpValueObject\Utils;

/**
* 真偽値の値オブジェクトの基底クラス
Expand All @@ -17,7 +18,7 @@
{
protected function __construct(public bool $value)
{
assert(static::isValid($value)->isOk());
Utils::assertResultIsOk(static::isValid($value));
}

#[Override]
Expand Down
6 changes: 3 additions & 3 deletions src/Collection/ArrayList.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -122,15 +122,15 @@ final public static function tryFromResults(iterable $results): Result
{
$elements = is_array($results) ? $results : iterator_to_array($results);

$elementsResult = Result\combineWithErrorValue(...$elements);
$elementsResult = Result\combine(...$elements);
if ($elementsResult->isErr()) {
$flattenErrs = [];
foreach ($elementsResult->unwrapErr() as $err) {
if ($err instanceof IErrorValue) { // @phpstan-ignore-line
if ($err instanceof IErrorValue) {
$flattenErrs[] = $err;
} elseif (is_array($err)) {
foreach ($err as $e) {
if ($e instanceof IErrorValue) { // @phpstan-ignore-line
if ($e instanceof IErrorValue) {
$flattenErrs[] = $e;
} else {
throw new LogicException(
Expand Down
5 changes: 3 additions & 2 deletions src/Collection/Base/CollectionBase.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@
use WizDevelop\PhpMonad\Result;
use WizDevelop\PhpValueObject\Error\ValueObjectError;
use WizDevelop\PhpValueObject\IValueObject;
use WizDevelop\PhpValueObject\Utils;

use function count;

Expand All @@ -27,8 +28,8 @@
*/
protected function __construct(protected array $elements)
{
assert(static::isValid($elements)->isOk());
assert(static::isValidCount($elements)->isOk());
Utils::assertResultIsOk(static::isValid($elements));
Utils::assertResultIsOk(static::isValidCount($elements));
}

#[Override]
Expand Down
11 changes: 6 additions & 5 deletions src/DateTime/LocalDate.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@
use WizDevelop\PhpMonad\Result;
use WizDevelop\PhpValueObject\Error\ValueObjectError;
use WizDevelop\PhpValueObject\IValueObject;
use WizDevelop\PhpValueObject\Utils;
use WizDevelop\PhpValueObject\ValueObjectMeta;

/**
Expand Down Expand Up @@ -57,11 +58,11 @@ final private function __construct(
private int $day
) {
// NOTE: 不変条件（invariant）
assert(static::isValid($year, $month, $day)->isOk());
assert(static::isValidYear($year)->isOk());
assert(static::isValidMonth($month)->isOk());
assert(static::isValidDay($day)->isOk());
assert(static::isValidDate($year, $month, $day)->isOk());
Utils::assertResultIsOk(static::isValid($year, $month, $day));
Utils::assertResultIsOk(static::isValidYear($year));
Utils::assertResultIsOk(static::isValidMonth($month));
Utils::assertResultIsOk(static::isValidDay($day));
Utils::assertResultIsOk(static::isValidDate($year, $month, $day));
}

// -------------------------------------------------------------------------
Expand Down
5 changes: 3 additions & 2 deletions src/DateTime/LocalDateRange.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@
use WizDevelop\PhpMonad\Result;
use WizDevelop\PhpValueObject\Error\ValueObjectError;
use WizDevelop\PhpValueObject\IValueObject;
use WizDevelop\PhpValueObject\Utils;

/**
* @template TStart of LocalDate
Expand Down Expand Up @@ -42,8 +43,8 @@ final private function __construct(
private mixed $to,
) {
// NOTE: 不変条件（invariant）
assert(static::isValid($from, $to)->isOk());
assert(static::isValidRange($from, $to)->isOk());
Utils::assertResultIsOk(static::isValid($from, $to));
Utils::assertResultIsOk(static::isValidRange($from, $to));
}

// -------------------------------------------------------------------------
Expand Down
3 changes: 2 additions & 1 deletion src/DateTime/LocalDateTime.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@
use WizDevelop\PhpMonad\Result;
use WizDevelop\PhpValueObject\Error\ValueObjectError;
use WizDevelop\PhpValueObject\IValueObject;
use WizDevelop\PhpValueObject\Utils;
use WizDevelop\PhpValueObject\ValueObjectMeta;

/**
Expand All @@ -38,7 +39,7 @@ final private function __construct(
private LocalTime $time,
) {
// NOTE: 不変条件（invariant）
assert(static::isValid($date, $time)->isOk());
Utils::assertResultIsOk(static::isValid($date, $time));
}

// -------------------------------------------------------------------------
Expand Down
3 changes: 2 additions & 1 deletion src/DateTime/LocalDateTimeRange.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@
use WizDevelop\PhpMonad\Result;
use WizDevelop\PhpValueObject\Error\ValueObjectError;
use WizDevelop\PhpValueObject\IValueObject;
use WizDevelop\PhpValueObject\Utils;
use WizDevelop\PhpValueObject\ValueObjectMeta;

/**
Expand Down Expand Up @@ -37,7 +38,7 @@ final private function __construct(
private RangeType $rangeType
) {
// NOTE: 不変条件（invariant）
assert(static::isValid($from, $to)->isOk());
Utils::assertResultIsOk(static::isValid($from, $to));
}

// -------------------------------------------------------------------------
Expand Down
13 changes: 7 additions & 6 deletions src/DateTime/LocalTime.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@
use WizDevelop\PhpMonad\Result;
use WizDevelop\PhpValueObject\Error\ValueObjectError;
use WizDevelop\PhpValueObject\IValueObject;
use WizDevelop\PhpValueObject\Utils;
use WizDevelop\PhpValueObject\ValueObjectMeta;

/**
Expand Down Expand Up @@ -50,11 +51,11 @@ final private function __construct(
private int $micro
) {
// NOTE: 不変条件（invariant）
assert(static::isValid($hour, $minute, $second, $micro)->isOk());
assert(static::isValidHour($hour)->isOk());
assert(static::isValidMinute($minute)->isOk());
assert(static::isValidSecond($second)->isOk());
assert(static::isValidMicro($micro)->isOk());
Utils::assertResultIsOk(static::isValid($hour, $minute, $second, $micro));
Utils::assertResultIsOk(static::isValidHour($hour));
Utils::assertResultIsOk(static::isValidMinute($minute));
Utils::assertResultIsOk(static::isValidSecond($second));
Utils::assertResultIsOk(static::isValidMicro($micro));
}

// -------------------------------------------------------------------------
Expand Down Expand Up @@ -586,7 +587,7 @@ private static function extractTime(DateTimeInterface $value): array
$second = (int)$value->format('s');

/** @var Micro */
$micro = (int)$value->format('u'); // @phpstan-ignore varTag.type
$micro = (int)$value->format('u');

return [$hour, $minute, $second, $micro];
}
Expand Down
9 changes: 4 additions & 5 deletions src/Number/Decimal/DecimalValueBase.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@
use WizDevelop\PhpMonad\Result;
use WizDevelop\PhpValueObject\Error\ValueObjectError;
use WizDevelop\PhpValueObject\IValueObject;
use WizDevelop\PhpValueObject\Utils;

/**
* 少数の値オブジェクトの基底クラス
Expand All @@ -26,11 +27,9 @@ protected function __construct(public Number $value)
{
// NOTE: 不変条件（invariant）
assert(static::min() <= static::max());
// assert(static::min()->scale <= static::scale());
// assert(static::max()->scale <= static::scale());
assert(static::isValidRange($value)->isOk());
assert(static::isValidDigits($value)->isOk());
assert(static::isValid($value)->isOk());
Utils::assertResultIsOk(static::isValidRange($value));
Utils::assertResultIsOk(static::isValidDigits($value));
Utils::assertResultIsOk(static::isValid($value));
}

#[Override]
Expand Down
5 changes: 3 additions & 2 deletions src/Number/Integer/IntegerValueBase.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@
use WizDevelop\PhpMonad\Result;
use WizDevelop\PhpValueObject\Error\ValueObjectError;
use WizDevelop\PhpValueObject\IValueObject;
use WizDevelop\PhpValueObject\Utils;

/**
* 整数の値オブジェクトの基底クラス
Expand All @@ -25,8 +26,8 @@ protected function __construct(public int $value)
{
// NOTE: 不変条件（invariant）
assert(static::min() <= static::max());
assert(static::isValidRange($value)->isOk());
assert(static::isValid($value)->isOk());
Utils::assertResultIsOk(static::isValidRange($value));
Utils::assertResultIsOk(static::isValid($value));
}

#[Override]
Expand Down
7 changes: 4 additions & 3 deletions src/String/Base/StringValueBase.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@
use WizDevelop\PhpMonad\Result;
use WizDevelop\PhpValueObject\Error\ValueObjectError;
use WizDevelop\PhpValueObject\IValueObject;
use WizDevelop\PhpValueObject\Utils;

use function assert;

Expand All @@ -25,9 +26,9 @@ protected function __construct(public string $value)
{
// NOTE: 不変条件（invariant）
assert(static::minLength() <= static::maxLength());
assert(static::isValid($value)->isOk());
assert(static::isValidLength($value)->isOk());
assert(static::isValidRegex($value)->isOk());
Utils::assertResultIsOk(static::isValid($value));
Utils::assertResultIsOk(static::isValidLength($value));
Utils::assertResultIsOk(static::isValidRegex($value));
}

#[Override]
Expand Down
25 changes: 25 additions & 0 deletions src/Utils.php
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
<?php

declare(strict_types=1);

namespace WizDevelop\PhpValueObject;

use WizDevelop\PhpMonad\Result;
use WizDevelop\PhpValueObject\Error\ValueObjectError;

/**
* @internal
*/
final readonly class Utils
{
/**
* @param Result<bool,ValueObjectError> $result
*/
public static function assertResultIsOk(Result $result): void
{
assert($result->isOk(), $result->mapOrElse(
static fn () => 'Ok',
static fn ($error) => "error_code: {$error->getCode()}, message: {$error->getMessage()}, details: " . json_encode($error->getDetails(), JSON_UNESCAPED_UNICODE | JSON_PRETTY_PRINT)
));
}
}
Loading