Limoncello\Flute\Http\Traits\FluteRoutesTrait

Complexity

Total Complexity

13

Size/Duplication

Total Lines	127
Duplicated Lines	13.39 %

Coupling/Cohesion

Components	0
Dependencies	1

Test Coverage

Coverage

100%

Importance

Changes

0

3 Methods

Rating	Name	Duplication	Size	Complexity
B	resource()	9	42	6
B	controller()	8	33	6
B	relationship()	0	26	1

<?php namespace Limoncello\Flute\Http\Traits;

/**
 * Copyright 2015-2017 info@neomerx.com
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

use Limoncello\Contracts\Routing\GroupInterface;
use Limoncello\Contracts\Routing\RouteInterface;
use Limoncello\Flute\Contracts\Http\Controller\ControllerCreateInterface;
use Limoncello\Flute\Contracts\Http\Controller\ControllerDeleteInterface;
use Limoncello\Flute\Contracts\Http\Controller\ControllerIndexInterface;
use Limoncello\Flute\Contracts\Http\Controller\ControllerReadInterface;
use Limoncello\Flute\Contracts\Http\Controller\ControllerUpdateInterface;
use Limoncello\Flute\Contracts\Http\ControllerInterface as CI;
use Limoncello\Flute\Contracts\Schema\SchemaInterface;
use Limoncello\Flute\Http\BaseController;
use Neomerx\JsonApi\Contracts\Document\DocumentInterface;

/**
 * @package Limoncello\Flute
 */
trait FluteRoutesTrait
{
    /**
     * @param GroupInterface $group
     * @param string         $controllerClass
     *
     * @return GroupInterface
     */
    protected static function resource(GroupInterface $group, string $controllerClass): GroupInterface
    {
        /** @var BaseController $controllerClass */
        assert(array_key_exists(BaseController::class, class_parents($controllerClass)) === true);
        $schemeClass = $controllerClass::SCHEMA_CLASS;
        assert(
            empty($schemeClass) === false,
            "Scheme class is not specified for controller `$controllerClass`."
        );

        /** @var SchemaInterface $schemeClass */
        assert(array_key_exists(SchemaInterface::class, class_implements($schemeClass)) === true);
        $type = $schemeClass::TYPE;

        $indexSlug = '/{' . BaseController::ROUTE_KEY_INDEX . '}';
        $params    = function ($method) use ($type) {
            return [RouteInterface::PARAM_NAME => $type . '_' . $method];
        };
        $handler   = function ($method) use ($controllerClass) {
            return [$controllerClass, $method];
        };

        // if the class implements any of CRUD methods a corresponding route will be added
        $classInterfaces = class_implements($controllerClass);
        if (in_array(ControllerIndexInterface::class, $classInterfaces) === true) {
            $group->get($type, $handler(CI::METHOD_INDEX), $params(CI::METHOD_INDEX));
        }
        if (in_array(ControllerCreateInterface::class, $classInterfaces) === true) {
            $group->post($type, $handler(CI::METHOD_CREATE), $params(CI::METHOD_CREATE));
        }
        if (in_array(ControllerReadInterface::class, $classInterfaces) === true) {

This code seems to be duplicated across your project.

            $group->get($type . $indexSlug, $handler(CI::METHOD_READ), $params(CI::METHOD_READ));
        }
        if (in_array(ControllerUpdateInterface::class, $classInterfaces) === true) {

This code seems to be duplicated across your project.

            $group->patch($type . $indexSlug, $handler(CI::METHOD_UPDATE), $params(CI::METHOD_UPDATE));
        }
        if (in_array(ControllerDeleteInterface::class, $classInterfaces) === true) {

This code seems to be duplicated across your project.

            $group->delete($type . $indexSlug, $handler(CI::METHOD_DELETE), $params(CI::METHOD_DELETE));
        }

        return $group;
    }

    /**
     * @param GroupInterface $group
     * @param string         $subUri
     * @param string         $controllerClass
     *
     * @return GroupInterface
     */
    protected static function controller(GroupInterface $group, string $subUri, string $controllerClass): GroupInterface
    {
        $slugged = $subUri . '/{' . BaseController::ROUTE_KEY_INDEX . '}';
        $params  = function ($method) use ($subUri) {
            return [RouteInterface::PARAM_NAME => $subUri . '_' . $method];
        };
        $handler = function ($method) use ($controllerClass) {
            return [$controllerClass, $method];
        };

        // if the class implements any of CRUD methods a corresponding route will be added
        // as HTML forms do not support methods other than GET/POST we use POST and special URI for update and delete.
        $classInterfaces = class_implements($controllerClass);
        if (in_array(ControllerIndexInterface::class, $classInterfaces) === true) {
            $group->get($subUri, $handler(CI::METHOD_INDEX), $params(CI::METHOD_INDEX));
        }
        if (in_array(ControllerCreateInterface::class, $classInterfaces) === true) {
            $group->post($subUri, $handler(CI::METHOD_CREATE), $params(CI::METHOD_CREATE));
        }
        if (in_array(ControllerReadInterface::class, $classInterfaces) === true) {
            $group->get($slugged, $handler(CI::METHOD_READ), $params(CI::METHOD_READ));
        }
        if (in_array(ControllerUpdateInterface::class, $classInterfaces) === true) {

This code seems to be duplicated across your project.

            $updateUri = $slugged . '/' . CI::METHOD_UPDATE;
            $group->post($updateUri, $handler(CI::METHOD_UPDATE), $params(CI::METHOD_UPDATE));
        }
        if (in_array(ControllerDeleteInterface::class, $classInterfaces) === true) {

This code seems to be duplicated across your project.

            $deleteUri = $slugged . '/' . CI::METHOD_DELETE;
            $group->post($deleteUri, $handler(CI::METHOD_DELETE), $params(CI::METHOD_DELETE));
        }

        return $group;
    }

    /**
     * @param GroupInterface $group
     * @param string         $relationshipName
     * @param string         $controllerClass
     * @param string         $selfGetMethod
     *
     * @return GroupInterface
     */
    protected static function relationship(
        GroupInterface $group,
        string $relationshipName,
        string $controllerClass,
        string $selfGetMethod
    ): GroupInterface {
        /** @var BaseController $controllerClass */
        assert(array_key_exists(BaseController::class, class_parents($controllerClass)) === true);
        $schemaClass = $controllerClass::SCHEMA_CLASS;

        /** @var SchemaInterface $schemaClass */
        assert(array_key_exists(SchemaInterface::class, class_implements($schemaClass)) === true);
        $subUri = $schemaClass::TYPE;

        /** @var string $controllerClass */
        /** @var string $schemaClass */

        $resourceIdUri = $subUri . '/{' . CI::ROUTE_KEY_INDEX . '}/';
        $selfUri       = $resourceIdUri . DocumentInterface::KEYWORD_RELATIONSHIPS . '/' . $relationshipName;

        return $group
            // `self`
            ->get($selfUri, [$controllerClass, $selfGetMethod])
            // `related`
            ->get($resourceIdUri . $relationshipName, [$controllerClass, $selfGetMethod]);
    }
}