Merge pull request #11 from salahhusa9/fun-docs

Fun docs
salahhusa9 · Oct 24, 2023 · bcf4f1a · bcf4f1a
2 parents 4737e7e + 0fcb67e
commit bcf4f1a
Show file tree

Hide file tree

Showing 15 changed files with 174 additions and 19 deletions.
diff --git a/phpstan.neon.dist b/phpstan.neon.dist
diff --git a/src/Contracts/Repository.php b/src/Contracts/Repository.php
@@ -4,11 +4,11 @@
 
 interface Repository
 {
-    public function getLatestVersion();
+    public function getLatestVersion(): string;
 
-    public function getLatestVersionData();
+    public function getLatestVersionData(): \Illuminate\Support\Collection;
 
-    public function getVersions();
+    public function getVersions(): array;
 
-    public function getVersionsData();
+    public function getVersionsData(): \Illuminate\Support\Collection;
 }
diff --git a/src/Facades/Updater.php b/src/Facades/Updater.php
@@ -6,6 +6,13 @@
 
 /**
  * @see \Salahhusa9\Updater\Updater
+ *
+ * @method static string update() Update the application to the latest version
+ * @method static array newVersionAvailable() Check if a new version is available
+ * @method static string getLatestVersion() Get the latest version
+ * @method static string getCurrentVersion() Get the current version
+ * @method static string getLatestVersionData() Get the latest version data
+ * @method static string versions() Get all versions
  */
 class Updater extends Facade
 {

diff --git a/src/Helpers/Git.php b/src/Helpers/Git.php
@@ -7,6 +7,13 @@
 
 class Git
 {
+    /**
+     * getCurrentCommit
+     *
+     * @return string
+     *
+     * @throws \Exception
+     */
     public static function getCurrentCommit()
     {
         $process = Process::run(self::gitPath().' log --pretty="%h" -n1 HEAD');
@@ -18,6 +25,13 @@ public static function getCurrentCommit()
         return trim($process->output());
     }
 
+    /**
+     * getCurrentBranch
+     *
+     * @return string
+     *
+     * @throws \Exception
+     */
     public static function getCurrentBranch()
     {
         $process = Process::run(self::gitPath().' rev-parse --abbrev-ref HEAD');
@@ -29,6 +43,13 @@ public static function getCurrentBranch()
         return trim($process->output());
     }
 
+    /**
+     * getCurrentTag
+     *
+     * @return string
+     *
+     * @throws \Exception
+     */
     public static function getCurrentTag()
     {
         $process = Process::run(self::gitPath().' describe --tags --abbrev=0');
@@ -40,6 +61,13 @@ public static function getCurrentTag()
         return trim($process->output());
     }
 
+    /**
+     * auth
+     *
+     * @return string
+     *
+     * @throws \Exception
+     */
     public static function auth()
     {
         $process = Process::run(self::gitPath().' remote set-url origin https://'.config('updater.github_username').':'.config('updater.github_token').'@github.com/'.config('updater.github_username').'/'.config('updater.github_repository').'.git');
@@ -51,6 +79,13 @@ public static function auth()
         return trim($process->output());
     }
 
+    /**
+     * pull
+     *
+     * @return string
+     *
+     * @throws \Exception
+     */
     public static function pull()
     {
         $process = Process::run(self::gitPath().' pull');
@@ -62,6 +97,14 @@ public static function pull()
         return trim($process->output());
     }
 
+    /**
+     * checkout
+     *
+     * @param  mixed  $branch
+     * @return string
+     *
+     * @throws \Exception
+     */
     public static function checkout($branch)
     {
         $process = Process::run(self::gitPath().' checkout '.$branch);
@@ -73,6 +116,13 @@ public static function checkout($branch)
         return trim($process->output());
     }
 
+    /**
+     * fetch
+     *
+     * @return string
+     *
+     * @throws \Exception
+     */
     public static function fetch()
     {
         $process = Process::run(self::gitPath().' fetch');
@@ -84,6 +134,11 @@ public static function fetch()
         return trim($process->output());
     }
 
+    /**
+     * gitPath
+     *
+     * @return string
+     */
     public static function gitPath()
     {
         $gitPath = config('updater.git_path');

diff --git a/src/Helpers/Helper.php b/src/Helpers/Helper.php
@@ -4,7 +4,12 @@
 
 class Helper
 {
-    public function isVersion($version)
+    /**
+     * isVersion
+     *
+     * @param  mixed  $version
+     */
+    public function isVersion($version): int|false
     {
         $pattern = '/^v(\d+\.\d+\.\d+)(-[a-zA-Z0-9]+(\.\d+)?)?$/';
 

diff --git a/src/Pipelines/ArtisanCallCacheClearPipe.php b/src/Pipelines/ArtisanCallCacheClearPipe.php
@@ -8,6 +8,13 @@
 
 class ArtisanCallCacheClearPipe implements Pipeline
 {
+    /**
+     * handle
+     *
+     * @param  array  $content
+     * @param  mixed  $next
+     * @return void
+     */
     public function handle($content, Closure $next)
     {
         Artisan::call('cache:clear');

diff --git a/src/Pipelines/ArtisanCallConfigClearPipe.php b/src/Pipelines/ArtisanCallConfigClearPipe.php
@@ -8,6 +8,13 @@
 
 class ArtisanCallConfigClearPipe implements Pipeline
 {
+    /**
+     * handle
+     *
+     * @param  array  $content
+     * @param  mixed  $next
+     * @return void
+     */
     public function handle($content, Closure $next)
     {
         Artisan::call('config:clear');

diff --git a/src/Pipelines/ArtisanCallMigratePipe.php b/src/Pipelines/ArtisanCallMigratePipe.php
@@ -8,6 +8,13 @@
 
 class ArtisanCallMigratePipe implements Pipeline
 {
+    /**
+     * handle
+     *
+     * @param  array  $content
+     * @param  mixed  $next
+     * @return void
+     */
     public function handle($content, Closure $next)
     {
         Artisan::call('migrate', [

diff --git a/src/Pipelines/ArtisanCallOptimizePipe.php b/src/Pipelines/ArtisanCallOptimizePipe.php
@@ -8,6 +8,13 @@
 
 class ArtisanCallOptimizePipe implements Pipeline
 {
+    /**
+     * handle
+     *
+     * @param  array  $content
+     * @param  mixed  $next
+     * @return void
+     */
     public function handle($content, Closure $next)
     {
         Artisan::call('optimize');

diff --git a/src/Pipelines/ArtisanCallRouteClearPipe.php b/src/Pipelines/ArtisanCallRouteClearPipe.php
@@ -8,6 +8,13 @@
 
 class ArtisanCallRouteClearPipe implements Pipeline
 {
+    /**
+     * handle
+     *
+     * @param  array  $content
+     * @param  mixed  $next
+     * @return void
+     */
     public function handle($content, Closure $next)
     {
         Artisan::call('route:clear');

diff --git a/src/Pipelines/ArtisanCallViewClearPipe.php b/src/Pipelines/ArtisanCallViewClearPipe.php
@@ -8,6 +8,13 @@
 
 class ArtisanCallViewClearPipe implements Pipeline
 {
+    /**
+     * handle
+     *
+     * @param  array  $content
+     * @param  mixed  $next
+     * @return void
+     */
     public function handle($content, Closure $next)
     {
         Artisan::call('view:clear');

diff --git a/src/Pipelines/GitPipe.php b/src/Pipelines/GitPipe.php
@@ -9,6 +9,13 @@
 
 class GitPipe implements Pipeline
 {
+    /**
+     * handle
+     *
+     * @param  array  $content
+     * @param  mixed  $next
+     * @return void
+     */
     public function handle($content, Closure $next)
     {
         $version = $content['new_version'];

diff --git a/src/Pipelines/SeedersPipe.php b/src/Pipelines/SeedersPipe.php
@@ -8,6 +8,13 @@
 
 class SeedersPipe implements Pipeline
 {
+    /**
+     * handle
+     *
+     * @param  array  $content
+     * @param  mixed  $next
+     * @return void
+     */
     public function handle($content, Closure $next)
     {
         Artisan::call('db:seed', [

diff --git a/src/RepositorySource/GithubRepository.php b/src/RepositorySource/GithubRepository.php
@@ -7,13 +7,21 @@
 
 class GithubRepository implements Repository
 {
+    /**
+     * getLatestVersion
+     */
     public function getLatestVersion(): string
     {
         $this->checkConfig();
 
         return isset($this->getLatestVersionData()['message']) ? throw new \Exception($this->getLatestVersionData()['message']) : $this->getLatestVersionData()['tag_name'];
     }
 
+    /**
+     * getLatestVersionData
+     *
+     * @return Illuminate\Support\Collection
+     */
     public function getLatestVersionData(): \Illuminate\Support\Collection
     {
         $this->checkConfig();
@@ -29,6 +37,9 @@ public function getLatestVersionData(): \Illuminate\Support\Collection
         return $response->collect();
     }
 
+    /**
+     * getVersions
+     */
     public function getVersions(): array
     {
         $this->checkConfig();
@@ -44,6 +55,11 @@ public function getVersions(): array
         })->toArray();
     }
 
+    /**
+     * getVersionsData
+     *
+     * @return Illuminate\Support\Collection
+     */
     public function getVersionsData(): \Illuminate\Support\Collection
     {
         $this->checkConfig();
@@ -59,6 +75,11 @@ public function getVersionsData(): \Illuminate\Support\Collection
         return $response->collect();
     }
 
+    /**
+     * checkConfig
+     *
+     * @return void
+     */
     private function checkConfig()
     {
         if (config('updater.github_token') == null) {