capsules() - Code Metrics - Inspection of "Add some capsule finder methods and helpers" - area17/twill - Measure and Improve Code Quality continuously with Scrutinizer

Passed
Pull Request — 2.x (#925)

by Antonio Carlos
created 2021-05-22 14:52 UTC
capsules() A

↳ Parent: Project
Complexity

Conditions	2
Paths	2
Size

Total Lines	8
Code Lines	4
Duplication

Lines	0
Ratio	0 %
Code Coverage

Tests	0
CRAP Score	6
Importance

Changes
Metric	Value
cc	2
eloc	4
c	0
b	0
f	0
nc	2
nop	1
dl	0
loc	8
rs	10
ccs	0
cts	0
cp	0
crap	6
<?php

use A17\Twill\Services\Blocks\BlockCollection;
use Illuminate\Filesystem\Filesystem;
.
|-- OtherDir
|   |-- Bar.php
|   `-- Foo.php
`-- SomeDir
    `-- Foo.php
use Illuminate\Support\Arr;
use Illuminate\Support\Facades\Event;
.
|-- OtherDir
|   |-- Bar.php
|   `-- Foo.php
`-- SomeDir
    `-- Foo.php
use \Illuminate\Support\Str;

if (!function_exists('dumpUsableSqlQuery')) {
    function dumpUsableSqlQuery($query)
    {
        dd(vsprintf(str_replace('?', '%s', $query->toSql()), array_map(function ($binding) {
            return is_numeric($binding) ? $binding : "'{$binding}'";
        }, $query->getBindings())));
    }
}

if (!function_exists('classUsesDeep')) {
    /**
     * @param mixed $class
     * @param bool $autoload
     * @return array
     */
    function classUsesDeep($class, $autoload = true)
    {
        $traits = [];

        // Get traits of all parent classes
        do {
            $traits = array_merge(class_uses($class, $autoload), $traits);
        } while ($class = get_parent_class($class));

        // Get traits of all parent traits
        $traitsToSearch = $traits;
        while (!empty($traitsToSearch)) {
            $newTraits = class_uses(array_pop($traitsToSearch), $autoload);
            $traits = array_merge($newTraits, $traits);
            $traitsToSearch = array_merge($newTraits, $traitsToSearch);
        }

        foreach ($traits as $trait => $same) {
            $traits = array_merge(class_uses($trait, $autoload), $traits);
        }

        return array_unique($traits);
    }
}

if (!function_exists('classHasTrait')) {
    /**
     * @param mixed $class
     * @param string $trait
     * @return bool
     */
    function classHasTrait($class, $trait)
    {
        $traits = classUsesDeep($class);

        if (in_array($trait, array_keys($traits))) {
            return true;
        }

        return false;
    }
}

if (!function_exists('getFormFieldsValue')) {
    /**
     * @param array $formFields
     * @param string $name
     * @return mixed
     */
    function getFormFieldsValue($formFields, $name)
    {
        return Arr::get($formFields, str_replace(']', '', str_replace('[', '.', $name)), '');
    }
}

if (!function_exists('fireCmsEvent')) {
    /**
     * @param string $eventName
     * @param array $input
     * @return void
     */
    function fireCmsEvent($eventName, $input = [])
    {
        $method = method_exists(\Illuminate\Events\Dispatcher::class, 'dispatch') ? 'dispatch' : 'fire';
        Event::$method($eventName, [$eventName, $input]);
    }
}

if (!function_exists('twill_path')) {
    /**
     * @param string $path
     * @return string
     */
    function twill_path($path = '')

    {
        // Is it a full application path?
        if (Str::startsWith($path, base_path())) {
            return $path;
        }

        // Split to separate root namespace
        preg_match('/(\w*)\W?(.*)/', config('twill.namespace'), $namespaceParts);

        $twillBase = app_path(
            fix_directory_separator(
                $namespaceParts[1] == 'App' ? $namespaceParts[2] : $namespaceParts[0]
            )
        ) . '/';

        // Remove base path from path
        if (Str::startsWith($path, $twillBase)) {
            $path = Str::after($path, $twillBase);
        }

        // Namespace App is unchanged in config?
        if ($namespaceParts[0] === 'App') {
            return app_path($path);
        }

        // If it it still starts with App, use the left part, otherwise use the whole namespace
        // This can be a problem for those using a completely different app path for the application
        $left = ($namespaceParts[1] === 'App' ? $namespaceParts[2] : $namespaceParts[0]);

        // Join, fix slashes for the current operating system, and return path
        return app_path(fix_directory_separator(
            $left . (filled($path) ? '\\' . $path : '')
        ));
    }
}

if (!function_exists('make_twill_directory')) {
    /**
     * @param string $path
     * @param bool $recursive
     * @param \Illuminate\Filesystem\Filesystem|null $fs
     */
    function make_twill_directory($path, $recursive = true, $fs = null)
    {
        $fs = filled($fs)
        ? $fs
        : app(Filesystem::class);

        $path = twill_path($path);

        if (!$fs->isDirectory($path)) {
        if (!$fs->/** @scrutinizer ignore-call */ isDirectory($path)) {
            $fs->makeDirectory($path, 0755, $recursive);
        }
    }
}

if (!function_exists('twill_put_stub')) {
    /**
     * @param string $path
     * @param bool $recursive
     * @param \Illuminate\Filesystem\Filesystem|null $fs
     */
    function twill_put_stub($path, $stub, $fs = null)
    {
        $fs = filled($fs)
        ? $fs
        : app(Filesystem::class);

        $stub = str_replace(
            'namespace App\\',
            sprintf('namespace %s\\', config('twill.namespace')),
            $stub
        );

        if (!$fs->exists($path)) {
            $fs->put($path, $stub);
        }
    }
}

if (!function_exists('fix_directory_separator')) {
    /**
     * @param string $path
     * @param bool $recursive
     * @param int $mode
     */
    function fix_directory_separator($path)
    {
        return str_replace(
            '\\',
            DIRECTORY_SEPARATOR,
            $path
        );
    }
}

if (!function_exists('generate_list_of_allowed_blocks')) {
    /**
     * @param array $blocks
     * @param array $groups
     * @return array
     */
    function generate_list_of_available_blocks($blocks, $groups)
    {
        $blockList = app(BlockCollection::class)->getBlockList();

        $appBlocksList = $blockList->filter(function ($block) {
            return $block['source'] !== A17\Twill\Services\Blocks\Block::SOURCE_TWILL;
        });

        $finalBlockList = $blockList->filter(
            function ($block) use ($blocks, $groups, $appBlocksList) {
                if ($block['group'] === A17\Twill\Services\Blocks\Block::SOURCE_TWILL) {
                    if (!collect(
                        config('twill.block_editor.use_twill_blocks')
                    )->contains($block['name'])) {
                        return false;
                    }

                    if (count($appBlocksList) > 0 && $appBlocksList->contains(
                        function ($appBlock) use ($block) {
                            return $appBlock['name'] === $block['name'];
                        })
                    ) {
                        return false;
                    }
                }

                return (filled($blocks) ? collect($blocks)->contains($block['name']) : true)
                    && (filled($groups) ? collect($groups)->contains($block['group']) : true);
            }
        );

        // Sort them by the original definition
        $sorted = $finalBlockList->sortBy(function($b) use ($blocks) {
            return collect($blocks)->search(function($id, $key) use ($b) {
                return $id == $b['name'];
            });
        })->values()->toArray();

        return $sorted;
    }
}

if (!function_exists('capsule_namespace')) {
    function capsule_namespace($capsuleName, $type = null) {
        return capsules()->capsuleNamespace($capsuleName, $type);
        return capsules()->/** @scrutinizer ignore-call */ capsuleNamespace($capsuleName, $type);
    }
}


if (!function_exists('capsule_namespace_to_path')) {
    function capsule_namespace_to_path($namespace, $capsuleNamespace, $rootPath) {
        return capsules()->capsuleNamespaceToPath($namespace, $capsuleNamespace, $rootPath);
        return capsules()->/** @scrutinizer ignore-call */ capsuleNamespaceToPath($namespace, $capsuleNamespace, $rootPath);
    }
}

if (!function_exists('capsules')) {
    function capsules($capsule = null) {
        $manager = app('twill.capsules.manager');

        if (filled($capsule)) {
            return $manager->capsule($capsule);
            return $manager->/** @scrutinizer ignore-call */ capsule($capsule);
        }

        return $manager;
    }
}

area17 / twill

Pull Request — 2.x (#925)

capsules() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like
