RouteListCommand::hasGeoOption() - Code Metrics - Inspection of "Merge pull request #43 from LaraCrafts/artisan-com..." - LaraCrafts/laravel-geo-routes - Measure and Improve Code Quality continuously with Scrutinizer

Completed
Push — master ( d09c49...b1a6d4 )

by Raed
created 2020-03-29 13:23 UTC
RouteListCommand::hasGeoOption() A

↳ Parent: RouteListCommand
Complexity

Conditions	4
Paths	4
Size

Total Lines	4
Code Lines	2
Duplication

Lines	0
Ratio	0 %
Code Coverage

Tests	3
CRAP Score	4
Importance

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

namespace LaraCrafts\GeoRoutes\Console\Commands;

use Illuminate\Foundation\Console\RouteListCommand as BaseCommand;
use Illuminate\Routing\Route;
use Illuminate\Support\Arr;
use Illuminate\Support\Facades\Validator;
use Symfony\Component\Console\Input\InputOption;

class RouteListCommand extends BaseCommand
{
    /**
     * The console command name.
     *
     * @var string
     */
    protected $name = 'route:list';

    /**
     * The console command description.
     *
     * @var string
     */
    protected $description = 'List all registered routes';

    /**
     * The router instance.
     *
     * @var \Illuminate\Routing\Router
     */
    protected $router;

    /**
     * The table geo headers for the command.
     *
     * @var array
     */
    protected $geoHeaders = ['Countries', 'Strategy', 'Callback'];

    /**
     * The columns to display when using the "compact" flag.
     *
     * @var array
     */
    protected $compactColumns = ['method', 'uri', 'action'];

    /**
     * Get the route information for a given route.
     *
     * @param  \Illuminate\Routing\Route  $route
     * @return array
     */
    protected function getRouteInformation(Route $route)
    {
        return $this->filterRoute([
            'domain' => $route->domain(),
            'method' => implode('|', $route->methods()),
            'uri'    => $route->uri(),
            'name'   => $route->getName(),
            'action' => ltrim($route->getActionName(), '\\'),
            'middleware' => $this->getMiddleware($route),
            'is_geo' => $this->isGeoRoute($route),
            'countries' => $this->getCountries($route),
            'strategy' => $this->getStrategy($route),
            'callback' => $this->getCallback($route),
        ]);
    }

    /**
     * Display the route information on the console.
     *
     * @param  array  $routes
     * @return void
     */
    protected function displayRoutes(array $routes)
    {
        if ($this->hasOption('json') && $this->option('json')) {
            $this->line(json_encode(array_values($routes)));

            return;
        }
        
        $this->table($this->getHeaders(), $this->formatRoutes($routes));
    }

    /**
     * Format the routes output.
     *
     * @param array $routes
     *
     * @return array
     */
    protected function formatRoutes(array $routes)
    {
        foreach ($routes as $key => $route) {
            $routes[$key]['countries'] = $this->formatCountries($route['countries']);
            $routes[$key]['strategy'] = $this->formatStrategy($route['strategy']);
            $routes[$key]['callback'] = $this->formatCallback($route['callback']);
        }

        return $routes;
    }

