Merge pull request #43 from BrainMaestro/feature/handles-scripts-with-multiple-commands

Feature/handles scripts with multiple commands

Author: BrainMaestro

Diff for: CONTRIBUTING.md

@@ -6,21 +6,23 @@ We accept contributions via Pull Requests on [Github](https://github.com/BrainMa
 
 ## Pull Requests
 
-- **[PSR-2 Coding Standard](https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-2-coding-style-guide.md)** -  The easiest way to apply the conventions is run command:
- ```sh
+-   **[PSR-2 Coding Standard](https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-2-coding-style-guide.md)** - We use git hooks to enforce the style :). The easiest way to apply the conventions is run command:
+
+```sh
 composer fix-style
 ```
-- **Add tests!** - Your patch won't be accepted if it doesn't have tests.
 
-- **Document any change in behaviour** - Make sure the [README.md](README.md) and any other relevant documentation are kept up-to-date.
+-   **Add tests!** - Your patch won't be accepted if it doesn't have tests.
+
+-   **Document any change in behaviour** - Make sure the [README.md](README.md) and any other relevant documentation are kept up-to-date.
 
-- **Consider our release cycle** - We try to follow [SemVer v2.0.0](http://semver.org/). Randomly breaking public APIs is not an option.
+-   **Consider our release cycle** - We try to follow [SemVer v2.0.0](http://semver.org/). Randomly breaking public APIs is not an option.
 
-- **Create feature branches** - Don't ask us to pull from your master branch.
+-   **Create feature branches** - Don't ask us to pull from your master branch.
 
-- **One pull request per feature** - If you want to do more than one thing, send multiple pull requests.
+-   **One pull request per feature** - If you want to do more than one thing, send multiple pull requests.
 
-- **Send coherent history** - Make sure each individual commit in your pull request is meaningful. If you had to make multiple intermediate commits while developing, please [squash them](http://www.git-scm.com/book/en/v2/Git-Tools-Rewriting-History#Changing-Multiple-Commit-Messages) before submitting.
+-   **Send coherent history** - Make sure each individual commit in your pull request is meaningful. If you had to make multiple intermediate commits while developing, please [squash them](http://www.git-scm.com/book/en/v2/Git-Tools-Rewriting-History#Changing-Multiple-Commit-Messages) before submitting.
 
 ## Running Tests
 

Diff for: Dockerfile

@@ -4,8 +4,11 @@ WORKDIR /app
 
 COPY ./composer.json ./composer.lock /app/
 
+# Remove any scripts that have cghooks since it is not yet present in the container
+RUN sed -iE '/\.\/cghooks .*/d' composer.json
+
 RUN composer install
 
 COPY . /app/
 
-RUN ./vendor/bin/phpunit
+RUN composer fix-style && composer test && ./cghooks add

Diff for: Makefile

@@ -2,3 +2,6 @@
 
 test:
 	docker build --rm -t cghooks .
+
+exec:
+	docker run --rm -it cghooks sh

Diff for: README.md

@@ -13,18 +13,19 @@ Add a `hooks` section to the `extra` section of your `composer.json` and add the
 
 ```json
 {
-  "extra": {
-    "hooks": {
-      "pre-commit": "phpunit",
-      "post-commit": "echo committed",
-      "pre-push": "phpunit && echo pushing!",
-      "...": "..."
+    "extra": {
+        "hooks": {
+            "pre-commit": "phpunit",
+            "post-commit": "echo committed",
+            "pre-push": ["phpunit", "echo pushing!"],
+            "...": "..."
+        }
     }
-  }
 }
 ```
 
 Then install the library with
+
 ```sh
 composer require --dev brainmaestro/composer-git-hooks
 ```
@@ -39,10 +40,10 @@ Add a `cghooks` script to the `scripts` section of your `composer.json` file. Th
 
 ```json
 {
-  "scripts": {
-    "cghooks": "vendor/bin/cghooks",
-    "...": "..."
-  }
+    "scripts": {
+        "cghooks": "vendor/bin/cghooks",
+        "...": "..."
+    }
 }
 ```
 
@@ -52,11 +53,11 @@ Add the following events to your `composer.json` file. The `cghooks` commands wi
 
 ```json
 {
-  "scripts": {
-    "post-install-cmd": "vendor/bin/cghooks add --ignore-lock",
-    "post-update-cmd": "vendor/bin/cghooks update",
-    "...": "..."
-  }
+    "scripts": {
+        "post-install-cmd": "vendor/bin/cghooks add --ignore-lock",
+        "post-update-cmd": "vendor/bin/cghooks update",
+        "...": "..."
+    }
 }
 ```
 
@@ -69,11 +70,11 @@ All the following commands have to be run in the same folder as your `composer.j
 After installation is complete, run `cghooks add`
 to add all the valid git hooks that have been specified in the composer config.
 
-Option | Description | Command
------- | ----------- | -------
-`no-lock` | Do not create a lock file | `cghooks add --no-lock`
-`ignore-lock` | Add the lock file to .gitignore | `cghooks add --ignore-lock`
-`force-win` | Force windows bash compatibility | `cghooks add --force-win`
+| Option        | Description                      | Command                     |
+| ------------- | -------------------------------- | --------------------------- |
+| `no-lock`     | Do not create a lock file        | `cghooks add --no-lock`     |
+| `ignore-lock` | Add the lock file to .gitignore  | `cghooks add --ignore-lock` |
+| `force-win`   | Force windows bash compatibility | `cghooks add --force-win`   |
 
 The `lock` file contains a list of all added hooks.
 
@@ -87,13 +88,12 @@ Hooks can be easily removed with `cghooks remove`. This will remove all the hook
 
 Hooks can also be removed by passing them as arguments. The command `cghooks remove pre-commit post-commit` which will remove the `pre-commit` and `post-commit` hooks.
 
-Option | Description | Command
------- | ----------- | -------
-`force` | Delete hooks without checking the lock file | `cghooks remove --force`
+| Option  | Description                                 | Command                  |
+| ------- | ------------------------------------------- | ------------------------ |
+| `force` | Delete hooks without checking the lock file | `cghooks remove --force` |
 
 **CAREFUL**: If the lock file was tampered with or the force option was used, hooks that already existed before using this package, but were specified in the composer scripts config will be removed as well. That is, if you had a previous `pre-commit` hook, but your current composer config also has a `pre-commit` hook, this option will cause the command to remove your initial hook.
 
-
 ### Listing hooks
 
 Hooks can be listed with the `cghooks list-hooks` command. This basically checks composer config and list the hooks that actually have files.
@@ -102,9 +102,9 @@ Hooks can be listed with the `cghooks list-hooks` command. This basically checks
 
 The following options are common to all commands.
 
-Option | Description | Command
------- | ----------- | -------
-`git-dir` | Path to git directory | `cghooks ${command} --git-dir='/path/to/.git'`
+| Option    | Description           | Command                                        |
+| --------- | --------------------- | ---------------------------------------------- |
+| `git-dir` | Path to git directory | `cghooks ${command} --git-dir='/path/to/.git'` |
 
 ### Testing Hooks
 
@@ -116,11 +116,12 @@ Please see [CONTRIBUTING](CONTRIBUTING.md) for details.
 
 ## Credits
 
-- [Ezinwa Okpoechi][link-author]
-- [All Contributors][link-contributors]
+-   [Ezinwa Okpoechi][link-author]
+-   [All Contributors][link-contributors]
 
 ## Related
-- [husky][link-husky]
+
+-   [husky][link-husky]
 
 ## License
 
@@ -131,7 +132,6 @@ The MIT License (MIT). Please see [License File](LICENSE) for more information.
 [badge-packagist]: https://img.shields.io/packagist/v/brainmaestro/composer-git-hooks.svg?style=flat-square
 [badge-stable]: https://poser.pugx.org/your-app-rocks/eloquent-uuid/v/stable
 [badge-travis]: https://img.shields.io/travis/BrainMaestro/composer-git-hooks.svg?style=flat-square
-
 [link-author]: https://github.com/BrainMaestro
 [link-composer-events]: https://getcomposer.org/doc/articles/scripts.md#command-events
 [link-contributors]: ../../contributors

Diff for: composer.json

@@ -36,12 +36,20 @@
             "BrainMaestro\\GitHooks\\Tests\\": "tests/"
         }
     },
