From 2d3a59d6c04d76f92f637e1278d5044795f80330 Mon Sep 17 00:00:00 2001 From: Andreas Gohr Date: Thu, 15 Mar 2012 23:56:16 +0100 Subject: Updated CodeSniffer files for work with Version 1.3.3 --- _cs/DokuWiki/DokuWikiCodingStandard.php | 78 ---------------------- .../Sniffs/PHP/DiscouragedFunctionsSniff.php | 4 +- _cs/DokuWiki/ruleset.xml | 49 ++++++++++++++ 3 files changed, 50 insertions(+), 81 deletions(-) delete mode 100644 _cs/DokuWiki/DokuWikiCodingStandard.php create mode 100644 _cs/DokuWiki/ruleset.xml (limited to '_cs') diff --git a/_cs/DokuWiki/DokuWikiCodingStandard.php b/_cs/DokuWiki/DokuWikiCodingStandard.php deleted file mode 100644 index 36133fc46..000000000 --- a/_cs/DokuWiki/DokuWikiCodingStandard.php +++ /dev/null @@ -1,78 +0,0 @@ - - */ - -if (class_exists('PHP_CodeSniffer_Standards_CodingStandard', true) === false) { - throw new PHP_CodeSniffer_Exception('Class PHP_CodeSniffer_Standards_CodingStandard not found'); -} - -/** - * DokuWiki Coding Standard. - * - * @category PHP - * @package PHP_CodeSniffer - * @author Andreas Gohr - */ -class PHP_CodeSniffer_Standards_DokuWiki_DokuWikiCodingStandard extends PHP_CodeSniffer_Standards_CodingStandard { - - - /** - * Return a list of external sniffs to include with this standard. - * - * @return array - */ - public function getIncludedSniffs() { - return array( - 'Generic/Sniffs/Classes/DuplicateClassNameSniff.php', - 'Generic/Sniffs/CodeAnalysis/JumbledIncrementerSniff.php', - 'Generic/Sniffs/CodeAnalysis/UnnecessaryFinalModifierSniff.php', - 'Generic/Sniffs/CodeAnalysis/UnconditionalIfStatementSniff.php', - 'Generic/Sniffs/CodeAnalysis/ForLoopShouldBeWhileLoopSniff.php', - 'Generic/Sniffs/CodeAnalysis/ForLoopWithTestFunctionCallSniff.php', - 'Generic/Sniffs/CodeAnalysis/UnusedFunctionParameterSniff.php', - 'Generic/Sniffs/CodeAnalysis/EmptyStatementSniff.php', - 'Generic/Sniffs/CodeAnalysis/UselessOverridingMethodSniff.php', - 'Generic/Sniffs/Commenting/TodoSniff.php', - 'Generic/Sniffs/Files/LineEndingsSniff.php', - 'Generic/Sniffs/Formatting/DisallowMultipleStatementsSniff.php', - 'Generic/Sniffs/Metrics/NestingLevelSniff.php', -// 'Generic/Sniffs/Metrics/CyclomaticComplexitySniff.php', //FIXME we might need to tune this first - 'Generic/Sniffs/NamingConventions/UpperCaseConstantNameSniff.php', - 'Generic/Sniffs/PHP/LowerCaseConstantSniff.php', - 'Generic/Sniffs/PHP/DisallowShortOpenTagSniff.php', - 'Generic/Sniffs/PHP/ForbiddenFunctionsSniff.php', - 'Generic/Sniffs/WhiteSpace/DisallowTabIndentSniff.php', - 'DokuWiki/Sniffs/WhiteSpace/ScopeIndentSniff.php', - 'Zend/Sniffs/Files/ClosingTagSniff.php', - 'PEAR/Sniffs/Functions/ValidDefaultValueSniff.php', - 'Squiz/Sniffs/PHP/EvalSniff.php', - 'Squiz/Sniffs/PHP/NonExecutableCodeSniff.php', -// 'Squiz/Sniffs/PHP/CommentedOutCodeSniff.php', //FIXME should ignore oneliners - 'Squiz/Sniffs/WhiteSpace/SuperfluousWhitespaceSniff.php', - 'Squiz/Sniffs/PHP/NonExecutableCodeSniff.php', - 'Squiz/Sniffs/CSS/LowercaseStyleDefinitionSniff.php', - 'Squiz/Sniffs/CSS/MissingColonSniff.php', - 'Squiz/Sniffs/CSS/DisallowMultipleStyleDefinitionsSniff.php', - 'Squiz/Sniffs/CSS/ColonSpacingSniff.php', - 'Squiz/Sniffs/CSS/ClassDefinitionClosingBraceSpaceSniff.php', - 'Squiz/Sniffs/CSS/SemicolonSpacingSniff.php', - 'Squiz/Sniffs/CSS/IndentationSniff.php', - 'Squiz/Sniffs/CSS/EmptyClassDefinitionSniff.php', - 'Squiz/Sniffs/CSS/ClassDefinitionNameSpacingSniff.php', - 'Squiz/Sniffs/CSS/EmptyStyleDefinitionSniff.php', - 'Squiz/Sniffs/CSS/OpacitySniff.php', - 'Squiz/Sniffs/CSS/ColourDefinitionSniff.php', - 'Squiz/Sniffs/CSS/DuplicateClassDefinitionSniff.php', - 'Squiz/Sniffs/CSS/ClassDefinitionOpeningBraceSpaceSniff.php', - - 'Squiz/Sniffs/Commenting/DocCommentAlignmentSniff.php', - - ); - } - -}//end class diff --git a/_cs/DokuWiki/Sniffs/PHP/DiscouragedFunctionsSniff.php b/_cs/DokuWiki/Sniffs/PHP/DiscouragedFunctionsSniff.php index c95e0fd33..9cd9a7d36 100644 --- a/_cs/DokuWiki/Sniffs/PHP/DiscouragedFunctionsSniff.php +++ b/_cs/DokuWiki/Sniffs/PHP/DiscouragedFunctionsSniff.php @@ -49,8 +49,6 @@ class DokuWiki_Sniffs_PHP_DiscouragedFunctionsSniff extends Generic_Sniffs_PHP_F * * @var bool */ - protected $error = false; + public $error = false; }//end class - -?> diff --git a/_cs/DokuWiki/ruleset.xml b/_cs/DokuWiki/ruleset.xml new file mode 100644 index 000000000..5efa6bf06 --- /dev/null +++ b/_cs/DokuWiki/ruleset.xml @@ -0,0 +1,49 @@ + + + DokuWiki Coding Standard + + , + , + , + , + , + , + , + , + , + , + , + , + , + + , + , + , + , + , + , + , + , + , + , + + , + , + , + , + , + , + , + , + , + , + , + , + , + , + , + , + + , + + -- cgit v1.2.3 From c1272e0334c0f9a6b7bdf86c7489e82aaeb01aa5 Mon Sep 17 00:00:00 2001 From: Andreas Gohr Date: Fri, 16 Mar 2012 00:38:36 +0100 Subject: some code sniffer rule adjustments --- _cs/DokuWiki/ruleset.xml | 88 +++++++++++++++++++++++++----------------------- 1 file changed, 46 insertions(+), 42 deletions(-) (limited to '_cs') diff --git a/_cs/DokuWiki/ruleset.xml b/_cs/DokuWiki/ruleset.xml index 5efa6bf06..4135c0860 100644 --- a/_cs/DokuWiki/ruleset.xml +++ b/_cs/DokuWiki/ruleset.xml @@ -2,48 +2,52 @@ DokuWiki Coding Standard - , - , - , - , - , - , - , - , - , - , - , - , - , - - , - , - , - , - , - , - , - , - , - , - - , - , - , - , - , - , - , - , - , - , - , - , - , - , - , - , + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - , + -- cgit v1.2.3 From 37b032b419e51fe8cae1e63dd067601cc111040f Mon Sep 17 00:00:00 2001 From: Andreas Gohr Date: Fri, 16 Mar 2012 10:19:16 +0100 Subject: find deprecated functions in codesniffer --- .../Sniffs/PHP/DeprecatedFunctionsSniff.php | 61 ++++++++++++++++++++++ 1 file changed, 61 insertions(+) create mode 100644 _cs/DokuWiki/Sniffs/PHP/DeprecatedFunctionsSniff.php (limited to '_cs') diff --git a/_cs/DokuWiki/Sniffs/PHP/DeprecatedFunctionsSniff.php b/_cs/DokuWiki/Sniffs/PHP/DeprecatedFunctionsSniff.php new file mode 100644 index 000000000..ecd4093b8 --- /dev/null +++ b/_cs/DokuWiki/Sniffs/PHP/DeprecatedFunctionsSniff.php @@ -0,0 +1,61 @@ + + * @copyright 2006 Squiz Pty Ltd (ABN 77 084 670 600) + * @license http://matrix.squiz.net/developer/tools/php_cs/licence BSD Licence + * @version CVS: $Id: DiscouragedFunctionsSniff.php 265110 2008-08-19 06:36:11Z squiz $ + * @link http://pear.php.net/package/PHP_CodeSniffer + */ + +if (class_exists('Generic_Sniffs_PHP_ForbiddenFunctionsSniff', true) === false) { + throw new PHP_CodeSniffer_Exception('Class Generic_Sniffs_PHP_ForbiddenFunctionsSniff not found'); +} + +/** + * DokuWiki_Sniffs_PHP_DiscouragedFunctionsSniff. + * + * @category PHP + * @package PHP_CodeSniffer + * @author Greg Sherwood + * @copyright 2006 Squiz Pty Ltd (ABN 77 084 670 600) + * @license http://matrix.squiz.net/developer/tools/php_cs/licence BSD Licence + * @version Release: 1.2.2 + * @link http://pear.php.net/package/PHP_CodeSniffer + */ +class DokuWiki_Sniffs_PHP_DeprecatedFunctionsSniff extends Generic_Sniffs_PHP_ForbiddenFunctionsSniff +{ + + /** + * A list of forbidden functions with their alternatives. + * + * The value is NULL if no alternative exists. IE, the + * function should just not be used. + * + * @var array(string => string|null) + */ + protected $forbiddenFunctions = array( + 'setCorrectLocale' => null, + 'html_attbuild' => 'buildAttributes', + 'io_runcmd' => null, + 'p_wiki_xhtml_summary' => 'p_cached_output', + 'search_callback' => 'call_user_func_array', + 'search_backlinks' => 'ft_backlinks', + 'search_fulltext' => 'Fulltext Indexer', + 'search_regex' => 'Fulltext Indexer', + 'tpl_getFavicon' => 'tpl_getMediaFile', + ); + + /** + * If true, an error will be thrown; otherwise a warning. + * + * @var bool + */ + public $error = true; + +}//end class -- cgit v1.2.3 From d086370fa9b2f3cfa66d4584ed76314e216df899 Mon Sep 17 00:00:00 2001 From: Andreas Gohr Date: Fri, 16 Mar 2012 12:09:13 +0100 Subject: more codesniffer updates --- .../NamingConventions/ConstructorNameSniff.php | 85 +++++++++++++++++ _cs/DokuWiki/ruleset.xml | 103 ++++++++++++--------- 2 files changed, 142 insertions(+), 46 deletions(-) create mode 100644 _cs/DokuWiki/Sniffs/NamingConventions/ConstructorNameSniff.php (limited to '_cs') diff --git a/_cs/DokuWiki/Sniffs/NamingConventions/ConstructorNameSniff.php b/_cs/DokuWiki/Sniffs/NamingConventions/ConstructorNameSniff.php new file mode 100644 index 000000000..7dd6d9366 --- /dev/null +++ b/_cs/DokuWiki/Sniffs/NamingConventions/ConstructorNameSniff.php @@ -0,0 +1,85 @@ + + * @author Leif Wickland + * @copyright 2006-2011 Squiz Pty Ltd (ABN 77 084 670 600) + * @license http://matrix.squiz.net/developer/tools/php_cs/licence BSD Licence + * @link http://pear.php.net/package/PHP_CodeSniffer + */ + +if (class_exists('PHP_CodeSniffer_Standards_AbstractScopeSniff', true) === false) { + $error = 'Class PHP_CodeSniffer_Standards_AbstractScopeSniff not found'; + throw new PHP_CodeSniffer_Exception($error); +} + +/** + * Generic_Sniffs_NamingConventions_ConstructorNameSniff. + * + * Favor PHP 5 constructor syntax, which uses "function __construct()". + * Avoid PHP 4 constructor syntax, which uses "function ClassName()". + * + * @category PHP + * @package PHP_CodeSniffer + * @author Leif Wickland + * @license http://matrix.squiz.net/developer/tools/php_cs/licence BSD Licence + * @version Release: 1.3.3 + * @link http://pear.php.net/package/PHP_CodeSniffer + */ +class DokuWiki_Sniffs_NamingConventions_ConstructorNameSniff extends Generic_Sniffs_NamingConventions_ConstructorNameSniff +{ + /** + * Processes this test when one of its tokens is encountered. + * + * @param PHP_CodeSniffer_File $phpcsFile The current file being scanned. + * @param int $stackPtr The position of the current token + * in the stack passed in $tokens. + * @param int $currScope A pointer to the start of the scope. + * + * @return void + */ + protected function processTokenWithinScope( + PHP_CodeSniffer_File $phpcsFile, + $stackPtr, + $currScope + ) { + $className = $phpcsFile->getDeclarationName($currScope); + $methodName = $phpcsFile->getDeclarationName($stackPtr); + + if (strcasecmp($methodName, $className) === 0) { + $error = 'PHP4 style constructors are discouraged; use "__construct()" instead'; + $phpcsFile->addWarning($error, $stackPtr, 'OldStyle'); + } else if (strcasecmp($methodName, '__construct') !== 0) { + // Not a constructor. + return; + } + + $tokens = $phpcsFile->getTokens(); + + $parentClassName = $phpcsFile->findExtendedClassName($currScope); + if ($parentClassName === false) { + return; + } + + $endFunctionIndex = $tokens[$stackPtr]['scope_closer']; + $startIndex = $stackPtr; + while ($doubleColonIndex = $phpcsFile->findNext(array(T_DOUBLE_COLON), $startIndex, $endFunctionIndex)) { + if ($tokens[($doubleColonIndex + 1)]['code'] === T_STRING + && $tokens[($doubleColonIndex + 1)]['content'] === $parentClassName + ) { + $error = 'PHP4 style calls to parent constructors are discouraged; use "parent::__construct()" instead'; + $phpcsFile->addWarning($error, ($doubleColonIndex + 1), 'OldStyleCall'); + } + + $startIndex = ($doubleColonIndex + 1); + } + + }//end processTokenWithinScope() + + +}//end class diff --git a/_cs/DokuWiki/ruleset.xml b/_cs/DokuWiki/ruleset.xml index 4135c0860..bfbef87fe 100644 --- a/_cs/DokuWiki/ruleset.xml +++ b/_cs/DokuWiki/ruleset.xml @@ -2,52 +2,63 @@ DokuWiki Coding Standard - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + */adLDAP.php + */EmailAddressValidator.php + */feedcreator.class.php + */SimplePie.php + */geshi.php + */geshi/* + */JSON.php - + + */_test/* + */_cs/* + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + -- cgit v1.2.3