Code Improvements (#23)

* Add 'windows_os' function - DRY ( Don't repeat yourself concept ) * Code cleanup * Add 'mkdir_if_not_exist' function - DRY ( Don't repeat yourself concept ) * Add 'git_version' function - Avoid updating the application version in future releases * Sort functions * Rename functions - 'windos_os()' to 'is_windows()' - 'mkdir_if_not_exist()' to 'create_hooks_dir()' - Replace mkdir hardcode with 'create_hooks_dir()' function * Update 'create_hooks_dir()' function - String interpolation within function
BrainMaestro · Jun 1, 2018 · d3ba750 · d3ba750
1 parent 283dd5b
commit d3ba750
Show file tree

Hide file tree

Showing 12 changed files with 69 additions and 26 deletions.
diff --git a/cghooks b/cghooks
@@ -22,7 +22,7 @@ use BrainMaestro\GitHooks\Commands\ListCommand;
 use BrainMaestro\GitHooks\Commands\HookCommand;
 use Symfony\Component\Console\Application;
 
-$application = new Application('Composer Git Hooks', 'v2.2.0');
+$application = new Application('Composer Git Hooks', git_version());
 
 $hooks = Hook::getValidHooks($dir);
 $application->add(new AddCommand($hooks));

diff --git a/composer.json b/composer.json
@@ -26,7 +26,10 @@
     "autoload": {
         "psr-4": {
             "BrainMaestro\\GitHooks\\": "src/"
-        }
+        },
+        "files": [
+            "src/helpers.php"
+        ]
     },
     "autoload-dev": {
         "psr-4": {

diff --git a/src/Commands/AddCommand.php b/src/Commands/AddCommand.php
@@ -38,11 +38,8 @@ protected function execute(InputInterface $input, OutputInterface $output)
         $gitDir = $input->getOption('git-dir');
         $force = $input->getOption('force');
         $forceWindows = $input->getOption('force-win');
-        $hookDir = "{$gitDir}/hooks";
 
-        if (! is_dir($hookDir)) {
-            mkdir($hookDir, 0700, true);
-        }
+        create_hooks_dir($gitDir);
 
         foreach ($this->hooks as $hook => $script) {
             $filename = "{$gitDir}/hooks/{$hook}";
@@ -51,7 +48,7 @@ protected function execute(InputInterface $input, OutputInterface $output)
             if (! $force && $fileExists) {
                 $output->writeln("<comment>{$hook} already exists</comment>");
             } else {
-                if ($forceWindows || strtoupper(substr(PHP_OS, 0, 3)) === 'WIN') {
+                if ($forceWindows || is_windows()) {
                     // On windows we need to add a SHEBANG
                     // See: https://github.com/BrainMaestro/composer-git-hooks/issues/7
                     $script = '#!/bin/bash' . PHP_EOL . $script;

diff --git a/src/Commands/RemoveCommand.php b/src/Commands/RemoveCommand.php
@@ -60,9 +60,10 @@ protected function execute(InputInterface $input, OutputInterface $output)
                 unlink($filename);
                 $output->writeln("Removed <info>{$hook}</info> hook");
                 unset($lockFileHooks[$hook]);
-            } else {
-                $output->writeln("<error>{$hook} hook does not exist</error>");
+                continue;
             }
+
+            $output->writeln("<error>{$hook} hook does not exist</error>");
         }
 
         file_put_contents(Hook::LOCK_FILE, json_encode(array_keys($lockFileHooks)));

diff --git a/src/Commands/UpdateCommand.php b/src/Commands/UpdateCommand.php
@@ -33,18 +33,15 @@ protected function execute(InputInterface $input, OutputInterface $output)
     {
         $gitDir = $input->getOption('git-dir');
         $forceWindows = $input->getOption('force-win');
-        $hookDir = "{$gitDir}/hooks";
-
-        if (! is_dir($hookDir)) {
-            mkdir($hookDir, 0700, true);
-        }
+
+        create_hooks_dir($gitDir);
 
         foreach ($this->hooks as $hook => $script) {
             $filename = "{$gitDir}/hooks/{$hook}";
 
             $operation = file_exists($filename) ? 'Updated' : 'Added';
 
-            if ($forceWindows || strtoupper(substr(PHP_OS, 0, 3)) === 'WIN') {
+            if ($forceWindows || is_windows()) {
                 // On windows we need to add a SHEBANG
                 // See: https://github.com/BrainMaestro/composer-git-hooks/issues/7
                 $script = '#!/bin/bash' . PHP_EOL . $script;

diff --git a/src/Hook.php b/src/Hook.php
@@ -25,7 +25,7 @@ public static function getValidHooks($dir)
         $validHooks = [];
 
         foreach ($hooks as $hook => $script) {
-            if (array_key_exists($hook, self::getHooks())) {
+            if (self::isValidHook($hook)) {
                 $validHooks[$hook] = $script;
             }
         }

diff --git a/src/helpers.php b/src/helpers.php
@@ -0,0 +1,48 @@
+<?php
+
+use Symfony\Component\Process\Process;
+
+if (! function_exists('create_hooks_dir')) {
+    /**
+     * Create hook directory if not exists.
+     *
+     * @param  string  $dir
+     * @param  int  $mode
+     * @param  bool  $recursive
+     *
+     * @return void
+     */
+    function create_hooks_dir($dir, $mode = 0700, $recursive = true)
+    {
+        if (! is_dir("{$dir}/hooks")) {
+            mkdir("{$dir}/hooks", $mode, $recursive);
+        }
+    }
+}
+
+if (! function_exists('git_version')) {
+    /**
+     * Get latest git tag version.
+     *
+     * @return string
+     */
+    function git_version()
+    {
+        $process = new Process('git describe --tags $(git rev-list --tags --max-count=1)');
+        $process->run();
+
+        return trim($process->getOutput()) ?: 'unreleased';
+    }
+}
+
+if (! function_exists('is_windows')) {
+    /**
+     * Determine whether the current environment is Windows based.
+     *
+     * @return bool
+     */
+    function is_windows()
+    {
+        return strtoupper(substr(PHP_OS, 0, 3)) === 'WIN';
+    }
+}
diff --git a/tests/AddCommandTest.php b/tests/AddCommandTest.php
@@ -38,7 +38,7 @@ public function it_adds_hooks_that_do_not_already_exist()
      */
     public function it_adds_shebang_to_hooks_on_windows()
     {
-        if (strtoupper(substr(PHP_OS, 0, 3)) !== 'WIN') {
+        if (! is_windows()) {
             $this->markTestSkipped('This test is only relevant on windows. You\'re running Linux.');
         }
 
@@ -130,7 +130,7 @@ public function it_ignores_the_hook_lock_file_if_the_ignore_lock_option_is_passe
     public function it_uses_a_different_git_path_if_specified()
     {
         $gitDir = 'test-git-dir';
-        mkdir("{$gitDir}/hooks", 0700, true);
+        create_hooks_dir($gitDir);
         $this->commandTester->execute(['--git-dir' => $gitDir]);
 
         foreach (array_keys(self::$hooks) as $hook) {

diff --git a/tests/ListCommandTest.php b/tests/ListCommandTest.php
@@ -39,7 +39,7 @@ public function it_uses_a_different_git_path_if_specified()
     {
         $gitDir = 'test-git-dir';
 
-        mkdir("{$gitDir}/hooks", 0777, true);
+        create_hooks_dir($gitDir, 0777);
 
         self::createHooks($gitDir);
 

diff --git a/tests/PrepareHookTest.php b/tests/PrepareHookTest.php
@@ -23,9 +23,7 @@ public static function tearDownAfterClass()
 
     public static function createHooks($gitDir = '.git')
     {
-        if (!is_dir("{$gitDir}/hooks")) {
-            mkdir("{$gitDir}/hooks", 0777, true);
-        }
+        create_hooks_dir($gitDir, 0777);
 
         foreach (self::$hooks as $hook => $script) {
             file_put_contents("{$gitDir}/hooks/{$hook}", $script);

diff --git a/tests/RemoveCommandTest.php b/tests/RemoveCommandTest.php
@@ -97,7 +97,7 @@ public function it_uses_a_different_git_path_if_specified()
     {
         $gitDir = 'test-git-dir';
 
-        mkdir("{$gitDir}/hooks", 0777, true);
+        create_hooks_dir($gitDir, 0777);
 
         self::createHooks($gitDir);
         $this->assertFalse(self::isDirEmpty("{$gitDir}/hooks"));

diff --git a/tests/UpdateCommandTest.php b/tests/UpdateCommandTest.php
@@ -48,7 +48,7 @@ public function it_updates_hooks_that_already_exist()
 
     public function it_adds_shebang_to_hooks_on_windows()
     {
-        if (strtoupper(substr(PHP_OS, 0, 3)) !== 'WIN') {
+        if (! is_windows()) {
             $this->markTestSkipped('This test is only relevant on windows. You\'re running Linux.');
         }
 
@@ -71,7 +71,7 @@ public function it_uses_a_different_git_path_if_specified()
     {
         $gitDir = 'test-git-dir';
 
-        mkdir("{$gitDir}/hooks", 0777, true);
+        create_hooks_dir($gitDir, 0777);
 
         $this->commandTester->execute(['--git-dir' => $gitDir]);
 
@@ -104,7 +104,6 @@ public function it_create_git_hooks_path_when_hooks_dir_not_exists()
         rmdir($hookDir);
     }
 
-
     /**
      * @test
      */