Analytics View Helper

config/module.config.php

@@ -6,25 +6,67 @@
         ],
     ],
     'phpab' => [
+        'analytics' => [
+            /**
+             * The name of the service that collects analytics.
+             */
+            'collector' => 'phpab.default_analytics_collector',
+
+            /**
+             * The name of the service that handles analytics after collecting.
+             * You can set this to null to ignore analytics.
+             */
+            'handler' => 'phpab.default_analytics_handler',
+        ],
+
+        /**
+         * The name of the service that loads the default filter for tests.
+         * You can set this to null to ignore the default filter.
+         */
         'default_filter' => 'phpab.default_filter',
+
+        /**
+         * The name of the service that loads the default variant chooser for tests.
+         * You can set this to null to ignore the default variant chooser.
+         */
         'default_variant_chooser' => 'phpab.default_variant_chooser',
+
+        /**
+         * The name of the storage that should be loaded.
+         * For a list with options go to the documentation: https://phpab.github.io/
+         */
         'storage' => 'runtime',
+
+        /**
+         * An array with options for the storage providers.
+         * The options are defined in the documentation: https://phpab.github.io/
+         */
         'storage_options' => [],
+
+        /**
+         * An array with tests, how to define these tests is defined in the documentation: https://phpab.github.io/
+         */
         'tests' => [],
     ],
     'service_manager' => [
         'factories' => [
+            'phpab.default_analytics_handler' => 'PhpAbModule\\Service\\DefaultAnalyticsHandlerFactory',
             'phpab.default_filter' => 'PhpAbModule\\Service\\DefaultFilterFactory',
             'phpab.default_variant_chooser' => 'PhpAbModule\\Service\\DefaultVariantChooserFactory',
             'phpab.dispatcher' => 'PhpAbModule\\Service\\DispatcherFactory',
             'phpab.engine' => 'PhpAbModule\\Service\\EngineFactory',
             'phpab.participation_manager' => 'PhpAbModule\\Service\\ParticipationManagerFactory',
             'phpab.storage' => 'PhpAbModule\\Service\\StorageFactory',
         ],
+        'invokables' => [
+            'phpab.default_analytics_collector' => 'PhpAb\\Analytics\\DataCollector\\\Generic',
+            'phpab.analytics_data_collector' => 'PhpAb\Analytics\Google\DataCollector',
+        ],
     ],
     'view_helpers' => [
         'factories' => [
             'phpAbIsActive' => 'PhpAbModule\\View\\Helper\\Service\\IsActiveFactory',
+            'phpAbScript' => 'PhpAbModule\\View\\Helper\\Service\\ScriptFactory',
         ],
     ],
 ];

config/phpab.global.php.dist

@@ -2,10 +2,67 @@
 
 return [
     'phpab' => [
+        'analytics' => [
+            /**
+             * The name of the service that collects analytics.
+             */
+            'collector' => 'phpab.default_analytics_collector',
+
+            /**
+             * The name of the service that handles analytics after collecting.
+             * You can set this to null to ignore analytics.
+             */
+            'handler' => 'phpab.default_analytics_handler',
+        ],
+
+        /**
+         * The name of the service that loads the default filter for tests.
+         * You can set this to null to ignore the default filter.
+         */
         'default_filter' => 'phpab.default_filter',
+
+        /**
+         * The name of the service that loads the default variant chooser for tests.
+         * You can set this to null to ignore the default variant chooser.
+         */
         'default_variant_chooser' => 'phpab.default_variant_chooser',
+
+        /**
+         * The name of the storage that should be loaded.
+         * For a list with options go to the documentation: https://phpab.github.io/
+         */
         'storage' => 'runtime',
+
+        /**
+         * An array with options for the storage providers.
+         * The options are defined in the documentation: https://phpab.github.io/
+         */
         'storage_options' => [],
+
+        /**
+         * An array with tests, how to define these tests is defined in the documentation: https://phpab.github.io/
+         */
         'tests' => [],
     ],
+    'service_manager' => [
+        'invokables' => [
+            'phpab.analytics_data_collector' => 'PhpAb\Analytics\Google\DataCollector',
+        ],
+        'factories' => [
+            'phpab.default_analytics_handler' => function($serviceManager) {
+                $config = $serviceManager->get('Config');
+
+                if (!$serviceManager->has($config['phpab']['analytics']['collector'])) {
+                    throw new RuntimeException(sprintf(
+                        'The data collector "%s" does not exists.',
+                        $config['phpab']['analytics']['collector']
+                    ));
+                }
+
+                $analyticsData = $serviceManager->get($config['phpab']['analytics']['collector']);
+
+                return new \PhpAb\Analytics\Renderer\GoogleUniversalAnalytics($analyticsData->getTestsData());
+            },
+        ],
+    ],
 ];

