Some improvements

- Don't use the shutdown function by default
- Don't use the coverage ID in the filename
- Create the coverage directory if it doesn't exist

Author: matthiasnoback

README.md

@@ -12,21 +12,21 @@ composer require matthiasnoback/live-code-coverage
 
 ## Collecting code coverage data
 
-At the top of your front controller (e.g. `index.php`), add the following:
+In your front controller (e.g. `index.php`), add the following:
 
 ```php
 <?php
 
-require __DIR__ . '/../vendor/autoload.php';
-
 use LiveCodeCoverage\LiveCodeCoverage;
 
-LiveCodeCoverage::bootstrap(
-    __DIR__ . '/../coverage',
+$liveCodeCoverage = LiveCodeCoverage::bootstrap(
+    __DIR__ . '/../var/coverage',
     __DIR__ . '/../phpunit.xml.dist'
 );
 
 // Run your web application now
+
+$liveCodeCoverage->stopAndSave();
 ```
 
 - The first argument is the directory where all the collected coverage data will be stored (`*.cov` files). This directory should already exist and be writable.
@@ -47,12 +47,23 @@ Any configuration directive that's [available in PHPUnit](https://phpunit.de/man
 
 If you don't provide a PHPUnit configuration file, no filters will be applied, so you will get a coverage report for all the code in your project, including vendor and test code if applicable.
 
+If your application is a legacy application which `exit()`s or `die()`s before execution reaches the end of your front controller, the bootstrap should be slightly different:
+
+```php
+$liveCodeCoverage = LiveCodeCoverage::bootstrap(
+    // ...
+);
+$liveCodeCoverage->stopAndSaveOnExit();
+
+// Run your web application now
+```
+
 ## Generating code coverage reports (HTML, Clover, etc.)
 
 To merge all the coverage data and generate a report for it, install Sebastian Bergmann's [`phpcov` tool](https://github.com/sebastianbergmann/phpcov). Run it like this (or in any other way you like):
 
 ```bash
-phpcov merge --html=./coverage/html ./coverage
+phpcov merge --html=./coverage/html ./var/coverage
 ```
 
 ## Downsides

src/LiveCodeCoverage/LiveCodeCoverage.php

@@ -22,17 +22,14 @@ final class LiveCodeCoverage
      */
     private $storageDirectory;
 
-    private function __construct(CodeCoverage $codeCoverage, $storageDirectory, $coverage_id)
+    private function __construct(CodeCoverage $codeCoverage, $storageDirectory, $coverageId)
     {
-        Assert::regex($coverage_id, '/^[\w\-]+$/');
         $this->codeCoverage = $codeCoverage;
-        $this->coverageId = $coverage_id;
-        Assert::directory($storageDirectory);
-        Assert::writable($storageDirectory);
+        $this->coverageId = $coverageId;
         $this->storageDirectory = $storageDirectory;
     }
 
-    public static function bootstrap($storageDirectory, $phpunitConfigFilePath = null, $coverage_id = 'live-coverage')
+    public static function bootstrap($storageDirectory, $phpunitConfigFilePath = null, $coverageId = 'live-coverage')
     {
         if ($phpunitConfigFilePath !== null) {
             Assert::file($phpunitConfigFilePath);
@@ -41,33 +38,32 @@ public static function bootstrap($storageDirectory, $phpunitConfigFilePath = nul
             $codeCoverage = CodeCoverageFactory::createDefault();
         }
 
-        $liveCodeCoverage = new self($codeCoverage, $storageDirectory, $coverage_id);
+        $liveCodeCoverage = new self($codeCoverage, $storageDirectory, $coverageId);
 
         $liveCodeCoverage->start();
-        register_shutdown_function([$liveCodeCoverage, 'stopAndSave']);
+
+        return $liveCodeCoverage;
     }
 
     private function start()
     {
         $this->codeCoverage->start($this->coverageId);
     }
 
+    public function stopAndSaveOnExit()
+    {
+        register_shutdown_function([$this, 'stopAndSave']);
+    }
+
     public function stopAndSave()
     {
         $this->codeCoverage->stop();
 
-        $cov = '<?php return unserialize(' . var_export(serialize($this->codeCoverage), true) . ');';
-        file_put_contents($this->generateCovFileName(), $cov);
+        Storage::storeCodeCoverage($this->codeCoverage, $this->storageDirectory, $this->covFileName());
     }
 
-    private function generateCovFileName()
+    private function covFileName()
     {
-        $fileNameParts = [
-            $this->coverageId,
-            date('YmdHis'),
-            uniqid('', true)
-        ];
-
-        return $this->storageDirectory . '/' . implode('-', $fileNameParts) . '.cov';
+        return uniqid(date('YmdHis'), true);
     }
 }

