Switch to PHPCS coding standard

- add travis testing
- change some sniffs to comply to PHPCS standard
- update README.md
- split out LICENSE
- closes GH-8

Author: mmoll

.travis.yml

@@ -0,0 +1,16 @@
+sudo: false
+language: php
+php:
+  - 5.4
+  - 5.5
+  - 5.6
+
+before_script:
+  - composer install --dev
+  - mkdir -p vendor/squizlabs/php_codesniffer/CodeSniffer/Standards/Symfony
+  - cp -R Sniffs/ vendor/squizlabs/php_codesniffer/CodeSniffer/Standards/Symfony/Sniffs/
+  - cp -R Tests/ vendor/squizlabs/php_codesniffer/CodeSniffer/Standards/Symfony/Tests/
+
+script:
+  - (cd vendor/squizlabs/php_codesniffer ; phpunit)
+  - ./vendor/squizlabs/php_codesniffer/scripts/phpcs ./vendor/squizlabs/php_codesniffer/CodeSniffer/Standards/Symfony/Sniffs --standard=PHPCS --report=summary -np

LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) 2013 Xaver Loppenstedt
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is furnished
+to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

README.md

@@ -1,4 +1,4 @@
-# MO4 CodeSniffer ruleset 
+# MO4 CodeSniffer ruleset <a href="https://travis-ci.org/Mayflower/mo4-coding-standard/"><img src="https://secure.travis-ci.org/Mayflower/mo4-coding-standard.png?branch=master"
 
 Provides a CodeSniffer ruleset
 
@@ -51,11 +51,11 @@ The MO4 Coding Standard is an extension of the [Symfony Coding Standard](http://
 
 ## Contributing
 
-If you contribute code to these sniffs, please make sure it conforms to the PEAR coding standard and that the unit tests still pass.
+If you contribute code to these sniffs, please make sure it conforms to the PHPCS coding standard and that the unit tests still pass.
 
 To check the coding standard, run from the Symfony-coding-standard source root:
 
-        phpcs --ignore=Tests --standard=PEAR . -n
+        phpcs --ignore=Tests --standard=PHPCS . -n
 
 The unit-tests are run from within the PHP_CodeSniffer directory
 
@@ -69,23 +69,4 @@ The unit-tests are run from within the PHP_CodeSniffer directory
 
 ## Licence
 
-Copyright (c) 2013 Xaver Loppenstedt
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is furnished
-to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
-THE SOFTWARE.
-
+This project is licensed under the MIT license.

Sniffs/Commenting/PropertyCommentSniff.php

@@ -35,21 +35,20 @@ class MO4_Sniffs_Commenting_PropertyCommentSniff
      */
     public $supportedTokenizers = array('PHP');
 
+
     /**
      * Construct PropertyCommentSniff
      */
     function __construct()
     {
-        $scopes = array(
-            T_CLASS,
-        );
+        $scopes = array(T_CLASS);
 
-        $listen = array(
-            T_VARIABLE,
-        );
+        $listen = array(T_VARIABLE);
 
         parent::__construct($scopes, $listen, true);
-    }
+
+    }//end __construct()
+
 
     /**
      * Processes a token that is found within the scope that this test is
@@ -70,22 +69,22 @@ protected function processTokenWithinScope(
         $currScope
     ) {
         $find   = array(
-            T_COMMENT,
-            T_DOC_COMMENT_CLOSE_TAG,
-            T_CLASS,
-            T_CONST,
-            T_FUNCTION,
-            T_VARIABLE,
-            T_OPEN_TAG,
-        );
+                   T_COMMENT,
+                   T_DOC_COMMENT_CLOSE_TAG,
+                   T_CLASS,
+                   T_CONST,
+                   T_FUNCTION,
+                   T_VARIABLE,
+                   T_OPEN_TAG,
+                  );
         $tokens = $phpcsFile->getTokens();
 
         $commentEnd = $phpcsFile->findPrevious($find, ($stackPtr - 1));
         if ($commentEnd === false) {
             return;
         }
 
-        $conditions = $tokens[$commentEnd]['conditions'];
+        $conditions    = $tokens[$commentEnd]['conditions'];
         $lastCondition = array_pop($conditions);
         if ($lastCondition !== T_CLASS) {
             return;
@@ -97,20 +96,20 @@ protected function processTokenWithinScope(
 
             $isCommentOneLiner = $tokens[$commentStart]['line'] === $tokens[$commentEnd]['line'];
 
-            $length         = $commentEnd - $commentStart + 1;
+            $length         = ($commentEnd - $commentStart + 1);
             $tokensAsString = $phpcsFile->getTokensAsString(
                 $commentStart,
                 $length
             );
 
-            $varCount = count(preg_split('/\s+@var\s+/', $tokensAsString)) - 1;
+            $varCount = (count(preg_split('/\s+@var\s+/', $tokensAsString)) - 1);
             if ($varCount === 0) {
                 $phpcsFile->addError(
                     'property doc comment must have one @var annotation',
                     $commentStart,
                     'NoVarDefined'
                 );
-            } elseif ($varCount > 1) {
+            } else if ($varCount > 1) {
                 $phpcsFile->addError(
                     'property doc comment must no multiple @var annotations',
                     $commentStart,
@@ -119,41 +118,43 @@ protected function processTokenWithinScope(
             }
 
             if ($varCount === 1) {
-                if ($isCommentOneLiner) {
+                if ($isCommentOneLiner === true) {
                     $fix = $phpcsFile->addFixableError(
                         'property doc comment must be multi line',
                         $commentEnd,
                         'NotMultiLineDocBlock'
                     );
 
-                    if ($fix) {
+                    if ($fix === true) {
                         $phpcsFile->fixer->beginChangeset();
                         $phpcsFile->fixer->addContent($commentStart, "\n     *");
                         $phpcsFile->fixer->replaceToken(
-                            $commentEnd - 1,
-                            rtrim($tokens[$commentEnd - 1]['content'])
+                            ($commentEnd - 1),
+                            rtrim($tokens[($commentEnd - 1)]['content'])
                         );
                         $phpcsFile->fixer->addContentBefore($commentEnd, "\n     ");
                         $phpcsFile->fixer->endChangeset();
                     }
                 }
             } else {
-                if ($isCommentOneLiner) {
+                if ($isCommentOneLiner === true) {
                     $phpcsFile->addError(
                         'property doc comment must be multi line',
                         $commentEnd,
                         'NotMultiLineDocBlock'
                     );
                 }
-            }
-        } elseif ($code === T_COMMENT) {
+            }//end if
+        } else if ($code === T_COMMENT) {
             $commentStart = $phpcsFile->findPrevious(T_COMMENT, $commentEnd, null, true);
             $phpcsFile->addError(
                 'property doc comment must begin with /**',
-                $commentStart + 1,
+                ($commentStart + 1),
                 'NotADocBlock'
             );
-        }
-    }
-}
- 
+        }//end if
+
+    }//end processTokenWithinScope()
+
+
+}//end class

Sniffs/Formatting/AlphabeticalUseStatementsSniff.php

@@ -31,26 +31,27 @@ class MO4_Sniffs_Formatting_AlphabeticalUseStatementsSniff
     extends PSR2_Sniffs_Namespaces_UseDeclarationSniff
 {
     /**
-     * last use statement seen in group
+     * Last use statement seen in group
      *
      * @var string
      */
     private $_lastUseStatement = '';
 
     /**
-     * line number of the last seen use statement
+     * Line number of the last seen use statement
      *
      * @var int
      */
     private $_lastLine = -1;
 
     /**
-     * current file
+     * Current file
      *
      * @var string
      */
     private $_currentFile = null;
 
