BindsToContainer::prepareNamingFor() - Code Metrics - Inspection of "[4.x] Fluent configuration" - michael-rubel/laravel-auto-binder - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Pull Request — main (#1)

by Michael

created 2022-06-20 18:38 UTC

BindsToContainer::prepareNamingFor() A

↳ Parent: BindsToContainer

Complexity

Conditions	1
Paths	1

Size

Total Lines	3
Code Lines	1

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	2
CRAP Score	1

Importance

Changes

Metric	Value
cc	1
eloc	1
nc	1
nop	1
dl	0
loc	3
ccs	2
cts	2
cp	1
crap	1
rs	10
c	0
b	0
f	0

<?php

declare(strict_types=1);

namespace MichaelRubel\AutoBinder\Traits;

use Illuminate\Support\Collection;
use Illuminate\Support\Facades\File;
use Illuminate\Support\LazyCollection;
use Illuminate\Support\Str;
use Symfony\Component\Finder\SplFileInfo;

trait BindsToContainer
{
    /**
     * Run the directory scanning & bind the results.
     *
     * @return void
     */
    protected function scan(): void
    {
        $this->getFolderFiles()->each(function (SplFileInfo $file) {
            $relativePath             = $file->getRelativePathname();
            $filenameWithoutExtension = $file->getFilenameWithoutExtension();
            $filenameWithRelativePath = $this->prepareFilename($relativePath);

            $interface = $this->interfaceFrom($filenameWithoutExtension);
            $concrete  = $this->concreteFrom($filenameWithRelativePath);

            if (! interface_exists($interface) || ! class_exists($concrete)) {
                return;
            }

            $dependencies = collect($this->dependencies);

            $concrete = match (true) {
                $dependencies->has($interface) => $dependencies->get($interface),
                $dependencies->has($concrete)  => $dependencies->get($concrete),
                default                        => $concrete,
            };

            app()->{$this->bindingType}($interface, $concrete);
        });
    }

    /**
     * Get the folder files except for ignored ones.
     *
     * @return LazyCollection
     */
    protected function getFolderFiles(): LazyCollection
    {
        return LazyCollection::make(File::directories(base_path($this->basePath . DIRECTORY_SEPARATOR . $this->classFolder)))
        return LazyCollection::make(/** @scrutinizer ignore-type */ File::directories(base_path($this->basePath . DIRECTORY_SEPARATOR . $this->classFolder)))
            ->reject(fn ($folder) => in_array(basename($folder), $this->excludesFolders))
            ->map(fn ($folder) => File::allFiles($folder))
            ->flatten();
    }

    /**
     * Prepare the filename.
     *
     * @param string $filename
     *
     * @return string
     */
    protected function prepareFilename(string $filename): string
    {
        return (string) Str::of($filename)
            ->replace('/', '\\')
            ->substr(0, (int) strrpos($filename, '.'));
    }

    /**
     * Get the namespace from a given path.
     *
     * @param string $path
     *
     * @return string
     */
    protected function namespaceFrom(string $path): string
    {
        return (string) Str::of($path)
            ->replace('/', '\\')
            ->ucfirst();
    }

    /**
     * Get the concrete from filename.
     *
     * @param string $filenameWithRelativePath
     *
     * @return string
     */
    protected function concreteFrom(string $filenameWithRelativePath): string
    {
        return $this->classNamespace . '\\'
            . $this->classFolder . '\\'
            . $this->prepareNamingFor($filenameWithRelativePath);
    }

    /**
     * Get the interface from filename.
     *
     * @param string $filenameWithoutExtension
     *
     * @return string
     */
    protected function interfaceFrom(string $filenameWithoutExtension): string
    {
        $guessedInterface = $this->guessInterfaceBy($filenameWithoutExtension);

        if (is_null($guessedInterface)) {
            return $this->buildInterfaceBy($filenameWithoutExtension);
        }

        return $guessedInterface;
    }

    /**
     * Guess the interface with a given filename.
     *
     * @param string $filenameWithoutExtension
     *
     * @return string|null
     */
    protected function guessInterfaceBy(string $filenameWithoutExtension): ?string
    {
        return ! Str::contains($this->interfaceNamespace, '\\')
            ? $this->buildInterfaceFromClassBy($filenameWithoutExtension)
            : null;
    }

    /**
     * Build the interface class-string.
     *
     * @param string $filename
     *
     * @return string
     */
    protected function buildInterfaceBy(string $filename): string
    {
        return $this->interfaceNamespace . '\\'
            . $this->prepareNamingFor($filename)
            . ($this->interfaceNaming);
    }

    /**
     * Build the interface class-string based on the class folder.
     *
     * @param string $filename
     *
     * @return string
     */
    protected function buildInterfaceFromClassBy(string $filename): string
    {
        return $this->classNamespace . '\\'
            . $this->classFolder . '\\'
            . $this->interfaceNamespace . '\\'
            . $this->prepareNamingFor($filename)
            . ($this->interfaceNaming);
    }

    /**
     * Cleans up filename to append the desired interface name.
     *
     * @param string $filename
     *
     * @return string
     */
    protected function prepareNamingFor(string $filename): string
    {
        return Str::replace($this->interfaceNaming, '', $filename);
    }
}


michael-rubel / laravel-auto-binder

Pull Request — main (#1)

BindsToContainer::prepareNamingFor() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like