Konekt\Concord\Conventions\ConcordDefault

Complexity

Total Complexity

26

Size/Duplication

Total Lines	237
Duplicated Lines	0 %

Importance

Changes	7
Bugs	1	Features	2

26 Methods

Rating	Name	Duplication	Size	Complexity
A	enumForProxy()	0	4	1
A	proxyForEnum()	0	4	1
A	proxyForEnumContract()	0	4	1
A	contractForEnum()	0	4	1
A	proxyForModelContract()	0	4	1
A	enumsFolder()	0	3	1
A	defaultModelClassForContract()	0	6	1
A	defaultEnumClassForContract()	0	6	1
A	migrationsFolder()	0	3	1
A	manifestFile()	0	3	1
A	contractForRequest()	0	6	1
A	controllersFolder()	0	3	1
A	viewsFolder()	0	3	1
A	modulesFolder()	0	3	1
A	contractForModel()	0	6	1
A	repositoryForModel()	0	3	1
A	resourcesFolder()	0	3	1
A	providersFolder()	0	3	1
A	modelsFolder()	0	3	1
A	modelForProxy()	0	3	1
A	contractsFolder()	0	3	1
A	modelForRepository()	0	3	1
A	routesFolder()	0	3	1
A	configFolder()	0	3	1
A	requestsFolder()	0	3	1
A	proxyForModel()	0	3	1

<?php

declare(strict_types=1);

/**
 * Contains the ConcordDefault convention class.
 *
 * @copyright   Copyright (c) 2017 Attila Fulop
 * @author      Attila Fulop
 * @license     MIT
 * @since       2017-04-14
 *
 */

namespace Konekt\Concord\Conventions;

use Illuminate\Support\Str;
use Konekt\Concord\Contracts\Convention;

/**
 * Concord's default conventions
 */
class ConcordDefault extends BaseConvention implements Convention
{
    /**
     * @inheritdoc
     */
    public function modulesFolder(): string
    {
        return 'Modules';
    }

    /**
     * @inheritDoc
     */
    public function modelsFolder(): string
    {
        return 'Models';
    }

    /**
     * @inheritDoc
     */
    public function contractsFolder(): string
    {
        return 'Contracts';
    }

    /**
     * @inheritDoc
     */
    public function controllersFolder(): string
    {
        return 'Http/Controllers';
    }

    /**
     * @inheritDoc
     */
    public function requestsFolder(): string
    {
        return 'Http/Requests';
    }

    /**
     * @inheritDoc
     */
    public function resourcesFolder(): string
    {
        return 'Http/Resources';
    }

    /**
     * @inheritDoc
     */
    public function contractForRequest(string $requestClass): string
    {
        return sprintf(
            '%s\\Contracts\\Requests\\%s',
            $this->oneLevelUp($this->oneLevelUp($this->getNamespace($requestClass))),
            class_basename($requestClass)
        );
    }

    /**
     * @inheritDoc
     */
    public function contractForModel(string $modelClass): string
    {
        return sprintf(
            '%s\\Contracts\\%s',
            $this->oneLevelUp($this->getNamespace($modelClass)),
            class_basename($modelClass)
        );
    }

    /**
     * @inheritDoc
     */
    public function modelForRepository(string $repositoryClass): string
    {
        return Str::replaceLast('Repository', '', $repositoryClass);
    }

    /**
     * @inheritDoc
     */
    public function modelForProxy(string $proxyClass): string
    {
        return Str::replaceLast('Proxy', '', $proxyClass);
    }

    /**
     * @inheritDoc
     */
    public function repositoryForModel(string $modelClass): string
    {
        return $modelClass . 'Repository';
    }

    /**
     * @inheritDoc
     */
    public function proxyForModel(string $modelClass): string
    {
        return $modelClass . 'Proxy';
    }

    /**
     * @inheritDoc
     */
    public function manifestFile(): string
    {
        return 'resources/manifest.php';
    }

    /**
     * @inheritDoc
     */
    public function configFolder(): string
    {
        return 'resources/config';
    }

    /**
     * @inheritDoc
     */
    public function migrationsFolder(): string
    {
        return 'resources/database/migrations';
    }

    /**
     * @inheritDoc
     */
    public function viewsFolder(): string
    {
        return 'resources/views';
    }

    /**
     * @inheritDoc
     */
    public function routesFolder(): string
    {
        return 'resources/routes';
    }

    /**
     * @inheritDoc
     */
    public function providersFolder(): string
    {
        return 'Providers';
    }

    /**
     * @inheritDoc
     */
    public function enumsFolder(): string
    {
        return 'Models';
    }

    /**
     * @inheritDoc
     */
    public function contractForEnum(string $enumClass): string
    {
        // Enums are in the same folder as models, so we use the existing method
        return $this->contractForModel($enumClass);
    }

    /**
     * @inheritDoc
     */
    public function proxyForEnum(string $enumClass): string
    {
        // Identical with model proxies
        return $this->proxyForModel($enumClass);
    }

    /**
     * @inheritDoc
     */
    public function enumForProxy(string $proxyClass): string
    {
        // Identical with model proxies
        return $this->modelForProxy($proxyClass);
    }

    /**
     * @inheritdoc
     */
    public function proxyForEnumContract(string $enumContract)
    {
        return $this->proxyForEnum(
            $this->defaultEnumClassForContract($enumContract)
        );
    }

    /**
     * @inheritdoc
     */
    public function proxyForModelContract(string $modelContract): string
    {
        return $this->proxyForModel(
            $this->defaultModelClassForContract($modelContract)
        );
    }

    /**
     * Returns the convention's default enum class for an enum contract
     *
     * @param $enumContract
     *
     * @return string
     */
    protected function defaultEnumClassForContract($enumContract)
    {
        return
            $this->oneLevelUp($this->getNamespace($enumContract))
            . '\\' . $this->enumsFolder()
            . '\\' . class_basename($enumContract);
    }

    /**
     * Returns the convention's default model class for a model contract
     *
     * @param $modelContract
     *
     * @return string
     */
    protected function defaultModelClassForContract($modelContract)
    {
        return
            $this->oneLevelUp($this->getNamespace($modelContract))
            . '\\' . $this->modelsFolder()
            . '\\' . class_basename($modelContract);
    }
}