Split LiveCodeCoverage

Author: matthiasnoback

src/LiveCodeCoverage/CodeCoverageFactory.php

@@ -16,7 +16,7 @@ public static function createFromPhpUnitConfiguration($phpunitFilePath)
         $codeCoverage = self::createDefault();
 
         // Accomodate for PHPUnit 5.7
-        if (class_exists('PHPUnit_Util_Configuration')) {
+        if (!class_exists('PHPUnit\Util\Configuration')) {
             class_alias('PHPUnit_Util_Configuration', 'PHPUnit\Util\Configuration');
         }
 

src/LiveCodeCoverage/LiveCodeCoverage.php

@@ -59,68 +59,22 @@ public static function bootstrap($collectCodeCoverage, $storageDirectory, $phpun
         return [$liveCodeCoverage, 'stopAndSave'];
     }
 
-    /**
-     * @param bool $coverageEnabled
-     * @param string $storageDirectory
-     * @param null $phpunitConfigFilePath
-     * @return callable
-     */
-    public static function bootstrapRemoteCoverage($coverageEnabled, $storageDirectory, $phpunitConfigFilePath = null)
-    {
-        Assert::boolean($coverageEnabled);
-        if (!$coverageEnabled) {
-            return function () {
-                // do nothing - code coverage is not enabled
-            };
-        }
-
-        $coverageGroup = isset($_GET['coverage_group']) ? $_GET['coverage_group'] :
-            (isset($_COOKIE['coverage_group']) ? $_COOKIE['coverage_group'] : null);
-
-        $storageDirectory .= ($coverageGroup ? '/' . $coverageGroup : '');
-
-        if (isset($_GET['export_code_coverage'])) {
-            self::exportCoverageData($storageDirectory);
-            exit;
-        }
-
-        $coverageId = isset($_GET['coverage_id']) ? $_GET['coverage_id'] :
-            (isset($_COOKIE['coverage_id']) ? $_COOKIE['coverage_id'] : 'live-coverage');
-
-        return self::bootstrap(
-            isset($_COOKIE['collect_code_coverage']) && (bool)$_COOKIE['collect_code_coverage'],
-            $storageDirectory,
-            $phpunitConfigFilePath,
-            $coverageId
-        );
-    }
-
     private function start()
     {
         $this->codeCoverage->start($this->coverageId);
     }
 
     /**
-     * @param $coverageDirectory
-     * @return void
+     * Stop collecting code coverage data and save it.
      */
-    public static function exportCoverageData($coverageDirectory)
-    {
-        $codeCoverage = Storage::loadFromDirectory($coverageDirectory);
-
-        header('Content-Type: text/plain');
-        echo serialize($codeCoverage);
-    }
-
     public function stopAndSave()
     {
         $this->codeCoverage->stop();
 
-        Storage::storeCodeCoverage($this->codeCoverage, $this->storageDirectory, $this->covFileName());
-    }
-
-    private function covFileName()
-    {
-        return uniqid(date('YmdHis'), true);
+        Storage::storeCodeCoverage(
+            $this->codeCoverage,
+            $this->storageDirectory,
+            uniqid(date('YmdHis'), true)
+        );
     }
 }

src/LiveCodeCoverage/RemoteCodeCoverage.php

@@ -0,0 +1,65 @@
+<?php
+
+namespace LiveCodeCoverage;
+
+use Webmozart\Assert\Assert;
+
+final class RemoteCodeCoverage
+{
+    const COVERAGE_ID_KEY = 'coverage_id';
+    const COLLECT_CODE_COVERAGE_KEY = 'collect_code_coverage';
+    const COVERAGE_GROUP_KEY = 'coverage_group';
+    const EXPORT_CODE_COVERAGE_KEY = 'export_code_coverage';
+
+    /**
+     * Enable remote code coverage.
+     *
+     * @param bool $coverageEnabled Whether or not code coverage should be enabled
+     * @param string $storageDirectory Where to store the generated coverage data files
+     * @param string $phpunitConfigFilePath The path to the PHPUnit XML file containing the coverage filter configuration
+     * @return callable Call this value at the end of the request life cycle.
+     */
+    public static function bootstrap($coverageEnabled, $storageDirectory, $phpunitConfigFilePath = null)
+    {
+        Assert::boolean($coverageEnabled);
+        if (!$coverageEnabled) {
+            return function () {
+                // do nothing - code coverage is not enabled
+            };
+        }
+
+        $coverageGroup = isset($_GET[self::COVERAGE_GROUP_KEY]) ? $_GET[self::COVERAGE_GROUP_KEY] :
+            (isset($_COOKIE[self::COVERAGE_GROUP_KEY]) ? $_COOKIE[self::COVERAGE_GROUP_KEY] : null);
+
+        $storageDirectory .= ($coverageGroup ? '/' . $coverageGroup : '');
+
+        if (isset($_GET[self::EXPORT_CODE_COVERAGE_KEY])) {
+            header('Content-Type: text/plain');
+            echo self::exportCoverageData($storageDirectory);
+            exit;
+        }
+
+        $coverageId = isset($_GET[self::COVERAGE_ID_KEY]) ? $_GET[self::COVERAGE_ID_KEY] :
+            (isset($_COOKIE[self::COVERAGE_ID_KEY]) ? $_COOKIE[self::COVERAGE_ID_KEY] : 'live-coverage');
+
+        return LiveCodeCoverage::bootstrap(
+            isset($_COOKIE[self::COLLECT_CODE_COVERAGE_KEY]) && (bool)$_COOKIE[self::COLLECT_CODE_COVERAGE_KEY],
+            $storageDirectory,
+            $phpunitConfigFilePath,
+            $coverageId
+        );
+    }
+
+    /**
+     * Get previously collected coverage data (combines all coverage data stored in the given directory, merges and serializes it).
+     *
+     * @param string $coverageDirectory
+     * @return string
+     */
+    public static function exportCoverageData($coverageDirectory)
+    {
+        $codeCoverage = Storage::loadFromDirectory($coverageDirectory);
+
+        return serialize($codeCoverage);
+    }
+}

src/LiveCodeCoverage/Storage.php

@@ -36,6 +36,8 @@ public static function storeCodeCoverage(CodeCoverage $coverage, $storageDirecto
      */
     public static function loadFromDirectory($storageDirectory)
     {
+        Assert::string($storageDirectory);
+
         $coverage = new CodeCoverage();
 
         if (!is_dir($storageDirectory)) {