[Iteration 5] v4.0-beta (#110)

Author: Jeckerson

.ci/install-phalcon.sh

@@ -0,0 +1,12 @@
+#!/usr/bin/env bash
+#
+# This file is part of the Phalcon Framework.
+#
+# (c) Phalcon Team <[email protected]>
+#
+# For the full copyright and license information, please view the
+# LICENSE.txt file that was distributed with this source code.
+
+git clone --depth=1 -v https://github.com/phalcon/cphalcon.git -b ${PHALCON_VERSION:=master} /tmp/phalcon
+cd /tmp/phalcon/build
+./install --phpize $(phpenv which phpize) --php-config $(phpenv which php-config)

.env.example

@@ -16,3 +16,13 @@ MAIL_SMTP_PORT=587
 MAIL_SMTP_SECURITY=tls
 MAIL_SMTP_USERNAME=
 MAIL_SMTP_PASSWORD=
+
+DB_TESTING_ADAPTER=mysql
+DB_TESTING_HOST=127.0.0.1
+DB_TESTING_NAME=vokuro_test
+DB_TESTING_USERNAME=root
+DB_TESTING_PASSWORD=
+DB_TESTING_PORT=3306
+
+CODECEPTION_URL=127.0.0.1
+CODECEPTION_PORT=8888

.htrouter.php

@@ -0,0 +1,22 @@
+<?php
+
+/**
+ * This file is part of the Vökuró.
+ *
+ * (c) Phalcon Team <[email protected]>
+ *
+ * For the full copyright and license information, please view
+ * the LICENSE file that was distributed with this source code.
+ */
+
+$uri = urldecode(
+    parse_url($_SERVER['REQUEST_URI'], PHP_URL_PATH)
+);
+
+if ($uri !== '/' && file_exists(__DIR__ . '/public' . $uri)) {
+    return false;
+}
+
+$_GET['_url'] = $_SERVER['REQUEST_URI'];
+
+require_once __DIR__ . '/public/index.php';

.travis.yml

@@ -0,0 +1,46 @@
+language: php
+
+php:
+  - '7.3'
+  - '7.2'
+
+dist: xenial
+
+services:
+  - mysql
+
+env:
+  global:
+    - PHALCON_VERSION=v4.0.0-beta.2
+    - DB_NAME=vokuro_test
+
+cache:
+  timeout: 604800
+  directories:
+    - ${HOME}/.composer/cache
+
+before_install:
+  - |
+    # Hide "You are in 'detached HEAD' state" message
+    git config --global advice.detachedHead false
+
+install:
+  - pecl install --force psr
+  - .ci/install-phalcon.sh
+  - echo extension=phalcon.so | tee -a "$(phpenv prefix)/etc/php.ini"
+
+before_script:
+  - mysql -e 'CREATE DATABASE IF NOT EXISTS vokuro_test CHARSET=utf8 COLLATE=utf8_unicode_ci;'
+  - php -S 127.0.0.1:8888 -t public/ .htrouter.php &
+  - travis_retry composer install --no-interaction --no-ansi --no-progress --no-suggest
+  - cp .env.example .env
+
+script:
+  - vendor/bin/phinx migrate -e testing
+  - vendor/bin/phinx seed:run -e testing
+  - vendor/bin/codecept build --quiet
+  - vendor/bin/codecept run
+  - vendor/bin/psalm --show-info=false
+
+notifications:
+  email: false

README.md

@@ -7,11 +7,6 @@ Please write us if you have any feedback.
 
 Thanks.
 
-## NOTE
-
-The master branch will always contain the latest stable version.
-If you wish to check older versions or newer ones currently under development, please switch to the relevant branch.
-
 ## Get Started
 
 ### Requirements
@@ -24,15 +19,6 @@ To run this application on your machine, you need at least:
 * Apache Web Server with `mod_rewrite enabled`, and `AllowOverride Options` (or `All`) in your `httpd.conf` or Nginx Web Server
 * Latest [Phalcon Framework](https://github.com/phalcon/cphalcon) extension installed/enabled
 
-Then you'll need to create the database and initialize schema:
-
-```bash
-echo 'CREATE DATABASE vokuro' | mysql -u root
-cat schemas/vokuro.sql | mysql -u root vokuro
-```
-
-Also you can override application config by creating `app/config/config.dev.php` (already gitignored).
-
 ### Installing Dependencies via Composer
 
 Vökuró's dependencies must be installed using Composer. Install composer in a common location or in your project:
@@ -45,7 +31,7 @@ Run the composer installer:
 
 ```bash
 cd vokuro
-php composer.phar install
+composer install
 cp .env.example .env
 vendor/bin/phinx migrate
 vendor/bin/phinx seed:run
@@ -54,6 +40,11 @@ vendor/bin/phinx seed:run
 **NOTE** After the installation, please ensure that the following folders have write permissions set:
 - `cache`
 
+## NOTE
+
+The master branch will always contain the latest stable version.
+If you wish to check older versions or newer ones currently under development, please switch to the relevant branch.
+
 ## Improving this Sample
 
 Phalcon is an open source project and a volunteer effort.

app/Application.php

@@ -0,0 +1,107 @@
+<?php
+declare(strict_types=1);
+
+/**
+ * This file is part of the Vökuró.
+ *
+ * (c) Phalcon Team <[email protected]>
+ *
+ * For the full copyright and license information, please view
+ * the LICENSE file that was distributed with this source code.
+ */
+
+namespace Vokuro;
+
+use Exception;
+use Phalcon\Application\AbstractApplication;
+use Phalcon\Di\DiInterface;
+use Phalcon\Di\FactoryDefault;
+use Phalcon\Di\ServiceProviderInterface;
+use Phalcon\Mvc\Application as MvcApplication;
+
+/**
+ * Vökuró Application
+ */
+class Application
+{
+    const APPLICATION_PROVIDER = 'bootstrap';
+
+    /**
+     * @var AbstractApplication
+     */
+    protected $app;
+
+    /**
+     * @var DiInterface
+     */
+    protected $di;
+
+    /**
+     * Project root path
+     *
+     * @var string
+     */
+    protected $rootPath;
+
+    /**
+     * @param string $rootPath
+     * @throws Exception
+     */
+    public function __construct(string $rootPath)
+    {
+        $this->di = new FactoryDefault();
+        $this->app = $this->createApplication();
+        $this->rootPath = $rootPath;
+
+        $this->di->setShared(self::APPLICATION_PROVIDER, $this);
+
+        $this->initializeProviders();
+    }
+
+    /**
+     * Run Vökuró Application
+     *
+     * @return string
+     * @throws Exception
+     */
+    public function run(): string
+    {
+        return (string) $this->app->handle($_SERVER['REQUEST_URI'])->getContent();
+    }
+
+    /**
+     * Get Project root path
+     *
+     * @return string
+     */
+    public function getRootPath(): string
+    {
+        return $this->rootPath;
+    }
+
+    /**
+     * @return AbstractApplication
+     */
+    protected function createApplication(): AbstractApplication
+    {
+        return new MvcApplication($this->di);
+    }
+
+    /**
+     * @throws Exception
+     */
+    protected function initializeProviders(): void
+    {
+        $filename = $this->rootPath . '/configs/providers.php';
+        if (!file_exists($filename) || !is_readable($filename)) {
+            throw new Exception('File providers.php does not exist or is not readable.');
+        }
+
+        $providers = include_once $filename;
+        foreach ($providers as $providerClass) {
+            /** @var ServiceProviderInterface $provider */
+            $provider = new $providerClass;
+            $provider->register($this->di);
+        }
+    }
+}

app/controllers/AboutController.php renamed to app/Controllers/AboutController.php

@@ -1,9 +1,10 @@
 <?php
+declare(strict_types=1);
 
 /**
  * This file is part of the Vökuró.
  *
- * (c) Phalcon Team <team@phalconphp.com>
+ * (c) Phalcon Team <team@phalcon.io>
  *
  * For the full copyright and license information, please view
  * the LICENSE file that was distributed with this source code.
@@ -14,12 +15,12 @@
 /**
  * Display the "About" page.
  */
-class AboutController extends ControllerBase
+final class AboutController extends ControllerBase
 {
     /**
      * Default action. Set the public layout (layouts/public.volt)
      */
-    public function indexAction()
+    public function indexAction(): void
     {
         $this->view->setVar('logged_in', is_array($this->auth->getIdentity()));
         $this->view->setTemplateBefore('public');

app/controllers/ControllerBase.php renamed to app/Controllers/ControllerBase.php

@@ -1,9 +1,10 @@
 <?php
+declare(strict_types=1);
 
 /**
  * This file is part of the Vökuró.
  *
- * (c) Phalcon Team <team@phalconphp.com>
+ * (c) Phalcon Team <team@phalcon.io>
  *
  * For the full copyright and license information, please view
  * the LICENSE file that was distributed with this source code.
@@ -13,12 +14,15 @@
 
 use Phalcon\Mvc\Controller;
 use Phalcon\Mvc\Dispatcher;
+use Vokuro\Plugins\Acl\Acl;
+use Vokuro\Plugins\Auth\Auth;
 
 /**
  * ControllerBase
  * This is the base controller for all controllers in the application
  *
- * @property \Vokuro\Auth\Auth auth
+ * @property Auth auth
+ * @property Acl acl
  */
 class ControllerBase extends Controller
 {
@@ -29,9 +33,10 @@ class ControllerBase extends Controller
      * @param Dispatcher $dispatcher
      * @return boolean
      */
-    public function beforeExecuteRoute(Dispatcher $dispatcher)
+    public function beforeExecuteRoute(Dispatcher $dispatcher): bool
     {
         $controllerName = $dispatcher->getControllerName();
+        $actionName = $dispatcher->getActionName();
 
         // Only check permissions on private controllers
         if ($this->acl->isPrivate($controllerName)) {
@@ -50,7 +55,6 @@ public function beforeExecuteRoute(Dispatcher $dispatcher)
             }
 
             // Check if the user have permission to the current option
-            $actionName = $dispatcher->getActionName();
             if (!$this->acl->isAllowed($identity['profile'], $controllerName, $actionName)) {
                 $this->flash->notice('You don\'t have access to this module: ' . $controllerName . ':' . $actionName);
 
@@ -69,5 +73,7 @@ public function beforeExecuteRoute(Dispatcher $dispatcher)
                 return false;
             }
         }
+
+        return true;
     }
 }

app/controllers/IndexController.php renamed to app/Controllers/IndexController.php

@@ -1,9 +1,10 @@
 <?php
+declare(strict_types=1);
 
 /**
  * This file is part of the Vökuró.
  *
- * (c) Phalcon Team <team@phalconphp.com>
+ * (c) Phalcon Team <team@phalcon.io>
  *
  * For the full copyright and license information, please view
  * the LICENSE file that was distributed with this source code.
@@ -14,12 +15,12 @@
 /**
  * Display the default index page.
  */
-class IndexController extends ControllerBase
+final class IndexController extends ControllerBase
 {
     /**
      * Default action. Set the public layout (layouts/public.volt)
      */
-    public function indexAction()
+    public function indexAction(): void
     {
         $this->view->setVar('logged_in', is_array($this->auth->getIdentity()));
         $this->view->setTemplateBefore('public');

app/controllers/PermissionsController.php renamed to app/Controllers/PermissionsController.php

@@ -1,9 +1,10 @@
 <?php
+declare(strict_types=1);
 
 /**
  * This file is part of the Vökuró.
  *
- * (c) Phalcon Team <team@phalconphp.com>
+ * (c) Phalcon Team <team@phalcon.io>
  *
  * For the full copyright and license information, please view
  * the LICENSE file that was distributed with this source code.
@@ -17,12 +18,12 @@
 /**
  * View and define permissions for the various profile levels.
  */
-class PermissionsController extends ControllerBase
+final class PermissionsController extends ControllerBase
 {
     /**
      * View the permissions for a profile level, and change them if we have a POST.
      */
-    public function indexAction()
+    public function indexAction(): void
     {
         $this->view->setTemplateBefore('private');