Merge pull request #17 from dotkernel/develop

Develop

Author: n3vrax

CHANGELOG.md

@@ -1,3 +1,27 @@
+## 0.2.0 - 2017-03-22
+
+ZE2 migration
+
+### Changed
+* new design
+* updated to PSR11 container
+* updated to PSR15 middleware
+* refactored project structure to follow modular design promoted by ZE2
+* programmatic routes and pipeline
+
+### Added
+* Nothing
+
+### Deprecated
+* Nothing
+
+### Removed
+* Nothing
+
+### Fixed
+* Nothing
+
+
 ## 0.1.2 - 2017-03-12
 
 ### Added

README.md

@@ -6,18 +6,20 @@ Dotkernel web starter package suitable for frontend applications.
 
 Create a new project directory and change dir to it. Run the following composer command
 ```bash
-$ composer create-project -s dev dotkernel/dot-frontend .
+$ composer create-project dotkernel/dot-frontend .
 ```
 
 ## Configuration
 
 * import the database schema, if you are using mysql, found in `data/dot-frontend.sql`
-* remove the `.dist` extension of the files `local.php.dist` and `errorhandler.local.php.dist` located in `config/autoload`
+* remove the `.dist` extension of the files `local.php.dist` located in `config/autoload`
 * edit `local.php` according to your dev machine. Fill in the `database` configuration and a smtp credentials if you want your application to send mails on registration etc.
 * get a recaptcha key pair and configure the `local.php` with them
-* run the following command in your project root dir
+* if you use the create-project command, after installing, the project will go into development mode automatically
+* you can also toggle development mode by using the composer commands
 ```bash
 $ composer development-enable
+$ composer development-disable
 ```
 This will enable dev mode having debug flag true and configuration caching off. It also make sure that any previously config cache is cleared.
 
@@ -34,3 +36,14 @@ If you still get exceptions or errors regarding some missing services, try runni
 ```bash
 $ composer clear-config-cache
 ```
+
+**NOTE**
+If you get errors when running composer commands like development-enable or clear-config-cache related to parsing errors and strict types
+it is probably because you don't have the PHP CLI version > 7.1 installed
+
+If you cannot use these commands(for example if you cannot upgrade PHP globally) you can setup/clean the project by hand as described below or if you have a locally installed PHP 7.1 version installed you can use that
+* enable development mode by renaming the files `config/development.config.php.dist` and `config/autoload/development.local.php.dist` to removed the `.dist` extension
+* disable dev mode by reverting the above procedure
+* run `bin/clear-config-cache.php` using the proper PHP version if accessible OR
+* manually clear cached data from `data/cache` directory and optionally `data/proxies`
+

bin/clear-config-cache.php

@@ -1,5 +1,4 @@
 <?php
-
 /**
  * Script for clearing the configuration cache.
  *
@@ -9,21 +8,27 @@
  * @copyright Copyright (c) 2017 Zend Technologies USA Inc. (http://www.zend.com)
  * @license   https://github.com/zendframework/zend-expressive-skeleton/blob/master/LICENSE.md New BSD License
  */
+
 chdir(__DIR__ . '/../');
+
 require 'vendor/autoload.php';
+
 $config = include 'config/config.php';
