add ZDT support (#2)

This PR adds support for the zend developer tools. While adding this, some refactoring were applied. But nothing (should) introduces BC breaks.

Author: tonivdv

.gitignore

@@ -1,2 +1,3 @@
 .idea
+composer.lock
 vendor

.travis.yml

@@ -3,13 +3,19 @@ language: php
 php:
   - 5.6
   - 7.0
+  - 7.1
+  - 7.2
+
+matrix:
+  allow_failures:
+        - php: 7.2
 
 cache:
   directories:
     - $HOME/.composer/cache
 
 before_script:
-  - composer install --dev --prefer-source
+  - composer install
 
 script:
-  - vendor/bin/phpunit --configuration tests/phpunit.xml
+  - vendor/bin/phpunit --configuration phpunit.dist.xml

Module.php

@@ -18,24 +18,8 @@
 use Zend\ModuleManager\Feature\ViewHelperProviderInterface;
 use Zend\ServiceManager\AbstractPluginManager;
 
-class Module implements AutoloaderProviderInterface, ConfigProviderInterface, ViewHelperProviderInterface
+class Module implements ConfigProviderInterface, ViewHelperProviderInterface
 {
-
-    /**
-     * {@inheritdoc}
-     */
-    public function getAutoloaderConfig()
-    {
-        return array(
-            'Zend\Loader\StandardAutoloader' => array(
-                'namespaces' => array(
-                    __NAMESPACE__ => __DIR__ . '/src/' . __NAMESPACE__,
-                ),
-            ),
-        );
-
-    }
-
     /**
      * {@inheritdoc}
      */

README.md

@@ -3,4 +3,60 @@ Zend Framework 2 Module - Rollout
 
 [![Build Status](https://travis-ci.org/adlogix/zf2-opensoft-rollout.svg?branch=master)](https://travis-ci.org/adlogix/zf2-opensoft-rollout) [![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/adlogix/zf2-opensoft-rollout/badges/quality-score.png?b=master)](https://scrutinizer-ci.com/g/adlogix/zf2-opensoft-rollout/?branch=master) [![Total Downloads](https://poser.pugx.org/adlogix/zf2-opensoft-rollout/downloads)](https://packagist.org/packages/adlogix/zf2-opensoft-rollout) [![License](https://poser.pugx.org/adlogix/zf2-opensoft-rollout/license)](https://packagist.org/packages/adlogix/zf2-opensoft-rollout) [![composer.lock](https://poser.pugx.org/adlogix/zf2-opensoft-rollout/composerlock)](https://packagist.org/packages/adlogix/zf2-opensoft-rollout) [![Latest Stable Version](https://poser.pugx.org/adlogix/zf2-opensoft-rollout/v/stable)](https://packagist.org/packages/adlogix/zf2-opensoft-rollout)
 
-A ZF2 Module for [opensoft/rollout](https://github.com/opensoft/rollout)
+A ZF2 Module for [opensoft/rollout](https://github.com/opensoft/rollout)
+
+# Installation
+
+1. Install the module via composer by running:
+
+```bash
+composer require adlogix/zf2-opensoft-rollout ~1.0
+```
+
+2. Add the `Adlogix\Zf2Rollout` module to the module section of your `config/application.config.php`
+
+# Configuration
+
+Rollout parameters can be defined in the application configurations:
+
+```php
+<?php
+return [
+    'rollout' => [
+
+        // Service id to obtain a Opensoft\Rollout\RolloutUserInterface instance
+        'user_service' => null,
+
+        // Service id to obtain a Opensoft\Rollout\Storage\StorageInterface instance
+        'storage_service' => 'zf2_rollout_storage_array',
+
+        // Required configuration if storage service is Adlogix\Zf2Rollout\Storage\ZendDbAdapterStorage
+        'zend_db_storage' => [
+            'table_name' => 'rollout_feature'
+        ],
+
+        // Required configuration if storage service is Adlogix\Zf2Rollout\Storage\Doctrine\DoctrineORMStorage
+        'doctrine_storage' => [
+            'class_name' => SomeFeatureEntity::class
+        ]
+    ],
+]
+```
+
+# Usage
+
+To retrieve the rollout service from a zend controller:
+
+```
+<?php
+
+$rollout = $this->getServiceLocator()->get('zf2_rollout');
+```
+
+Refer to the documentation of [opensoft/rollout](https://github.com/opensoft/rollout) for more information on how to use the library.
+
+## Zend Developer Toolbar
+
+The module comes with support for the zend developer toolbar. Currently the toolbar only shows the list of features and enable status for a given user.
+
+![zf2-adlogix-rollout zend developer tools](docs/rollout-zdt.png)

composer.json

@@ -19,27 +19,33 @@
   ],
   "require": {
     "php": ">=5.6",
-    "opensoft/rollout": "~2.1"
+    "opensoft/rollout": "~2.2"
   },
   "require-dev": {
-    "zendframework/zendframework": "~2.0",
-    "phpunit/phpunit": "5.5.*",
-    "doctrine/orm": "*"
+    "zendframework/zend-developer-tools": "^1.2",
+    "zendframework/zend-db": "~2.9",
+    "zendframework/zend-i18n": "~2.8",
+    "zendframework/zend-log": "~2.10",
+    "zendframework/zend-mvc": "~2.7",
+    "zendframework/zend-serializer": "~2.9",
+    "zendframework/zend-servicemanager": "~2.7",
+    "doctrine/orm": "~2.5",
+    "phpunit/phpunit": "~5.0"
   },
   "autoload": {
-    "psr-0": {
+    "psr-4": {
       "Adlogix\\Zf2Rollout\\": "src/"
     },
     "classmap": [
       "./"
     ]
   },
   "autoload-dev": {
-    "psr-0": {
-      "Adlogix\\Zf2RolloutTest\\": "tests/"
+    "psr-4": {
+      "Adlogix\\Zf2Rollout\\Test\\": "tests/"
     },
     "classmap": [
       "./"
     ]
   }
-}
+}