Varnish - Code Metrics - Inspection of "Add support to flush remote Varnish cache using so..." - spatie/laravel-varnish - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#28)

unknown

created 2018-04-23 23:56 UTC

Varnish A

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	144
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	3

Importance

Changes

Metric	Value
wmc	13
lcom	1
cbo	3
dl	0
loc	144
rs	10
c	0
b	0
f	0

7 Methods

Rating	Name	Size	Complexity
A	flush()	23	3
A	getHosts()	10	2
A	generateBanCommand()	6	1
A	generateBanExpr()	14	2
A	getSecret()	12	3
A	executeCommand()	7	1
A	executeSocketCommand()	18	1

<?php

namespace Spatie\Varnish;

use Symfony\Component\Process\Process;

class Varnish
{
    /*
     * Known exec types
     */
    const EXEC_SOCKET = 'socket';
    const EXEC_COMMAND = 'command';

    /**
     * @param string|array $host
     *
     * @return bool|null
     *
     * @throws \Exception
     */
    public function flush($host = null)
    {
        $config = config('varnish');

        $host = $this->getHosts($host);
        $expr = $this->generateBanExpr($host);

        // Default to execution_type command when the config parameter is not set
        switch ($config['execution_type'] ?? self::EXEC_COMMAND) {
            case self::EXEC_SOCKET:
switch ($expr) {
    case "A": { //wrong
        doSomething();
        break;
    }
    case "B"; //wrong
        doSomething();
        break;
    case "C": //right
        doSomething();
        break;
}
                return $this->executeSocketCommand($expr);
                break;
switch ($x) {
    case 1:
        return 'foo';
        break; // This break is not necessary and can be left off.
}
            case self::EXEC_COMMAND:
switch ($expr) {
    case "A": { //wrong
        doSomething();
        break;
    }
    case "B"; //wrong
        doSomething();
        break;
    case "C": //right
        doSomething();
        break;
}
                $command = $this->generateBanCommand($expr);

                return $this->executeCommand($command);
                break;
switch ($x) {
    case 1:
        return 'foo';
        break; // This break is not necessary and can be left off.
}
            default:
                throw new \Exception(sprintf(
                    'Unknown execution type: %s', $config['execution_type']
                ));
        }
    }

    /**
     * @param array|string $host
     *
     * @return array
     */
    protected function getHosts($host = null): array
    {
        $host = $host ?? config('varnish.host');

        if (! is_array($host)) {
            $host = [$host];
        }

        return $host;
    }

    /**
     * @param string $expr
     *
     * @return string
     */
    public function generateBanCommand($expr = ''): string
    {
        $config = config('varnish');

        return "sudo varnishadm -S {$config['administrative_secret_file']} -T 127.0.0.1:{$config['administrative_port']} '{$expr}'";
    }

    /**
     * @param array $hosts
     *
     * @return string
     */
    public function generateBanExpr(array $hosts): string
    {
        if (! is_array($hosts)) {
            $hosts = [$hosts];
        }

        $hostsRegex = collect($hosts)
            ->map(function (string $host) {
                return "(^{$host}$)";
            })
            ->implode('|');

        return sprintf('ban req.http.host ~ %s', $hostsRegex);
    }

    /**
     * @return string
     */
    public function getSecret()
    {
        $config = config('varnish');
        if (! $secret = $config['administrative_secret']) {
            $secret = '';
            if (file_exists($config['administrative_secret_file'])) {
                $secret = trim(file_get_contents($config['administrative_secret_file']));
            }
        }

        return $secret;
    }

    /**
     * @param string $command
     *
     * @return bool
     *
     * @throws \Exception When the command fails
     */
    protected function executeCommand(string $command): bool
    {
        $process = new Process($command);
        $process->run();

        return $process->isSuccessful();
    }

    /**
     * @param string $command
     *
     * @return bool
     *
     * @throws \Exception When connection to socket or command failed
     */
    protected function executeSocketCommand(string $command): bool
    {
        $config = config('varnish');
        $socket = new VarnishSocket();

        try {
            $socket->connect(
                $config['administrative_host'],
                $config['administrative_port'],
                $this->getSecret()
            );
            $socket->command($command);
        } finally {
            $socket->quit();
        }

        return true;
    }
}


