refactor: update services to avoid the stan errors

ploi · Nov 9, 2024 · 67ed9f1 · 67ed9f1
1 parent d99f68b
commit 67ed9f1
Show file tree

Hide file tree

Showing 6 changed files with 44 additions and 13 deletions.
diff --git a/app/Services/GitHubService.php b/app/Services/GitHubService.php
@@ -9,7 +9,11 @@
 
 class GitHubService
 {
-    public function getRepositories(?string $searchQuery = null): Collection
+    /**
+     * @param string $searchQuery
+     * @return Collection<int|string, mixed>
+     */
+    public function getRepositories(string $searchQuery = ''): Collection
     {
         if (!$this->isEnabled()) {
             return collect();
@@ -31,10 +35,15 @@ public function getRepositories(?string $searchQuery = null): Collection
 
     public function isEnabled(): bool
     {
-        return config('github.enabled');
+        return (bool) config('github.enabled');
     }
 
-    public function getIssuesForRepository(?string $repository, ?string $searchQuery = null): Collection
+    /**
+     * @param string|null $repository
+     * @param string $searchQuery
+     * @return Collection<int|string, string>
+     */
+    public function getIssuesForRepository(?string $repository, string $searchQuery = ''): Collection
     {
         if (!$this->isEnabled() || $repository === null) {
             return collect();
@@ -76,7 +85,7 @@ public function getIssueTitle(?string $repository, ?int $issueNumber): ?string
         }
     }
 
-    public function createIssueInRepository(string $repository, $title, $body): int
+    public function createIssueInRepository(string $repository, string $title, string $body): int
     {
         $repo = str($repository)->explode('/');
 

diff --git a/app/Services/OgImageGenerator.php b/app/Services/OgImageGenerator.php
@@ -18,9 +18,13 @@ class OgImageGenerator
     private ?string $templateFile = null;
 
     private bool   $polygonEnabled = false;
+
+    /**
+     * @var array<int>|null
+     */
     private ?array $polygonPoints  = null;
 
-    public static function make(?string $title): self
+    public static function make(string $title): self
     {
         return new self($title);
     }
@@ -58,6 +62,10 @@ public function withFilename(?string $filename): self
         return $this;
     }
 
+    /**
+     * @param array<int>|null $points
+     * @return $this
+     */
     public function withPolygonDecoration(?array $points = null): static
     {
         $this->polygonEnabled = true;
@@ -76,7 +84,7 @@ public function getFilename(): string
             $this->filename = 'og-' . $this->filename;
         }
 
-        return $this->filename ?? 'og-' . md5(time()) . '.jpg';
+        return $this->filename ?? 'og-' . md5((string) time()) . '.jpg';
     }
 
     public function generate(): OgImage

diff --git a/app/Services/SystemChecker.php b/app/Services/SystemChecker.php
@@ -12,20 +12,20 @@ class SystemChecker
 
     public function getVersions(): self
     {
-        $this->remoteVersion = trim($this->getRemoteVersion());
-        $this->currentVersion = trim($this->getApplicationVersion());
+        $this->remoteVersion = trim((string) $this->getRemoteVersion());
+        $this->currentVersion = trim((string) $this->getApplicationVersion());
 
         return $this;
     }
 
-    public function getApplicationVersion(): string|null
+    public function getApplicationVersion(): string|null|bool
     {
         return cache()->remember($this->cacheKeyCurrent, now()->addDay(), function () {
             return shell_exec('git describe --tag --abbrev=0');
         });
     }
 
-    public function getRemoteVersion(): string|null
+    public function getRemoteVersion(): string|null|bool
     {
         return cache()->remember($this->cacheKeyRemote, now()->addDay(), function () {
             shell_exec('git fetch --tags');

diff --git a/app/Services/Tailwind.php b/app/Services/Tailwind.php
@@ -8,8 +8,14 @@
 
 class Tailwind
 {
+    /**
+     * @var array<string, string>
+     */
     public array $shades = [];
 
+    /**
+     * @var array<int, float>
+     */
     protected array $intensityMap = [
         50 => 0.95,
         100 => 0.9,
@@ -36,7 +42,7 @@ public function getCssFormat(): string
             if ($this->name === 'primary') {
                 $color = Str::between($color, '(', ')');
             }
-            
+
             $output .= "\t--color-{$shade}: {$color};" . PHP_EOL;
         }
 
@@ -46,7 +52,12 @@ public function getCssFormat(): string
         return $output;
     }
 
-    public function generateColorShades(string $name, ?string $baseColor): array
+    /**
+     * @param string $name
+     * @param string $baseColor
+     * @return array<string, string>
+     */
+    public function generateColorShades(string $name, string $baseColor = ''): array
     {
         $baseColor = Hex::fromString($baseColor);
 

diff --git a/app/Traits/HasOgImage.php b/app/Traits/HasOgImage.php
@@ -8,7 +8,7 @@ trait HasOgImage
 {
     public function getOgImage(?string $description, string $subject = 'Roadmap'): string
     {
-        return OgImageGenerator::make($this->title)
+        return OgImageGenerator::make($this->title ?? '')
                                ->withSubject($subject)
                                ->withDescription($description)
                                ->withPolygonDecoration()

diff --git a/phpstan.neon b/phpstan.neon
@@ -8,3 +8,6 @@ parameters:
     excludePaths:
         - ./app/Spotlight
         - ./app/SocialProviders
+        - ./app/Settings
+        - ./app/Services/Icons.php
+        - ./app/Services/GitHubService.php