MessageCategory::exclude() - Code Metrics - Inspection of "New demo feature" - yiisoft/log - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Pull Request — master (#49)

by Evgeniy

created 2020-11-24 18:47 UTC

MessageCategory::exclude() A

↳ Parent: MessageCategory

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	3
CRAP Score	1

Importance

Changes

Metric	Value
cc	1
eloc	2
c	0
b	0
f	0
nc	1
nop	1
dl	0
loc	4
ccs	3
cts	3
cp	1
crap	1
rs	10

<?php

declare(strict_types=1);

namespace Yiisoft\Log;

use Psr\Log\InvalidArgumentException;

use function gettype;
use function is_string;
use function rtrim;
use function substr_compare;
use function sprintf;
use function strpos;

/**
 * Category is a data object that stores and matches the included and excluded categories of log messages.
 */
final class MessageCategory
{
    public const DEFAULT = 'application';

    /**
     * @var string[] The list of included log message categories.
     *
     * Defaults to empty, which means all categories are included.
     *
     * You can use an asterisk at the end of a category so that the category may be used to
     * match those categories sharing the same common prefix. For example, 'Yiisoft\Db\*' will match
     * categories starting with 'Yiisoft\Db\', such as `Yiisoft\Db\Connection`.
     */
    private array $include = [];

    /**
     * @var string[] The list of excluded log message categories.
     *
     * Defaults to empty, which means there are no excluded categories.
     *
     * You can use an asterisk at the end of a category so that the category can be used to
     * match those categories sharing the same common prefix. For example, 'Yiisoft\Db\*' will match
     * categories starting with 'Yiisoft\Db\', such as `Yiisoft\Db\Connection`.
     */
    private array $exclude = [];

    /**
     * Sets the log message categories to be included.
     *
     * @param string[] $categories List of log message categories to be included.
     * @throws InvalidArgumentException for invalid log message categories structure.
     */
    public function include(array $categories): void
    {
        $this->checkStructure($categories);
        $this->include = $categories;
    }

    /**
     * Gets the log message categories to be included.
     *
     * @return string[] The list of log message categories to be included.
     */
    public function getIncluded(): array
    {
        return $this->include;
    }

    /**
     * Sets the log message categories to be excluded.
     *
     * @param string[] $categories The list of log message categories to be excluded.
     * @throws InvalidArgumentException for invalid log message categories structure.
     */
    public function exclude(array $categories): void
    {
        $this->checkStructure($categories);
        $this->exclude = $categories;
    }

    /**
     * Gets the log message categories to be excluded.
     *
     * @return string[] The list of log message categories to be excluded.
     */
    public function getExcluded(): array
    {
        return $this->exclude;
    }

    /**
     * Checks whether the specified log message category is excluded.
     *
     * @param string $category The log message category.
     * @return bool The value indicating whether the specified category is excluded.
     */
    public function isExcluded(string $category): bool
    {
        foreach ($this->exclude as $exclude) {
            $prefix = rtrim($exclude, '*');

            if (
                (($category && $category === $exclude) || $prefix !== $exclude)

                && (strpos($category, $prefix) === 0)
            ) {
                return true;
            }
        }

        if (empty($this->include)) {
            return false;
        }

        foreach ($this->include as $include) {
            if (
                ($category && $category === $include)
                || (
                    !empty($include)
                    && substr_compare($include, '*', -1, 1) === 0
                    && strpos($category, rtrim($include, '*')) === 0
                )
            ) {
                return false;
            }
        }

        return true;
    }

    /**
     * Checks message categories structure.
     *
     * @param array $categories The log message categories to be checked.
     * @throws InvalidArgumentException for invalid log message categories structure.
     */
    private function checkStructure(array $categories): void
    {
        foreach ($categories as $category) {
            if (!is_string($category)) {
                throw new InvalidArgumentException(sprintf(
                    'The log message category must be a string, %s received.',
                    gettype($category)
                ));
            }
        }
    }
}


1		<?php
2
3		declare(strict_types=1);
4
5		namespace Yiisoft\Log;
6
7		use Psr\Log\InvalidArgumentException;
8
9		use function gettype;
10		use function is_string;
11		use function rtrim;
12		use function substr_compare;
13		use function sprintf;
14		use function strpos;
15
16		/**
17		* Category is a data object that stores and matches the included and excluded categories of log messages.
18		*/
19		final class MessageCategory
20		{
21		public const DEFAULT = 'application';
22
23		/**
24		* @var string[] The list of included log message categories.
25		*
26		* Defaults to empty, which means all categories are included.
27		*
28		* You can use an asterisk at the end of a category so that the category may be used to
29		* match those categories sharing the same common prefix. For example, 'Yiisoft\Db\*' will match
30		* categories starting with 'Yiisoft\Db\', such as `Yiisoft\Db\Connection`.
31		*/
32		private array $include = [];
33
34		/**
35		* @var string[] The list of excluded log message categories.
36		*
37		* Defaults to empty, which means there are no excluded categories.
38		*
39		* You can use an asterisk at the end of a category so that the category can be used to
40		* match those categories sharing the same common prefix. For example, 'Yiisoft\Db\*' will match
41		* categories starting with 'Yiisoft\Db\', such as `Yiisoft\Db\Connection`.
42		*/
43		private array $exclude = [];
44
45		/**
46		* Sets the log message categories to be included.
47		*
48		* @param string[] $categories List of log message categories to be included.
49		* @throws InvalidArgumentException for invalid log message categories structure.
50		*/
51	28	public function include(array $categories): void
52		{
53	28	$this->checkStructure($categories);
54	16	$this->include = $categories;
55	16	}
56
57		/**
58		* Gets the log message categories to be included.
59		*
60		* @return string[] The list of log message categories to be included.
61		*/
62	2	public function getIncluded(): array
63		{
64	2	return $this->include;
65		}
66
67		/**
68		* Sets the log message categories to be excluded.
69		*
70		* @param string[] $categories The list of log message categories to be excluded.
71		* @throws InvalidArgumentException for invalid log message categories structure.
72		*/
73	19	public function exclude(array $categories): void
74		{
75	19	$this->checkStructure($categories);
76	7	$this->exclude = $categories;
77	7	}
78
79		/**
80		* Gets the log message categories to be excluded.
81		*
82		* @return string[] The list of log message categories to be excluded.
83		*/
84	2	public function getExcluded(): array
85		{
86	2	return $this->exclude;
87		}
88
89		/**
90		* Checks whether the specified log message category is excluded.
91		*
92		* @param string $category The log message category.
93		* @return bool The value indicating whether the specified category is excluded.
94		*/
95	31	public function isExcluded(string $category): bool
96		{
97	31	foreach ($this->exclude as $exclude) {
98	5	$prefix = rtrim($exclude, '*');
99
100		if (
101	5	(($category && $category === $exclude) \|\| $prefix !== $exclude)
		0 ignored issues – show introduced 2020-11-24 14:50 UTC by Report Bug Copy Issue Report Consider adding parentheses for clarity. Current Interpretation: `($category && $category ...ategory, $prefix) === 0`, Probably Intended Meaning: `$category && $category =...tegory, $prefix) === 0)` Loading history...
102	5	&& (strpos($category, $prefix) === 0)
103		) {
104	5	return true;
105		}
106		}
107
108	31	if (empty($this->include)) {
109	17	return false;
110		}
111
112	14	foreach ($this->include as $include) {
113		if (
114	14	($category && $category === $include)
115		\|\| (
116	14	!empty($include)
117	14	&& substr_compare($include, '*', -1, 1) === 0
118	14	&& strpos($category, rtrim($include, '*')) === 0
119		)
120		) {
121	13	return false;
122		}
123		}
124
125	14	return true;
126		}
127
128		/**
129		* Checks message categories structure.
130		*
131		* @param array $categories The log message categories to be checked.
132		* @throws InvalidArgumentException for invalid log message categories structure.
133		*/
134	43	private function checkStructure(array $categories): void
135		{
136	43	foreach ($categories as $category) {
137	43	if (!is_string($category)) {
138	24	throw new InvalidArgumentException(sprintf(
139	24	'The log message category must be a string, %s received.',
140	24	gettype($category)
141		));
142		}
143		}
144	19	}
145		}
146

yiisoft / log

Pull Request — master (#49)

MessageCategory::exclude() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like