Merge pull request #303 from hydephp/fix-code-issues

Fix minor code issues found by static analyses
hydephp · Jul 31, 2022 · ba6b1e1 · ba6b1e1
2 parents 7997b24 + ad2a8c6
commit ba6b1e1
Show file tree

Hide file tree

Showing 29 changed files with 138 additions and 43 deletions.
diff --git a/.idea/inspectionProfiles/Project_Default.xml b/.idea/inspectionProfiles/Project_Default.xml
diff --git a/.idea/misc.xml b/.idea/misc.xml
diff --git a/RELEASE_NOTES.md b/RELEASE_NOTES.md
@@ -2,12 +2,7 @@
 
 ### About
 
-Keep an Unreleased section at the top to track upcoming changes.
-
-This serves two purposes:
-
-1. People can see what changes they might expect in upcoming releases
-2. At release time, you can move the Unreleased section changes into a new release version section.
+This release refactors and cleans up a large part of the internal code base. For most end users, this will not have any visible effect. If you have developed integrations that depend on methods you may want to take a closer look at the associated pull requests as it is not practical to list them all here.
 
 ### Added
 - internal: Adds methods to the HydeKernelContract interface

diff --git a/packages/framework/src/Application.php b/packages/framework/src/Application.php
@@ -5,6 +5,9 @@
 use Illuminate\Filesystem\Filesystem;
 use Illuminate\Foundation\PackageManifest;
 
