diff --git a/dev/tests/static/framework/Magento/Sniffs/Translation/ConstantUsageSniff.php b/dev/tests/static/framework/Magento/Sniffs/Translation/ConstantUsageSniff.php
index 260f731aecf1ce30d60cbd5dee1c2fb0f20074d2..4f9082aa4eb2124072b3c9fe39ddd50a901b7bd1 100644
--- a/dev/tests/static/framework/Magento/Sniffs/Translation/ConstantUsageSniff.php
+++ b/dev/tests/static/framework/Magento/Sniffs/Translation/ConstantUsageSniff.php
@@ -5,12 +5,10 @@
*/
namespace Magento\Sniffs\Translation;
-use PHP_CodeSniffer_File;
-
/**
* Make sure that constants are not used as the first argument of translation function.
*/
-class ConstantUsageSniff extends \Generic_Sniffs_Files_LineLengthSniff
+class ConstantUsageSniff implements \PHP_CodeSniffer_Sniff
{
/**
* Having previous line content allows to process multi-line declaration.
@@ -20,24 +18,73 @@ class ConstantUsageSniff extends \Generic_Sniffs_Files_LineLengthSniff
protected $previousLineContent = '';
/**
- * {@inheritdoc}
+ * {@inheritDoc}
+ */
+ public function register()
+ {
+ return [T_OPEN_TAG];
+
+ }
+
+ /**
+ * Copied from \Generic_Sniffs_Files_LineLengthSniff, minor changes made
+ *
+ * {@inheritDoc}
*/
- protected function checkLineLength(\PHP_CodeSniffer_File $phpcsFile, $stackPtr, $lineContent)
+ public function process(\PHP_CodeSniffer_File $phpcsFile, $stackPtr)
{
- $previousLineRegexp = '~__\($|Phrase\($~';
- $currentLineRegexp = '~__\(.+\)|Phrase\(.+\)~';
+ $tokens = $phpcsFile->getTokens();
+
+ // Make sure this is the first open tag
+ $previousOpenTag = $phpcsFile->findPrevious(T_OPEN_TAG, ($stackPtr - 1));
+ if ($previousOpenTag !== false) {
+ return;
+ }
+
+ $tokenCount = 0;
+ $currentLineContent = '';
+ $currentLine = 1;
+
+ for (; $tokenCount < $phpcsFile->numTokens; $tokenCount++) {
+ if ($tokens[$tokenCount]['line'] === $currentLine) {
+ $currentLineContent .= $tokens[$tokenCount]['content'];
+ } else {
+ $this->checkIfFirstArgumentConstant($phpcsFile, ($tokenCount - 1), $currentLineContent);
+ $currentLineContent = $tokens[$tokenCount]['content'];
+ $currentLine++;
+ }
+ }
+
+ $this->checkIfFirstArgumentConstant($phpcsFile, ($tokenCount - 1), $currentLineContent);
+ }
+
+ /**
+ * Checks if first argument of \Magento\Framework\Phrase or translation function is a constant
+ *
+ * @param \PHP_CodeSniffer_File $phpcsFile
+ * @param int $stackPtr
+ * @param string $lineContent
+ * @return void
+ */
+ private function checkIfFirstArgumentConstant(
+ \PHP_CodeSniffer_File $phpcsFile,
+ $stackPtr,
+ $lineContent
+ ) {
+ $previousLineRegexp = '/(__|Phrase)\($/im';
+ $currentLineRegexp = '/(__|Phrase)\(.+\)/';
$currentLineMatch = preg_match($currentLineRegexp, $lineContent) !== 0;
$previousLineMatch = preg_match($previousLineRegexp, $this->previousLineContent) !== 0;
$this->previousLineContent = $lineContent;
$error = 'Constants are not allowed as the first argument of translation function, use string literal instead';
- $constantRegexp = '[^\'"]+::[A-Z_0-9]+.*';
+ $constantRegexp = '[^\$\'"]+::[A-Z_0-9]+.*';
if ($currentLineMatch) {
- $variableRegexp = "~__\({$constantRegexp}\)|Phrase\({$constantRegexp}\)~";
+ $variableRegexp = "/(__|Phrase)\({$constantRegexp}\)/";
if (preg_match($variableRegexp, $lineContent) !== 0) {
$phpcsFile->addError($error, $stackPtr, 'VariableTranslation');
}
} else if ($previousLineMatch) {
- $variableRegexp = "~^\s+{$constantRegexp}~";
+ $variableRegexp = "/^{$constantRegexp}/";
if (preg_match($variableRegexp, $lineContent) !== 0) {
$phpcsFile->addError($error, $stackPtr, 'VariableTranslation');
}
diff --git a/dev/tests/static/framework/tests/unit/testsuite/Magento/Sniffs/Translation/ConstantUsageSniffTest.php b/dev/tests/static/framework/tests/unit/testsuite/Magento/Sniffs/Translation/ConstantUsageSniffTest.php
new file mode 100644
index 0000000000000000000000000000000000000000..a64d47054ede9bc1f695514aa8f3ef95fc1e8eeb
--- /dev/null
+++ b/dev/tests/static/framework/tests/unit/testsuite/Magento/Sniffs/Translation/ConstantUsageSniffTest.php
@@ -0,0 +1,96 @@
+<?php
+/**
+ * Copyright © 2016 Magento. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+namespace Magento\Sniffs\Translation;
+
+class ConstantUsageSniffTest extends \PHPUnit_Framework_TestCase
+{
+ /**
+ * @var \PHP_CodeSniffer_File|\PHPUnit_Framework_MockObject_MockObject
+ */
+ private $fileMock;
+
+ /**
+ * @var ConstantUsageSniff
+ */
+ private $constantUsageSniff;
+
+ protected function setUp()
+ {
+ $this->fileMock = $this->getMock(\PHP_CodeSniffer_File::class, [], [], '', false);
+ $this->constantUsageSniff = new ConstantUsageSniff();
+ }
+
+ /**
+ * @param string $file
+ * @param int $numIncorrectUsages
+ * @dataProvider processDataProvider
+ */
+ 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);
+ }
+
+ /**
+ * Get tokens for a string
+ *
+ * @param string $fileContent
+ * @return array
+ */
+ 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;
+ }
+
+ /**
+ * @return array
+ */
+ public function processDataProvider()
+ {
+ return [
+ [
+ 'incorrect_arguments.txt',
+ 9
+ ],
+ [
+ 'correct_arguments.txt',
+ 0
+ ]
+ ];
+ }
+}
diff --git a/dev/tests/static/framework/tests/unit/testsuite/Magento/Sniffs/Translation/_files/correct_arguments.txt b/dev/tests/static/framework/tests/unit/testsuite/Magento/Sniffs/Translation/_files/correct_arguments.txt
new file mode 100644
index 0000000000000000000000000000000000000000..2ea7c6ed532c4334b031e93fd2b2eacdde222591
--- /dev/null
+++ b/dev/tests/static/framework/tests/unit/testsuite/Magento/Sniffs/Translation/_files/correct_arguments.txt
@@ -0,0 +1,29 @@
+<?php
+/**
+ * Copyright © 2016 Magento. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+
+$item[ConfigConverter::KEY_TITLE] = __($item)
+
+$item[ConfigConverter::KEY_TITLE] = __($item[Converter::KEY_TITLE])
+
+$item[ConfigConverter::KEY_TITLE] = __($item['\Magento\Support\Model\Report\Config\Converter::KEY_TITLE'])
+
+$item[ConfigConverter::KEY_TITLE] = __($item['value'])
+
+$item[ConfigConverter::KEY_TITLE] = __(
+ $item
+)
+
+Phrase($item)
+
+Phrase($item[Converter::KEY_TITLE])
+
+Phrase($item['\Magento\Support\Model\Report\Config\Converter::KEY_TITLE'])
+
+\Magento\Framework\Phrase($item['value'])
+
+\Magento\Framework\Phrase(
+ $item[Converter::KEY_TITLE]
+)
diff --git a/dev/tests/static/framework/tests/unit/testsuite/Magento/Sniffs/Translation/_files/incorrect_arguments.txt b/dev/tests/static/framework/tests/unit/testsuite/Magento/Sniffs/Translation/_files/incorrect_arguments.txt
new file mode 100644
index 0000000000000000000000000000000000000000..d2e60b65c06ccda6751f52b8bc5db17c6c1585c3
--- /dev/null
+++ b/dev/tests/static/framework/tests/unit/testsuite/Magento/Sniffs/Translation/_files/incorrect_arguments.txt
@@ -0,0 +1,27 @@
+<?php
+/**
+ * Copyright © 2016 Magento. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+
+$item[ConfigConverter::KEY_TITLE] = __(Converter::KEY_TITLE)
+
+$item[ConfigConverter::KEY_TITLE] = __(self::KEY_TITLE)
+
+$item[ConfigConverter::KEY_TITLE] = __(\Magento\Support\Model\Report\Config\Converter::KEY_TITLE)
+
+$item[ConfigConverter::KEY_TITLE] = __(
+ Converter::KEY_TITLE
+)
+
+Phrase(Converter::KEY_TITLE)
+
+Phrase(self::KEY_TITLE)
+
+Phrase(\Magento\Support\Model\Report\Config\Converter::KEY_TITLE)
+
+\Magento\Framework\Phrase(Converter::KEY_TITLE)
+
+\Magento\Framework\Phrase(
+ Converter::KEY_TITLE
+)