Merge pull request #605 from ProgressPlanner/convert-meta/prpl_points

Stop using post-meta to store a task's points

Author: aristath

assets/js/suggested-task.js

@@ -267,7 +267,7 @@ prplSuggestedTask = {
 								'trash' === newStatus ? 'complete' : 'pending'
 							);
 							const eventPoints = parseInt(
-								postData?.meta?.prpl_points
+								postData?.prpl_points
 							);
 
 							// Task is trashed, check if we need to celebrate.

assets/js/widgets/todo.js

@@ -54,7 +54,7 @@ const prplTodoWidget = {
 								detail: {
 									item,
 									insertPosition:
-										1 === item?.meta?.prpl_points
+										1 === item?.prpl_points
 											? 'afterbegin' // Add golden task to the start of the list.
 											: 'beforeend',
 									listId:
@@ -89,7 +89,7 @@ const prplTodoWidget = {
 								detail: {
 									item,
 									insertPosition:
-										1 === item?.meta?.prpl_points
+										1 === item?.prpl_points
 											? 'afterbegin' // Add golden task to the start of the list.
 											: 'beforeend',
 									listId:
@@ -137,13 +137,13 @@ const prplTodoWidget = {
 					const newTask = {
 						...response,
 						meta: {
-							prpl_points: 0,
 							prpl_url: '',
 							...( response.meta || {} ),
 						},
 						provider: 'user',
 						category: 'user',
 						order: prplTodoWidget.getHighestItemOrder() + 1,
+						prpl_points: 0,
 					};
 
 					// Inject the new task into the DOM.

classes/class-suggested-tasks-db.php

@@ -175,16 +175,10 @@ public function update_recommendation( $id, $data ) {
 		}
 
 		$update_data    = [ 'ID' => $id ];
-		$update_meta    = [];
 		$update_terms   = [];
 		$update_results = [];
 		foreach ( $data as $key => $value ) {
 			switch ( $key ) {
-				case 'points':
-				case 'prpl_points':
-					$update_meta[ 'prpl_' . \str_replace( 'prpl_', '', (string) $key ) ] = $value;
-					break;
-
 				case 'category':
 				case 'provider':
 					$update_terms[ "prpl_recommendations_$key" ] = $value;
@@ -200,12 +194,6 @@ public function update_recommendation( $id, $data ) {
 			$update_results[] = (bool) \wp_update_post( $update_data );
 		}
 
-		if ( ! empty( $update_meta ) ) {
-			foreach ( $update_meta as $key => $value ) {
-				$update_results[] = (bool) \update_post_meta( $id, $key, $value );
-			}
-		}
-
 		if ( ! empty( $update_terms ) ) {
 			foreach ( $update_terms as $taxonomy => $term ) {
 				$update_results[] = (bool) \wp_set_object_terms( $id, $term->slug, $taxonomy ); // @phpstan-ignore-line property.nonObject

classes/class-suggested-tasks.php

@@ -281,7 +281,7 @@ public function register_post_type() {
 				'show_in_admin_bar'     => \apply_filters( 'progress_planner_tasks_show_ui', false ),
 				'show_in_rest'          => true,
 				'rest_controller_class' => \Progress_Planner\Rest\Recommendations_Controller::class,
-				'supports'              => [ 'title', 'editor', 'author', 'custom-fields', 'page-attributes' ],
+				'supports'              => [ 'title', 'excerpt', 'editor', 'author', 'custom-fields', 'page-attributes' ],
 				'rewrite'               => false,
 				'menu_icon'             => 'dashicons-admin-tools',
 				'menu_position'         => 5,
@@ -291,11 +291,6 @@ public function register_post_type() {
 		);
 
 		$rest_meta_fields = [
-			'prpl_points'  => [
-				'type'         => 'number',
-				'single'       => true,
-				'show_in_rest' => true,
-			],
 			'prpl_task_id' => [
 				'type'         => 'string',
 				'single'       => true,
@@ -442,13 +437,14 @@ public function rest_prepare_recommendation( $response, $post ) {
 
 			// This has to be the last item to be added because actions use data from previous items.
 			$response->data['prpl_task_actions'] = $provider->get_task_actions( $response->data );
+			$response->data['prpl_points']       = $provider->get_points();
 
 			/*
 			 * Check if task was completed before - for example, comments were disabled and then re-enabled, and remove points if so.
 			 * Those are tasks which are completed by toggling an option, so non repetitive & not user tasks.
 			 */
 			if ( ! \has_term( 'user', 'prpl_recommendations_provider', $post->ID ) && ! $provider->is_repetitive() && $provider->task_has_activity( $response->data['meta']['prpl_task_id'] ) ) {
-				$response->data['meta']['prpl_points'] = 0;
+				$response->data['prpl_points'] = 0;
 			}
 		}
 
@@ -513,7 +509,15 @@ public function get_tasks_in_rest_format( array $args = [] ) {
 			}
 		}
 
-		return $tasks;
+		/**
+		 * Allow other classes to modify the tasks in REST format.
+		 *
+		 * @param array $tasks The tasks.
+		 * @param array $args  The arguments.
+		 *
+		 * @return array
+		 */
+		return \apply_filters( 'progress_planner_suggested_tasks_in_rest_format', $tasks, $args );
 	}
 
 	/**

classes/class-todo.php

@@ -57,7 +57,7 @@ public function maybe_change_first_item_points_on_monday() {
 		foreach ( $pending_items as $task ) {
 			\progress_planner()->get_suggested_tasks_db()->update_recommendation(
 				$task->ID,
-				[ 'points' => $task->ID === $pending_items[0]->ID ? 1 : 0 ]
+				[ 'post_excerpt' => $task->ID === $pending_items[0]->ID ? 'GOLDEN' : '' ]
 			);
 		}
 

classes/suggested-tasks/providers/class-user.php

@@ -47,6 +47,13 @@ class User extends Tasks {
 	 */
 	protected const PROVIDER_ID = 'user';
 
+	/**
+	 * Constructor.
+	 */
+	public function __construct() {
+		\add_filter( 'progress_planner_suggested_tasks_in_rest_format', [ $this, 'modify_task_details_for_user_tasks_rest_format' ], 10, 2 );
+	}
+
 	/**
 	 * Check if the task should be added.
 	 *
@@ -94,4 +101,29 @@ public function add_task_actions( $data = [], $actions = [] ) {
 
 		return $actions;
 	}
+
+	/**
+	 * Modify the task details for user tasks in REST format.
+	 *
+	 * @param array $tasks The tasks.
+	 * @param array $args  The arguments.
+	 *
+	 * @return array
+	 */
+	public function modify_task_details_for_user_tasks_rest_format( $tasks, $args ) {
+		static $modified_tasks = [];
+		if ( ! isset( $tasks['user'] ) || ! isset( $args['include_provider'] ) || ! \in_array( 'user', $args['include_provider'], true ) ) {
+			return $tasks;
+		}
+		foreach ( $tasks['user'] as $key => $task ) {
+			if ( \in_array( $task['id'], $modified_tasks, true ) ) {
+				continue;
+			}
+
+			$task['prpl_points']   = ( isset( $task['excerpt']['rendered'] ) && \str_contains( $task['excerpt']['rendered'], 'GOLDEN' ) ) ? 1 : 0;
+			$tasks['user'][ $key ] = $task;
+			$modified_tasks[]      = $task['id'];
+		}
+		return $tasks;
+	}
 }

classes/update/class-update-190.php

@@ -0,0 +1,57 @@
+<?php
+/**
+ * Update class for version 1.9.0.
+ *
+ * @package Progress_Planner
+ */
+
+namespace Progress_Planner\Update;
+
+/**
+ * Update class for version 1.7.2.
+ *
+ * @package Progress_Planner
+ */
+class Update_190 {
+
+	const VERSION = '1.9.0';
+
+	/**
+	 * Run the update.
+	 *
+	 * @return void
+	 */
+	public function run() {
+		// Migrate the golden task.
+		$this->migrate_golden_todo_task();
+	}
+
+	/**
+	 * Migrate the golden task.
+	 *
+	 * @return void
+	 */
+	private function migrate_golden_todo_task() {
+		// Get all user tasks.
+		$tasks = \progress_planner()->get_suggested_tasks_db()->get_tasks_by( [ 'provider_id' => 'user' ] );
+
+		// Loop through tasks and update the `post_excerpt` if the `prpl_points` meta is set to 1.
+		global $wpdb;
+		foreach ( $tasks as $task ) {
+			// Get the `prpl_points` meta.
+			// We'll be getting the value directly from the database since the post-meta is no longer used.
+			$points = $wpdb->get_var( // phpcs:ignore WordPress.DB.DirectDatabaseQuery.DirectQuery, WordPress.DB.DirectDatabaseQuery.NoCaching
+				$wpdb->prepare(
+					"SELECT meta_value FROM {$wpdb->postmeta} WHERE post_id = %d AND meta_key = 'prpl_points'", // @phpstan-ignore-line property.nonObject
+					$task->ID
+				)
+			);
+			if ( 1 === (int) $points ) {
+				\progress_planner()->get_suggested_tasks_db()->update_recommendation(
+					$task->ID,
+					[ 'post_excerpt' => 'GOLDEN' ]
+				);
+			}
+		}
+	}
+}

views/js-templates/suggested-task.html

@@ -1,5 +1,5 @@
 <script type="text/html" id="tmpl-prpl-suggested-task">
-	<li class="prpl-suggested-task" data-task-id="{{ data.post.meta.prpl_task_id || data.post.id }}" data-post-id="{{ data.post.id }}" data-task-action="{{ data.action }}" data-task-url="{{ data.post.meta.prpl_url }}" data-task-provider-id="{{ data.post.prpl_provider.slug }}" data-task-points="{{ data.post.meta.prpl_points }}" data-task-category="{{ data.post.prpl_category.slug }}" data-task-order="{{ data.post.menu_order }}">
+	<li class="prpl-suggested-task" data-task-id="{{ data.post.meta.prpl_task_id || data.post.id }}" data-post-id="{{ data.post.id }}" data-task-action="{{ data.action }}" data-task-url="{{ data.post.meta.prpl_url }}" data-task-provider-id="{{ data.post.prpl_provider.slug }}" data-task-points="{{ data.post.prpl_points }}" data-task-category="{{ data.post.prpl_category.slug }}" data-task-order="{{ data.post.menu_order }}">
 		<div class="prpl-suggested-task-checkbox-wrapper">
 			<# if ( 'user' === data.post.prpl_category.slug ) { #>
 				<label>
@@ -20,9 +20,9 @@ <h3 class="prpl-task-title">
 		</div>
 
 		<div class="prpl-suggested-task-points-wrapper">
-			<# if ( data.post.meta.prpl_points ) { #>
+			<# if ( data.post.prpl_points ) { #>
 				<span class="prpl-suggested-task-points">
-					+{{ data.post.meta.prpl_points }}
+					+{{ data.post.prpl_points }}
 				</span>
 			<# } #>