Merge pull request #26 from VincentLanglet/staging

✨ Add check for filename

Author: VincentLanglet

Symfony3Custom/Sniffs/NamingConventions/ValidFileNameSniff.php

@@ -0,0 +1,58 @@
+<?php
+
+namespace Symfony3Custom\Sniffs\NamingConventions;
+
+use PHP_CodeSniffer\Files\File;
+use PHP_CodeSniffer\Sniffs\Sniff;
+
+/**
+ * Checks whether filename contains any other character than alphanumeric and underscores.
+ */
+class ValidFileNameSniff implements Sniff
+{
+    /**
+     * Returns an array of tokens this test wants to listen for.
+     *
+     * @return array
+     */
+    public function register()
+    {
+        return array(T_OPEN_TAG);
+    }
+
+    /**
+     * Process.
+     *
+     * @param File $phpcsFile
+     * @param int                         $stackPtr
+     *
+     * @return void
+     */
+    public function process(File $phpcsFile, $stackPtr)
+    {
+        $filename = $phpcsFile->getFilename();
+
+        if ('STDIN' === $filename) {
+            return;
+        }
+
+        $filenamePhp = str_replace('_', '', basename($filename, '.php'));
+        $filenameInc = str_replace('_', '', basename($filename, '.inc'));
+
+        if (strlen($filenameInc) < strlen($filenamePhp)) {
+            $filename = $filenameInc;
+        } else {
+            $filename = $filenamePhp;
+        }
+
+        if (false === ctype_alnum($filename)) {
+            $error = sprintf('Filename "%s" contains non alphanumeric characters', $filename);
+            $phpcsFile->addError($error, $stackPtr, 'Invalid');
+            $phpcsFile->recordMetric($stackPtr, 'Alphanumeric filename', 'no');
+        } else {
+            $phpcsFile->recordMetric($stackPtr, 'Alphanumeric filename', 'yes');
+        }
+
+        return;
+    }
+}

Symfony3Custom/Tests/NamingConventions/ValidFileNameUnitTest.Invalid.inc

@@ -0,0 +1,3 @@
+<?php
+
+return 'Test';

Symfony3Custom/Tests/NamingConventions/ValidFileNameUnitTest.inc

@@ -0,0 +1,3 @@
+<?php
+
+return 'Test';

Symfony3Custom/Tests/NamingConventions/ValidFileNameUnitTest.php

@@ -0,0 +1,50 @@
+<?php
+
+namespace Symfony3Custom\Tests\NamingConventions;
+
+use PHP_CodeSniffer\Tests\Standards\AbstractSniffUnitTest;
+
+/**
+ * Unit test class for the ValidFileName sniff.
+ *
+ * @group Symfony3Custom
+ */
+class ValidFileNameUnitTest extends AbstractSniffUnitTest
+{
+    /**
+     * 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.
+     *
+     * @param string $filename
+     *
+     * @return array<int, int>
+     */
+    public function getErrorList($filename = '')
+    {
+        switch ($filename) {
+            case 'ValidFileNameUnitTest.inc':
+                return [];
+            case 'ValidFileNameUnitTest.Invalid.inc':
+                return [
+                    1 => 1,
+                ];
+            default:
+                return [];
+        }
+    }
+
+    /**
+     * Returns the lines where warnings should occur.
+     *
+     * The key of the array should represent the line number and the value
+     * should represent the number of warnings that should occur on that line.
+     *
+     * @return array(int => int)
+     */
+    protected function getWarningList()
+    {
+        return array();
+    }
+}

docs/standards/symfony.md

@@ -159,6 +159,12 @@ Covered by `PSR1` completed by
 <rule ref="Symfony3Custom.NamingConventions.ValidClassName" />
 ```
 
+- Use alphanumeric characters and underscores for file names
+
+```
+<rule ref="Symfony3Custom.NamingConventions.ValidFileName" />
+```
+
 - For type-hinting in PHPDocs and casting, use `bool`, `int` and `float`
 
 ```