ConstantUsageSniffTest.php

Go to the documentation of this file.

<?php
namespace Magento\Sniffs\Translation;

use PHP_CodeSniffer\Files\File;

class ConstantUsageSniffTest extends \PHPUnit\Framework\TestCase
{
    private $fileMock;

    private $constantUsageSniff;

    protected function setUp()
    {
        $this->fileMock = $this->createMock(File::class);
        $this->constantUsageSniff = new ConstantUsageSniff();
    }

    public function testProcessIncorrectArguments($file, $numIncorrectUsages)
    {
        $stackPtr = 10;
        $fileContent = file_get_contents(__DIR__ . '/_files/' . $file);
        $tokens = $this->tokenizeString($fileContent);
        $this->fileMock->expects($this->once())
            ->method('findPrevious')
            ->with(
                T_OPEN_TAG,
                $stackPtr - 1
            )
            ->willReturn(false);
        $this->fileMock->expects($this->once())
            ->method('getTokens')
            ->willReturn($tokens);
        $this->fileMock->numTokens = count($tokens);
        $this->fileMock->expects($this->exactly($numIncorrectUsages))
            ->method('addError')
            ->with(
                'Constants are not allowed as the first argument of translation function, use string literal instead',
                $this->anything(),
                'VariableTranslation'
            );
        $this->constantUsageSniff->process($this->fileMock, $stackPtr);
    }

    private function tokenizeString($fileContent)
    {
        $lineNumber = 1;
        $tokens = token_get_all($fileContent);
        $snifferTokens = [];
        for ($i = 0; $i < count($tokens); $i++) {
            $content = is_array($tokens[$i]) ? $tokens[$i][1] : $tokens[$i];
            $snifferTokens[$i]['line'] = $lineNumber;
            $snifferTokens[$i]['content'] = $content;
            $trimmedContent = trim($content, ' ');
            if ($trimmedContent == PHP_EOL || $trimmedContent == PHP_EOL . PHP_EOL) {
                $lineNumber++;
            }
        }
        return $snifferTokens;
    }

    public function processDataProvider()
    {
        return [
            [
                'incorrect_arguments.txt',
                9
            ],
            [
                'correct_arguments.txt',
                0
            ]
        ];
    }
}