Improvements with zf3, php5.5 and better tests

.travis.yml

@@ -1,18 +1,22 @@
 language: php
 
-matrix:
-  fast_finish: true
-  include:
-    - php: 5.5
-    - php: 5.6
-    - php: 7
-    - php: hhvm
-  allow_failures:
-    - php: hhvm
+php:
+  - 5.5
+  - 5.6
+  - 7
+  - hhvm
+
+env:
+  - DEPS=lowest
+  - DEPS=latest
 
-install:
+before_script:
+  - composer self-update
+  - if [[ $DEPS == 'lowest' ]]; then travis_retry composer update --prefer-lowest --prefer-stable --no-interaction ; fi
   - travis_retry composer install --no-interaction
-  - composer info -i
 
 script:
-  - ./vendor/bin/phpunit
+  - composer test
+
+matrix:
+  fast_finish: true

composer.json

@@ -19,35 +19,38 @@
         }
     ],
     "require": {
-        "php": ">=5.5 || ^7.0",
-        "maximebf/debugbar": "1.*",
-        "zendframework/zend-mvc": "2.* || ^3.0",
-        "zendframework/zend-log": "2.*",
-        "zendframework/zend-servicemanager": "~2.6 || ^3.0",
-        "zendframework/zend-view": "2.*",
-        "zendframework/zend-eventmanager": "2.* || ^3.0",
-        "zendframework/zend-http": "2.*",
-        "zendframework/zend-modulemanager": "2.*"
+        "php": "^5.5 || ^7.0",
+        "maximebf/debugbar": "^1.10",
+        "zendframework/zend-mvc": "^2.4 || ^3.0",
+        "zendframework/zend-log": "^2.4",
+        "zendframework/zend-servicemanager": "^2.6 || ^3.0",
+        "zendframework/zend-view": "^2.4",
+        "zendframework/zend-eventmanager": "^2.4 || ^3.0",
+        "zendframework/zend-http": "^2.4",
+        "zendframework/zend-modulemanager": "^2.4"
     },
     "require-dev": {
-        "phpunit/phpunit": "~4.0",
-        "zendframework/zend-test": "2.* || ^3.0",
-        "zendframework/zend-config": "2.*",
-        "zendframework/zend-serializer": "2.*",
-        "zendframework/zend-i18n": "2.*",
-        "zendframework/zend-db": "2.*"
+        "phpunit/phpunit": "^4.0 || ^5.0",
+        "zendframework/zend-test": "^2.4 || ^3.0",
+        "zendframework/zend-config": "^2.4",
+        "zendframework/zend-serializer": "^2.4",
+        "zendframework/zend-i18n": "^2.4",
+        "zendframework/zend-db": "^2.4"
     },
     "autoload": {
-        "psr-0": {
-            "ZfSnapPhpDebugBar": "src/"
+        "psr-4": {
+            "ZfSnapPhpDebugBar\\": "src/"
         },
-        "classmap": [
-            "./Module.php"
+        "files": [
+            "src/Functions.php"
         ]
     },
     "autoload-dev": {
         "psr-4": {
             "ZfSnapPhpDebugBar\\Tests\\": "tests/"
         }
+    },
+    "scripts": {
+        "test": "phpunit"
     }
 }

config/aliases.config.php

@@ -0,0 +1,19 @@
+<?php
+
+/**
+ * Aliases for ZF3 (it's case sensitive)
+ */
+return [
+    'service_manager' => [
+        'aliases' => [
+            'DebugBar' => 'debugbar',
+            'Debugbar' => 'debugbar',
+        ],
+    ],
+    'view_helpers' => [
+        'aliases' => [
+            'DebugBar' => 'debugbar',
+            'Debugbar' => 'debugbar',
+        ],
+    ],
+];

config/zfsnapphpdebugbar.config.php

@@ -1,54 +1,64 @@
 <?php
 
-return array(
-    'php-debug-bar' => array(
-        'view' => array(
+return [
+    'php-debug-bar' => [
+        'view' => [
             'custom-style-path' => 'zf-snap-php-debug-bar.css',
-        ),
-        // Enables/disables PHP Debug Bar
+        ],
         'enabled' => true,
-
         'auto-append-assets' => true,
-
-        'zend-db-adapter-service-name' => 'Zend\Db\Adapter\Adapter',
-
-        // ServiceManager keys to inject collectors
+        'render-on-shutdown' => true,
+        'zend-db-adapter-service-name' => Zend\Db\Adapter\Adapter::class,
+        // ServiceManager service keys to inject collectors
         // http://phpdebugbar.com/docs/data-collectors.html
-        'collectors' => array(),
-
-        // ServiceManager key to inject storage
+        'collectors' => [],
+        // ServiceManager service key to inject storage
         // http://phpdebugbar.com/docs/storage.html
         'storage' => null,
-    ),
-    'controllers' => array(
-        'invokables' => array(
-            'ZfSnapPhpDebugBar\Controller\Resources' => 'ZfSnapPhpDebugBar\Controller\Resources',
-        ),
-    ),
-    'router' => array(
-        'routes' => array(
-            'phpdebugbar-resource' => array(
+    ],
+    'service_manager' => [
+        'invokables' => [
+            DebugBar\DebugBar::class => DebugBar\StandardDebugBar::class,
+        ],
+        'factories' => [
+            'debugbar' => ZfSnapPhpDebugBar\Service\PhpDebugBarFactory::class,
+            ZfSnapPhpDebugBar\Log\Writer\PhpDebugBar::class => ZfSnapPhpDebugBar\Log\Writer\PhpDebugBarFactory::class,
+        ],
+    ],
+    'controllers' => [
+        'invokables' => [
+            ZfSnapPhpDebugBar\Controller\Resources::class => ZfSnapPhpDebugBar\Controller\Resources::class,
+        ],
+    ],
+    'view_helpers' => [
+        'factories' => [
+            'debugbar' => ZfSnapPhpDebugBar\View\Helper\DebugBarFactory::class,
+        ],
+    ],
+    'router' => [
+        'routes' => [
+            'phpdebugbar-resource' => [
                 'type' => 'regex',
-                'options' => array(
+                'options' => [
                     'regex' => '/DebugBar/Resources/(?<resource>[a-zA-Z0-9_.\-/]+)',
                     'spec' => '/DebugBar/Resources/%resource%',
-                    'defaults' => array(
-                        'controller' => 'ZfSnapPhpDebugBar\Controller\Resources',
+                    'defaults' => [
+                        'controller' => ZfSnapPhpDebugBar\Controller\Resources::class,
                         'action' => 'index',
-                    ),
-                ),
-            ),
-            'phpdebugbar-custom-resource' => array(
+                    ],
+                ],
+            ],
+            'phpdebugbar-custom-resource' => [
                 'type' => 'regex',
-                'options' => array(
+                'options' => [
                     'regex' => '/ZfSnapPhpDebugBar/Resources/(?<resource>[a-zA-Z0-9_.\-/]+)',
                     'spec' => '/ZfSnapPhpDebugBar/Resources/%resource%',
-                    'defaults' => array(
-                        'controller' => 'ZfSnapPhpDebugBar\Controller\Resources',
+                    'defaults' => [
+                        'controller' => ZfSnapPhpDebugBar\Controller\Resources::class,
                         'action' => 'custom',
-                    ),
-                ),
-            ),
-        ),
-    ),
-);
+                    ],
+                ],
+            ],
+        ],
+    ],
+];

src/ZfSnapPhpDebugBar/Controller/Resources.php → src/Controller/Resources.php

@@ -5,16 +5,14 @@
 use Zend\Mvc\Controller\AbstractActionController;
 
 /**
- * Resources
- *
  * @author Witold Wasiczko <witold@wasiczko.pl>
  */
 class Resources extends AbstractActionController
 {
-    protected $extensionToContentTypeMap = array(
+    protected $extensionToContentTypeMap = [
         'css' => 'text/css; charset=UTF-8',
         'js' => 'text/javascript; charset=UTF-8',
-    );
+    ];
 
     public function indexAction()
     {

src/Exception/ThrowableException.php

@@ -0,0 +1,17 @@
+<?php
+
+namespace ZfSnapPhpDebugBar\Exception;
+
+use Exception;
+
+/**
+ * @author witold
+ */
+class ThrowableException extends Exception
+{
+
+    public function __construct(\Throwable $exception)
+    {
+        parent::__construct($exception->getMessage(), $exception->getCode(), $exception);
+    }
+}

src/ZfSnapPhpDebugBar/Functions.php → src/Functions.php

@@ -1,12 +1,14 @@
 <?php
 
+use ZfSnapPhpDebugBar\Module;
+
 if (!function_exists('debugbar_log')) {
     /**
      * @param string $message
      * @param string $type
      */
     function debugbar_log($message, $type = 'debug')
     {
-        \ZfSnapPhpDebugBar\Module::log($message, $type);
+        Module::log($message, $type);
     }
 }

src/Listener/ExceptionListener.php

@@ -0,0 +1,40 @@
+<?php
+
+namespace ZfSnapPhpDebugBar\Listener;
+
+use DebugBar\DataCollector\ExceptionsCollector;
+use Exception;
+use Zend\EventManager\AbstractListenerAggregate;
+use Zend\EventManager\EventInterface;
+use Zend\EventManager\EventManagerInterface;
+use ZfSnapPhpDebugBar\Exception\ThrowableException;
+
+/**
+ * @author witold
+ */
+final class ExceptionListener extends AbstractListenerAggregate
+{
+
+    private $exceptionsCollector;
+
+    public function __construct(ExceptionsCollector $exceptionsCollector)
+    {
+        $this->exceptionsCollector = $exceptionsCollector;
+    }
+
+    public function attach(EventManagerInterface $events, $priority = 1)
+    {
+        $this->listeners[] = $events->attach('*', [$this, 'collectException'], $priority);
+    }
+
+    public function collectException(EventInterface $event)
+    {
+        $exception = $event->getParam('exception');
+
+        if ($exception instanceof Exception || $exception instanceof \Throwable) {
+            $exception = $exception instanceof \Throwable ? new ThrowableException($exception) : $exception;
+
+            $this->exceptionsCollector->addException($exception);
+        }
+    }
+}

src/Listener/MeasureListener.php

@@ -0,0 +1,47 @@
+<?php
+
+namespace ZfSnapPhpDebugBar\Listener;
+
+use DebugBar\DataCollector\TimeDataCollector;
+use Zend\EventManager\AbstractListenerAggregate;
+use Zend\EventManager\EventInterface;
+use Zend\EventManager\EventManagerInterface;
+use Zend\View\Model\ModelInterface;
+use Zend\View\ViewEvent;
+
+/**
+ * @author witold
+ */
+class MeasureListener extends AbstractListenerAggregate
+{
+
+    private $timeCollector;
+    private $lastMeasure;
+
+    public function __construct(TimeDataCollector $timeCollector)
+    {
+        $this->timeCollector = $timeCollector;
+    }
+
+    public function attach(EventManagerInterface $events, $priority = 1)
+    {
+        $this->listeners[] = $events->attach('*', [$this, 'mesureToCollector'], $priority);
+    }
+
+    public function mesureToCollector(EventInterface $event)
+    {
+        if ($this->lastMeasure !== null && $this->timeCollector->hasStartedMeasure($this->lastMeasure)) {
+            $this->timeCollector->stopMeasure($this->lastMeasure);
+        }
+        $this->lastMeasure = $event->getName();
+
+        if ($event instanceof ViewEvent) {
+            $model = $event->getParam('model');
+
+            if ($model instanceof ModelInterface) {
+                $this->lastMeasure .= ' (' . $model->getTemplate() . ')';
+            }
+        }
+        $this->timeCollector->startMeasure($this->lastMeasure, $this->lastMeasure);
+    }
+}