src/Controller/Plugin/IsActive.php

@@ -9,7 +9,7 @@
 
 namespace PhpAbModule\Controller\Plugin;
 
-use PhpAb\Participation\ParticipationManagerInterface;
+use PhpAb\Participation\ManagerInterface;
 use Zend\Mvc\Controller\Plugin\AbstractPlugin;
 
 /**
@@ -18,16 +18,16 @@
 class IsActive extends AbstractPlugin
 {
     /**
-     * @var ParticipationManagerInterface The participation manager used to check participation.
+     * @var ManagerInterface The participation manager used to check participation.
      */
     private $participationManager;
 
     /**
      * Initializes a new instance of this class.
      *
-     * @param ParticipationManagerInterface $participationManager The participation manager used to check participation.
+     * @param ManagerInterface $participationManager The participation manager used to check participation.
      */
-    public function __construct(ParticipationManagerInterface $participationManager)
+    public function __construct(ManagerInterface $participationManager)
     {
         $this->participationManager = $participationManager;
     }

src/Service/DefaultAnalyticsHandlerFactory.php

@@ -0,0 +1,35 @@
+<?php
+/**
+ * This file is part of phpab/phpab-module. (https://github.com/phpab/phpab-module)
+ *
+ * @link https://github.com/phpab/phpab-module for the canonical source repository
+ * @copyright Copyright (c) 2015-2016 phpab. (https://github.com/phpab/)
+ * @license https://raw.githubusercontent.com/phpab/phpab-module/master/LICENSE MIT
+ */
+
+namespace PhpAbModule\Service;
+
+use PhpAb\Analytics\Renderer\Google\GoogleUniversalAnalytics;
+use RuntimeException;
+use Zend\ServiceManager\FactoryInterface;
+use Zend\ServiceManager\ServiceLocatorInterface;
+
+class DefaultAnalyticsHandlerFactory implements FactoryInterface
+{
+    public function createService(ServiceLocatorInterface $serviceLocator)
+    {
+        $config = $serviceLocator->get('Config');
+        $collectorServiceName = $config['phpab']['analytics']['collector'];
+
+        if (!$serviceLocator->has($collectorServiceName)) {
+            throw new RuntimeException(sprintf(
+                'The data collector "%s" does not exists.',
+                $config['phpab']['analytics']['collector']
+            ));
+        }
+
+        $analyticsData = $serviceLocator->get($collectorServiceName);
+
+        return new GoogleUniversalAnalytics($analyticsData->getTestsData());
+    }
+}

src/Service/DefaultFilterFactory.php

@@ -9,14 +9,14 @@
 
 namespace PhpAbModule\Service;
 
-use PhpAb\Participation\PercentageFilter;
+use PhpAb\Participation\Filter\Percentage;
 use Zend\ServiceManager\FactoryInterface;
 use Zend\ServiceManager\ServiceLocatorInterface;
 
 class DefaultFilterFactory implements FactoryInterface
 {
     public function createService(ServiceLocatorInterface $serviceLocator)
     {
-        return new PercentageFilter(100);
+        return new Percentage(100);
     }
 }

src/Service/DefaultVariantChooserFactory.php

@@ -9,7 +9,7 @@
 
 namespace PhpAbModule\Service;
 
-use PhpAb\Variant\RandomChooser;
+use PhpAb\Variant\Chooser\RandomChooser;
 use Zend\ServiceManager\FactoryInterface;
 use Zend\ServiceManager\ServiceLocatorInterface;
 

src/Service/DispatcherFactory.php

@@ -11,6 +11,7 @@
 
 use PhpAb\Engine\Engine;
 use PhpAb\Event\Dispatcher;
+use PhpAb\Event\SubscriberInterface;
 use PhpAb\Storage\Cookie;
 use PhpAb\Storage\Runtime;
 use PhpAb\Storage\Session;
@@ -22,6 +23,24 @@ class DispatcherFactory implements FactoryInterface
 {
     public function createService(ServiceLocatorInterface $serviceLocator)
     {
-        return new Dispatcher();
+        $dispatcher = new Dispatcher();
+
+        $config = $serviceLocator->get('Config');
+        $collectorName = $config['phpab']['analytics']['collector'];
+
+        if ($collectorName && $serviceLocator->has($collectorName)) {
+            $dataCollector = $serviceLocator->get($collectorName);
+
+            if (!$dataCollector instanceof SubscriberInterface) {
+                throw new RuntimeException(sprintf(
+                    'The data collector is not an instance of %s',
+                    SubscriberInterface::class
+                ));
+            }
+
+            $dispatcher->addSubscriber($dataCollector);
+        }
+
+        return $dispatcher;
     }
 }

src/View/Helper/IsActive.php

