Add file name sniff.

Author: dereuromark

PSR2R/Sniffs/Classes/ClassFileNameSniff.php

@@ -0,0 +1,86 @@
+<?php
+/**
+ * Squiz_Sniffs_Classes_ClassFileNameSniff.
+ *
+ * PHP version 5
+ *
+ * @category  PHP
+ * @package   PHP_CodeSniffer
+ * @author    Greg Sherwood <gsherwood@squiz.net>
+ * @author    Marc McIntyre <mmcintyre@squiz.net>
+ * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600)
+ * @license   https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence
+ * @link      http://pear.php.net/package/PHP_CodeSniffer
+ */
+namespace PSR2R\Sniffs\Classes;
+
+use PHP_CodeSniffer_File;
+use PSR2R\Tools\AbstractSniff;
+
+/**
+ * Squiz_Sniffs_Classes_ClassFileNameSniff.
+ *
+ * Tests that the file name and the name of the class contained within the file
+ * match.
+ *
+ * @author Greg Sherwood <gsherwood@squiz.net>
+ * @author Marc McIntyre <mmcintyre@squiz.net>
+ * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600)
+ * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence
+ * @version Release: @package_version@
+ * @link http://pear.php.net/package/PHP_CodeSniffer
+ */
+class ClassFileNameSniff extends AbstractSniff {
+
+	/**
+	 * Returns an array of tokens this test wants to listen for.
+	 *
+	 * @return array
+	 */
+	public function register() {
+		return [
+			T_CLASS,
+			T_INTERFACE,
+		];
+	}
+
+	/**
+	 * Processes this test, when one of its tokens is encountered.
+	 *
+	 * @param \PHP_CodeSniffer_File $phpcsFile The file being scanned.
+	 * @param int $stackPtr The position of the current token in
+	 *                                        the stack passed in $tokens.
+	 *
+	 * @return void
+	 */
+	public function process(PHP_CodeSniffer_File $phpcsFile, $stackPtr) {
+		$fullPath = basename($phpcsFile->getFilename());
+		$fileName = substr($fullPath, 0, strrpos($fullPath, '.'));
+		if ($fileName === '') {
+			// No filename probably means STDIN, so we can't do this check.
+			return;
+		}
+
+		$tokens = $phpcsFile->getTokens();
+
+		$previous = $phpcsFile->findPrevious([T_CLASS, T_INTERFACE], $stackPtr - 1);
+		if ($previous) {
+			// Probably more than a single declaration per file, we only check first one then.
+			return;
+		}
+
+		$decName = $phpcsFile->findNext(T_STRING, $stackPtr);
+
+		if ($tokens[$decName]['content'] !== $fileName) {
+			$error = '%s name doesn\'t match filename; expected "%s %s"';
+			$data = [
+				ucfirst($tokens[$stackPtr]['content']),
+				$tokens[$stackPtr]['content'],
+				$fileName,
+			];
+			$phpcsFile->addError($error, $stackPtr, 'NoMatch', $data);
+		}
+
+	}
+
+}