Replace magic strings with enums in sorting logic

.gitignore

@@ -6,6 +6,7 @@ build
 composer.lock
 coverage
 docs
+logs
 phpunit.xml
 phpstan.neon
 testbench.yaml

config/log-viewer.php

@@ -1,6 +1,6 @@
 <?php
 
-use Opcodes\LogViewer\Enums\FolderSortingMethod;
+use Opcodes\LogViewer\Enums\SortingMethod;
 use Opcodes\LogViewer\Enums\SortingOrder;
 use Opcodes\LogViewer\Enums\Theme;
 
@@ -283,13 +283,13 @@
         'use_local_storage' => true,
 
         // Method to sort the folders. Other options: `Alphabetical`, `ModifiedTime`
-        'folder_sorting_method' => FolderSortingMethod::ModifiedTime,
+        'folder_sorting_method' => SortingMethod::ModifiedTime,
 
         // Order to sort the folders. Other options: `Ascending`, `Descending`
         'folder_sorting_order' => SortingOrder::Descending,
 
         // Method for sorting log-files into directories. Other options: `Alphabetical`, `ModifiedTime`
-        'file_sorting_method' => FolderSortingMethod::ModifiedTime,
+        'file_sorting_method' => SortingMethod::ModifiedTime,
 
         // Order to sort the logs. Other options: `Ascending`, `Descending`
         'log_sorting_order' => SortingOrder::Descending,

src/Enums/FolderSortingMethod.php

@@ -2,6 +2,9 @@
 
 namespace Opcodes\LogViewer\Enums;
 
