8797238826

Committed 23 Apr 2024 08:25AM UTC coverage: 81.651%. Remained the same

Build # 8797238826

Build Type

push

github

Committed by

OndraM

Commit Message

Docs: Update readme to respect new ECS config behavior

Run Details

178 of 218 relevant lines covered (81.65%)

16.77 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

100.0

/src/Sniffs/Naming/AbstractClassNameSniff.php

<?php declare(strict_types=1);

/*
 * Originally part of https://github.com/symplify/symplify
 *
 * MIT License
 *
 * (c) 2020 Tomas Votruba <tomas.vot@gmail.com>
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in all
 * copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 */

namespace Lmc\CodingStandard\Sniffs\Naming;

use Nette\Utils\Strings;
use PHP_CodeSniffer\Files\File;
use PHP_CodeSniffer\Sniffs\Sniff;

final class AbstractClassNameSniff implements Sniff
{
    /**
     * @var string
     */
    private const ERROR_MESSAGE = 'Abstract class should have prefix "Abstract".';

    private int $position;
    private File $file;

    /**
     * @return int[]
     */
    public function register(): array
    {
        return [T_CLASS];
    }

    public function process(File $phpcsFile, $stackPtr): void
    {
        $this->file = $phpcsFile;
        $this->position = $stackPtr;

        if ($this->shouldBeSkipped()) {
            return;
        }

        $phpcsFile->addError(self::ERROR_MESSAGE, $stackPtr, self::class);
    }

    private function shouldBeSkipped(): bool
    {
        $className = $this->getClassName();

        if (!$this->isClassAbstract() || $className === null) {
            return true;
        }

        return Strings::startsWith($className, 'Abstract');
    }

    private function isClassAbstract(): bool
    {
        $classProperties = $this->file->getClassProperties($this->position);

        return $classProperties['is_abstract'];
    }

    private function getClassName(): ?string
    {
        return $this->file->getDeclarationName($this->position);
    }
}

1	<?php declare(strict_types=1);
2
3	/*
4	* Originally part of https://github.com/symplify/symplify
5	*
6	* MIT License
7	*
8	* (c) 2020 Tomas Votruba <tomas.vot@gmail.com>
9	*
10	* Permission is hereby granted, free of charge, to any person obtaining a copy
11	* of this software and associated documentation files (the "Software"), to deal
12	* in the Software without restriction, including without limitation the rights
13	* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
14	* copies of the Software, and to permit persons to whom the Software is
15	* furnished to do so, subject to the following conditions:
16	*
17	* The above copyright notice and this permission notice shall be included in all
18	* copies or substantial portions of the Software.
19	*
20	* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
21	* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
22	* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
23	* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
24	* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
25	* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
26	* SOFTWARE.
27	*/
28
29	namespace Lmc\CodingStandard\Sniffs\Naming;
30
31	use Nette\Utils\Strings;
32	use PHP_CodeSniffer\Files\File;
33	use PHP_CodeSniffer\Sniffs\Sniff;
34
35	final class AbstractClassNameSniff implements Sniff
36	{
37	/**
38	* @var string
39	*/
40	private const ERROR_MESSAGE = 'Abstract class should have prefix "Abstract".';
41
42	private int $position;
43	private File $file;
44
45	/**
46	* @return int[]
47	*/
48	public function register(): array	10✔
49	{
50	return [T_CLASS];	10✔
51	}
52
53	public function process(File $phpcsFile, $stackPtr): void	10✔
54	{
55	$this->file = $phpcsFile;	10✔
56	$this->position = $stackPtr;	10✔
57
58	if ($this->shouldBeSkipped()) {	10✔
59	return;	10✔
60	}
61
62	$phpcsFile->addError(self::ERROR_MESSAGE, $stackPtr, self::class);	5✔
63	}
64
65	private function shouldBeSkipped(): bool	10✔
66	{
67	$className = $this->getClassName();	10✔
68
69	if (!$this->isClassAbstract() \|\| $className === null) {	10✔
70	return true;	5✔
71	}
72
73	return Strings::startsWith($className, 'Abstract');	10✔
74	}
75
76	private function isClassAbstract(): bool	10✔
77	{
78	$classProperties = $this->file->getClassProperties($this->position);	10✔
79
80	return $classProperties['is_abstract'];	10✔
81	}
82
83	private function getClassName(): ?string	10✔
84	{
85	return $this->file->getDeclarationName($this->position);	10✔
86	}
87	}

lmc-eu / php-coding-standard / 8797238826

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous