Merge branch '2.x-dev' into normalize-the-asset-api

.github/workflows/smoke-tests.yml

@@ -52,7 +52,7 @@ jobs:
             local testsuite=$2
             echo "${suite^} tests started"
             cd ${suite}_tests
-            if vendor/bin/pest --colors=always --log-junit="../test_results/${suite}_junit.xml" --testsuite="$testsuite" > "../test_outputs/${suite}.log" 2>&1; then
+            if vendor/bin/pest --colors=always --compact --log-junit="../test_results/${suite}_junit.xml" --testsuite="$testsuite" > "../test_outputs/${suite}.log" 2>&1; then
               echo "${suite^} tests completed successfully"
             else
               echo "${suite^} tests failed"

docs/digging-deeper/helpers.md

@@ -115,6 +115,8 @@ There are a few ways to create a new `ReadingTime` instance. Either create a new
 In all cases, you will end up with a `ReadingTime` object that you can use to get the reading time.
 
 ```php
+use Hyde\Support\ReadingTime;
+
 // Via constructor
 $time = new ReadingTime('Input text string');
 

ide.json

@@ -10,7 +10,7 @@
                 {
                     "methodNames": ["path"],
                     "place": "parameter",
-                    "classFqn": ["\\Hyde\\Hyde"],
+                    "classFqn": ["Hyde\\Foundation\\HydeKernel", "\\Hyde\\Hyde", "Hyde"],
                     "parameters": [1]
                 }
             ]

monorepo/HydeStan/.gitignore

@@ -0,0 +1 @@
+todo.md

monorepo/HydeStan/HydeStan.php

@@ -20,6 +20,8 @@ final class HydeStan
     private const TEST_FILE_ANALYSERS = [
         NoFixMeAnalyser::class,
         NoUsingAssertEqualsForScalarTypesTestAnalyser::class,
+        NoParentSetUpTearDownInUnitTestCaseAnalyser::class,
+        UnitTestCaseExtensionAnalyzer::class,
     ];
 
     private const LINE_ANALYSERS = [
@@ -85,6 +87,8 @@ public function run(): void
             $this->analyseFile($file, $this->getFileContents($file));
         }
 
+        $this->console->info('Finished analyzing files!');
+
         $this->runTestStan();
 
         $endTime = microtime(true) - $time;
@@ -382,3 +386,59 @@ public function run(string $file, int $lineNumber, string $line): void
         }
     }
 }
+
+class NoParentSetUpTearDownInUnitTestCaseAnalyser extends FileAnalyser
+{
+    public function run(string $file, string $contents): void
+    {
+        if (! str_contains($contents, 'extends UnitTestCase')) {
+            return;
+        }
+
+        $methods = ['setUp', 'tearDown'];
+
+        foreach ($methods as $method) {
+            AnalysisStatisticsContainer::analysedExpression();
+            if (str_contains($contents, "parent::$method()")) {
+                $lineNumber = substr_count(substr($contents, 0, strpos($contents, $method)), "\n") + 1;
+                $this->fail(sprintf("Found '%s' method in UnitTestCase at %s", "parent::$method()", fileLink($file, $lineNumber, false)));
+                HydeStan::addActionsMessage('error', $file, $lineNumber, "HydeStan: UnnecessaryParent{$method}MethodError", "{$method} method in UnitTestCase performs no operation and should be removed.");
+            }
+        }
+    }
+}
+
+class UnitTestCaseExtensionAnalyzer extends FileAnalyser
+{
+    public function run(string $file, string $contents): void
+    {
+        // Check if the file is in the unit namespace
+        if (! str_contains($file, 'Unit')) {
+            AnalysisStatisticsContainer::analysedExpression();
+
+            return;
+        }
+
+        AnalysisStatisticsContainer::analysedExpression();
+
+        // Unit view tests are allowed to extend TestCase
+        if (str_contains($file, 'ViewTest')) {
+            AnalysisStatisticsContainer::analysedExpression();
+
+            return;
+        }
+
+        AnalysisStatisticsContainer::analysedExpression();
+
+        // Check if the class extends TestCase but not UnitTestCase
+        if (str_contains($contents, 'extends TestCase') && ! str_contains($contents, 'extends UnitTestCase')) {
+            AnalysisStatisticsContainer::analysedExpressions(2);
+
+            $lineNumber = substr_count(substr($contents, 0, strpos($contents, 'extends TestCase')), "\n") + 1;
+
+            todo(realpath(__DIR__.'/../../packages/framework/'.$file), $lineNumber, 'Refactor unit test to extend UnitTestCase instead of TestCase');
+
+            echo sprintf('Test in unit namespace extends TestCase instead of UnitTestCase at %s', fileLink($file, $lineNumber, false))."\n";
+        }
+    }
+}

monorepo/HydeStan/includes/helpers.php

@@ -51,11 +51,14 @@ function check_str_contains_any(array $searches, string $line): bool
     return $strContainsAny;
 }
 
-function fileLink(string $file, ?int $line = null): string
+function fileLink(string $file, ?int $line = null, bool $substr = true): string
 {
     $path = (realpath(__DIR__.'/../../packages/framework/'.$file) ?: $file).($line ? ':'.$line : '');
-    $trim = strlen(getcwd()) + 2;
-    $path = substr($path, $trim);
+
+    if ($substr) {
+        $trim = strlen(getcwd()) + 2;
+        $path = substr($path, $trim);
+    }
 
     return str_replace('\\', '/', $path);
 }
@@ -74,3 +77,61 @@ function recursiveFileFinder(string $directory): array
 
     return $files;
 }
+
+class TodoBuffer
+{
+    private static array $todos = [];
+
+    public static function add(string $file, int $line, string $todo): void
+    {
+        self::$todos[] = [
+            'file' => $file,
+            'line' => $line,
+            'todo' => $todo,
+        ];
+    }
+
+    public static function getTodos(): array
+    {
+        return self::$todos;
+    }
+
+    public static function writeTaskFile(): void
+    {
+        $todos = self::getTodos();
+
+        if (empty($todos)) {
+            return;
+        }
+
+        $taskFile = __DIR__.'/../todo.md';
+
+        $content = '# Todos'."\n\n";
+        $groupedTodos = [];
+
+        $baseDir = realpath(__DIR__.'/../../../');
+
+        foreach ($todos as $todo) {
+            $path = "{$todo['file']}:{$todo['line']}";
+            $path = str_replace('\\', '/', $path);
+
+            $path = substr($path, strlen($baseDir) + 1);
+
+            $groupedTodos[$todo['todo']][] = "[$path]($path)";
+        }
+
+        foreach ($groupedTodos as $todo => $items) {
+            $content .= "## $todo\n\n";
+            foreach ($items as $item) {
+                $content .= "- $item\n";
+            }
+        }
+
+        file_put_contents($taskFile, $content);
+    }
+}
+
+function todo(string $file, int $line, string $todo): void
+{
+    TodoBuffer::add($file, $line, $todo);
+}

monorepo/HydeStan/run.php

@@ -12,6 +12,9 @@
 $analyser = new HydeStan($debug);
 $analyser->run();
 
+// Todo: Could add a flag for this
+TodoBuffer::writeTaskFile();
+
 if ($analyser->hasErrors()) {
     exit(1);
 }

package.json

@@ -10,7 +10,7 @@
         "autoprefixer": "^10.4.20",
         "hydefront": "^3.3.0",
         "laravel-mix": "^6.0.49",
-        "postcss": "^8.4.41",
+        "postcss": "^8.4.45",
         "prettier": "3.3.3",
         "tailwindcss": "^3.4.10"
     }

packages/framework/src/Facades/Filesystem.php

@@ -113,7 +113,7 @@ public static function unlinkIfExists(string $path): bool
      */
     public static function getContents(string $path, bool $lock = false): string
     {
-        return self::get($path, $lock);
+        return self::get(...func_get_args());
     }
 
     /**
@@ -126,7 +126,7 @@ public static function getContents(string $path, bool $lock = false): string
      */
     public static function putContents(string $path, string $contents, bool $lock = false): bool|int
     {
-        return self::put($path, $contents, $lock);
+        return self::put(...func_get_args());
     }
 
     /**

packages/framework/src/Foundation/Kernel/FileCollection.php

@@ -4,13 +4,13 @@
 
 namespace Hyde\Foundation\Kernel;
 
+use Hyde\Facades\Filesystem;
 use Hyde\Foundation\Concerns\BaseFoundationCollection;
 use Hyde\Framework\Exceptions\FileNotFoundException;
 use Hyde\Pages\Concerns\HydePage;
 use Hyde\Support\Filesystem\SourceFile;
 
 use function basename;
-use function glob;
 use function str_starts_with;
 
 /**
@@ -59,7 +59,7 @@ protected function runExtensionHandlers(): void
     protected function discoverFilesFor(string $pageClass): void
     {
         // Scan the source directory, and directories therein, for files that match the model's file extension.
-        foreach (glob($this->kernel->path($pageClass::sourcePath('{*,**/*}')), GLOB_BRACE) as $path) {
+        foreach (Filesystem::smartGlob($pageClass::sourcePath('{*,**/*}'), GLOB_BRACE) as $path) {
             if (! str_starts_with(basename((string) $path), '_')) {
                 $this->addFile(SourceFile::make($path, $pageClass));
             }

packages/framework/src/Framework/Actions/BladeMatterParser.php

@@ -4,10 +4,9 @@
 
 namespace Hyde\Framework\Actions;
 
-use Hyde\Hyde;
 use RuntimeException;
+use Hyde\Facades\Filesystem;
 
-use function file_get_contents;
 use function str_ends_with;
 use function str_starts_with;
 use function substr_count;
@@ -53,7 +52,7 @@ class BladeMatterParser
 
     public static function parseFile(string $path): array
     {
-        return static::parseString(file_get_contents(Hyde::path($path)));
+        return static::parseString(Filesystem::getContents($path));
     }
 
     public static function parseString(string $contents): array

packages/framework/tests/Unit/DocumentationPageTest.php → packages/framework/tests/Feature/DocumentationPageTest.php

@@ -2,7 +2,7 @@
 
 declare(strict_types=1);
 
-namespace Hyde\Framework\Testing\Unit;
+namespace Hyde\Framework\Testing\Feature;
 
 use Hyde\Facades\Filesystem;
 use Hyde\Foundation\Facades\Routes;