Merge pull request #161 from opcodesio/carbon-interface

use CarbonInterface typehints for compatibility with immutable Carbon instances

Author: arukompas

config/log-viewer.php

@@ -122,8 +122,8 @@
              * $matches[7] - the log text, the rest of the text.
              */
             'log_parsing_regex' => '/^\[(\d{4}-\d{2}-\d{2}[T ]\d{2}:\d{2}:\d{2}\.?(\d{6}([\+-]\d\d:\d\d)?)?)\](.*?(\w+)\.|.*?)('
-                . implode('|', array_filter(Level::caseValues()))
-                . ')?: (.*?)( in [\/].*?:[0-9]+)?$/is',
+                .implode('|', array_filter(Level::caseValues()))
+                .')?: (.*?)( in [\/].*?:[0-9]+)?$/is',
         ],
     ],
 

src/Concerns/CanFilterIndex.php

@@ -2,7 +2,7 @@
 
 namespace Opcodes\LogViewer\Concerns;
 
-use Carbon\Carbon;
+use Carbon\CarbonInterface;
 use Opcodes\LogViewer\Level;
 
 trait CanFilterIndex
@@ -33,13 +33,13 @@ public function getQuery(): ?string
         return $this->query;
     }
 
-    public function forDateRange(int|Carbon $from = null, int|Carbon $to = null): self
+    public function forDateRange(int|CarbonInterface $from = null, int|CarbonInterface $to = null): self
     {
-        if ($from instanceof Carbon) {
+        if ($from instanceof CarbonInterface) {
             $from = $from->timestamp;
         }
 
-        if ($to instanceof Carbon) {
+        if ($to instanceof CarbonInterface) {
             $to = $to->timestamp;
         }
 

src/Log.php

@@ -2,6 +2,7 @@
 
 namespace Opcodes\LogViewer;
 
+use Carbon\CarbonInterface;
 use Illuminate\Support\Carbon;
 use Illuminate\Support\Str;
 use Opcodes\LogViewer\Facades\LogViewer;
@@ -11,7 +12,7 @@ class Log
 {
     public int $index;
 
-    public Carbon $time;
+    public CarbonInterface $time;
 
     public Level $level;
 

src/LogFile.php

@@ -2,6 +2,7 @@
 
 namespace Opcodes\LogViewer;
 
+use Carbon\CarbonInterface;
 use Illuminate\Support\Arr;
 use Illuminate\Support\Facades\Cache;
 use Illuminate\Support\Str;
@@ -88,7 +89,7 @@ public function download(): BinaryFileResponse
         return response()->download($this->path);
     }
 
-    protected function cacheTtl()
+    protected function cacheTtl(): CarbonInterface
     {
         return now()->addWeek();
     }

src/LogIndex.php

@@ -2,7 +2,8 @@
 
 namespace Opcodes\LogViewer;
 
-use Carbon\Carbon;
+use Carbon\CarbonInterface;
+use Illuminate\Support\Carbon;
 use Illuminate\Support\Collection;
 use Illuminate\Support\Facades\Cache;
 
@@ -47,7 +48,7 @@ public function metaCacheKey(): string
         return $this->file->cacheKey().':'.$this->identifier().':metadata';
     }
 
-    public function cacheTtl(): Carbon
+    public function cacheTtl(): CarbonInterface
     {
         if (! empty($this->query)) {
             // There will be a lot more search queries, and they're usually just one-off searches.
@@ -69,11 +70,11 @@ public function clearCache(): void
         $this->loadMetadata();
     }
 
-    public function addToIndex(int $filePosition, int|Carbon $timestamp, string $severity, int $index = null): int
+    public function addToIndex(int $filePosition, int|CarbonInterface $timestamp, string $severity, int $index = null): int
     {
         $logIndex = $index ?? $this->nextLogIndexToCreate ?? 0;
 
-        if ($timestamp instanceof Carbon) {
+        if ($timestamp instanceof CarbonInterface) {
             $timestamp = $timestamp->timestamp;
         }
 
@@ -338,7 +339,7 @@ public function getEarliestTimestamp(): ?int
         return $earliestTimestamp;
     }
 
-    public function getEarliestDate(): Carbon
+    public function getEarliestDate(): CarbonInterface
     {
         return Carbon::createFromTimestamp($this->getEarliestTimestamp());
     }
@@ -369,7 +370,7 @@ public function getLatestTimestamp(): ?int
         return $latestTimestamp;
     }
 
-    public function getLatestDate(): Carbon
+    public function getLatestDate(): CarbonInterface
     {
         return Carbon::createFromTimestamp($this->getLatestTimestamp());
     }

src/LogViewerServiceProvider.php

@@ -72,7 +72,7 @@ public function boot()
 
     private function basePath(string $path): string
     {
-        return __DIR__ . '/..' . $path;
+        return __DIR__.'/..'.$path;
     }
 
     private function isEnabled(): bool

tests/Pest.php

@@ -1,6 +1,6 @@
 <?php
 
-use Carbon\Carbon;
+use Carbon\CarbonInterface;
 use Illuminate\Support\Facades\File;
 use Opcodes\LogViewer\LogFile;
 use Opcodes\LogViewer\LogIndex;
@@ -65,9 +65,9 @@ function clearGeneratedLogFiles(): void
     File::cleanDirectory(storage_path('logs'));
 }
 
-function makeLogEntry(Carbon $date = null, string $level = 'debug', string $message = 'Testing log entry'): string
+function makeLogEntry(CarbonInterface $date = null, string $level = 'debug', string $message = 'Testing log entry'): string
 {
-    $dateFormatted = $date instanceof Carbon ? $date->toDateTimeString() : now()->toDateTimeString();
+    $dateFormatted = $date instanceof CarbonInterface ? $date->toDateTimeString() : now()->toDateTimeString();
     $level = strtoupper($level);
 
     return "[$dateFormatted] local.$level: $message";