Adding support for DateTime and DateTimeImmutable

An additional rule is added to detect instantiation of DateTime or DateTimeImmutable (instead of Safe\DateTime or any other subclass)

Author: moufmouf

src/Rules/UseSafeClassesRule.php

@@ -0,0 +1,49 @@
+<?php
+
+
+namespace TheCodingMachine\Safe\PHPStan\Rules;
+
+use PhpParser\Node;
+use PHPStan\Analyser\Scope;
+use PHPStan\Reflection\FunctionReflection;
+use PHPStan\Reflection\MethodReflection;
+use PHPStan\Rules\Rule;
+use PHPStan\ShouldNotHappenException;
+use TheCodingMachine\Safe\PHPStan\Utils\ClassListLoader;
+use TheCodingMachine\Safe\PHPStan\Utils\FunctionListLoader;
+use PhpParser\Node\Arg;
+use PhpParser\Node\Expr;
+use PhpParser\Node\Scalar;
+
+/**
+ * This rule checks that no "unsafe" classes are instantiated in code.
+ */
+class UseSafeClassesRule implements Rule
+{
+    public function getNodeType(): string
+    {
+        return Node\Expr\New_::class;
+    }
+
+    /**
+     * @param Node\Expr\New_ $node
+     * @param \PHPStan\Analyser\Scope $scope
+     * @return string[]
+     */
+    public function processNode(Node $node, Scope $scope): array
+    {
+        $classNode = $node->class;
+        if (!$classNode instanceof Node\Name) {
+            return [];
+        }
+
+        $className = $classNode->toString();
+        $unsafeClasses = ClassListLoader::getClassList();
+
+        if (isset($unsafeClasses[$className])) {
+            return ["Class $className is unsafe to use. Its methods can return FALSE instead of throwing an exception. Please add 'use Safe\\$className;' at the beginning of the file to use the variant provided by the 'thecodingmachine/safe' library."];
+        }
+
+        return [];
+    }
+}

src/Utils/ClassListLoader.php

@@ -0,0 +1,24 @@
+<?php
+
+
+namespace TheCodingMachine\Safe\PHPStan\Utils;
+
+use PHPStan\Analyser\Scope;
+use PHPStan\Reflection\FunctionReflection;
+use PHPStan\Reflection\MethodReflection;
+
+class ClassListLoader
+{
+    private static $classes = [
+        'DateTime' => 'DateTime',
+        'DateTimeImmutable' => 'DateTimeImmutable',
+    ];
+
+    /**
+     * @return string[]
+     */
+    public static function getClassList(): array
+    {
+        return self::$classes;
+    }
+}

tests/Rules/UseSafeClassesRuleTest.php

@@ -0,0 +1,28 @@
+<?php
+
+namespace TheCodingMachine\Safe\PHPStan\Rules;
+
+use PHPStan\Testing\RuleTestCase;
+use TheCodingMachine\Safe\PHPStan\Type\Php\ReplaceSafeFunctionsDynamicReturnTypeExtension;
+
+class UseSafeClassesRuleTest extends RuleTestCase
+{
+    protected function getRule(): \PHPStan\Rules\Rule
+    {
+        return new UseSafeClassesRule();
+    }
+
+    public function testDateTime()
+    {
+        $this->analyse([__DIR__ . '/data/datetime.php'], [
+            [
+                "Class DateTime is unsafe to use. Its methods can return FALSE instead of throwing an exception. Please add 'use Safe\DateTime;' at the beginning of the file to use the variant provided by the 'thecodingmachine/safe' library.",
+                3,
+            ],
+            [
+                "Class DateTimeImmutable is unsafe to use. Its methods can return FALSE instead of throwing an exception. Please add 'use Safe\DateTimeImmutable;' at the beginning of the file to use the variant provided by the 'thecodingmachine/safe' library.",
+                4,
+            ],
+        ]);
+    }
+}

tests/Rules/data/datetime.php

@@ -0,0 +1,6 @@
+<?php
+
+$date = new DateTime();
+$dateImmutable = new DateTimeImmutable();
+$safeDate = new Safe\DateTime();
+$safeDateImmutable = new Safe\DateTimeImmutable();