src/LiveCodeCoverage/Storage.php

@@ -0,0 +1,58 @@
+<?php
+
+namespace LiveCodeCoverage;
+
+use DirectoryIterator;
+use SebastianBergmann\CodeCoverage\CodeCoverage;
+use Webmozart\Assert\Assert;
+
+final class Storage
+{
+    /**
+     * @param CodeCoverage $coverage
+     * @param string $storageDirectory
+     * @param $name
+     * @return void
+     * @throws \RuntimeException
+     */
+    public static function storeCodeCoverage(CodeCoverage $coverage, $storageDirectory, $name)
+    {
+        Assert::string($storageDirectory);
+
+        if (!is_dir($storageDirectory)) {
+            if (!mkdir($storageDirectory, 0777, true) && !is_dir($storageDirectory)) {
+                throw new \RuntimeException(sprintf('Could not create directory "%s"', $storageDirectory));
+            }
+        }
+
+        $cov = '<?php return unserialize(' . var_export(serialize($coverage), true) . ');';
+        $filePath = $storageDirectory . '/' . $name . '.cov';
+        file_put_contents($filePath, $cov);
+    }
+
+    /**
+     * @param string $storageDirectory
+     * @return CodeCoverage
+     */
+    public static function loadFromDirectory($storageDirectory)
+    {
+        $coverage = new CodeCoverage();
+
+        if (!is_dir($storageDirectory)) {
+            return $coverage;
+        }
+
+        foreach (new DirectoryIterator($storageDirectory) as $file) {
+            if ($file->isDot()) {
+                continue;
+            }
+
+            $partialCodeCoverage = include $file->getPathname();
+            Assert::isInstanceOf($partialCodeCoverage, CodeCoverage::class);
+
+            $coverage->merge($partialCodeCoverage);
+        }
+
+        return $coverage;
+    }
+}

test/functional/LiveCodeCoverageTest.php

@@ -39,19 +39,10 @@ public function it_generates_cov_files_with_serialized_CodeCoverage_objects()
 
         foreach ($finder as $covFile) {
             $filePath = (string)$covFile;
-            $this->assertFileNameStartsWithExpectedPrefix($filePath);
             $this->assertIncludedFileReturnsCodeCoverageObject($filePath);
         }
     }
 
-    /**
-     * @param $filePath
-     */
-    private function assertFileNameStartsWithExpectedPrefix($filePath)
-    {
-        $this->assertRegExp('/^live-coverage/', basename($filePath));
-    }
-
     /**
      * @param $filePath
      */

test/functional/prepend.php

@@ -2,4 +2,5 @@
 
 use LiveCodeCoverage\LiveCodeCoverage;
 
-LiveCodeCoverage::bootstrap(__DIR__ . '/coverage', __DIR__ . '/phpunit.xml.dist');
+$liveCodeCoverage = LiveCodeCoverage::bootstrap(__DIR__ . '/coverage', __DIR__ . '/phpunit.xml.dist');
+$liveCodeCoverage->stopAndSaveOnExit();