Add pantheon-wp-coding-standards (#247)

* use pantheon coding standards
exclude vip minimum which flags a lot of session-related code

* add phpcbf script and run it

* remove empty return statement per phpcs

* set the linting box to php8.0

Author: jazzsequence

.circleci/config.yml

@@ -21,7 +21,7 @@ jobs:
   lint:
     working_directory: ~/pantheon-systems/wp-native-php-sessions
     docker:
-      - image: quay.io/pantheon-public/build-tools-ci:8.x-php8.2
+      - image: quay.io/pantheon-public/build-tools-ci:8.x-php8.0
     steps:
       - checkout
       - restore_cache:

composer.json

@@ -15,15 +15,14 @@
     ],
     "require-dev": {
         "pantheon-systems/pantheon-wordpress-upstream-tests": "dev-master",
-        "wp-coding-standards/wpcs": "dev-develop as 2.3.1",
-        "dealerdirect/phpcodesniffer-composer-installer": "^1.0.0",
+        "pantheon-systems/pantheon-wp-coding-standards": "^1.0",
         "phpunit/phpunit": "^9",
-        "phpcompatibility/php-compatibility": "^9.3",
         "yoast/phpunit-polyfills": "^1.0"
     },
     "scripts": {
         "lint": "@phpcs",
         "phpcs": "vendor/bin/phpcs",
+        "phpcbf": "vendor/bin/phpcbf",
         "phpunit": "vendor/bin/phpunit",
         "test": "@phpunit"
     },

composer.lock

