WIP

StydeNet · May 5, 2024 · e4f624a · e4f624a
1 parent 69aeda8
commit e4f624a
Show file tree

Hide file tree

Showing 80 changed files with 369 additions and 714 deletions.
diff --git a/.phpunit.cache/test-results b/.phpunit.cache/test-results
diff --git a/composer.json b/composer.json
@@ -3,15 +3,15 @@
     "description": "Enlighten your APIs with auto-generated documentation",
     "type": "library",
     "require": {
-        "php": "^7.3|^8.0",
-        "laravel/framework": "^7.28|^8.0|^9.0|^10.0",
+        "php": "^8.2",
+        "laravel/framework": "^11.0",
         "ext-json": "*",
         "guzzlehttp/guzzle": "^7.2"
     },
     "require-dev": {
-        "phpunit/phpunit": "^9.3|^9.5",
-        "orchestra/testbench": "^5.0|^6.0|^7.0",
-        "friendsofphp/php-cs-fixer": "^2.16|^3.1"
+        "phpunit/phpunit": "^11.0.1",
+        "orchestra/testbench": "^9.0",
+        "friendsofphp/php-cs-fixer": "^3.1"
     },
     "license": "MIT",
     "authors": [

diff --git a/phpunit.xml b/phpunit.xml
@@ -1,29 +1,26 @@
 <?xml version="1.0" encoding="UTF-8"?>
-<phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" backupGlobals="false" backupStaticAttributes="false"
-         bootstrap="vendor/autoload.php" colors="true" convertErrorsToExceptions="true"
-         convertNoticesToExceptions="true" convertWarningsToExceptions="true" processIsolation="false"
-         stopOnError="false" stopOnFailure="false" verbose="true"
-         xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/9.3/phpunit.xsd">
-    <coverage processUncoveredFiles="true">
-        <include>
-            <directory suffix=".php">./src</directory>
-        </include>
-    </coverage>
-    <testsuites>
-        <testsuite name="Unit">
-            <directory suffix="Test.php">./tests/Unit</directory>
-        </testsuite>
-        <testsuite name="Console">
-            <directory suffix="Test.php">./tests/Console</directory>
-        </testsuite>
-        <testsuite name="Feature">
-            <directory suffix="Test.php">./tests/Feature</directory>
-        </testsuite>
-        <testsuite name="Integration">
-            <directory suffix="Test.php">./tests/Integration</directory>
-        </testsuite>
-    </testsuites>
-    <php>
-        <env name="APP_KEY" value="base64:CIjoXm7CcFbLOH9vTdexSSIJGB4tH8vNJ2jKbXcQI4w="/>
-    </php>
+<phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" backupGlobals="false" bootstrap="vendor/autoload.php" colors="true" processIsolation="false" stopOnError="false" stopOnFailure="false" xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/11.1/phpunit.xsd" cacheDirectory=".phpunit.cache" backupStaticProperties="false">
+  <testsuites>
+    <testsuite name="Unit">
+      <directory suffix="Test.php">./tests/Unit</directory>
+    </testsuite>
+    <testsuite name="Console">
+      <directory suffix="Test.php">./tests/Console</directory>
+    </testsuite>
+    <testsuite name="Feature">
+      <directory suffix="Test.php">./tests/Feature</directory>
+    </testsuite>
+    <testsuite name="Integration">
+      <directory suffix="Test.php">./tests/Integration</directory>
+    </testsuite>
+  </testsuites>
+  <php>
+    <env name="APP_KEY" value="base64:CIjoXm7CcFbLOH9vTdexSSIJGB4tH8vNJ2jKbXcQI4w="/>
+    <env name="SYMFONY_DEPRECATIONS_HELPER" value="disabled" />
+  </php>
+  <source>
+    <include>
+      <directory suffix=".php">./src</directory>
+    </include>
+  </source>
 </phpunit>
diff --git a/src/CodeExamples/CodeExampleCreator.php b/src/CodeExamples/CodeExampleCreator.php
@@ -5,22 +5,12 @@
 use Styde\Enlighten\ExampleCreator;
 use Throwable;
 
-class CodeExampleCreator
+readonly class CodeExampleCreator
 {
-    /**
-     * @var \Styde\Enlighten\ExampleCreator
-     */
-    private $exampleCreator;
-
-    /**
-     * @var CodeInspector
-     */
-    private $codeInspector;
-
-    public function __construct(ExampleCreator $exampleCreator, CodeInspector $codeInspector)
-    {
-        $this->exampleCreator = $exampleCreator;
-        $this->codeInspector = $codeInspector;
+    public function __construct(
+        private ExampleCreator $exampleCreator,
+        private CodeInspector $codeInspector,
+    ) {
     }
 
     public function createSnippet(callable $callback, string $key = null)

diff --git a/src/CodeExamples/CodeResultExporter.php b/src/CodeExamples/CodeResultExporter.php
@@ -6,16 +6,10 @@
 
 class CodeResultExporter
 {
-    private $currentLevel;
+    private int $currentLevel;
 
-    /**
-     * @var CodeResultFormat
-     */
-    private $format;
-
-    public function __construct(CodeResultFormat $format)
+    public function __construct(private readonly CodeResultFormat $format)
     {
-        $this->format = $format;
     }
 
     public function export($snippet)
@@ -28,7 +22,7 @@ public function export($snippet)
         );
     }
 
-    private function exportValue($value)
+    private function exportValue($value): string
     {
         if (isset($value[ExampleSnippet::CLASS_NAME])) {
             return $this->exportObject($value);
@@ -54,7 +48,7 @@ private function exportValue($value)
         return '';
     }
 
-    private function exportArray($items)
+    private function exportArray($items): string
     {
         $result = $this->format->symbol('[').$this->format->line();
 
@@ -70,7 +64,7 @@ private function exportArray($items)
         return $result;
     }
 
-    public function isAssoc(array $array)
+    public function isAssoc(array $array): bool
     {
         return array_keys($array) !== range(0, count($array) - 1);
     }

diff --git a/src/CodeExamples/CodeResultTransformer.php b/src/CodeExamples/CodeResultTransformer.php
@@ -11,10 +11,7 @@
 
 class CodeResultTransformer
 {
-    /**
-     * @var int
-     */
-    public static $maxNestedLevel = 5;
+    public static int $maxNestedLevel = 5;
 
     public static function export($result)
     {

diff --git a/src/CodeExamples/PlainCodeResultFormat.php b/src/CodeExamples/PlainCodeResultFormat.php
@@ -6,7 +6,7 @@
 
 class PlainCodeResultFormat extends BaseCodeResultFormat
 {
-    public function block(string $code)
+    public function block(string $code): HtmlString
     {
         return new HtmlString('<pre>'.$code.'</pre>');
     }
@@ -46,7 +46,7 @@ public function className(string $name): string
         return $name;
     }
 
-    public function propertyName(string $name)
+    public function propertyName(string $name): string
     {
         return $name;
     }

diff --git a/src/Console/Commands/ExportDocumentationCommand.php b/src/Console/Commands/ExportDocumentationCommand.php
@@ -3,6 +3,7 @@
 namespace Styde\Enlighten\Console\Commands;
 
 use Illuminate\Console\Command;
+use Illuminate\Database\Eloquent\Collection;
 use Illuminate\Support\Str;
 use Styde\Enlighten\Console\DocumentationExporter;
 use Styde\Enlighten\Models\Run;
@@ -13,19 +14,13 @@ class ExportDocumentationCommand extends Command
 
     protected $description = 'Export the documentation generated by Enlighten as static HTML files';
 
-    /**
-     * @var DocumentationExporter
-     */
-    private $exporter;
-
-    public function __construct(DocumentationExporter $exporter)
+    public function __construct(private readonly DocumentationExporter $exporter)
     {
         parent::__construct();
 
-        $this->exporter = $exporter;
     }
 
-    public function handle()
+    public function handle(): void
     {
         $runs = $this->getLatestRuns();
 
@@ -52,15 +47,15 @@ public function handle()
         $this->info("`{$selectedRun->signature}` run exported!");
     }
 
-    protected function getLatestRuns()
+    protected function getLatestRuns(): Collection
     {
         return Run::query()
             ->latest()
             ->take(5)
             ->get();
     }
 
-    private function normalizeBaseUrl($url)
+    private function normalizeBaseUrl($url): string
     {
         if (Str::startsWith($url, ['http://', 'https://'])) {
             return $url;

diff --git a/src/Console/Commands/GenerateDocumentationCommand.php b/src/Console/Commands/GenerateDocumentationCommand.php
@@ -22,7 +22,7 @@ public function __construct()
         $this->ignoreValidationErrors();
     }
 
-    public function handle()
+    public function handle(): void
     {
         $runBuilder = app(RunBuilder::class);
 
@@ -43,7 +43,7 @@ public function handle()
         }
     }
 
-    private function addCustomBootstrapToGlobalArguments()
+    private function addCustomBootstrapToGlobalArguments(): void
     {
         $_SERVER['argv'] = array_merge(
             array_slice($_SERVER['argv'], 0, 2),
@@ -60,7 +60,7 @@ private function runTests(): void
         ]);
     }
 
-    private function printMissingSetupWarning()
+    private function printMissingSetupWarning(): void
     {
         $this->output->newLine();
         $this->alert('The documentation was not generated');
@@ -69,7 +69,7 @@ private function printMissingSetupWarning()
         $this->warn('Learn more: https://github.com/StydeNet/enlighten#installation');
     }
 
-    private function printFailedExamples(RunContract $run)
+    private function printFailedExamples(RunContract $run): void
     {
         $failedExamples = $run->getFailedExamples();
 
@@ -79,7 +79,7 @@ private function printFailedExamples(RunContract $run)
         }
     }
 
-    private function printFailedExamplesHeader($examples)
+    private function printFailedExamplesHeader($examples): void
     {
         $this->output->newLine();
         $this->error(sprintf(
@@ -89,7 +89,7 @@ private function printFailedExamplesHeader($examples)
         ));
     }
 
-    private function printFailedExampleItems($examples)
+    private function printFailedExampleItems($examples): void
     {
         $examples->each(function ($example) {
             $this->output->newLine();
@@ -98,7 +98,7 @@ private function printFailedExampleItems($examples)
         });
     }
 
-    private function printDocumentationLink(RunContract $run)
+    private function printDocumentationLink(RunContract $run): void
     {
         $this->output->newLine();
         $this->line('⚡ Check your documentation at:');

diff --git a/src/Console/Commands/InstallCommand.php b/src/Console/Commands/InstallCommand.php
@@ -11,7 +11,7 @@ class InstallCommand extends Command
 
     protected $description = 'Install and Enlighten automatically';
 
-    public function handle()
+    public function handle(): void
     {
         $this->publishBuildAndConfigFiles();
 
@@ -36,7 +36,7 @@ private function publishBuildAndConfigFiles(): void
         $this->call('vendor:publish', ['--tag' => 'enlighten']);
     }
 
-    private function setupEnlightenInTestCase()
+    private function setupEnlightenInTestCase(): bool
     {
         $appTestCase = File::get(base_path('tests/TestCase.php'));
         $baseTestCase = File::get(__DIR__.'/stubs/BaseTestCase.php.stub');

diff --git a/src/Console/ContentRequest.php b/src/Console/ContentRequest.php
@@ -8,17 +8,12 @@
 
 class ContentRequest
 {
-    /**
-     * @var HttpKernel
-     */
-    private $httpKernel;
 
-    public function __construct(HttpKernel $httpKernel)
+    public function __construct(private readonly HttpKernel $httpKernel)
     {
-        $this->httpKernel = $httpKernel;
     }
 
-    public function getContent(string $url)
+    public function getContent(string $url): false|string
     {
         $symfonyRequest = SymfonyRequest::create($url, 'GET');