added immutables

README.md

@@ -25,6 +25,9 @@ composer require laracraft-tech/carbon-extensions
 The `CarbonFiscalYear` class helps you to work with **fiscal years**!
 It easily lets you know the fiscal years **start** and **end** of a given date.
 
+**Note:** There is also a `CarbonFiscalYearImmutable`, class which has the same API,
+but it works _immutable_. For more information on _immutables_, check out the [carbon docs](https://carbon.nesbot.com/docs/).
+
 ```php
 // set your fiscal year start month and day 
 CarbonFiscalYear::setFiscalYearStart(4, 1);
@@ -33,9 +36,9 @@ $date = CarbonFiscalYear::parse("2022-03-30");
 $date->startOfYear()->format("Y-m-d"); // 2021-04-01
 $date->endOfYear()->format("Y-m-d"); // 2022-03-31
 
-$date = CarbonFiscalYear::parse("2022-04-02");
-$date->startOfYear()->format("Y-m-d"); // 2022-04-01
-$date->endOfYear()->format("Y-m-d"); // 2023-03-31
+$date2 = CarbonFiscalYear::parse("2022-04-02");
+$date2->startOfYear()->format("Y-m-d"); // 2022-04-01
+$date2->endOfYear()->format("Y-m-d"); // 2023-03-31
 ```
 
 ## Testing

src/CarbonFiscalYear.php

@@ -3,21 +3,10 @@
 namespace LaracraftTech\CarbonExtensions;
 
 use Carbon\Carbon;
-use LaracraftTech\CarbonExtensions\Exceptions\InvalidFiscalYearException;
 
 class CarbonFiscalYear extends Carbon
 {
-    /**
-     * The month of the year when the fiscal year starts.
-     * @var int
-     */
-    protected static int $fiscalYearStartMonth;
-
-    /**
-     * The day in the month of the year when the fiscal year starts.
-     * @var int
-     */
-    protected static int $fiscalYearStartDay;
+    use CarbonFiscalYearTrait;
 
     /**
      * @param $time
@@ -29,42 +18,4 @@ public function __construct($time = null, $tz = null)
 
         $this->ensureFiscalYearStartIsSet();
     }
-
-    /**
-     * Set the start of the fiscal year before you start using the class.
-     *
-     * @param int $month
-     * @param int $day
-     * @return void
-     */
-    public static function setFiscalYearStart(int $month, int $day): void
-    {
-        self::$fiscalYearStartMonth = $month;
-        self::$fiscalYearStartDay = $day;
-    }
-
-    private function ensureFiscalYearStartIsSet()
-    {
-        if (empty(self::$fiscalYearStartMonth) || empty(self::$fiscalYearStartDay)) {
-            throw new InvalidFiscalYearException();
-        }
-    }
-
-    public function startOfYear(): CarbonFiscalYear
-    {
-        $year = $this->year;
-
-        if ($this->month < self::$fiscalYearStartMonth ||
-            ($this->month == self::$fiscalYearStartMonth && $this->day < self::$fiscalYearStartDay)
-        ) {
-            $year -= 1;
-        }
-
-        return $this->setDate($year, self::$fiscalYearStartMonth, self::$fiscalYearStartDay)->startOfDay();
-    }
-
-    public function endOfYear(): CarbonFiscalYear
-    {
-        return $this->startOfYear()->copy()->addYear()->subDay()->endOfDay();
-    }
 }

src/CarbonFiscalYearException.php

@@ -0,0 +1,10 @@
+<?php
+
+namespace LaracraftTech\CarbonExtensions;
+
+use InvalidArgumentException;
+
+class CarbonFiscalYearException extends InvalidArgumentException
+{
+    //
+}

src/CarbonFiscalYearImmutable.php

@@ -0,0 +1,21 @@
+<?php
+
+namespace LaracraftTech\CarbonExtensions;
+
+use Carbon\CarbonImmutable;
+
+class CarbonFiscalYearImmutable extends CarbonImmutable
+{
+    use CarbonFiscalYearTrait;
+
+    /**
+     * @param $time
+     * @param $tz
+     */
+    public function __construct($time = null, $tz = null)
+    {
+        parent::__construct($time, $tz);
+
+        $this->ensureFiscalYearStartIsSet();
+    }
+}

src/CarbonFiscalYearTrait.php

@@ -0,0 +1,56 @@
+<?php
+
+namespace LaracraftTech\CarbonExtensions;
+
+trait CarbonFiscalYearTrait
+{
+    /**
+     * The month of the year when the fiscal year starts.
+     * @var int
+     */
+    protected static int $fiscalYearStartMonth;
+
+    /**
+     * The day in the month of the year when the fiscal year starts.
+     * @var int
+     */
+    protected static int $fiscalYearStartDay;
+
+    /**
+     * Set the start of the fiscal year before you start using the class.
+     *
+     * @param int $month
+     * @param int $day
+     * @return void
+     */
+    public static function setFiscalYearStart(int $month, int $day): void
+    {
+        self::$fiscalYearStartMonth = $month;
+        self::$fiscalYearStartDay = $day;
+    }
+
+    private function ensureFiscalYearStartIsSet()
+    {
+        if (empty(self::$fiscalYearStartMonth) || empty(self::$fiscalYearStartDay)) {
+            throw new CarbonFiscalYearException();
+        }
+    }
+
+    public function startOfYear(): CarbonFiscalYear
+    {
+        $year = $this->year;
+
+        if ($this->month < self::$fiscalYearStartMonth ||
+            ($this->month == self::$fiscalYearStartMonth && $this->day < self::$fiscalYearStartDay)
+        ) {
+            $year -= 1;
+        }
+
+        return $this->setDate($year, self::$fiscalYearStartMonth, self::$fiscalYearStartDay)->startOfDay();
+    }
+
+    public function endOfYear(): CarbonFiscalYear
+    {
+        return $this->startOfYear()->copy()->addYear()->subDay()->endOfDay();
+    }
+}

tests/CarbonFiscalYearTest.php

@@ -1,6 +1,7 @@
 <?php
 
 use LaracraftTech\CarbonExtensions\CarbonFiscalYear;
+use LaracraftTech\CarbonExtensions\CarbonFiscalYearImmutable;
 
 it('can detect fiscal year start and end', function () {
     //set fiscal year
@@ -21,3 +22,17 @@
     expect($date->startOfYear()->format("Y-m-d"))->toBe("2022-10-01")
         ->and($date->endOfYear()->format("Y-m-d"))->toBe("2023-09-30");
 });
+
+it('works with im/mutable', function () {
+    CarbonFiscalYear::setFiscalYearStart(4, 1);
+    $mutableDate = CarbonFiscalYear::parse("2022-03-30");
+    $mutableDate2 = $mutableDate->addYear();
+
+    expect($mutableDate)->toBe($mutableDate2);
+
+    CarbonFiscalYearImmutable::setFiscalYearStart(4, 1);
+    $immutableDate = CarbonFiscalYearImmutable::parse("2022-03-30");
+    $immutableDate2 = $immutableDate->addYear();
+
+    expect($immutableDate)->not->toBe($immutableDate2);
+});