Closes #7126: PHPStan ~ Discourage wp option function (#7155)

Co-authored-by: WordPressFan <[email protected]>
Co-authored-by: WordPress Fan <[email protected]>

phpstan.neon.dist

@@ -55,7 +55,7 @@ parameters:
 		 - %currentWorkingDirectory%/inc/classes/subscriber/third-party/
 		 - %currentWorkingDirectory%/inc/3rd-party/
 rules:
-	- WP_Rocket\Tests\phpstan\Rules\DiscourageUpdateOptionUsage
+	- WP_Rocket\Tests\phpstan\Rules\DiscourageWPOptionUsage
 	- WP_Rocket\Tests\phpstan\Rules\DiscourageApplyFilters
 	- WP_Rocket\Tests\phpstan\Rules\EnsureCallbackMethodsExistsInSubscribedEvents
 	- WP_Rocket\Tests\phpstan\Rules\NoHooksInORM

tests/phpstan/Rules/DiscourageWPOptionUsage.php

@@ -0,0 +1,39 @@
+<?php
+
+namespace WP_Rocket\Tests\phpstan\Rules;
+
+use PhpParser\Node;
+use PhpParser\Node\Expr\FuncCall;
+use PHPStan\Analyser\Scope;
+use PHPStan\Rules\Rule;
+use PHPStan\Rules\RuleErrorBuilder;
+
+class DiscourageWPOptionUsage implements Rule {
+	public function getNodeType(): string {
+		return FuncCall::class;
+	}
+
+	public function processNode( Node $node, Scope $scope ): array {
+		if ( !$node instanceof FuncCall ) {
+			return [];
+		}
+
+		$functionName = $node->name instanceof Node\Name ? $node->name->toString() : '';
+
+		$discouragedFunctions = [
+			'update_option' => true,
+			'get_option'    => true,
+			'delete_option' => true,
+		];
+
+		if ( isset( $discouragedFunctions[ $functionName ] ) ) {
+			return [
+				RuleErrorBuilder::message( sprintf( 'Usage of %1$s() is discouraged. Use the Option object instead.', $functionName ) )
+					->identifier('custom.rules.discourageOptionUsage')
+					->build(),
+			];
+		}
+
+		return [];
+	}
+}

tests/phpstan/tests/Rules/DiscourageWPOptionUsageTest.php

@@ -0,0 +1,46 @@
+<?php
+
+namespace WP_Rocket\Tests\phpstan\tests\Rules;
+
+use PHPStan\Rules\Rule;
+use PHPStan\Testing\RuleTestCase;
+use WP_Rocket\Tests\phpstan\Rules\DiscourageWPOptionUsage;
+
+class DiscourageWPOptionUsageTest extends RuleTestCase {
+
+	protected function getRule(): Rule {
+		return new DiscourageWPOptionUsage();
+	}
+
+	public function testValidShouldNotHaveErrors() {
+		$this->analyse([__DIR__ . '/../data/DiscourageWPOptionUsageTest/valid.php'], [
+		]);
+	}
+
+	public function testShouldHaveErrorWithDeleteOption() {
+		$this->analyse([__DIR__ . '/../data/DiscourageWPOptionUsageTest/use-delete-option.php'], [
+			[
+				"Usage of delete_option() is discouraged. Use the Option object instead.",
+				19
+			]
+		]);
+	}
+
+	public function testShouldHaveErrorWithGetOption() {
+		$this->analyse([__DIR__ . '/../data/DiscourageWPOptionUsageTest/use-get-option.php'], [
+			[
+				"Usage of get_option() is discouraged. Use the Option object instead.",
+				19
+			]
+		]);
+	}
+
+	public function testShouldHaveErrorWithUpdateOption() {
+		$this->analyse([__DIR__ . '/../data/DiscourageWPOptionUsageTest/use-update-option.php'], [
+			[
+				"Usage of update_option() is discouraged. Use the Option object instead.",
+				19
+			]
+		]);
+	}
+}

tests/phpstan/tests/data/DiscourageWPOptionUsageTest/use-delete-option.php

@@ -0,0 +1,21 @@
+<?php
+
+namespace WP_Rocket\Engine\Admin;
+
+use WP_Rocket\Event_Management\Subscriber_Interface;
+use WP_Rocket\ThirdParty\ReturnTypesTrait;
+
+class ActionSchedulerSubscriber implements Subscriber_Interface {
+
+	use ReturnTypesTrait;
+
+	public static function get_subscribed_events() {
+		return [
+			'hook' => 'callback',
+		];
+	}
+
+	public function callback() {
+		return delete_option('test_option' );
+	}
+}

tests/phpstan/tests/data/DiscourageWPOptionUsageTest/use-get-option.php

@@ -0,0 +1,21 @@
+<?php
+
+namespace WP_Rocket\Engine\Admin;
+
+use WP_Rocket\Event_Management\Subscriber_Interface;
+use WP_Rocket\ThirdParty\ReturnTypesTrait;
+
+class ActionSchedulerSubscriber implements Subscriber_Interface {
+
+	use ReturnTypesTrait;
+
+	public static function get_subscribed_events() {
+		return [
+			'hook' => 'callback',
+		];
+	}
+
+	public function callback() {
+		return get_option('test_option', false );
+	}
+}

tests/phpstan/tests/data/DiscourageWPOptionUsageTest/use-update-option.php

@@ -0,0 +1,22 @@
+<?php
+
+namespace WP_Rocket\Engine\Admin;
+
+use WP_Rocket\Event_Management\Subscriber_Interface;
+use WP_Rocket\ThirdParty\ReturnTypesTrait;
+
+class ActionSchedulerSubscriber implements Subscriber_Interface {
+
+	use ReturnTypesTrait;
+
+	public static function get_subscribed_events() {
+		return [
+			'hook' => 'callback',
+		];
+	}
+
+	public function callback() {
+		update_option('test_option', false );
+		return true;
+	}
+}