-if (!isset($config['config_cache_path'])) {
+
+if (! isset($config['config_cache_path'])) {
     echo "No configuration cache path found" . PHP_EOL;
     exit(0);
 }
-if (!file_exists($config['config_cache_path'])) {
+
+if (! file_exists($config['config_cache_path'])) {
     printf(
         "Configured config cache file '%s' not found%s",
         $config['config_cache_path'],
         PHP_EOL
     );
     exit(0);
 }
+
 if (false === unlink($config['config_cache_path'])) {
     printf(
         "Error removing config cache file '%s'%s",
@@ -32,6 +37,7 @@
     );
     exit(1);
 }
+
 printf(
     "Removed configured config cache file '%s'%s",
     $config['config_cache_path'],

composer.json

@@ -9,13 +9,16 @@
       "email": "[email protected]"
     }
   ],
+  "config": {
+    "sort-packages": true
+  },
   "require": {
     "php": "^7.1",
     "roave/security-advisories": "dev-master",
-    "zendframework/zend-expressive": "^1.0",
-    "zendframework/zend-expressive-fastroute": "^1.0",
-    "zendframework/zend-servicemanager": "^3.0",
-    "zendframework/zend-expressive-twigrenderer": "^1.0",
+    "zendframework/zend-expressive": "^2.0.2",
+    "zendframework/zend-expressive-fastroute": "^2.0",
+    "zendframework/zend-expressive-twigrenderer": "^1.4",
+    "zendframework/zend-servicemanager": "^3.3.0",
     "zendframework/zend-db": "^2.8",
     "zendframework/zend-i18n": "^2.7",
     "zendframework/zend-i18n-resources": "^2.5",
@@ -26,49 +29,49 @@
     "zendframework/zend-psr7bridge": "^0.2.2",
     "zendframework/zend-config": "^3.1",
     "zendframework/zend-config-aggregator": "^0.2.0",
-    "zendframework/zend-component-installer": "^0.6.0 || ~1.0",
+    "zendframework/zend-component-installer": "^1.0 || ^0.7.0",
 
-    "dotkernel/dot-annotated-services": "^1.0",
-    "dotkernel/dot-authentication-service": "^0.1",
-    "dotkernel/dot-authentication-web": "^0.1",
-    "dotkernel/dot-cache": "^1.0",
-    "dotkernel/dot-controller": "^0.1",
-    "dotkernel/dot-controller-plugin-flashmessenger": "^0.1",
-    "dotkernel/dot-controller-plugin-authentication": "^0.1",
-    "dotkernel/dot-controller-plugin-authorization": "^0.1",
-    "dotkernel/dot-controller-plugin-forms": "^0.1",
+    "dotkernel/dot-annotated-services": "^1.1",
+    "dotkernel/dot-authentication-service": "^0.2",
+    "dotkernel/dot-authentication-web": "^0.2",
+    "dotkernel/dot-cache": "^1.1",
+    "dotkernel/dot-controller": "^0.2",
+    "dotkernel/dot-controller-plugin-flashmessenger": "^0.2",
+    "dotkernel/dot-controller-plugin-authentication": "^0.2",
+    "dotkernel/dot-controller-plugin-authorization": "^0.2",
+    "dotkernel/dot-controller-plugin-forms": "^0.2",
     "dotkernel/dot-controller-plugin-mail": "^0.1",
-    "dotkernel/dot-controller-plugin-session": "^0.1",
-    "dotkernel/dot-mapper": "^0.1",
-    "dotkernel/dot-event": "^0.1",
-    "dotkernel/dot-filter": "^1.0",
-    "dotkernel/dot-flashmessenger": "^0.1",
-    "dotkernel/dot-form": "^1.0",
-    "dotkernel/dot-helpers": "^0.1",
-    "dotkernel/dot-hydrator": "^1.0",
-    "dotkernel/dot-inputfilter": "^1.0",
-    "dotkernel/dot-log": "^1.0",
+    "dotkernel/dot-controller-plugin-session": "^0.2",
+    "dotkernel/dot-mapper": "^0.3",
+    "dotkernel/dot-event": "^0.2",
+    "dotkernel/dot-filter": "^1.1",
+    "dotkernel/dot-flashmessenger": "^0.2",
+    "dotkernel/dot-form": "^1.1",
+    "dotkernel/dot-helpers": "^0.2",
+    "dotkernel/dot-hydrator": "^1.1",
+    "dotkernel/dot-inputfilter": "^1.1",
+    "dotkernel/dot-log": "^1.1",
     "dotkernel/dot-mail": "^0.1",
-    "dotkernel/dot-navigation": "^0.1",
-    "dotkernel/dot-paginator": "^1.0",
-    "dotkernel/dot-rbac": "^0.1",
-    "dotkernel/dot-rbac-guard": "^0.1",
-    "dotkernel/dot-session": "^1.0",
-    "dotkernel/dot-twigrenderer": "^0.1",
-    "dotkernel/dot-user": "^0.1",
-    "dotkernel/dot-validator": "^1.0"
+    "dotkernel/dot-navigation": "^0.2",
+    "dotkernel/dot-paginator": "^1.1",
+    "dotkernel/dot-rbac": "^0.2",
+    "dotkernel/dot-rbac-guard": "^0.2",
+    "dotkernel/dot-session": "^2.0",
+    "dotkernel/dot-twigrenderer": "^0.2",
+    "dotkernel/dot-user": "^0.2",
+    "dotkernel/dot-validator": "^1.1"
   },
   "require-dev": {
-    "phpunit/phpunit": "^4.8",
-    "squizlabs/php_codesniffer": "^2.3",
-    "filp/whoops": "^1.1 || ^2.0",
-    "mikey179/vfsstream": "^1.6",
+    "phpunit/phpunit": "^6.0.8 || ^5.7.15",
+    "squizlabs/php_codesniffer": "^2.8.1",
+    "zendframework/zend-expressive-tooling": "^0.3.2",
+    "filp/whoops": "^2.1.7",
     "zfcampus/zf-development-mode": "^3.1"
   },
   "autoload": {
     "psr-4": {
-      "Frontend\\App\\": "src/App/",
-      "Frontend\\User\\": "src/User"
+      "Frontend\\App\\": "src/App/src",
+      "Frontend\\User\\": "src/User/src"
     }
   },
   "autoload-dev": {
@@ -77,24 +80,28 @@
     }
   },
   "scripts": {
+    "post-create-project-cmd": [
+      "@development-enable"
+    ],
     "development-disable": "zf-development-mode disable",
     "development-enable": "zf-development-mode enable",
     "development-status": "zf-development-mode status",
     "check": [
-      "@cs",
+      "@cs-check",
       "@test"
     ],
     "clear-config-cache": "php bin/clear-config-cache.php",
     "cs-check": "phpcs",
     "cs-fix": "phpcbf",
-    "serve": "php -S 0.0.0.0:8080 -t public/ public/index.php",
+    "serve": "php -S 0.0.0.0:8080 -t public public/index.php",
     "test": "phpunit --colors=always",
     "test-coverage": "phpunit --colors=always --coverage-clover clover.xml",
     "upload-coverage": "coveralls -v"
   },
   "extra": {
     "branch-alias": {
-      "dev-master": "0.2-dev"
+      "dev-master": "0.2-dev",
+      "dev-develop": "0.3-dev"
     }
   }
 }