+/**
+ * @deprecated Use SortingMethod instead
+ */
 class FolderSortingMethod
 {
     public const Alphabetical = 'Alphabetical';

src/Enums/SortingMethod.php

@@ -0,0 +1,9 @@
+<?php
+
+namespace Opcodes\LogViewer\Enums;
+
+class SortingMethod
+{
+    public const Alphabetical = 'Alphabetical';
+    public const ModifiedTime = 'ModifiedTime';
+}

src/Http/Controllers/FilesController.php

@@ -5,7 +5,8 @@
 use Illuminate\Http\Request;
 use Illuminate\Support\Facades\Gate;
 use Illuminate\Support\Facades\URL;
-use Opcodes\LogViewer\Enums\FolderSortingMethod;
+use Opcodes\LogViewer\Enums\SortingMethod;
+use Opcodes\LogViewer\Enums\SortingOrder;
 use Opcodes\LogViewer\Facades\LogViewer;
 use Opcodes\LogViewer\Http\Resources\LogFileResource;
 
@@ -14,17 +15,18 @@ class FilesController
     public function index(Request $request)
     {
         $files = LogViewer::getFiles();
-        $sortingMethod = config('log-viewer.defaults.file_sorting_method', FolderSortingMethod::ModifiedTime);
+        $sortingMethod = config('log-viewer.defaults.file_sorting_method', SortingMethod::ModifiedTime);
+        $direction = $this->validateDirection($request->query('direction'));
 
-        if ($sortingMethod === FolderSortingMethod::ModifiedTime) {
-            if ($request->query('direction', 'desc') === 'asc') {
+        if ($sortingMethod === SortingMethod::ModifiedTime) {
+            if ($direction === SortingOrder::Ascending) {
                 $files = $files->sortByEarliestFirst();
             } else {
                 $files = $files->sortByLatestFirst();
             }
 
         } else {
-            if ($request->query('direction', 'desc') === 'asc') {
+            if ($direction === SortingOrder::Ascending) {
                 $files = $files->sortAlphabeticallyAsc();
             } else {
                 $files = $files->sortAlphabeticallyDesc();
@@ -34,6 +36,15 @@ public function index(Request $request)
         return LogFileResource::collection($files);
     }
 
+    private function validateDirection(?string $direction): string
+    {
+        if ($direction === SortingOrder::Ascending) {
+            return SortingOrder::Ascending;
+        }
+
+        return SortingOrder::Descending;
+    }
+
     public function requestDownload(Request $request, string $fileIdentifier)
     {
         $file = LogViewer::getFile($fileIdentifier);

src/Http/Controllers/FoldersController.php

@@ -5,7 +5,7 @@
 use Illuminate\Http\Request;
 use Illuminate\Support\Facades\Gate;
 use Illuminate\Support\Facades\URL;
-use Opcodes\LogViewer\Enums\FolderSortingMethod;
+use Opcodes\LogViewer\Enums\SortingMethod;
 use Opcodes\LogViewer\Enums\SortingOrder;
 use Opcodes\LogViewer\Facades\LogViewer;
 use Opcodes\LogViewer\Http\Resources\LogFolderResource;
@@ -17,20 +17,20 @@ public function index(Request $request)
     {
         $folders = LogViewer::getFilesGroupedByFolder();
 
-        $sortingMethod = config('log-viewer.defaults.folder_sorting_method', FolderSortingMethod::ModifiedTime);
+        $sortingMethod = config('log-viewer.defaults.folder_sorting_method', SortingMethod::ModifiedTime);
         $sortingOrder = config('log-viewer.defaults.folder_sorting_order', SortingOrder::Descending);
 
-        $fileSortingMethod = config('log-viewer.defaults.file_sorting_method', FolderSortingMethod::ModifiedTime);
-        $fileSortingOrder = $request->query('direction', 'desc');
+        $fileSortingMethod = config('log-viewer.defaults.file_sorting_method', SortingMethod::ModifiedTime);
+        $fileSortingOrder = $this->validateDirection($request->query('direction'));
 
-        if ($sortingMethod === FolderSortingMethod::Alphabetical) {
+        if ($sortingMethod === SortingMethod::Alphabetical) {
             if ($sortingOrder === SortingOrder::Ascending) {
                 $folders = $folders->sortAlphabeticallyAsc();
             } else {
                 $folders = $folders->sortAlphabeticallyDesc();
             }
         } else { // ModifiedTime
-            if ($fileSortingOrder === 'asc') {
+            if ($fileSortingOrder === SortingOrder::Ascending) {
                 $folders = $folders->sortByEarliestFirstIncludingFiles();
             } else {
                 $folders = $folders->sortByLatestFirstIncludingFiles();
@@ -39,15 +39,15 @@ public function index(Request $request)
 
         // Sort files within folders after sorting folders
         $folders->each(function ($folder) use ($fileSortingMethod, $fileSortingOrder) {
-            if ($fileSortingMethod === FolderSortingMethod::ModifiedTime) {
-                if ($fileSortingOrder === 'asc') {
+            if ($fileSortingMethod === SortingMethod::ModifiedTime) {
+                if ($fileSortingOrder === SortingOrder::Ascending) {
                     $folder->files()->sortByEarliestFirst();
                 } else {
                     $folder->files()->sortByLatestFirst();
                 }
 
             } else {
-                if ($fileSortingOrder === 'asc') {
+                if ($fileSortingOrder === SortingOrder::Ascending) {
                     $folder->files()->sortAlphabeticallyAsc();
                 } else {
                     $folder->files()->sortAlphabeticallyDesc();
@@ -58,6 +58,15 @@ public function index(Request $request)
         return LogFolderResource::collection($folders->values());
     }
 
+    private function validateDirection(?string $direction): string
+    {
+        if ($direction === SortingOrder::Ascending) {
+            return SortingOrder::Ascending;
+        }
+
+        return SortingOrder::Descending;
+    }
+
     public function requestDownload(Request $request, string $folderIdentifier)
     {
         $folder = LogViewer::getFolder($folderIdentifier);

src/Http/Controllers/IndexController.php

@@ -2,7 +2,7 @@
 
 namespace Opcodes\LogViewer\Http\Controllers;
 
-use Opcodes\LogViewer\Enums\FolderSortingMethod;
+use Opcodes\LogViewer\Enums\SortingMethod;
 use Opcodes\LogViewer\Facades\LogViewer;
 use Opcodes\LogViewer\LogFolder;
 use Opcodes\LogViewer\Utils\Utils;
@@ -15,7 +15,7 @@ public function __invoke()
             abort(404);
         }
 
-        $files_sort_by_time = config('log-viewer.defaults.file_sorting_method') === FolderSortingMethod::ModifiedTime;
+        $files_sort_by_time = config('log-viewer.defaults.file_sorting_method') === SortingMethod::ModifiedTime;
 
         return view(LogViewer::getViewLayout(), [
             'logViewerScriptVariables' => [

tests/Feature/InvalidSortingValuesTest.php

@@ -0,0 +1,178 @@
+<?php
+
+use Opcodes\LogViewer\Enums\SortingMethod;
+use Opcodes\LogViewer\Enums\SortingOrder;
+
+use function Pest\Laravel\getJson;
+
+beforeEach(function () {
+    config(['log-viewer.include_files' => ['*.log', '*/**.log']]);
+});
+
+// FilesController with invalid sorting values
+
+it('files controller returns default desc order when invalid direction is provided', function () {
+    config(['log-viewer.defaults.file_sorting_method' => SortingMethod::ModifiedTime]);
+    $names = ['one.log', 'two.log', 'three.log'];
+    generateLogFiles($names, randomContent: true);
+
+    array_map(function (string $name) {
+        $this->travelTo(now()->addSecond());
+        touch(storage_path('logs/'.$name), now()->timestamp);
+    }, $names);
+
+    $response = getJson(route('log-viewer.files', ['direction' => 'invalid']));
+
+    expect(array_column($response->json(), 'name'))->toBe([
+        'three.log',
+        'two.log',
+        'one.log',
+    ]);
+});
+
+it('files controller returns default desc order when empty direction is provided', function () {
+    config(['log-viewer.defaults.file_sorting_method' => SortingMethod::ModifiedTime]);
+    $names = ['one.log', 'two.log', 'three.log'];
+    generateLogFiles($names, randomContent: true);
+
+    array_map(function (string $name) {
+        $this->travelTo(now()->addSecond());
+        touch(storage_path('logs/'.$name), now()->timestamp);
+    }, $names);
+
+    $response = getJson(route('log-viewer.files', ['direction' => '']));
+
+    expect(array_column($response->json(), 'name'))->toBe([
+        'three.log',
+        'two.log',
+        'one.log',
+    ]);
+});
+
+it('files controller returns default desc order when direction is null', function () {
+    config(['log-viewer.defaults.file_sorting_method' => SortingMethod::ModifiedTime]);
+    $names = ['one.log', 'two.log', 'three.log'];
+    generateLogFiles($names, randomContent: true);
+
+    array_map(function (string $name) {
+        $this->travelTo(now()->addSecond());
+        touch(storage_path('logs/'.$name), now()->timestamp);
+    }, $names);
+
+    $response = getJson(route('log-viewer.files'));
+
+    expect(array_column($response->json(), 'name'))->toBe([
+        'three.log',
+        'two.log',
+        'one.log',
+    ]);
+});
+
+it('files controller returns alphabetical sorting with default desc when invalid direction is provided', function () {
+    config(['log-viewer.defaults.file_sorting_method' => SortingMethod::Alphabetical]);
+    generateLogFiles(['one.log', 'two.log', 'three.log', 'four.log'], randomContent: true);
+
+    $response = getJson(route('log-viewer.files', ['direction' => 'invalid']));
+
+    expect(array_column($response->json(), 'name'))->toBe([
+        'two.log',
+        'three.log',
+        'one.log',
+        'four.log',
+    ]);
+});
+
+it('files controller returns correct order with valid asc direction and alphabetical sorting', function () {
+    config(['log-viewer.defaults.file_sorting_method' => SortingMethod::Alphabetical]);
+    generateLogFiles(['one.log', 'two.log', 'three.log', 'four.log'], randomContent: true);
+
+    $response = getJson(route('log-viewer.files', ['direction' => SortingOrder::Ascending]));
+
+    expect(array_column($response->json(), 'name'))->toBe([
+        'four.log',
+        'one.log',
+        'three.log',
+        'two.log',
+    ]);
+});
+
+// FoldersController with invalid sorting values
+
+it('folders controller returns default desc order when invalid direction is provided', function () {
+    config(['log-viewer.include_files' => ['*/**.log']]);
+    config(['log-viewer.defaults.folder_sorting_method' => SortingMethod::Alphabetical]);
+    config(['log-viewer.defaults.file_sorting_method' => SortingMethod::ModifiedTime]);
+    $names = ['sub/one.log', 'sub/two.log', 'sub/three.log'];
+    generateLogFiles($names, randomContent: true);
+
+    array_map(function (string $name) {
+        $this->travelTo(now()->addSecond());
+        touch(storage_path('logs/'.$name), now()->timestamp);
+    }, $names);
+
+    $response = getJson(route('log-viewer.folders', ['direction' => 'invalid']));
+
+    expect(array_column($response->json()[0]['files'], 'name'))->toBe([
+        'three.log',
+        'two.log',
+        'one.log',
+    ]);
+});
+
+it('folders controller returns default desc order when empty direction is provided', function () {
+    config(['log-viewer.include_files' => ['*/**.log']]);
+    config(['log-viewer.defaults.folder_sorting_method' => SortingMethod::Alphabetical]);
+    config(['log-viewer.defaults.file_sorting_method' => SortingMethod::ModifiedTime]);
+    $names = ['sub/one.log', 'sub/two.log', 'sub/three.log'];
+    generateLogFiles($names, randomContent: true);
+
+    array_map(function (string $name) {
+        $this->travelTo(now()->addSecond());
+        touch(storage_path('logs/'.$name), now()->timestamp);
+    }, $names);
+
+    $response = getJson(route('log-viewer.folders', ['direction' => '']));
+
+    expect(array_column($response->json()[0]['files'], 'name'))->toBe([
+        'three.log',
+        'two.log',
+        'one.log',
+    ]);
+});
+
+it('folders controller returns default desc order when direction is null', function () {
+    config(['log-viewer.include_files' => ['*/**.log']]);
+    config(['log-viewer.defaults.folder_sorting_method' => SortingMethod::Alphabetical]);
+    config(['log-viewer.defaults.file_sorting_method' => SortingMethod::ModifiedTime]);
+    $names = ['sub/one.log', 'sub/two.log', 'sub/three.log'];
+    generateLogFiles($names, randomContent: true);
+
+    array_map(function (string $name) {
+        $this->travelTo(now()->addSecond());
+        touch(storage_path('logs/'.$name), now()->timestamp);
+    }, $names);
+
+    $response = getJson(route('log-viewer.folders'));
+
+    expect(array_column($response->json()[0]['files'], 'name'))->toBe([
+        'three.log',
+        'two.log',
+        'one.log',
+    ]);
+});
+
+it('folders controller returns correct order with valid asc direction and alphabetical sorting', function () {
+    config(['log-viewer.include_files' => ['*/**.log']]);
+    config(['log-viewer.defaults.folder_sorting_method' => SortingMethod::Alphabetical]);
+    config(['log-viewer.defaults.file_sorting_method' => SortingMethod::Alphabetical]);
+    generateLogFiles(['sub/one.log', 'sub/two.log', 'sub/three.log', 'sub/four.log'], randomContent: true);
+
+    $response = getJson(route('log-viewer.folders', ['direction' => SortingOrder::Ascending]));
+
+    expect(array_column($response->json()[0]['files'], 'name'))->toBe([
+        'four.log',
+        'one.log',
+        'three.log',
+        'two.log',
+    ]);
+});