Merge pull request #7 from Xoshbin/develop

fix: resolve PHPStan errors and Request deprecations

Author: Xoshbin

config/pertuk.php

@@ -46,7 +46,7 @@
     ],
 
     // GitHub Repo & Branch for "Edit on GitHub" links
-    'github_repo' => env('PERTUK_GITHUB_REPO', 'username/repo'),
-    'github_branch' => env('PERTUK_GITHUB_BRANCH', 'main'),
+    'github_repo' => env('PERTUK_GITHUB_REPO', 'username/repo'), // @phpstan-ignore-line
+    'github_branch' => env('PERTUK_GITHUB_BRANCH', 'main'), // @phpstan-ignore-line
 
 ];

src/Http/Controllers/LocaleController.php

@@ -42,7 +42,7 @@ public function setLocale(Request $request, string $locale): Response|JsonRespon
         }
 
         // Standard redirection
-        $redirectUrl = $request->get('redirect') ?: $request->header('referer');
+        $redirectUrl = $request->input('redirect') ?: $request->header('referer');
 
         if ($redirectUrl && is_string($redirectUrl) && $this->isDocsUrl($redirectUrl)) {
             return redirect($this->getLocaleEquivalentUrl($redirectUrl, $locale));

src/Services/DocumentationService.php

@@ -217,7 +217,9 @@ public function get(string $locale, string $slug): array
         }
 
         $mtime = File::lastModified($path);
-        $cacheKey = 'pertuk:docs:'.$locale.':'.md5($path.':'.$mtime);
+        // Use realpath to ensure consistent cache keys regardless of symlinks/relative paths
+        $realPath = realpath($path) ?: $path;
+        $cacheKey = 'pertuk:docs:'.$locale.':'.md5($realPath.':'.$mtime);
 
         // Get cached value and validate it
         $cached = Cache::get($cacheKey);
@@ -247,6 +249,12 @@ private function isValidCachedDocument(mixed $data): bool
     private function generateDocumentData(string $path, string $locale, string $slug, int $mtime): array
     {
         $raw = File::get($path);
+
+        // @phpstan-ignore-next-line
+        if (! is_string($raw)) {
+            throw new \RuntimeException("Failed to read file: {$path}");
+        }
+
         try {
             $front = YamlFrontMatter::parse($raw);
             $content = $front->body();
@@ -424,15 +432,16 @@ protected function buildAlternates(string $locale, string $slug): array
         $supported = (array) config('pertuk.supported_locales', ['en']);
 
         $labels = (array) config('pertuk.locale_labels', []);
-        $prefix = config('pertuk.route_prefix', 'docs');
+        $prefix = (string) config('pertuk.route_prefix', 'docs');
 
         $alternates = [];
         foreach ($supported as $loc) {
+            $loc = (string) $loc;
             $path = $this->resolvePath($loc, $slug);
             if ($path) {
                 $alternates[] = [
                     'locale' => $loc,
-                    'label' => $labels[$loc] ?? strtoupper($loc),
+                    'label' => (string) ($labels[$loc] ?? strtoupper($loc)),
                     'url' => url('/'.$prefix.'/'.($this->version ? $this->version.'/' : '').$loc.'/'.$slug),
                     'active' => $loc === $locale,
                 ];

tests/Feature/CacheTest.php

@@ -29,7 +29,8 @@
     // Verify cache key exists
     $path = $this->getTestDocsPath().'/en/test-cache.md';
     $mtime = File::lastModified($path);
-    $cacheKey = 'pertuk:docs:en:'.md5($path.':'.$mtime);
+    $realPath = realpath($path) ?: $path;
+    $cacheKey = 'pertuk:docs:en:'.md5($realPath.':'.$mtime);
 
     expect(Cache::has($cacheKey))->toBeTrue();
 });
@@ -75,7 +76,8 @@
     // Verify it's cached
     $path = $this->getTestDocsPath().'/en/test-ttl.md';
     $mtime = File::lastModified($path);
-    $cacheKey = 'pertuk:docs:en:'.md5($path.':'.$mtime);
+    $realPath = realpath($path) ?: $path;
+    $cacheKey = 'pertuk:docs:en:'.md5($realPath.':'.$mtime);
     expect(Cache::has($cacheKey))->toBeTrue();
 
     // Wait for TTL to expire
@@ -102,8 +104,11 @@
     $mtime1 = File::lastModified($path1);
     $mtime2 = File::lastModified($path2);
 
-    $cacheKey1 = 'pertuk:docs:en:'.md5($path1.':'.$mtime1);
-    $cacheKey2 = 'pertuk:docs:en:'.md5($path2.':'.$mtime2);
+    $realPath1 = realpath($path1) ?: $path1;
+    $realPath2 = realpath($path2) ?: $path2;
+
+    $cacheKey1 = 'pertuk:docs:en:'.md5($realPath1.':'.$mtime1);
+    $cacheKey2 = 'pertuk:docs:en:'.md5($realPath2.':'.$mtime2);
 
     expect($cacheKey1)->not->toBe($cacheKey2);
     expect(Cache::has($cacheKey1))->toBeTrue();
@@ -146,7 +151,8 @@
     // Manually corrupt the cache
     $path = $this->getTestDocsPath().'/en/cache-corruption.md';
     $mtime = File::lastModified($path);
-    $cacheKey = 'pertuk:docs:en:'.md5($path.':'.$mtime);
+    $realPath = realpath($path) ?: $path;
+    $cacheKey = 'pertuk:docs:en:'.md5($realPath.':'.$mtime);
 
     Cache::put($cacheKey, 'corrupted-data', 60);
 

tests/Feature/FileReadingTest.php

@@ -156,7 +156,7 @@
     $filePath = $this->createTestMarkdownFile('test-permissions.md', "# Test\n\nContent");
 
     // Make file unreadable (this might not work on all systems)
-    if (chmod($filePath, 0000)) {
+    if (chmod($filePath, 0000) && ! is_readable($filePath)) {
         $service = DocumentationService::make();
 
         // Should handle the error gracefully
@@ -166,8 +166,8 @@
         // Restore permissions for cleanup
         chmod($filePath, 0644);
     } else {
-        // Skip test if we can't change permissions
-        $this->markTestSkipped('Cannot change file permissions on this system');
+        // Skip test if we can't change permissions or it's still readable (e.g. root)
+        $this->markTestSkipped('Cannot make file unreadable on this system');
     }
 });