Refactor Specs task for better code organization

ChiragAgg5k · ChiragAgg5k · commit b791941f8e66 · 2025-12-13T21:56:23.000+05:30
- Extract platform, auth counts, and keys into separate methods
- Add getPlatforms(), getAuthCounts(), and getKeys() methods
- Extract SDK platform logic into getSDKPlatformsForRouteSecurity()
- Add PHPDoc comments with proper type hints
- Move constructor to top of class for better readability
diff --git a/src/Appwrite/Platform/Tasks/Specs.php b/src/Appwrite/Platform/Tasks/Specs.php
@@ -28,6 +28,15 @@
 
 class Specs extends Action
 {
+    public function __construct()
+    {
+        $this
+            ->desc('Generate Appwrite API specifications')
+            ->param('version', 'latest', new Text(16), 'Spec version', true)
+            ->param('mode', 'normal', new WhiteList(['normal', 'mocks']), 'Spec Mode', true)
+            ->callback($this->action(...));
+    }
+
     public static function getName(): string
     {
         return 'specs';
@@ -52,40 +61,43 @@ protected function getFormatInstance(string $format, array $arguments)
         };
     }
 
-    public function __construct()
+    /**
+     * Platforms
+     *
+     * @return array{client: string, server: string, console: string}
+     */
+    protected function getPlatforms(): array
     {
-        $this
-            ->desc('Generate Appwrite API specifications')
-            ->param('version', 'latest', new Text(16), 'Spec version', true)
-            ->param('mode', 'normal', new WhiteList(['normal', 'mocks']), 'Spec Mode', true)
-            ->callback($this->action(...));
-    }
-
-    public function action(string $version, string $mode): void
-    {
-        $appRoutes = App::getRoutes();
-        $response = $this->getResponse();
-        $mocks = ($mode === 'mocks');
-
-        // Mock dependencies
-        App::setResource('request', fn () => $this->getRequest());
-        App::setResource('response', fn () => $response);
-        App::setResource('dbForPlatform', fn () => new Database(new MySQL(''), new Cache(new None())));
-        App::setResource('dbForProject', fn () => new Database(new MySQL(''), new Cache(new None())));
-
-        $platforms = [
+        return [
             'client' => APP_PLATFORM_CLIENT,
             'server' => APP_PLATFORM_SERVER,
             'console' => APP_PLATFORM_CONSOLE,
         ];
+    }
 
-        $authCounts = [
+    /**
+     * Number of authentication methods supported by each platform
+     * client: 1 (Session or JWT), server: 2 (Key and JWT), console: 1 (Admin)
+     *
+     * @return array{client: int, console: int, server: int}
+     */
+    protected function getAuthCounts(): array
+    {
+        return [
             'client' => 1,
             'server' => 2,
             'console' => 1,
         ];
+    }
 
-        $keys = [
+    /**
+     * Keys for each platform
+     *
+     * @return array{client: array, server: array, console: array}
+     */
+    protected function getKeys(): array
+    {
+        return [
             APP_PLATFORM_CLIENT => [
                 'Project' => [
                     'type' => 'apiKey',
@@ -189,6 +201,44 @@ public function action(string $version, string $mode): void
                 ],
             ],
         ];
+    }
+
+    protected function getSDKPlatformsForRouteSecurity(array $routeSecurity): array
+    {
+        $sdkPlatforms = [];
+        foreach ($routeSecurity as $value) {
+            switch ($value) {
+                case AuthType::SESSION:
+                    $sdkPlatforms[] = APP_PLATFORM_CLIENT;
+                    break;
+                case AuthType::JWT:
+                case AuthType::KEY:
+                    $sdkPlatforms[] = APP_PLATFORM_SERVER;
+                    break;
+                case AuthType::ADMIN:
+                    $sdkPlatforms[] = APP_PLATFORM_CONSOLE;
+                    break;
+            }
+        }
+        return $sdkPlatforms;
+    }
+
+    public function action(string $version, string $mode): void
+    {
+        $appRoutes = App::getRoutes();
+        /** @var AppwriteResponse $response */
+        $response = $this->getResponse();
+        $mocks = ($mode === 'mocks');
+
+        // Mock dependencies
+        App::setResource('request', fn () => $this->getRequest());
+        App::setResource('response', fn () => $response);
+        App::setResource('dbForPlatform', fn () => new Database(new MySQL(''), new Cache(new None())));
+        App::setResource('dbForProject', fn () => new Database(new MySQL(''), new Cache(new None())));
+
+        $platforms = $this->getPlatforms();
+        $authCounts = $this->getAuthCounts();
+        $keys = $this->getKeys();
 
         foreach ($platforms as $platform) {
             $routes = [];
@@ -215,22 +265,7 @@ public function action(string $version, string $mode): void
                         }
 
                         $routeSecurity = $sdk->getAuth();
-                        $sdkPlatforms = [];
-
-                        foreach ($routeSecurity as $value) {
-                            switch ($value) {
-                                case AuthType::SESSION:
-                                    $sdkPlatforms[] = APP_PLATFORM_CLIENT;
-                                    break;
-                                case AuthType::JWT:
-                                case AuthType::KEY:
-                                    $sdkPlatforms[] = APP_PLATFORM_SERVER;
-                                    break;
-                                case AuthType::ADMIN:
-                                    $sdkPlatforms[] = APP_PLATFORM_CONSOLE;
-                                    break;
-                            }
-                        }
+                        $sdkPlatforms = $this->getSDKPlatformsForRouteSecurity($routeSecurity);
 
                         if (empty($routeSecurity)) {
                             $sdkPlatforms[] = APP_PLATFORM_SERVER;
