Adding some CS fixes

Author: SirLouen

tests/phpunit/tests/formatting/antispambot.php

@@ -1,11 +1,11 @@
 <?php
-
 /**
- * @group formatting
+ * Tests for the antispambot() function.
  *
+ * @group formatting
  * @covers ::antispambot
  */
-class Tests_Formatting_antispambot extends WP_UnitTestCase {
+class Tests_Formatting_Antispambot extends WP_UnitTestCase {
 
 	/**
 	 * This is basically a driveby test. While working on ticket
@@ -16,12 +16,16 @@ class Tests_Formatting_antispambot extends WP_UnitTestCase {
 	 * @ticket 31992
 	 *
 	 * @dataProvider data_returns_valid_utf8
+	 * @param string $address  The email address to obfuscate.
+	 * @param bool   $validity Whether the obfuscated address should be valid UTF-8.
 	 */
-
 	public function test_returns_valid_utf8( $address, $validity ) {
 		$this->assertSame( wp_is_valid_utf8( antispambot( $address ) ), $validity );
 	}
 
+	/**
+	 * Data provider for test_returns_valid_utf8.
+	 */
 	public function data_returns_valid_utf8() {
 		return array(
 			'plain'                => array( '[email protected]', true ),

tests/phpunit/tests/formatting/isEmail.php

@@ -1,11 +1,17 @@
 <?php
-
 /**
+ * Tests for the is_email() function.
+ *
  * @group formatting
  *
  * @covers ::is_email
  */
 class Tests_Formatting_IsEmail extends WP_UnitTestCase {
+	/**
+	 * This test checks that valid email addresses return the same address.
+	 *
+	 * @ticket 31992
+	 */
 	public function test_returns_the_email_address_if_it_is_valid() {
 		$data = array(
 			'[email protected]',
@@ -25,6 +31,11 @@ public function test_returns_the_email_address_if_it_is_valid() {
 		}
 	}
 
+	/**
+	 * This test checks that invalid email addresses return false.
+	 *
+	 * @ticket 31992
+	 */
 	public function test_returns_false_if_given_an_invalid_email_address() {
 		$data = array(
 			'khaaaaaaaaaaaaaaan!',
@@ -34,16 +45,20 @@ public function test_returns_false_if_given_an_invalid_email_address() {
 			'bob@your mom',
 			'[email protected]',
 			'" "@b.c',
-			'h([email protected]', // bad comment
+			'h([email protected]', // bad comment.
 			'hi@',
-			'hi@[email protected]', // double @
-			/* The next address is not deliverable as described,
+			'hi@[email protected]', // double @.
+
+			/*
+			 * The next address is not deliverable as described,
 			 * SMTP servers should strip the (ab), so it is very
 			 * likely a source of confusion or a typo.
 			 * Best rejected.
 			 */
 			'(ab)[email protected]',
-			/* The next address is not globally deliverable,
+
+			/*
+			 * The next address is not globally deliverable,
 			 * so it may work with PHPMailer and break with
 			 * mail sending services. Best not allow users
 			 * to paint themselves into that corner. This also
@@ -52,7 +67,9 @@ public function test_returns_false_if_given_an_invalid_email_address() {
 			 * browsers and servers.
 			*/
 			'toto@to',
-			/* Several addresses are best rejected because
+
+			/*
+			 * Several addresses are best rejected because
 			 * we don't want to allow sending to fe80::, 192.168
 			 * and other special addresses; that too might
 			 * be used to probe the Wordpress server's local

tests/phpunit/tests/formatting/sanitizeEmail.php

@@ -1,11 +1,27 @@
 <?php
-
 /**
- * @group formatting
+ * Tests for the sanitize_email() function.
  *
+ * @group formatting
  * @covers ::sanitize_email
  */
 class Tests_Formatting_SanitizeEmail extends WP_UnitTestCase {
+
+	/**
+	 * This test checks that email addresses are properly sanitized.
+	 *
+	 * @ticket 31992
+	 * @dataProvider data_for_sanitation
+	 * @param string $address  The email address to sanitize.
+	 * @param string $expected The expected sanitized email address.
+	 */
+	public function test_returns_stripped_email_address( $address, $expected ) {
+		$this->assertSame( sanitize_email( $address ), $expected );
+	}
+
+	/**
+	 * Data provider for test_returns_stripped_email_address.
+	 */
 	public function data_for_sanitation() {
 		return array(
 			'shorter than 6 characters' => array( 'a@b', '' ),
@@ -14,13 +30,4 @@ public function data_for_sanitation() {
 			'plain'                     => array( '[email protected]', '[email protected]' ),
 		);
 	}
-
-	/**
-	* @ticket 31992
-	* @dataProvider data_for_sanitation
-	*/
-
-	public function test_returns_stripped_email_address( $address, $expected ) {
-		$this->assertSame( sanitize_email( $address ), $expected );
-	}
 }

tests/phpunit/tests/formatting/sanitizeTitle.php

@@ -1,6 +1,11 @@
 <?php
 
+use SebastianBergmann\RecursionContext\InvalidArgumentException;
+use PHPUnit\Framework\ExpectationFailedException;
+
 /**
+ * Tests for the sanitize_title() function.
+ *
  * @group formatting
  *
  * @covers ::sanitize_title
@@ -12,6 +17,11 @@ public function test_strips_html() {
 		$this->assertSame( $expected, sanitize_title( $input ) );
 	}
 
+	/**
+	 * Tests for the sanitize_title() function leaving Devanagari characters intact.
+	 *
+	 * @ticket 31992
+	 */
 	public function test_leaves_devanagari() {
 		$input = 'राजीव';
 		$this->assertSame( $input, urldecode( sanitize_title( $input ) ) );

tests/phpunit/tests/formatting/sanitizeUser.php

@@ -1,8 +1,8 @@
 <?php
-
 /**
- * @group formatting
+ * Tests for the sanitize_user() function.
  *
+ * @group formatting
  * @covers ::sanitize_user
  */
 class Tests_Formatting_SanitizeUser extends WP_UnitTestCase {
@@ -37,14 +37,13 @@ public function test_strips_encoded_ampersand_when_followed_by_semicolon() {
 		$this->assertSame( $expected, sanitize_user( 'AT&amp;T Test;' ) );
 	}
 
-	/*
+	/**
 	 * Some languages use the Latin alphabet with various accents.
 	 * The city Münster is in Germany, Orléans is in France. This
 	 * test checks that an author (a user name) can use an accent.
 	 *
 	 * @ticket 31992
 	 */
-
 	public function test_strips_percent_encoded_octets() {
 		if ( ! function_exists( 'mb_str_split' ) ) {
 			$this->markTestSkipped( 'PHP 7.2/3 lacks mb_str_split' );
@@ -57,6 +56,13 @@ public function test_optional_strict_mode_reduces_to_safe_ascii_subset() {
 		$this->assertSame( 'abc', sanitize_user( '()~ab~ˆcˆ!', true ) );
 	}
 
+	/**
+	 * Arabic script is used in various languages, including
+	 * Arabic and Persian. This test checks that an author
+	 * (a user name) can use such letters.
+	 *
+	 * @ticket 31992
+	 */
 	public function test_accepts_all_arabic() {
 		if ( ! function_exists( 'mb_str_split' ) ) {
 			$this->markTestSkipped( 'PHP 7.2/3 lacks mb_str_split' );
@@ -68,7 +74,7 @@ public function test_accepts_all_arabic() {
 		$this->assertSame( $expected, sanitize_user( $encoded ) );
 	}
 
-	/*
+	/**
 	 * Some languages use the Latin alphabet with various
 	 * extra letters. The city Bodø is in Norway, Gießen in
 	 * Germany. This test checks that an author (a user name) can
@@ -78,7 +84,6 @@ public function test_accepts_all_arabic() {
 	 *
 	 * @ticket 31992
 	 */
-
 	public function test_accepts_west_african_latin() {
 		if ( ! function_exists( 'mb_str_split' ) ) {
 			$this->markTestSkipped( 'PHP 7.2/3 lacks mb_str_split' );

tests/phpunit/tests/user.php

@@ -1120,12 +1120,14 @@ public function test_validate_utf8_usernames() {
 		$this->assertTrue( validate_username( 'grå' ) );
 		/* Three Cyrillic letters */
 		$this->assertTrue( validate_username( 'ІВМ' ) );
-		/* A metal umlaut fails because validate_username is
-		 * strict and n̈ is unfamiliar in every language
+		/**
+		 * A metal umlaut fails because validate_username is
+		 * strict and n̈ is unfamiliar in every language.
 		 */
 		$this->assertFalse( validate_username( 'spın̈altap' ) );
-		/* Emoji skintones fail because usernames should be
-		 * easily distinguishable
+		/**
+		 * Emoji skintones fail because usernames should be
+		 * easily distinguishable.
 		 */
 		$this->assertFalse( validate_username( '👱🏼' ) );
 		$this->assertFalse( validate_username( '👱🏾' ) );