From 3b9e08f1ea96bddd1b6382246a7b398bbb9a89ad Mon Sep 17 00:00:00 2001
From: Christoph Wurst <christoph@winzerhof-wurst.at>
Date: Sun, 15 Sep 2024 17:29:22 +0200
Subject: [PATCH] feat: Refactor ILogger::* constants to PSR log levels

Signed-off-by: Christoph Wurst <christoph@winzerhof-wurst.at>
---
 .../nextcloud-31-deprecations.php             | 10 +++
 src/Rector/ILoggerToPsrLoggerLevelsRector.php | 81 +++++++++++++++++++
 src/Set/NextcloudSets.php                     |  1 +
 .../Fixture/test_fixture.php.inc              | 35 ++++++++
 .../ILoggerToPsrLoggerLevelsRectorTest.php    | 28 +++++++
 .../config/config.php                         | 11 +++
 6 files changed, 166 insertions(+)
 create mode 100644 config/nextcloud-31/nextcloud-31-deprecations.php
 create mode 100644 src/Rector/ILoggerToPsrLoggerLevelsRector.php
 create mode 100644 tests/Rector/ILoggerToPsrLoggerLevelsRector/Fixture/test_fixture.php.inc
 create mode 100644 tests/Rector/ILoggerToPsrLoggerLevelsRector/ILoggerToPsrLoggerLevelsRectorTest.php
 create mode 100644 tests/Rector/ILoggerToPsrLoggerLevelsRector/config/config.php

diff --git a/config/nextcloud-31/nextcloud-31-deprecations.php b/config/nextcloud-31/nextcloud-31-deprecations.php
new file mode 100644
index 0000000..fcaec39
--- /dev/null
+++ b/config/nextcloud-31/nextcloud-31-deprecations.php
@@ -0,0 +1,10 @@
+<?php
+
+declare(strict_types=1);
+
+use ChristophWurst\Nextcloud\Rector\Rector\ILoggerToPsrLoggerLevelsRector;
+use Rector\Config\RectorConfig;
+
+return static function (RectorConfig $rectorConfig): void {
+    $rectorConfig->rule(ILoggerToPsrLoggerLevelsRector::class);
+};
diff --git a/src/Rector/ILoggerToPsrLoggerLevelsRector.php b/src/Rector/ILoggerToPsrLoggerLevelsRector.php
new file mode 100644
index 0000000..5fbbce4
--- /dev/null
+++ b/src/Rector/ILoggerToPsrLoggerLevelsRector.php
@@ -0,0 +1,81 @@
+<?php
+
+declare(strict_types=1);
+
+/*
+ * SPDX-FileCopyrightText: 2024 Nextcloud GmbH and Nextcloud contributors
+ * SPDX-License-Identifier: AGPL-3.0-only
+ */
+
+namespace ChristophWurst\Nextcloud\Rector\Rector;
+
+use PhpParser\Node;
+use PhpParser\Node\Expr\ClassConstFetch;
+use PhpParser\Node\Expr\MethodCall;
+use PhpParser\Node\Identifier;
+use PhpParser\Node\Name\FullyQualified;
+use Rector\Rector\AbstractRector;
+use Symplify\RuleDocGenerator\ValueObject\CodeSample\CodeSample;
+use Symplify\RuleDocGenerator\ValueObject\RuleDefinition;
+
+use function array_slice;
+
+class ILoggerToPsrLoggerLevelsRector extends AbstractRector
+{
+    /**
+     * @return array<class-string<Node>>
+     */
+    public function getNodeTypes(): array
+    {
+        return [MethodCall::class];
+    }
+
+    public function refactor(Node $node): ?Node
+    {
+        if (!($node instanceof MethodCall)) {
+            return null;
+        }
+        $methodCallName = $this->getName($node->name);
+        if ($methodCallName !== 'log') {
+            return null;
+        }
+        if (
+            !($node->args[0] instanceof Node\Arg)
+            || !($node->args[0]->value instanceof ClassConstFetch)
+            || $this->getName($node->args[0]->value->class) !== 'OCP\ILogger'
+        ) {
+            return null;
+        }
+
+        return new MethodCall(
+            $node->var,
+            'log',
+            [
+                new Node\Arg(new ClassConstFetch(
+                    new FullyQualified('Psr\Log\LogLevel'),
+                    new Identifier(match ($this->getName($node->args[0]->value->name)) {
+                        'DEBUG' => 'DEBUG',
+                        'INFO' => 'INFO',
+                        'WARN' => 'WARNING',
+                        'FATAL' => 'EMERGENCY',
+                        default => 'ERROR',
+                    }),
+                )),
+                ...array_slice($node->args, 1),
+            ],
+        );
+    }
+
+    public function getRuleDefinition(): RuleDefinition
+    {
+        return new RuleDefinition(
+            'Change method calls from set* to change*.',
+            [
+                new CodeSample(
+                    '\OC::$server->get(IAppConfig::class);',
+                    '\OCP\Server::get(IAppConfig::class);',
+                ),
+            ],
+        );
+    }
+}
diff --git a/src/Set/NextcloudSets.php b/src/Set/NextcloudSets.php
index ce7a26b..22fca98 100644
--- a/src/Set/NextcloudSets.php
+++ b/src/Set/NextcloudSets.php
@@ -15,4 +15,5 @@ final class NextcloudSets implements SetListInterface
     public const NEXTCLOUD_25 = __DIR__ . '/../../config/nextcloud-25/nextcloud-25-deprecations.php';
     public const NEXTCLOUD_26 = __DIR__ . '/../../config/nextcloud-26/nextcloud-26-deprecations.php';
     public const NEXTCLOUD_27 = __DIR__ . '/../../config/nextcloud-27/nextcloud-27-deprecations.php';
