Bootstrap::dotenv() - Code Metrics - Inspection of "Merge pull request #10 from dgagnon/dgagnon-patch-..." - zemit-cms/core - Measure and Improve Code Quality continuously with Scrutinizer

Test Failed
Push — master ( ffc597...4abc3b )

by Julien
created 2022-03-29 00:25 UTC
Bootstrap::dotenv() A

↳ Parent: Bootstrap
Complexity

Conditions	2
Paths	3
Size

Total Lines	14
Code Lines	5
Duplication

Lines	0
Ratio	0 %
Code Coverage

Tests	5
CRAP Score	2
Importance

Changes	1
Bugs	0	Features	0
Metric	Value
eloc	5
c	1
b	0
f	0
dl	0
loc	14
ccs	5
cts	5
cp	1
rs	10
cc	2
nc	3
nop	0
crap	2
<?php
/**
 * This file is part of the Zemit Framework.
 *
 * (c) Zemit Team <[email protected]>
 *
 * For the full copyright and license information, please view the LICENSE.txt
 * file that was distributed with this source code.
 */

namespace Zemit;

use Phalcon\Di;
use Phalcon\Di\FactoryDefault;
use Phalcon\Http\Response;
use Phalcon\Text;
use Phalcon\Events;

use Zemit\Bootstrap\Prepare;
use Zemit\Bootstrap\Config;
use Zemit\Bootstrap\Services;
use Zemit\Bootstrap\Modules;
use Zemit\Bootstrap\Router;
use Zemit\Events\EventsAwareTrait;
use Zemit\Mvc\Application;
use Zemit\Cli\Console;
use Zemit\Cli\Router as CliRouter;

use Dotenv\Dotenv;
use Docopt;

/**
 * Class Bootstrap
 * Zemit Core's Bootstrap for the MVC Application & CLI Console mode
 *
 * @author Julien Turbide <[email protected]>
 * @copyright Zemit Team <[email protected]>
 *
 * @since 1.0
 * @version 1.0
 *
 * @package Zemit
 */
class Bootstrap
{
    use EventsAwareTrait;
    
    /**
     * Bootstrap modes
     */
    const MODE_CLI = 'console';
    const MODE_DEFAULT = 'default';
    const MODE_CONSOLE = self::MODE_CLI;
    
    /**
     * @deprecated Use MODE_DEFAULT instead
     */
    const MODE_NORMAL = self::MODE_DEFAULT;
    
    /**
     * Ideally, only the config service provider should be added here, then it will load other service from itself
     * You can also add new Service Providers here if it's absolutely required to be loaded earlier before
     * @var array abstract => concrete
     */
    public $providers = [
        Provider\Config\ServiceProvider::class => Provider\Config\ServiceProvider::class,
    ];
    
    /**
     * Bootstrap mode
     * @var string
     */
    public $mode;
    
    /**
     * Bootstrap console args
     * @var array
     */
    public $args;
    
    /**
     * Dependencies
     * @var FactoryDefault|FactoryDefault\Cli
     */
    public $di;
    
    /**
     * @var Dotenv
     */
    public $dotenv;
    
    /**
     * @var Prepare
     */
    public $prepare;
    
    /**
     * @var Config
     */
    public $config;
    
    /**
     * @var Services
     */
    public $services;
    
    /**
     * @var Application|\Phalcon\Cli\Console
     */
    public $application;
    
    /**
     * @var Modules
     */
    public $modules;
    
    /**
     * @var Router
     */
    public $router;
    
    /**
     * @var Debug
     */
    public $debug;
    
    /**
     * @var Response
     */
    public $response;
    
    /**
     * @var Docopt
     */
    public $docopt;
    
    /**
     * @var string
     */
    public $consoleDoc = <<<DOC
Zemit Console

Usage:
  zemit <module> <task> [<action>] [<params> ...]  [--env=<env>] [--debug=<debug>] [--plugin=<plugin>] [--log-file=<file>]
  zemit (-h | --help)
  zemit (-v | --version)
  zemit (-i | --info)
  zemit (-c | --config)

Options:
  -h --help               show this help message
  -v --version            print version number
  -i --info               print environment informations
  -c --config             print the generated config that is used
  -V --verbose            increase verbosity
  -q --quiet              suppress non-error messages
  -f --force              force action even if not safe
  -n --dry-run            perform a trial run with no changes made
  -p --plugins            execute task for all plugins at once
  --ignore-errors         keep executing the task even after errors
  --plugin=<plugin>       plugin to execute the task
  --log-file=<file>       log what we're doing to the specified file [default: private/logs/cli.log]
  --debug=<debug>         Force the debug and ignore debug value from the config [default: false]
  --env=<env>             Force environment to pick the configuration files [default: development]
DOC;
    
