App\Port\Provider\Traits\PortServiceProviderTrait

Complexity

Total Complexity

19

Size/Duplication

Total Lines	148
Duplicated Lines	8.11 %

Coupling/Cohesion

Components	1
Dependencies	3

Importance

Changes	4
Bugs	1	Features	1

6 Methods

Rating	Name	Duplication	Size	Complexity
A	changeTheDefaultDatabaseModelsFactoriesPath()	0	8	1
A	debugDatabaseQueries()	0	18	4
A	getMainServiceProviders()	0	13	3
B	getAllContainersConsoleCommandsForAutoLoading()	12	18	5
B	overrideDefaultFractalSerializer()	0	25	4
A	registerAllMiddlewares()	0	16	2

<?php

namespace App\Port\Provider\Traits;

use App;
use App\Port\Butler\Portals\Facade\PortButler;
use App\Port\Exception\Exceptions\UnsupportedFractalSerializerException;
use App\Port\Middleware\PortKernel;
use DB;
use File;
use Illuminate\Support\Facades\Config;
use Log;

/**
 * Class PortServiceProviderTrait.
 *
 * @author  Mahmoud Zalt <mahmoud@zalt.me>
 */
trait PortServiceProviderTrait
{

    /**
     * Write the DB queries in the Log and Display them in the
     * terminal (in case you want to see them while executing the tests).
     *
     * @param bool|false $terminal
     */
    public function debugDatabaseQueries($log = true, $terminal = false)
    {
        if (Config::get('database.query_debugging')) {
            DB::listen(function ($event) use ($terminal, $log) {
                $fullQuery = vsprintf(str_replace(['%', '?'], ['%%', '%s'], $event->sql), $event->bindings);

                $text = $event->connectionName . ' (' . $event->time . '): ' . $fullQuery;

                if ($terminal) {
                    dump($text);
                }

                if ($log) {
                    Log::info($text);
                }
            });
        }
    }

    /**
     * By default Laravel takes (server/database/factories) as the
     * path to the factories, this function changes the path to load
     * the factories from the infrastructure directory.
     */
    public function changeTheDefaultDatabaseModelsFactoriesPath($customPath)
    {
        App::singleton(\Illuminate\Database\Eloquent\Factory::class, function ($app) use ($customPath) {
            $faker = $app->make(\Faker\Generator::class);

            return \Illuminate\Database\Eloquent\Factory::construct($faker, base_path() . $customPath);
        });
    }

    /**
     * Get the containers Service Providers full classes names.
     *
     * @return  array
     */
    public function getMainServiceProviders()
    {
        $containersNamespace = PortButler::getContainersNamespace();

        $allServiceProviders = [];

        foreach (PortButler::getContainersNames() as $containerName) {
            // append the Module main service provider
            $allServiceProviders[] = PortButler::buildMainServiceProvider($containersNamespace, $containerName);
        }

        return array_unique($allServiceProviders) ? : [];
    }


    /**
     * TODO: needs refactoring, was created in 5 min
     *
     * @return  array
     */
    public function getAllContainersConsoleCommandsForAutoLoading()
    {
        $classes = [];
        foreach (PortButler::getContainersNames() as $containerName) {

This code seems to be duplicated across your project.

            $containerCommandsDirectory = base_path('app/Containers/' . $containerName . '/UI/CLI/Commands/');
            if (File::isDirectory($containerCommandsDirectory)) {
                $files = \File::allFiles($containerCommandsDirectory);
                foreach ($files as $consoleFile) {
                    if (\File::isFile($consoleFile)) {
                        $pathName = $consoleFile->getPathname();
                        $classes[] = PortButler::getClassFullNameFromFile($pathName);
                    }
                }
            }
        };

        return $classes;
    }


    /**
     * By default the Dingo API package (in the config file) creates an instance of the
     * fractal manager which takes the default serializer (specified by the fractal
     * package itself, and there's no way to override change it from the configurations of
     * the Dingo package).
     *
     * Here I am replacing the current default serializer (DataArraySerializer) by the
     * (JsonApiSerializer).
     *
     * "Serializers are what build the final response after taking the transformers data".
     */
    public function overrideDefaultFractalSerializer()
    {
        $serializerName = Config::get('api.serializer');

        // if DataArray `\League\Fractal\Serializer\DataArraySerializer` do noting since it's set by default by the Dingo API
        if ($serializerName !== 'DataArray') {
            app('Dingo\Api\Transformer\Factory')->setAdapter(function () use ($serializerName) {
                switch ($serializerName) {
                    case 'JsonApi':
                        $serializer = new \League\Fractal\Serializer\JsonApiSerializer(Config::get('api.domain'));
                        break;
                    case 'Array':
                        $serializer = new \League\Fractal\Serializer\ArraySerializer(Config::get('api.domain'));
                        break;
                    default:
                        throw new UnsupportedFractalSerializerException('Unsupported ' . $serializerName);
                }

                $fractal = new \League\Fractal\Manager();
                $fractal->setSerializer($serializer);

                return new \Dingo\Api\Transformer\Adapter\Fractal($fractal, 'include', ',', false);
            });
        }
    }

    /**
     * @param array $middlewares
     * @param array $middlewareGroups
     * @param array $routeMiddlewares
     */
    public function registerAllMiddlewares(
        array $middlewares = [],
        array $middlewareGroups = [],
        array $routeMiddlewares = []
    ) {
        // Registering single and grouped middleware's
        (App::make(PortKernel::class))
            ->registerMiddlewares($middlewares)
            ->registerMiddlewareGroups($middlewareGroups);

        // Registering Route Middleware's
        foreach ($routeMiddlewares as $key => $routeMiddleware) {
            $this->app['router']->middleware($key, $routeMiddleware);

The property app does not exist. Did you maybe forget to declare it?

        }

    }


}