Merge pull request #127 from ongr-io/master

2.1.2 Release request

Author: saimaz

.gitignore

@@ -1,6 +1,3 @@
-/.idea
 /vendor
 /composer.lock
-
 /phpunit.xml
-/Tests/Build

.travis.yml

@@ -3,10 +3,16 @@ php:
   - 5.4
   - 5.5
   - 5.6
+  - 7.0
+  - hhvm
+
+matrix:
+  allow_failures:
+    - php: hhvm
+    - php: 7.0
+
 before_script:
-  - $TRAVIS_BUILD_DIR/travis.sh
-  - cd $TRAVIS_BUILD_DIR/../Ongr/
-  - composer self-update
-  - composer update --prefer-source
+  - composer install
+
 script:
-  - vendor/bin/phpunit Tests/AllTests.php
+  - vendor/bin/phpunit

Sniffs/Arrays/ArrayDeclarationSniff.php renamed to Ongr/Sniffs/Arrays/ArrayDeclarationSniff.php

@@ -0,0 +1,170 @@
+<?php
+/**
+ * Ongr_Sniffs_Commenting_EmptyCatchCommentSniff.
+ *
+ * PHP version 5
+ *
+ * @category  PHP
+ * @package   PHP_CodeSniffer
+ * @author    Greg Sherwood <[email protected]>
+ * @author    Marc McIntyre <[email protected]>
+ * @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
+ */
+
+/**
+ * Ongr_Sniffs_Commenting_DocCommentAlignmentSniff.
+ *
+ * Tests that the stars in a doc comment align correctly.
+ *
+ * @category  PHP
+ * @package   PHP_CodeSniffer
+ * @author    Greg Sherwood <[email protected]>
+ * @author    Marc McIntyre <[email protected]>
+ * @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 Ongr_Sniffs_Commenting_DocCommentAlignmentSniff implements PHP_CodeSniffer_Sniff
+{
+
+    /**
+     * A list of tokenizers this sniff supports.
+     *
+     * @var array
+     */
+    public $supportedTokenizers = array(
+                                   'PHP',
+                                   'JS',
+                                  );
+
+
+    /**
+     * Returns an array of tokens this test wants to listen for.
+     *
+     * @return array
+     */
+    public function register()
+    {
+        return array(T_DOC_COMMENT_OPEN_TAG);
+
+    }//end register()
+
+
+    /**
+     * 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)
+    {
+        $tokens = $phpcsFile->getTokens();
+
+        // We are only interested in function/class/interface doc block comments.
+        $ignore = PHP_CodeSniffer_Tokens::$emptyTokens;
+        if ($phpcsFile->tokenizerType === 'JS') {
+            $ignore[] = T_EQUAL;
+            $ignore[] = T_STRING;
+            $ignore[] = T_OBJECT_OPERATOR;
+        }
+
+        $nextToken = $phpcsFile->findNext($ignore, ($stackPtr + 1), null, true);
+        $ignore    = array(
+                      T_CLASS     => true,
+                      T_INTERFACE => true,
+                      T_FUNCTION  => true,
+                      T_PUBLIC    => true,
+                      T_PRIVATE   => true,
+                      T_PROTECTED => true,
+                      T_STATIC    => true,
+                      T_ABSTRACT  => true,
+                      T_PROPERTY  => true,
+                      T_OBJECT    => true,
+                      T_PROTOTYPE => true,
+                     );
+
+        if (isset($ignore[$tokens[$nextToken]['code']]) === false) {
+            // Could be a file comment.
+            $prevToken = $phpcsFile->findPrevious(PHP_CodeSniffer_Tokens::$emptyTokens, ($stackPtr - 1), null, true);
+            if ($tokens[$prevToken]['code'] !== T_OPEN_TAG) {
+                return;
+            }
+        }
+
+        // There must be one space after each star (unless it is an empty comment line)
+        // and all the stars must be aligned correctly.
+        $requiredColumn = ($tokens[$stackPtr]['column'] + 1);
+        $endComment     = $tokens[$stackPtr]['comment_closer'];
+        for ($i = ($stackPtr + 1); $i <= $endComment; $i++) {
+            if ($tokens[$i]['code'] !== T_DOC_COMMENT_STAR
+                && $tokens[$i]['code'] !== T_DOC_COMMENT_CLOSE_TAG
+            ) {
+                continue;
+            }
+
+            if ($tokens[$i]['code'] === T_DOC_COMMENT_CLOSE_TAG) {
+                // Can't process the close tag if it is not the first thing on the line.
+                $prev = $phpcsFile->findPrevious(T_DOC_COMMENT_WHITESPACE, ($i - 1), $stackPtr, true);
+                if ($tokens[$prev]['line'] === $tokens[$i]['line']) {
+                    continue;
+                }
+            }
+
+            if ($tokens[$i]['column'] !== $requiredColumn) {
+                $error = 'Expected %s space(s) before asterisk; %s found';
+                $data  = array(
+                          ($requiredColumn - 1),
+                          ($tokens[$i]['column'] - 1),
+                         );
+                $fix   = $phpcsFile->addFixableError($error, $i, 'SpaceBeforeStar', $data);
+                if ($fix === true) {
+                    $padding = str_repeat(' ', ($requiredColumn - 1));
+                    if ($tokens[$i]['column'] === 1) {
+                        $phpcsFile->fixer->addContentBefore($i, $padding);
+                    } else {
+                        $phpcsFile->fixer->replaceToken(($i - 1), $padding);
+                    }
+                }
+            }
+
+            if ($tokens[$i]['code'] !== T_DOC_COMMENT_STAR) {
+                continue;
+            }
+
+            if ($tokens[($i + 2)]['line'] !== $tokens[$i]['line']) {
+                // Line is empty.
+                continue;
+            }
+            //ONGR get last character on previous line.
+            $lastVarEnding = substr($tokens[$i - 3]['content'], -1);
+            if ($tokens[($i + 1)]['code'] !== T_DOC_COMMENT_WHITESPACE) {
+                $error = 'Expected 1 space after asterisk; 0 found';
+                $fix   = $phpcsFile->addFixableError($error, $i, 'NoSpaceAfterStar');
+                if ($fix === true) {
+                    $phpcsFile->fixer->addContent($i, ' ');
+                }
+            } else if ($tokens[($i + 2)]['code'] === T_DOC_COMMENT_TAG
+                && $tokens[($i + 1)]['content'] !== ' '
+                //ONGR we allow more spaces after asterisk if tags represented as in array.
+                && $lastVarEnding !== '{'
+                && $lastVarEnding !== ','
+            ) {
+                $error = 'Expected 1 space after asterisk; %s found   1 '.$lastVarEnding;
+                $data  = array(strlen($tokens[($i + 1)]['content']));
+                $fix   = $phpcsFile->addFixableError($error, $i, 'SpaceAfterStar', $data);
+                if ($fix === true) {
+                    $phpcsFile->fixer->replaceToken(($i + 1), ' ');
+                }
+            }
+        }//end for
+
+    }//end process()
+
+
+}//end class