Fixes#4830 Rankmath class not found (#6695)

inc/ThirdParty/Plugins/SEO/RankMathSEO.php

@@ -1,54 +1,44 @@
 <?php
+declare(strict_types=1);
 
 namespace WP_Rocket\ThirdParty\Plugins\SEO;
 
 use RankMath\Helper;
 use RankMath\Sitemap\Router;
-use WP_Rocket\Admin\Options_Data;
 use WP_Rocket\Event_Management\Subscriber_Interface;
 
 class RankMathSEO implements Subscriber_Interface {
-
-
 	/**
-	 * Options instance.
+	 * Returns an array of events this subscriber wants to listen to.
 	 *
-	 * @var Options_Data
+	 * @return array
 	 */
-	protected $option;
-
-	/**
-	 * Instantiate class.
-	 *
-	 * @param Options_Data $option Options instance.
-	 */
-	public function __construct( Options_Data $option ) {
-		$this->option = $option;
-	}
+	public static function get_subscribed_events(): array {
+		if ( ! class_exists( 'RankMath\Helper' ) ) {
+			return [];
+		}
 
-	/**
-	 * Subscribed events.
-	 */
-	public static function get_subscribed_events() {
-		// @phpstan-ignore-next-line
 		if ( ! defined( 'RANK_MATH_FILE' ) || ! Helper::is_module_active( 'sitemap' ) ) {
 			return [];
 		}
 
 		return [
-			'rocket_sitemap_preload_list' => [ 'rocket_sitemap', 15 ],
+			'rocket_sitemap_preload_list' => [ 'add_sitemap', 15 ],
 		];
 	}
 
 	/**
 	 * Add SEO sitemap URL to the sitemaps to preload
 	 *
 	 * @param array $sitemaps Sitemaps to preload.
-	 * @return array Updated Sitemaps to preload
+	 *
+	 * @return array
 	 */
-	public function rocket_sitemap( $sitemaps ) {
+	public function add_sitemap( $sitemaps ) {
+		if ( ! class_exists( 'RankMath\Sitemap\Router' ) ) {
+			return $sitemaps;
+		}
 
-		// @phpstan-ignore-next-line
 		$sitemaps[] = Router::get_base_url( 'sitemap_index.xml' );
 
 		return $sitemaps;

inc/ThirdParty/ServiceProvider.php

@@ -238,7 +238,6 @@ public function register(): void {
 			->addTag( 'common_subscriber' );
 		$this->getContainer()
 			->addShared( 'rank_math_seo', RankMathSEO::class )
-			->addArgument( $options )
 			->addTag( 'common_subscriber' );
 		$this->getContainer()
 			->addShared( 'all_in_one_seo_pack', AllInOneSEOPack::class )

tests/Fixtures/inc/ThirdParty/Plugins/SEO/RankMathSEO/rocketSitemap.php → tests/Fixtures/inc/ThirdParty/Plugins/SEO/RankMathSEO/addSitemap.php

@@ -2,11 +2,11 @@
 return [
 	'shouldAddSitemap' => [
 		'config' => [
-			'sitemap' => 'sitemap',
-			'sitemaps' => []
+			'sitemap'  => 'sitemap',
+			'sitemaps' => [],
 		],
 		'expected' => [
 			'sitemap',
-		]
-	]
+		],
+	],
 ];

tests/Integration/inc/ThirdParty/Plugins/SEO/RankMathSEO/addSitemap.php

@@ -0,0 +1,39 @@
+<?php
+declare(strict_types=1);
+
+namespace WP_Rocket\Tests\Integration\inc\ThirdParty\Plugins\SEO\RankMathSEO;
+
+use RankMath\Sitemap\Router;
+use WP_Rocket\Tests\Integration\TestCase;
+
+/**
+ * Test class covering \WP_Rocket\ThirdParty\Plugins\SEO\RankMathSEO::add_sitemap
+ *
+ * @group RankMathSEO
+ * @group ThirdParty
+ */
+class TestRocketSitemap extends TestCase {
+	public function set_up() {
+		parent::set_up();
+
+		$this->unregisterAllCallbacksExcept( 'rocket_sitemap_preload_list', 'add_sitemap', 15 );
+	}
+
+	public function tear_down() {
+		$this->restoreWpHook( 'rocket_sitemap_preload_list' );
+
+		parent::tear_down();
+	}
+
+	/**
+	 * @dataProvider configTestData
+	 */
+	public function testShouldReturnExpected( $config, $expected ) {
+		Router::$sitemap = $config['sitemap'];
+
+		$this->assertSame(
+			$expected,
+			apply_filters( 'rocket_sitemap_preload_list', $config['sitemaps'] )
+		);
+	}
+}

tests/Unit/inc/ThirdParty/Plugins/SEO/RankMathSEO/addSitemap.php

@@ -0,0 +1,37 @@
+<?php
+declare(strict_types=1);
+
+namespace WP_Rocket\Tests\Unit\inc\ThirdParty\Plugins\SEO\RankMathSEO;
+
+use RankMath\Sitemap\Router;
+use WP_Rocket\Tests\Unit\TestCase;
+use WP_Rocket\ThirdParty\Plugins\SEO\RankMathSEO;
+
+/**
+ * Test class covering \WP_Rocket\ThirdParty\Plugins\SEO\RankMathSEO::add_sitemap
+ *
+ * @group RankMathSEO
+ * @group ThirdParty
+ */
+class Test_RocketSitemap extends TestCase {
+	protected $option;
+	protected $subscriber;
+
+	protected function setUp(): void {
+		parent::setUp();
+
+		$this->subscriber = new RankMathSEO();
+	}
+
+	/**
+	 * @dataProvider configTestData
+	 */
+	public function testShouldReturnAsExpected( $config, $expected ) {
+		Router::$sitemap = $config['sitemap'];
+
+		$this->assertSame(
+			$expected,
+			$this->subscriber->add_sitemap( $config['sitemaps'] )
+		);
+	}
+}