    /**
     * Bootstrap constructor.
     * Setup the di, env, app, config, services, applications, modules and then the router
     *
     * @param string $mode Mode for the application 'default' 'console'
     *
     * @throws Exception
     */
    public function __construct($mode = self::MODE_DEFAULT)
    {
        $this->mode = $mode;
        $this->setEventsManager(new Events\Manager());
        $this->initialize();
        $this->dotenv();
        $this->docopt();
        $this->di();
        $this->prepare();
        $this->register();
        $this->config();
        $this->debug();
        $this->services();
        $this->application();
        $this->modules();
//        $this->router(); // using serviceProvider now
    }
    
    /**
     * Initialisation
     */
    public function initialize()
    {
    }
    
    /**
     * Prepare the DI including itself (Bootstrap) and setup as default DI
     * Also use the cli factory default for console mode
     * @return FactoryDefault|FactoryDefault\Cli Return a factory default DI
     * @throws Exception
     */
    public function di()
    {
        // Use the phalcon cli factory default for console mode
        $this->fireSet(
            $this->di,
            $this->isConsole() ?
            FactoryDefault\Cli::class :
            FactoryDefault::class,
            [],
            function (Bootstrap $bootstrap) {
                // Register bootstrap itself
                $this->di->setShared('bootstrap', $bootstrap);
                
                // Set as the default DI
                Di::setDefault($this->di);
            }
        );
        
        return $this->di;
    }
    
    /**
     * Reading .env file
     * @return Dotenv
     * @throws Exception
     */
    public function dotenv()
    {
        
        try {
            $this->dotenv = Dotenv::create(dirname(APP_PATH)); // @todo fix this to handle fireset instead, using a new class extending dotenv
            $this->dotenv->load();
//            $this->fireSet($this->dotenv, Dotenv::class, [dirname(APP_PATH)], function (Bootstrap $bootstrap) {
//                $bootstrap->dotenv->load();
//            });
        } catch (\Dotenv\Exception\InvalidPathException|\Dotenv\Exception\InvalidFileException $e) {
            // just ignore and run the application anyway
        }
        
        return $this->dotenv;
    }
    
    /**
     * Get arguments from command line interface (cli / console)
     * @return Docopt
     * @throws Exception
     */
    public function docopt()
    {
        return $this->fireSet($this->docopt, Docopt::class, [], function (Bootstrap $bootstrap) {
            if ($this->isConsole()) {
                $args = $bootstrap->docopt->handle($bootstrap->consoleDoc);
                $bootstrap->args = is_null($bootstrap->args)? $args : array_merge($bootstrap->args, $args);
                $bootstrap->args = is_null($bootstrap->args)? $args : array_merge($bootstrap->args, /** @scrutinizer ignore-type */ $args);
            }
        });
    }
    
    /**
     * Preparing some native PHP related stuff
     * @return Prepare
     * @throws Exception
     */
    public function prepare()
    {
        return $this->fireSet($this->prepare, Prepare::class);
    }
    
    /**
     * Registering bootstrap providers
     */
    public function register(array &$providers = null)
    {
        $providers ??= $this->providers;
        
        foreach ($providers as $key => $provider) {
            if (is_string($provider) && class_exists($provider)) {
                $provider = new $provider($this->di);
                $this->di->register($provider);
                if ($this->di->has($provider->getName())) {
                    $this->providers[$key] = $this->di->get($provider->getName());
                }
            }
        }
        
        return $this->providers;
    }
    
    /**
     * Prepare the config service
     * - Fire events (before & after)
     * - Apply current bootstrap mode ('default', 'console')
     * - Merge with current environment config
     * @return Config
     * @throws Exception
     */
    public function config()
    {
        if ($this->di->has('config')) {
            $this->config = $this->di->get('config');
        }
        return $this->fireSet($this->config, Config::class, [], function (Bootstrap $bootstrap) {
            $bootstrap->config->mode = $bootstrap->getMode();

            $bootstrap->config->mergeEnvConfig();
//            $bootstrap->prepare->php();
        });
    }
    
