Do not export empty, disabled, or included configs

This change is done to not clutter the configuration with unnecessary
hook configurations, and to make sure when changing a configuration file
with 'enable' or 'disable' commands, we do not double actions that are
included from other files.

Issue: #278

Author: sebastianfeldmann

src/Config.php

@@ -412,7 +412,9 @@ public function getJsonData(): array
             $data['config']['custom'] = $this->custom;
         }
         foreach (Hooks::getValidHooks() as $hook => $value) {
-            $data[$hook] = $this->hooks[$hook]->getJsonData();
+            if ($this->hooks[$hook]->isEnabled() || $this->hooks[$hook]->hasActions()) {
+                $data[$hook] = $this->hooks[$hook]->getJsonData();
+            }
         }
         return $data;
     }

src/Config/Action.php

@@ -61,6 +61,13 @@ class Action
         Config::SETTING_LABEL
     ];
 
+    /**
+     * Indicates if an action config was included from another file
+     *
+     * @var bool
+     */
+    private bool $isIncluded = false;
+
     /**
      * Action constructor
      *
@@ -114,6 +121,26 @@ private function setupSettings(array $settings): void
         }
     }
 
+    /**
+     * Marks a action config as included
+     *
+     * @return void
+     */
+    public function markIncluded(): void
+    {
+        $this->isIncluded = true;
+    }
+
+    /**
+     * Check if an action config was included
+     *
+     * @return bool
+     */
+    public function isIncluded(): bool
+    {
+        return $this->isIncluded;
+    }
+
     /**
      * Indicates if the action can fail without stopping the git operation
      *

src/Config/Factory.php

@@ -291,7 +291,7 @@ private function mergeHookConfigFromIncludes(Hook $hook, array $includes): void
                 // empty hook config just to enable the included actions feels a bit dull.
                 // Since the main hook is processed last (if one is configured) the enabled flag will be overwritten
                 // once again by the main config value. This is to make sure that if somebody disables a hook in its
-                // main configuration no actions will get executed, even if we have enabled hooks in any include file.
+                // main configuration, no actions will get executed, even if we have enabled hooks in any include file.
                 $this->copyActionsFromTo($includedHook, $hook);
             }
         }
@@ -326,6 +326,7 @@ protected function loadIncludedConfigs(array $json, string $path): array
     private function copyActionsFromTo(Hook $sourceConfig, Hook $targetConfig): void
     {
         foreach ($sourceConfig->getActions() as $action) {
+            $action->markIncluded();
             $targetConfig->addAction($action);
         }
     }

src/Config/Hook.php

@@ -86,6 +86,16 @@ public function isEnabled(): bool
         return $this->isEnabled;
     }
 
+    /**
+     * Check if a hook config has actions
+     *
+     * @return bool
+     */
+    public function hasActions(): bool
+    {
+        return !empty($this->actions);
+    }
+
     /**
      * Add an action to the list
      *
@@ -118,7 +128,9 @@ public function getJsonData(): array
     {
         $config = ['enabled' => $this->isEnabled, 'actions' => []];
         foreach ($this->actions as $action) {
-            $config['actions'][] = $action->getJsonData();
+            if (!$action->isIncluded()) {
+                $config['actions'][] = $action->getJsonData();
+            }
         }
         return $config;
     }

tests/unit/ConfigTest.php

@@ -157,15 +157,17 @@ public function testFailOnFirstErrorCanBeChanged(): void
         $this->assertFalse($config->failOnFirstError());
     }
 
-    public function testCanBeExportedToJsonData(): void
+    public function testExportsOnlyEnabledHooksOrHooksWithActionsToJsonData(): void
     {
         $config = new Config('./no-config.json');
+        $config->getHookConfig('pre-commit')->setEnabled(true);
+        $config->getHookConfig('pre-push')->addAction(new Action('foo'));
         $json   = $config->getJsonData();
 
         $this->assertIsArray($json);
         $this->assertIsArray($json['pre-commit']);
-        $this->assertIsArray($json['commit-msg']);
         $this->assertIsArray($json['pre-push']);
+        $this->assertFalse(array_key_exists('commit-msg', $json));
     }
 
     public function testCanBeExportedToJsonDataWithSettings(): void
@@ -180,9 +182,6 @@ public function testCanBeExportedToJsonDataWithSettings(): void
         $this->assertIsArray($json);
         $this->assertIsArray($json['config']);
         $this->assertIsArray($json['config']['run']);
-        $this->assertIsArray($json['pre-commit']);
-        $this->assertIsArray($json['commit-msg']);
-        $this->assertIsArray($json['pre-push']);
     }
 
     public function testGetJsonDataWithoutEmptyConfig(): void
@@ -204,6 +203,21 @@ public function testGetJsonDataWithConfigSection(): void
         $this->assertArrayNotHasKey('plugins', $json);
     }
 
+    public function testDoesNotExportIncludedActionsToJson(): void
+    {
+        $localAction    = new Action('foo');
+        $includedAction = new Action('bar');
+        $includedAction->markIncluded();
+
+        $config = new Config('foo.json', true, []);
+        $config->getHookConfig('pre-commit')->setEnabled(true);
+        $config->getHookConfig('pre-commit')->addAction($localAction);
+        $config->getHookConfig('pre-commit')->addAction($includedAction);
+
+        $json = $config->getJsonData();
+        $this->assertCount(1, $json['pre-commit']['actions']);
+    }
+
     public function testGetPluginsReturnsEmptyArray(): void
     {
         $config = new Config('foo.json');

tests/unit/Runner/Config/CreatorTest.php

@@ -76,7 +76,6 @@ public function testConfigureFileExtend(): void
         $configFileContentAfter = $configDir->getChild('captainhook.json')->getContent();
         $this->assertFileExists($configFile);
         $this->assertStringContainsString('pre-commit', $configFileContentAfter);
-        $this->assertStringContainsString('pre-push', $configFileContentAfter);
         $this->assertStringContainsString('phpunit', $configFileContentAfter);
     }
 }