Merge branch 'feature/blade-formatter-pre-commit-hook' into develop

Author: igorsgm

config/git-hooks.php

@@ -178,6 +178,10 @@
             'phpcbf_path' => env('PHPCBF_PATH', 'vendor/bin/phpcbf'),
             'standard' => env('PHPCS_STANDARD', 'phpcs.xml'),
         ],
+        'blade_formatter' => [
+            'path' => env('BLADE_FORMATTER_PATH', 'node_modules/.bin/blade-formatter'),
+            'config' => env('BLADE_FORMATTER_CONFIG', '.bladeformatterrc.json'),
+        ],
     ],
 
 ];

src/Console/Commands/Hooks/BaseCodeAnalyzerPreCommitHook.php

@@ -5,6 +5,7 @@
 use Closure;
 use Igorsgm\GitHooks\Exceptions\HookFailException;
 use Igorsgm\GitHooks\Facades\GitHooks;
+use Igorsgm\GitHooks\Git\ChangedFile;
 use Igorsgm\GitHooks\Git\ChangedFiles;
 use Igorsgm\GitHooks\Traits\ProcessHelper;
 use Illuminate\Console\Command;
@@ -21,9 +22,16 @@ abstract class BaseCodeAnalyzerPreCommitHook
      */
     public $command;
 
+    /**
+     * Name of the hook
+     * @var string
+     */
+    protected $name;
+
     /*
-     * List of files extensions that will be analyzed by the hook
-     * @var array
+     * List of files extensions that will be analyzed by the hook.
+     * Can also be a regular expression.
+     * @var array|string
      */
     public $fileExtensions = [];
 
