add patch command to cache

Author: petitphp

features/cache.feature

@@ -211,15 +211,15 @@ Feature: Managed the WordPress object cache
     When I run `wp cache supports set_multiple`
     Then the return code should be 0
 
-  Scenario: Nested values can be retrieved at any depth.
+  Scenario: Nested values from cache can be retrieved at any depth.
     Given a WP install
     And a wp-content/mu-plugins/test-harness.php file:
       """
       <?php
       $set_foo = function(){
         wp_cache_set( 'my_key', ['foo' => 'bar'] );
         wp_cache_set( 'my_key_2', ['foo' => ['bar' => 'baz']] );
-        wp_cache_set( 'my_key_custom', ['foo_custom' => ['bar_custom' => 'baz_custom']], 'my_custom_group' );
+        wp_cache_set( 'my_key_3', ['foo' => 'bar_custom'], 'my_custom_group' );
       };
 
       WP_CLI::add_hook( 'before_invoke:cache pluck', $set_foo );
@@ -237,8 +237,96 @@ Feature: Managed the WordPress object cache
       baz
       """
 
-    When I try `wp cache pluck my_key_custom foo_custom bar_custom --group=my_custom_group`
+    When I try `wp cache pluck my_key_3 foo --group=my_custom_group`
     Then STDOUT should be:
       """
-      baz_custom
+      bar_custom
+      """
+
+  Scenario: Nested values from cache can be updated at any depth.
+    Given a WP install
+    And a wp-content/mu-plugins/test-harness.php file:
+      """
+      <?php
+      $set_foo = function(){
+        wp_cache_set( 'my_key', ['foo' => 'bar'] );
+        wp_cache_set( 'other_key', ['fuz' => 'biz'] );
+
+        $complex_key = (object) [
+            'foo' => (object) [
+                'bar' => (object) [
+                    'baz' => 2,
+                ],
+            ],
+        ];
+        wp_cache_set( 'complex_key', $complex_key );
+      };
+
+      WP_CLI::add_hook( 'before_invoke:cache patch', $set_foo );
+      """
+
+    When I try `wp cache patch insert my_key fuz baz`
+    Then STDOUT should be:
+      """
+      Success: Updated cache key 'my_key'.
+      """
+
+    When I try `wp cache patch insert complex_key foo bar fuz 34`
+    Then STDOUT should be:
+      """
+      Success: Updated cache key 'complex_key'.
+      """
+
+    When I try `wp cache patch insert unknown_key foo bar`
+    Then STDERR should be:
+      """
+      Error: Cannot create key "foo" on data type boolean
+      """
+
+    When I try `wp cache patch update my_key foo test`
+    Then STDOUT should be:
+      """
+      Success: Updated cache key 'my_key'.
+      """
+
+    When I try `wp cache patch update other_key fuz biz`
+    Then STDOUT should be:
+      """
+      Success: Value passed for cache key 'other_key' is unchanged.
+      """
+
+    When I try `wp cache patch update complex_key foo bar baz 34`
+    Then STDOUT should be:
+      """
+      Success: Updated cache key 'complex_key'.
+      """
+
+    When I try `wp cache patch update unknown_key foo test`
+    Then STDERR should be:
+      """
+      Error: No data exists for key "foo"
+      """
+
+    When I try `wp cache patch update my_key bar test`
+    Then STDERR should be:
+      """
+      Error: No data exists for key "bar"
+      """
+
+    When I try `wp cache patch delete my_key foo`
+    Then STDOUT should be:
+      """
+      Success: Updated cache key 'my_key'.
+      """
+
+    When I try `wp cache patch delete unknown_key foo`
+    Then STDERR should be:
+      """
+      Error: No data exists for key "foo"
+      """
+
+    When I try `wp cache patch delete my_key bar`
+    Then STDERR should be:
+      """
+      Error: No data exists for key "bar"
       """

src/Cache_Command.php

@@ -464,4 +464,92 @@ public function pluck( $args, $assoc_args ) {
 
 		WP_CLI::print_value( $value, $assoc_args );
 	}
+
+	/**
+	 * Update a nested value from the cache.
+	 *
+	 * ## OPTIONS
+	 *
+	 * <action>
+	 * : Patch action to perform.
+	 * ---
+	 * options:
+	 *   - insert
+	 *   - update
+	 *   - delete
+	 * ---
+	 *
+	 * <key>
+	 * : Cache key.
+	 *
+	 * <key-path>...
+	 * : The name(s) of the keys within the value to locate the value to pluck.
+	 *
+	 * [<value>]
+	 * : The new value. If omitted, the value is read from STDIN.
+	 *
+	 * [--group=<group>]
+	 * : Method for grouping data within the cache which allows the same key to be used across groups.
+	 * ---
+	 * default: default
+	 * ---
+	 *
+	 * [--format=<format>]
+	 * : The serialization format for the value.
+	 * ---
+	 * default: plaintext
+	 * options:
+	 *   - plaintext
+	 *   - json
+	 * ---
+	 */
+	public function patch( $args, $assoc_args ) {
+		list( $action, $key ) = $args;
+		$group = Utils\get_flag_value( $assoc_args, 'group' );
+
+		$key_path = array_map( function ( $key ) {
+			if ( is_numeric( $key ) && ( $key === (string) intval( $key ) ) ) {
+				return (int) $key;
+			}
+
+			return $key;
+		}, array_slice( $args, 2 ) );
+
+		if ( 'delete' === $action ) {
+			$patch_value = null;
+		} elseif ( \WP_CLI\Entity\Utils::has_stdin() ) {
+			$stdin_value = WP_CLI::get_value_from_arg_or_stdin( $args, - 1 );
+			$patch_value = WP_CLI::read_value( trim( $stdin_value ), $assoc_args );
+		} else {
+			// Take the patch value as the last positional argument. Mutates $key_path to be 1 element shorter!
+			$patch_value = WP_CLI::read_value( array_pop( $key_path ), $assoc_args );
+		}
+
+		/* Need to make a copy of $current_value here as it is modified by reference */
+		$old_value = wp_cache_get($key, $group);
+		$current_value = $old_value;
+		if (is_object($old_value)) {
+			$current_value = clone $old_value;
+		}
+
+		$traverser = new RecursiveDataStructureTraverser( $current_value );
+
+		try {
+			$traverser->$action( $key_path, $patch_value );
+		} catch ( \Exception $e ) {
+			WP_CLI::error( $e->getMessage() );
+		}
+
+		$patched_value = $traverser->value();
+
+		if ( $patched_value === $old_value ) {
+			WP_CLI::success( "Value passed for cache key '$key' is unchanged." );
+		} else {
+			if ( wp_cache_set( $key, $patched_value, $group ) ) {
+				WP_CLI::success( "Updated cache key '$key'." );
+			} else {
+				WP_CLI::error( "Could not update cache key '$key'." );
+			}
+		}
+	}
 }