Refactor and standardize integer type naming and testing structure

georgedeploy · georgedeploy · commit d2c74fbdd893 · 2025-11-26T21:13:51.000+01:00
- Renamed multiple integer types (`WeekDayInt`, `NonNegativeInt`, `PositiveInt`, `IntegerBasic`) to align with naming consistency (`IntegerWeekDay`, `IntegerNonNegative`, `IntegerPositive`, `IntegerStandart`).
- Introduced alias classes (`PositiveInt`, `NonNegativeInt`, `Id`) to retain backward compatibility and improve extensibility.
- Added new tests for aliases to validate functionality.
- Updated existing tests, documentation, and examples to use new naming conventions.
- Enhanced exception hierarchy for stricter validations (`IntegerTypeException`).
diff --git a/docs/INSTALL.md b/docs/INSTALL.md
@@ -31,9 +31,9 @@ Create a quick test script (e.g., demo.php):
 <?php
 require __DIR__ . '/vendor/autoload.php';
 
-use PhpTypedValues\Integer\PositiveInt;
+use PhpTypedValues\Integer\IntegerPositive;
 
-echo PositiveInt::fromString('21')->value(); // 21
+echo IntegerPositive::fromString('21')->value(); // 21
 ```
 
 Run it:
diff --git a/docs/USAGE.md b/docs/USAGE.md
@@ -41,17 +41,17 @@ Static usage examples
 ---------------------
 
 ```php
-use PhpTypedValues\DateTime\DateTimeAtom;use PhpTypedValues\DateTime\Timestamp\TimestampSeconds;use PhpTypedValues\Float\FloatBasic;use PhpTypedValues\Float\NonNegativeFloat;use PhpTypedValues\Integer\IntegerBasic;use PhpTypedValues\Integer\NonNegativeInt;use PhpTypedValues\Integer\PositiveInt;use PhpTypedValues\Integer\WeekDayInt;use PhpTypedValues\String\NonEmptyStr;use PhpTypedValues\String\StringBasic;
+use PhpTypedValues\DateTime\DateTimeAtom;use PhpTypedValues\DateTime\Timestamp\TimestampSeconds;use PhpTypedValues\Float\FloatBasic;use PhpTypedValues\Float\NonNegativeFloat;use PhpTypedValues\Integer\IntegerStandart;use PhpTypedValues\Integer\IntegerNonNegative;use PhpTypedValues\Integer\IntegerPositive;use PhpTypedValues\Integer\IntegerWeekDay;use PhpTypedValues\String\NonEmptyStr;use PhpTypedValues\String\StringBasic;
 
 // Integers
-$any = IntegerBasic::fromInt(-10);
-$pos = PositiveInt::fromInt(1);
-$nn  = NonNegativeInt::fromInt(0);
-$wd  = WeekDayInt::fromInt(7);        // 1..7
+$any = IntegerStandart::fromInt(-10);
+$pos = IntegerPositive::fromInt(1);
+$nn  = IntegerNonNegative::fromInt(0);
+$wd  = IntegerWeekDay::fromInt(7);        // 1..7
 
 // From string (integers)
-$posFromString = PositiveInt::fromString('123');
-$wdFromString  = WeekDayInt::fromString('5');
+$posFromString = IntegerPositive::fromString('123');
+$wdFromString  = IntegerWeekDay::fromString('5');
 
 // Strings
 $greeting = StringBasic::fromString('hello');
