Merge pull request #43 from kubawerlos/feature/no-nullable-booleans

Add NoNullableBooleanTypeFixer

Author: kubawerlos

CHANGELOG.md

@@ -1,5 +1,8 @@
 # CHANGELOG for PHP CS Fixer: custom fixers
 
+## [Unreleased]
+- Add NoNullableBooleanTypeFixer
+
 ## v1.8.0 - *2018-08-09*
 - Add PhpdocSelfAccessorFixer
 

README.md

@@ -83,6 +83,18 @@ In your PHP CS Fixer configuration register fixers and use them:
  $y = new \Baz();
 ```
 
+- **NoNullableBooleanTypeFixer** - there must be no nullable boolean type.
+
+  *Risky: when the null is used.*
+```diff
+ <?php
+-function foo(?bool $bar) : ?bool
++function foo(bool $bar) : bool
+ {
+      return $bar;
+  }
+```
+
 - **NoPhpStormGeneratedCommentFixer** - there must be no comment generated by PhpStorm.
 ```diff
  <?php

src/Fixer/NoNullableBooleanTypeFixer.php

@@ -0,0 +1,63 @@
+<?php
+
+declare(strict_types = 1);
+
+namespace PhpCsFixerCustomFixers\Fixer;
+
+use PhpCsFixer\FixerDefinition\CodeSample;
+use PhpCsFixer\FixerDefinition\FixerDefinition;
+use PhpCsFixer\Tokenizer\Tokens;
+
+final class NoNullableBooleanTypeFixer extends AbstractFixer
+{
+    public function getDefinition(): FixerDefinition
+    {
+        return new FixerDefinition(
+            'There must be no nullable boolean type.',
+            [new CodeSample('<?php
+function foo(?bool $bar) : ?bool
+{
+     return $bar;
+ }
+')],
+            null,
+            'When the null is used.'
+        );
+    }
+
+    public function isCandidate(Tokens $tokens): bool
+    {
+        return $tokens->isTokenKindFound(T_STRING);
+    }
+
+    public function isRisky(): bool
+    {
+        return true;
+    }
+
+    public function fix(\SplFileInfo $file, Tokens $tokens): void
+    {
+        foreach ($tokens as $index => $token) {
+            if ($token->getContent() !== '?') {
+                continue;
+            }
+
+            $nextIndex = $tokens->getNextMeaningfulToken($index);
+            if (!$tokens[$nextIndex]->equals([T_STRING, 'bool'], false) && !$tokens[$nextIndex]->equals([T_STRING, 'boolean'], false)) {
+                continue;
+            }
+
+            $nextNextIndex = $tokens->getNextMeaningfulToken($nextIndex);
+            if (!$tokens[$nextNextIndex]->isGivenKind(T_VARIABLE) && $tokens[$nextNextIndex]->getContent() !== '{') {
+                continue;
+            }
+
+            $tokens->clearTokenAndMergeSurroundingWhitespace($index);
+        }
+    }
+
+    public function getPriority(): int
+    {
+        return 0;
+    }
+}

tests/Fixer/NoNullableBooleanTypeFixerTest.php

@@ -0,0 +1,78 @@
+<?php
+
+declare(strict_types = 1);
+
+namespace Tests\Fixer;
+
+/**
+ * @internal
+ *
+ * @covers \PhpCsFixerCustomFixers\Fixer\NoNullableBooleanTypeFixer
+ */
+final class NoNullableBooleanTypeFixerTest extends AbstractFixerTestCase
+{
+    public function testPriority(): void
+    {
+        static::assertSame(0, $this->fixer->getPriority());
+    }
+
+    public function testIsRisky(): void
+    {
+        static::assertTrue($this->fixer->isRisky());
+    }
+
+    /**
+     * @param string      $expected
+     * @param string|null $input
+     *
+     * @dataProvider provideFixCases
+     */
+    public function testFix(string $expected, string $input = null): void
+    {
+        $this->doTest($expected, $input);
+    }
+
+    public function provideFixCases(): \Iterator
+    {
+        yield [
+            '<?php function foo(bool $b) {}',
+            '<?php function foo(?bool $b) {}',
+        ];
+
+        yield [
+            '<?php function foo(Bool $b) {}',
+            '<?php function foo(?Bool $b) {}',
+        ];
+
+        yield [
+            '<?php function foo(boolean $b) {}',
+            '<?php function foo(?boolean $b) {}',
+        ];
+
+        yield [
+            '<?php function foo() : bool {}',
+            '<?php function foo() : ?bool {}',
+        ];
+
+        yield [
+            '<?php function foo(bool $a, bool $b, bool $c, bool $d) {}',
+            '<?php function foo(?bool $a, ?bool $b, ?bool $c, ?bool $d) {}',
+        ];
+        yield [
+            '<?php function foo(  bool $b ) {}',
+            '<?php function foo( ? bool $b ) {}',
+        ];
+
+        yield [
+            '<?php function foo(?int $b) : ?string {}',
+        ];
+
+        yield [
+            '<?php FOO ? BOOL : BAR;',
+        ];
+
+        yield [
+            '<?php FOO ?: bool;',
+        ];
+    }
+}