Merge pull request #2769 from Strategy11/new_sniff_to_remove_unnecessary_whitespace_in_small_if_conditions

Crabcyborg · web-flow · commit 4f30f582f0f5 · 2026-01-09T22:56:30.000-04:00
New sniff to remove unnecessary white space in small if conditions
diff --git a/classes/controllers/FrmAddonsController.php b/classes/controllers/FrmAddonsController.php
@@ -269,7 +269,6 @@ public static function license_settings() {
 
 		if ( ! $plugins ) {
 			esc_html_e( 'There are no plugins on your site that require a license', 'formidable' );
-
 			return;
 		}
 
@@ -1546,7 +1545,6 @@ private static function allowed_external_urls() {
 
 		if ( ! is_array( $allowed_url_list ) ) {
 			_doing_it_wrong( __METHOD__, 'Only an array of URLs could be used within this filter.', '6.3.1' );
-
 			return array();
 		}
 
diff --git a/classes/controllers/FrmFormsController.php b/classes/controllers/FrmFormsController.php
@@ -978,7 +978,6 @@ public static function delete_all() {
 
 		if ( $permission_error !== false ) {
 			self::display_forms_list( array(), '', array( $permission_error ) );
-
 			return;
 		}
 
@@ -2027,23 +2026,20 @@ public static function process_bulk_form_actions( $errors ) {
 
 		if ( $bulkaction && str_starts_with( $bulkaction, 'bulk_' ) ) {
 			FrmAppHelper::remove_get_action();
-
 			$bulkaction = str_replace( 'bulk_', '', $bulkaction );
 		}
 
 		$ids = FrmAppHelper::get_param( 'item-action', '', 'get', 'sanitize_text_field' );
 
 		if ( ! $ids ) {
 			$errors[] = __( 'No forms were specified', 'formidable' );
-
 			return $errors;
 		}
 
 		$permission_error = FrmAppHelper::permission_nonce_error( '', '_wpnonce', 'bulk-toplevel_page_formidable' );
 
 		if ( $permission_error !== false ) {
 			$errors[] = $permission_error;
-
 			return $errors;
 		}
 
diff --git a/classes/helpers/FrmAppHelper.php b/classes/helpers/FrmAppHelper.php
@@ -2082,7 +2082,6 @@ public static function post_edit_link( $post_id ) {
 
 		if ( $post ) {
 			$post_url = admin_url( 'post.php?post=' . $post_id . '&action=edit' );
-
 			return '<a href="' . esc_url( $post_url ) . '">' . self::truncate( $post->post_title, 50 ) . '</a>';
 		}
 
@@ -2389,7 +2388,6 @@ public static function permission_check( $permission, $show_message = 'show' ) {
 	public static function permission_nonce_error( $permission, $nonce_name = '', $nonce = '' ) {
 		if ( $permission && ! current_user_can( $permission ) && ! current_user_can( 'administrator' ) ) {
 			$frm_settings = self::get_settings();
-
 			return $frm_settings->admin_permission;
 		}
 
diff --git a/classes/helpers/FrmEntriesListHelper.php b/classes/helpers/FrmEntriesListHelper.php
@@ -208,7 +208,6 @@ public function no_items() {
 
 		if ( $s ) {
 			esc_html_e( 'No Entries Found', 'formidable' );
-
 			return;
 		}
 
diff --git a/classes/helpers/FrmFormsHelper.php b/classes/helpers/FrmFormsHelper.php
@@ -1726,7 +1726,6 @@ public static function get_plan_required( &$item ) {
 		foreach ( $item['categories'] as $k => $category ) {
 			if ( in_array( $category, $plans, true ) ) {
 				unset( $item['categories'][ $k ] );
-
 				return self::convert_legacy_package_names( $category );
 			}
 		}
diff --git a/classes/helpers/FrmXMLHelper.php b/classes/helpers/FrmXMLHelper.php
@@ -1865,7 +1865,6 @@ private static function remove_default_html( $html_name, $defaults, &$options )
 		// phpcs:ignore Universal.Operators.StrictComparisons
 		if ( $old_html == $default_html ) {
 			unset( $options[ $html_name ] );
-
 			return;
 		}
 
diff --git a/classes/models/FrmAddon.php b/classes/models/FrmAddon.php
@@ -867,7 +867,6 @@ private function get_license_status() {
 
 		if ( empty( $this->license ) ) {
 			$response['error'] = false;
-
 			return $response;
 		}
 
diff --git a/classes/models/FrmCreateFile.php b/classes/models/FrmCreateFile.php
@@ -106,7 +106,6 @@ public function append_file( $file_content ) {
 		if ( $this->has_permission ) {
 
 			if ( file_exists( $this->new_file_path ) ) {
-
 				$existing_content = $this->get_contents();
 				$file_content     = $existing_content . $file_content;
 			}
diff --git a/classes/models/FrmEntryMeta.php b/classes/models/FrmEntryMeta.php
@@ -276,7 +276,6 @@ public static function get_entry_meta_by_field( $entry_id, $field_id ) {
 
 		if ( $cached && isset( $cached->metas ) && isset( $cached->metas[ $field_id ] ) ) {
 			$result = $cached->metas[ $field_id ];
-
 			return wp_unslash( $result );
 		}
 
diff --git a/classes/models/FrmEntryValidate.php b/classes/models/FrmEntryValidate.php
@@ -24,7 +24,6 @@ public static function validate( $values, $exclude = false ) {
 
 		if ( ! isset( $values['form_id'] ) || ! isset( $values['item_meta'] ) ) {
 			$errors['form'] = __( 'There was a problem with your submission. Please try again.', 'formidable' );
-
 			return $errors;
 		}
 
@@ -1128,8 +1127,7 @@ private static function get_all_form_ids_and_flatten_meta( &$values ) { // phpcs
 
 					// Convert name array to string.
 					if ( isset( $subsubvalue['first'] ) && isset( $subsubvalue['last'] ) ) {
-						$subsubvalue = trim( implode( ' ', $subsubvalue ) );
-
+						$subsubvalue                = trim( implode( ' ', $subsubvalue ) );
 						$values['name_field_ids'][] = $subsubindex;
 					}
 
diff --git a/classes/models/FrmFieldValue.php b/classes/models/FrmFieldValue.php
@@ -224,8 +224,7 @@ public function get_displayed_value() {
 	 */
 	protected function generate_displayed_value_for_field_type( $atts ) {
 		if ( ! FrmAppHelper::is_empty_value( $this->displayed_value, '' ) ) {
-			$field_obj = FrmFieldFactory::get_field_object( $this->field );
-
+			$field_obj             = FrmFieldFactory::get_field_object( $this->field );
 			$this->displayed_value = $field_obj->get_display_value( $this->displayed_value, $atts );
 		}
 	}
diff --git a/classes/models/FrmStyle.php b/classes/models/FrmStyle.php
@@ -566,8 +566,7 @@ public function get_all( $orderby = 'title', $order = 'ASC', $limit = 99 ) {
 		}//end foreach
 
 		if ( ! $default_style ) {
-			$default_style = reset( $styles );
-
+			$default_style                            = reset( $styles );
 			$styles[ $default_style->ID ]->menu_order = 1;
 		}
 
diff --git a/phpcs-sniffs/Formidable/Sniffs/WhiteSpace/NoBlankLineInShortIfSniff.php b/phpcs-sniffs/Formidable/Sniffs/WhiteSpace/NoBlankLineInShortIfSniff.php
@@ -0,0 +1,137 @@
+<?php
+/**
+ * Formidable_Sniffs_WhiteSpace_NoBlankLineInShortIfSniff
+ *
+ * Removes blank lines inside if blocks that are exactly 3 lines.
+ *
+ * @package Formidable\Sniffs
+ */
+
+namespace Formidable\Sniffs\WhiteSpace;
+
+use PHP_CodeSniffer\Sniffs\Sniff;
+use PHP_CodeSniffer\Files\File;
+
+/**
+ * Removes blank lines inside if blocks that are exactly 3 lines.
+ *
+ * Bad:
+ * if ( $condition ) {
+ *     do_something();
+ *
+ *     return;
+ * }
+ *
+ * Good:
+ * if ( $condition ) {
+ *     do_something();
+ *     return;
+ * }
+ */
+class NoBlankLineInShortIfSniff implements Sniff {
+
+	/**
+	 * Returns an array of tokens this test wants to listen for.
+	 *
+	 * @return array
+	 */
+	public function register() {
+		return array( T_IF, T_ELSEIF, T_ELSE );
+	}
+
+	/**
+	 * Processes this test, when one of its tokens is encountered.
+	 *
+	 * @param File $phpcsFile The file being scanned.
+	 * @param int  $stackPtr  The position of the current token in the stack passed in $tokens.
+	 *
+	 * @return void
+	 */
+	public function process( File $phpcsFile, $stackPtr ) {
+		$tokens = $phpcsFile->getTokens();
+
+		// Make sure this if/else has a scope (curly braces).
+		if ( ! isset( $tokens[ $stackPtr ]['scope_opener'] ) || ! isset( $tokens[ $stackPtr ]['scope_closer'] ) ) {
+			return;
+		}
+
+		$scopeOpener = $tokens[ $stackPtr ]['scope_opener'];
+		$scopeCloser = $tokens[ $stackPtr ]['scope_closer'];
+
+		// Calculate the number of lines in the block body.
+		$openerLine = $tokens[ $scopeOpener ]['line'];
+		$closerLine = $tokens[ $scopeCloser ]['line'];
+
+		// Body lines = closerLine - openerLine - 1.
+		// We want to trigger when there are exactly 3 body lines (2 code + 1 blank).
+		// This means the if block has 2 statements but a blank line between them.
+		$bodyLines = $closerLine - $openerLine - 1;
+
+		// Only process if the body is exactly 3 lines (2 code lines + 1 blank line).
+		if ( $bodyLines !== 3 ) {
+			return;
+		}
+
+		// Find if there's a blank line inside the block.
+		// A blank line is a whitespace token that contains 2+ consecutive newlines.
+		$blankLineToken = null;
+
+		for ( $i = $scopeOpener + 1; $i < $scopeCloser; $i++ ) {
+			if ( $tokens[ $i ]['code'] === T_WHITESPACE ) {
+				$content      = $tokens[ $i ]['content'];
+				$newlineCount = substr_count( $content, "\n" );
+
+				// If this whitespace has 2+ newlines, it contains a blank line.
+				if ( $newlineCount >= 2 ) {
+					$blankLineToken = $i;
+					break;
+				}
+			}
+		}
+
+		if ( null === $blankLineToken ) {
+			// Also check for consecutive newline tokens (PHPCS sometimes splits them).
+			$lastWasNewline = false;
+
+			for ( $i = $scopeOpener + 1; $i < $scopeCloser; $i++ ) {
+				if ( $tokens[ $i ]['code'] === T_WHITESPACE && $tokens[ $i ]['content'] === "\n" ) {
+					if ( $lastWasNewline ) {
+						$blankLineToken = $i;
+						break;
+					}
+					$lastWasNewline = true;
+				} else {
+					$lastWasNewline = false;
+				}
+			}
+		}
+
+		if ( null === $blankLineToken ) {
+			return;
+		}
+
+		$fix = $phpcsFile->addFixableError(
+			'Remove blank line inside short if block (3 lines or less).',
+			$blankLineToken,
+			'BlankLineInShortIf'
+		);
+
+		if ( true === $fix ) {
+			$phpcsFile->fixer->beginChangeset();
+
+			$content = $tokens[ $blankLineToken ]['content'];
+
+			// Remove one newline from the whitespace.
+			if ( substr_count( $content, "\n" ) >= 2 ) {
+				// Replace double newline with single newline, preserving indentation.
+				$newContent = preg_replace( "/\n\n/", "\n", $content, 1 );
+				$phpcsFile->fixer->replaceToken( $blankLineToken, $newContent );
+			} elseif ( $content === "\n" ) {
+				// This is a standalone newline token that creates a blank line.
+				$phpcsFile->fixer->replaceToken( $blankLineToken, '' );
+			}
+
+			$phpcsFile->fixer->endChangeset();
+		}
+	}
+}
diff --git a/phpcs.xml b/phpcs.xml
@@ -291,4 +291,5 @@
 	<rule ref="Formidable.WhiteSpace.ShortFunctionBlankLine" />
 	<rule ref="Formidable.CodeAnalysis.SimplifyIfReturn" />
 	<rule ref="Formidable.CodeAnalysis.PreferObGetClean" />
+	<rule ref="Formidable.WhiteSpace.NoBlankLineInShortIf" />
 </ruleset>

Original file line number	Diff line number	Diff line change
`@@ -269,7 +269,6 @@ public static function license_settings() {`
`269`	`269`
`270`	`270`	`if ( ! $plugins ) {`
`271`	`271`	`esc_html_e( 'There are no plugins on your site that require a license', 'formidable' );`
`272`		`-`
`273`	`272`	`return;`
`274`	`273`	`}`
`275`	`274`
`@@ -1546,7 +1545,6 @@ private static function allowed_external_urls() {`
`1546`	`1545`
`1547`	`1546`	`if ( ! is_array( $allowed_url_list ) ) {`
`1548`	`1547`	`_doing_it_wrong( __METHOD__, 'Only an array of URLs could be used within this filter.', '6.3.1' );`
`1549`		`-`
`1550`	`1548`	`return array();`
`1551`	`1549`	`}`
`1552`	`1550`
Original file line number	Diff line number	Diff line change
`@@ -978,7 +978,6 @@ public static function delete_all() {`
`978`	`978`
`979`	`979`	`if ( $permission_error !== false ) {`
`980`	`980`	`self::display_forms_list( array(), '', array( $permission_error ) );`
`981`		`-`
`982`	`981`	`return;`
`983`	`982`	`}`
`984`	`983`
`@@ -2027,23 +2026,20 @@ public static function process_bulk_form_actions( $errors ) {`
`2027`	`2026`
`2028`	`2027`	`if ( $bulkaction && str_starts_with( $bulkaction, 'bulk_' ) ) {`
`2029`	`2028`	`FrmAppHelper::remove_get_action();`
`2030`		`-`
`2031`	`2029`	`$bulkaction = str_replace( 'bulk_', '', $bulkaction );`
`2032`	`2030`	`}`
`2033`	`2031`
`2034`	`2032`	`$ids = FrmAppHelper::get_param( 'item-action', '', 'get', 'sanitize_text_field' );`
`2035`	`2033`
`2036`	`2034`	`if ( ! $ids ) {`
`2037`	`2035`	`$errors[] = __( 'No forms were specified', 'formidable' );`
`2038`		`-`
`2039`	`2036`	`return $errors;`
`2040`	`2037`	`}`
`2041`	`2038`
`2042`	`2039`	`$permission_error = FrmAppHelper::permission_nonce_error( '', '_wpnonce', 'bulk-toplevel_page_formidable' );`
`2043`	`2040`
`2044`	`2041`	`if ( $permission_error !== false ) {`
`2045`	`2042`	`$errors[] = $permission_error;`
`2046`		`-`
`2047`	`2043`	`return $errors;`
`2048`	`2044`	`}`
`2049`	`2045`
Original file line number	Diff line number	Diff line change
`@@ -2082,7 +2082,6 @@ public static function post_edit_link( $post_id ) {`
`2082`	`2082`
`2083`	`2083`	`if ( $post ) {`
`2084`	`2084`	`$post_url = admin_url( 'post.php?post=' . $post_id . '&action=edit' );`
`2085`		`-`
`2086`	`2085`	`return '<a href="' . esc_url( $post_url ) . '">' . self::truncate( $post->post_title, 50 ) . '</a>';`
`2087`	`2086`	`}`
`2088`	`2087`
`@@ -2389,7 +2388,6 @@ public static function permission_check( $permission, $show_message = 'show' ) {`
`2389`	`2388`	`public static function permission_nonce_error( $permission, $nonce_name = '', $nonce = '' ) {`
`2390`	`2389`	`if ( $permission && ! current_user_can( $permission ) && ! current_user_can( 'administrator' ) ) {`
`2391`	`2390`	`$frm_settings = self::get_settings();`
`2392`		`-`
`2393`	`2391`	`return $frm_settings->admin_permission;`
`2394`	`2392`	`}`
`2395`	`2393`
Original file line number	Diff line number	Diff line change
`@@ -208,7 +208,6 @@ public function no_items() {`
`208`	`208`
`209`	`209`	`if ( $s ) {`
`210`	`210`	`esc_html_e( 'No Entries Found', 'formidable' );`
`211`		`-`
`212`	`211`	`return;`
`213`	`212`	`}`
`214`	`213`
Original file line number	Diff line number	Diff line change
`@@ -1726,7 +1726,6 @@ public static function get_plan_required( &$item ) {`
`1726`	`1726`	`foreach ( $item['categories'] as $k => $category ) {`
`1727`	`1727`	`if ( in_array( $category, $plans, true ) ) {`
`1728`	`1728`	`unset( $item['categories'][ $k ] );`
`1729`		`-`
`1730`	`1729`	`return self::convert_legacy_package_names( $category );`
`1731`	`1730`	`}`
`1732`	`1731`	`}`
Original file line number	Diff line number	Diff line change
`@@ -1865,7 +1865,6 @@ private static function remove_default_html( $html_name, $defaults, &$options )`
`1865`	`1865`	`// phpcs:ignore Universal.Operators.StrictComparisons`
`1866`	`1866`	`if ( $old_html == $default_html ) {`
`1867`	`1867`	`unset( $options[ $html_name ] );`
`1868`		`-`
`1869`	`1868`	`return;`
`1870`	`1869`	`}`
`1871`	`1870`
Original file line number	Diff line number	Diff line change
`@@ -867,7 +867,6 @@ private function get_license_status() {`
`867`	`867`
`868`	`868`	`if ( empty( $this->license ) ) {`
`869`	`869`	`$response['error'] = false;`
`870`		`-`
`871`	`870`	`return $response;`
`872`	`871`	`}`
`873`	`872`
Original file line number	Diff line number	Diff line change
`@@ -106,7 +106,6 @@ public function append_file( $file_content ) {`
`106`	`106`	`if ( $this->has_permission ) {`
`107`	`107`
`108`	`108`	`if ( file_exists( $this->new_file_path ) ) {`
`109`		`-`
`110`	`109`	`$existing_content = $this->get_contents();`
`111`	`110`	`$file_content = $existing_content . $file_content;`
`112`	`111`	`}`
Original file line number	Diff line number	Diff line change
`@@ -276,7 +276,6 @@ public static function get_entry_meta_by_field( $entry_id, $field_id ) {`
`276`	`276`
`277`	`277`	`if ( $cached && isset( $cached->metas ) && isset( $cached->metas[ $field_id ] ) ) {`
`278`	`278`	`$result = $cached->metas[ $field_id ];`
`279`		`-`
`280`	`279`	`return wp_unslash( $result );`
`281`	`280`	`}`
`282`	`281`
Original file line number	Diff line number	Diff line change
`@@ -24,7 +24,6 @@ public static function validate( $values, $exclude = false ) {`
`24`	`24`
`25`	`25`	`if ( ! isset( $values['form_id'] ) \|\| ! isset( $values['item_meta'] ) ) {`
`26`	`26`	`$errors['form'] = __( 'There was a problem with your submission. Please try again.', 'formidable' );`
`27`		`-`
`28`	`27`	`return $errors;`
`29`	`28`	`}`
`30`	`29`
`@@ -1128,8 +1127,7 @@ private static function get_all_form_ids_and_flatten_meta( &$values ) { // phpcs`
`1128`	`1127`
`1129`	`1128`	`// Convert name array to string.`
`1130`	`1129`	`if ( isset( $subsubvalue['first'] ) && isset( $subsubvalue['last'] ) ) {`
`1131`		`- $subsubvalue = trim( implode( ' ', $subsubvalue ) );`
`1132`		`-`
	`1130`	`+ $subsubvalue = trim( implode( ' ', $subsubvalue ) );`
`1133`	`1131`	`$values['name_field_ids'][] = $subsubindex;`
`1134`	`1132`	`}`
`1135`	`1133`