Remove todos (#54)

* Remove all todos, in support of issues instead

* Drop more todos

Author: ingeniumed

class-workflow.php

@@ -294,8 +294,6 @@ public function update_all_module_options( $mod_name, $new_options ) {
 	 * @return array $post_types All of the post types that are 'on'
 	 */
 	public function get_supported_post_types(): array {
-		// ToDo: Move this function to a shared static helper after we've refactored into static modules
-
 		$post_types         = [];
 		$post_types_options = $this->settings->module->options->post_types;
 

modules/custom-status/custom-status.php

@@ -297,8 +297,6 @@ public function load_styles_for_block_editor() {
 
 	/**
 	 * Check whether custom status stuff should be loaded on this page
-	 *
-	 * @todo migrate this to the base module class
 	 */
 	public function is_whitelisted_page() {
 		global $pagenow;
@@ -319,8 +317,6 @@ public function is_whitelisted_page() {
 
 	/**
 	 * Adds all necessary javascripts to make custom statuses work
-	 *
-	 * @todo Support private and future posts on edit.php view
 	 */
 	public function post_admin_header() {
 		global $post, $pagenow;
@@ -339,7 +335,6 @@ public function post_admin_header() {
 
 			// $selected can be empty, but must be set because it's used as a JS variable
 			$selected      = '';
-			$selected_name = '';
 
 			if ( ! empty( $post ) ) {
 				// Get the status of the current post
@@ -460,10 +455,6 @@ private function generate_error_and_delete_bad_data( int $term_id, string $meta
 		return new WP_Error( 'invalid', sprintf( __( 'Unable to create the custom status, as the %s failed to save.', 'vip-workflow' ), $meta ) );
 	}
 
-	// ToDo: Once custom status has been refactored, the below CRUD methods should be unified with the
-	// ones from Editorial metadata module and turned into a utility class focused on DB operations.
-	// We could call that utility class ORM or DAO.
-
 	/**
 	 * Adds a new custom status as a term in the wp_terms table.
 	 * Basically a wrapper for the wp_insert_term class.
@@ -678,7 +669,6 @@ public function delete_custom_status( int $status_id ): bool|WP_Error {
 		// Re-order the positions after deletion
 		$custom_statuses = $this->get_custom_statuses();
 
-		// ToDo: Optimize this to only work on the next or previous item.
 		$current_postition = 1;
 
 		// save each status with the new position
@@ -814,8 +804,6 @@ public function reassign_post_status( string $old_status, string $new_status ):
 		return true;
 	}
 
-	// ToDo: Move all these hacks to a separate class focused on core hacks, that gets init at the top of the file.
-
 	/**
 	 * Display our custom post statuses in post listings when needed.
 	 *

modules/custom-status/lib/custom-status.js

@@ -1,4 +1,3 @@
-// ToDo: Refactor to use vanilla JS instead.
 jQuery( document ).ready( function () {
 	const i18n = window.__vw_localize_custom_status;
 

modules/custom-status/rest/custom-status-endpoint.php

@@ -92,7 +92,6 @@ public static function register_routes() {
 					'required'          => true,
 					'validate_callback' => function ( $param ) {
 						$term_id = absint( $param );
-						// ToDo: Switch this to our own method once Custom Status module has been refactored.
 						$term    = get_term( $term_id, Custom_Status::TAXONOMY_KEY );
 						return ( $term instanceof WP_Term );
 					},
@@ -141,7 +140,6 @@ public static function register_routes() {
 					'required'          => true,
 					'validate_callback' => function ( $param ) {
 						$term_id = absint( $param );
-						// ToDo: Switch this to our own method once Custom Status module has been refactored.
 						$term    = get_term( $term_id, Custom_Status::TAXONOMY_KEY );
 						return ( $term instanceof WP_Term );
 					},
@@ -168,7 +166,6 @@ public static function register_routes() {
 						// validate each item in the array.
 						foreach ( $param as $position => $term_id ) {
 							$term_id = absint( $term_id );
-							// ToDo: Switch this to our own method once Custom Status module has been refactored.
 							$term    = get_term( $term_id, Custom_Status::TAXONOMY_KEY );
 							if ( ! $term instanceof WP_Term ) {
 								return false;
@@ -343,7 +340,6 @@ public static function handle_reorder_status( WP_REST_Request $request ) {
 			return new WP_Error( 'invalid', 'Status order must be an array.' );
 		}
 
-		// ToDo: Switch this to be a bulk update instead.
 		foreach ( $status_order as $position => $term_id ) {
 
 			// Have to add 1 to the position because the index started with zero
@@ -371,7 +367,6 @@ private static function is_valid_editorial_metadata_ids( $metadata_ids ) {
 			return true;
 		}
 
-		// ToDo: Optimize this to batch fetch metadata terms, and only include the ID field.
 		foreach ( $metadata_ids as $metadata_id ) {
 			$editorial_metadata = EditorialMetadata::get_editorial_metadata_term_by( 'id', $metadata_id );
 			if ( is_wp_error( $editorial_metadata ) || ! $editorial_metadata ) {

modules/editorial-metadata/rest/editorial-metadata-endpoint.php

@@ -211,7 +211,6 @@ public static function handle_update_editorial_metadata( WP_REST_Request $reques
 			'name'        => $editorial_metadata_name,
 		];
 
-		// ToDo: Ensure that we don't do an update when the name, description and type are the same as the current editorial metadata
 		$update_editorial_metadata_result = EditorialMetadata::update_editorial_metadata_term( $term_id, $args );
 
 		// Regardless of an error being thrown, the result will be returned so the client can handle it.
@@ -225,7 +224,6 @@ public static function handle_update_editorial_metadata( WP_REST_Request $reques
 	 */
 	public static function handle_delete_editorial_metadata( WP_REST_Request $request ) {
 		$term_id = $request->get_param( 'id' );
-
 		// Check to make sure the editorial metadata exists
 		$editorial_metadata_by_id = EditorialMetadata::get_editorial_metadata_term_by( 'id', $term_id );
 		if ( ! $editorial_metadata_by_id ) {

modules/notifications/notifications.php

@@ -237,7 +237,6 @@ public static function schedule_emails( string $action, WP_Post $post, string $s
 	public static function send_emails( array $recipients, string $subject, string $message, string $message_headers = '' ): void {
 		$response = wp_mail( $recipients, $subject, $message, $message_headers );
 
-		// ToDo: Switch to using log2logstash instead of error_log.
 		if ( ! $response ) {
 			// phpcs:ignore WordPress.PHP.DevelopmentFunctions.error_log_error_log
 			error_log( 'Unable to send notification to email(s) provided.' );
@@ -296,7 +295,6 @@ public static function send_to_webhook( string $message, string $message_type, s
 			]
 		);
 
-		// ToDo: Switch to using log2logstash instead of error_log.
 		if ( is_wp_error( $response ) ) {
 			// phpcs:ignore WordPress.PHP.DevelopmentFunctions.error_log_error_log
 			error_log( 'Unable to send notification to webhook provided.' );

modules/settings/settings.php

@@ -175,8 +175,6 @@ public function helper_option_custom_post_type( $args = array() ) {
 	 * Validate input from the end user
 	 */
 	public function settings_validate( $new_options ) {
-		// ToDo: There's no error messages shown right now, or any kind of notice that data is invalid.
-
 		// Whitelist validation for the post type options
 		if ( ! isset( $new_options['post_types'] ) ) {
 			$new_options['post_types'] = [];

phpcs.xml.dist

@@ -53,10 +53,6 @@
 		<!-- Localization is done in a legacy manner in some places, and its been left as is for now -->
 		<exclude name="WordPress.WP.I18n.InterpolatedVariableSingular" />
 		<exclude name="WordPress.WP.I18n.InterpolatedVariablePlural" />
-		<exclude name="WordPress.WP.I18n.MissingSingularPlaceholder" />
-		<exclude name="WordPress.WP.I18n.NonSingularStringLiteralText" />
-		<!-- This rule is hard to solve given the heavy use of JS in the PHP code right now -->
-		<exclude name="Squiz.PHP.DisallowMultipleAssignments.FoundInControlStructure" />
 	</rule>
 
 </ruleset>

vip-workflow.php

@@ -22,7 +22,6 @@
 
 define( 'VIP_WORKFLOW_LOADED', true );
 
-// ToDo: When 6.4 is our min version, switch to wp_admin_notice.
 global $wp_version;
 if ( version_compare( phpversion(), '8.0', '<' ) || version_compare( $wp_version, '6.2', '<' ) ) {
 		add_action( 'admin_notices', function () {