AC-663 PHPCS classes test #274
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,215 @@ | ||
| <?php | ||
| /** | ||
| * Copyright © Magento, Inc. All rights reserved. | ||
| * See COPYING.txt for license details. | ||
| */ | ||
|
|
||
| namespace Magento2\Sniffs\Legacy; | ||
|
|
||
| use DOMDocument; | ||
| use PHP_CodeSniffer\Sniffs\Sniff; | ||
| use PHP_CodeSniffer\Files\File; | ||
| use SimpleXMLElement; | ||
|
|
||
| class ClassesConfigurationSniff implements Sniff | ||
| { | ||
| private const ERROR_MESSAGE_CONFIG = 'Attribute does not follow expected format'; | ||
| private const ERROR_CODE_CONFIG = 'WrongXML'; | ||
| private const ERROR_MESSAGE_MODULE = 'Attribute does not follow expected format in module'; | ||
| private const ERROR_CODE_MODULE = 'WrongXMLModule'; | ||
|
|
||
| /** | ||
| * @inheritdoc | ||
| */ | ||
| public function register() | ||
| { | ||
| return [ | ||
| T_INLINE_HTML, | ||
| ]; | ||
| } | ||
|
|
||
| /** | ||
| * @inheritdoc | ||
| */ | ||
| public function process(File $phpcsFile, $stackPtr) | ||
| { | ||
| if ($stackPtr > 0) { | ||
| return; | ||
| } | ||
|
|
||
| // We need to format the incoming XML to avoid tags split into several lines. In that case, PHP's DOMElement | ||
| // returns the position of the closing /> as the position of the tag, and we need the position of < | ||
| // instead, as it is the one we compare with $stackPtr later on. | ||
| $xml = simplexml_load_string($this->getFormattedXML($phpcsFile)); | ||
| if ($xml === false) { | ||
| $phpcsFile->addError( | ||
| sprintf( | ||
| "Couldn't parse contents of '%s', check that they are in valid XML format", | ||
| $phpcsFile->getFilename(), | ||
| ), | ||
| $stackPtr, | ||
| self::ERROR_CODE_CONFIG | ||
| ); | ||
| } | ||
|
|
||
| $classes = $this->collectClassesInConfig($xml); | ||
| $this->assertNonFactoryName($phpcsFile, $classes); | ||
|
|
||
| $modules = $this->getXmlAttributeValues($xml, '//@module', 'module'); | ||
| $this->assertNonFactoryNameModule($phpcsFile, $modules); | ||
| } | ||
|
|
||
| /** | ||
| * Check whether specified classes or module names correspond to a file according PSR-1 Standard. | ||
| * | ||
| * @param File $phpcsFile | ||
| * @param ExtendedNode[] $elements | ||
| */ | ||
| private function assertNonFactoryName(File $phpcsFile, array $elements) | ||
| { | ||
| foreach ($elements as $element) { | ||
| if (stripos($element->value, 'Magento') === false) { | ||
| continue; | ||
| } | ||
| if (preg_match('/^([A-Z][a-z\d\\\\]+)+$/', $element->value) !== 1) { | ||
| $phpcsFile->addError( | ||
| self::ERROR_MESSAGE_CONFIG, | ||
| $element->element->getLineNo() - 1, | ||
| self::ERROR_CODE_CONFIG, | ||
| ); | ||
| } | ||
| } | ||
| } | ||
|
|
||
| /** | ||
| * Check whether specified classes or module names correspond to a file according PSR-1 Standard. | ||
| * | ||
| * @param File $phpcsFile | ||
| * @param ExtendedNode[] $classes | ||
| */ | ||
| private function assertNonFactoryNameModule(File $phpcsFile, array $classes) | ||
| { | ||
| foreach ($classes as $element) { | ||
| if (preg_match('/^([A-Z][A-Za-z\d_]+)+$/', $element->value) !== 1) { | ||
| $phpcsFile->addError( | ||
| self::ERROR_MESSAGE_MODULE, | ||
| $element->element->getLineNo() - 1, | ||
| self::ERROR_CODE_MODULE, | ||
| ); | ||
| } | ||
| } | ||
| } | ||
|
|
||
| /** | ||
| * Format the incoming XML to avoid tags split into several lines. | ||
| * | ||
| * @param File $phpcsFile | ||
| * @return false|string | ||
| */ | ||
| private function getFormattedXML(File $phpcsFile) | ||
| { | ||
| $doc = new DomDocument('1.0'); | ||
| $doc->formatOutput = true; | ||
| $doc->loadXML($phpcsFile->getTokensAsString(0, 999999)); | ||
| return $doc->saveXML(); | ||
| } | ||
|
|
||
| /** | ||
| * Parse an XML for references to PHP class names in selected tags or attributes | ||
| * | ||
| * @param SimpleXMLElement $xml | ||
| * @return array | ||
| */ | ||
| private function collectClassesInConfig(SimpleXMLElement $xml): array | ||
| { | ||
| $classes = $this->getXmlNode( | ||
| $xml, | ||
| ' | ||
| /config//resource_adapter | /config/*[not(name()="sections")]//class[not(ancestor::observers)] | ||
| | //model[not(parent::connection)] | //backend_model | //source_model | //price_model | ||
| | //model_token | //writer_model | //clone_model | //frontend_model | //working_model | ||
| | //admin_renderer | //renderer | /config/*/di/preferences/*' | ||
| ); | ||
| $classes = array_merge($classes, $this->getXmlAttributeValues($xml, '//@backend_model', 'backend_model')); | ||
| $classes = array_merge( | ||
| $classes, | ||
| $this->getXmlNodeNames( | ||
| $xml, | ||
| '/logging/*/expected_models/* | /logging/*/actions/*/expected_models/* | /config/*/di/preferences/*' | ||
| ) | ||
| ); | ||
|
|
||
| $classes = array_map( | ||
| function (ExtendedNode $extendedNode) { | ||
| $extendedNode->value = explode('::', trim($extendedNode->value))[0]; | ||
| return $extendedNode; | ||
| }, | ||
| $classes | ||
| ); | ||
| $classes = array_filter( | ||
| $classes, | ||
| function ($value) { | ||
| return !empty($value); | ||
| } | ||
| ); | ||
|
|
||
| return $classes; | ||
| } | ||
|
|
||
| /** | ||
| * Get XML node text values using specified xPath | ||
| * | ||
| * The node must contain specified attribute | ||
| * | ||
| * @param SimpleXMLElement $xml | ||
| * @param string $xPath | ||
| * @return array | ||
| */ | ||
| private function getXmlNode(SimpleXMLElement $xml, string $xPath): array | ||
| { | ||
| $result = []; | ||
| $nodes = $xml->xpath($xPath) ?: []; | ||
| foreach ($nodes as $node) { | ||
| $result[] = new ExtendedNode((string)$node, $node); | ||
| } | ||
| return $result; | ||
| } | ||
|
|
||
| /** | ||
| * Get XML node names using specified xPath | ||
| * | ||
| * @param SimpleXMLElement $xml | ||
| * @param string $xpath | ||
| * @return array | ||
| */ | ||
| private function getXmlNodeNames(SimpleXMLElement $xml, string $xpath): array | ||
| { | ||
| $result = []; | ||
| $nodes = $xml->xpath($xpath) ?: []; | ||
| foreach ($nodes as $node) { | ||
| $result[] = new ExtendedNode($node->getName(), $node); | ||
| } | ||
| return $result; | ||
| } | ||
|
|
||
| /** | ||
| * Get XML node attribute values using specified xPath | ||
| * | ||
| * @param SimpleXMLElement $xml | ||
| * @param string $xPath | ||
| * @param string $attributeName | ||
| * @return array | ||
| */ | ||
| private function getXmlAttributeValues(SimpleXMLElement $xml, string $xPath, string $attributeName): array | ||
| { | ||
| $result = []; | ||
| $nodes = $xml->xpath($xPath) ?: []; | ||
| foreach ($nodes as $node) { | ||
| $nodeArray = (array)$node; | ||
| if (isset($nodeArray['@attributes'][$attributeName])) { | ||
| $result[] = new ExtendedNode($nodeArray['@attributes'][$attributeName], $node); | ||
| } | ||
| } | ||
| return $result; | ||
| } | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,33 @@ | ||
| <?php | ||
| /** | ||
| * Copyright © Magento, Inc. All rights reserved. | ||
| * See COPYING.txt for license details. | ||
| */ | ||
|
|
||
| namespace Magento2\Sniffs\Legacy; | ||
|
|
||
| use DOMElement; | ||
| use SimpleXMLElement; | ||
|
|
||
| class ExtendedNode | ||
svera marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| { | ||
| /** | ||
| * @var string | ||
| */ | ||
| public $value; | ||
|
|
||
| /** | ||
| * @var DOMElement | ||
| */ | ||
| public $element; | ||
|
|
||
| /** | ||
| * @param string $value | ||
| * @param SimpleXMLElement $element | ||
| */ | ||
| public function __construct(string $value, SimpleXMLElement $element) | ||
| { | ||
| $this->value = $value; | ||
| $this->element = dom_import_simplexml($element); | ||
| } | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,45 @@ | ||
| <?xml version="1.0"?> | ||
| <!-- | ||
| /** | ||
| * Copyright © Magento, Inc. All rights reserved. | ||
| * See COPYING.txt for license details. | ||
| */ | ||
| --> | ||
| <config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="urn:magento:module:Magento_Config:etc/system_file.xsd"> | ||
| <system> | ||
| <section id="payment" type="text" sortOrder="400" showInDefault="1" showInWebsite="1" showInStore="1"> | ||
| <group id="checkmo" translate="label" type="text" sortOrder="30" showInDefault="1" showInWebsite="1" showInStore="1"> | ||
| <label>Check / Money Order</label> | ||
| <field id="active" translate="label" type="select" sortOrder="1" showInDefault="1" showInWebsite="1" canRestore="1"> | ||
| <label>Enabled</label> | ||
| <source_model>Magento\Config\Model\Config\Source\Yesno</source_model> | ||
| </field> | ||
| </group> | ||
| <group id="purchaseorder" translate="label" type="text" sortOrder="32" showInDefault="1" showInWebsite="1" showInStore="1"> | ||
| <label>Purchase Order</label> | ||
| <field id="active" translate="label" type="select" sortOrder="1" showInDefault="1" showInWebsite="1" canRestore="1"> | ||
| <label>Enabled</label> | ||
| <source_model>Magento\CONFIG\Model\Config\Source\Yesno</source_model> | ||
| </field> | ||
| </group> | ||
| <group id="banktransfer" translate="label" type="text" sortOrder="30" showInDefault="1" showInWebsite="1" showInStore="1"> | ||
| <label>Bank Transfer Payment</label> | ||
| <field id="active" translate="label" type="select" sortOrder="1" showInDefault="1" showInWebsite="1" canRestore="1"> | ||
| <label>Enabled</label> | ||
| <source_model>Config\Model\Config\Source\Yesno</source_model> | ||
| </field> | ||
| <field id="title" translate="label" type="text" sortOrder="10" showInDefault="1" showInWebsite="1" showInStore="1" canRestore="1"> | ||
| <label>Title</label> | ||
| </field> | ||
| <field id="order_status" translate="label" type="select" sortOrder="20" showInDefault="1" showInWebsite="1" canRestore="1"> | ||
| <label>New Order Status</label> | ||
| <source_model>Sales\MODEL\Config\Source\Order\Status\NewStatus</source_model> | ||
|
There was a problem hiding this comment. How about this line? Should it work? There was a problem hiding this comment. @jcuerdo is not in the |
||
| </field> | ||
| <field id="allowspecific" translate="label" type="allowspecific" sortOrder="50" showInDefault="1" showInWebsite="1" canRestore="1"> | ||
| <label>Payment from Applicable Countries</label> | ||
| <source_model>MAGENTO\Payment\Model\Config\Source\Allspecificcountries</source_model> | ||
| </field> | ||
| </group> | ||
| </section> | ||
| </system> | ||
| </config> | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,52 @@ | ||
| <?xml version="1.0"?> | ||
| <!-- | ||
| /** | ||
| * Copyright © Magento, Inc. All rights reserved. | ||
| * See COPYING.txt for license details. | ||
| */ | ||
| --> | ||
| <config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="urn:magento:module:Magento_Config:etc/system_file.xsd"> | ||
| <system> | ||
| <section id="payment" type="text" sortOrder="400" showInDefault="1" showInWebsite="1" showInStore="1"> | ||
| <group id="checkmo" translate="label" type="text" sortOrder="30" showInDefault="1" showInWebsite="1" showInStore="1"> | ||
| <label>Check / Money Order</label> | ||
| <field id="active" translate="label" type="select" sortOrder="1" showInDefault="1" showInWebsite="1" canRestore="1"> | ||
| <label>Enabled</label> | ||
| <source_model>Magento\Config\Model\Config\Source\Yesno</source_model> | ||
| </field> | ||
| </group> | ||
| <group id="purchaseorder" translate="label" type="text" sortOrder="32" showInDefault="1" showInWebsite="1" showInStore="1"> | ||
| <label>Purchase Order</label> | ||
| <field id="active" translate="label" type="select" sortOrder="1" showInDefault="1" showInWebsite="1" canRestore="1"> | ||
| <label>Enabled</label> | ||
| <source_model> | ||
| Magento\CONFIG\Model\Config\Source\Yesno | ||
| </source_model> | ||
| </field> | ||
| </group> | ||
| <group id="banktransfer" translate="label" type="text" sortOrder="30" showInDefault="1" showInWebsite="1" showInStore="1"> | ||
| <label>Bank Transfer Payment</label> | ||
| <field id="active" translate="label" type="select" sortOrder="1" showInDefault="1" showInWebsite="1" canRestore="1"> | ||
| <label>Enabled</label> | ||
| <source_model>Config\Model\Config\Source\Yesno</source_model> | ||
| </field> | ||
| <field id="title" translate="label" type="text" sortOrder="10" showInDefault="1" showInWebsite="1" showInStore="1" canRestore="1"> | ||
| <label>Title</label> | ||
| </field> | ||
| <field id="order_status" translate="label" type="select" sortOrder="20" showInDefault="1" showInWebsite="1" canRestore="1"> | ||
| <label>New Order Status</label> | ||
| <source_model>Sales\MODEL\Config\Source\Order\Status\NewStatus</source_model> | ||
| </field> | ||
| <field id="allowspecific" translate="label" type="allowspecific" sortOrder="50" showInDefault="1" showInWebsite="1" canRestore="1"> | ||
| <label>Payment from Applicable Countries</label> | ||
| <source_model> | ||
|
|
||
|
|
||
| MAGENTO\Payment\Model\Config\Source\Allspecificcountries | ||
|
|
||
| </source_model> | ||
| </field> | ||
| </group> | ||
| </section> | ||
| </system> | ||
| </config> |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,13 @@ | ||
| <?xml version="1.0"?> | ||
| <!-- | ||
| /** | ||
| * Copyright © Magento, Inc. All rights reserved. | ||
| * See COPYING.txt for license details. | ||
| */ | ||
| --> | ||
| <config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="urn:magento:module:Magento_Backend:etc/menu.xsd"> | ||
| <menu> | ||
| <add id="Magento_CatalogRule::promo" title="Promotions" translate="title" module="Magento CatalogRule" parent="Magento_Backend::marketing" sortOrder="10" resource="Magento_CatalogRule::promo"/> | ||
| <add id="Magento_CatalogRule::promo_catalog" title="Catalog Price Rule" translate="title" sortOrder="10" module="Magento_CatalogRule" parent="Magento_CatalogRule::promo" action="catalog_rule/promo_catalog/" dependsOnModule="Magento_Catalog" resource="Magento_CatalogRule::promo_catalog"/> | ||
| </menu> | ||
| </config> |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This regexp must be updated almost certainly, as I think some of these paths are no longer accurate. Could you please check them out @sivaschenko ?