+/**
+ * @property mixed $app
+ */
 class Application extends \LaravelZero\Framework\Application
 {
     /**

diff --git a/packages/framework/src/Commands/HydeBuildStaticSiteCommand.php b/packages/framework/src/Commands/HydeBuildStaticSiteCommand.php
@@ -133,8 +133,10 @@ public function runPostBuildActions(): void
     protected function printFinishMessage(float $time_start): void
     {
         $execution_time = (microtime(true) - $time_start);
-        $this->info(sprintf('All done! Finished in %s seconds. (%sms)',
-            number_format($execution_time, 2), number_format($execution_time * 1000, 2)
+        $this->info(sprintf(
+            'All done! Finished in %s seconds. (%sms)',
+            number_format($execution_time, 2),
+            number_format($execution_time * 1000, 2)
         ));
 
         $this->info('Congratulations! 🎉 Your static site has been built!');
@@ -149,10 +151,11 @@ protected function runNodeCommand(string $command, string $message, ?string $act
     {
         $this->info($message.' This may take a second.');
 
-        $output = shell_exec(sprintf('%s%s',
+        $output = shell_exec(sprintf(
+            '%s%s',
             app()->environment() === 'testing' ? 'echo ' : '',
-            $command)
-        );
+            $command
+        ));
 
         $this->line($output ?? sprintf(
             '<fg=red>Could not %s! Is NPM installed?</>',

diff --git a/packages/framework/src/Commands/HydeDebugCommand.php b/packages/framework/src/Commands/HydeDebugCommand.php
@@ -2,6 +2,7 @@
 
 namespace Hyde\Framework\Commands;
 
+use Composer\InstalledVersions;
 use Hyde\Framework\Hyde;
 use LaravelZero\Framework\Commands\Command;
 
@@ -44,8 +45,8 @@ public function handle(): int
 
         $this->newLine();
         $this->comment('Git Version: '.app('git.version'));
-        $this->comment('Hyde Version: '.(\Composer\InstalledVersions::getPrettyVersion('hyde/hyde') ?: 'unreleased'));
-        $this->comment('Framework Version: '.(\Composer\InstalledVersions::getPrettyVersion('hyde/framework') ?: 'unreleased'));
+        $this->comment('Hyde Version: '.(InstalledVersions::getPrettyVersion('hyde/hyde') ?: 'unreleased'));
+        $this->comment('Framework Version: '.(InstalledVersions::getPrettyVersion('hyde/framework') ?: 'unreleased'));
 
         $this->newLine();
         $this->comment('App Env: '.app('env'));

diff --git a/packages/framework/src/Commands/HydeValidateCommand.php b/packages/framework/src/Commands/HydeValidateCommand.php
@@ -6,7 +6,7 @@
 use LaravelZero\Framework\Commands\Command;
 
 /**
- * @see \Hyde\Testing\Feature\Commands\HydeValidateCommandTest
+ * @see \Hyde\Framework\Testing\Feature\Commands\HydeValidateCommandTest
  */
 class HydeValidateCommand extends Command
 {

diff --git a/packages/framework/src/Concerns/HasArticleMetadata.php b/packages/framework/src/Concerns/HasArticleMetadata.php
@@ -4,7 +4,6 @@
 
 use Hyde\Framework\Contracts\RouteContract;
 use Hyde\Framework\Hyde;
-use Hyde\Framework\Models\Pages\MarkdownPost;
 
 /**
  * Generates article metadata for a MarkdownPost.

diff --git a/packages/framework/src/Concerns/HasAuthor.php b/packages/framework/src/Concerns/HasAuthor.php
@@ -19,8 +19,8 @@ public function constructAuthor(): void
     {
         if (isset($this->matter['author'])) {
             if (is_string($this->matter['author'])) {
-                // If the author is a string, we assume it's a username
-                // and we'll try to find the author in the config
+                // If the author is a string, we assume it's a username,
+                // so we'll try to find the author in the config
                 $this->author = $this->findAuthor($this->matter['author']);
             }
             if (is_array($this->matter['author'])) {

diff --git a/packages/framework/src/Concerns/HasPageMetadata.php b/packages/framework/src/Concerns/HasPageMetadata.php
@@ -116,7 +116,8 @@ public function hasOpenGraphTitleInConfig(): bool
 
     protected function makeRssFeedLink(): string
     {
-        return sprintf('<link rel="alternate" type="application/rss+xml" title="%s" href="%s" />',
+        return sprintf(
+            '<link rel="alternate" type="application/rss+xml" title="%s" href="%s" />',
             RssFeedService::getDescription(),
             Hyde::url(RssFeedService::getDefaultOutputFilename())
         );

diff --git a/packages/framework/src/Contracts/AbstractBuildTask.php b/packages/framework/src/Contracts/AbstractBuildTask.php
@@ -5,11 +5,6 @@
 use Illuminate\Console\Concerns\InteractsWithIO;
 use Illuminate\Console\OutputStyle;
 
-/**
- * @experimental This feature was recently added and may be changed without notice.
- *
- * @since 0.40.0
- */
 abstract class AbstractBuildTask implements BuildTaskContract
 {
     use InteractsWithIO;

diff --git a/packages/framework/src/Exceptions/FileConflictException.php b/packages/framework/src/Exceptions/FileConflictException.php
@@ -12,5 +12,7 @@ class FileConflictException extends Exception
     public function __construct(?string $path = null)
     {
         $this->message = $path ? "File already exists: $path" : $this->message;
+
+        parent::__construct($this->message, $this->code);
     }
 }
diff --git a/packages/framework/src/Exceptions/FileNotFoundException.php b/packages/framework/src/Exceptions/FileNotFoundException.php
@@ -12,5 +12,7 @@ class FileNotFoundException extends Exception
     public function __construct(?string $path = null)
     {
         $this->message = $path ? "File $path not found." : $this->message;
+
+        parent::__construct($this->message, $this->code);
     }
 }
diff --git a/packages/framework/src/Models/MarkdownDocument.php b/packages/framework/src/Models/MarkdownDocument.php
@@ -9,7 +9,7 @@
 use Illuminate\Support\Arr;
 
 /**
- * @see \Hyde\Framework\Testing\MarkdownDocumentTest
+ * @see \Hyde\Framework\Testing\Unit\MarkdownDocumentTest
  */
 class MarkdownDocument implements MarkdownDocumentContract
 {

diff --git a/packages/framework/src/Models/NavItem.php b/packages/framework/src/Models/NavItem.php
@@ -13,7 +13,7 @@
  * You have a few options to construct a navigation menu item:
  *   1. You can supply a Route directly and explicit properties to the constructor
  *   2. You can use NavItem::fromRoute() to use data from the route
- *   3. You can use NavItem::leadsTo(URI, Title, ?priority) for an external or unrouted link
+ *   3. You can use NavItem::leadsTo(URI, Title, ?priority) for an external or un-routed link
  */
 class NavItem
 {

diff --git a/packages/framework/src/Models/NavigationMenu.php b/packages/framework/src/Models/NavigationMenu.php
@@ -20,7 +20,7 @@ public function __construct()
         $this->items = new Collection();
     }
 
-    public static function create(?RouteContract $currentRoute = null): static
+    public static function create(): static
     {
         return (new static())->generate()->filter()->sort();
     }

diff --git a/packages/framework/src/Models/Pages/DocumentationPage.php b/packages/framework/src/Models/Pages/DocumentationPage.php
@@ -23,7 +23,7 @@ class DocumentationPage extends AbstractMarkdownPage
     public ?string $category;
 
     /**
-     * The path to the page relative to the configured docs directory.
+     * The path to the page relative to the configured `_docs` directory.
      * Generally only needed if the page is in a subdirectory.
      */
     public ?string $localPath;

diff --git a/packages/framework/src/Models/Parsers/DocumentationPageParser.php b/packages/framework/src/Models/Parsers/DocumentationPageParser.php
@@ -9,7 +9,7 @@
 use Illuminate\Support\Str;
 
 /**
- * Parses a Markdown file in the configured docs directory into a DocumentationPage object.
+ * Parses a Markdown file in the configured `_docs` directory into a DocumentationPage object.
  *
  * If the file is in a subdirectory relative to the base source directory (default _docs),
  * the subdirectory name will be used as the page's category. This only works for one level,

diff --git a/packages/framework/src/Models/ValidationResult.php b/packages/framework/src/Models/ValidationResult.php
@@ -3,8 +3,8 @@
 namespace Hyde\Framework\Models;
 
 /**
- * @see \Hyde\Testing\Feature\Services\ValidationServiceTest
- * @see \Hyde\Testing\Feature\Commands\HydeValidateCommandTest
+ * @see \Hyde\Framework\Testing\Feature\Services\ValidationServiceTest
+ * @see \Hyde\Framework\Testing\Feature\Commands\HydeValidateCommandTest
  */
 class ValidationResult
 {

diff --git a/packages/framework/src/Modules/DataCollections/DataCollection.php b/packages/framework/src/Modules/DataCollections/DataCollection.php
@@ -3,7 +3,6 @@
 namespace Hyde\Framework\Modules\DataCollections;
 
 use Hyde\Framework\Hyde;
-use Hyde\Framework\Models\MarkdownDocument;
 use Hyde\Framework\Services\MarkdownFileService;
 use Illuminate\Support\Collection;
 

diff --git a/packages/framework/src/Services/BuildService.php b/packages/framework/src/Services/BuildService.php
@@ -58,7 +58,8 @@ public function transferMediaAssets(): void
         $collection = DiscoveryService::getMediaAssetFiles();
         $this->comment('Transferring Media Assets...');
 
-        $this->withProgressBar($collection,
+        $this->withProgressBar(
+            $collection,
             function ($filepath) {
                 copy($filepath, Hyde::getSiteOutputPath('media/'.basename($filepath)));
             }
@@ -80,7 +81,8 @@ protected function compilePagesForClass(string $pageClass): void
         $collection = $this->router->getRoutesForModel($pageClass);
 
         $this->withProgressBar(
-            $collection, $this->compileRoute()
+            $collection,
+            $this->compileRoute()
         );
 
         $this->newLine(2);
@@ -122,7 +124,7 @@ protected function askIfUnsafeDirectoryShouldBeEmptied(): bool
         return $this->confirm(sprintf(
             'The configured output directory (%s) is potentially unsafe to empty. '.
             'Are you sure you want to continue?',
-            Hyde::getSiteOutputPath())
-        );
+            Hyde::getSiteOutputPath()
+        ));
     }
 }
diff --git a/packages/framework/src/Services/DiscoveryService.php b/packages/framework/src/Services/DiscoveryService.php
@@ -111,10 +111,10 @@ public static function getDocumentationPageFiles(): array
     public static function getMediaAssetFiles(): array
     {
         return glob(Hyde::path('_media/*.{'.str_replace(
-                ' ',
-                '',
-                config('hyde.media_extensions', 'png,svg,jpg,jpeg,gif,ico,css,js')
-            ).'}'), GLOB_BRACE);
+            ' ',
+            '',
+            config('hyde.media_extensions', 'png,svg,jpg,jpeg,gif,ico,css,js')
+        ).'}'), GLOB_BRACE);
     }
 
     /**

diff --git a/packages/framework/src/Services/RoutingService.php b/packages/framework/src/Services/RoutingService.php
@@ -82,7 +82,7 @@ public function getRoutesForModel(string $pageClass): Collection
 
     /**
      * This internal method adds the specified route to the route index.
-     * It's made publics so package developers can hook into the routing system.
+     * It's made public so package developers can hook into the routing system.
      */
     public function addRoute(RouteContract $route): self
     {

diff --git a/packages/framework/src/Services/RssFeedService.php b/packages/framework/src/Services/RssFeedService.php
@@ -1,5 +1,7 @@
 <?php
 
+/** @noinspection PhpComposerExtensionStubsInspection */
+
 namespace Hyde\Framework\Services;
 
 use Hyde\Framework\Helpers\Features;
@@ -18,6 +20,10 @@ class RssFeedService
 
     public function __construct()
     {
+        if (! extension_loaded('simplexml') || config('testing.mock_disabled_extensions', false) === true) {
+            throw new \Exception('The ext-simplexml extension is not installed, but is required to generate RSS feeds.');
+        }
+
         $this->feed = new SimpleXMLElement('<?xml version="1.0" encoding="UTF-8"?>
             <rss version="2.0" xmlns:atom="http://www.w3.org/2005/Atom" xmlns:dc="http://purl.org/dc/elements/1.1/" />');
         $this->feed->addChild('channel');

diff --git a/packages/framework/src/Services/SitemapService.php b/packages/framework/src/Services/SitemapService.php
@@ -1,5 +1,7 @@
 <?php
 
+/** @noinspection PhpComposerExtensionStubsInspection */
+
 namespace Hyde\Framework\Services;
 
 use Hyde\Framework\Contracts\RouteContract;
@@ -23,6 +25,10 @@ class SitemapService
 
     public function __construct()
     {
+        if (! extension_loaded('simplexml') || config('testing.mock_disabled_extensions', false) === true) {
+            throw new \Exception('The ext-simplexml extension is not installed, but is required to generate RSS feeds.');
+        }
+
         $this->time_start = microtime(true);
 
         $this->xmlElement = new SimpleXMLElement('<?xml version="1.0" encoding="UTF-8"?><urlset xmlns="https://www.sitemaps.org/schemas/sitemap/0.9"></urlset>');

diff --git a/packages/framework/src/Services/ValidationService.php b/packages/framework/src/Services/ValidationService.php
@@ -7,8 +7,8 @@
 use Hyde\Framework\Models\ValidationResult as Result;
 
 /**
- * @see \Hyde\Testing\Feature\Services\ValidationServiceTest
- * @see \Hyde\Testing\Feature\Commands\HydeValidateCommandTest
+ * @see \Hyde\Framework\Testing\Feature\Services\ValidationServiceTest
+ * @see \Hyde\Framework\Testing\Feature\Commands\HydeValidateCommandTest
  */
 class ValidationService
 {

diff --git a/packages/framework/src/Views/Components/LinkComponent.php b/packages/framework/src/Views/Components/LinkComponent.php
@@ -3,6 +3,8 @@
 namespace Hyde\Framework\Views\Components;
 
 use Hyde\Framework\Hyde;
+use Illuminate\Contracts\View\Factory;
+use Illuminate\Contracts\View\View;
 use Illuminate\View\Component;
 
 class LinkComponent extends Component
@@ -14,7 +16,7 @@ public function __construct(string $href)
         $this->href = Hyde::relativeLink($href);
     }
 
-    public function render(): \Illuminate\Contracts\View\View|\Illuminate\Contracts\View\Factory
+    public function render(): View|Factory
     {
         return view('hyde::components.link');
     }