Surge: Don't use AP constant in wp-config. (#1696)

Co-authored-by: Matthias Pfefferle <[email protected]>

Author: obenland

integration/class-surge.php

@@ -15,15 +15,9 @@
  * @see https://wordpress.org/plugins/surge/
  */
 class Surge {
-	/**
-	 * The define for the Surge cache config.
-	 *
-	 * @var string
-	 */
-	public static $cache_config = "define( 'WP_CACHE_CONFIG', '' . ACTIVITYPUB_PLUGIN_DIR . 'integration/surge-cache-config.php' );";
 
 	/**
-	 * The pattern to find the define for the Surge cache config.
+	 * The pattern to find the Surge cache config constant.
 	 *
 	 * @var string
 	 */
@@ -66,9 +60,9 @@ public static function add_cache_config() {
 		// Add a WP_CACHE_CONFIG to wp-config.php.
 		$anchor = "/* That's all, stop editing!";
 		if ( false !== \strpos( $config, $anchor ) ) {
-			$config = \str_replace( $anchor, self::$cache_config . PHP_EOL . PHP_EOL . $anchor, $config );
+			$config = \str_replace( $anchor, self::get_cache_config() . PHP_EOL . PHP_EOL . $anchor, $config );
 		} elseif ( false !== \strpos( $config, '<?php' ) ) {
-			$config = \str_replace( '<?php', '<?php' . PHP_EOL . PHP_EOL . self::$cache_config . PHP_EOL, $config );
+			$config = \str_replace( '<?php', '<?php' . PHP_EOL . PHP_EOL . self::get_cache_config() . PHP_EOL, $config );
 		}
 
 		$wp_filesystem->put_contents( $file, $config, FS_CHMOD_FILE );
@@ -177,11 +171,20 @@ public static function test_surge_integration() {
 				\sprintf(
 					// translators: %s: Plugin directory path.
 					\__( 'To enable the ActivityPub integration with Surge, add the following line to your <code>wp-config.php</code> file: <br /><code>%s</code>', 'activitypub' ),
-					self::$cache_config
+					self::get_cache_config()
 				)
 			);
 		}
 
 		return $result;
 	}
+
+	/**
+	 * Get the cache config.
+	 *
+	 * @return string The cache config.
+	 */
+	public static function get_cache_config() {
+		return \sprintf( "define( 'WP_CACHE_CONFIG', '%s/integration/surge-cache-config.php' );", \rtrim( ACTIVITYPUB_PLUGIN_DIR, '/' ) );
+	}
 }

tests/integration/class-test-akismet.php

@@ -13,6 +13,7 @@
 /**
  * Test Akismet Integration class.
  *
+ * @group integration
  * @coversDefaultClass \Activitypub\Integration\Akismet
  */
 class Test_Akismet extends WP_UnitTestCase {

tests/integration/class-test-enable-mastodon-apps.php

@@ -12,6 +12,7 @@
 /**
  * Test class for Enable Mastodon Apps integration.
  *
+ * @group integration
  * @coversDefaultClass \Activitypub\Integration\Enable_Mastodon_Apps
  */
 class Test_Enable_Mastodon_Apps extends \WP_UnitTestCase {

tests/integration/class-test-seriously-simple-podcasting.php

@@ -10,6 +10,7 @@
 /**
  * Test class for Seriously Simple Podcasting integration.
  *
+ * @group integration
  * @coversDefaultClass \Activitypub\Integration\Seriously_Simple_Podcasting
  */
 class Test_Seriously_Simple_Podcasting extends \WP_UnitTestCase {

tests/integration/class-test-surge.php

@@ -11,6 +11,9 @@
 
 /**
  * Test Surge integration.
+ *
+ * @group integration
+ * @coversDefaultClass \Activitypub\Integration\Surge
  */
 class Test_Surge extends \WP_UnitTestCase {
 	/**
@@ -21,11 +24,11 @@ class Test_Surge extends \WP_UnitTestCase {
 	private $test_file;
 
 	/**
-	 * Original config file path.
+	 * Config contents.
 	 *
 	 * @var string
 	 */
-	private $original_config_file;
+	private $config_contents;
 
 	/**
 	 * Original cache config.
@@ -83,7 +86,7 @@ public function test_add_cache_config() {
 
 		$this->assertStringContainsString( '<?php', $file, 'File should start with PHP opening tag' );
 		$this->assertStringContainsString( "/* That's all, stop editing! */", $file, 'Comment should be present' );
-		$this->assertStringContainsString( Surge::$cache_config, $file, 'Config line should be present' );
+		$this->assertStringContainsString( Surge::get_cache_config(), $file, 'Config line should be present' );
 	}
 
 	/**
@@ -101,7 +104,7 @@ public function test_remove_cache_config() {
 		// phpcs:ignore
 		$actual = \file_get_contents( Surge::get_config_file_path() );
 		$this->assertStringContainsString( '<?php', $actual, 'File should start with PHP opening tag' );
-		$this->assertStringNotContainsString( Surge::$cache_config, $actual, 'Config line should be removed' );
+		$this->assertStringNotContainsString( Surge::get_cache_config(), $actual, 'Config line should be removed' );
 		$this->assertStringContainsString( "/* That's all, stop editing! */", $actual, 'Comment should be present' );
 	}
 
@@ -115,7 +118,7 @@ public function test_init_with_surge_active() {
 
 		// phpcs:ignore
 		$before = \file_get_contents( Surge::get_config_file_path() );
-		$this->assertStringNotContainsString( Surge::$cache_config, $before );
+		$this->assertStringNotContainsString( Surge::get_cache_config(), $before );
 
 		Surge::init();
 
@@ -124,7 +127,7 @@ public function test_init_with_surge_active() {
 
 		// phpcs:ignore
 		$after = \file_get_contents( Surge::get_config_file_path() );
-		$this->assertStringContainsString( Surge::$cache_config, $after );
+		$this->assertStringContainsString( Surge::get_cache_config(), $after );
 
 		\remove_all_filters( 'pre_option_active_plugins' );
 	}
@@ -145,7 +148,7 @@ public function get_active_plugins() {
 	 */
 	public function test_init_with_surge_inactive() {
 		// phpcs:ignore
-		\file_put_contents( Surge::get_config_file_path(), "<?php\n" . Surge::$cache_config . "\n\n/* That's all, stop editing! */" );
+		\file_put_contents( Surge::get_config_file_path(), "<?php\n" . Surge::get_cache_config() . "\n\n/* That's all, stop editing! */" );
 		\add_filter( 'pre_option_active_plugins', array( $this, 'get_inactive_plugins' ) );
 
 		Surge::init();
@@ -155,7 +158,7 @@ public function test_init_with_surge_inactive() {
 
 		// phpcs:ignore
 		$after = \file_get_contents( Surge::get_config_file_path() );
-		$this->assertStringNotContainsString( Surge::$cache_config, $after );
+		$this->assertStringNotContainsString( Surge::get_cache_config(), $after );
 
 		\remove_all_filters( 'pre_option_active_plugins' );
 	}