Merge pull request #440 from hydephp/code-cleanup

Code cleanup without affecting functionality

src/Actions/FindsContentLengthForImageObject.php

@@ -5,6 +5,7 @@
 use Hyde\Framework\Contracts\ActionContract;
 use Hyde\Framework\Models\Image;
 use Illuminate\Support\Facades\Http;
+use Symfony\Component\Console\Output\ConsoleOutput;
 use Symfony\Component\Console\Output\OutputInterface;
 
 /**
@@ -23,7 +24,7 @@ public function __construct(Image $image)
     {
         $this->image = $image;
 
-        $this->output = new \Symfony\Component\Console\Output\ConsoleOutput();
+        $this->output = new ConsoleOutput();
     }
 
     public function execute(): int

src/Actions/GeneratesNavigationMenu.php

@@ -6,7 +6,6 @@
 use Hyde\Framework\Hyde;
 use Hyde\Framework\Services\CollectionService;
 use Illuminate\Support\Str;
-use JetBrains\PhpStorm\Pure;
 
 /**
  * Generate the dynamic navigation menu.
@@ -152,7 +151,6 @@ public function getTitleFromSlug(string $slug): string
      *
      * @return array
      */
-    #[Pure]
     private function getListOfCustomPages(): array
     {
         return array_unique(

src/Actions/MarkdownConverter.php

@@ -12,7 +12,6 @@ class MarkdownConverter
     /**
      * Parse the Markdown into HTML.
      *
-     * @param  string  $markdown
      * @return string $html
      */
     public static function parse(string $markdown, ?string $sourceModel = null): string

src/Commands/HydeDebugCommand.php

@@ -29,7 +29,7 @@ public function __construct()
         parent::__construct();
 
         if (config('app.env', 'production') !== 'development') {
-            $this->setHidden(true);
+            $this->setHidden();
         }
     }
 

src/Commands/HydeRebuildStaticSiteCommand.php

@@ -129,7 +129,7 @@ public function handleException(Exception $exception): int
      * Get the output path for the given source file path.
      * Will fall back to the input path when using non-standard source paths.
      *
-     * @deprecated, reimplementing path information in StaticPageBuilder,
+     * @deprecated reimplementing path information in StaticPageBuilder,
      *              alternatively, recreating in the DiscoveryService
      *
      * @param  string  $path

src/Concerns/Commands/AsksToRebuildSite.php

@@ -9,7 +9,7 @@
  */
 trait AsksToRebuildSite
 {
-    protected function askToRebuildSite()
+    protected function askToRebuildSite(): void
     {
         if ($this->option('no-interaction')) {
             return;

src/Concerns/GeneratesPageMetadata.php

@@ -4,8 +4,8 @@
 
 use Hyde\Framework\Hyde;
 use Hyde\Framework\Models\MarkdownPost;
-use Hyde\Framework\Models\Metadata;
 use Hyde\Framework\Services\AuthorService;
+use Tests\TestCase;
 
 /**
  * Generates metadata for page models that have front matter.
@@ -22,7 +22,7 @@ public function constructMetadata(): void
     {
         $this->parseFrontMatterMetadata();
 
-        if ($this instanceof MarkdownPost || $this instanceof \Tests\TestCase) {
+        if ($this instanceof MarkdownPost || $this instanceof TestCase) {
             $this->makeOpenGraphPropertiesForArticle();
         }
     }

src/Concerns/HasDateString.php

@@ -13,6 +13,9 @@ trait HasDateString
 {
     public ?DateString $date = null;
 
+    /**
+     * @throws \Exception
+     */
     public function constructDateString(): void
     {
         if (isset($this->matter['date'])) {

src/Concerns/HasTableOfContents.php

@@ -5,7 +5,7 @@
 use Hyde\Framework\Actions\GeneratesTableOfContents;
 
 /**
- * Generate a Table of Contents HTML string from a Markdown document body.
+ * Generate Table of Contents as HTML from a Markdown document body.
  *
  * @see \Tests\Unit\HasTableOfContentsTest
  */

src/Concerns/Internal/AssetManager.php

@@ -14,7 +14,7 @@ trait AssetManager
     /**
      * Get the asset service instance.
      *
-     * @return \Hyde\Framework\Services\AssetServiceContract
+     * @return \Hyde\Framework\Contracts\AssetServiceContract
      */
     public static function assetManager(): AssetServiceContract
     {

src/Concerns/Internal/BuildActionRunner.php

@@ -31,7 +31,7 @@ protected function canRunBuildAction(array $collection, string $name, ?string $v
     }
 
     /** @internal */
-    protected function runBuildAction(string $model)
+    protected function runBuildAction(string $model): void
     {
         $collection = CollectionService::getSourceFileListForModel($model);
         $modelName = $this->getModelPluralName($model);

src/Concerns/RegistersDefaultDirectories.php

@@ -2,16 +2,20 @@
 
 namespace Hyde\Framework\Concerns;
 
+use Hyde\Framework\Contracts\AbstractPage;
+
 trait RegistersDefaultDirectories
 {
     /**
      * Register the default directories.
      *
+     * @param  array  $directoryMapping
      * @return void
      */
-    protected function registerDefaultDirectories(array $directoryMapping)
+    protected function registerDefaultDirectories(array $directoryMapping): void
     {
         foreach ($directoryMapping as $class => $location) {
+            /** @var AbstractPage $class */
             $class::$sourceDirectory = $location;
         }
     }

src/Concerns/ValidatesExistence.php

@@ -6,7 +6,7 @@
 use Hyde\Framework\Hyde;
 
 /**
- * Validate the existance of a Page model's source file.
+ * Validate the existence of a Page model's source file.
  */
 trait ValidatesExistence
 {
@@ -17,6 +17,7 @@ trait ValidatesExistence
      */
     public function validateExistence(string $model, string $slug): void
     {
+        /** @var \Hyde\Framework\Contracts\AbstractPage $model */
         $filepath = $model::$sourceDirectory.'/'.
             $slug.$model::$fileExtension;
 

src/Contracts/AbstractPage.php

@@ -18,6 +18,8 @@ abstract class AbstractPage
     public static string $fileExtension;
     public static string $parserClass;
 
+    public string $slug;
+
     public function getCurrentPagePath(): string
     {
         return $this->slug;

src/Hyde.php

@@ -53,6 +53,9 @@ public static function titleFromSlug(string $slug): string
         return Str::title(str_replace('-', ' ', ($slug)));
     }
 
+    /**
+     * @throws \Exception
+     */
     public static function getLatestPosts(): Collection
     {
         $collection = new Collection();

src/HydeServiceProvider.php

@@ -25,7 +25,7 @@ class HydeServiceProvider extends ServiceProvider
      *
      * @return void
      */
-    public function register()
+    public function register(): void
     {
         /**
          * @deprecated
@@ -84,7 +84,7 @@ function () {
      *
      * @return void
      */
-    public function boot()
+    public function boot(): void
     {
         if (config('hyde.create_default_directories', true)) {
             (new CreatesDefaultDirectories)->__invoke();

src/Models/MarkdownPost.php

@@ -21,6 +21,9 @@ class MarkdownPost extends MarkdownDocument
     public static string $sourceDirectory = '_posts';
     public static string $parserClass = MarkdownPostParser::class;
 
+    /**
+     * @throws \Exception
+     */
     public function __construct(array $matter, string $body, string $title = '', string $slug = '')
     {
         parent::__construct($matter, $body, $title, $slug);

src/Services/AuthorService.php

@@ -38,7 +38,7 @@ public function __construct()
      *
      * If the file does not exist, it will be created.
      */
-    public function publishFile()
+    public function publishFile(): void
     {
         file_put_contents($this->filepath, <<<'EOF'
 # In this file you can declare custom authors.

src/Services/DiscoveryService.php

@@ -2,6 +2,7 @@
 
 namespace Hyde\Framework\Services;
 
+use Hyde\Framework\Contracts\AbstractPage;
 use Hyde\Framework\Models\BladePage;
 use Hyde\Framework\Models\DocumentationPage;
 use Hyde\Framework\Models\MarkdownPage;
@@ -16,6 +17,7 @@ class DiscoveryService
 {
     public static function getParserClassForModel(string $model): string
     {
+        /** @var AbstractPage $model */
         return $model::$parserClass;
     }
 
@@ -31,6 +33,7 @@ public static function getParserClassForModel(string $model): string
      */
     public static function getParserInstanceForModel(string $model, string $slug): object
     {
+        /** @var AbstractPage $model */
         return new $model::$parserClass($slug);
     }
 
@@ -39,6 +42,7 @@ public static function getParserInstanceForModel(string $model, string $slug): o
      */
     public static function getFileExtensionForModelFiles(string $model): string
     {
+        /** @var AbstractPage $model */
         return $model::$fileExtension;
     }
 
@@ -47,6 +51,7 @@ public static function getFileExtensionForModelFiles(string $model): string
      */
     public static function getFilePathForModelClassFiles(string $model): string
     {
+        /** @var AbstractPage $model */
         return $model::$sourceDirectory;
     }
 

src/Services/RssFeedService.php

@@ -24,6 +24,9 @@ public function __construct()
         $this->addInitialChannelItems();
     }
 
+    /**
+     * @throws \Exception
+     */
     public function generate(): self
     {
         /** @var MarkdownPost $post */

src/Services/SitemapService.php

@@ -17,6 +17,7 @@
 class SitemapService
 {
     public SimpleXMLElement $xmlElement;
+    protected float $time_start;
 
     public function __construct()
     {
@@ -82,6 +83,7 @@ public function addPageModelUrls(string $pageClass, string $routePrefix = ''): v
     protected function getLastModDate(string $pageClass, string $slug): string
     {
         return date('c', filemtime(
+            /** @var \Hyde\Framework\Contracts\AbstractPage $pageClass */
             Hyde::path($pageClass::$sourceDirectory.DIRECTORY_SEPARATOR.$slug.$pageClass::$fileExtension)
         ));
     }