LocalDateRange の属性 from, to の型を継承時に指定できるようにする

Fixes #32

Author: endou-mame

src/DateTime/LocalDate.php

@@ -16,6 +16,10 @@
 use WizDevelop\PhpValueObject\ValueObjectMeta;
 
 /**
+ * @phpstan-type Year int<LocalDate::MIN_YEAR, LocalDate::MAX_YEAR>
+ * @phpstan-type Month int<1, 12>
+ * @phpstan-type Day int<1, 31>
+ *
  * ローカル日付を表す値オブジェクト
  */
 #[ValueObjectMeta(name: 'ローカル日付')]
@@ -43,9 +47,9 @@
 
     /**
      * Avoid new() operator.
-     * @param int        $year  the year to represent, validated from MIN_YEAR to MAX_YEAR
-     * @param int<1, 12> $month the month, from 1 to 12
-     * @param int<1, 31> $day   the day, from 1 to 31
+     * @param int   $year  the year to represent, validated from MIN_YEAR to MAX_YEAR
+     * @param Month $month the month, from 1 to 12
+     * @param Day   $day   the day, from 1 to 31
      */
     final private function __construct(
         private int $year,
@@ -85,9 +89,9 @@ final public function jsonSerialize(): string
     // MARK: factory methods
     // -------------------------------------------------------------------------
     /**
-     * @param int        $year  the year to represent, validated from MIN_YEAR to MAX_YEAR
-     * @param int<1, 12> $month the month, from 1 to 12
-     * @param int<1, 31> $day   the day, from 1 to 31
+     * @param int   $year  the year to represent, validated from MIN_YEAR to MAX_YEAR
+     * @param Month $month the month, from 1 to 12
+     * @param Day   $day   the day, from 1 to 31
      */
     final public static function of(int $year, int $month, int $day): static
     {
@@ -191,10 +195,10 @@ final public static function ofEpochDay(int $epochDay): static
         // Convert march-based values back to January-based.
         $marchMonth0 = intdiv($marchDoy0 * 5 + 2, 153);
 
-        /** @var int<1, 12> $month */
+        /** @var Month $month */
         $month = ($marchMonth0 + 2) % 12 + 1;
 
-        /** @var int<1, 31> $dom */
+        /** @var Day $dom */
         $dom = $marchDoy0 - intdiv($marchMonth0 * 306 + 5, 10) + 1;
 
         $yearEst += intdiv($marchMonth0, 10);
@@ -271,8 +275,8 @@ className: static::class,
     /**
      * 有効な日かどうかを判定
      * @param  int                           $year        年
-     * @param  int<1, 12>                    $monthOfYear 月
-     * @param  int<1, 31>                    $dayOfMonth  日
+     * @param  Month                         $monthOfYear 月
+     * @param  Day                           $dayOfMonth  日
      * @return Result<bool,ValueObjectError>
      */
     final protected static function isValidDate(int $year, int $monthOfYear, int $dayOfMonth): Result
@@ -340,7 +344,7 @@ final public function toISOString(): string
     }
 
     /**
-     * @return int<self::MIN_YEAR, self::MAX_YEAR>
+     * @return Year
      */
     final public function getYear(): int
     {
@@ -349,15 +353,15 @@ final public function getYear(): int
     }
 
     /**
-     * @return int<1, 12>
+     * @return Month
      */
     final public function getMonth(): int
     {
         return $this->month;
     }
 
     /**
-     * @return int<1, 31>
+     * @return Day
      */
     final public function getDay(): int
     {
@@ -471,7 +475,7 @@ final public function addMonths(int $months): static
 
         $yearDiff = Math::floorDiv($month, 12);
 
-        /** @var int<1, 12> $month */
+        /** @var Month $month */
         $month = Math::floorMod($month, 12) + 1;
 
         $year = $this->year + $yearDiff;
@@ -599,17 +603,17 @@ final public function toEpochDay(): int
     // MARK: private methods
     // -------------------------------------------------------------------------
     /**
-     * @return array{0:int<self::MIN_YEAR, self::MAX_YEAR>, 1:int<1, 12>, 2:int<1, 31>}
+     * @return array{0:Year, 1:Month, 2:Day}
      */
     private static function extractDate(DateTimeInterface $value): array
     {
-        /** @var int<self::MIN_YEAR, self::MAX_YEAR> */
+        /** @var Year */
         $year = (int)$value->format('Y');
 
-        /** @var int<1, 12> */
+        /** @var Month */
         $month = (int)$value->format('n');
 
-        /** @var int<1, 31> */
+        /** @var Day */
         $day = (int)$value->format('j');
 
         return [$year, $month, $day];
@@ -618,9 +622,9 @@ private static function extractDate(DateTimeInterface $value): array
     /**
      * Resolves the date, resolving days past the end of month.
      *
-     * @param int        $year  the year to represent, validated from MIN_YEAR to MAX_YEAR
-     * @param int<1, 12> $month the month-of-year to represent
-     * @param int<1, 31> $day   the day-of-month to represent, validated from 1 to 31
+     * @param int   $year  the year to represent, validated from MIN_YEAR to MAX_YEAR
+     * @param Month $month the month-of-year to represent
+     * @param Day   $day   the day-of-month to represent, validated from 1 to 31
      */
     private static function resolvePreviousValid(int $year, int $month, int $day): static
     {
@@ -640,7 +644,7 @@ private static function isLeapYear(int $year): bool
     }
 
     /**
-     * @param  int<1, 12>  $month
+     * @param  Month       $month
      * @return int<28, 31>
      */
     private static function lengthOfMonth(int $year, int $month): int
@@ -654,8 +658,8 @@ private static function lengthOfMonth(int $year, int $month): int
 
     /**
      * Returns whether this date is the last day of the month.
-     * @param int<1, 12> $month
-     * @param int<1, 31> $day
+     * @param Month $month
+     * @param Day   $day
      */
     private static function isEndOfMonth(int $year, int $month, int $day): bool
     {

src/DateTime/LocalDateRange.php

@@ -242,26 +242,6 @@ final public function strictlyBefore(self $other): bool
         );
     }
 
-    /**
-     * 境界での重なりを考慮した判定
-     *
-     * @param self<TStart,TEnd> $other
-     */
-    private function hasOverlapAt(self $other): bool
-    {
-        // 開始点での重なり判定
-        $startOverlap = $this->contains($other->from) || $other->contains($this->from);
-
-        // 終了点での重なり判定
-        $endOverlap = $this->contains($other->to) || $other->contains($this->to);
-
-        // 一方が他方を完全に含む場合
-        $containment = ($this->from->isBeforeOrEqualTo($other->from) && $this->to->isAfterOrEqualTo($other->to))
-            || ($other->from->isBeforeOrEqualTo($this->from) && $other->to->isAfterOrEqualTo($this->to));
-
-        return $startOverlap || $endOverlap || $containment;
-    }
-
     /**
      * 範囲の日数を返す
      * 注意: 開区間の場合、実際の日数は計算結果より1日または2日少なくなる可能性があります

src/DateTime/LocalDateTime.php

@@ -16,6 +16,15 @@
 use WizDevelop\PhpValueObject\ValueObjectMeta;
 
 /**
+ * @phpstan-import-type Hour from LocalTime
+ * @phpstan-import-type Minute from LocalTime
+ * @phpstan-import-type Second from LocalTime
+ * @phpstan-import-type Micro from LocalTime
+ *
+ * @phpstan-import-type Year from LocalDate
+ * @phpstan-import-type Month from LocalDate
+ * @phpstan-import-type Day from LocalDate
+ *
  * ローカル日時を表す値オブジェクト
  */
 #[ValueObjectMeta(name: 'ローカル日時')]
@@ -161,55 +170,55 @@ final public function getTime(): LocalTime
     }
 
     /**
-     * @return int<-9999, 9999>
+     * @return Year
      */
     final public function getYear(): int
     {
         return $this->date->getYear();
     }
 
     /**
-     * @return int<1, 12>
+     * @return Month
      */
     final public function getMonth(): int
     {
         return $this->date->getMonth();
     }
 
     /**
-     * @return int<1, 31>
+     * @return Day
      */
     final public function getDay(): int
     {
         return $this->date->getDay();
     }
 
     /**
-     * @return int<0, 23>
+     * @return Hour
      */
     final public function getHour(): int
     {
         return $this->time->getHour();
     }
 
     /**
-     * @return int<0, 59>
+     * @return Minute
      */
     final public function getMinute(): int
     {
         return $this->time->getMinute();
     }
 
     /**
-     * @return int<0, 59>
+     * @return Second
      */
     final public function getSecond(): int
     {
         return $this->time->getSecond();
     }
 
     /**
-     * @return int<0, 999999>
+     * @return Micro
      */
     final public function getMicro(): int
     {
@@ -517,7 +526,7 @@ private function addWithOverflow(int $hours, int $minutes, int $seconds, int $mi
         $totMicros = $micros * $sign + $this->time->getMicro();
         $totSeconds += Math::floorDiv($totMicros, LocalTime::MICROS_PER_SECOND);
 
-        /** @var int<0, 999999> */
+        /** @var Micro */
         $newMicro = Math::floorMod($totMicros, LocalTime::MICROS_PER_SECOND);
 
         $totDays += Math::floorDiv($totSeconds, LocalTime::SECONDS_PER_DAY);