Sorting: Fixes during testing of sort rules

- Fixed name numeric sorting not working as expected due to bad
  comparison.
- Added name numeric desc operation option.
- Added test to ensure each operating has a comparison function.

diff --git a/app/Sorting/SortRuleOperation.php b/app/Sorting/SortRuleOperation.php
index 0d8ff239f8da37240321a29c7b49031460b71c9d..27bb9e3c0e23f75cf642841db8ae75f04e00bf97 100644 (file)
--- a/app/Sorting/SortRuleOperation.php
+++ b/app/Sorting/SortRuleOperation.php
@@ -10,6 +10,7 @@ enum SortRuleOperation: string
     case NameAsc = 'name_asc';
     case NameDesc = 'name_desc';
     case NameNumericAsc = 'name_numeric_asc';
+    case NameNumericDesc = 'name_numeric_desc';
     case CreatedDateAsc = 'created_date_asc';
     case CreatedDateDesc = 'created_date_desc';
     case UpdateDateAsc = 'updated_date_asc';

diff --git a/app/Sorting/SortSetOperationComparisons.php b/app/Sorting/SortSetOperationComparisons.php
index e1c3e625f9fb84956df078145416897a22d4c8ea..0d8e582648e3f8113f682233f424631e128d8ede 100644 (file)
--- a/app/Sorting/SortSetOperationComparisons.php
+++ b/app/Sorting/SortSetOperationComparisons.php
@@ -8,7 +8,6 @@ use BookStack\Entities\Models\Entity;
 /**
  * Sort comparison function for each of the possible SortSetOperation values.
  * Method names should be camelCase names for the SortSetOperation enum value.
- * TODO - Test to cover each SortSetOperation enum value is covered.
  */
 class SortSetOperationComparisons
 {
@@ -27,9 +26,12 @@ class SortSetOperationComparisons
         $numRegex = '/^\d+(\.\d+)?/';
         $aMatches = [];
         $bMatches = [];
-        preg_match($numRegex, $a, $aMatches);
-        preg_match($numRegex, $b, $bMatches);
-        return ($aMatches[0] ?? 0) <=> ($bMatches[0] ?? 0);
+        preg_match($numRegex, $a->name, $aMatches);
+        preg_match($numRegex, $b->name, $bMatches);
+        $aVal = floatval(($aMatches[0] ?? 0));
+        $bVal = floatval(($bMatches[0] ?? 0));
+
+        return $aVal <=> $bVal;
     }
 
     public static function nameNumericDesc(Entity $a, Entity $b): int

diff --git a/tests/Sorting/SortRuleTest.php b/tests/Sorting/SortRuleTest.php
index 10c7bc17d3e33c70c16fd39c484bb25e53ad974a..85b3d7991c44af7e89cd89aa21ffab0c53f4b950 100644 (file)
--- a/tests/Sorting/SortRuleTest.php
+++ b/tests/Sorting/SortRuleTest.php
@@ -5,6 +5,7 @@ namespace Tests\Sorting;
 use BookStack\Activity\ActivityType;
 use BookStack\Entities\Models\Book;
 use BookStack\Sorting\SortRule;
+use BookStack\Sorting\SortRuleOperation;
 use Tests\Api\TestsApi;
 use Tests\TestCase;
 
@@ -202,7 +203,8 @@ class SortRuleTest extends TestCase
             "20 - Milk",
         ];
 
-        foreach ($namesToAdd as $name) {
+        $reverseNamesToAdd = array_reverse($namesToAdd);
+        foreach ($reverseNamesToAdd as $name) {
             $this->actingAsApiEditor()->post("/api/pages", [
                 'book_id' => $book->id,
                 'name' => $name,
@@ -218,4 +220,14 @@ class SortRuleTest extends TestCase
             ]);
         }
     }
+
+    public function test_each_sort_rule_operation_has_a_comparison_function()
+    {
+        $operations = SortRuleOperation::cases();
+
+        foreach ($operations as $operation) {
+            $comparisonFunc = $operation->getSortFunction();
+            $this->assertIsCallable($comparisonFunc);
+        }
+    }
 }