@@ -89,8 +97,12 @@ public function handleCommittedFiles(ChangedFiles $files, Closure $next)
      */
     protected function analizeCommittedFiles($commitFiles)
     {
+        /** @var ChangedFile $file */
         foreach ($commitFiles as $file) {
-            if (! in_array($file->extension(), $this->fileExtensions)) {
+            if (
+                (is_array($this->fileExtensions) && ! in_array($file->extension(), $this->fileExtensions)) ||
+                (is_string($this->fileExtensions) && ! preg_match($this->fileExtensions, $file->getFilePath()))
+            ) {
                 continue;
             }
 
@@ -177,13 +189,21 @@ protected function suggestAutoFixOrExit()
         }
     }
 
+    /**
+     * Get the name of the hook.
+     */
+    public function getName(): ?string
+    {
+        return $this->name;
+    }
+
     /**
      * @param  array|string  $fileExtensions
      * @return BaseCodeAnalyzerPreCommitHook
      */
     public function setFileExtensions($fileExtensions)
     {
-        $this->fileExtensions = (array) $fileExtensions;
+        $this->fileExtensions = $fileExtensions;
 
         return $this;
     }

src/Console/Commands/Hooks/BladeFormatterPreCommitHook.php

@@ -0,0 +1,68 @@
+<?php
+
+namespace Igorsgm\GitHooks\Console\Commands\Hooks;
+
+use Closure;
+use Igorsgm\GitHooks\Contracts\CodeAnalyzerPreCommitHook;
+use Igorsgm\GitHooks\Git\ChangedFiles;
+
+class BladeFormatterPreCommitHook extends BaseCodeAnalyzerPreCommitHook implements CodeAnalyzerPreCommitHook
+{
+    /**
+     * @var string
+     */
+    protected $configParam;
+
+    /**
+     * Name of the hook
+     *
+     * @var string
+     */
+    protected $name = 'Blade Formatter';
+
+    /**
+     * Analyze and fix committed blade.php files using blade-formatter npm package
+     *
+     * @param  ChangedFiles  $files  The files that have been changed in the current commit.
+     * @param  Closure  $next  A closure that represents the next middleware in the pipeline.
+     * @return mixed|null
+     */
+    public function handle(ChangedFiles $files, Closure $next)
+    {
+        $this->configParam = $this->configParam();
+
+        return $this->setFileExtensions('/\.blade\.php$/')
+            ->setAnalyzerExecutable(config('git-hooks.code_analyzers.blade_formatter.path'), true)
+            ->handleCommittedFiles($files, $next);
+    }
+
+    /**
+     * Returns the command to run Blade Formatter tester
+     */
+    public function analyzerCommand(): string
+    {
+        return trim(sprintf('%s -c %s', $this->getAnalyzerExecutable(), $this->configParam));
+    }
+
+    /**
+     * Returns the command to run Blade Formatter fixer
+     */
+    public function fixerCommand(): string
+    {
+        return trim(sprintf('%s --write %s', $this->getFixerExecutable(), $this->configParam));
+    }
+
+    /**
+     * Returns the configuration parameter for the analyzer.
+     * This method retrieves the Blade Formatter configuration path (usually .bladeformatterrc.json or .bladeformatterrc)
+     * from the Git hooks configuration file and returns it as a string in the format '--config=<configFile>'.
+     *
+     * @return string The configuration parameter for the analyzer.
+     */
+    public function configParam(): string
+    {
+        $bladeFormatterConfig = rtrim(config('git-hooks.code_analyzers.blade_formatter.config'), '/');
+
+        return empty($bladeFormatterConfig) ? '' : '--config='.$bladeFormatterConfig;
+    }
+}

src/Console/Commands/Hooks/PHPCodeSnifferPreCommitHook.php

@@ -11,15 +11,14 @@ class PHPCodeSnifferPreCommitHook extends BaseCodeAnalyzerPreCommitHook implemen
     /**
      * @var string
      */
-    protected $analyzerConfigParam;
+    protected $configParam;
 
     /**
-     * Get the name of the hook.
+     * Name of the hook
+     *
+     * @var string
      */
-    public function getName(): ?string
-    {
-        return 'PHP_CodeSniffer';
-    }
+    protected $name = 'PHP_CodeSniffer';
 
     /**
      * Analyze and fix committed PHP files using PHP Code Sniffer and PHP Code Beautifier and Fixer.
@@ -30,7 +29,7 @@ public function getName(): ?string
      */
     public function handle(ChangedFiles $files, Closure $next)
     {
-        $this->analyzerConfigParam = $this->analyzerConfigParam();
+        $this->configParam = $this->configParam();
 
         return $this->setFileExtensions(['php'])
             ->setAnalyzerExecutable(config('git-hooks.code_analyzers.php_code_sniffer.phpcs_path'))
@@ -43,15 +42,15 @@ public function handle(ChangedFiles $files, Closure $next)
      */
     public function analyzerCommand(): string
     {
-        return trim(sprintf('%s %s', $this->getAnalyzerExecutable(), $this->analyzerConfigParam));
+        return trim(sprintf('%s %s', $this->getAnalyzerExecutable(), $this->configParam));
     }
 
     /**
      * Returns the command to run PHPCS
      */
     public function fixerCommand(): string
     {
-        return trim(sprintf('%s %s', $this->getFixerExecutable(), $this->analyzerConfigParam));
+        return trim(sprintf('%s %s', $this->getFixerExecutable(), $this->configParam));
     }
 
     /**
@@ -61,7 +60,7 @@ public function fixerCommand(): string
      *
      * @return string The configuration parameter for the analyzer.
      */
-    public function analyzerConfigParam(): string
+    public function configParam(): string
     {
         $phpCSStandard = rtrim(config('git-hooks.code_analyzers.php_code_sniffer.standard'), '/');
 

src/Console/Commands/Hooks/PintPreCommitHook.php

@@ -11,15 +11,14 @@ class PintPreCommitHook extends BaseCodeAnalyzerPreCommitHook implements CodeAna
     /**
      * @var string
      */
-    protected $analyzerConfigParam;
+    protected $configParam;
 
     /**
-     * Get the name of the hook.
+     * Name of the hook
+     *
+     * @var string
      */
-    public function getName(): ?string
-    {
-        return 'Laravel Pint';
-    }
+    protected $name = 'Laravel Pint';
 
     /**
      * Analyze and fix committed PHP files using Laravel Pint
@@ -30,7 +29,7 @@ public function getName(): ?string
      */
     public function handle(ChangedFiles $files, Closure $next)
     {
-        $this->analyzerConfigParam = $this->analyzerConfigParam();
+        $this->configParam = $this->configParam();
 
         return $this->setFileExtensions(['php'])
             ->setAnalyzerExecutable(config('git-hooks.code_analyzers.laravel_pint.path'), true)
@@ -42,23 +41,23 @@ public function handle(ChangedFiles $files, Closure $next)
      */
     public function analyzerCommand(): string
     {
-        return trim(sprintf('%s --test %s', $this->getAnalyzerExecutable(), $this->analyzerConfigParam));
+        return trim(sprintf('%s --test %s', $this->getAnalyzerExecutable(), $this->configParam));
     }
 
     /**
      * Returns the command to run Pint fixer
      */
     public function fixerCommand(): string
     {
-        return trim(sprintf('%s %s', $this->getFixerExecutable(), $this->analyzerConfigParam));
+        return trim(sprintf('%s %s', $this->getFixerExecutable(), $this->configParam));
     }
 
     /**
      * Gets the command-line parameter for specifying the configuration file for Laravel Pint.
      *
      * @return string The command-line parameter for the configuration file, or an empty string if not set.
      */
-    protected function analyzerConfigParam(): string
+    protected function configParam(): string
     {
         $pintConfigFile = config('git-hooks.code_analyzers.laravel_pint.config');
 

tests/Datasets/GitLogsDataset.php

@@ -25,5 +25,8 @@
 ]);
 
 dataset('listOfFixableFiles', [
-    'List of Fixable Files' => 'AM temp/ClassWithFixableIssues.php',
+    'List of Fixable Files' => implode(PHP_EOL, [
+        'AM temp/ClassWithFixableIssues.php',
+        'AM temp/fixable-blade-file.blade.php',
+    ]),
 ]);

tests/Datasets/PreCommitHooksDataset.php

@@ -24,3 +24,12 @@
         ],
     ],
 ]);
