refactor(Commands): change variables to class attributes

Author: Wtyd

qa/phpstan.neon

@@ -1,5 +1,3 @@
-# Phpqa copia este fichero de configuracion y lo ejecuta desde el directorio "build"
-# currentWorkingDirectory es donde se ejecuta phpstan, en este caso desde ./
 {
     parameters: {
         level: 8
@@ -10,7 +8,7 @@
         checkMissingIterableValueType: false
         ignoreErrors: [
            '#Method [a-zA-Z0-9\\_]+Command::handle\(\)#',
-           '#root of method GitHooks\Commands\HookCommand::[a-zA-Z0-9\\_]+() expects string, string|false given#'
+            '#Property [a-zA-Z0-9\\_]+Command::\$root \(string\) does not accept string\|false.#'
         ]
         excludes_analyse: [
             # Exclude all files relatives to Artisan Console

src/Commands/CleanHookCommand.php

@@ -10,6 +10,12 @@ class CleanHookCommand extends Command
 {
     protected $signature = 'hook:clean  {hook=pre-commit}';
     protected $description = 'Deletes the hook passed as argument (default pre-commit)';
+
+    /**
+     * Extra information about the command invoked with the --help flag.
+     *
+     * @var string
+     */
     protected $help = 'Without arguments deletes the pre-commit hook. A optional argument can be the name of another hook. Example: hook:clean pre-push.';
 
     /**

src/Commands/CreateHookCommand.php

@@ -11,6 +11,12 @@ class CreateHookCommand extends Command
 {
     protected $signature = 'hook  {hook=pre-commit : The hook to be setted} {scriptFile? : The custom script to be setted as the hook (default:GitHooks)}';
     protected $description = 'Copies the hook for the GitHooks execution. The default hook is pre-commit. You can pass scriptFile as argument to set custom scripts.';
+
+    /**
+     * Extra information about the command invoked with the --help flag.
+     *
+     * @var string
+     */
     protected $help = 'The default script is the default GitHooks execution. You can custom your script to execute what ever you want.
 Even the default script and after, other tools which GitHooks not support or vice versa';
 
@@ -19,6 +25,27 @@ class CreateHookCommand extends Command
      */
     protected $printer;
 
+    /**
+     * Path to the root project
+     *
+     * @var string
+     */
+    protected $root;
+
+    /**
+     * First argument. The hook that will be setted.
+     *
+     * @var string
+     */
+    protected $hook;
+
+    /**
+     * Second argument. The custom script to be setted as the hook. Per default is the GitHooks script to execute the tools setted in githooks.yml file.
+     *
+     * @var string
+     */
+    protected $scriptFile;
+
     public function __construct(Printer $printer)
     {
         $this->printer = $printer;
@@ -27,46 +54,42 @@ public function __construct(Printer $printer)
 
     public function handle()
     {
-        $root = getcwd();
-        $hook = strval($this->argument('hook'));
-        $scriptFile = $this->argument('scriptFile') ?? '';
-
+        $this->root = getcwd();
+        $this->hook = strval($this->argument('hook'));
+        $this->scriptFile = strval($this->argument('scriptFile')) ?? '';
 
-        if (!Hooks::validate($hook)) {
-            $this->printer->error("'$hook' is not a valid git hook. Avaliable hooks are:");
+        if (!Hooks::validate($this->hook)) {
+            $this->printer->error("'{$this->hook}' is not a valid git hook. Avaliable hooks are:");
             $this->printer->error(implode(', ', Hooks::HOOKS));
             return;
         }
 
-        $origin = $this->path2OriginFile($root, strval($scriptFile));
+        $origin = $this->path2OriginFile();
         try {
-            $destiny = "$root/.git/hooks/$hook";
+            $destiny = "{$this->root}/.git/hooks/{$this->hook}";
             copy($origin, $destiny);
             chmod($destiny, 0755);
-            $this->printer->success("Hook $hook created");
+            $this->printer->success("Hook {$this->hook} created");
         } catch (\Throwable $th) {
-            $this->printer->error("Error copying $origin in $hook");
+            $this->printer->error("Error copying $origin in {$this->hook}");
         }
     }
 
     /**
      * Find the origin of the scripts for the hook
      *
-     * @param string $root Path to the root of the project.
-     * @param string $scriptFile File with the custom script. It's optional.
-     *
      * @return string File to be executed in the hook.
      */
-    public function path2OriginFile(string $root, string $scriptFile): string
+    public function path2OriginFile(): string
     {
         $origin = '';
-        if (empty($scriptFile)) {
-            $origin = $this->defaultPrecommit($root);
+        if (empty($this->scriptFile)) {
+            $origin = $this->defaultPrecommit();
         } else {
-            if (!file_exists($scriptFile)) {
-                throw new Exception("$scriptFile file not found");
+            if (!file_exists($this->scriptFile)) {
+                throw new Exception("{$this->scriptFile} file not found");
             }
-            $origin = $scriptFile;
+            $origin = $this->scriptFile;
         }
         return $origin;
     }
@@ -76,19 +99,17 @@ public function path2OriginFile(string $root, string $scriptFile): string
      * 1. When GitHooks will be a library, it returns the path through 'vendor'.
      * 2. To work on developing GitHooks itself, it will return the local path to 'hooks'
      *
-     * @param string $root Root path of the project.
-     *
      * @return string The default script to run GitHooks in the hook.
      */
-    public function defaultPrecommit(string $root): string
+    public function defaultPrecommit(): string
     {
         $origin = '';
-        if (file_exists($root . '/vendor/wtyd/githooks/hooks/pre-commit.php')) {
-            $origin = $root . '/vendor/wtyd/githooks/hooks/pre-commit.php';
+        if (file_exists($this->root . '/vendor/wtyd/githooks/hooks/pre-commit.php')) {
+            $origin = $this->root . '/vendor/wtyd/githooks/hooks/pre-commit.php';
         }
 
-        if (file_exists($root . '/hooks/pre-commit.php')) {
-            $origin = $root . '/hooks/pre-commit.php';
+        if (file_exists($this->root . '/hooks/pre-commit.php')) {
+            $origin = $this->root . '/hooks/pre-commit.php';
         }
 
         if (empty($origin)) {