-    "bin": ["cghooks"],
+    "bin": [
+        "cghooks"
+    ],
     "scripts": {
         "test": "vendor/bin/phpunit",
+        "post-install-cmd": "./cghooks add --ignore-lock",
+        "post-update-cmd": "./cghooks update",
         "check-style": "php-cs-fixer fix --using-cache=no --diff --dry-run .",
-        "fix-style": "php-cs-fixer fix --using-cache=no .",
-        "pre-commit": "echo about to commit",
-        "post-commit": "echo just committed"
+        "fix-style": "php-cs-fixer fix --using-cache=no ."
+    },
+    "extra": {
+        "hooks": {
+            "pre-commit": "composer check-style",
+            "pre-push": "composer test"
+        }
     }
 }

Diff for: src/Commands/AddCommand.php

@@ -45,6 +45,8 @@ protected function execute(InputInterface $input, OutputInterface $output)
             $filename = "{$gitDir}/hooks/{$hook}";
             $fileExists = file_exists($filename);
 
+            $script = is_array($script) ? implode(PHP_EOL, $script) : $script;
+
             if (! $force && $fileExists) {
                 $output->writeln("<comment>{$hook} already exists</comment>");
             } else {

Diff for: src/Commands/HookCommand.php

@@ -31,6 +31,7 @@ protected function configure()
 
     protected function execute(InputInterface $input, OutputInterface $output)
     {
-        $output->writeln(shell_exec($this->script));
+        $script = is_array($this->script) ? implode(PHP_EOL, $this->script) : $this->script;
+        $output->writeln(shell_exec($script));
     }
 }

