Enhancement: Implement NoNullDefaultValueRule

.php_cs.fixture

@@ -3,6 +3,7 @@
 use Localheinz\PhpCsFixer\Config;
 
 $config = Config\Factory::fromRuleSet(new Config\RuleSet\Php71(''), [
+    'lowercase_constants' => false,
     'static_lambda' => false,
 ]);
 

CHANGELOG.md

@@ -7,7 +7,11 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## Unreleased
 
-For a full diff see [`0.2.0...master`](https://github.com/localheinz/phpstan-rules/compare/0.2.0...master).
+For a full diff see [`0.3.0...master`](https://github.com/localheinz/phpstan-rules/compare/0.3.0...master).
+
+## [`0.3.0`](https://github.com/localheinz/phpstan-rules/releases/tag/0.2.0)
+
+For a full diff see [`0.2.0...0.3.0`](https://github.com/localheinz/phpstan-rules/compare/0.2.0...0.3.0).
 
 ### Added
 
@@ -16,6 +20,9 @@ For a full diff see [`0.2.0...master`](https://github.com/localheinz/phpstan-rul
   `Methods\NoNullableReturnTypeDeclarationRule`, which reports an error
   when a method declared on an anonymous class, a class, or an interface has a
   nullable return type declaration ([#16](https://github.com/localheinz/phpstan-rules/pull/16)), by [@localheinz](https://github.com/localheinz)
+* added `Params\NoNullDefaultValueRule`, which reports an error when a
+  named function, or a method declared on an anonymous class, a class, or an
+  interface has a parameter with `null` as default value ([#26](https://github.com/localheinz/phpstan-rules/pull/26)), by [@localheinz](https://github.com/localheinz)
 
 ## [`0.2.0`](https://github.com/localheinz/phpstan-rules/releases/tag/0.2.0)
 

README.md

@@ -23,6 +23,7 @@ This package provides the following rules for use with [`phpstan/phpstan`](https
 * [`Localheinz\PHPStan\Rules\Classes\FinalRule`](https://github.com/localheinz/phpstan-rules#classesfinalrule)
 * [`Localheinz\PHPStan\Rules\Functions\NoNullableReturnTypeDeclarationRule`](https://github.com/localheinz/phpstan-rules#functionsnonullablereturntypedeclarationrule)
 * [`Localheinz\PHPStan\Rules\Methods\NoNullableReturnTypeDeclarationRule`](https://github.com/localheinz/phpstan-rules#methodsnonullablereturntypedeclarationrule)
+* [`Localheinz\PHPStan\Rules\Params\NoNullDefaultValueRule`](https://github.com/localheinz/phpstan-rules#paramsnonulldefaultvaluerule)
 
 ### `Classes\AbstractOrFinalRule`
 
@@ -96,6 +97,17 @@ rules:
 	- Localheinz\PHPStan\Rules\Methods\NoNullableReturnTypeDeclarationRule
 ```
 
+### `Params\NoNullDefaultValueRule`
+
+This rule reports an error when a named function, or a method declared on an anonymous class, a class, or an interface has a parameter with `null` as default value.
+
+If you want to use this rule, add it to your `phpstan.neon`:
+
+```neon
+rules:
+	- Localheinz\PHPStan\Rules\Params\NoNullDefaultValueRule
+```
+
 ## Changelog
 
 Please have a look at [`CHANGELOG.md`](CHANGELOG.md).

phpstan.neon

@@ -5,3 +5,4 @@ rules:
 	- Localheinz\PHPStan\Rules\Classes\AbstractOrFinalRule
 	- Localheinz\PHPStan\Rules\Functions\NoNullableReturnTypeDeclarationRule
 	- Localheinz\PHPStan\Rules\Methods\NoNullableReturnTypeDeclarationRule
+	- Localheinz\PHPStan\Rules\Params\NoNullDefaultValueRule

src/Params/NoNullDefaultValueRule.php

@@ -0,0 +1,56 @@
+<?php
+
+declare(strict_types=1);
+
+/**
+ * Copyright (c) 2018 Andreas Möller.
+ *
+ * For the full copyright and license information, please view
+ * the LICENSE file that was distributed with this source code.
+ *
+ * @see https://github.com/localheinz/phpstan-rules
+ */
+
+namespace Localheinz\PHPStan\Rules\Params;
+
+use PhpParser\Node;
+use PHPStan\Analyser\Scope;
+use PHPStan\Rules\Rule;
+
+final class NoNullDefaultValueRule implements Rule
+{
+    public function getNodeType(): string
+    {
+        return Node\Param::class;
+    }
+
+    /**
+     * @param Node\Param $node
+     * @param Scope      $scope
+     *
+     * @return array
+     */
+    public function processNode(Node $node, Scope $scope): array
+    {
+        if (!$node->var instanceof Node\Expr\Variable
+            || !\is_string($node->var->name)
+            || !$node->default instanceof Node\Expr\ConstFetch
+        ) {
+            return [];
+        }
+
+        /** @var Node\Expr\ConstFetch $default */
+        $default = $node->default;
+
+        if ('null' !== \mb_strtolower($default->name->toString())) {
+            return [];
+        }
+
+        return [
+            \sprintf(
+                'Parameter "%s" should not have null as default value.',
+                $node->var->name
+            ),
+        ];
+    }
+}

test/Fixture/Params/NoNullDefaultValueRule/Failure/MethodInClassWithParameterWithNullDefaultValue.php

@@ -0,0 +1,13 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Localheinz\PHPStan\Rules\Test\Fixture\Params\NoNullDefaultValueRule\Failure;
+
+final class MethodInClassWithParameterWithNullDefaultValue
+{
+    public function foo($bar = null)
+    {
+        return $bar;
+    }
+}

test/Fixture/Params/NoNullDefaultValueRule/Failure/MethodInClassWithParameterWithRootNamespaceReferencedNullDefaultValue.php

@@ -0,0 +1,13 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Localheinz\PHPStan\Rules\Test\Fixture\Params\NoNullDefaultValueRule\Failure;
+
+final class MethodInClassWithParameterWithRootNamespaceReferencedNullDefaultValue
+{
+    public function foo($bar = \null)
+    {
+        return $bar;
+    }
+}

test/Fixture/Params/NoNullDefaultValueRule/Failure/MethodInClassWithParameterWithWronglyCapitalizedNullDefaultValue.php

@@ -0,0 +1,13 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Localheinz\PHPStan\Rules\Test\Fixture\Params\NoNullDefaultValueRule\Failure;
+
+final class MethodInClassWithParameterWithWronglyCapitalizedNullDefaultValue
+{
+    public function foo($bar = NuLl)
+    {
+        return $bar;
+    }
+}

test/Fixture/Params/NoNullDefaultValueRule/Failure/MethodInInterfaceWithParameterWithNullDefaultValue.php

@@ -0,0 +1,10 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Localheinz\PHPStan\Rules\Test\Fixture\Params\NoNullDefaultValueRule\Failure;
+
+interface MethodInInterfaceWithParameterWithNullDefaultValue
+{
+    public function foo($bar = null);
+}

test/Fixture/Params/NoNullDefaultValueRule/Failure/MethodInInterfaceWithParameterWithRootNamespaceReferencedNullDefaultValue.php

@@ -0,0 +1,10 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Localheinz\PHPStan\Rules\Test\Fixture\Params\NoNullDefaultValueRule\Failure;
+
+interface MethodInInterfaceWithParameterWithRootNamespaceReferencedNullDefaultValue
+{
+    public function foo($bar = \null);
+}

test/Fixture/Params/NoNullDefaultValueRule/Failure/MethodInInterfaceWithParameterWithWronlgyCapitalizedNullDefaultValue.php

@@ -0,0 +1,10 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Localheinz\PHPStan\Rules\Test\Fixture\Params\NoNullDefaultValueRule\Failure;
+
+interface MethodInInterfaceWithParameterWithWronlgyCapitalizedNullDefaultValue
+{
+    public function foo($bar = NuLl);
+}

test/Fixture/Params/NoNullDefaultValueRule/Failure/method-in-anonymous-class-with-parameter-with-null-default-value.php

@@ -0,0 +1,12 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Localheinz\PHPStan\Rules\Test\Fixture\Params\NoNullDefaultValueRule\Failure;
+
+new class() {
+    public function foo($bar = null)
+    {
+        return $bar;
+    }
+};

test/Fixture/Params/NoNullDefaultValueRule/Failure/method-in-anonymous-class-with-parameter-with-root-namespace-referenced-null-default-value.php

@@ -0,0 +1,12 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Localheinz\PHPStan\Rules\Test\Fixture\Params\NoNullDefaultValueRule\Failure;
+
+new class() {
+    public function foo($bar = \null)
+    {
+        return $bar;
+    }
+};

test/Fixture/Params/NoNullDefaultValueRule/Failure/method-in-anonymous-class-with-parameter-with-wrongly-capitalized-null-default-value.php

@@ -0,0 +1,12 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Localheinz\PHPStan\Rules\Test\Fixture\Params\NoNullDefaultValueRule\Failure;
+
+new class() {
+    public function foo($bar = NuLl)
+    {
+        return $bar;
+    }
+};

test/Fixture/Params/NoNullDefaultValueRule/Failure/named-function-parameter-with-null-default-value.php

@@ -0,0 +1,10 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Localheinz\PHPStan\Rules\Test\Fixture\Params\NoNullDefaultValueRule\Failure;
+
+function foo($bar = null)
+{
+    return $bar;
+}

test/Fixture/Params/NoNullDefaultValueRule/Failure/named-function-parameter-with-root-namespace-referenced-null-default-value.php

@@ -0,0 +1,10 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Localheinz\PHPStan\Rules\Test\Fixture\Params\NoNullDefaultValueRule\Failure;
+
+function foo($bar = \null)
+{
+    return $bar;
+}

test/Fixture/Params/NoNullDefaultValueRule/Failure/named-function-parameter-with-wrongly-capitalized-null-default-value.php

@@ -0,0 +1,10 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Localheinz\PHPStan\Rules\Test\Fixture\Params\NoNullDefaultValueRule\Failure;
+
+function foo($bar = nUlL)
+{
+    return $bar;
+}

test/Fixture/Params/NoNullDefaultValueRule/Success/MethodInClassWithParameterWithNonNullDefaultValue.php

@@ -0,0 +1,13 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Localheinz\PHPStan\Rules\Test\Fixture\Params\NoNullDefaultValueRule\Success;
+
+final class MethodInClassWithParameterWithNonNullDefaultValue
+{
+    public function foo($bar = 'null')
+    {
+        return $bar;
+    }
+}

test/Fixture/Params/NoNullDefaultValueRule/Success/MethodInClassWithParameterWithoutDefaultValue.php

@@ -0,0 +1,13 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Localheinz\PHPStan\Rules\Test\Fixture\Params\NoNullDefaultValueRule\Success;
+
+final class MethodInClassWithParameterWithoutDefaultValue
+{
+    public function foo($bar)
+    {
+        return $bar;
+    }
+}

test/Fixture/Params/NoNullDefaultValueRule/Success/MethodInInterfaceWithParameterWithNonNullDefaultValue.php

@@ -0,0 +1,10 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Localheinz\PHPStan\Rules\Test\Fixture\Params\NoNullDefaultValueRule\Success;
+
+interface MethodInInterfaceWithParameterWithNonNullDefaultValue
+{
+    public function foo($bar = 'null');
+}

test/Fixture/Params/NoNullDefaultValueRule/Success/MethodInInterfaceWithParameterWithoutDefaultValue.php

@@ -0,0 +1,10 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Localheinz\PHPStan\Rules\Test\Fixture\Params\NoNullDefaultValueRule\Success;
+
+interface MethodInInterfaceWithParameterWithoutDefaultValue
+{
+    public function foo($bar);
+}

test/Fixture/Params/NoNullDefaultValueRule/Success/MethodInTraitWithParameterWithDefaultValue.php

@@ -0,0 +1,13 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Localheinz\PHPStan\Rules\Test\Fixture\Params\NoNullDefaultValueRule\Success;
+
+trait MethodInTraitWithParameterWithDefaultValue
+{
+    public function foo($bar = 'null')
+    {
+        return $bar;
+    }
+}

test/Fixture/Params/NoNullDefaultValueRule/Success/MethodInTraitWithParameterWithNonNullDefaultValue.php

@@ -0,0 +1,13 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Localheinz\PHPStan\Rules\Test\Fixture\Params\NoNullDefaultValueRule\Success;
+
+trait MethodInTraitWithParameterWithNonNullDefaultValue
+{
+    public function foo($bar = 'null')
+    {
+        return $bar;
+    }
+}

test/Fixture/Params/NoNullDefaultValueRule/Success/MethodInTraitWithParameterWithRootNamespaceReferencedNullDefaultValue.php

@@ -0,0 +1,13 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Localheinz\PHPStan\Rules\Test\Fixture\Params\NoNullDefaultValueRule\Success;
+
+trait MethodInTraitWithParameterWithRootNamespaceReferencedNullDefaultValue
+{
+    public function foo($bar = \null)
+    {
+        return $bar;
+    }
+}

test/Fixture/Params/NoNullDefaultValueRule/Success/MethodInTraitWithParameterWithWronlgyCapitalizedNullDefaultValue.php

@@ -0,0 +1,13 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Localheinz\PHPStan\Rules\Test\Fixture\Params\NoNullDefaultValueRule\Success;
+
+trait MethodInTraitWithParameterWithWronlgyCapitalizedNullDefaultValue
+{
+    public function foo($bar = NuLl)
+    {
+        return $bar;
+    }
+}

test/Fixture/Params/NoNullDefaultValueRule/Success/MethodInTraitWithParameterWithoutDefaultValue.php

@@ -0,0 +1,13 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Localheinz\PHPStan\Rules\Test\Fixture\Params\NoNullDefaultValueRule\Success;
+
+trait MethodInTraitWithParameterWithoutDefaultValue
+{
+    public function foo($bar)
+    {
+        return $bar;
+    }
+}

test/Fixture/Params/NoNullDefaultValueRule/Success/anonymous-function-parameter-with-non-null-default-value.php

@@ -0,0 +1,9 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Localheinz\PHPStan\Rules\Test\Fixture\Params\NoNullDefaultValueRule\Success;
+
+$foo = function ($bar = 'null') {
+    return $bar;
+};