Merge pull request #1414 from hydephp/code-quality

emmadesilva · web-flow · commit a121e9cc478b · 2023-10-29T14:41:09.000+01:00
Additional minor code quality and type improvements
diff --git a/packages/framework/src/Console/Commands/BuildSiteCommand.php b/packages/framework/src/Console/Commands/BuildSiteCommand.php
@@ -46,8 +46,7 @@ public function handle(): int
 
         $this->service = new BuildService($this->output);
 
-        $this->taskService = app(BuildTaskService::class);
-        $this->taskService->setOutput($this->output);
+        $this->configureBuildTaskService();
 
         $this->runPreBuildActions();
 
@@ -62,11 +61,21 @@ public function handle(): int
         return $this->getExitCode();
     }
 
+    protected function configureBuildTaskService(): void
+    {
+        /** @var BuildTaskService $taskService */
+        $taskService = app(BuildTaskService::class);
+
+        $this->taskService = $taskService;
+        $this->taskService->setOutput($this->output);
+    }
+
     protected function runPreBuildActions(): void
     {
         if ($this->option('no-api')) {
             $this->info('Disabling external API calls');
             $this->newLine();
+            /** @var array<string, string> $config */
             $config = Config::getArray('hyde.features', []);
             unset($config[array_search('torchlight', $config)]);
             Config::set(['hyde.features' => $config]);
@@ -132,7 +141,7 @@ protected function runNodeCommand(string $command, string $message, ?string $act
 
         $output = shell_exec(sprintf(
             '%s%s',
-            app()->environment() === 'testing' ? 'echo ' : '',
+            (string) app()->environment() === 'testing' ? 'echo ' : '',
             $command
         ));
 
@@ -150,7 +159,7 @@ protected function hasWarnings(): bool
     protected function getExitCode(): int
     {
         if ($this->hasWarnings() && BuildWarnings::reportsWarningsAsExceptions()) {
-            return self::INVALID;
+            return Command::INVALID;
         }
 
         return Command::SUCCESS;
diff --git a/packages/framework/src/Console/Commands/DebugCommand.php b/packages/framework/src/Console/Commands/DebugCommand.php
@@ -70,7 +70,10 @@ protected function printVerbosePathInformation(): void
 
     protected function printEnabledFeatures(): void
     {
-        foreach (Config::getArray('hyde.features') as $feature) {
+        /** @var array<string, string> $features */
+        $features = Config::getArray('hyde.features', []);
+
+        foreach ($features as $feature) {
             $this->line(" - $feature");
         }
     }
diff --git a/packages/framework/src/Console/Commands/MakePageCommand.php b/packages/framework/src/Console/Commands/MakePageCommand.php
@@ -80,7 +80,7 @@ protected function validateOptions(): void
     protected function getTitle(): string
     {
         return $this->argument('title')
-            ?? $this->ask('What is the title of the page?')
+            ?? $this->askForString('What is the title of the page?')
             ?? 'My New Page';
     }
 
@@ -116,4 +116,9 @@ protected function getTypeOption(): ?string
 
         return null;
     }
+
+    protected function askForString(string $question, ?string $default = null): ?string
+    {
+        return $this->ask($question, $default);
+    }
 }
diff --git a/packages/framework/src/Facades/Config.php b/packages/framework/src/Facades/Config.php
@@ -46,6 +46,7 @@ public static function getFloat(string $key, float $default = null): float
     /** @experimental Could possibly be merged by allowing null returns if default is null? Preferably with generics so the type is matched by IDE support. */
     public static function getNullableString(string $key, string $default = null): ?string
     {
+        /** @var array|string|int|bool|float|null $value */
         $value = static::get($key, $default);
 
         if ($value === null) {
diff --git a/packages/framework/src/Facades/Filesystem.php b/packages/framework/src/Facades/Filesystem.php
@@ -7,7 +7,6 @@
 use Hyde\Foundation\HydeKernel;
 use Hyde\Framework\Concerns\Internal\ForwardsIlluminateFilesystem;
 use Illuminate\Support\Collection;
-use Illuminate\Support\Facades\File;
 
 use function app;
 
diff --git a/packages/framework/src/Foundation/Internal/LoadYamlConfiguration.php b/packages/framework/src/Foundation/Internal/LoadYamlConfiguration.php
@@ -45,6 +45,7 @@ protected function hasYamlConfigFile(): bool
             || file_exists(Hyde::path('hyde.yaml'));
     }
 
+    /** @return array<string, mixed> */
     protected function getYaml(): array
     {
         return (array) Yaml::parse(file_get_contents($this->getFile()));
@@ -64,6 +65,7 @@ protected function mergeParsedConfiguration(): void
         // If the Yaml file contains namespaces, we merge those using more granular logic
         // that only applies the namespace data to each configuration namespace.
         if ($this->configurationContainsNamespaces($yaml)) {
+            /** @var array<string, array<string, scalar>> $yaml */
             foreach ($yaml as $namespace => $data) {
                 $this->mergeConfiguration($namespace, (array) $data);
             }
diff --git a/packages/framework/src/Framework/Actions/PreBuildTasks/CleanSiteDirectory.php b/packages/framework/src/Framework/Actions/PreBuildTasks/CleanSiteDirectory.php
@@ -61,6 +61,8 @@ protected function askIfUnsafeDirectoryShouldBeEmptied(): bool
     protected function safeOutputDirectories(): array
     {
         /** @var array<string> $directories */
-        return Config::getArray('hyde.safe_output_directories', ['_site', 'docs', 'build']);
+        $directories = Config::getArray('hyde.safe_output_directories', ['_site', 'docs', 'build']);
+
+        return $directories;
     }
 }
diff --git a/packages/framework/src/Framework/Factories/NavigationDataFactory.php b/packages/framework/src/Framework/Factories/NavigationDataFactory.php
@@ -139,10 +139,13 @@ private function searchForPriorityInFrontMatter(): ?int
 
     private function searchForLabelInConfig(): ?string
     {
-        return Config::getArray('hyde.navigation.labels', [
+        /** @var array<string, string> $config */
+        $config = Config::getArray('hyde.navigation.labels', [
             'index' => 'Home',
             DocumentationPage::homeRouteName() => 'Docs',
-        ])[$this->routeKey] ?? null;
+        ]);
+
+        return $config[$this->routeKey] ?? null;
     }
 
     private function searchForPriorityInConfigs(): ?int
@@ -160,19 +163,25 @@ private function searchForPriorityInSidebarConfig(): ?int
         // Adding an offset makes so that pages with a front matter priority that is lower can be shown first.
         // This is all to make it easier to mix ways of adding priorities.
 
+        /** @var array<string> $config */
+        $config = Config::getArray('docs.sidebar_order', []);
+
         return $this->offset(
-            array_flip(Config::getArray('docs.sidebar_order', []))[$this->identifier] ?? null,
+            array_flip($config)[$this->identifier] ?? null,
             self::CONFIG_OFFSET
         );
     }
 
     private function searchForPriorityInNavigationConfig(): ?int
     {
-        return Config::getArray('hyde.navigation.order', [
+        /** @var array<string, int> $config */
+        $config = Config::getArray('hyde.navigation.order', [
             'index' => 0,
             'posts' => 10,
             'docs/index' => 100,
-        ])[$this->routeKey] ?? null;
+        ]);
+
+        return $config[$this->routeKey] ?? null;
     }
 
     private function canUseSubdirectoryForGroups(): bool
diff --git a/packages/framework/src/Framework/Features/Blogging/Models/FeaturedImage.php b/packages/framework/src/Framework/Features/Blogging/Models/FeaturedImage.php
@@ -226,6 +226,7 @@ protected function getContentLengthForRemoteImage(): int
     {
         // Check if the --no-api flag is set when running the build command, and if so, skip the API call.
         if (Config::getBool('hyde.api_calls', true)) {
+            /** @var string[][] $headers */
             $headers = Http::withHeaders([
                 'User-Agent' => Config::getString('hyde.http_user_agent', 'RSS Request Client'),
             ])->head($this->getSource())->headers();
diff --git a/packages/framework/src/Framework/Features/Navigation/NavItem.php b/packages/framework/src/Framework/Features/Navigation/NavItem.php
@@ -125,7 +125,10 @@ public function isCurrent(): bool
 
     protected static function getRouteGroup(Route $route): ?string
     {
-        return static::normalizeGroupKey($route->getPage()->data('navigation.group'));
+        /** @var string|null $group */
+        $group = $route->getPage()->data('navigation.group');
+
+        return static::normalizeGroupKey($group);
     }
 
     protected static function normalizeGroupKey(?string $group): ?string
diff --git a/packages/framework/src/Framework/Features/XmlGenerators/SitemapGenerator.php b/packages/framework/src/Framework/Features/XmlGenerators/SitemapGenerator.php
@@ -8,6 +8,7 @@
 
 use Hyde\Hyde;
 use SimpleXMLElement;
+use Hyde\Facades\Config;
 use Hyde\Pages\BladePage;
 use Hyde\Pages\MarkdownPage;
 use Hyde\Pages\MarkdownPost;
@@ -18,7 +19,6 @@
 
 use function filemtime;
 use function in_array;
-use function config;
 use function date;
 use function time;
 
@@ -61,7 +61,7 @@ protected function addRoute(Route $route): void
         $this->addChild($urlItem, 'lastmod', $this->getLastModDate($route->getSourcePath()));
         $this->addChild($urlItem, 'changefreq', 'daily');
 
-        if (config('hyde.sitemap.dynamic_priority', true)) {
+        if (Config::getBool('hyde.sitemap.dynamic_priority', true)) {
             $this->addChild($urlItem, 'priority', $this->getPriority(
                 $route->getPageClass(), $route->getPage()->getIdentifier()
             ));
diff --git a/packages/framework/src/Framework/Services/ValidationService.php b/packages/framework/src/Framework/Services/ValidationService.php
@@ -13,6 +13,7 @@
 use Hyde\Support\Models\ValidationResult as Result;
 
 use function count;
+use function call_user_func;
 use function get_class_methods;
 use function array_intersect;
 use function file_exists;
@@ -38,7 +39,7 @@ public static function checks(): array
 
     public function run(string $check): Result
     {
-        return $this->$check(new Result);
+        return call_user_func([$this, $check], new Result);
     }
 
     public function check_validators_can_run(Result $result): Result
diff --git a/packages/framework/src/Markdown/Processing/CodeblockFilepathProcessor.php b/packages/framework/src/Markdown/Processing/CodeblockFilepathProcessor.php
@@ -28,6 +28,7 @@ class CodeblockFilepathProcessor implements MarkdownPreProcessorContract, Markdo
 {
     protected static string $torchlightKey = '<!-- Syntax highlighted by torchlight.dev -->';
 
+    /** @var array<string> */
     protected static array $patterns = [
         '// filepath: ',
         '// filepath ',
diff --git a/packages/framework/src/Pages/DocumentationPage.php b/packages/framework/src/Pages/DocumentationPage.php
@@ -10,6 +10,11 @@
 use Hyde\Pages\Concerns\BaseMarkdownPage;
 use Hyde\Support\Models\Route;
 
+use function trim;
+use function sprintf;
+use function unslash;
+use function basename;
+
 /**
  * Page class for documentation pages.
  *
@@ -37,16 +42,16 @@ public static function homeRouteName(): string
     /** @see https://hydephp.com/docs/1.x/documentation-pages#automatic-edit-page-button */
     public function getOnlineSourcePath(): string|false
     {
-        if (config('docs.source_file_location_base') === null) {
+        if (Config::getNullableString('docs.source_file_location_base') === null) {
             return false;
         }
 
-        return trim((string) config('docs.source_file_location_base'), '/').'/'.$this->identifier.'.md';
+        return sprintf('%s/%s.md', trim(Config::getString('docs.source_file_location_base'), '/'), $this->identifier);
     }
 
     public static function hasTableOfContents(): bool
     {
-        return config('docs.table_of_contents.enabled', true);
+        return Config::getBool('docs.table_of_contents.enabled', true);
     }
 
     /**
diff --git a/packages/framework/src/Support/BuildWarnings.php b/packages/framework/src/Support/BuildWarnings.php
@@ -18,18 +18,21 @@
  */
 class BuildWarnings
 {
-    /** @var array<int, \Hyde\Framework\Exceptions\BuildWarning> */
+    /** @var array<\Hyde\Framework\Exceptions\BuildWarning> */
     protected array $warnings = [];
 
-    public static function getInstance(): static
+    public static function getInstance(): self
     {
         $app = Container::getInstance();
 
         if (! $app->bound(self::class)) {
             $app->singleton(self::class);
         }
 
-        return $app->make(self::class);
+        /** @var \Hyde\Support\BuildWarnings $instance */
+        $instance = $app->make(self::class);
+
+        return $instance;
     }
 
     public static function report(BuildWarning|string $warning): void
@@ -79,8 +82,11 @@ protected static function renderWarnings(OutputStyle $output, bool $verbose): vo
 
     protected static function renderWarningsAsExceptions(OutputStyle $output): void
     {
+        /** @var ExceptionHandler $handler */
+        $handler = app(ExceptionHandler::class);
+
         foreach (static::getWarnings() as $warning) {
-            app(ExceptionHandler::class)->renderForConsole($output, $warning);
+            $handler->renderForConsole($output, $warning);
         }
     }
 }
diff --git a/packages/publications/src/Pages/PublicationListPage.php b/packages/publications/src/Pages/PublicationListPage.php
@@ -4,11 +4,11 @@
 
 namespace Hyde\Publications\Pages;
 
+use Hyde\Facades\Config;
 use Hyde\Pages\InMemoryPage;
 use Hyde\Publications\Actions\PublicationPageCompiler;
 use Hyde\Publications\Models\PublicationType;
 
-use function config;
 use function in_array;
 
 /**
@@ -35,6 +35,6 @@ public function compile(): string
 
     public function showInNavigation(): bool
     {
-        return ! in_array($this->type->getDirectory(), config('hyde.navigation.exclude', []));
+        return ! in_array($this->type->getDirectory(), Config::getArray('hyde.navigation.exclude', []));
     }
 }

Original file line number	Diff line number	Diff line change
`@@ -70,7 +70,10 @@ protected function printVerbosePathInformation(): void`
`70`	`70`
`71`	`71`	`protected function printEnabledFeatures(): void`
`72`	`72`	`{`
`73`		`- foreach (Config::getArray('hyde.features') as $feature) {`
	`73`	`+ /** @var array<string, string> $features */`
	`74`	`+ $features = Config::getArray('hyde.features', []);`
	`75`	`+`
	`76`	`+ foreach ($features as $feature) {`
`74`	`77`	`$this->line(" - $feature");`
`75`	`78`	`}`
`76`	`79`	`}`
Original file line number	Diff line number	Diff line change
`@@ -80,7 +80,7 @@ protected function validateOptions(): void`
`80`	`80`	`protected function getTitle(): string`
`81`	`81`	`{`
`82`	`82`	`return $this->argument('title')`
`83`		`- ?? $this->ask('What is the title of the page?')`
	`83`	`+ ?? $this->askForString('What is the title of the page?')`
`84`	`84`	`?? 'My New Page';`
`85`	`85`	`}`
`86`	`86`
`@@ -116,4 +116,9 @@ protected function getTypeOption(): ?string`
`116`	`116`
`117`	`117`	`return null;`
`118`	`118`	`}`
	`119`	`+`
	`120`	`+ protected function askForString(string $question, ?string $default = null): ?string`
	`121`	`+ {`
	`122`	`+ return $this->ask($question, $default);`
	`123`	`+ }`
`119`	`124`	`}`
Original file line number	Diff line number	Diff line change
`@@ -46,6 +46,7 @@ public static function getFloat(string $key, float $default = null): float`
`46`	`46`	`/** @experimental Could possibly be merged by allowing null returns if default is null? Preferably with generics so the type is matched by IDE support. */`
`47`	`47`	`public static function getNullableString(string $key, string $default = null): ?string`
`48`	`48`	`{`
	`49`	`+ /** @var array\|string\|int\|bool\|float\|null $value */`
`49`	`50`	`$value = static::get($key, $default);`
`50`	`51`
`51`	`52`	`if ($value === null) {`
Original file line number	Diff line number	Diff line change
`@@ -45,6 +45,7 @@ protected function hasYamlConfigFile(): bool`
`45`	`45`	`\|\| file_exists(Hyde::path('hyde.yaml'));`
`46`	`46`	`}`
`47`	`47`
	`48`	`+ /** @return array<string, mixed> */`
`48`	`49`	`protected function getYaml(): array`
`49`	`50`	`{`
`50`	`51`	`return (array) Yaml::parse(file_get_contents($this->getFile()));`
`@@ -64,6 +65,7 @@ protected function mergeParsedConfiguration(): void`
`64`	`65`	`// If the Yaml file contains namespaces, we merge those using more granular logic`
`65`	`66`	`// that only applies the namespace data to each configuration namespace.`
`66`	`67`	`if ($this->configurationContainsNamespaces($yaml)) {`
	`68`	`+ /** @var array<string, array<string, scalar>> $yaml */`
`67`	`69`	`foreach ($yaml as $namespace => $data) {`
`68`	`70`	`$this->mergeConfiguration($namespace, (array) $data);`
`69`	`71`	`}`
Original file line number	Diff line number	Diff line change
`@@ -61,6 +61,8 @@ protected function askIfUnsafeDirectoryShouldBeEmptied(): bool`
`61`	`61`	`protected function safeOutputDirectories(): array`
`62`	`62`	`{`
`63`	`63`	`/** @var array<string> $directories */`
`64`		`- return Config::getArray('hyde.safe_output_directories', ['_site', 'docs', 'build']);`
	`64`	`+ $directories = Config::getArray('hyde.safe_output_directories', ['_site', 'docs', 'build']);`
	`65`	`+`
	`66`	`+ return $directories;`
`65`	`67`	`}`
`66`	`68`	`}`
Original file line number	Diff line number	Diff line change
`@@ -226,6 +226,7 @@ protected function getContentLengthForRemoteImage(): int`
`226`	`226`	`{`
`227`	`227`	`// Check if the --no-api flag is set when running the build command, and if so, skip the API call.`
`228`	`228`	`if (Config::getBool('hyde.api_calls', true)) {`
	`229`	`+ /** @var string[][] $headers */`
`229`	`230`	`$headers = Http::withHeaders([`
`230`	`231`	`'User-Agent' => Config::getString('hyde.http_user_agent', 'RSS Request Client'),`
`231`	`232`	`])->head($this->getSource())->headers();`
Original file line number	Diff line number	Diff line change
`@@ -125,7 +125,10 @@ public function isCurrent(): bool`
`125`	`125`
`126`	`126`	`protected static function getRouteGroup(Route $route): ?string`
`127`	`127`	`{`
`128`		`- return static::normalizeGroupKey($route->getPage()->data('navigation.group'));`
	`128`	`+ /** @var string\|null $group */`
	`129`	`+ $group = $route->getPage()->data('navigation.group');`
	`130`	`+`
	`131`	`+ return static::normalizeGroupKey($group);`
`129`	`132`	`}`
`130`	`133`
`131`	`134`	`protected static function normalizeGroupKey(?string $group): ?string`