ISSUE-113: Increments a year in a Season's end date, if start month > end month (#114)

* Increments a year in a Season's end date if start month > end month

Also adds to public methods to fetch those years but keeps the original private $year as-is (used on the constructor) to avoid breaking the contract. Also adds some basic tests (and fixes testWinterValues() expected end dates)

* Spacing

* Spacing v/s tabs

* More Coding style

* reuse local var

* Parser return is explicit ETDF Value, breaking static analysis. Maybe this fixes PHP Stan?

Author: DiegoPino

src/Model/Season.php

@@ -11,7 +11,13 @@
 class Season implements EdtfValue, HasPrecision {
 	use CoversTrait;
 
+	/**
+	 * The initial year.
+	 * A Season could span into a next one.
+	 * @var int
+	 */
 	private int $year;
+
 	private int $season;
 
 	private ExtDate $start;
@@ -20,9 +26,11 @@ class Season implements EdtfValue, HasPrecision {
 	public function __construct( int $year, int $season ) {
 		$this->year = $year;
 		$this->season = $season;
-
-		$this->start = new ExtDate( $year, $this->generateStartMonth() );
-		$this->end = new ExtDate( $year, $this->generateEndMonth() );
+		$startMonth = $this->generateStartMonth();
+		$this->start = new ExtDate( $year, $startMonth );
+		$endMonth = $this->generateEndMonth();
+		$year = $endMonth < $startMonth ? ($year + 1) : $year;
+		$this->end = new ExtDate( $year, $endMonth );
 	}
 
 	private function generateStartMonth(): int {
@@ -99,6 +107,12 @@ public function getMin(): int {
 		return $this->start->getMin();
 	}
 
+	/**
+	 * Returns the Original Year present in the Season EDTF string definition.
+	 * Some seasons can expand to the next year.
+	 *
+	 * @return int
+	 */
 	public function getYear(): int {
 		return $this->year;
 	}
@@ -169,6 +183,14 @@ public function getEndMonth(): int {
 		return $this->end->getMonth();
 	}
 
+	public function getStartYear(): int {
+		return $this->start->getYear();
+	}
+
+	public function getEndYear(): int {
+		return $this->end->getYear();
+	}
+
 	public function precision(): int {
 		return self::PRECISION_SEASON;
 	}

tests/Unit/Model/SeasonTest.php

@@ -16,12 +16,25 @@
 class SeasonTest extends TestCase {
 
 	public function testCreate(): void {
+		// Quarter 1
 		$season = new Season( 2010, 33 );
 		$this->assertSame( 2010, $season->getYear() );
 		$this->assertSame( 33, $season->getSeason() );
 		$this->assertSame( [ 1, 2, 3 ], $season->getMonths() );
 		$this->assertSame( 1, $season->getStartMonth() );
 		$this->assertSame( 3, $season->getEndMonth() );
+		$this->assertSame( 2010, $season->getStartYear() );
+		$this->assertSame( 2010, $season->getEndYear() );
+
+		// Winter spanning into next year.
+		$season = new Season( 1937, 24 );
+		$this->assertSame( 1937, $season->getYear() );
+		$this->assertSame( 24, $season->getSeason() );
+		$this->assertSame( [ 12, 1, 2 ], $season->getMonths() );
+		$this->assertSame( 12, $season->getStartMonth() );
+		$this->assertSame( 2, $season->getEndMonth() );
+		$this->assertSame( 1937, $season->getStartYear() );
+		$this->assertSame( 1938, $season->getEndYear() );
 	}
 
 	public function testSpringValues(): void {
@@ -43,9 +56,9 @@ public function testAutumnValues(): void {
 	}
 
 	public function testWinterValues(): void {
-		$this->assertSeasonValues( '2010-24', '2010-12-01', '2010-02-28' );
-		$this->assertSeasonValues( '2010-28', '2010-12-01', '2010-02-28' );
-		$this->assertSeasonValues( '2010-32', '2010-12-01', '2010-02-28' );
+		$this->assertSeasonValues( '2010-24', '2010-12-01', '2011-02-28' );
+		$this->assertSeasonValues( '2010-28', '2010-12-01', '2011-02-28' );
+		$this->assertSeasonValues( '2010-32', '2010-12-01', '2011-02-28' );
 	}
 
 	public function testQuarterValues(): void {
@@ -74,14 +87,22 @@ private function assertSeasonValues( string $input, string $expectedStart, strin
 		$seasonStart = Carbon::createFromTimestamp( $season->getMin() );
 		$seasonEnd = Carbon::createFromTimestamp( $season->getMax() );
 
-		// start season validation
+		// Fetch max/min years from public methods.
+		if ($season instanceof Season) {
+			$seasonStartYearFromMethod = $season->getStartYear();
+			$seasonEndYearFromMethod = $season->getEndYear();
+			// start season validation
+			$this->assertSame( $expectedStart->year, $seasonStartYearFromMethod);
+			$this->assertSame( $expectedEnd->year, $seasonEndYearFromMethod);
+		}
+
 		$this->assertSame( $expectedStart->year, $seasonStart->year );
 		$this->assertSame( $expectedStart->month, $seasonStart->month );
 		$this->assertSame( $expectedStart->day, $seasonStart->day );
 
-		// end season validation
 		$this->assertSame( $expectedEnd->year, $seasonEnd->year );
 		$this->assertSame( $expectedEnd->month, $seasonEnd->month );
 		$this->assertSame( $expectedEnd->day, $seasonEnd->day );
+		// end season validation.
 	}
 }