config/autoload/authentication.global.php

@@ -1,21 +1,25 @@
 <?php
 
+use Frontend\User\Entity\UserEntity;
+use Dot\Hydrator\ClassMethodsCamelCase;
+use Dot\User\Service\PasswordCheck;
+
 return [
     'dot_authentication' => [
         'adapter' => [
             'type' => 'CallbackCheck',
             'options' => [
                 'adapter' => 'database',
 
-                'identity_prototype' => \Frontend\User\Entity\UserEntity::class,
-                'identity_hydrator' => \Dot\Hydrator\ClassMethodsCamelCase::class,
+                'identity_prototype' => UserEntity::class,
+                'identity_hydrator' => ClassMethodsCamelCase::class,
 
                 'table' => 'user',
 
                 'identity_columns' => ['username', 'email'],
                 'credential_column' => 'password',
 
-                'callback_check' => \Dot\User\Service\PasswordCheck::class
+                'callback_check' => PasswordCheck::class
             ]
         ],
         'storage' => [

config/autoload/authorization-guards.global.php

@@ -1,9 +1,10 @@
 <?php
 
-return [
+use Dot\Rbac\Guard\Guard\GuardInterface;
 
+return [
     'dot_authorization' => [
-        'protection_policy' => \Dot\Rbac\Guard\Guard\GuardInterface::POLICY_ALLOW,
+        'protection_policy' => GuardInterface::POLICY_ALLOW,
 
         'event_listeners' => [],
 
@@ -20,7 +21,20 @@
                             'rules' => [
                                 [
                                     'route' => 'user',
-                                    'actions' => ['change-password', 'account'],
+                                    'actions' => [
+                                        'register',
+                                        'reset-password',
+                                        'forgot-password',
+                                        'confirm-account',
+                                        'opt-out',
+                                        'pending-activation',
+                                        'resend-activation'
+                                    ],
+                                    'permissions' => ['*']
+                                ],
+                                [
+                                    'route' => 'user',
+                                    'actions' => [],
                                     'permissions' => ['authenticated']
                                 ],
                                 [

config/autoload/cache.global.php

@@ -1,14 +1,16 @@
 <?php
 
+use Dot\AnnotatedServices\Factory\AbstractAnnotatedFactory;
+use Frontend\App\Factory\AnnotationsCacheFactory;
+
 return [
     'annotations_cache_dir' => __DIR__ . '/../../data/cache/annotations',
 
     'dependencies' => [
         'factories' => [
             // used by dot-annotated-services to cache annotations
             // needs to return a cache instance from Doctrine\Common\Cache
-            \Dot\AnnotatedServices\Factory\AbstractAnnotatedFactory::CACHE_SERVICE =>
-                \Frontend\App\Factory\AnnotationsCacheFactory::class,
+            AbstractAnnotatedFactory::CACHE_SERVICE => AnnotationsCacheFactory::class,
         ]
     ],
 ];

config/autoload/controllers.global.php

@@ -1,20 +1,39 @@
 <?php
 
 use Zend\Expressive\Application;
-use Zend\Expressive\Container\ApplicationFactory;
+use Zend\Expressive\Container;
+use Zend\Expressive\Delegate;
 use Zend\Expressive\Helper;
+use Zend\Expressive\Middleware;
 
 return [
+    // Provides application-wide services.
+    // We recommend using fully-qualified class names whenever possible as
+    // service names.
     'dependencies' => [
-        'factories' => [
-            Application::class => ApplicationFactory::class,
-            Helper\UrlHelper::class => Helper\UrlHelperFactory::class,
-            Helper\ServerUrlHelper::class => \Zend\ServiceManager\Factory\InvokableFactory::class,
+        // Use 'aliases' to alias a service name to another service. The
+        // key is the alias name, the value is the service to which it points.
+        'aliases' => [
+            'Zend\Expressive\Delegate\DefaultDelegate' => Delegate\NotFoundDelegate::class,
         ],
+        // Use 'invokables' for constructor-less services, or services that do
+        // not require arguments to the constructor. Map a service name to the
+        // class name.
+        'invokables' => [
+            // Fully\Qualified\InterfaceName::class => Fully\Qualified\ClassName::class,
+            Helper\ServerUrlHelper::class => Helper\ServerUrlHelper::class,
+        ],
+        // Use 'factories' for services provided by callbacks/factory classes.
+        'factories'  => [
+            Application::class                => Container\ApplicationFactory::class,
+            Delegate\NotFoundDelegate::class  => Container\NotFoundDelegateFactory::class,
+            Helper\ServerUrlMiddleware::class => Helper\ServerUrlMiddlewareFactory::class,
+            Helper\UrlHelper::class           => Helper\UrlHelperFactory::class,
+            Helper\UrlHelperMiddleware::class => Helper\UrlHelperMiddlewareFactory::class,
 
-        'lazy_services' => [
-            'proxies_target_dir' => 'data/proxies',
-            'proxies_namespace' => 'DotProxy',
-        ]
+            Zend\Stratigility\Middleware\ErrorHandler::class => Container\ErrorHandlerFactory::class,
+            Middleware\ErrorResponseGenerator::class         => Container\ErrorResponseGeneratorFactory::class,
+            Middleware\NotFoundHandler::class                => Container\NotFoundHandlerFactory::class,
+        ],
     ],
 ];