Skip to content

AC-666: Create phpcs static check for CopyrightTest for php files #267

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
Sep 13, 2021
Merged

AC-666: Create phpcs static check for CopyrightTest for php files #267

Show file tree
Hide file tree
Changes from 4 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
8b2cd90
AC-666: Create phpcs static check for CopyrightTest
eliseacornejo Sep 9, 2021
e2c2d07
AC-666: Create phpcs static check for CopyrightTest
eliseacornejo Sep 9, 2021
f4b0117
AC-666: Create phpcs static check for CopyrightTest
eliseacornejo Sep 9, 2021
7a6f29f
AC-666: Create phpcs static check for CopyrightTest
eliseacornejo Sep 9, 2021
a2864d2
AC-666: Create phpcs static check for CopyrightTest
eliseacornejo Sep 13, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion Magento2/Helpers/Commenting/PHPDocFormattingValidator.php
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
<?php

/**
* Copyright © Magento. All rights reserved.
* Copyright © Magento, Inc. All rights reserved.
* See COPYING.txt for license details.
*/
namespace Magento2\Helpers\Commenting;
Expand Down
2 changes: 1 addition & 1 deletion Magento2/Sniffs/Classes/AbstractApiSniff.php
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<?php
/**
* Copyright © Magento. All rights reserved.
* Copyright © Magento, Inc. All rights reserved.
* See COPYING.txt for license details.
*/
namespace Magento2\Sniffs\Classes;
Expand Down
2 changes: 1 addition & 1 deletion Magento2/Sniffs/Classes/DiscouragedDependenciesSniff.php
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<?php
/**
* Copyright © Magento. All rights reserved.
* Copyright © Magento, Inc. All rights reserved.
* See COPYING.txt for license details.
*/
namespace Magento2\Sniffs\Classes;
Expand Down
2 changes: 1 addition & 1 deletion Magento2/Sniffs/CodeAnalysis/EmptyBlockSniff.php
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<?php
/**
* Copyright © Magento. All rights reserved.
* Copyright © Magento, Inc. All rights reserved.
* See COPYING.txt for license details.
*/
namespace Magento2\Sniffs\CodeAnalysis;
Expand Down
2 changes: 1 addition & 1 deletion Magento2/Sniffs/Commenting/ClassAndInterfacePHPDocFormattingSniff.php
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
<?php

/**
* Copyright © Magento. All rights reserved.
* Copyright © Magento, Inc. All rights reserved.
* See COPYING.txt for license details.
*/
namespace Magento2\Sniffs\Commenting;
Expand Down
4 changes: 4 additions & 0 deletions Magento2/Sniffs/Commenting/ClassPropertyPHPDocFormattingSniff.php
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,8 @@
<?php
/**
* Copyright © Magento, Inc. All rights reserved.
* See COPYING.txt for license details.
*/
namespace Magento2\Sniffs\Commenting;

use PHP_CodeSniffer\Files\File;
Expand Down
2 changes: 1 addition & 1 deletion Magento2/Sniffs/Commenting/ConstantsPHPDocFormattingSniff.php
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<?php
/**
* Copyright © Magento. All rights reserved.
* Copyright © Magento, Inc. All rights reserved.
* See COPYING.txt for license details.
*/
namespace Magento2\Sniffs\Commenting;
Expand Down
2 changes: 1 addition & 1 deletion Magento2/Sniffs/Exceptions/DirectThrowSniff.php
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<?php
/**
* Copyright © Magento. All rights reserved.
* Copyright © Magento, Inc. All rights reserved.
* See COPYING.txt for license details.
*/
namespace Magento2\Sniffs\Exceptions;
Expand Down
2 changes: 1 addition & 1 deletion Magento2/Sniffs/Exceptions/ThrowCatchSniff.php
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<?php
/**
* Copyright © Magento. All rights reserved.
* Copyright © Magento, Inc. All rights reserved.
* See COPYING.txt for license details.
*/