@@ -81,16 +81,16 @@ Validation errors (static constructors)
 Invalid input throws an exception with a helpful message.
 
 ```php
-use PhpTypedValues\Integer\PositiveInt;
-use PhpTypedValues\Integer\WeekDayInt;
+use PhpTypedValues\Integer\IntegerPositive;
+use PhpTypedValues\Integer\IntegerWeekDay;
 use PhpTypedValues\String\NonEmptyStr;
 use PhpTypedValues\Float\NonNegativeFloat;
 use PhpTypedValues\DateTime\DateTimeAtom;
 
-PositiveInt::fromInt(0);              // throws: must be > 0
-PositiveInt::fromString('12.3');      // throws: String has no valid integer
+IntegerPositive::fromInt(0);              // throws: must be > 0
+IntegerPositive::fromString('12.3');      // throws: String has no valid integer
 
-WeekDayInt::fromInt(0);               // throws: Value must be between 1 and 7
+IntegerWeekDay::fromInt(0);               // throws: Value must be between 1 and 7
 
 NonEmptyStr::fromString('');          // throws: Value must be a non-empty string
 
@@ -110,9 +110,9 @@ declare(strict_types=1);
 
 namespace App\Domain;
 
-use PhpTypedValues\Integer\PositiveInt;
+use PhpTypedValues\Integer\IntegerPositive;
 
-final class UserId extends PositiveInt {}
+final class UserId extends IntegerPositive {}
 
 // Usage
 $userId = UserId::fromInt(42);
@@ -190,15 +190,15 @@ declare(strict_types=1);
 
 namespace App\Domain;
 
-use PhpTypedValues\Integer\PositiveInt;
+use PhpTypedValues\Integer\IntegerPositive;
 use PhpTypedValues\String\NonEmptyStr;
 use PhpTypedValues\Float\NonNegativeFloat;
 use PhpTypedValues\DateTime\DateTimeAtom;
 
 final class Profile
 {
     public function __construct(
-        public readonly PositiveInt $id,
+        public readonly IntegerPositive $id,
         public readonly NonEmptyStr $firstName,
         public readonly NonEmptyStr $lastName,
         public readonly ?NonEmptyStr $middleName,     // nullable field
@@ -216,7 +216,7 @@ final class Profile
         int|float|string|null $heightM
     ): self {
         return new self(
-            PositiveInt::fromInt($id),
+            IntegerPositive::fromInt($id),
             NonEmptyStr::fromString($firstName),
             NonEmptyStr::fromString($lastName),
             $middleName !== null ? NonEmptyStr::fromString($middleName) : null,
@@ -237,7 +237,7 @@ $p1 = Profile::fromScalars(
 );
 
 $p2 = new Profile(
-    id: PositiveInt::fromInt(202),
+    id: IntegerPositive::fromInt(202),
     firstName: NonEmptyStr::fromString('Bob'),
     lastName: NonEmptyStr::fromString('Johnson'),
     middleName: NonEmptyStr::fromString('A.'),
diff --git a/src/Code/Exception/ReasonableRangeDateTimeTypeException.php b/src/Code/Exception/ReasonableRangeDateTimeTypeException.php
@@ -4,6 +4,6 @@
 
 namespace PhpTypedValues\Code\Exception;
 
-class ReasonableRangeDateTimeTypeException extends TypeException
+class ReasonableRangeDateTimeTypeException extends DateTimeTypeException
 {
 }
diff --git a/src/Integer/Alias/Id.php b/src/Integer/Alias/Id.php
@@ -0,0 +1,14 @@
+<?php
+
+declare(strict_types=1);
+
+namespace PhpTypedValues\Integer\Alias;
+
+use PhpTypedValues\Integer\IntegerPositive;
+
+/**
+ * @psalm-immutable
+ */
+readonly class Id extends IntegerPositive
+{
+}
diff --git a/src/Integer/Alias/NonNegativeInt.php b/src/Integer/Alias/NonNegativeInt.php
@@ -0,0 +1,14 @@
+<?php
+
+declare(strict_types=1);
+
+namespace PhpTypedValues\Integer\Alias;
+
+use PhpTypedValues\Integer\IntegerNonNegative;
+
+/**
+ * @psalm-immutable
+ */
+readonly class NonNegativeInt extends IntegerNonNegative
+{
+}
diff --git a/src/Integer/Alias/PositiveInt.php b/src/Integer/Alias/PositiveInt.php
@@ -0,0 +1,14 @@
+<?php
+
+declare(strict_types=1);
+
+namespace PhpTypedValues\Integer\Alias;
+
+use PhpTypedValues\Integer\IntegerPositive;
+
+/**
+ * @psalm-immutable
+ */
+readonly class PositiveInt extends IntegerPositive
+{
+}
diff --git a/src/Integer/IntegerNonNegative.php b/src/Integer/IntegerNonNegative.php
@@ -12,7 +12,7 @@
 /**
  * @psalm-immutable
  */
-readonly class NonNegativeInt extends IntType
+readonly class IntegerNonNegative extends IntType
 {
     /** @var non-negative-int */
     protected int $value;
diff --git a/src/Integer/IntegerPositive.php b/src/Integer/IntegerPositive.php
@@ -12,7 +12,7 @@
 /**
  * @psalm-immutable
  */
-readonly class PositiveInt extends IntType
+readonly class IntegerPositive extends IntType
 {
     /** @var positive-int */
     protected int $value;
diff --git a/src/Integer/IntegerStandart.php b/src/Integer/IntegerStandart.php
@@ -10,7 +10,7 @@
 /**
  * @psalm-immutable
  */
-readonly class IntegerBasic extends IntType
+readonly class IntegerStandart extends IntType
 {
     protected int $value;
 
diff --git a/src/Integer/IntegerWeekDay.php b/src/Integer/IntegerWeekDay.php
@@ -12,7 +12,7 @@
 /**
  * @psalm-immutable
  */
-readonly class WeekDayInt extends IntType
+readonly class IntegerWeekDay extends IntType
 {
     /** @var int<1, 7> */
     protected int $value;
diff --git a/src/psalmTest.php b/src/psalmTest.php
@@ -14,37 +14,28 @@
 use PhpTypedValues\DateTime\Timestamp\TimestampSeconds;
 use PhpTypedValues\Float\FloatBasic;
 use PhpTypedValues\Float\NonNegativeFloat;
-use PhpTypedValues\Integer\IntegerBasic;
-use PhpTypedValues\Integer\NonNegativeInt;
-use PhpTypedValues\Integer\PositiveInt;
-use PhpTypedValues\Integer\WeekDayInt;
+use PhpTypedValues\Integer\Alias\Id;
+use PhpTypedValues\Integer\Alias\NonNegativeInt;
+use PhpTypedValues\Integer\Alias\PositiveInt;
+use PhpTypedValues\Integer\IntegerNonNegative;
+use PhpTypedValues\Integer\IntegerPositive;
+use PhpTypedValues\Integer\IntegerStandart;
+use PhpTypedValues\Integer\IntegerWeekDay;
 use PhpTypedValues\String\NonEmptyStr;
 use PhpTypedValues\String\StringBasic;
 
-// try {
-//    echo DateTimeImmutable::createFromFormat('U.u', '953402300800.000000')->format('U.u');
-// } catch (Throwable $e) {
-//    var_dump('error');
-//    var_dump($e);
-// }
-//
-// try {
-//    echo TimestampMilliseconds::fromString('953402300800000')->toString(); // '253402300800000'
-// } catch (Throwable $e) {
-//    var_dump('error');
-//    var_dump($e);
-// }
-// exit('ssssssssss');
-
 /**
  * Integer.
  */
-testInteger(IntegerBasic::fromInt(10)->value());
-testPositiveInt(PositiveInt::fromInt(10)->value());
-testNonNegativeInt(NonNegativeInt::fromInt(10)->value());
-testWeekDayInt(WeekDayInt::fromInt(7)->value());
-
-echo IntegerBasic::fromString('10')->toString() . \PHP_EOL;
+testInteger(IntegerStandart::fromInt(10)->value());
+testPositiveInt(IntegerPositive::fromInt(10)->value());
+testNonNegativeInt(IntegerNonNegative::fromInt(10)->value());
+testWeekDayInt(IntegerWeekDay::fromInt(7)->value());
+
+echo NonNegativeInt::fromString('10')->toString() . \PHP_EOL;
+echo PositiveInt::fromString('10')->toString() . \PHP_EOL;
+echo IntegerStandart::fromString('10')->toString() . \PHP_EOL;
+echo Id::fromString('10')->toString() . \PHP_EOL;
 
 /**
  * String.
diff --git a/tests/Unit/Code/Integer/IntTypeTest.php b/tests/Unit/Code/Integer/IntTypeTest.php
@@ -3,27 +3,27 @@
 declare(strict_types=1);
 
 use PhpTypedValues\Code\Exception\IntegerTypeException;
-use PhpTypedValues\Integer\IntegerBasic;
+use PhpTypedValues\Integer\IntegerStandart;
 
 it('fromInt returns exact value and toString matches', function (): void {
-    $i1 = IntegerBasic::fromInt(-10);
+    $i1 = IntegerStandart::fromInt(-10);
     expect($i1->value())->toBe(-10)
         ->and($i1->toString())->toBe('-10');
 
-    $i2 = IntegerBasic::fromInt(0);
+    $i2 = IntegerStandart::fromInt(0);
     expect($i2->value())->toBe(0)
         ->and($i2->toString())->toBe('0');
 });
 
 it('fromString parses valid integer strings including negatives and leading zeros', function (): void {
-    expect(IntegerBasic::fromString('-15')->value())->toBe(-15)
-        ->and(IntegerBasic::fromString('0')->toString())->toBe('0')
-        ->and(IntegerBasic::fromString('42')->toString())->toBe('42');
+    expect(IntegerStandart::fromString('-15')->value())->toBe(-15)
+        ->and(IntegerStandart::fromString('0')->toString())->toBe('0')
+        ->and(IntegerStandart::fromString('42')->toString())->toBe('42');
 });
 
 it('fromString rejects non-integer strings', function (): void {
     $invalid = ['5a', 'a5', '', 'abc', ' 5', '5 ', '+5', '05', '--5', '3.14'];
     foreach ($invalid as $str) {
-        expect(fn() => IntegerBasic::fromString($str))->toThrow(IntegerTypeException::class);
+        expect(fn() => IntegerStandart::fromString($str))->toThrow(IntegerTypeException::class);
     }
 });
diff --git a/tests/Unit/Integer/Alias/IdTypeTest.php b/tests/Unit/Integer/Alias/IdTypeTest.php
@@ -0,0 +1,42 @@
+<?php
+
+declare(strict_types=1);
+
+use PhpTypedValues\Code\Exception\IntegerTypeException;
+use PhpTypedValues\Integer\Alias\Id;
+
+it('creates Id', function (): void {
+    expect(Id::fromInt(1)->value())->toBe(1);
+});
+
+it('fails on 0', function (): void {
+    expect(fn() => Id::fromInt(0))->toThrow(IntegerTypeException::class);
+});
+
+it('fails on negatives', function (): void {
+    expect(fn() => Id::fromInt(-1))->toThrow(IntegerTypeException::class);
+});
+
+it('creates Id from string', function (): void {
+    expect(Id::fromString('1')->value())->toBe(1);
+});
+
+it('fails Id from integerish string', function (): void {
+    expect(fn() => Id::fromString('5.0'))->toThrow(IntegerTypeException::class);
+});
+
+it('fails creating Id from string 0', function (): void {
+    expect(fn() => Id::fromString('0'))->toThrow(IntegerTypeException::class);
+});
+
+it('fails creating Id from negative string', function (): void {
+    expect(fn() => Id::fromString('-3'))->toThrow(IntegerTypeException::class);
+});
+
+it('toString returns scalar string for Id', function (): void {
+    expect((new Id(3))->toString())->toBe('3');
+});
+
+it('fails creating Id from float string', function (): void {
+    expect(fn() => Id::fromString('5.5'))->toThrow(IntegerTypeException::class);
+});
diff --git a/tests/Unit/Integer/Alias/NonNegativeIntTypeTest.php b/tests/Unit/Integer/Alias/NonNegativeIntTypeTest.php
@@ -3,7 +3,7 @@
 declare(strict_types=1);
 
 use PhpTypedValues\Code\Exception\IntegerTypeException;
-use PhpTypedValues\Integer\NonNegativeInt;
+use PhpTypedValues\Integer\Alias\NonNegativeInt;
 
 it('creates NonNegativeInt', function (): void {
     expect((new NonNegativeInt(0))->value())->toBe(0);
diff --git a/tests/Unit/Integer/Alias/PositiveIntTypeTest.php b/tests/Unit/Integer/Alias/PositiveIntTypeTest.php
@@ -3,7 +3,7 @@
 declare(strict_types=1);
 
 use PhpTypedValues\Code\Exception\IntegerTypeException;
-use PhpTypedValues\Integer\PositiveInt;
+use PhpTypedValues\Integer\Alias\PositiveInt;
 
 it('creates PositiveInt', function (): void {
     expect(PositiveInt::fromInt(1)->value())->toBe(1);
diff --git a/tests/Unit/Integer/Alias/WeekDayIntTypeTest.php b/tests/Unit/Integer/Alias/WeekDayIntTypeTest.php
@@ -0,0 +1,42 @@
+<?php
+
+declare(strict_types=1);
+
+use PhpTypedValues\Code\Exception\IntegerTypeException;
+use PhpTypedValues\Integer\Alias\PositiveInt;
+
+it('creates PositiveInt', function (): void {
+    expect(PositiveInt::fromInt(1)->value())->toBe(1);
+});
+
+it('fails on 0', function (): void {
+    expect(fn() => PositiveInt::fromInt(0))->toThrow(IntegerTypeException::class);
+});
+
+it('fails on negatives', function (): void {
+    expect(fn() => PositiveInt::fromInt(-1))->toThrow(IntegerTypeException::class);
+});
+
+it('creates PositiveInt from string', function (): void {
+    expect(PositiveInt::fromString('1')->value())->toBe(1);
+});
+
+it('fails PositiveInt from integerish string', function (): void {
+    expect(fn() => PositiveInt::fromString('5.0'))->toThrow(IntegerTypeException::class);
+});
+
+it('fails creating PositiveInt from string 0', function (): void {
+    expect(fn() => PositiveInt::fromString('0'))->toThrow(IntegerTypeException::class);
+});
+
+it('fails creating PositiveInt from negative string', function (): void {
+    expect(fn() => PositiveInt::fromString('-3'))->toThrow(IntegerTypeException::class);
+});
+
+it('toString returns scalar string for PositiveInt', function (): void {
+    expect((new PositiveInt(3))->toString())->toBe('3');
+});
+
+it('fails creating PositiveInt from float string', function (): void {
+    expect(fn() => PositiveInt::fromString('5.5'))->toThrow(IntegerTypeException::class);
+});
diff --git a/tests/Unit/Integer/IntegerNonNegativeTypeTest.php b/tests/Unit/Integer/IntegerNonNegativeTypeTest.php
diff --git a/tests/Unit/Integer/IntegerPositiveTypeTest.php b/tests/Unit/Integer/IntegerPositiveTypeTest.php
diff --git a/tests/Unit/Integer/IntegerStandartTypeTest.php b/tests/Unit/Integer/IntegerStandartTypeTest.php
diff --git a/tests/Unit/Integer/IntegerWeekDayTypeTest.php b/tests/Unit/Integer/IntegerWeekDayTypeTest.php
diff --git a/tests/Unit/Integer/WeekDayIntTypeTest.php b/tests/Unit/Integer/WeekDayIntTypeTest.php

Original file line number	Diff line number	Diff line change
`@@ -4,6 +4,6 @@`
`4`	`4`
`5`	`5`	`namespace PhpTypedValues\Code\Exception;`
`6`	`6`
`7`		`-class ReasonableRangeDateTimeTypeException extends TypeException`
	`7`	`+class ReasonableRangeDateTimeTypeException extends DateTimeTypeException`
`8`	`8`	`{`
`9`	`9`	`}`
Original file line number	Diff line number	Diff line change
`@@ -12,7 +12,7 @@`
`12`	`12`	`/**`
`13`	`13`	`* @psalm-immutable`
`14`	`14`	`*/`
`15`		`-readonly class NonNegativeInt extends IntType`
	`15`	`+readonly class IntegerNonNegative extends IntType`
`16`	`16`	`{`
`17`	`17`	`/** @var non-negative-int */`
`18`	`18`	`protected int $value;`
Original file line number	Diff line number	Diff line change
`@@ -10,7 +10,7 @@`
`10`	`10`	`/**`
`11`	`11`	`* @psalm-immutable`
`12`	`12`	`*/`
`13`		`-readonly class IntegerBasic extends IntType`
	`13`	`+readonly class IntegerStandart extends IntType`
`14`	`14`	`{`
`15`	`15`	`protected int $value;`
`16`	`16`