File size: 2,536 Bytes
d2897cd
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
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
<?php

namespace Mautic\CodingStandards\PhpCSFixer;

use PhpCsFixer\AbstractFixer;
use PhpCsFixer\FixerDefinition\CodeSample;
use PhpCsFixer\FixerDefinition\FixerDefinition;
use PhpCsFixer\FixerDefinition\FixerDefinitionInterface;
use PhpCsFixer\StdinFileInfo;
use PhpCsFixer\Tokenizer\Tokens;

class NoTablePrefixDefinitionInTestsFixer extends AbstractFixer
{
    public function getName(): string
    {
        return sprintf('Mautic/%s', parent::getName());
    }

    protected function applyFix(\SplFileInfo $file, Tokens $tokens): void
    {
        $matches = $tokens->findSequence([[T_STRING, 'define'], '(', [T_CONSTANT_ENCAPSED_STRING, "'MAUTIC_TABLE_PREFIX'"]]);

        if ($matches) {
            $begin_defined = $tokens->getPrevTokenOfKind(array_key_first($matches), [[T_STRING, 'defined']]);
            $begin_if      = $tokens->getPrevTokenOfKind($begin_defined, [[T_IF, 'if']]);
            if ($begin_defined) {
                if ((int) $begin_if >= $begin_defined - 4) {
                    $begin     = $begin_if;
                    $end_token = ['}'];
                } else {
                    $begin     = $begin_defined;
                    $end_token = [';'];
                }

                $end = $tokens->getNextTokenOfKind(array_key_last($matches), $end_token);

                foreach (range($begin, $end) as $id) {
                    $tokens->clearAt($id);
                }
                $tokens->removeLeadingWhitespace($end);
            }
        }
    }

    public function isCandidate(Tokens $tokens): bool
    {
        return $tokens->isTokenKindFound(T_CONSTANT_ENCAPSED_STRING);
    }

    public function getDefinition(): FixerDefinitionInterface
    {
        return new FixerDefinition(
          'Test should not define the `MAUTIC_TABLE_PREFIX` const.',
          [new CodeSample("<?php

class ExampleTest {
    public function setUp(): void
    {
        defined('MAUTIC_TABLE_PREFIX') or define('MAUTIC_TABLE_PREFIX', '');
    }
}
"),
            new CodeSample("<?php

class ExampleTest {
    public function setUp(): void
    {
        if (!defined('MAUTIC_TABLE_PREFIX')) {
            define('MAUTIC_TABLE_PREFIX', '');
        }
    }
}
"), ]
        );
    }

    public function supports(\SplFileInfo $file): bool
    {
        return $file instanceof StdinFileInfo || preg_match('/\/Tests\/.*Test\.php$/', $file->getPathname());
    }

    /**
     * run before the whitespace cleanup.
     */
    public function getPriority(): int
    {
        return 1;
    }
}