Expand Down
2 changes: 1 addition & 1 deletion Magento2/Sniffs/Exceptions/TryProcessSystemResourcesSniff.php
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<?php
/**
* Copyright © Magento. All rights reserved.
* Copyright © Magento, Inc. All rights reserved.
* See COPYING.txt for license details.
*/
namespace Magento2\Sniffs\Exceptions;
Expand Down
2 changes: 1 addition & 1 deletion Magento2/Sniffs/Functions/DiscouragedFunctionSniff.php
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<?php
/**
* Copyright © Magento. All rights reserved.
* Copyright © Magento, Inc. All rights reserved.
* See COPYING.txt for license details.
*/
namespace Magento2\Sniffs\Functions;
Expand Down
2 changes: 1 addition & 1 deletion Magento2/Sniffs/Functions/StaticFunctionSniff.php
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<?php
/**
* Copyright © Magento. All rights reserved.
* Copyright © Magento, Inc. All rights reserved.
* See COPYING.txt for license details.
*/
namespace Magento2\Sniffs\Functions;
Expand Down
2 changes: 1 addition & 1 deletion Magento2/Sniffs/GraphQL/AbstractGraphQLSniff.php
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<?php
/**
* Copyright © Magento. All rights reserved.
* Copyright © Magento, Inc. All rights reserved.
* See COPYING.txt for license details.
*/
namespace Magento2\Sniffs\GraphQL;
Expand Down
2 changes: 1 addition & 1 deletion Magento2/Sniffs/GraphQL/ValidArgumentNameSniff.php
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<?php
/**
* Copyright © Magento. All rights reserved.
* Copyright © Magento, Inc. All rights reserved.
* See COPYING.txt for license details.
*/

Expand Down
2 changes: 1 addition & 1 deletion Magento2/Sniffs/GraphQL/ValidEnumValueSniff.php
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<?php
/**
* Copyright © Magento. All rights reserved.
* Copyright © Magento, Inc. All rights reserved.
* See COPYING.txt for license details.
*/

Expand Down
2 changes: 1 addition & 1 deletion Magento2/Sniffs/GraphQL/ValidFieldNameSniff.php
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<?php
/**
* Copyright © Magento. All rights reserved.
* Copyright © Magento, Inc. All rights reserved.
* See COPYING.txt for license details.
*/
namespace Magento2\Sniffs\GraphQL;
Expand Down
2 changes: 1 addition & 1 deletion Magento2/Sniffs/GraphQL/ValidTopLevelFieldNameSniff.php
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<?php
/**
* Copyright © Magento. All rights reserved.
* Copyright © Magento, Inc. All rights reserved.
* See COPYING.txt for license details.
*/
namespace Magento2\Sniffs\GraphQL;
Expand Down
2 changes: 1 addition & 1 deletion Magento2/Sniffs/GraphQL/ValidTypeNameSniff.php
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<?php
/**
* Copyright © Magento. All rights reserved.
* Copyright © Magento, Inc. All rights reserved.
* See COPYING.txt for license details.
*/
namespace Magento2\Sniffs\GraphQL;
Expand Down
2 changes: 1 addition & 1 deletion Magento2/Sniffs/Legacy/AbstractBlockSniff.php
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<?php
/**
* Copyright © Magento. All rights reserved.
* Copyright © Magento, Inc. All rights reserved.
* See COPYING.txt for license details.
*/
declare(strict_types = 1);
Expand Down
51 changes: 51 additions & 0 deletions Magento2/Sniffs/Legacy/CopyrightSniff.php
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@
<?php
/**
* Copyright © Magento, Inc. All rights reserved.
* See COPYING.txt for license details.
*/
declare(strict_types = 1);

namespace Magento2\Sniffs\Legacy;

use PHP_CodeSniffer\Files\File;
use PHP_CodeSniffer\Sniffs\Sniff;

