PhpCSFixer-Custom-Fixers/src/PedroTroller/CS/Fixer/CodingStyle/ExceptionsPunctuationFixer.php at 026da2b05082e02609bc9ce7288ffd88f274d7e3 · PedroTroller/PhpCSFixer-Custom-Fixers · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
<?php

declare(strict_types=1);

namespace PedroTroller\CS\Fixer\CodingStyle;

use PedroTroller\CS\Fixer\AbstractFixer;
use PhpCsFixer\Tokenizer\Token;
use PhpCsFixer\Tokenizer\Tokens;
use SplFileInfo;

final class ExceptionsPunctuationFixer extends AbstractFixer
{
    public function isCandidate(Tokens $tokens): bool
    {
        return $tokens->isTokenKindFound(T_THROW);
    }

    public function isRisky(): bool
    {
        return true;
    }

    public function getSampleCode(): string
    {
        return <<<'PHP'
            <?php

            use LogicException;

            class MyClass {
                public function fun1()
                {
                    throw new \Exception('This is the message');
                }

                public function fun2($data)
                {
                    throw new LogicException(sprintf('This is the %s', 'message'));
                }
            }
            PHP;
    }

    public function getDocumentation(): string
    {
        return 'Exception messages MUST ends by ".", "…", "?" or "!".<br /><br /><i>Risky: will change the exception message.</i>';
    }

    protected function applyFix(SplFileInfo $file, Tokens $tokens): void
    {
        $cases = $this->analyze($tokens)->findAllSequences([
            [
                [T_THROW],
                [T_NEW],
                [T_STRING],
                '(',
                [T_CONSTANT_ENCAPSED_STRING],
                ',',
            ],
            [
                [T_THROW],
                [T_NEW],
                [T_NS_SEPARATOR],
                [T_STRING],
                '(',
                [T_CONSTANT_ENCAPSED_STRING],
                ',',
            ],
            [
                [T_THROW],
                [T_NEW],
                [T_STRING],
                '(',
                [T_STRING, 'sprintf'],
                '(',
                [T_CONSTANT_ENCAPSED_STRING],
                ',',
            ],
            [
                [T_THROW],
                [T_NEW],
                [T_NS_SEPARATOR],
                [T_STRING],
                '(',
                [T_STRING, 'sprintf'],
                '(',
                [T_CONSTANT_ENCAPSED_STRING],
                ',',
            ],
            [
                [T_THROW],
                [T_NEW],
                [T_STRING],
                '(',
                [T_CONSTANT_ENCAPSED_STRING],
                ')',
            ],
            [
                [T_THROW],
                [T_NEW],
                [T_NS_SEPARATOR],
                [T_STRING],
                '(',
                [T_CONSTANT_ENCAPSED_STRING],
                ')',
            ],
            [
                [T_THROW],
                [T_NEW],
                [T_STRING],
                '(',
                [T_STRING, 'sprintf'],
                '(',
                [T_CONSTANT_ENCAPSED_STRING],
                ')',
            ],
            [
                [T_THROW],
                [T_NEW],
                [T_NS_SEPARATOR],
                [T_STRING],
                '(',
                [T_STRING, 'sprintf'],
                '(',
                [T_CONSTANT_ENCAPSED_STRING],
                ')',
            ],
        ]);

        foreach ($cases as $case) {
            $keys = array_keys($case);
            array_pop($keys);
            array_pop($case);

            $key   = end($keys);
            $token = end($case);

            if (false === $key || false === $token || false === \is_int($key)) {
                continue;
            }

            $tokens[$key] = $this->cleanupMessage($token);
        }
    }

    private function cleanupMessage(Token $token): Token
    {
        $content     = $token->getContent();
        $chars       = str_split($content);
        $quotes      = array_shift($chars);
        $quotes      = array_pop($chars);
        $ponctuation = end($chars);

        switch ($ponctuation) {
            case '.':
            case '…':
            case '?':
            case '!':
                return $token;
        }

        return new Token([T_CONSTANT_ENCAPSED_STRING, sprintf('%s%s.%s', $quotes, implode('', $chars), $quotes)]);
    }
}