    /**
     * @return Debug
     * @throws Exception
     */
    public function debug()
    {
        return $this->fireSet($this->debug, Debug::class, [], function (Bootstrap $bootstrap) {
            $config = $bootstrap->config->debug;

            $bootstrap->prepare()->debug($bootstrap->config);
            
            if ($bootstrap->config->app->debug || $bootstrap->config->debug->enable) {

                if (is_bool($config)) {
                    $bootstrap->debug->listen();
                } else {
                    $bootstrap->debug->listen($config->exception ?? true, $config->lowSeverity ?? true);
                    $bootstrap->debug->setBlacklist($config->has('blacklist')? $config->blacklist->toArray() : []);
                    $bootstrap->debug->setShowFiles($config->showFiles ?? true);
                    $bootstrap->debug->setShowBackTrace($config->showBackTrace ?? true);
                    $bootstrap->debug->setShowFileFragment($config->showFileFragment ?? true);
                    if (is_string($config->uri)) {
                        $bootstrap->debug->setUri($config->uri);
                    }
                }
            }
        });
    }
    
    /**
     * Prepare procedural services way
     * - Fire events (before & after)
     * - Pass the current Di object as well as the current Config object
     * @return Services
     * @throws Exception
     */
    public function services()
    {
        return $this->fireSet($this->services, Services::class, [$this->di, $this->config]);
    }
    
    /**
     * Prepare the application
     * - Fire events (before & after)
     * - Pass the current Di object
     * - Depends on the current bootstrap mode ('default', 'console')
     * @return \Phalcon\Cli\Console|Application
     * @throws Exception
     */
    public function application()
    {
        return $this->fireSet(
            $this->application,
            $this->isConsole() ?
                Console::class :
                Application::class,
            [$this->di]
        );
    }
    
    /**
     * Prepare the application for modules
     * - Fire events (before & after)
     * - Pass the current Application object
     * @return Modules
     * @throws Exception
     */
    public function modules()
    {
        return $this->fireSet($this->modules, Modules::class, [$this->application]);
    }
    
    /**
     * Prepare the router
     * - Fire events (before & after router)
     * - Pass the current application for default mode
     * - Depends on the bootstrap mode ('default', 'default')
     * - Force Re-inject router in the bootstrap DI @TODO is it still necessary
     * @return Router
     * @throws Exception
     */
    public function router()
    {
        return $this->fireSet($this->router, $this->isConsole() ? CliRouter::class : Router::class, [true, $this->application]);
    }
    
    /**
     * Run Zemit App
     * - Fire events (before run & after run)
     * - Handle both console and default application
     * - Return response string
     * @return string
     * @throws Exception If the application can't be found
     */
    public function run()
    {
        $this->fire('beforeRun');
        
        // cli console mode, get the arguments from the doctlib
        if ($this->isConsole() || $this->application instanceof Console) {
            try {
                ob_start();
                $this->application->handle($this->getArguments());
                $this->application->handle(/** @scrutinizer ignore-type */ $this->getArguments());
                $responseString = ob_get_clean();
                $this->fire('afterRun');
                return $responseString;
            } catch (\Zemit\Exception $e) {
                new Cli\ExceptionHandler($e);
                // do zemit related stuff here
                exit(1);

            } catch (\Phalcon\Exception $e) {
                new Cli\ExceptionHandler($e);
                // do phalcon related stuff here
                exit(1);

            } catch (\Exception $exception) {
                new Cli\ExceptionHandler($exception);
                exit(1);

            } catch (\Throwable $throwable) {
                new Cli\ExceptionHandler($throwable);
                exit(1);

            }
        } elseif (isset($this->application) && ($this->application instanceof \Phalcon\Mvc\Application)) {
            // we don't need a try catch here, its handled by the application
            // or the user can wrap it with try catch into the public/index.php instead
            $this->response = $this->application->handle($_SERVER['REQUEST_URI'] ?? '/');

            $this->fire('afterRun');
            return $this->response->getContent();
        } else {
            if (empty($this->application)) {
                throw new \Exception('Application \'\' not found', 404);
            } else {
                throw new \Exception('Application \''.get_class($this->application).'\' not supported', 400);
            }
        }
    }
    
    /**
     * Get & format arguments from the $this->args property
     * @return array Key value pair, human readable
     */
    public function getArguments()
    {
        $arguments = [];
        if ($this->args) {

            foreach ($this->args as $key => $value) {
                if (preg_match('/(<(.*?)>|\-\-(.*))/', $key, $match)) {
                    $key = lcfirst(Text::camelize(Text::uncamelize(array_pop($match))));
                    $arguments[$key] = $value;
                }
            }
        }
        return $arguments;
    }
    
    /**
     * Return True if the bootstrap mode is set to 'console'
     * @return bool Console mode
     */
    public function isConsole() : bool
    {
        return $this->getMode() === self::MODE_CONSOLE;
    }
    
    /**
     * Return the raw bootstrap mode, should be either 'console' or 'default'
     * @return string Bootstrap mode
     */
    public function getMode() : string
    {
        return $this->mode;
    }
}

zemit-cms / core

Push — master ( ffc597...4abc3b )

Bootstrap::dotenv() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like