    /**
     * Filter the route by the coutnry, strategy,
     * URI or/and name
     *
     * @param  array  $route
     *
     * @return array|null
     */
    protected function filterRoute(array $route)
    {
        if (($this->option('country') && !in_array(strtoupper($this->option('country')), $route['countries'] ?? []))
        if (($this->option('country') && !in_array(strtoupper(/** @scrutinizer ignore-type */ $this->option('country')), $route['countries'] ?? []))
            || $this->option('strategy') && $route['strategy'] != strtolower($this->option('strategy'))
            || $this->option('strategy') && $route['strategy'] != strtolower(/** @scrutinizer ignore-type */ $this->option('strategy'))
            || $this->option('geo-only') && !$route['is_geo']) {
            return;
        }

        return parent::filterRoute($route);
    }

    /**
     * Get the table headers for the visible columns.
     *
     * @return array
     */
    protected function getHeaders()
    {
        return Arr::only(
            $this->hasGeoOption() ? array_merge($this->headers, $this->geoHeaders) : $this->headers,
            array_keys($this->getColumns())
        );
    }

    /**
     * Get the column names to show (lowercase table headers).
     *
     * @return array
     */
    protected function getColumns()
    {
        $availableColumns = array_map(
            'strtolower',
            $this->hasGeoOption() ? array_merge($this->headers, $this->geoHeaders) : $this->headers
        );

        if ($this->hasOption('compact') && $this->option('compact')) {
            return array_intersect($availableColumns, $this->compactColumns);
        }

        if ($this->hasOption('columns') && $columns = $this->option('columns')) {
            return array_intersect($availableColumns, $this->parseColumns($columns));
            return array_intersect($availableColumns, $this->parseColumns(/** @scrutinizer ignore-type */ $columns));
        }

        return $availableColumns;
    }

    /**
     * Determine if the given route is a georoute.
     *
     * @param \Illuminate\Routing\Route $route
     *
     * @return boolean
     */
    protected function isGeoRoute(Route $route)
    {
        $validator = Validator::make($route->getAction('geo') ?? [], [
            'countries' => 'required|array|min:1',
            'countries.*' => 'string|min:2|max:2',
            'strategy' => 'required|in:allow,deny',
        ]);

        return $validator->passes();
    }

    /**
     * Get the list of countries covered by
     * the geo-constraint for the given route.
     *
     * @param \Illuminate\Routing\Route $route
     *
     * @return array|null
     */
    protected function getCountries(Route $route)
    {
        return $route->getAction('geo')['countries'];
    }

    /**
     * Get the route geo strategy.
     *
     * @param \Illuminate\Routing\Route $route
     *
     * @return string|null
     */
    protected function getStrategy(Route $route)
    {
        return $route->getAction('geo')['strategy'];
    }

    /**
     * Get the route geo callback.
     *
     * @param \Illuminate\Routing\Route $route
     *
     * @return string|null
     */
    protected function getCallback(Route $route)
    {
        return $route->getAction('geo')['callback'][0];
    }
    
    /**
     * Format the route strategy output.
     *
     * @param string|null $strategy
     *
     * @return string
     */
    protected function formatStrategy($strategy)
    {
        $strategy = strtolower($strategy);

        if ($strategy == 'allow') {
            return '<fg=green;options=bold>Allow</>';
        }

        if ($strategy == 'deny') {
            return '<fg=red;options=bold>Deny</>';
        }

        return '<fg=yellow>None</>';
    }

    /**
     * Format the route countries output.
     *
     * @param array|null $countries
     *
     * @return string
     */
    protected function formatCountries($countries)
    {
        return $countries ? implode(', ', $countries) : '<fg=yellow>None</>';
    }

    /**
     * Format the route callback output.
     *
     * @param string|null $callback
     *
     * @return string
     */
    protected function formatCallback($callback)
    {
        return !is_null($callback) ? str_replace('::', '@', $callback) : '<fg=yellow>None</>';
    }

    /**
     * Determine if any geo option exists.
     *
     * @return boolean
     */
    protected function hasGeoOption()
    {
        return $this->option('geo') || $this->option('geo-only')
            || $this->option('country') || $this->option('strategy');
    }

    /**
     * Get the console command options.
     *
     * @return array
     */
    protected function getOptions()
    {
        return array_merge(parent::getOptions(), [
            ['geo', 'g', InputOption::VALUE_NONE, 'Show the routes geo specifications'],
            ['geo-only', null, InputOption::VALUE_NONE, 'Display GeoRoutes only'],
            ['strategy', null, InputOption::VALUE_REQUIRED, 'Display only the routes that have a given strategy'],
            ['country', null, InputOption::VALUE_REQUIRED, 'Display only the routes that have a given country'],
        ]);
    }
}

LaraCrafts / laravel-geo-routes

Push — master ( d09c49...b1a6d4 )

RouteListCommand::hasGeoOption() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like
