Merge pull request #12 from igorsgm/feature/readding-pest-tests

Pest Tests

Author: igorsgm

composer.json

@@ -22,18 +22,20 @@
     ],
     "require": {
         "php": "^7.2|^8.0",
-        "illuminate/container": "^5.6|^6.0|^7.0|^8.0|^9.0",
-        "illuminate/config": "^5.6|^6.0|^7.0|^8.0|^9.0",
-        "illuminate/support": "^5.6|^6.0|^7.0|^8.0|^9.0",
-        "illuminate/contracts": "^5.6|^6.0|^7.0|^8.0|^9.0",
-        "illuminate/console": "^5.6|^6.0|^7.0|^8.0|^9.0",
-        "illuminate/pipeline": "^5.6|^6.0|^7.0|^8.0|^9.0"
+        "illuminate/config": "^6.0|^7.0|^8.0|^9.0",
+        "illuminate/console": "^6.0|^7.0|^8.0|^9.0",
+        "illuminate/container": "^6.0|^7.0|^8.0|^9.0",
+        "illuminate/contracts": "^6.0|^7.0|^8.0|^9.0",
+        "illuminate/pipeline": "^6.0|^7.0|^8.0|^9.0",
+        "illuminate/support": "^6.0|^7.0|^8.0|^9.0"
     },
     "require-dev": {
-        "orchestra/testbench": "^6.0",
-        "phpunit/phpunit": "^9.0",
-        "mockery/mockery": "^1.4.4",
-        "laravel/pint": "^1.2"
+        "laravel/pint": "^1.2",
+        "mockery/mockery": "^1.5.1",
+        "orchestra/testbench": "^7.0",
+        "pestphp/pest": "^1.22",
+        "pestphp/pest-plugin-mock": "^1.0",
+        "phpunit/phpunit": "^9.0"
     },
     "autoload": {
         "psr-4": {
@@ -50,15 +52,18 @@
         "test-coverage": "vendor/bin/phpunit --coverage-html coverage"
     },
     "config": {
-        "sort-packages": true
+        "sort-packages": true,
+        "allow-plugins": {
+            "pestphp/pest-plugin": true
+        }
     },
     "extra": {
         "laravel": {
             "providers": [
                 "Igorsgm\\GitHooks\\GitHooksServiceProvider"
             ],
             "aliases": {
-                "GitHooks": "Igorsgm\\GitHooks\\GitHooksFacade"
+                "GitHooks": "Igorsgm\\GitHooks\\Facades\\GitHooks"
             }
         }
     },

config/git-hooks.php

@@ -78,6 +78,8 @@
     | Pre-Rebase Hooks
     |-----------------------------------------------------------------
     |
+    | @TODO Implement support to pre-rebase hooks
+    |
     | The pre-rebase hook runs before you rebase anything and can halt the process by exiting non-zero.
     | You can use this hook to disallow rebasing any commits that have already been pushed.
     | The example pre-rebase hook that Git installs does this, although it makes some assumptions that may not
@@ -93,6 +95,8 @@
     | Post-Rewrite Hooks
     |-----------------------------------------------------------------
     |
+    | @TODO Implement support to post-rewrite hook
+    |
     | The post-rewrite hook is run by commands that replace commits, such as git commit --amend and git rebase
     | (though not by git filter-branch). Its single argument is which command triggered the rewrite, and it receives
     | a list of rewrites on stdin. This hook has many of the same uses as the post-checkout and post-merge hooks.
@@ -107,6 +111,8 @@
     | Post-Checkout Hooks
     |-----------------------------------------------------------------
     |
+    | @TODO Implement support to post-checkout hook
+    |
     | After you run a successful git checkout, the post-checkout hook runs; you can use it to set up your working
     | directory properly for your project environment. This may mean moving in large binary files that you don't want
     | source controlled, auto-generating documentation, or something along those lines.
@@ -121,10 +127,13 @@
     | Post-Merge Hooks
     |-----------------------------------------------------------------
     |
+    | @TODO Implement support to post-merge hook
+    |
     | The post-merge hook runs after a successful merge command. You can use it to restore data in the working tree
     | that Git can't track, such as permissions data. This hook can likewise validate the presence of files external
     | to Git control that you may want copied in when the working tree changes.
     |
+    |
     */
     'post-merge' => [
 

phpunit.xml

@@ -1,23 +1,18 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
-         backupGlobals="false"
-         backupStaticAttributes="false"
+         xsi:noNamespaceSchemaLocation="./vendor/phpunit/phpunit/phpunit.xsd"
          bootstrap="vendor/autoload.php"
          colors="true"
-         convertErrorsToExceptions="true"
-         convertNoticesToExceptions="true"
-         convertWarningsToExceptions="true"
-         processIsolation="false"
-         stopOnFailure="false"
-         xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/9.3/phpunit.xsd">
-    <coverage>
-        <include>
-            <directory suffix=".php">./src</directory>
-        </include>
-    </coverage>
+>
     <testsuites>
-        <testsuite name="Unit">
+        <testsuite name="Test Suite">
             <directory suffix="Test.php">./tests</directory>
         </testsuite>
     </testsuites>
+    <coverage processUncoveredFiles="true">
+        <include>
+            <directory suffix=".php">./app</directory>
+            <directory suffix=".php">./src</directory>
+        </include>
+    </coverage>
 </phpunit>

src/Console/Commands/PreCommit.php

@@ -4,8 +4,8 @@
 
 use Igorsgm\GitHooks\Contracts\HookCommand;
 use Igorsgm\GitHooks\Exceptions\HookFailException;
+use Igorsgm\GitHooks\Facades\GitHooks;
 use Igorsgm\GitHooks\Git\ChangedFiles;
-use Igorsgm\GitHooks\Git\GitHelper;
 use Igorsgm\GitHooks\Traits\WithPipeline;
 use Illuminate\Console\Command;
 
@@ -45,7 +45,7 @@ public function handle()
         try {
             $this->sendChangedFilesThroughHooks(
                 new ChangedFiles(
-                    GitHelper::getListOfChangedFiles()
+                    GitHooks::getListOfChangedFiles()
                 )
             );
         } catch (HookFailException $e) {

src/Console/Commands/RegisterHooks.php

@@ -2,6 +2,7 @@
 
 namespace Igorsgm\GitHooks\Console\Commands;
 
+use Exception;
 use Igorsgm\GitHooks\GitHooks;
 use Illuminate\Console\Command;
 
@@ -12,22 +13,22 @@ class RegisterHooks extends Command
      *
      * @var string
      */
-    protected $signature = 'git-hooks:register-hooks';
+    protected $signature = 'git-hooks:register';
 
     /**
      * The console command description.
      *
      * @var string
      */
-    protected $description = 'Register git hooks for application';
+    protected $description = 'Register or re-register git hooks for application';
 
     /**
      * Execute the console command.
      *
      * @param  GitHooks  $gitHooks
      * @return void
      *
-     * @throws \Exception
+     * @throws Exception
      */
     public function handle(GitHooks $gitHooks)
     {
@@ -37,6 +38,6 @@ public function handle(GitHooks $gitHooks)
             $gitHooks->install($hook);
         }
 
-        $this->info('Git hooks have been successfully created');
+        $this->info('Git hooks have been successfully installed.');
     }
 }

src/GitHooksFacade.php renamed to src/Facades/GitHooks.php

@@ -1,13 +1,13 @@
 <?php
 
-namespace Igorsgm\GitHooks;
+namespace Igorsgm\GitHooks\Facades;
 
 use Illuminate\Support\Facades\Facade;
 
 /**
  * @see \Igorsgm\GitHooks\GitHooks
  */
-class GitHooksFacade extends Facade
+class GitHooks extends Facade
 {
     /**
      * Get the registered name of the component.

src/GitHooks.php

@@ -3,9 +3,12 @@
 namespace Igorsgm\GitHooks;
 
 use Exception;
+use Igorsgm\GitHooks\Traits\GitHelper;
 
 class GitHooks
 {
+    use GitHelper;
+
     /**
      * Get all supported git hooks
      */
@@ -44,7 +47,7 @@ public function getAvailableHooks()
      *
      * @throws Exception
      */
-    public function install($hookName)
+    public function install(string $hookName)
     {
         if (! is_dir($this->getGitHooksDir())) {
             throw new Exception('Git not initialized in this project.');

src/HooksPipeline.php

@@ -12,12 +12,12 @@ class HooksPipeline extends Pipeline
     /**
      * @var Closure
      */
-    protected $callback;
+    protected $pipeStartCallback;
 
     /**
      * @var Closure
      */
-    protected $exceptionCallback;
+    protected $pipeEndCallback;
 
     /**
      * @var string
@@ -38,9 +38,9 @@ public function __construct(Container $container, string $hook)
      * @param  Closure  $callback
      * @return $this
      */
-    public function withCallback(Closure $callback)
+    public function withPipeStartCallback(Closure $callback)
     {
-        $this->callback = $callback;
+        $this->pipeStartCallback = $callback;
 
         return $this;
     }
@@ -49,9 +49,9 @@ public function withCallback(Closure $callback)
      * @param  Closure  $callback
      * @return $this
      */
-    public function withExceptionCallback(Closure $callback)
+    public function withPipeEndCallback(Closure $callback)
     {
-        $this->exceptionCallback = $callback;
+        $this->pipeEndCallback = $callback;
 
         return $this;
     }
@@ -79,8 +79,10 @@ protected function carry()
                         // execute the pipe function giving in the parameters that are required.
                         $pipe = $this->getContainer()->make($pipe, ['parameters' => $hookParameters]);
 
-                        if ($this->callback) {
-                            call_user_func_array($this->callback, [$pipe]);
+                        $this->handlePipeEnd(true);
+
+                        if ($this->pipeStartCallback) {
+                            call_user_func_array($this->pipeStartCallback, [$pipe]);
                         }
 
                         $parameters = [$passable, $stack];
@@ -92,8 +94,8 @@ protected function carry()
                     }
 
                     $carry = method_exists($pipe, $this->method)
-                                    ? $pipe->{$this->method}(...$parameters)
-                                    : $pipe(...$parameters);
+                                ? $pipe->{$this->method}(...$parameters)
+                                : $pipe(...$parameters);
 
                     return $this->handleCarry($carry);
                 } catch (Throwable $e) {
@@ -104,13 +106,43 @@ protected function carry()
     }
 
     /**
-     * {@inheritDoc}
+     * Handle the call back call once a specific pipe has finished or errored.
+     *
+     * @param  bool  $success
+     * @return void
      */
-    protected function handleException($passable, $e)
+    protected function handlePipeEnd($success)
     {
-        if ($this->exceptionCallback) {
-            return call_user_func_array($this->exceptionCallback, [$e]);
+        if ($this->pipeEndCallback) {
+            call_user_func_array($this->pipeEndCallback, [$success]);
         }
+    }
+
+    /**
+     * Handle the value returned from each pipe before passing it to the next.
+     *
+     * @param  mixed  $carry
+     * @return mixed
+     */
+    protected function handleCarry($carry)
+    {
+        $this->handlePipeEnd(true);
+
+        return $carry;
+    }
+
+    /**
+     * Handle the given exception.
+     *
+     * @param  mixed  $passable
+     * @param  \Throwable  $e
+     * @return mixed
+     *
+     * @throws \Throwable
+     */
+    protected function handleException($passable, Throwable $e)
+    {
+        $this->handlePipeEnd(false);
 
         throw $e;
     }

src/Git/GitHelper.php renamed to src/Traits/GitHelper.php

@@ -1,37 +1,36 @@
 <?php
 
-namespace Igorsgm\GitHooks\Git;
+namespace Igorsgm\GitHooks\Traits;
 
-use Igorsgm\GitHooks\Traits\ProcessHelper;
 use Symfony\Component\Process\Exception\ProcessFailedException;
 
-class GitHelper
+trait GitHelper
 {
     use ProcessHelper;
 
     /**
      * @return string
      */
-    public static function getListOfChangedFiles()
+    public function getListOfChangedFiles()
     {
-        return self::execAndGetCommandOutput('git status --short');
+        return $this->runCommandAndGetOutput('git status --short');
     }
 
     /**
      * @return string
      */
-    public static function getLastCommitFromLog()
+    public function getLastCommitFromLog()
     {
-        return self::execAndGetCommandOutput('git log -1 HEAD');
+        return $this->runCommandAndGetOutput('git log -1 HEAD');
     }
 
     /**
      * @param  string|array  $commands
      * @return string
      */
-    private static function execAndGetCommandOutput($commands)
+    private function runCommandAndGetOutput($commands)
     {
-        $process = self::execCommands($commands);
+        $process = $this->runCommands($commands);
 
         if (! $process->isSuccessful()) {
             throw new ProcessFailedException($process);
@@ -46,7 +45,7 @@ private static function execAndGetCommandOutput($commands)
      * @param  string  $filePath
      * @return string
      */
-    public static function getCommitMessageContentFromFile(string $filePath): string
+    public function getCommitMessageContentFromFile(string $filePath): string
     {
         return file_get_contents($filePath);
     }
@@ -57,7 +56,7 @@ public static function getCommitMessageContentFromFile(string $filePath): string
      * @param  string  $path
      * @param  string  $message
      */
-    public static function updateCommitMessageContentInFile(string $path, string $message): void
+    public function updateCommitMessageContentInFile(string $path, string $message): void
     {
         file_put_contents($path, $message);
     }