Triadev\PrometheusExporter\Provider\PrometheusExporterServiceProvider

Complexity

Total Complexity

14

Size/Duplication

Total Lines	85
Duplicated Lines	0 %

Test Coverage

Coverage

90.91%

Importance

Changes	7
Bugs	0	Features	0

6 Methods

Rating	Name	Duplication	Size	Complexity
A	registerMiddlewareForRequestMetrics()	0	6	2
A	bootConfig()	0	13	3
A	bootRoutes()	0	4	2
A	registerAdapter()	0	19	5
A	boot()	0	4	1
A	register()	0	11	1

<?php

Filename "PrometheusExporterServiceProvider.php" doesn't match the expected filename "prometheusexporterserviceprovider.php"

namespace Triadev\PrometheusExporter\Provider;

use Illuminate\Routing\Router;
use Illuminate\Support\ServiceProvider;
use Prometheus\Storage\InMemory;
use Triadev\PrometheusExporter\Contract\PrometheusExporterContract;
use Prometheus\Storage\Redis;
use Prometheus\Storage\APC;
use Prometheus\Storage\Adapter;
use Triadev\PrometheusExporter\Middleware\RequestPerRoute;
use Triadev\PrometheusExporter\PrometheusExporter;

class PrometheusExporterServiceProvider extends ServiceProvider
{
    /**
     * Bootstrap the application events.
     *
     * @return void
     */
    public function boot()

Expected 2 blank lines before function; 0 found

    {

Opening brace should be on the same line as the declaration

        $this->bootConfig();
        $this->bootRoutes();
    }

Expected 2 blank lines after function; 1 found

Expected 1 blank line before closing function brace; 0 found

Expected //end boot()

    
    private function bootConfig()

Private method name "PrometheusExporterServiceProvider::bootConfig" must be prefixed with an underscore

Missing function doc comment

    {

Opening brace should be on the same line as the declaration

        $source = realpath(__DIR__ . '/../Config/config.php');

Concat operator must not be surrounded by spaces

    
        if (class_exists('Illuminate\Foundation\Application', false)) {
            $this->publishes([

The opening parenthesis of a multi-line function call should be the last content on the line.

Short array syntax is not allowed

                __DIR__ . '/../Config/config.php' => config_path('prometheus-exporter.php'),

This array key does not seem to be aligned correctly; expected 30 spaces, but found 16.

Concat operator must not be surrounded by spaces

            ], 'config');

The closing parenthesis does not seem to be aligned correctly; expected 29 space(s), but found 12.

For multi-line function calls, the closing parenthesis should be on a new line.

        } elseif (class_exists('Laravel\Lumen\Application', false)) {

Usage of ELSEIF not allowed; use ELSE IF instead

            $this->app/** @scrutinizer ignore-call */->configure('prometheus-exporter');

The open comment tag must be the only content on the line

Missing short description in doc comment

The close comment tag must be the only content on the line

        }
    
        $this->mergeConfigFrom($source, 'prometheus-exporter');
    }

Expected 2 blank lines after function; 1 found

Expected 1 blank line before closing function brace; 0 found

Expected //end bootConfig()

    
    private function bootRoutes()

Private method name "PrometheusExporterServiceProvider::bootRoutes" must be prefixed with an underscore

Missing function doc comment

    {

Opening brace should be on the same line as the declaration

        if (class_exists('Illuminate\Foundation\Application', false)) {
            $this->loadRoutesFrom(__DIR__ . '/../Routes/routes.php');

Concat operator must not be surrounded by spaces

        }
    }

Expected 2 blank lines after function; 1 found

Expected 1 blank line before closing function brace; 0 found

Expected //end bootRoutes()

    /**
     * Register the service provider.
     *
     * @throws \ErrorException
     */

Missing @return tag in function comment

    public function register()
    {

Opening brace should be on the same line as the declaration

        $this->mergeConfigFrom(__DIR__ . '/../Config/config.php', 'prometheus-exporter');

Concat operator must not be surrounded by spaces

    
        $this->registerAdapter();
        $this->registerMiddlewareForRequestMetrics();
    
        $this->app->bind(
            PrometheusExporterContract::class,
            PrometheusExporter::class,
            true
        );
    }

Expected 2 blank lines after function; 1 found

Expected 1 blank line before closing function brace; 0 found

Expected //end register()

    
    /**

Missing short description in doc comment

     * @throws \ErrorException
     */

Missing @return tag in function comment

    private function registerAdapter()

Private method name "PrometheusExporterServiceProvider::registerAdapter" must be prefixed with an underscore

    {

Opening brace should be on the same line as the declaration

        switch (config('prometheus-exporter.adapter')) {
            case 'apc':

Line indented incorrectly; expected 8 spaces, found 12

                $this->app->bind(Adapter::class, APC::class);
                break;

Case breaking statement must be indented 4 spaces from SWITCH keyword

Case breaking statements must be followed by a single blank line

            case 'redis':

Line indented incorrectly; expected 8 spaces, found 12

                $this->app->bind(Adapter::class, function () {

The opening parenthesis of a multi-line function call should be the last content on the line.

                    return new Redis(config('prometheus-exporter.redis'));
                });

Line indented incorrectly; expected 12 spaces, found 16

For multi-line function calls, the closing parenthesis should be on a new line.

                break;

Case breaking statement must be indented 4 spaces from SWITCH keyword

Case breaking statements must be followed by a single blank line

            case 'push':

Line indented incorrectly; expected 8 spaces, found 12

                $this->app->bind(Adapter::class, APC::class);
                break;

Case breaking statement must be indented 4 spaces from SWITCH keyword

Case breaking statements must be followed by a single blank line

            case 'inmemory':

Line indented incorrectly; expected 8 spaces, found 12

                $this->app->bind(Adapter::class, InMemory::class);
                break;

Case breaking statement must be indented 4 spaces from SWITCH keyword

Case breaking statements must be followed by a single blank line

            default:

Line indented incorrectly; expected 8 spaces, found 12

                throw new \ErrorException('"prometheus-exporter.adapter" must be either apc or redis');

Case breaking statement must be indented 4 spaces from SWITCH keyword

This line exceeds maximum limit of 100 characters; contains 103 characters

        }
    }

Expected 2 blank lines after function; 1 found

Expected 1 blank line before closing function brace; 0 found

Expected //end registerAdapter()

    
    private function registerMiddlewareForRequestMetrics()

Private method name "PrometheusExporterServiceProvider::registerMiddlewareForRequestMetrics" must be prefixed with an underscore

Missing function doc comment

    {

Opening brace should be on the same line as the declaration

        if (class_exists('Illuminate\Foundation\Application', false)) {
            /** @var Router $router */

The open comment tag must be the only content on the line

Missing short description in doc comment

The close comment tag must be the only content on the line

            $router = $this->app['router'];
            $router->aliasMiddleware('lpe.requestPerRoute', RequestPerRoute::class);
        }
    }

Expected 2 blank lines after function; 0 found

Expected 1 blank line before closing function brace; 0 found

Expected //end registerMiddlewareForRequestMetrics()

}

Expected //end class

As per coding style, files should not end with a newline character.