Merge branch '2.x' for 2.3.0 release

Author: Wtyd

.github/workflows/code-analysis.yml

@@ -33,9 +33,7 @@ jobs:
         restore-keys: ${{ runner.os }}-composer-
 
     - name: Install dependencies
-      run: |
-        composer install --prefer-dist --no-progress
-        chmod -R +x tools/*
+      run: composer install --prefer-dist --no-progress
 
     - name: Execute PhpStan
       run: php githooks tool phpstan

.github/workflows/main-tests.yml

@@ -27,7 +27,7 @@ jobs:
       with:
         php-version: ${{ matrix.php-versions }}
         extensions: ${{ env.extensions }} #optional
-        tools: phpcs, phpcbf, phpmd, phpstan
+        tools: phpcs, phpcbf, phpmd, phpstan:1.4
         ini-values: "post_max_size=256M" #optional
         coverage: none
 

.github/workflows/release.yml

@@ -49,17 +49,25 @@ jobs:
         echo $version
         php githooks app:build --build-version=${version}
 
-    - uses: actions/upload-artifact@master
+    - name: 'Tar files to keep permissions'
+      run: |
+        tar -cvf githooks-71.tar builds/php7.1/githooks
+        tar -cvf githooks-73.tar builds/githooks
+        ls -lah builds/githooks builds/php7.1/githooks
+  
+    - name: Upload php 7.1 build
+      uses: actions/upload-artifact@master
       if: ${{ '7.1' == matrix.php-versions }}
       with:
         name: githooks-71
-        path: builds/php7.1/githooks
+        path: githooks-71.tar
 
-    - uses: actions/upload-artifact@master
+    - name: Upload php 7.3 build
+      uses: actions/upload-artifact@master
       if: ${{ '7.3' == matrix.php-versions }}
       with:
         name: githooks-73
-        path: builds/githooks
+        path: githooks-73.tar
 
   test_rc:    
     name: Test the Build in php ${{ matrix.php-versions }}
@@ -100,19 +108,22 @@ jobs:
         chmod -R +x tools/*
 
     - name: Delete Old Builds
-      run: rm builds/githooks builds/php7.1/githooks
+      run: rm builds/githooks builds/php7.1/githooks && echo ${{ secrets.PAT_TOKEN_TO_COMMIT }}
 
-    - uses: actions/download-artifact@master
-      if: ${{ '7.2' == matrix.php-versions }}
+    - uses: actions/download-artifact@v3
       with:
         name: githooks-71
-        path: 'builds/php7.1'
 
     - uses: actions/download-artifact@master
-      if: ${{ '8.1' == matrix.php-versions }}
       with:
         name: githooks-73
-        path: builds
+
+    - name: Extract and check builds
+      run: |
+        tar -xf githooks-71.tar
+        tar -xf githooks-73.tar
+        ls -lah builds
+        git status
   
     - name: Testing the Aplication
       run: |
@@ -121,59 +132,58 @@ jobs:
         vendor/bin/phpunit --group release
       shell: bash
 
-  # commit_rc:    
-  #   name: Commit the Build
-  #   needs: test_rc
-  #   runs-on: ubuntu-latest
-  #   steps:
-  #     - name: Checkout
-  #       uses: actions/checkout@v2
-  #       token: ''
-
-  #     - name: Delete Old Builds
-  #       run: rm builds/githooks builds/php7.1/githooks
-
-  #     - uses: actions/download-artifact@master
-  #       with:
-  #         name: githooks-71
-  #         path: 'builds/php7.1'
-
-  #     - uses: actions/download-artifact@master
-  #       with:
-  #         name: githooks-73
-  #         path: builds
-
-  #     - name: Make Changes
-  #       uses: DamianReeves/write-file-action
-  #       with:
-  #         path: README.md
-  #         contents: |
-  #           echo "Hello World!"
-  #         write-mode: append
-
-  #     - name: Make Changes
-  #       run: ls && echo 'Nueva fila' >> README.md
-
-  #     - name: Check Changes
-  #       run: git status
-
-  #     - name: Get Time
-  #       id: time
-  #       uses: nanzm/get-time-action@v1.1
-  #       with:
-  #         # timeZone: 8
-  #         format: 'DD-MM-YYYY HH-mm-ss'
-
-  #     - name: Commit the new RC
-  #       uses: EndBug/add-and-commit@v7
-  #       env:
-  #         TIME: "${{ steps.time.outputs.time }}"
-  #       with:
-  #         # add: 'builds/*'
-  #         add: '*'
-  #         default_author: github_actions # github_actor -> UserName <UserName@users.noreply.github.com> || user_info -> Your Display Name <your-actual@email.com>
-  #         message: 'RC ${{ env.version }} - ${{ env.TIME }}'
-  #         push: false
-
-  #     - name: Git Log
-  #       run: git log
+  commit_rc:    
+    name: Commit the Build
+    needs: test_rc
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+
+      - name: Delete Old Builds
+        run: rm builds/githooks builds/php7.1/githooks && echo ${{ secrets.PAT_TOKEN_TO_COMMIT }}
+
+      - uses: actions/download-artifact@v3
+        with:
+          name: githooks-71
+
+      - uses: actions/download-artifact@master
+        with:
+          name: githooks-73
+
+      - name: Extract and check builds
+        run: |
+          tar -xf githooks-71.tar
+          tar -xf githooks-73.tar
+          ls -lah builds
+          git status
+
+      - name: Get Time
+        id: time
+        uses: nanzm/get-time-action@v1.1
+        with:
+          timeZone: 1
+          format: 'DD-MM-YYYY HH:mm:ss'
+
+      - name: Extract version
+        id: version_id
+        run:  |
+          branch=${GITHUB_REF##*/}
+          echo ${branch}
+          prefix='rc-'
+          version=${branch#"$prefix"}
+          echo $version
+          echo "::set-output name=version::${version}"
+
+      - name: Check Version
+        run: echo ${{ steps.version_id.outputs.version }} && echo ${{ steps.time.outputs.time }}
+
+      - uses: GuillaumeFalourd/git-commit-push@v1.3
+        with:
+          files: builds/githooks builds/php7.1/githooks
+          commit_message: 'Release Candidate: ${{ steps.version_id.outputs.version }} - Build: ${{ steps.time.outputs.time }}'
+
+      - name: Git Log
+        run: git log

.gitignore

@@ -29,7 +29,7 @@ testsDir/src
 testsDir/app
 testsDir/vendor
 testsDir/*.yml
-githooks.yml
+/githooks.yml
 
 tools/tmp/
 

README.md

@@ -51,7 +51,6 @@ Then run `composer update wtyd/githooks`.
 
 5. [Set the configuration file](#Set-the-configuration-file).
 
-
 # Usage
 When you commit, all the configured code check tools are automatically launched. If your code pass all checks, GitHooks allows you to commit. If not, you have to fix the code and try again:
 <p>
@@ -85,14 +84,18 @@ But you can set your [own script](https://github.com/Wtyd/githooks/wiki/Console%
 The `githooks.yml` file is splitted on three parts:
 
 ## Options
-Actually the only option is `execution`. This flag marks how GitHooks will run:
+### Execution
+The `execution` flag marks how GitHooks will run:
 * `full` (the default option): executes always all tools setted against all path setted for each tool.
     For example, you setted phpcs for run in `src` and `app` directories. The commit only contains modified files from `database` directory. Phpcs will check `src` and `app` directories even if no files in these directories have been modified.
 * `fast`: this option runs the tools only against files modified by commit.
     * This option only affects the following tools: phpcs, phpmd, phpstan, and parallel-lint. The rest of the tools will run as the full option.
-    * **WARNING!!!** You must set the excludes of the tools either in githooks.yml or in the configuration file of eath tool since this
+    * **WARNING!!!** You must set the excludes of the tools either in `githooks.yml` or in the configuration file of eath tool since this
 option overwrites the key `paths` of the tools so that they are executed only against the modified files.
 
+### Processes
+Run multiple tools in multiple processes at same time (`tool all` command). The default number of processes is 1.
+
 ## Tools
 It is an array with the name of the tools that GitHooks will run. The name of the tools is their executable. If you want all the tools to be executed, the `Tools` key will be as follows:
 ```yml

app-

@@ -3,16 +3,25 @@
 namespace Wtyd\GitHooks\App\Commands;
 
 use Wtyd\GitHooks\App\Commands\ToolCommand as BaseCommand;
+use Wtyd\GitHooks\ConfigurationFile\CliArguments;
 use Wtyd\GitHooks\ConfigurationFile\Exception\ConfigurationFileInterface;
 use Wtyd\GitHooks\ConfigurationFile\Exception\ConfigurationFileNotFoundException;
 use Wtyd\GitHooks\ConfigurationFile\Exception\ToolIsNotSupportedException;
-use Wtyd\GitHooks\ConfigurationFile\Exception\WrongExecutionValueException;
+use Wtyd\GitHooks\ConfigurationFile\Exception\WrongOptionsValueException;
 use Wtyd\GitHooks\Tools\Errors;
 
 class ExecuteToolCommand extends BaseCommand
 {
-    protected $signature = 'tool {tool : Tool will be run} {execution? : Override the execution mode of githooks.yml. Values: "fast" and "full"}';
-    protected $description = 'Run the tool passed as argument. It must be a supported tool by GitHooks. ';
+    protected $signature = 'tool 
+                            {tool : Tool will be run}
+                            {execution? : Override the execution mode of githooks.yml. Values: "fast" and "full"}
+                            {--ignoreErrorsOnExit= : Avoids exit error even if the tool finds some trobule. When tool is \'all\' applies for all tools}
+                            {--otherArguments= : Other tool options not supported by GitHooks}
+                            {--executablePath= : Path to executable}
+                            {--paths= :  Paths or files against the tool will be executed}
+                            {--processes= : Number of parallel processes in which the tools will be executed}';
+
+    protected $description = 'Run the tool passed as argument. It must be a supported tool by GitHooks. the available options depend on the tool passed as parameter';
 
     public function handle()
     {
@@ -21,15 +30,26 @@ public function handle()
         $execution = strval($this->argument('execution'));
 
         try {
-            $tools = $this->toolsPreparer->__invoke($tool, $execution);
+            $configurationFile = $this->readConfigurationFileAction
+                ->__invoke(new CliArguments(
+                    $tool,
+                    $execution,
+                    $this->option('ignoreErrorsOnExit'),
+                    strval($this->option('otherArguments')),
+                    strval($this->option('executablePath')),
+                    strval($this->option('paths')),
+                    intval($this->option('processes'))
+                ));
+
+            $tools = $this->toolsPreparer->__invoke($configurationFile);
 
-            $withLiveOutput = $tool === 'all' ? false : true;
+            $processesExecution = $this->processExecutionFactory->create($tool);
 
-            $errors = $this->toolExecutor->__invoke($tools, $withLiveOutput);
+            $errors = $processesExecution->execute($tools, $configurationFile->getProcesses());
         } catch (ToolIsNotSupportedException $exception) {
             $this->error($exception->getMessage());
             $errors->setError($tool, $exception->getMessage());
-        } catch (WrongExecutionValueException $exception) {
+        } catch (WrongOptionsValueException $exception) {
             $this->error($exception->getMessage());
             $errors->setError($tool, $exception->getMessage());
         } catch (ConfigurationFileNotFoundException $exception) {
@@ -47,6 +67,7 @@ public function handle()
                 $this->warn($warning);
             }
         }
+
         foreach ($this->toolsPreparer->getConfigurationFileWarnings() as $warning) {
             $this->warn($warning);
         }

app/Commands/ExecuteToolCommand.php

@@ -3,26 +3,31 @@
 namespace Wtyd\GitHooks\App\Commands;
 
 use Wtyd\GitHooks\Tools\Errors;
-use Wtyd\GitHooks\Tools\ToolExecutor;
 use Wtyd\GitHooks\Tools\ToolsPreparer;
 use LaravelZero\Framework\Commands\Command;
+use Wtyd\GitHooks\ConfigurationFile\ReadConfigurationFileAction;
+use Wtyd\GitHooks\Tools\Execution\ProcessExecutionFactory;
+use Wtyd\GitHooks\Tools\Execution\ProcessExecutionFactoryAbstract;
 
 abstract class ToolCommand extends Command
 {
-    /**
-     * @var  ToolsPreparer
-     */
+    /**  @var  ReadConfigurationFileAction */
+    protected $readConfigurationFileAction;
+
+    /** @var  ToolsPreparer */
     protected $toolsPreparer;
 
-    /**
-     * @var ToolExecutor
-     */
-    protected $toolExecutor;
+    /** @var ProcessExecutionFactoryAbstract */
+    protected $processExecutionFactory;
 
-    public function __construct(ToolsPreparer $toolsPreparer, ToolExecutor $toolExecutor)
-    {
+    public function __construct(
+        ReadConfigurationFileAction $readConfigurationFileAction,
+        ToolsPreparer $toolsPreparer,
+        ProcessExecutionFactoryAbstract $processExecutionFactory
+    ) {
+        $this->readConfigurationFileAction = $readConfigurationFileAction;
         $this->toolsPreparer = $toolsPreparer;
-        $this->toolExecutor = $toolExecutor;
+        $this->processExecutionFactory = $processExecutionFactory;
         parent::__construct();
     }
 

app/Commands/ToolCommand.php

@@ -7,6 +7,8 @@
 use Tests\Utils\FileReaderFake;
 use Wtyd\GitHooks\ConfigurationFile\FileReader;
 use Wtyd\GitHooks\Container\RegisterBindings;
+use Wtyd\GitHooks\Tools\Execution\ProcessExecutionFactoryAbstract;
+use Wtyd\GitHooks\Tools\Execution\ProcessExecutionFactoryFake;
 use Wtyd\GitHooks\Tools\Tool\SecurityChecker;
 
 class AppServiceProvider extends ServiceProvider
@@ -49,6 +51,7 @@ protected function testsRegister(): void
         if (defined('APP_ENV') && APP_ENV === 'testing') {
             $this->app->singleton(FileReader::class, FileReaderFake::class);
             $this->app->singleton(SecurityChecker::class, SecurityCheckerFake::class);
+            $this->app->singleton(ProcessExecutionFactoryAbstract::class, ProcessExecutionFactoryFake::class);
         }
     }
 }