Develop (#3)

* refactoring
dotkernel · Mar 9, 2017 · 77a8cba · 77a8cba
1 parent eb164c1
commit 77a8cba
Show file tree

Hide file tree

Showing 28 changed files with 380 additions and 505 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -0,0 +1,15 @@
+## 0.1.0 - 2017-03-09
+
+Initial tagged release
+
+### Added
+* Everything
+
+### Deprecated
+* Nothing
+
+### Removed
+* Nothing
+
+### Fixed
+* Nothing
diff --git a/README.md b/README.md
@@ -21,43 +21,40 @@ In your `config/autoload` directory, create a config file
 ```php
 return [
     'dot_navigation' => [
-
         //enable menu item active if any child is active
         'active_recursion' => true,
-
-        //map a provider name to a provider type
-        'providers_map' => [
-            'default' => \Dot\Navigation\Provider\ArrayProvider::class,
-        ],
-
+
         //map a provider name to its config
         'containers' => [
             'default' => [
-                [
-                    'options' => [
-                        'label' => 'Menu #1',
-                        'route' => 'home',
+                'type' => 'ArrayProvider'
+                'options' => [
+                    'items' => [
+                        [
+                            'options' => [
+                                'label' => 'Menu #1',
+                                'route' => 'home',
+                            ],
+                            'attributes' => [
+                                'name' => 'Menu #1',
+                            ]
+                        ],
+                        [
+                            'options' => [
+                                'label' => 'Menu #2',
+                                'route' => 'home',
+                            ],
+                            'attributes' => [
+                                'name' => 'Menu #1',
+                            ]
+                        ]
                     ],
-                    'attributes' => [
-                        'name' => 'Menu #1',
-                    ]
                 ],
-                [
-                    'options' => [
-                        'label' => 'Menu #2',
-                        'route' => 'home',
-                    ],
-                    'attributes' => [
-                        'name' => 'Menu #1',
-                    ]
-                ]
-            ]
+            ],
         ],
-
+        
         //register custom providers here
-        'provider_manager' => [
-
-        ]
+        'provider_manager' => [],
     ],
 ];
 ```
@@ -85,7 +82,6 @@ Each provider must implement the interface `ProviderInterface` and be registered
 
 We offer just one provider for now, `ArrayProvider`, that is able to fetch and create a menu container from a php array that is defined in the configuration file.
 
-When configuring the module, you'll have to associate each defined navigation container to its provider, in the `provider_map` key.
 
 ## NavigationRenderer
 
@@ -106,4 +102,4 @@ The following are options that each page should define in the configuration
 * `label` - the text of the menu item
 * `route` or `uri` - defines the route or link the menu item will have
 * `params`, `query_params`, `fragment` - are all options to use with the route option, to generate the complete route, if required. These are optional.
-* `permission` - can be used optionally, if authorization service is present, in order to omit menu items that are not authorized to visit.
+* `permission` - can be used optionally, if authorization service is present, in order to omit menu items that are not authorized to visit.
diff --git a/composer.json b/composer.json
@@ -1,7 +1,7 @@
 {
   "name": "dotkernel/dot-navigation",
   "type": "library",
-  "description": "Navigation library for easy menu parsing",
+  "description": "DotKernel navigation component",
   "license": "MIT",
   "authors": [
     {
@@ -10,7 +10,7 @@
     }
   ],
   "require": {
-    "php": "^5.6 || ^7.0",
+    "php": "^7.1",
     "psr/http-message": "^1.0",
     "container-interop/container-interop": "^1.1",
     "zendframework/zend-servicemanager": "^3.1",
@@ -23,7 +23,7 @@
     "squizlabs/php_codesniffer": "^2.3",
 
     "zendframework/zend-stdlib": "^3.1",
-    "dotkernel/dot-authorization": "0.6.x-dev"
+    "dotkernel/dot-authorization": "~0.1"
   },
   "autoload": {
     "psr-4": {
@@ -37,7 +37,7 @@
   },
   "extra": {
     "branch-alias": {
-      "dev-master": "0.6-dev"
+      "dev-master": "0.2-dev"
     }
   }
 }
diff --git a/navigation.global.php.dist b/navigation.global.php.dist
@@ -2,52 +2,39 @@
 
 return [
     'dot_navigation' => [
-
         //enable menu item active if any child is active
         'active_recursion' => true,
 
-        'menu_options' => [
-            //depths between the menu hierarchy is iterated
-            'min_depth' => -1,
-            'max_depth' => -1,
-
-            //css classes to use for menu rendering
-            'active_class' => 'active',
-            'ul_class' => 'nav',
-        ],
-
-        //map a provider name to a provider type
-        'providers_map' => [
-            'default' => \Dot\Navigation\Provider\ArrayProvider::class,
-        ],
-
         //map a provider name to its config
         'containers' => [
             'default' => [
-                [
-                    'options' => [
-                        'label' => 'Menu #1',
-                        'route' => 'home',
+                'type' => 'ArrayProvider'
+                'options' => [
+                    'items' => [
+                        [
+                            'options' => [
+                                'label' => 'Menu #1',
+                                'route' => 'home',
+                            ],
+                            'attributes' => [
+                                'name' => 'Menu #1',
+                            ]
+                        ],
+                        [
+                            'options' => [
+                                'label' => 'Menu #2',
+                                'route' => 'home',
+                            ],
+                            'attributes' => [
+                                'name' => 'Menu #1',
+                            ]
+                        ]
                     ],
-                    'attributes' => [
-                        'name' => 'Menu #1',
-                    ]
                 ],
-                [
-                    'options' => [
-                        'label' => 'Menu #2',
-                        'route' => 'home',
-                    ],
-                    'attributes' => [
-                        'name' => 'Menu #1',
-                    ]
-                ]
-            ]
+            ],
         ],
 
         //register custom providers here
-        'provider_manager' => [
-
-        ]
+        'provider_manager' => [],
     ],
-];
+];
diff --git a/src/ConfigProvider.php b/src/ConfigProvider.php
@@ -7,6 +7,8 @@
  * Time: 5:20 PM
  */
 
+declare(strict_types = 1);
+
 namespace Dot\Navigation;
 
 use Dot\Navigation\Factory\NavigationMiddlewareFactory;
@@ -16,7 +18,9 @@
 use Dot\Navigation\Factory\ProviderPluginManagerFactory;
 use Dot\Navigation\Options\NavigationOptions;
 use Dot\Navigation\Provider\ProviderPluginManager;
+use Dot\Navigation\Service\Navigation;
 use Dot\Navigation\Service\NavigationInterface;
+use Dot\Navigation\View\NavigationRenderer;
 use Dot\Navigation\View\RendererInterface;
 
 /**
@@ -28,57 +32,39 @@ class ConfigProvider
     /**
      * @return array
      */
-    public function __invoke()
+    public function __invoke(): array
     {
         return [
-
             'dependencies' => $this->getDependencyConfig(),
 
             'dot_navigation' => [
 
-                'menu_options' => [
-
-                    'min_depth' => -1,
-                    'max_depth' => -1,
-
-                    'active_class' => 'active',
-                    'ul_class' => 'nav',
-                ],
-
                 'active_recursion' => true,
 
-                'containers' => [
-
-                ],
-
-                'providers_map' => [
+                'containers' => [],
 
-                ],
-
-                'provider_manager' => [
-
-                ]
+                'provider_manager' => []
             ],
         ];
     }
 
     /**
      * @return array
      */
-    public function getDependencyConfig()
+    public function getDependencyConfig(): array
     {
         return [
             'factories' => [
                 NavigationOptions::class => NavigationOptionsFactory::class,
-
                 ProviderPluginManager::class => ProviderPluginManagerFactory::class,
-
-                NavigationInterface::class => NavigationServiceFactory::class,
-
-                RendererInterface::class => NavigationRendererFactory::class,
-
+                Navigation::class => NavigationServiceFactory::class,
+                NavigationRenderer::class => NavigationRendererFactory::class,
                 NavigationMiddleware::class => NavigationMiddlewareFactory::class,
             ],
+            'aliases' => [
+                NavigationInterface::class => Navigation::class,
+                RendererInterface::class => NavigationRenderer::class,
+            ]
         ];
     }
 }
diff --git a/src/Exception/ExceptionInterface.php b/src/Exception/ExceptionInterface.php
@@ -7,6 +7,8 @@
  * Time: 5:20 PM
  */
 
+declare(strict_types = 1);
+
 namespace Dot\Navigation\Exception;
 
 /**

diff --git a/src/Exception/InvalidArgumentException.php b/src/Exception/InvalidArgumentException.php
@@ -7,6 +7,8 @@
  * Time: 5:20 PM
  */
 
+declare(strict_types = 1);
+
 namespace Dot\Navigation\Exception;
 
 /**

diff --git a/src/Exception/RuntimeException.php b/src/Exception/RuntimeException.php
@@ -7,6 +7,8 @@
  * Time: 5:20 PM
  */
 
+declare(strict_types = 1);
+
 namespace Dot\Navigation\Exception;
 
 /**

diff --git a/src/Factory/NavigationMiddlewareFactory.php b/src/Factory/NavigationMiddlewareFactory.php
@@ -7,6 +7,8 @@
  * Time: 5:20 PM
  */
 
+declare(strict_types = 1);
+
 namespace Dot\Navigation\Factory;
 
 use Dot\Navigation\NavigationMiddleware;
@@ -21,11 +23,12 @@ class NavigationMiddlewareFactory
 {
     /**
      * @param ContainerInterface $container
+     * @param $requestedName
      * @return NavigationMiddleware
      */
-    public function __invoke(ContainerInterface $container)
+    public function __invoke(ContainerInterface $container, $requestedName): NavigationMiddleware
     {
         $navigation = $container->get(NavigationInterface::class);
-        return new NavigationMiddleware($navigation);
+        return new $requestedName($navigation);
     }
 }
diff --git a/src/Factory/NavigationOptionsFactory.php b/src/Factory/NavigationOptionsFactory.php
@@ -7,6 +7,8 @@
  * Time: 5:20 PM
  */
 
+declare(strict_types = 1);
+
 namespace Dot\Navigation\Factory;
 
 use Dot\Navigation\Options\NavigationOptions;
@@ -20,11 +22,12 @@ class NavigationOptionsFactory
 {
     /**
      * @param ContainerInterface $container
+     * @param $requestedName
      * @return NavigationOptions
      */
-    public function __invoke(ContainerInterface $container)
+    public function __invoke(ContainerInterface $container, $requestedName): NavigationOptions
     {
         $config = $container->get('config')['dot_navigation'];
-        return new NavigationOptions($config);
+        return new $requestedName($config);
     }
 }