Split auto-detect driver into separate drivers; add Factory, Stub, and HHVM drivers (and unit tests)

Author: robocoder

src/VIPSoft/CodeCoverageCommon/Driver.php

@@ -0,0 +1,53 @@
+<?php
+/**
+ * Code Coverage Driver Factory
+ *
+ * @copyright 2013 Anthon Pang
+ * @license BSD-3-Clause
+ */
+
+namespace VIPSoft\CodeCoverageCommon\Driver;
+
+use PHP_CodeCoverage_Driver as DriverInterface;
+
+/**
+ * Driver factory
+ *
+ * @author Anthon Pang <apang@softwaredevelopment.ca>
+ */
+class Factory
+{
+    /**
+     * @var array
+     */
+    private $driverClasses;
+
+    /**
+     * Constructor
+     *
+     * @param array $driverClasses List of namespaced driver classes
+     */
+    public function __construct(array $driverClasses)
+    {
+        $this->driverClasses = $driverClasses;
+    }
+
+    /**
+     * Create driver
+     *
+     * @return DriverInterface
+     */
+    public function create()
+    {
+        foreach ($this->driverClasses as $driverClass) {
+            try {
+                $driver = new $driverClass();
+
+                return $driver;
+            } catch (\Exception $e) {
+            }
+        }
+
+        return null;
+    }
+}

src/VIPSoft/CodeCoverageCommon/Driver/Factory.php

@@ -0,0 +1,53 @@
+<?php
+/**
+ * HHVM Code Coverage Driver
+ *
+ * @copyright 2013 Anthon Pang
+ * @license BSD-3-Clause
+ */
+
+namespace VIPSoft\CodeCoverageCommon\Driver;
+
+use PHP_CodeCoverage_Driver as DriverInterface;
+
+/**
+ * HHVM (Hip Hop VM) Driver
+ *
+ * {@internal Derived from PHP_CodeCoverage_Driver_Xdebug.}
+ *
+ * @author Anthon Pang <apang@softwaredevelopment.ca>
+ */
+class HHVM implements DriverInterface
+{
+    /**
+     * Constructor
+     *
+     * @throws \PHP_CodeCoverage_Exception if PHP code coverage not enabled
+     */
+    public function __construct()
+    {
+        if ( ! defined('HPHP_VERSION')) {
+            throw new \PHP_CodeCoverage_Exception('This driver requires HHVM');
+        }
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function start()
+    {
+        fb_enable_code_coverage();
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function stop()
+    {
+        $codeCoverage = fb_get_code_coverage(true);
+
+        fb_disable_code_coverage();
+
+        return $codeCoverage;
+    }
+}

src/VIPSoft/CodeCoverageCommon/Driver/HHVM.php

@@ -0,0 +1,59 @@
+<?php
+/**
+ * Code Coverage Stub Driver
+ *
+ * @copyright 2013 Anthon Pang
+ * @license BSD-3-Clause
+ */
+
+namespace VIPSoft\CodeCoverageCommon\Driver;
+
+use PHP_CodeCoverage_Driver as DriverInterface;
+
+/**
+ * Stub driver
+ *
+ * @author Anthon Pang <apang@softwaredevelopment.ca>
+ */
+class Stub implements DriverInterface
+{
+    private $driver;
+
+    /**
+     * Register driver
+     *
+     * @param DriverInterface $driver
+     */
+    public function setDriver(DriverInterface $driver)
+    {
+        $this->driver = $driver;
+    }
+
+    /**
+     * Get driver
+     *
+     * @return DriverInterface $driver
+     */
+    public function getDriver()
+    {
+        return $this->driver;
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function start()
+    {
+        if ($this->driver) {
+            $this->driver->start();
+        }
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function stop()
+    {
+        return $this->driver ? $this->driver->stop() : false;
+    }
+}

src/VIPSoft/CodeCoverageCommon/Driver/Stub.php

@@ -0,0 +1,59 @@
+<?php
+/**
+ * XCache Code Coverage Driver
+ *
+ * @copyright 2013 Anthon Pang
+ * @license BSD-3-Clause
+ */
+
+namespace VIPSoft\CodeCoverageCommon\Driver;
+
+use PHP_CodeCoverage_Driver as DriverInterface;
+
+/**
+ * XCache Driver
+ *
+ * {@internal Derived from PHP_CodeCoverage_Driver_Xdebug.}
+ *
+ * @author Anthon Pang <apang@softwaredevelopment.ca>
+ */
+class XCache implements DriverInterface
+{
+    /**
+     * Constructor
+     *
+     * @throws \PHP_CodeCoverage_Exception if PHP code coverage not enabled
+     */
+    public function __construct()
+    {
+        if ( ! extension_loaded('xcache')) {
+            throw new \PHP_CodeCoverage_Exception('This driver requires XCache');
+        }
+
+        if (version_compare(phpversion('xcache'), '1.2.0', '<') ||
+            ! ini_get('xcache.coverager')
+        ) {
+            throw new \PHP_CodeCoverage_Exception('xcache.coverager=On has to be set in php.ini');
+        }
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function start()
+    {
+        xcache_coverager_start();
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function stop()
+    {
+        $codeCoverage = xcache_coverager_get();
+
+        xcache_coverager_stop(true);
+
+        return $codeCoverage;
+    }
+}