MC-19366: Adds sniff for field names

Author: jean-bernard-valentaten

Magento2/Sniffs/GraphQL/ValidArgumentNameSniff.php

@@ -0,0 +1,65 @@
+<?php
+/**
+ * Copyright © Magento. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+namespace Magento2\Sniffs\GraphQL;
+
+use PHP_CodeSniffer\Files\File;
+use PHP_CodeSniffer\Sniffs\Sniff;
+use PHP_CodeSniffer\Util\Common;
+
+/**
+ * Detects field names the are not specified in <kbd>snake_case</kbd>.
+ */
+class ValidFieldNameSniff implements Sniff
+{
+
+    /**
+     * Defines the tokenizers that this sniff is using.
+     *
+     * @var array
+     */
+    public $supportedTokenizers = ['GraphQL'];
+
+    /**
+     * @inheritDoc
+     */
+    public function register()
+    {
+        return [T_VARIABLE];
+    }
+
+    /**
+     * @inheritDoc
+     */
+    public function process(File $phpcsFile, $stackPtr)
+    {
+        $tokens = $phpcsFile->getTokens();
+        $name   = $tokens[$stackPtr]['content'];
+
+        if (!$this->isSnakeCase($name)) {
+            $type  = 'Field';
+            $error = '%s name "%s" is not in snake_case format';
+            $data  = [
+                $type,
+                $name,
+            ];
+            $phpcsFile->addError($error, $stackPtr, 'NotSnakeCase', $data);
+            $phpcsFile->recordMetric($stackPtr, 'SnakeCase field name', 'no');
+        } else {
+            $phpcsFile->recordMetric($stackPtr, 'SnakeCase field name', 'yes');
+        }
+    }
+
+    /**
+     * Returns whether <var>$name</var> is strictly lower case, potentially separated by underscores.
+     *
+     * @param string $name
+     * @return bool
+     */
+    private function isSnakeCase($name)
+    {
+        return preg_match('/^[a-z][a-z0-9_]*$/', $name);
+    }
+}

Magento2/Sniffs/GraphQL/ValidFieldNameSniff.php

@@ -38,7 +38,7 @@ public function process(File $phpcsFile, $stackPtr)
     {
         $tokens = $phpcsFile->getTokens();
 
-        //compose entity name by making use of the next strings the we find until we hit a non-string token
+        //compose entity name by making use of the next strings that we find until we hit a non-string token
         $name = '';
         for ($i=$stackPtr+1; $tokens[$i]['code'] === T_STRING; ++$i) {
             $name .= $tokens[$i]['content'];

Magento2/Sniffs/GraphQL/ValidTypeNameSniff.php

@@ -0,0 +1,35 @@
+<?php
+/**
+ * Copyright © Magento. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+namespace Magento2\Tests\GraphQL;
+
+use PHP_CodeSniffer\Config;
+use PHP_CodeSniffer\Tests\Standards\AbstractSniffUnitTest;
+
+/**
+ * Implements an abstract base for unit tests that cover GraphQL sniffs.
+ */
+abstract class AbstractGraphQLSniffUnitTestCase extends AbstractSniffUnitTest
+{
+
+    protected function setUp()
+    {
+        //let parent do its job
+        parent::setUp();
+
+        //generate a config that allows ro use our GraphQL tokenizer
+        $config = new Config();
+        $config->extensions = array_merge(
+            $config->extensions,
+            [
+                'graphqls' => 'GraphQL'
+            ]
+        );
+
+        //and write back to a global that is used in base class
+        $GLOBALS['PHP_CODESNIFFER_CONFIG'] = $config;
+    }
+
+}

Magento2/Tests/GraphQL/AbstractGraphQLSniffUnitTestCase.php

@@ -0,0 +1,31 @@
+type FooType {
+    # Valid snake case field names
+    valid_snake_case_field: String
+    validlowercasefield: String
+    valid_snake_case_field_ending_with_number_5: String
+    valid_snake_case_field_with_ending_numbers_12345: String
+    valid_snake_case_field_5_with_number5_inline: String
+
+    # Incorrect use of snake case
+    INVALIDUPPERCASEFIELD: String
+    INVALID_SCREAMING_SNAKE_CASE_FIELD: String
+    Invalid_Upper_Snake_Case_Field: String
+    invalid_mixed_case_FIELD: String
+    InvalidCameCaseFieldName: String
+}
+
+interface FooInterface {
+    # Valid snake case field names
+    valid_snake_case_field: String
+    validlowercasefield: String
+    valid_snake_case_field_ending_with_number_5: String
+    valid_snake_case_field_with_ending_numbers_12345: String
+    valid_snake_case_field_5_with_number5_inline: String
+
+    # Incorrect use of snake case
+    INVALIDUPPERCASEFIELD: String
+    INVALID_SCREAMING_SNAKE_CASE_FIELD: String
+    Invalid_Upper_Snake_Case_Field: String
+    invalid_mixed_case_FIELD: String
+    InvalidCameCaseFieldName: String
+}

Magento2/Tests/GraphQL/ValidFieldNameUnitTest.graphqls

@@ -0,0 +1,45 @@
+<?php
+/**
+ * Copyright © Magento. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+namespace Magento2\Tests\GraphQL;
+
+/**
+ * Covers {@link \Magento2\Sniffs\GraphQL\ValidFieldNameUnitTest}.
+ */
+class ValidFieldNameUnitTest extends AbstractGraphQLSniffUnitTestCase
+{
+
+    /**
+     * Returns the lines where errors should occur.
+     *
+     * The key of the array should represent the line number and the value
+     * should represent the number of errors that should occur on that line.
+     *
+     * @return array<int, int>
+     */
+    protected function getErrorList()
+    {
+        return [
+            10 => 1,
+            11 => 1,
+            12 => 1,
+            13 => 1,
+            14 => 1,
+            26 => 1,
+            27 => 1,
+            28 => 1,
+            29 => 1,
+            30 => 1,
+        ];
+    }
+
+    /**
+     * @inheritDoc
+     */
+    protected function getWarningList()
+    {
+        return [];
+    }
+}

Magento2/Tests/GraphQL/ValidFieldNameUnitTest.php

@@ -6,32 +6,12 @@
 namespace Magento2\Tests\GraphQL;
 
 use PHP_CodeSniffer\Config;
-use PHP_CodeSniffer\Tests\Standards\AbstractSniffUnitTest;
 
 /**
- * Covers {@link \agento2\Sniffs\GraphQL\ValidTypeNameSniff}.
+ * Covers {@link \Magento2\Sniffs\GraphQL\ValidTypeNameSniff}.
  */
-class ValidTypeNameUnitTest extends AbstractSniffUnitTest
+class ValidTypeNameUnitTest extends AbstractGraphQLSniffUnitTestCase
 {
-
-    protected function setUp()
-    {
-        //let parent do its job
-        parent::setUp();
-
-        //generate a config that allows ro use our GraphQL tokenizer
-        $config = new Config();
-        $config->extensions = array_merge(
-            $config->extensions,
-            [
-                'graphqls' => 'GraphQL'
-            ]
-        );
-
-        //and write back to a global that is used in base class
-        $GLOBALS['PHP_CODESNIFFER_CONFIG'] = $config;
-    }
-
     /**
      * Returns the lines where errors should occur.
      *