Merge pull request #7 from anuzpandey/dev

🔨 fix: memory exhaustion issue with recursive call.

README.md

@@ -65,6 +65,47 @@ The following format specifiers are supported for formatting dates:
 - `l` - Day in full name (Sunday-Saturday/आइतबार-शनिबार)
 - `S` - Day in two letters (st, nd, rd, th)
 
+## Extending Carbon with NepaliDateMixin
+In order to use the `toNepaliDate` and `toEnglishDate` mixin on Carbon instances, you need to register the `NepaliDateMixin` mixin in your Laravel service provider.
+
+You can do so by adding the following code to your `AppServiceProvider`
+```php
+<?php
+
+use Anuzpandey\LaravelNepaliDate\NepaliDateMixin;
+use Carbon\Carbon;
+use Illuminate\Support\ServiceProvider;
+
+class AppServiceProvider extends ServiceProvider
+{
+    public function boot(): void
+    {
+        // Register the NepaliDateMixin
+        Carbon::mixin(new NepaliDateMixin());
+    }
+}
+```
+
+Or create your own service provider with `php artisan make:provider MacroableServiceProvider`,
+register it in `config/app.php` and add the following code to the `boot` method.
+```php
+<?php
+
+use Anuzpandey\LaravelNepaliDate\NepaliDateMixin;
+use Carbon\Carbon;
+use Illuminate\Support\ServiceProvider;
+
+class MacroableServiceProvider extends ServiceProvider
+{
+    public function boot(): void
+    {
+        // Register the NepaliDateMixin
+        Carbon::mixin(new NepaliDateMixin());
+    }
+}
+```
+
+
 ## Testing
 
 ```bash

src/Mixin/NepaliDateMixin.php

@@ -0,0 +1,34 @@
+<?php
+
+namespace Anuzpandey\LaravelNepaliDate\Mixin;
+
+use Anuzpandey\LaravelNepaliDate\LaravelNepaliDate;
+use Carbon\Carbon;
+use Closure;
+
+/**
+ * @mixin Carbon
+ */
+class NepaliDateMixin
+{
+
+    public function toNepaliDate(): Closure
+    {
+        return function (?string $format = 'Y-m-d', ?string $locale = 'np') {
+            $date = $this->toDateString();
+
+            return LaravelNepaliDate::from($date)->toNepaliDate($format, $locale);
+        };
+    }
+
+
+    public function toEnglishDate(): Closure
+    {
+        return function (?string $format = 'Y-m-d', ?string $locale = 'en') {
+            $date = $this->toDateString();
+
+            return LaravelNepaliDate::from($date)->toEnglishDate($format, $locale);
+        };
+    }
+
+}

src/Traits/EnglishDateTrait.php

@@ -62,12 +62,8 @@ trait EnglishDateTrait
     ];
 
 
-    public function toEnglishDate(?string $format = NULL, ?string $locale = 'en'): string
+    public function toEnglishDate(string $format = 'Y-m-d', string $locale = 'en'): string
     {
-        if ($format) {
-            return $this->toFormattedEnglishDate($format, $locale);
-        }
-
         $checkIfIsInRange = $this->isInNepaliDateRange($this->date);
 
         if (!$checkIfIsInRange) {
@@ -78,14 +74,12 @@ public function toEnglishDate(?string $format = NULL, ?string $locale = 'en'): s
 
         $this->performCalculationBasedonNepaliDays($totalNepaliDays);
 
-        return $this->englishYear . '-' . $this->englishMonth . '-' . $this->englishDay;
+        return $this->toFormattedEnglishDate($format, $locale);
     }
 
 
     public function toEnglishDateArray(): NepaliDateArrayData
     {
-        $this->toEnglishDate();
-
         return NepaliDateArrayData::from([
             'year' => $this->englishYear,
             'month' => $this->englishMonth,

src/Traits/NepaliDateTrait.php

@@ -4,7 +4,6 @@
 
 use Anuzpandey\LaravelNepaliDate\DataTransferObject\NepaliDateArrayData;
 use Carbon\Carbon;
-use Illuminate\Support\Str;
 use RuntimeException;
 
 trait NepaliDateTrait
@@ -63,27 +62,11 @@ trait NepaliDateTrait
     ];
 
 
-    public function toNepaliDate(?string $format = NULL, ?string $locale = 'np'): string
+    public function toNepaliDate(string $format = 'Y-m-d', string $locale = 'en'): string
     {
-        if ($format) {
-            return $this->toFormattedNepaliDate($format, $locale);
-        }
-
-        $checkIfIsInRange = $this->isInEnglishDateRange($this->date);
-
-        if (!$checkIfIsInRange) {
-            throw new RuntimeException($checkIfIsInRange);
-        }
+        $this->performCalculationOnEnglishDate();
 
-        $totalEnglishDays = $this->calculateTotalEnglishDays($this->date->year, $this->date->month, $this->date->day);
-
-        $this->performCalculationBasedOn($totalEnglishDays);
-
-        $year = $this->nepaliYear;
-        $month = $this->nepaliMonth < 10 ? '0' . $this->nepaliMonth : $this->nepaliMonth;
-        $day = $this->nepaliDay < 10 ? '0' . $this->nepaliDay : $this->nepaliDay;
-
-        return $year . '-' . $month . '-' . $day;
+        return $this->toFormattedNepaliDate($format, $locale);
     }
 
 
@@ -100,8 +83,6 @@ public function toFormattedNepaliDate(
 
     public function toNepaliDateArray(): NepaliDateArrayData
     {
-        $this->toNepaliDate();
-
         $nepaliMonth = $this->nepaliMonth > 9 ? $this->nepaliMonth : '0' . $this->nepaliMonth;
         $nepaliDay = $this->nepaliDay > 9 ? $this->nepaliDay : '0' . $this->nepaliDay;
 
@@ -146,6 +127,20 @@ public function getShortDayName(string $npDayName, string $locale = 'np'): strin
     }
 
 
+    public function performCalculationOnEnglishDate(): void
+    {
+        $checkIfIsInRange = $this->isInEnglishDateRange($this->date);
+
+        if (!$checkIfIsInRange) {
+            throw new RuntimeException($checkIfIsInRange);
+        }
+
+        $totalEnglishDays = $this->calculateTotalEnglishDays($this->date->year, $this->date->month, $this->date->day);
+
+        $this->performCalculationBasedOn($totalEnglishDays);
+    }
+
+
     private function calculateTotalEnglishDays($year, $month, $day)
     {
         $totalEnglishDays = 0;

tests/ArchTest.php

@@ -3,3 +3,11 @@
 it('will not use debugging functions')
     ->expect(['dd', 'dump', 'ray'])
     ->each->not->toBeUsed();
+
+it('ensures traits are suffixed with Trait')
+    ->expect('Anuzpandey\LaravelNepaliDate\Traits')
+    ->toHaveSuffix('Trait');
+
+it('ensures mixins are suffixed with Mixin')
+    ->expect('Anuzpandey\LaravelNepaliDate\Mixin')
+    ->toHaveSuffix('Mixin');

tests/ConvertToEnglishDateTest.php

@@ -13,26 +13,11 @@
     ['2022-12-20', '1966-04-02'],
 ]);
 
-it('can convert to english date array', function () {
-    $date = '2053-01-10';
-
-    $englishDateArray = LaravelNepaliDate::from($date)->toEnglishDateArray();
-
-    expect($englishDateArray->toArray())
-        ->toBeArray()
-        ->toMatchArray([
-            'year' => '1996',
-            'month' => '04',
-            'day' => '22',
-            'npYear' => '१९९६',
-            'npDayName' => 'सोमबार',
-        ]);
-});
 
 it('can convert to nepali formatted result', function (string $format, string $locale, string $expectedResult) {
     $date = '2053-01-10';
 
-    expect(LaravelNepaliDate::from($date)->toFormattedEnglishDate(format: $format, locale: $locale))
+    expect(LaravelNepaliDate::from($date)->toEnglishDate(format: $format, locale: $locale))
         ->toBe($expectedResult);
 })->with([
     ['d F Y, l', 'np', '२२ अप्रिल १९९६, सोमबार'],

tests/ConvertToNepaliDateTest.php

@@ -13,26 +13,10 @@
     ['1966-04-02', '2022-12-20'],
 ]);
 
-it('can convert to nepali date array', function () {
-    $date = '1996-04-22';
-
-    $nepaliDateArray = LaravelNepaliDate::from($date)->toNepaliDateArray();
-
-    expect($nepaliDateArray->toArray())
-        ->toBeArray()
-        ->toMatchArray([
-            'year' => '2053',
-            'month' => '01',
-            'day' => '10',
-            'npYear' => '२०५३',
-            'npDayName' => 'सोमबार',
-        ]);
-});
-
 it('can convert to nepali formatted result', function (string $format, string $locale, string $expectedResult) {
     $date = '1996-04-22';
 
-    expect(LaravelNepaliDate::from($date)->toFormattedNepaliDate(format: $format, locale: $locale))
+    expect(LaravelNepaliDate::from($date)->toNepaliDate(format: $format, locale: $locale))
         ->toBe($expectedResult);
 })->with([
     ['d F Y, l', 'np', '१० वैशाख २०५३, सोमबार'],