@@ -9,7 +9,7 @@
 
 namespace PhpAbModule\View\Helper;
 
-use PhpAb\Participation\ParticipationManagerInterface;
+use PhpAb\Participation\ManagerInterface;
 use Zend\View\Helper\AbstractHelper;
 
 /**
@@ -18,16 +18,16 @@
 class IsActive extends AbstractHelper
 {
     /**
-     * @var ParticipationManagerInterface The participation manager used to check participation.
+     * @var ManagerInterface The participation manager used to check participation.
      */
     private $participationManager;
 
     /**
      * Initializes a new instance of this class.
      *
-     * @param ParticipationManagerInterface $participationManager The participation manager used to check participation.
+     * @param ManagerInterface $participationManager The participation manager used to check participation.
      */
-    public function __construct(ParticipationManagerInterface $participationManager)
+    public function __construct(ManagerInterface $participationManager)
     {
         $this->participationManager = $participationManager;
     }

src/View/Helper/Script.php

@@ -0,0 +1,50 @@
+<?php
+/**
+ * This file is part of phpab/phpab-module. (https://github.com/phpab/phpab-module)
+ *
+ * @link https://github.com/phpab/phpab-module for the canonical source repository
+ * @copyright Copyright (c) 2015-2016 phpab. (https://github.com/phpab/)
+ * @license https://raw.githubusercontent.com/phpab/phpab-module/master/LICENSE MIT
+ */
+
+namespace PhpAbModule\View\Helper;
+
+use PhpAb\Analytics\Renderer\AbstractGoogleAnalytics;
+use PhpAb\Analytics\Renderer\JavascriptRendererInterface;
+use PhpAb\Analytics\Renderer\RendererInterface;
+use Zend\View\Helper\AbstractHelper;
+
+/**
+ * A view helper that can be used to render a script for analytics.
+ */
+class Script extends AbstractHelper
+{
+    /**
+     * @var RendererInterface
+     */
+    private $renderer;
+
+    /**
+     * Initializes a new instance of this class.
+     *
+     * @param RendererInterface $renderer The analytics to render a script for.
+     */
+    public function __construct(RendererInterface $renderer)
+    {
+        $this->renderer = $renderer;
+    }
+
+    /**
+     * Generates the script that is needed to make phpab work.
+     *
+     * @return string
+     */
+    public function __invoke()
+    {
+        if ($this->renderer instanceof JavascriptRendererInterface) {
+            return $this->renderer->getScript();
+        }
+
+        return '';
+    }
+}

src/View/Helper/Service/ScriptFactory.php

@@ -0,0 +1,36 @@
+<?php
+/**
+ * This file is part of phpab/phpab-module. (https://github.com/phpab/phpab-module)
+ *
+ * @link https://github.com/phpab/phpab-module for the canonical source repository
+ * @copyright Copyright (c) 2015-2016 phpab. (https://github.com/phpab/)
+ * @license https://raw.githubusercontent.com/phpab/phpab-module/master/LICENSE MIT
+ */
+
+namespace PhpAbModule\View\Helper\Service;
+
+use PhpAbModule\View\Helper\Script;
+use RuntimeException;
+use Zend\ServiceManager\FactoryInterface;
+use Zend\ServiceManager\ServiceLocatorInterface;
+
+class ScriptFactory implements FactoryInterface
+{
+    public function createService(ServiceLocatorInterface $serviceLocator)
+    {
+        $serviceManager = $serviceLocator->getServiceLocator();
+
+        $config = $serviceManager->get('Config');
+
+        if (!$serviceManager->has($config['phpab']['analytics']['renderer'])) {
+            throw new RuntimeException(sprintf(
+                'The data renderer "%s" does not exists.',
+                $config['phpab']['analytics']['renderer']
+            ));
+        }
+
+        $renderer = $serviceManager->get($config['phpab']['analytics']['renderer']);
+
+        return new Script($renderer);
+    }
+}

tests/PhpAbModuleTest/Controller/Plugin/IsActiveTest.php

@@ -9,7 +9,7 @@
 
 namespace PhpAbModuleTest\Controller\Plugin;
 
-use PhpAb\Participation\ParticipationManagerInterface;
+use PhpAb\Participation\ManagerInterface;
 use PhpAbModule\Controller\Plugin\IsActive;
 use PHPUnit_Framework_MockObject_MockObject;
 use PHPUnit_Framework_TestCase;
@@ -23,7 +23,7 @@ class IsActiveTest extends PHPUnit_Framework_TestCase
 
     protected function setUp()
     {
-        $this->participationManager = $this->getMockForAbstractClass(ParticipationManagerInterface::class);
+        $this->participationManager = $this->getMockForAbstractClass(ManagerInterface::class);
     }
 
     public function testWithParticipationManagerReturningTrue()