@@ -44,16 +44,16 @@ public static function get_instance() {
 	 */
 	private function setup_actions() {
 
-		add_action( 'admin_menu', array( $this, 'action_admin_menu' ) );
-		add_action( 'wp_ajax_pantheon_clear_session', array( $this, 'handle_clear_session' ) );
+		add_action( 'admin_menu', [ $this, 'action_admin_menu' ] );
+		add_action( 'wp_ajax_pantheon_clear_session', [ $this, 'handle_clear_session' ] );
 	}
 
 	/**
 	 * Register the admin menu
 	 */
 	public function action_admin_menu() {
 
-		add_management_page( __( 'Pantheon Sessions', 'wp-native-php-sessions' ), __( 'Sessions', 'wp-native-php-sessions' ), self::$capability, 'pantheon-sessions', array( $this, 'handle_page' ) );
+		add_management_page( __( 'Pantheon Sessions', 'wp-native-php-sessions' ), __( 'Sessions', 'wp-native-php-sessions' ), self::$capability, 'pantheon-sessions', [ $this, 'handle_page' ] );
 	}
 
 	/**
@@ -68,16 +68,16 @@ public function handle_page() {
 		echo '<div class="wrap">';
 
 		echo '<div>';
-		$query_args = array(
+		$query_args = [
 			'action'  => 'pantheon_clear_session',
 			'nonce'   => wp_create_nonce( 'pantheon_clear_session' ),
 			'session' => 'all',
-		);
+		];
 		if ( $wpdb->get_var( "SELECT COUNT(session_id) FROM $wpdb->pantheon_sessions" ) ) {
 			echo '<a class="button pantheon-clear-all-sessions" style="float:right; margin-top: 9px;" href="' . esc_url( add_query_arg( $query_args, admin_url( 'admin-ajax.php' ) ) ) . '">' . esc_html__( 'Clear All', 'wp-native-php-sessions' ) . '</a>';
 		}
 		echo '<h2>' . esc_html__( 'Pantheon Sessions', 'wp-native-php-sessions' ) . '</h2>';
-		if ( isset( $_GET['message'] ) && in_array( $_GET['message'], array( 'delete-all-session', 'delete-session' ), true ) ) {
+		if ( isset( $_GET['message'] ) && in_array( $_GET['message'], [ 'delete-all-session', 'delete-session' ], true ) ) {
 			if ( 'delete-all-session' === $_GET['message'] ) {
 				$message = __( 'Cleared all sessions.', 'wp-native-php-sessions' );
 			} elseif ( 'delete-session' === $_GET['message'] ) {
@@ -93,7 +93,7 @@ public function handle_page() {
 
 		echo '</div>';
 
-		add_action( 'admin_footer', array( $this, 'action_admin_footer' ) );
+		add_action( 'admin_footer', [ $this, 'action_admin_footer' ] );
 	}
 
 	/**

inc/class-admin.php

@@ -29,13 +29,13 @@ public function list_( $args, $assoc_args ) {
 			WP_CLI::error( 'Pantheon Sessions is currently disabled.' );
 		}
 
-		$defaults   = array(
+		$defaults   = [
 			'format' => 'table',
 			'fields' => 'session_id,user_id,datetime,ip_address,data',
-		);
+		];
 		$assoc_args = array_merge( $defaults, $assoc_args );
 
-		$sessions = array();
+		$sessions = [];
 		foreach ( new \WP_CLI\Iterators\Query( "SELECT * FROM {$wpdb->pantheon_sessions} ORDER BY datetime DESC" ) as $row ) {
 			$sessions[] = $row;
 		}

inc/class-cli-command.php

@@ -19,9 +19,9 @@ public function prepare_items() {
 		global $wpdb;
 
 		$columns               = $this->get_columns();
-		$hidden                = array();
-		$sortable              = array();
-		$this->_column_headers = array( $columns, $hidden, $sortable );
+		$hidden                = [];
+		$sortable              = [];
+		$this->_column_headers = [ $columns, $hidden, $sortable ];
 
 		$per_page = 20;
 		$paged    = ( isset( $_GET['paged'] ) ) ? (int) $_GET['paged'] : 1;
@@ -31,10 +31,10 @@ public function prepare_items() {
 		$total_items = $wpdb->get_var( "SELECT COUNT(*) FROM $wpdb->pantheon_sessions" );
 
 		$this->set_pagination_args(
-			array(
+			[
 				'total_items' => $total_items,
 				'per_page'    => $per_page,
-			)
+			]
 		);
 	}
 
@@ -49,13 +49,13 @@ public function no_items() {
 	 * Get the columns in the list table
 	 */
 	public function get_columns() {
-		return array(
+		return [
 			'session_id' => __( 'Session ID', 'wp-native-php-sessions' ),
 			'user_id'    => __( 'User ID', 'wp-native-php-sessions' ),
 			'ip_address' => __( 'IP Address', 'wp-native-php-sessions' ),
 			'datetime'   => __( 'Last Active', 'wp-native-php-sessions' ),
 			'data'       => __( 'Data', 'wp-native-php-sessions' ),
-		);
+		];
 	}
 
 	/**
@@ -68,14 +68,14 @@ public function column_default( $item, $column_name ) {
 		if ( 'data' === $column_name ) {
 			return '<code>' . esc_html( $item->data ) . '</code>';
 		} elseif ( 'session_id' === $column_name ) {
-			$query_args = array(
+			$query_args = [
 				'action'  => 'pantheon_clear_session',
 				'nonce'   => wp_create_nonce( 'pantheon_clear_session' ),
 				'session' => $item->session_id,
-			);
-			$actions    = array(
+			];
+			$actions    = [
 				'clear' => '<a href="' . esc_url( add_query_arg( $query_args, admin_url( 'admin-ajax.php' ) ) ) . '">' . esc_html__( 'Clear', 'wp-native-php-sessions' ) . '</a>',
-			);
+			];
 			return esc_html( $item->session_id ) . $this->row_actions( $actions );
 		} elseif ( 'datetime' === $column_name ) {
 			// translators: Time ago.

inc/class-list-table.php

@@ -17,14 +17,14 @@ class Session {
 	 *
 	 * @var array
 	 */
-	private static $sessions = array();
+	private static $sessions = [];
 
 	/**
 	 * Any secure sessions stored statically.
 	 *
 	 * @var array
 	 */
-	private static $secure_sessions = array();
+	private static $secure_sessions = [];
 
 	/**
 	 * Session id.
@@ -84,10 +84,10 @@ public static function create_for_sid( $sid ) {
 
 		$wpdb = self::restore_wpdb_if_null( $wpdb );
 
-		$insert_data = array(
+		$insert_data = [
 			'session_id' => $sid,
 			'user_id'    => (int) get_current_user_id(),
-		);
+		];
 		if ( function_exists( 'is_ssl' ) && is_ssl() ) {
 			$insert_data['secure_session_id'] = $sid;
 		}
@@ -148,10 +148,10 @@ public function set_user_id( $user_id ) {
 		$this->user_id = (int) $user_id;
 		$wpdb->update(
 			$wpdb->pantheon_sessions,
-			array(
+			[
 				'user_id' => $this->user_id,
-			),
-			array( self::get_session_id_column() => $this->get_id() )
+			],
+			[ self::get_session_id_column() => $this->get_id() ]
 		);
 	}
 
@@ -175,13 +175,13 @@ public function set_data( $data ) {
 
 		$wpdb->update(
 			$wpdb->pantheon_sessions,
-			array(
+			[
 				'user_id'    => (int) get_current_user_id(),
 				'datetime'   => gmdate( 'Y-m-d H:i:s' ),
 				'ip_address' => self::get_client_ip_server(),
 				'data'       => maybe_serialize( $data ),
-			),
-			array( self::get_session_id_column() => $this->get_id() )
+			],
+			[ self::get_session_id_column() => $this->get_id() ]
 		);
 
 		$this->data = maybe_serialize( $data );
@@ -197,14 +197,14 @@ public static function get_client_ip_server() {
 		$ip_address = apply_filters( 'pantheon_sessions_client_ip_default', '127.0.0.1' );
 		$ip_source  = null;
 
-		$keys = array(
+		$keys = [
 			'HTTP_CLIENT_IP',
 			'HTTP_X_FORWARDED_FOR',
 			'HTTP_X_FORWARDED',
 			'HTTP_FORWARDED_FOR',
 			'HTTP_FORWARDED',
 			'REMOTE_ADDR',
-		);
+		];
 
 		$ip_filter_flags = apply_filters( 'pantheon_sessions_client_ip_filter_flags', FILTER_FLAG_IPV4 | FILTER_FLAG_IPV6 | FILTER_FLAG_NO_RES_RANGE );
 
@@ -243,10 +243,10 @@ public function destroy() {
 
 		$wpdb = self::restore_wpdb_if_null( $wpdb );
 
-		$wpdb->delete( $wpdb->pantheon_sessions, array( self::get_session_id_column() => $this->get_id() ) );
+		$wpdb->delete( $wpdb->pantheon_sessions, [ self::get_session_id_column() => $this->get_id() ] );
 
 		// Reset $_SESSION to prevent a new session from being started.
-		$_SESSION = array();
+		$_SESSION = [];
 
 		$this->delete_cookies();
 	}
@@ -280,11 +280,11 @@ private function delete_cookies() {
 		}
 
 		$session_name = session_name();
-		$cookies      = array(
+		$cookies      = [
 			$session_name,
 			substr( $session_name, 1 ),
 			'S' . $session_name,
-		);
+		];
 
 		foreach ( $cookies as $cookie_name ) {
 

inc/class-session.php

@@ -62,8 +62,8 @@ private function load() {
 			$this->setup_database();
 			$this->initialize_session_override();
 			$this->set_ini_values();
-			add_action( 'set_logged_in_cookie', array( __CLASS__, 'action_set_logged_in_cookie' ), 10, 4 );
-			add_action( 'clear_auth_cookie', array( __CLASS__, 'action_clear_auth_cookie' ) );
+			add_action( 'set_logged_in_cookie', [ __CLASS__, 'action_set_logged_in_cookie' ], 10, 4 );
+			add_action( 'clear_auth_cookie', [ __CLASS__, 'action_clear_auth_cookie' ] );
 		}
 	}
 
@@ -239,10 +239,7 @@ public static function force_first_load() {
 				update_option( 'active_plugins', $plugins );
 			}
 		}
-
-		return;
 	}
-
 }
 
 /**

pantheon-sessions.php

@@ -9,7 +9,10 @@
 	<!-- Show progress and sniff codes in all reports -->
 	<arg value="ps"/>
 
-	<rule ref="WordPress-Core" />
+	<rule ref="Pantheon-WP">
+		<!-- Ignore all of the VIP rules. These mostly deal with sessions, and that's explicitly what this plugin does. -->
+		<exclude name="WordPressVIPMinimum" />
+	</rule>
 	<rule ref="WordPress-Docs" />
 	<rule ref="PHPCompatibility"/>
 
@@ -33,10 +36,4 @@
 	<rule ref="Squiz.Commenting.FunctionComment.MissingParamTag">
 		<exclude-pattern>*/inc/class-cli-command.php</exclude-pattern>
 	</rule>
-
-  <!-- Excluded sniffs -->
-  <rule ref="Universal.Operators.DisallowShortTernary.Found">
-    <exclude-pattern>*/inc/*</exclude-pattern>
-    <exclude-pattern>pantheon-sessions.php</exclude-pattern>
-  </rule>
 </ruleset>

phpcs.xml.dist

@@ -30,15 +30,15 @@ public function test_database_created() {
 		$column_data = $wpdb->get_results( "SHOW COLUMNS FROM {$table_name}" );
 		$columns     = wp_list_pluck( $column_data, 'Field' );
 		$this->assertEquals(
-			array(
+			[
 				'id',
 				'user_id',
 				'session_id',
 				'secure_session_id',
 				'ip_address',
 				'datetime',
 				'data',
-			),
+			],
 			$columns
 		);
 	}