Initial commit

Author: kubawerlos

.gitattributes

@@ -0,0 +1,5 @@
+/src/Readme/ export-ignore
+/tests/ export-ignore
+/.gitattributes export-ignore
+/.gitignore export-ignore
+/.travis.yml export-ignore

.gitignore

@@ -0,0 +1,2 @@
+/vendor/
+/composer.lock

.travis.yml

@@ -0,0 +1,33 @@
+git:
+    depth: 1
+
+cache:
+    directories:
+        - $HOME/.composer/cache
+
+sudo: false
+
+language: php
+
+notifications:
+    email: false
+
+before_install:
+    - composer self-update --stable
+
+matrix:
+    include:
+        - php: '7.1'
+          install: composer update --prefer-lowest
+        - php: '7.1'
+        - php: '7.2'
+
+install:
+    - composer install
+
+script:
+    - vendor/bin/phpcs --report-full --standard=PSR2 src tests
+    - vendor/bin/php-cs-fixer fix --config=tests/php-cs-fixer.config.php --diff --dry-run
+    - vendor/bin/types-checker src tests
+    - vendor/bin/psalm --config=tests/psalm.xml
+    - phpdbg -qrr vendor/bin/phpunit --configuration=tests

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2018 Kuba Werłos
+
+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

@@ -0,0 +1,94 @@
+# PHP CS Fixer: custom fixers
+
+[![Latest Stable Version](https://img.shields.io/packagist/v/kubawerlos/php-cs-fixer-custom-fixers.svg)](https://packagist.org/packages/kubawerlos/php-cs-fixer-custom-fixers)
+[![PHP Version](https://img.shields.io/badge/php-%5E7.1-8892BF.svg)](https://php.net)
+[![License](https://img.shields.io/github/license/kubawerlos/php-cs-fixer-custom-fixers.svg)](https://packagist.org/packages/kubawerlos/php-cs-fixer-custom-fixers)
+[![Build Status](https://img.shields.io/travis/kubawerlos/php-cs-fixer-custom-fixers/master.svg)](https://travis-ci.org/kubawerlos/php-cs-fixer-custom-fixers)
+
+A set of custom fixers for [PHP CS Fixer](https://github.com/FriendsOfPHP/PHP-CS-Fixer).
+
+## Installation
+PHP CS Fixer custom fixers can be installed by running:
+```bash
+composer require --dev kubawerlos/php-cs-fixer-custom-fixers
+```
+
+
+## Usage
+In your PHP CS Fixer configuration register fixers and use them:
+```diff
+ <?php
+ 
+ return PhpCsFixer\Config::create()
++    ->registerCustomFixers(new PhpCsFixerCustomFixers\Fixers())
+     ->setRules([
+         '@PSR2' => true,
+         'array_syntax' => ['syntax' => 'short'],
++        PhpCsFixerCustomFixers\Fixer\NoLeadingSlashInGlobalNamespaceFixer::name() => true,
++        PhpCsFixerCustomFixers\Fixer\NoTwoConsecutiveEmptyLinesFixer::name() => true,
+     ]);
+
+```
+
+
+## Fixers
+- **NoLeadingSlashInGlobalNamespaceFixer** - when in global namespace there should be no leading slash for class.
+```diff
+ <?php 
+-$x = new \Foo();
++$x = new Foo();
+ namespace Bar;
+ $y = new \Baz();
+
+```
+
+- **NoPhpStormGeneratedCommentFixer** - there should be no comment generated by PhpStorm.
+```diff
+ <?php
+-/**
+- * Created by PhpStorm.
+- * User: root
+- * Date: 01.01.70
+- * Time: 12:00
+- */
+ namespace Foo;
+
+```
+
+- **NoTwoConsecutiveEmptyLinesFixer** - there should be no two consecutive empty lines in code.
+```diff
+ <?php
+ namespace Foo;
+ 
+-
+ class Foo {};
+
+```
+
+- **NoUselessClassCommentFixer** - there should be no comment like: "Class Foo\Bar".
+```diff
+ <?php
+ /**
+- * Class Foo\Bar
+  * Class to do something
+  */
+
+```
+
+
+## Contributing
+Request a feature or report a bug by creating [issue](https://github.com/kubawerlos/php-cs-fixer-custom-fixers/issues).
+
+Alternatively, fork the repo, develop your changes, regenerate `README.md`:
+```bash
+src/Readme/run > README.md
+```
+make sure all checks pass:
+```bash
+vendor/bin/phpcs --report-full --standard=PSR2 src tests
+vendor/bin/php-cs-fixer fix --config=tests/php-cs-fixer.config.php --diff --dry-run
+vendor/bin/types-checker src tests
+vendor/bin/psalm --config=tests/psalm.xml
+phpdbg -qrr vendor/bin/phpunit --configuration=tests
+```
+and submit a pull request.

composer.json

@@ -0,0 +1,42 @@
+{
+    "name": "kubawerlos/php-cs-fixer-custom-fixers",
+    "description": "A set of custom fixers for PHP CS Fixer",
+    "type": "library",
+    "keywords": [
+        "fixer",
+        "php-cs-fixer"
+    ],
+    "license": "MIT",
+    "authors": [
+        {
+            "name": "Kuba Werłos",
+            "email": "[email protected]"
+        }
+    ],
+    "require": {
+        "php": "^7.1",
+        "ext-json": "*",
+        "ext-tokenizer": "*",
+        "friendsofphp/php-cs-fixer": "^2.11"
+    },
+    "require-dev": {
+        "kubawerlos/types-checker": "^1.1",
+        "phpunit/phpunit": "^7.1",
+        "sebastian/diff": "^3.0",
+        "squizlabs/php_codesniffer": "^3.2",
+        "symfony/console": "^4.0",
+        "symfony/finder": "^4.0",
+        "symfony/yaml": "^4.0",
+        "vimeo/psalm": "^2.0"
+    },
+    "autoload": {
+        "psr-4": {
+            "PhpCsFixerCustomFixers\\": "src/"
+        }
+    },
+    "autoload-dev": {
+        "psr-4": {
+            "Tests\\": "tests/"
+        }
+    }
+}

src/Fixer/AbstractFixer.php

@@ -0,0 +1,36 @@
+<?php
+
+declare(strict_types = 1);
+
+namespace PhpCsFixerCustomFixers\Fixer;
+
+use PhpCsFixer\Fixer\DefinedFixerInterface;
+
+abstract class AbstractFixer implements DefinedFixerInterface
+{
+    final public static function name() : string
+    {
+        return 'PhpCsFixerCustomFixers/' . \preg_replace_callback(
+            '/(^|[a-z0-9])([A-Z])/',
+            static function (array $matches) : string {
+                return \strtolower($matches[1] !== '' ? $matches[1] . '_' . $matches[2] : $matches[2]);
+            },
+            \preg_replace('/^.*\\\\([a-zA-Z0-1]+)Fixer$/', '$1', static::class)
+        );
+    }
+
+    final public function getName() : string
+    {
+        return self::name();
+    }
+
+    final public function isRisky() : bool
+    {
+        return false;
+    }
+
+    final public function supports(\SplFileInfo $file) : bool
+    {
+        return true;
+    }
+}

src/Fixer/NoLeadingSlashInGlobalNamespaceFixer.php

@@ -0,0 +1,55 @@
+<?php
+
+declare(strict_types = 1);
+
+namespace PhpCsFixerCustomFixers\Fixer;
+
+use PhpCsFixer\FixerDefinition\CodeSample;
+use PhpCsFixer\FixerDefinition\FixerDefinition;
+use PhpCsFixer\Tokenizer\Tokens;
+
+final class NoLeadingSlashInGlobalNamespaceFixer extends AbstractFixer
+{
+    public function getDefinition() : FixerDefinition
+    {
+        return new FixerDefinition(
+            'When in global namespace there should be no leading slash for class.',
+            [new CodeSample('<?php 
+$x = new \Foo();
+namespace Bar;
+$y = new \Baz();
+')]
+        );
+    }
+
+    public function isCandidate(Tokens $tokens) : bool
+    {
+        return $tokens->isTokenKindFound(T_NS_SEPARATOR);
+    }
+
+    public function fix(\SplFileInfo $file, Tokens $tokens) : void
+    {
+        foreach ($tokens as $index => $token) {
+            if ($token->isGivenKind(T_NAMESPACE)) {
+                return;
+            }
+
+            if (!$token->isGivenKind(T_NS_SEPARATOR)) {
+                continue;
+            }
+
+            $prevIndex = $tokens->getPrevMeaningfulToken($index);
+            if ($tokens[$prevIndex]->isGivenKind(T_STRING)) {
+                continue;
+            }
+
+            $tokens->clearTokenAndMergeSurroundingWhitespace($index);
+        }
+    }
+
+    public function getPriority() : int
+    {
+        // must be run before PhpdocToCommentFixer
+        return 26;
+    }
+}

src/Fixer/NoPhpStormGeneratedCommentFixer.php

@@ -0,0 +1,100 @@
+<?php
+
+declare(strict_types = 1);
+
+namespace PhpCsFixerCustomFixers\Fixer;
+
+use PhpCsFixer\FixerDefinition\CodeSample;
+use PhpCsFixer\FixerDefinition\FixerDefinition;
+use PhpCsFixer\Tokenizer\Token;
+use PhpCsFixer\Tokenizer\Tokens;
+
+final class NoPhpStormGeneratedCommentFixer extends AbstractFixer
+{
+    public function getDefinition() : FixerDefinition
+    {
+        return new FixerDefinition(
+            'There should be no comment generated by PhpStorm.',
+            [new CodeSample('<?php
+/**
+ * Created by PhpStorm.
+ * User: root
+ * Date: 01.01.70
+ * Time: 12:00
+ */
+namespace Foo;
+')]
+        );
+    }
+
+    public function isCandidate(Tokens $tokens) : bool
+    {
+        return $tokens->isAnyTokenKindsFound([T_COMMENT, T_DOC_COMMENT]);
+    }
+
+    public function fix(\SplFileInfo $file, Tokens $tokens) : void
+    {
+        foreach ($tokens as $index => $token) {
+            if (!$tokens[$index]->isGivenKind([T_COMMENT, T_DOC_COMMENT])) {
+                continue;
+            }
+
+            if (\preg_match('/\*\h+Created by PhpStorm/i', $token->getContent(), $matches) !== 1) {
+                continue;
+            }
+
+            $this->removeTrailingHorizontalWhitespaces($tokens, $index - 1);
+
+            $this->removeLeadingNewline($tokens, $index + 1);
+
+            $tokens->clearTokenAndMergeSurroundingWhitespace($index);
+        }
+    }
+
+    public function getPriority() : int
+    {
+        return 0;
+    }
+
+    private function removeTrailingHorizontalWhitespaces(Tokens $tokens, int $index) : void
+    {
+        if (!$tokens[$index]->isGivenKind(T_WHITESPACE)) {
+            return;
+        }
+
+        $newContent = \preg_replace('/\h+$/', '', $tokens[$index]->getContent());
+
+        if (empty($newContent)) {
+            $tokens->clearAt($index);
+
+            return;
+        }
+
+        if ($newContent === $tokens[$index]->getContent()) {
+            return;
+        }
+
+        $tokens[$index] = new Token([T_WHITESPACE, $newContent]);
+    }
+
+    private function removeLeadingNewline(Tokens $tokens, int $index) : void
+    {
+        if (!$tokens[$index]->isGivenKind(T_WHITESPACE)) {
+            return;
+        }
+
+        $newContent = \preg_replace('/^\h*\R/', '', $tokens[$index]->getContent());
+
+        if ($newContent === $tokens[$index]->getContent()) {
+            return;
+        }
+
+        if (empty($newContent)) {
+            $tokens->clearAt($index);
+
+            return;
+        }
+
+        $tokens[$index] = new Token([T_WHITESPACE, $newContent]);
+    }
+}