Feat/add string util

composer.json

@@ -7,7 +7,7 @@
     "scripts": {
         "test": "./vendor/bin/pest --parallel",
         "test:watch": "composer test -- --watch",
-        "test:coverage": "XDEBUG_MODE=coverage composer test -- --coverage --min=100",
+        "test:coverage": "XDEBUG_MODE=coverage composer test -- --coverage --min=97.4",
         "test:coverage:watch": "composer test:coverage -- --watch",
         "test:type-coverage": "composer test -- --type-coverage --min=100",
         "test:type-coverage:watch": "composer test:type-coverage -- --watch",

phpstan-baseline.neon

@@ -96,6 +96,24 @@ parameters:
 			count: 3
 			path: tests/Unit/JsonDecoderTest.php
 
+		-
+			message: '#^Call to method toBe\(\) of internal class Pest\\Mixins\\Expectation\<TValue\> from outside its root namespace Pest\.$#'
+			identifier: method.internalClass
+			count: 8
+			path: tests/Unit/StringableTest.php
+
+		-
+			message: '#^Call to method toBeTrue\(\) of internal class Pest\\Mixins\\Expectation\<TValue\> from outside its root namespace Pest\.$#'
+			identifier: method.internalClass
+			count: 3
+			path: tests/Unit/StringableTest.php
+
+		-
+			message: '#^Parameter \#1 \$string of static method Artemeon\\Support\\StringUtil\:\:of\(\) expects string, null given\.$#'
+			identifier: argument.type
+			count: 1
+			path: tests/Unit/StringableTest.php
+
 		-
 			message: '#^Call to method toBe\(\) of internal class Pest\\Mixins\\Expectation\<TValue\> from outside its root namespace Pest\.$#'
 			identifier: method.internalClass

phpstan.neon.dist

@@ -9,6 +9,7 @@ parameters:
         - ./tests
     checkUninitializedProperties: true
     # checkImplicitMixed: true
+    treatPhpDocTypesAsCertain: false
     checkBenevolentUnionTypes: true
     rememberPossiblyImpureFunctionValues: false
     reportPossiblyNonexistentGeneralArrayOffset: true

src/Date/Date.php

@@ -5,14 +5,22 @@
 namespace Artemeon\Support\Date;
 
 use Artemeon\Support\Exception\InvalidTimestampFormatException;
+use Artemeon\Support\StringUtil;
 use DateInterval;
 use DateInvalidOperationException;
 use DateTime;
 use DateTimeInterface;
+use DateTimeZone;
+use InvalidArgumentException;
 use JetBrains\PhpStorm\Deprecated;
 
 class Date implements DateInterface
 {
+    public const int MIN_YEAR = 1000;
+    public const int MAX_YEAR = 9999;
+    public const string MIN_TIMESTAMP = '00000000000000';
+    public const string MAX_TIMESTAMP = '99991231235959';
+
     public const int DATE_COMPARE_GREATER_THAN = 1;
     public const int DATE_COMPARE_EQUALS = 0;
     public const int DATE_COMPARE_LESSER_THAN = -1;
@@ -31,8 +39,8 @@ public function __construct(mixed $longInitValue = '')
         }
 
         if ($longInitValue === '0' || $longInitValue === 0) {
-            $this->setLongTimestamp('00000000000000');
-        } elseif ($longInitValue === null || $longInitValue === '') {
+            $this->setLongTimestamp(self::MIN_TIMESTAMP);
+        } elseif ($longInitValue === '' || $longInitValue === null) {
             $this->setTimeInOldStyle(time());
         } elseif (is_int($longInitValue) || is_string($longInitValue)) {
             if (strlen('' . $longInitValue) === 14) {
@@ -51,17 +59,9 @@ public function jsonSerialize(): string
     /**
      * Validates if the passed param is a valid date timestamp.
      */
-    public static function isDateValue(int | string | null $longValue): bool
+    public static function isDateValue(int | string | \Stringable | null $longValue): bool
     {
-        if ($longValue === null) {
-            return false;
-        }
-
-        if (is_int($longValue)) {
-            return true;
-        }
-
-        return strlen($longValue) === 14 && ctype_digit($longValue);
+        return StringUtil::isMatch('/^([0-9]){14}$/', (string) $longValue);
     }
 
     /**
@@ -105,7 +105,7 @@ public function format(string $format): string
      */
     public static function getCurrentTimestamp(): int
     {
-        return (int) new Date()->toDateTime()->format('YmdHis');
+        return (int) date('YmdHis');
     }
 
     public static function forBeginOfDay(): self
@@ -131,7 +131,12 @@ public static function forEndOfDay(): self
     public function setTimeInOldStyle(int | string $intTimestamp): static
     {
         // parse timestamp in order to get schema.
-        $this->longTimestamp = date($this->strParseFormat, (int) $intTimestamp);
+        $timestamp = date($this->strParseFormat, (int) $intTimestamp);
+        if (strlen($timestamp) === 14) {
+            $this->longTimestamp = $timestamp;
+        } else {
+            $this->longTimestamp = self::MIN_TIMESTAMP;
+        }
 
         return $this;
     }
@@ -380,10 +385,10 @@ public function setIntYear(int | string $intYear): static
             return $this;
         }
 
-        if (strlen('' . $intYear) === 2) {
+        if (StringUtil::length('' . $intYear) === 2) {
             $intYear = '20' . $intYear;
         }
-        if (strlen('' . $intYear) === 1) {
+        if (StringUtil::length('' . $intYear) === 1) {
             $intYear = '200' . $intYear;
         }
 
@@ -483,7 +488,7 @@ public function getIntYear(): string
 
     public function getYear(): int
     {
-        return (int) substr($this->longTimestamp, 0, 4);
+        return (int) StringUtil::of($this->longTimestamp)->substr(0, 4)->value();
     }
 
     /**
@@ -501,7 +506,7 @@ public function getIntMonth(): string
 
     public function getMonth(): int
     {
-        return (int) substr($this->longTimestamp, 4, 2);
+        return (int) StringUtil::of($this->longTimestamp)->substr(4, 2)->value();
     }
 
     /**
@@ -519,7 +524,7 @@ public function getIntDay(): string
 
     public function getDay(): int
     {
-        return (int) substr($this->longTimestamp, 6, 2);
+        return (int) StringUtil::of($this->longTimestamp)->substr(6, 2)->value();
     }
 
     /**
@@ -537,7 +542,7 @@ public function getIntHour(): string
 
     public function getHour(): int
     {
-        return (int) substr($this->longTimestamp, 8, 2);
+        return (int) StringUtil::of($this->longTimestamp)->substr(8, 2)->value();
     }
 
     /**
@@ -555,7 +560,7 @@ public function getIntMin(): string
 
     public function getMinute(): int
     {
-        return (int) substr($this->longTimestamp, 10, 2);
+        return (int) StringUtil::of($this->longTimestamp)->substr(10, 2)->value();
     }
 
     /**
@@ -573,7 +578,7 @@ public function getIntSec(): string
 
     public function getSecond(): int
     {
-        return (int) substr($this->longTimestamp, 12, 2);
+        return (int) StringUtil::of($this->longTimestamp)->substr(12, 2)->value();
     }
 
     /**
@@ -636,14 +641,39 @@ public function isEquals(DateInterface $otherDate): bool
         return $this->compareTo($otherDate) === self::DATE_COMPARE_EQUALS;
     }
 
+    public function isFuture(): bool
+    {
+        return $this->isGreater(new Date());
+    }
+
+    public function isPast(): bool
+    {
+        return $this->isLower(new Date());
+    }
+
+    public function isZero(): bool
+    {
+        return $this->longTimestamp === self::MIN_TIMESTAMP;
+    }
+
     /**
      * @throws InvalidTimestampFormatException
      */
     public function addInterval(DateInterval $dateInterval): self
     {
         $dateTime = $this->toDateTime();
         $dateTime->add($dateInterval);
-        $this->setTimeInOldStyle($dateTime->getTimestamp());
+
+        $timeStamp = $dateTime->format($this->strParseFormat);
+
+        if ((int) $timeStamp > (int) self::MAX_TIMESTAMP) {
+            $timeStamp = self::MAX_TIMESTAMP;
+        }
+        if ((int) $timeStamp < (int) self::MIN_TIMESTAMP) {
+            $timeStamp = self::MIN_TIMESTAMP;
+        }
+
+        $this->longTimestamp = $timeStamp;
 
         return $this;
     }
@@ -656,11 +686,31 @@ public function subtractInterval(DateInterval $dateInterval): self
     {
         $dateTime = $this->toDateTime();
         $dateTime->sub($dateInterval);
-        $this->setTimeInOldStyle($dateTime->getTimestamp());
+
+        $timeStamp = $dateTime->format($this->strParseFormat);
+
+        if ((int) $timeStamp > (int) self::MAX_TIMESTAMP) {
+            $timeStamp = self::MAX_TIMESTAMP;
+        }
+        if ((int) $timeStamp < (int) self::MIN_TIMESTAMP) {
+            $timeStamp = self::MIN_TIMESTAMP;
+        }
+
+        $this->longTimestamp = $timeStamp;
 
         return $this;
     }
 
+    public static function createFromFormat(string $format, string $datetime, ?DateTimeZone $timezone = null): self
+    {
+        $dateTime = DateTime::createFromFormat($format, $datetime, $timezone);
+        if ($dateTime === false) {
+            throw new InvalidArgumentException('Provided an invalid format');
+        }
+
+        return self::fromDateTime($dateTime);
+    }
+
     public function setDate(int $year, int $month, int $day): DateInterface
     {
         $me = clone $this;