add support for describing features (#5)

Author: laudeco

README.md

@@ -38,6 +38,13 @@ return [
         // Required configuration if storage service is Adlogix\Zf2Rollout\Storage\Doctrine\DoctrineORMStorage
         'doctrine_storage' => [
             'class_name' => SomeFeatureEntity::class
+        ],
+        
+        // (Optional) Describes the features with a description
+        'features' => [
+            'feature_1' => [
+                'description' => 'The description of the feature.' 
+            ]
         ]
     ],
 ]
@@ -55,6 +62,31 @@ $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.
 
+## Describe the features
+
+Since the Rollout library doesn't have (yet) a functionality to describe its feature flags, you can define them through this module. To do so, simply add your feature flag identifier in the 'features' sections of the rollout configuration as shown here:
+
+```php
+<?php
+return [
+    'rollout' => [
+        
+        // (Optional) Describes the features with a description
+        'features' => [
+            'feature_1' => [
+                'description' => '' 
+            ]
+        ]
+    ],
+];
+```
+
+To display the description in a view you have to call the view helper : **rollout_description**. If the description is not found in the configuration, an empty string will be returned.
+
+```php
+echo $this->rollout_description('feature_1');
+```
+
 ## Zend Developer Toolbar
 
 The module comes with support for the zend developer toolbar.

config/module.config.php

@@ -25,7 +25,9 @@
 
         'doctrine_storage' => [
             'class_name' => ''
-        ]
+        ],
+
+        'features' => []
     ],
 
     'router' => array(

src/Module.php

@@ -40,6 +40,11 @@ public function getViewHelperConfig()
                     /** @var Rollout $rollout */
                     $rollout = $serviceLocator->get('zf2_rollout');
                     return new View\Helper\IsActive($rollout);
+                },
+                'rollout_description' => function (AbstractPluginManager $pluginManager) {
+                    $serviceLocator = $pluginManager->getServiceLocator();
+                    $rolloutConfig = $serviceLocator->get('zf2_rollout_config');
+                    return new View\Helper\Description($rolloutConfig['features']);
                 }
             ],
         ];

src/View/Helper/Description.php

@@ -0,0 +1,51 @@
+<?php
+/*
+ * This file is part of the Adlogix package.
+ *
+ * (c) Allan Segebarth <[email protected]>
+ * (c) Jean-Jacques Courtens <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Adlogix\Zf2Rollout\View\Helper;
+
+
+use Zend\View\Helper\AbstractHelper;
+
+/**
+ * Returns the description of a given feature.
+ *
+ * @package Adlogix\Zf2Rollout\View\Helper
+ * @author Laurent De Coninck <[email protected]>
+ */
+class Description extends AbstractHelper
+{
+    /**
+     * @var array
+     */
+    private $features;
+
+    public function __construct(array $features = [])
+    {
+        $this->features = $features;
+    }
+
+    /**
+     * Returns the description of a feature.
+     *
+     * @param string $feature
+     *
+     * @return string|null
+     */
+    public function __invoke($feature)
+    {
+        if (!isset($this->features[$feature]['description'])) {
+            return '';
+        }
+
+        return $this->features[$feature]['description'];
+    }
+
+}

tests/View/Helper/DescriptionTest.php

@@ -0,0 +1,62 @@
+<?php
+/*
+ * This file is part of the Adlogix package.
+ *
+ * (c) Allan Segebarth <[email protected]>
+ * (c) Jean-Jacques Courtens <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Adlogix\Zf2Rollout\Test\View\Helper;
+
+use Adlogix\Zf2Rollout\View\Helper\Description;
+
+/**
+ * @package Adlogix\Zf2Rollout\Test\View\Helper
+ * @author Laurent De Coninck <[email protected]>
+ */
+class DescriptionTest extends \PHPUnit_Framework_TestCase
+{
+
+    /**
+     * @return Description
+     */
+    private function createHelper()
+    {
+        $features = [
+            'feature_1' => [
+                'description' => 'description for test'
+            ],
+            'feature_2' => [
+            ],
+        ];
+
+        return new Description($features);
+    }
+
+    /**
+     * @test
+     */
+    public function invoke_WithDescriptions_CorrectDescriptionReturned()
+    {
+        $this->assertEquals('description for test', $this->createHelper()->__invoke('feature_1'));
+    }
+
+    /**
+     * @test
+     */
+    public function invoke_NoDescriptionKey_NullReturned()
+    {
+        $this->assertEquals('', $this->createHelper()->__invoke('feature_2'));
+    }
+
+    /**
+     * @test
+     */
+    public function invoke_NoDescriptionFound_NullReturned()
+    {
+        $this->assertEquals('', $this->createHelper()->__invoke('feature_3'));
+    }
+}