+
     /**
      * Processes this test, when one of its tokens is encountered.
      *
@@ -65,18 +66,22 @@ public function process(PHP_CodeSniffer_File $phpcsFile, $stackPtr)
         parent::process($phpcsFile, $stackPtr);
 
         if ($this->_currentFile !== $phpcsFile->getFilename()) {
-            $this->_lastLine = -1;
+            $this->_lastLine         = -1;
             $this->_lastUseStatement = '';
-            $this->_currentFile = $phpcsFile->getFilename();
+            $this->_currentFile      = $phpcsFile->getFilename();
         }
 
         $tokens = $phpcsFile->getTokens();
         $line   = $tokens[$stackPtr]['line'];
 
-        // ignore function () use () {...}
+        // Ignore function () use () {...}.
         $prev = $phpcsFile->findPrevious(
-            [T_WHITESPACE, T_COMMENT, T_DOC_COMMENT],
-            $stackPtr - 1,
+            [
+             T_WHITESPACE,
+             T_COMMENT,
+             T_DOC_COMMENT,
+            ],
+            ($stackPtr - 1),
             null,
             true,
             null,
@@ -91,14 +96,14 @@ public function process(PHP_CodeSniffer_File $phpcsFile, $stackPtr)
             }
         }
 
-        $start = $phpcsFile->findNext(T_STRING, $stackPtr + 1);
+        $start = $phpcsFile->findNext(T_STRING, ($stackPtr + 1));
         if ($start === false) {
             return;
         }
 
-        $end = $phpcsFile->findNext([T_AS, T_SEMICOLON, T_COMMA], $stackPtr + 1);
+        $end = $phpcsFile->findNext([T_AS, T_SEMICOLON, T_COMMA], ($stackPtr + 1));
 
-        $currentUseStatement = $phpcsFile->getTokensAsString($start, $end - $start);
+        $currentUseStatement = $phpcsFile->getTokensAsString($start, ($end - $start));
 
         if (($this->_lastLine + 1) < $line) {
             $this->_lastLine         = $line;
@@ -117,6 +122,8 @@ public function process(PHP_CodeSniffer_File $phpcsFile, $stackPtr)
 
         $this->_lastUseStatement = $currentUseStatement;
         $this->_lastLine         = $line;
-    }
-}
- 
+
+    }//end process()
+
+
+}//end class