MC-19366: Adds GraphQL sniffs

Magento2/Sniffs/GraphQL/AbstractGraphQLSniff.php

@@ -0,0 +1,50 @@
+<?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

@@ -0,0 +1,124 @@
+<?php
+/**
+ * Copyright © Magento. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+namespace Magento2\Sniffs\GraphQL;
+
+use PHP_CodeSniffer\Files\File;
+
+/**
+ * Detects argument names that are not specified in <kbd>cameCase</kbd>.
+ */
+class ValidArgumentNameSniff extends AbstractGraphQLSniff
+{
+    /**
+     * @inheritDoc
+     */
+    public function register()
+    {
+        return [T_OPEN_PARENTHESIS];
+    }
+
+    /**
+     * @inheritDoc
+     */
+    public function process(File $phpcsFile, $stackPtr)
+    {
+        $tokens                  = $phpcsFile->getTokens();
+        $closeParenthesisPointer = $this->getCloseParenthesisPointer($stackPtr, $tokens);
+
+        //if we could not find the closing parenthesis pointer, we add a warning and terminate
+        if ($closeParenthesisPointer === false) {
+            $error = 'Possible parse error: Missing closing parenthesis for argument list in line %d';
+            $data  = [
+                $tokens[$stackPtr]['line'],
+            ];
+            $phpcsFile->addWarning($error, $stackPtr, 'UnclosedArgumentList', $data);
+            return;
+        }
+
+        $arguments = $this->getArguments($stackPtr, $closeParenthesisPointer, $tokens);
+
+        foreach ($arguments as $argument) {
+            $pointer = $argument[0];
+            $name    = $argument[1];
+
+            if (!$this->isCamelCase($name)) {
+                $type  = 'Argument';
+                $error = '%s name "%s" is not in CamelCase format';
+                $data  = [
+                    $type,
+                    $name,
+                ];
+
+                $phpcsFile->addError($error, $pointer, 'NotCamelCase', $data);
+                $phpcsFile->recordMetric($pointer, 'CamelCase argument name', 'no');
+            } else {
+                $phpcsFile->recordMetric($pointer, 'CamelCase argument name', 'yes');
+            }
+        }
+
+        //return stack pointer of closing parenthesis
+        return $closeParenthesisPointer;
+    }
+
+    /**
+     * Finds all argument names contained in <var>$tokens</var> range <var>$startPointer</var> and
+     * <var>$endPointer</var>.
+     *
+     * @param int $startPointer
+     * @param int $endPointer
+     * @param array $tokens
+     * @return array[]
+     */
+    private function getArguments($startPointer, $endPointer, array $tokens)
+    {
+        $argumentTokenPointer = null;
+        $argument             = '';
+        $names                = [];
+        $skipTypes            = [T_COMMENT, T_WHITESPACE];
+
+        for ($i = $startPointer + 1; $i < $endPointer; ++$i) {
+            //skip comment tokens
+            if (in_array($tokens[$i]['code'], $skipTypes)) {
+                continue;
+            }
+            $argument .= $tokens[$i]['content'];
+
+            if ($argumentTokenPointer === null) {
+                $argumentTokenPointer = $i;
+            }
+
+            if (preg_match('/^.+:.+$/', $argument)) {
+                list($name, $type) = explode(':', $argument);
+                $names[]              = [$argumentTokenPointer, $name];
+                $argument             = '';
+                $argumentTokenPointer = null;
+            }
+        }
+
+        return $names;
+    }
+
+    /**
+     * Seeks the next available token of type {@link T_CLOSE_PARENTHESIS} in <var>$tokens</var> and returns its pointer.
+     *
+     * @param int $stackPointer
+     * @param array $tokens
+     * @return bool|int
+     */
+    private function getCloseParenthesisPointer($stackPointer, array $tokens)
+    {
+        $numTokens = count($tokens);
+
+        for ($i = $stackPointer + 1; $i < $numTokens; ++$i) {
+            if ($tokens[$i]['code'] === T_CLOSE_PARENTHESIS) {
+                return $i;
+            }
+        }
+
+        //if we came here we could not find the closing parenthesis
+        return false;
+    }
+}

Magento2/Sniffs/GraphQL/ValidFieldNameSniff.php

@@ -0,0 +1,44 @@
+<?php
+/**
+ * Copyright © Magento. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+namespace Magento2\Sniffs\GraphQL;
+
+use PHP_CodeSniffer\Files\File;
+
+/**
+ * Detects field names the are not specified in <kbd>snake_case</kbd>.
+ */
+class ValidFieldNameSniff extends AbstractGraphQLSniff
+{
+    /**
+     * @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');
+        }
+    }
+}

Magento2/Sniffs/GraphQL/ValidTopLevelFieldNameSniff.php

@@ -0,0 +1,49 @@
+<?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

@@ -0,0 +1,53 @@
+<?php
+/**
+ * Copyright © Magento. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+namespace Magento2\Sniffs\GraphQL;
+
+use PHP_CodeSniffer\Files\File;
+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 extends AbstractGraphQLSniff
+{
+    /**
+     * @inheritDoc
+     */
+    public function register()
+    {
+        return [T_CLASS, T_INTERFACE];
+    }
+
+    /**
+     * @inheritDoc
+     */
+    public function process(File $phpcsFile, $stackPtr)
+    {
+        $tokens = $phpcsFile->getTokens();
+
+        //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'];
+        }
+
+        $valid = Common::isCamelCaps($name, true, true, false);
+
+        if ($valid === false) {
+            $type  = ucfirst($tokens[$stackPtr]['content']);
+            $error = '%s name "%s" is not in PascalCase format';
+            $data  = [
+                $type,
+                $name,
+            ];
+            $phpcsFile->addError($error, $stackPtr, 'NotCamelCaps', $data);
+            $phpcsFile->recordMetric($stackPtr, 'PascalCase class name', 'no');
+        } else {
+            $phpcsFile->recordMetric($stackPtr, 'PascalCase class name', 'yes');
+        }
+    }
+}

Magento2/Tests/GraphQL/AbstractGraphQLSniffUnitTestCase.php

@@ -0,0 +1,33 @@
+<?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/ValidArgumentNameUnitTest.graphqls

@@ -0,0 +1,32 @@
+type Foo {
+    bar(
+        # Valid argument names
+        validArgumentName: Int
+        validArgumentNameWith1Number: Int
+        validArgumentNameWith12345Numbers: Int
+        validArgumentNameEndingWithNumber5: Int
+        validArgumentNameWithUPPERCASE: Int
+        validargumentwithlowercase: Int
+        # Invalid argument names
+        InvalidArgumentNameUpperCamelCase: Int
+        INVALIDARGUMENTNAMEUPPERCASE: Int
+        invalid_argument_name_snake_case: Int
+        5invalidArgumentNameStatingWithNumber: Int
+    ): String
+}
+interface Foo {
+    bar(
+        # Valid argument names
+        validArgumentName: Int
+        validArgumentNameWith1Number: Int
+        validArgumentNameWith12345Numbers: Int
+        validArgumentNameEndingWithNumber5: Int
+        validArgumentNameWithUPPERCASE: Int
+        validargumentwithlowercase: Int
+        # Invalid argument names
+        InvalidArgumentNameUpperCamelCase: Int
+        INVALIDARGUMENTNAMEUPPERCASE: Int
+        invalid_argument_name_snake_case: Int
+        5invalidArgumentNameStatingWithNumber: Int
+    ): String
+}