1			<?php
2
3			namespace Spatie\Varnish;
4
5			use Symfony\Component\Process\Process;
6
7			class Varnish
8			{
9			/*
10			* Known exec types
11			*/
12			const EXEC_SOCKET = 'socket';
13			const EXEC_COMMAND = 'command';
14
15			/**
16			* @param string\|array $host
17			*
18			* @return bool\|null
19			*
20			* @throws \Exception
21			*/
22			public function flush($host = null)
23			{
24			$config = config('varnish');
25
26			$host = $this->getHosts($host);
27			$expr = $this->generateBanExpr($host);
28
29			// Default to execution_type command when the config parameter is not set
30			switch ($config['execution_type'] ?? self::EXEC_COMMAND) {
31			case self::EXEC_SOCKET:
			0 ignored issues – show Coding Style introduced 2018-04-23 23:36 UTC by Report Bug Copy Issue Report `case` statements should be defined using a colon. As per the PSR-2 coding standard, case statements should not be wrapped in curly braces. There is no need for braces, since each case is terminated by the next `break`. There is also the option to use a semicolon instead of a colon, this is discouraged because many programmers do not even know it works and the colon is universal between programming languages. switch ($expr) { case "A": { //wrong doSomething(); break; } case "B"; //wrong doSomething(); break; case "C": //right doSomething(); break; } To learn more about the PSR-2 coding standard, please refer to the PHP-Fig. Loading history...
32			return $this->executeSocketCommand($expr);
33			break;
			0 ignored issues – show Unused Code introduced 2018-04-23 23:36 UTC by Report Bug Copy Issue Report `break` is not strictly necessary here and could be removed. The `break` statement is not necessary if it is preceded for example by a `return` statement: switch ($x) { case 1: return 'foo'; break; // This break is not necessary and can be left off. } If you would like to keep this construct to be consistent with other `case` statements, you can safely mark this issue as a false-positive. Loading history...
34			case self::EXEC_COMMAND:
			0 ignored issues – show Coding Style introduced 2018-04-23 23:36 UTC by Report Bug Copy Issue Report `case` statements should be defined using a colon. As per the PSR-2 coding standard, case statements should not be wrapped in curly braces. There is no need for braces, since each case is terminated by the next `break`. There is also the option to use a semicolon instead of a colon, this is discouraged because many programmers do not even know it works and the colon is universal between programming languages. switch ($expr) { case "A": { //wrong doSomething(); break; } case "B"; //wrong doSomething(); break; case "C": //right doSomething(); break; } To learn more about the PSR-2 coding standard, please refer to the PHP-Fig. Loading history...
35			$command = $this->generateBanCommand($expr);
36
37			return $this->executeCommand($command);
38			break;
			0 ignored issues – show Unused Code introduced 2018-04-23 23:36 UTC by Report Bug Copy Issue Report `break` is not strictly necessary here and could be removed. The `break` statement is not necessary if it is preceded for example by a `return` statement: switch ($x) { case 1: return 'foo'; break; // This break is not necessary and can be left off. } If you would like to keep this construct to be consistent with other `case` statements, you can safely mark this issue as a false-positive. Loading history...
39			default:
40			throw new \Exception(sprintf(
41			'Unknown execution type: %s', $config['execution_type']
42			));
43			}
44			}
45
46			/**
47			* @param array\|string $host
48			*
49			* @return array
50			*/
51			protected function getHosts($host = null): array
52			{
53			$host = $host ?? config('varnish.host');
54
55			if (! is_array($host)) {
56			$host = [$host];
57			}
58
59			return $host;
60			}
61
62			/**
63			* @param string $expr
64			*
65			* @return string
66			*/
67			public function generateBanCommand($expr = ''): string
68			{
69			$config = config('varnish');
70
71			return "sudo varnishadm -S {$config['administrative_secret_file']} -T 127.0.0.1:{$config['administrative_port']} '{$expr}'";
72			}
73
74			/**
75			* @param array $hosts
76			*
77			* @return string
78			*/
79			public function generateBanExpr(array $hosts): string
80			{
81			if (! is_array($hosts)) {
82			$hosts = [$hosts];
83			}
84
85			$hostsRegex = collect($hosts)
86			->map(function (string $host) {
87			return "(^{$host}$)";
88			})
89			->implode('\|');
90
91			return sprintf('ban req.http.host ~ %s', $hostsRegex);
92			}
93
94			/**
95			* @return string
96			*/
97			public function getSecret()
98			{
99			$config = config('varnish');
100			if (! $secret = $config['administrative_secret']) {
101			$secret = '';
102			if (file_exists($config['administrative_secret_file'])) {
103			$secret = trim(file_get_contents($config['administrative_secret_file']));
104			}
105			}
106
107			return $secret;
108			}
109
110			/**
111			* @param string $command
112			*
113			* @return bool
114			*
115			* @throws \Exception When the command fails
116			*/
117			protected function executeCommand(string $command): bool
118			{
119			$process = new Process($command);
120			$process->run();
121
122			return $process->isSuccessful();
123			}
124
125			/**
126			* @param string $command
127			*
128			* @return bool
129			*
130			* @throws \Exception When connection to socket or command failed
131			*/
132			protected function executeSocketCommand(string $command): bool
133			{
134			$config = config('varnish');
135			$socket = new VarnishSocket();
136
137			try {
138			$socket->connect(
139			$config['administrative_host'],
140			$config['administrative_port'],
141			$this->getSecret()
142			);
143			$socket->command($command);
144			} finally {
145			$socket->quit();
146			}
147
148			return true;
149			}
150			}
151

spatie / laravel-varnish

GitHub Access Token became invalid

Pull Request — master (#28)

Varnish A

Complexity

Size/Duplication

Coupling/Cohesion

Importance

7 Methods

Duplication Side-by-Side

Filter issues like