use php-cs-fixer

Author: dbu

.github/workflows/static.yml

@@ -40,3 +40,16 @@ jobs:
         uses: docker://oskarstark/phpstan-ga:1.8.0
         with:
           args: analyze --no-progress -c phpstan.tests.neon.dist
+
+  php-cs-fixer:
+    name: PHP-CS-Fixer
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v3
+
+      - name: PHP-CS-Fixer
+        uses: docker://oskarstark/php-cs-fixer-ga
+        with:
+          args: --dry-run --diff

.gitignore

@@ -1,5 +1,5 @@
 cli-config.php
-
+.php-cs-fixer.cache
 vendor/
 composer.phar
-composer.lock
+composer.lock

.php-cs-fixer.dist.php

@@ -0,0 +1,18 @@
+<?php
+
+$finder = PhpCsFixer\Finder::create()
+    ->in(__DIR__.'/src')
+    ->in(__DIR__.'/tests')
+    ->name('*.php')
+;
+
+$config = new PhpCsFixer\Config();
+
+return $config
+    ->setRiskyAllowed(true)
+    ->setRules([
+        '@Symfony' => true,
+        'single_line_throw' => false,
+    ])
+    ->setFinder($finder)
+;

.styleci.yml

@@ -34,7 +34,8 @@
     "require-dev": {
         "ramsey/uuid": "^3.5",
         "phpunit/phpunit": "^7.5 || ^8.0 || ^9.0",
-        "phpstan/phpstan": "^1.9"
+        "phpstan/phpstan": "^1.9",
+        "friendsofphp/php-cs-fixer": "^3.40"
     },
     "suggest": {
         "ramsey/uuid": "A library for generating RFC 4122 version 1, 3, 4, and 5 universally unique identifiers (UUID)."

composer.json

@@ -19,7 +19,7 @@ public function __construct(TokenQueue $queue, $msg)
 
         // construct a lookup of the next tokens
         $lookup = '';
-        for ($i = 1; $i <= 5; $i++) {
+        for ($i = 1; $i <= 5; ++$i) {
             if ($queue->isEof()) {
                 break;
             }

src/PHPCR/Util/CND/Exception/ParserException.php

@@ -34,7 +34,7 @@ abstract class AbstractParser
      * Return false otherwise.
      *
      * @param int         $type       The expected token type
-     * @param null|string $data       The expected data or null
+     * @param string|null $data       The expected data or null
      * @param bool        $ignoreCase whether to do string comparisons case insensitive or sensitive
      *
      * @return bool
@@ -65,8 +65,7 @@ protected function checkToken($type, $data = null, $ignoreCase = false)
     /**
      * Check if the token data is one of the elements of the data array.
      *
-     * @param int   $type
-     * @param array $data
+     * @param int $type
      *
      * @return bool
      */
@@ -86,11 +85,11 @@ protected function checkTokenIn($type, array $data, $ignoreCase = false)
      * otherwise throw an exception.
      *
      * @param int         $type The expected token type
-     * @param null|string $data The expected token data or null
-     *
-     * @throws ParserException
+     * @param string|null $data The expected token data or null
      *
      * @return Token
+     *
+     * @throws ParserException
      */
     protected function expectToken($type, $data = null)
     {
@@ -110,7 +109,7 @@ protected function expectToken($type, $data = null)
      * return false.
      *
      * @param int         $type The expected token type
-     * @param null|string $data The expected token data or null
+     * @param string|null $data The expected token data or null
      *
      * @return bool|Token
      */

src/PHPCR/Util/CND/Parser/AbstractParser.php

@@ -35,30 +35,30 @@
 class CndParser extends AbstractParser
 {
     // node type attributes
-    private $ORDERABLE = ['o', 'ord', 'orderable']; //, 'variant' => true);
-    private $MIXIN = ['m', 'mix', 'mixin']; //, 'variant' => true);
-    private $ABSTRACT = ['a', 'abs', 'abstract']; //, 'variant' => true);
-    private $NOQUERY = ['noquery', 'nq']; //, 'variant' => false);
-    private $QUERY = ['query', 'q']; //, 'variant' => false);
-    private $PRIMARYITEM = ['primaryitem', '!']; //, 'variant' => false);
+    private $ORDERABLE = ['o', 'ord', 'orderable']; // , 'variant' => true);
+    private $MIXIN = ['m', 'mix', 'mixin']; // , 'variant' => true);
+    private $ABSTRACT = ['a', 'abs', 'abstract']; // , 'variant' => true);
+    private $NOQUERY = ['noquery', 'nq']; // , 'variant' => false);
+    private $QUERY = ['query', 'q']; // , 'variant' => false);
+    private $PRIMARYITEM = ['primaryitem', '!']; // , 'variant' => false);
 
     // common for properties and child definitions
-    private $PRIMARY = ['!', 'pri', 'primary']; //, 'variant' => true),
-    private $AUTOCREATED = ['a', 'aut', 'autocreated']; //, 'variant' => true),
-    private $MANDATORY = ['m', 'man', 'mandatory']; //, 'variant' => true),
-    private $PROTECTED = ['p', 'pro', 'protected']; //, 'variant' => true),
+    private $PRIMARY = ['!', 'pri', 'primary']; // , 'variant' => true),
+    private $AUTOCREATED = ['a', 'aut', 'autocreated']; // , 'variant' => true),
+    private $MANDATORY = ['m', 'man', 'mandatory']; // , 'variant' => true),
+    private $PROTECTED = ['p', 'pro', 'protected']; // , 'variant' => true),
     private $OPV = ['COPY', 'VERSION', 'INITIALIZE', 'COMPUTE', 'IGNORE', 'ABORT'];
 
     // property type attributes
-    private $MULTIPLE = ['*', 'mul', 'multiple']; //, 'variant' => true),
-    private $QUERYOPS = ['qop', 'queryops']; //, 'variant' => true), // Needs special handling !
-    private $NOFULLTEXT = ['nof', 'nofulltext']; //, 'variant' => true),
-    private $NOQUERYORDER = ['nqord', 'noqueryorder']; //, 'variant' => true),
+    private $MULTIPLE = ['*', 'mul', 'multiple']; // , 'variant' => true),
+    private $QUERYOPS = ['qop', 'queryops']; // , 'variant' => true), // Needs special handling !
+    private $NOFULLTEXT = ['nof', 'nofulltext']; // , 'variant' => true),
+    private $NOQUERYORDER = ['nqord', 'noqueryorder']; // , 'variant' => true),
 
     // child node attributes
     // multiple is actually a jackrabbit specific synonym for sns
     // http://www.mail-archive.com/users@jackrabbit.apache.org/msg19268.html
-    private $SNS = ['*', 'sns', 'multiple']; //, 'variant' => true),
+    private $SNS = ['*', 'sns', 'multiple']; // , 'variant' => true),
 
     /**
      * @var NodeTypeManagerInterface
@@ -75,9 +75,6 @@ class CndParser extends AbstractParser
      */
     protected $nodeTypes = [];
 
-    /**
-     * @param NodeTypeManagerInterface $ntm
-     */
     public function __construct(NodeTypeManagerInterface $ntm)
     {
         $this->ntm = $ntm;
@@ -130,7 +127,7 @@ private function parse(ReaderInterface $reader)
 
         return [
             'namespaces' => $this->namespaces,
-            'nodeTypes'  => $this->nodeTypes,
+            'nodeTypes' => $this->nodeTypes,
         ];
     }
 
@@ -350,7 +347,7 @@ protected function parsePropDef(NodeTypeTemplateInterface $nodeType)
         // Next token is '<' and two token later it's not '=', i.e. not '<ident='
         $next1 = $this->tokenQueue->peek();
         $next2 = $this->tokenQueue->peek(2);
-        if ($next1 && $next1->getData() === '<' && (!$next2 || $next2->getData() !== '=')) {
+        if ($next1 && '<' === $next1->getData() && (!$next2 || '=' !== $next2->getData())) {
             $this->parseValueConstraints($property);
         }
     }
@@ -678,21 +675,21 @@ protected function parseCndString()
             $type = $token->getType();
             $data = $token->getData();
 
-            if ($type === Token::TK_STRING) {
+            if (Token::TK_STRING === $type) {
                 $string = substr($data, 1, -1);
                 $this->tokenQueue->next();
 
                 return $string;
             }
 
             // If it's not an identifier or a symbol allowed in a string, break
-            if ($type !== Token::TK_IDENTIFIER && $type !== Token::TK_SYMBOL
-            || ($type === Token::TK_SYMBOL && $data !== '_' && $data !== ':')) {
+            if (Token::TK_IDENTIFIER !== $type && Token::TK_SYMBOL !== $type
+            || (Token::TK_SYMBOL === $type && '_' !== $data && ':' !== $data)) {
                 break;
             }
 
             // Detect spaces (an identifier cannot be followed by an identifier as it would have been read as a single token)
-            if ($type === Token::TK_IDENTIFIER && $lastType === Token::TK_IDENTIFIER) {
+            if (Token::TK_IDENTIFIER === $type && Token::TK_IDENTIFIER === $lastType) {
                 break;
             }
 
@@ -702,7 +699,7 @@ protected function parseCndString()
             $lastType = $type;
         }
 
-        if ($string === '') {
+        if ('' === $string) {
             throw new ParserException($this->tokenQueue, sprintf("Expected CND string, found '%s': ", $this->tokenQueue->peek()->getData()));
         }
 
@@ -752,10 +749,10 @@ protected function parseQueryOperator()
 
         switch ($data) {
             case '<':
-                $op = ($nextData === '>' ? '>=' : ($nextData === '=' ? '<=' : '<'));
+                $op = ('>' === $nextData ? '>=' : ('=' === $nextData ? '<=' : '<'));
                 break;
             case '>':
-                $op = ($nextData === '=' ? '>=' : '>');
+                $op = ('=' === $nextData ? '>=' : '>');
                 break;
             case '=':
                 $op = '=';
@@ -766,9 +763,9 @@ protected function parseQueryOperator()
         }
 
         // Consume the correct number of tokens
-        if ($op === 'LIKE' || strlen($op) === 1) {
+        if ('LIKE' === $op || 1 === strlen($op)) {
             $this->tokenQueue->next();
-        } elseif (strlen($op) === 2) {
+        } elseif (2 === strlen($op)) {
             $this->tokenQueue->next();
             $this->tokenQueue->next();
         }

src/PHPCR/Util/CND/Parser/CndParser.php

@@ -115,6 +115,7 @@ public function currentChar()
     public function isEof()
     {
         $currentChar = $this->currentChar();
+
         // substr after end of string returned false in PHP 5 and returns '' since PHP 7
         return in_array($currentChar, [$this->getEofMarker(), false, ''], true)
             || $this->startPos > strlen($this->buffer)
@@ -129,12 +130,12 @@ public function isEof()
     public function forward()
     {
         if ($this->forwardPos < strlen($this->buffer)) {
-            $this->forwardPos++;
-            $this->nextCurCol++;
+            ++$this->forwardPos;
+            ++$this->nextCurCol;
         }
 
-        if ($this->current() === "\n") {
-            $this->nextCurLine++;
+        if ("\n" === $this->current()) {
+            ++$this->nextCurLine;
             $this->nextCurCol = 1;
         }
 

src/PHPCR/Util/CND/Reader/BufferReader.php

@@ -30,8 +30,6 @@ public function resetQueue()
     }
 
     /**
-     * @param Token $token
-     *
      * @return Token|void
      */
     public function applyFilters(Token $token)

src/PHPCR/Util/CND/Scanner/AbstractScanner.php

@@ -143,9 +143,6 @@ public function getWhitespaces()
         return $this->whitespaces;
     }
 
-    /**
-     * @param TokenFilterInterface $filter
-     */
     public function addTokenFilter(TokenFilterInterface $filter)
     {
         $this->tokenFilters[] = $filter;