MC-19366: Adds sniff for top level fields

Author: jean-bernard-valentaten

Magento2/Sniffs/GraphQL/AbstractGraphQLSniff.php

@@ -0,0 +1,52 @@
+<?php
+/**
+ * NOTICE OF LICENSE
+ *
+ * Copyright (c) 2019 TechDivision GmbH <info@techdivision.com> - TechDivision GmbH
+ * All rights reserved
+ *
+ * This product includes proprietary software developed at TechDivision GmbH, Germany
+ * For more information see https://www.techdivision.com/
+ *
+ * To obtain a valid license for using this software please contact us at license@techdivision.com
+ */
+namespace Magento2\Sniffs\GraphQL;
+
+use PHP_CodeSniffer\Sniffs\Sniff;
+
+/**
+ * Defines an abstract base class for GraphQL sniffs.
+ */
+abstract class AbstractGraphQLSniff implements Sniff
+{
+
+    /**
+     * Defines the tokenizers that this sniff is using.
+     *
+     * @var array
+     */
+    public $supportedTokenizers = ['GraphQL'];
+
+    /**
+     * Returns whether <var>$name</var> starts with a lower case character and is written in camel case.
+     *
+     * @param string $name
+     * @return bool
+     */
+    protected function isCamelCase($name)
+    {
+        return (preg_match('/^[a-z][a-zA-Z0-9]+$/', $name) !== 0);
+    }
+
+    /**
+     * Returns whether <var>$name</var> is strictly lower case, potentially separated by underscores.
+     *
+     * @param string $name
+     * @return bool
+     */
+    protected function isSnakeCase($name)
+    {
+        return preg_match('/^[a-z][a-z0-9_]*$/', $name);
+    }
+
+}

Magento2/Sniffs/GraphQL/ValidArgumentNameSniff.php

@@ -3,25 +3,16 @@
  * 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;
 
 /**
  * Detects argument names that are not specified in <kbd>cameCase</kbd>.
  */
-class ValidArgumentNameSniff implements Sniff
+class ValidArgumentNameSniff extends AbstractGraphQLSniff
 {
 
-    /**
-     * Defines the tokenizers that this sniff is using.
-     *
-     * @var array
-     */
-    public $supportedTokenizers = ['GraphQL'];
-
     /**
      * @inheritDoc
      */
@@ -132,14 +123,4 @@ private function getCloseParenthesisPointer($stackPointer, array $tokens)
         return false;
     }
 
-    /**
-     * Returns whether <var>$name</var> starts with a lower case character and is written in camel case.
-     *
-     * @param string $argumentName
-     * @return bool
-     */
-    private function isCamelCase($argumentName)
-    {
-        return (preg_match('/^[a-z][a-zA-Z0-9]+$/', $argumentName) !== 0);
-    }
 }

Magento2/Sniffs/GraphQL/ValidFieldNameSniff.php

@@ -6,21 +6,13 @@
 namespace Magento2\Sniffs\GraphQL;
 
 use PHP_CodeSniffer\Files\File;
-use PHP_CodeSniffer\Sniffs\Sniff;
 
 /**
  * Detects field names the are not specified in <kbd>snake_case</kbd>.
  */
-class ValidFieldNameSniff implements Sniff
+class ValidFieldNameSniff extends AbstractGraphQLSniff
 {
 
-    /**
-     * Defines the tokenizers that this sniff is using.
-     *
-     * @var array
-     */
-    public $supportedTokenizers = ['GraphQL'];
-
     /**
      * @inheritDoc
      */
@@ -51,14 +43,4 @@ public function process(File $phpcsFile, $stackPtr)
         }
     }
 
-    /**
-     * 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/ValidTopLevelFieldNameSniff.php

@@ -0,0 +1,51 @@
+<?php
+/**
+ * Copyright © Magento. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+namespace Magento2\Sniffs\GraphQL;
+
+use PHP_CodeSniffer\Files\File;
+
+/**
+ * Detects top level field names that are not specified in <kbd>cameCase</kbd>.
+ */
+class ValidTopLevelFieldNameSniff extends AbstractGraphQLSniff
+{
+
+    /**
+     * @inheritDoc
+     */
+    public function register()
+    {
+        return [T_FUNCTION];
+    }
+
+    /**
+     * @inheritDoc
+     */
+    public function process(File $phpcsFile, $stackPtr)
+    {
+        $tokens = $phpcsFile->getTokens();
+
+        //compose function 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'];
+        }
+
+        if (strlen($name) > 0 && !$this->isCamelCase($name)) {
+            $type  = ucfirst($tokens[$stackPtr]['content']);
+            $error = '%s name "%s" is not in PascalCase format';
+            $data  = [
+                $type,
+                $name,
+            ];
+            $phpcsFile->addError($error, $stackPtr, 'NotCamelCase', $data);
+            $phpcsFile->recordMetric($stackPtr, 'CamelCase top level field name', 'no');
+        } else {
+            $phpcsFile->recordMetric($stackPtr, 'CamelCase top level field name', 'yes');
+        }
+    }
+
+}