class CopyrightSniff implements Sniff
{
private const WARNING_CODE = 'FoundCopyrightMissingOrWrongFormat';

private const COPYRIGHT_MAGENTO_TEXT = 'Copyright © Magento, Inc. All rights reserved.';
private const COPYRIGHT_ADOBE = '/Copyright \d+ Adobe/';

/**
* @inheritdoc
*/
public function register()
{
return [T_OPEN_TAG];
}

/**
* @inheritDoc
*/
public function process(File $phpcsFile, $stackPtr)
{
$positionOpenTag = $phpcsFile->findPrevious(T_OPEN_TAG, $stackPtr - 1);

if ($positionOpenTag === false) {
$positionComment = $phpcsFile->findNext(T_DOC_COMMENT_STRING, $stackPtr);
$contentFile = $phpcsFile->getTokens()[$positionComment]['content'];
$adobeCopyrightFound = preg_match(self::COPYRIGHT_ADOBE, $contentFile);

if (strpos($contentFile, self::COPYRIGHT_MAGENTO_TEXT) !== false || $adobeCopyrightFound) {
return;
} else {
$phpcsFile->addWarningOnLine(
'Copyright is missing or has wrong format',
$phpcsFile->getTokens()[$positionComment]['line'],
self::WARNING_CODE
);
}
}
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would be nice to flatten the code structure for better readability. Also handling the situation when $positionComment is false (no comments found) instantly (not trying to parse it)

Suggested change
$positionOpenTag = $phpcsFile->findPrevious(T_OPEN_TAG, $stackPtr - 1);
if ($positionOpenTag === false) {
$positionComment = $phpcsFile->findNext(T_DOC_COMMENT_STRING, $stackPtr);
$contentFile = $phpcsFile->getTokens()[$positionComment]['content'];
$adobeCopyrightFound = preg_match(self::COPYRIGHT_ADOBE, $contentFile);
if (strpos($contentFile, self::COPYRIGHT_MAGENTO_TEXT) !== false || $adobeCopyrightFound) {
return;
} else {
$phpcsFile->addWarningOnLine(
'Copyright is missing or has wrong format',
$phpcsFile->getTokens()[$positionComment]['line'],
self::WARNING_CODE
);
}
}
if ($phpcsFile->findPrevious(T_OPEN_TAG, $stackPtr - 1) !== false) {
return;
}
$positionComment = $phpcsFile->findNext(T_DOC_COMMENT_STRING, $stackPtr);
if ($positionComment === false) {
$phpcsFile->addWarning(
'Copyright is missing',
$stackPtr,
self::WARNING_CODE
);
return;
}
$content = $phpcsFile->getTokens()[$positionComment]['content'];
$adobeCopyrightFound = preg_match(self::COPYRIGHT_ADOBE, $content);
if (strpos($content, self::COPYRIGHT_MAGENTO_TEXT) !== false || $adobeCopyrightFound) {
return;
}
$phpcsFile->addWarningOnLine(
'Copyright is missing or has wrong format',
$phpcsFile->getTokens()[$positionComment]['line'],
self::WARNING_CODE
);

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for your collaboration. Done!

}
}
2 changes: 1 addition & 1 deletion Magento2/Sniffs/Legacy/MageEntitySniff.php
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<?php
/**
* Copyright © Magento. All rights reserved.
* Copyright © Magento, Inc. All rights reserved.
* See COPYING.txt for license details.
*/
namespace Magento2\Sniffs\Legacy;
Expand Down
2 changes: 1 addition & 1 deletion Magento2/Sniffs/Methods/DeprecatedModelMethodSniff.php
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<?php
/**
* Copyright © Magento. All rights reserved.
* Copyright © Magento, Inc. All rights reserved.
* See COPYING.txt for license details.
*/
namespace Magento2\Sniffs\Methods;
Expand Down
2 changes: 1 addition & 1 deletion Magento2/Sniffs/Namespaces/ImportsFromTestNamespaceSniff.php
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<?php
/**
* Copyright © Magento. All rights reserved.
* Copyright © Magento, Inc. All rights reserved.
* See COPYING.txt for license details.
*/
namespace Magento2\Sniffs\Namespaces;
Expand Down
2 changes: 1 addition & 1 deletion Magento2/Sniffs/NamingConvention/InterfaceNameSniff.php
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<?php
/**
* Copyright © Magento. All rights reserved.
* Copyright © Magento, Inc. All rights reserved.
* See COPYING.txt for license details.
*/
namespace Magento2\Sniffs\NamingConvention;
Expand Down
2 changes: 1 addition & 1 deletion Magento2/Sniffs/PHP/FinalImplementationSniff.php
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<?php
/**
* Copyright © Magento. All rights reserved.
* Copyright © Magento, Inc. All rights reserved.
* See COPYING.txt for license details.
*/
namespace Magento2\Sniffs\PHP;
Expand Down
2 changes: 1 addition & 1 deletion Magento2/Sniffs/PHP/GotoSniff.php
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<?php
/**
* Copyright © Magento. All rights reserved.
* Copyright © Magento, Inc. All rights reserved.
* See COPYING.txt for license details.
*/
namespace Magento2\Sniffs\PHP;
Expand Down
2 changes: 1 addition & 1 deletion Magento2/Sniffs/PHP/ReturnValueCheckSniff.php
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<?php
/**
* Copyright © Magento. All rights reserved.
* Copyright © Magento, Inc. All rights reserved.
* See COPYING.txt for license details.
*/
namespace Magento2\Sniffs\PHP;
Expand Down
2 changes: 1 addition & 1 deletion Magento2/Sniffs/PHP/VarSniff.php
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<?php
/**
* Copyright © Magento. All rights reserved.
* Copyright © Magento, Inc. All rights reserved.
* See COPYING.txt for license details.
*/
namespace Magento2\Sniffs\PHP;
Expand Down
2 changes: 1 addition & 1 deletion Magento2/Sniffs/Performance/ForeachArrayMergeSniff.php
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<?php
/**
* Copyright © Magento. All rights reserved.
* Copyright © Magento, Inc. All rights reserved.
* See COPYING.txt for license details.
*/
namespace Magento2\Sniffs\Performance;
Expand Down
2 changes: 1 addition & 1 deletion Magento2/Sniffs/SQL/RawQuerySniff.php
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<?php
/**
* Copyright © Magento. All rights reserved.
* Copyright © Magento, Inc. All rights reserved.
* See COPYING.txt for license details.
*/
namespace Magento2\Sniffs\SQL;
Expand Down
2 changes: 1 addition & 1 deletion Magento2/Sniffs/Security/IncludeFileSniff.php
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<?php
/**
* Copyright © Magento. All rights reserved.
* Copyright © Magento, Inc. All rights reserved.
* See COPYING.txt for license details.
*/
namespace Magento2\Sniffs\Security;
Expand Down
2 changes: 1 addition & 1 deletion Magento2/Sniffs/Security/InsecureFunctionSniff.php
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<?php
/**
* Copyright © Magento. All rights reserved.
* Copyright © Magento, Inc. All rights reserved.
* See COPYING.txt for license details.
*/
namespace Magento2\Sniffs\Security;
Expand Down
2 changes: 1 addition & 1 deletion Magento2/Sniffs/Security/LanguageConstructSniff.php
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<?php
/**
* Copyright © Magento. All rights reserved.
* Copyright © Magento, Inc. All rights reserved.
* See COPYING.txt for license details.
*/
namespace Magento2\Sniffs\Security;
Expand Down
2 changes: 1 addition & 1 deletion Magento2/Sniffs/Security/SuperglobalSniff.php
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<?php
/**
* Copyright © Magento. All rights reserved.
* Copyright © Magento, Inc. All rights reserved.
* See COPYING.txt for license details.
*/
namespace Magento2\Sniffs\Security;
Expand Down
2 changes: 1 addition & 1 deletion Magento2/Sniffs/Security/XssTemplateSniff.php
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<?php
/**
* Copyright © Magento. All rights reserved.
* Copyright © Magento, Inc. All rights reserved.
* See COPYING.txt for license details.
*/
namespace Magento2\Sniffs\Security;
Expand Down
2 changes: 1 addition & 1 deletion Magento2/Sniffs/Strings/ExecutableRegExSniff.php
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<?php
/**
* Copyright © Magento. All rights reserved.
* Copyright © Magento, Inc. All rights reserved.
* See COPYING.txt for license details.
*/
namespace Magento2\Sniffs\Strings;
Expand Down
2 changes: 1 addition & 1 deletion Magento2/Sniffs/Strings/StringConcatSniff.php
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<?php
/**
* Copyright © Magento. All rights reserved.
* Copyright © Magento, Inc. All rights reserved.
* See COPYING.txt for license details.
*/
namespace Magento2\Sniffs\Strings;
Expand Down
2 changes: 1 addition & 1 deletion Magento2/Sniffs/Templates/ThisInTemplateSniff.php
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<?php
/**
* Copyright © Magento. All rights reserved.
* Copyright © Magento, Inc. All rights reserved.
* See COPYING.txt for license details.
*/
namespace Magento2\Sniffs\Templates;
Expand Down
2 changes: 1 addition & 1 deletion Magento2/Sniffs/Whitespace/MultipleEmptyLinesSniff.php
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<?php
/**
* Copyright © Magento. All rights reserved.
* Copyright © Magento, Inc. All rights reserved.
* See COPYING.txt for license details.
*/
namespace Magento2\Sniffs\Whitespace;
Expand Down
2 changes: 1 addition & 1 deletion Magento2/Tests/Classes/AbstractApiUnitTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<?php
/**
* Copyright © Magento. All rights reserved.
* Copyright © Magento, Inc. All rights reserved.
* See COPYING.txt for license details.
*/
namespace Magento2\Tests\Classes;
Expand Down
2 changes: 1 addition & 1 deletion Magento2/Tests/Classes/DiscouragedDependenciesUnitTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<?php
/**
* Copyright © Magento. All rights reserved.
* Copyright © Magento, Inc. All rights reserved.
* See COPYING.txt for license details.
*/
namespace Magento2\Tests\Classes;
Expand Down
2 changes: 1 addition & 1 deletion Magento2/Tests/CodeAnalysis/EmptyBlockUnitTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<?php
/**
* Copyright © Magento. All rights reserved.
* Copyright © Magento, Inc. All rights reserved.
* See COPYING.txt for license details.
*/
namespace Magento2\Tests\CodeAnalysis;
Expand Down
2 changes: 1 addition & 1 deletion Magento2/Tests/Commenting/ClassAndInterfacePHPDocFormattingUnitTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
<?php

/**
* Copyright © Magento. All rights reserved.
* Copyright © Magento, Inc. All rights reserved.
* See COPYING.txt for license details.
*/
namespace Magento2\Tests\Commenting;
Expand Down
2 changes: 1 addition & 1 deletion Magento2/Tests/Commenting/ClassPropertyPHPDocFormattingUnitTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<?php
/**
* Copyright © Magento. All rights reserved.
* Copyright © Magento, Inc. All rights reserved.
* See COPYING.txt for license details.
*/
namespace Magento2\Tests\Commenting;
Expand Down
Loading