Diff for: src/Commands/UpdateCommand.php

@@ -33,14 +33,16 @@ protected function execute(InputInterface $input, OutputInterface $output)
     {
         $gitDir = $input->getOption('git-dir');
         $forceWindows = $input->getOption('force-win');
-        
+
         create_hooks_dir($gitDir);
 
         foreach ($this->hooks as $hook => $script) {
             $filename = "{$gitDir}/hooks/{$hook}";
 
             $operation = file_exists($filename) ? 'Updated' : 'Added';
 
+            $script = is_array($script) ? implode(PHP_EOL, $script) : $script;
+
             if ($forceWindows || is_windows()) {
                 // On windows we need to add a SHEBANG
                 // See: https://github.com/BrainMaestro/composer-git-hooks/issues/7

Diff for: tests/AddCommandTest.php

@@ -192,4 +192,30 @@ public function it_adds_win_bash_compat_if_the_force_windows_option_is_passed()
             $this->assertEquals(strpos($content, "#!/bin/bash"), 0);
         }
     }
+
+    /**
+     * @test
+     */
+    public function it_handles_commands_defined_in_an_array()
+    {
+        $hooks = [
+            'test-pre-commit' => [
+                'echo pre-commit first',
+                'echo pre-commit second',
+                'echo pre-commit third',
+            ],
+        ];
+
+        $command = new AddCommand($hooks);
+        $commandTester = new CommandTester($command);
+
+        $commandTester->execute([]);
+
+        foreach ($hooks as $hook => $scripts) {
+            $this->assertContains("Added {$hook} hook", $commandTester->getDisplay());
+
+            $content = file_get_contents(".git/hooks/" . $hook);
+            $this->assertContains(implode(PHP_EOL, $scripts), $content);
+        }
+    }
 }

Diff for: tests/UpdateCommandTest.php

@@ -46,6 +46,9 @@ public function it_updates_hooks_that_already_exist()
         }
     }
 
+    /**
+     * @test
+     */
     public function it_adds_shebang_to_hooks_on_windows()
     {
         if (! is_windows()) {
@@ -120,4 +123,31 @@ public function it_adds_win_bash_compat_if_the_force_windows_option_is_passed()
             $this->assertEquals(strpos($content, "#!/bin/bash"), 0);
         }
     }
+
+    /**
+     * @test
+     */
+    public function it_handles_commands_defined_in_an_array()
+    {
+        self::createHooks();
+        $hooks = [
+            'test-pre-commit' => [
+                'echo pre-commit first',
+                'echo pre-commit second',
+                'echo pre-commit third',
+            ],
+        ];
+
+        $command = new UpdateCommand($hooks);
+        $commandTester = new CommandTester($command);
+
+        $commandTester->execute([]);
+
+        foreach ($hooks as $hook => $scripts) {
+            $this->assertContains("Updated {$hook} hook", $commandTester->getDisplay());
+
+            $content = file_get_contents(".git/hooks/" . $hook);
+            $this->assertContains(implode(PHP_EOL, $scripts), $content);
+        }
+    }
 }