Magento2/Sniffs/GraphQL/ValidTypeNameSniff.php

@@ -6,23 +6,15 @@
 namespace Magento2\Sniffs\GraphQL;
 
 use PHP_CodeSniffer\Files\File;
-use PHP_CodeSniffer\Sniffs\Sniff;
 use PHP_CodeSniffer\Util\Common;
 
 /**
  * Detects types (<kbd>type</kbd>, <kbd>interface</kbd> and <kbd>enum</kbd>) that are not specified in
  * <kbd>UpperCamelCase</kbd>.
  */
-class ValidTypeNameSniff implements Sniff
+class ValidTypeNameSniff extends AbstractGraphQLSniff
 {
 
-    /**
-     * Defines the tokenizers that this sniff is using.
-     *
-     * @var array
-     */
-    public $supportedTokenizers = ['GraphQL'];
-
     /**
      * @inheritDoc
      */

Magento2/Tests/GraphQL/ValidTopLevelFieldNameUnitTest.graphqls

@@ -0,0 +1,35 @@
+# Valid names
+query validCamelCaseQuery {}
+mutation validCamelCaseMutation {}
+
+# Incorrect use of camel cyse
+query InvalidCamelCaseQuery {}
+query invalid_Camel_Case_Query_With_Underscores {}
+mutation InvalidCamelCaseMutation {}
+mutation invalid_Camel_Case_Mutation_With_Underscores {}
+
+# All lower case
+query validlowercasequery {}
+mutation validlowercasemutation {}
+
+# All upper case
+query INVALIDUPPERCASEQUERY {}
+mutation INVALIDUPPERCASEMUTATION {}
+
+# Mix camel case with uppercase
+query validCamelCaseQueryWithUPPERCASE {}
+mutation validCamelCaseMutationWithUPPERCASE {}
+
+# Usage of numeric characters
+query validCamelCaseQueryWith1Number {}
+query validCamelCaseQueryWith12345Numbers {}
+query validCamelCaseQueryEndingWithNumber4 {}
+query 5invalidCamelCaseQueryStartingWithNumber {}
+mutation validCamelCaseMutationWith1Number {}
+mutation validCamelCaseMutationWith12345Numbers {}
+mutation validCamelCaseMutationEndingWithNumber4 {}
+mutation 5invalidCamelCaseMutationStartingWithNumber {}
+
+# Empty names (valid by definition of GraphQL)
+query {}
+mutation {}

Magento2/Tests/GraphQL/ValidTopLevelFieldNameUnitTest.php

@@ -0,0 +1,39 @@
+<?php
+/**
+ * Copyright © Magento. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+namespace Magento2\Tests\GraphQL;
+
+/**
+ * Covers {@link \Magento2\Sniffs\GraphQL\ValidTopLevelFieldNameSniff}.
+ */
+class ValidTopLevelFieldNameUnitTest extends AbstractGraphQLSniffUnitTestCase
+{
+
+    /**
+     * @inheritDoc
+     */
+    protected function getErrorList()
+    {
+        return [
+            6 => 1,
+            7 => 1,
+            8 => 1,
+            9 => 1,
+            16 => 1,
+            17 => 1,
+            27 => 1,
+            31 => 1,
+        ];
+    }
+
+    /**
+     * @inheritDoc
+     */
+    protected function getWarningList()
+    {
+        return [];
+    }
+
+}

Magento2/ruleset.xml

@@ -526,6 +526,18 @@
         <severity>6</severity>
         <type>warning</type>
     </rule>
+    <rule ref="Magento2.GraphQL.ValidFieldName">
+        <severity>6</severity>
+        <type>warning</type>
+    </rule>
+    <rule ref="Magento2.GraphQL.ValidArgumentName">
+        <severity>6</severity>
+        <type>warning</type>
+    </rule>
+    <rule ref="Magento2.GraphQL.ValidTopLevelFieldName">
+        <severity>6</severity>
+        <type>warning</type>
+    </rule>
 
     <!-- Severity 5 warnings: PHPDoc formatting and commenting issues. -->
     <rule ref="Magento2.Commenting.ClassAndInterfacePHPDocFormatting">

PHP_CodeSniffer/Tokenizers/GraphQL.php

@@ -58,6 +58,8 @@ class GraphQL extends Tokenizer
         'implements' => 'T_IMPLEMENTS',
         'type'       => 'T_CLASS',
         'union'      => 'T_CLASS',
+        'query'      => 'T_FUNCTION',
+        'mutation'   => 'T_FUNCTION',
         //TODO We may have to add further types
     ];