Arcanedev\LaravelActive\Active

Complexity

Total Complexity

26

Size/Duplication

Total Lines	270
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	4

Test Coverage

Coverage

100%

Importance

Changes

0

16 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	5	1
A	getActiveClass()	0	4	1
A	setActiveClass()	0	6	1
A	getFallbackClass()	0	4	1
A	setFallbackClass()	0	6	1
A	getRequest()	0	4	2
A	setRequest()	0	6	1
A	active()	0	6	1
A	route()	0	6	1
A	path()	0	6	1
A	is()	0	5	2
A	isRoute()	0	10	2
A	isPath()	0	10	2
A	getCssClass()	0	6	4
A	isIgnored()	0	5	3
A	parseRoutes()	0	17	2

<?php

declare(strict_types=1);

namespace Arcanedev\LaravelActive;

use Arcanedev\LaravelActive\Contracts\Active as ActiveContract;
use Illuminate\Support\{
    Arr,
    Collection,
    Str};
use Illuminate\Http\Request;

/**
 * Class     Active
 *
 * @package  Arcanedev\LaravelActive
 * @author   ARCANEDEV <arcanedev.maroc@gmail.com>
 */
class Active implements ActiveContract
{
    /* -----------------------------------------------------------------
     |  Properties
     | -----------------------------------------------------------------
     */

    /** @var  string */
    protected $activeClass;

    /** @var  string */
    protected $fallbackClass;

    /** @var  \Illuminate\Http\Request */
    protected $request;

    /* -----------------------------------------------------------------
     |  Constructor
     | -----------------------------------------------------------------
     */

    /**
     * Active constructor.
     *
     * @param  array  $options
     */
    public function __construct(array $options)
    {
        $this->setActiveClass(Arr::get($options, 'class', 'active'));
        $this->setFallbackClass(Arr::get($options, 'fallback-class'));
    }

    /* -----------------------------------------------------------------
     |  Getters & Setters
     | -----------------------------------------------------------------
     */

    /**
     * Get the `active` CSS class.
     *
     * @return string
     */
    public function getActiveClass(): string
    {
        return $this->activeClass;
    }

    /**
     * Set the `active` CSS class.
     *
     * @param  string  $class
     *
     * @return $this
     */
    public function setActiveClass(string $class)
    {
        $this->activeClass = $class;

        return $this;
    }

    /**
     * Get the fallback (inactive) class.
     *
     * @return string|null
     */
    public function getFallbackClass(): ?string
    {
        return $this->fallbackClass;
    }

    /**
     * Set the fallback (inactive) class.
     *
     * @param  string|null  $class
     *
     * @return $this
     */
    public function setFallbackClass(?string $class)
    {
        $this->fallbackClass = $class;

        return $this;
    }

    /**
     * Get the request.
     *
     * @return \Illuminate\Http\Request
     */
    public function getRequest(): Request
    {
        return $this->request ?: app('request');
    }

    /**
     * Set the request.
     *
     * @param  \Illuminate\Http\Request  $request
     *
     * @return $this
     */
    public function setRequest(Request $request)
    {
        $this->request = $request;

        return $this;
    }

    /* -----------------------------------------------------------------
     |  Main Methods
     | -----------------------------------------------------------------
     */

    /**
     * Get the active class if the current path/route is active.
     *
     * @param  string|array  $routes
     * @param  string|null   $class
     * @param  string|null   $fallback
     *
     * @return string|null
     */
    public function active($routes, $class = null, $fallback = null)
    {
        return $this->getCssClass(
            $this->is($routes), $class, $fallback
        );
    }

    /**
     * Get the active class if the current route is in haystack routes.
     *
     * @param  string|array  $routes
     * @param  string|null   $class
     * @param  string|null   $fallback
     *
     * @return string|null
     */
    public function route($routes, $class = null, $fallback = null)
    {
        return $this->getCssClass(
            $this->isRoute($routes), $class, $fallback
        );
    }

    /**
     * Get the active class if the current path is in haystack paths.
     *
     * @param  string|array  $routes
     * @param  string|null   $class
     * @param  string|null   $fallback
     *
     * @return string|null
     */
    public function path($routes, $class = null, $fallback = null)
    {
        return $this->getCssClass(
            $this->isPath($routes), $class, $fallback
        );
    }

    /**
     * Check if any given routes/paths are active.
     *
     * @param  string|array  $routes
     *
     * @return bool
     */
    public function is($routes): bool
    {
        return $this->isPath($routes)
            || $this->isRoute($routes);
    }

    /**
     * Check if the current route is one of the given routes.
     *
     * @param  string|array  $routes
     *
     * @return bool
     */
    public function isRoute($routes): bool
    {
        list($patterns, $ignored) = $this->parseRoutes(Arr::wrap($routes));

        if ($this->isIgnored($ignored)) {
            return false;
        }

        return $this->getRequest()->routeIs($patterns);
    }

    /**
     * Check if the current path is active.
     *
     * @param  string|array  $routes
     *
     * @return bool
     */
    public function isPath($routes): bool
    {
        list($routes, $ignored) = $this->parseRoutes(Arr::wrap($routes));

        if ($this->isIgnored($ignored)) {
            return false;
        }

        return $this->getRequest()->is($routes);
    }

    /* -----------------------------------------------------------------
     |  Other Methods
     | -----------------------------------------------------------------
     */

    /**
     * Get the css class based on the given active state.
     *
     * @param  bool         $isActive
     * @param  string|null  $class
     * @param  string|null  $fallback
     *
     * @return string|null
     */
    protected function getCssClass(bool $isActive, ?string $class = null, ?string $fallback = null): ?string
    {
        return $isActive
            ? ($class ?: $this->getActiveClass())
            : ($fallback ?: $this->getFallbackClass());
    }

    /**
     * Check if the given routes/paths are ignored.
     *
     * @param  array  $ignored
     *
     * @return bool
     */
    protected function isIgnored(array $ignored): bool
    {
        return count($ignored)
            && ($this->isPath($ignored) || $this->isRoute($ignored));
    }

    /**
     * Separate ignored routes from the whitelist routes.
     *
     * @param  array  $allRoutes
     *
     * @return array
     */
    protected function parseRoutes(array $allRoutes): array
    {
        return Collection::make($allRoutes)
            ->partition(function ($route) {
                return ! Str::startsWith($route, ['not:']);
            })
            ->transform(function (Collection $routes, $index) {
                if ($index === 0) {
                    return $routes;
                }

                return $routes->transform(function ($route) {
                    return substr($route, 4);
                });
            })
            ->toArray();
    }
}