+
+dataset('bladeFormatterConfiguration', [
+    '.bladeformatterrc.json file' => [
+        [
+            'path' => '../../../../node_modules/.bin/blade-formatter',
+            'config' => __DIR__.'/../Fixtures/bladeFormatterFixture.json',
+        ],
+    ],
+]);

tests/Features/Commands/Hooks/BaseCodeAnalyzerPreCommitHookTest.php

@@ -0,0 +1,40 @@
+<?php
+
+use Igorsgm\GitHooks\Facades\GitHooks;
+use Igorsgm\GitHooks\Git\ChangedFiles;
+use Igorsgm\GitHooks\Tests\Fixtures\ConcreteBaseCodeAnalyzerFixture;
+use Igorsgm\GitHooks\Traits\GitHelper;
+
+uses(GitHelper::class);
+beforeEach(function () {
+    $this->gitInit();
+    $this->initializeTempDirectory(base_path('temp'));
+});
+
+test('Skips check if there are no files added to commit', function () {
+    $changedFiles = mock(ChangedFiles::class)
+        ->shouldReceive('getAddedToCommit')
+        ->andReturn(collect())
+        ->getMock();
+
+    $next = function ($files) {
+        return 'passed';
+    };
+
+    $hook = new ConcreteBaseCodeAnalyzerFixture();
+    $result = $hook->handleCommittedFiles($changedFiles, $next);
+    expect($result)->toBe('passed');
+});
+
+test('Skips check during a Merge process', function ($modifiedFilesList) {
+    $changedFiles = new ChangedFiles($modifiedFilesList);
+    GitHooks::shouldReceive('isMergeInProgress')->andReturn(true);
+
+    $next = function ($files) {
+        return 'passed';
+    };
+
+    $hook = new ConcreteBaseCodeAnalyzerFixture();
+    $result = $hook->handleCommittedFiles($changedFiles, $next);
+    expect($result)->toBe('passed');
+})->with('modifiedFilesList');