+    public const NEXTCLOUD_31 = __DIR__ . '/../../config/nextcloud-31/nextcloud-31-deprecations.php';
 }
diff --git a/tests/Rector/ILoggerToPsrLoggerLevelsRector/Fixture/test_fixture.php.inc b/tests/Rector/ILoggerToPsrLoggerLevelsRector/Fixture/test_fixture.php.inc
new file mode 100644
index 0000000..db64ad1
--- /dev/null
+++ b/tests/Rector/ILoggerToPsrLoggerLevelsRector/Fixture/test_fixture.php.inc
@@ -0,0 +1,35 @@
+<?php
+namespace Foo\Bar;
+
+use Psr\Log\LoggerInterface;
+use Psr\Log\LogLevel;
+use OCP\ILogger;
+
+class Foo {
+    public function __construct(private LoggerInterface $logger) {}
+
+    public function logGenerically(): void {
+        $this->logger->log(LogLevel::ALERT, 'alarm!');
+        $this->logger->log(ILogger::ERROR, 'warn!');
+        $this->logger->log(ILogger::DEBUG, 'debug!');
+    }
+}
+?>
+-----
+<?php
+namespace Foo\Bar;
+
+use Psr\Log\LoggerInterface;
+use Psr\Log\LogLevel;
+use OCP\ILogger;
+
+class Foo {
+    public function __construct(private LoggerInterface $logger) {}
+
+    public function logGenerically(): void {
+        $this->logger->log(LogLevel::ALERT, 'alarm!');
+        $this->logger->log(\Psr\Log\LogLevel::ERROR, 'warn!');
+        $this->logger->log(\Psr\Log\LogLevel::DEBUG, 'debug!');
+    }
+}
+?>
diff --git a/tests/Rector/ILoggerToPsrLoggerLevelsRector/ILoggerToPsrLoggerLevelsRectorTest.php b/tests/Rector/ILoggerToPsrLoggerLevelsRector/ILoggerToPsrLoggerLevelsRectorTest.php
new file mode 100644
index 0000000..e23fd39
--- /dev/null
+++ b/tests/Rector/ILoggerToPsrLoggerLevelsRector/ILoggerToPsrLoggerLevelsRectorTest.php
@@ -0,0 +1,28 @@
+<?php
+
+declare(strict_types=1);
+
+namespace ChristophWurst\Nextcloud\Rector\Test\Rector\OcpUtilAddScriptRector;
+
+use Iterator;
+use PHPUnit\Framework\Attributes\DataProvider;
+use Rector\Testing\PHPUnit\AbstractRectorTestCase;
+
+final class ILoggerToPsrLoggerLevelsRectorTest extends AbstractRectorTestCase
+{
+    #[DataProvider('provideData')]
+    public function test(string $filePath): void
+    {
+        $this->doTestFile($filePath);
+    }
+
+    public static function provideData(): Iterator
+    {
+        return self::yieldFilesFromDirectory(__DIR__ . '/Fixture');
+    }
+
+    public function provideConfigFilePath(): string
+    {
+        return __DIR__ . '/config/config.php';
+    }
+}
diff --git a/tests/Rector/ILoggerToPsrLoggerLevelsRector/config/config.php b/tests/Rector/ILoggerToPsrLoggerLevelsRector/config/config.php
new file mode 100644
index 0000000..a46ea42
--- /dev/null
+++ b/tests/Rector/ILoggerToPsrLoggerLevelsRector/config/config.php
@@ -0,0 +1,11 @@
+<?php
+
+declare(strict_types=1);
+
+use ChristophWurst\Nextcloud\Rector\Rector\ILoggerToPsrLoggerLevelsRector;
+use Rector\Config\RectorConfig;
+
+return RectorConfig::configure()
+    ->withRules([
+        ILoggerToPsrLoggerLevelsRector::class,
+    ]);