Add wp post revision restore, diff, and prune commands

composer.json

@@ -114,6 +114,10 @@
             "post meta patch",
             "post meta pluck",
             "post meta update",
+            "post revision",
+            "post revision diff",
+            "post revision prune",
+            "post revision restore",
             "post term",
             "post term add",
             "post term list",

entity-command.php

@@ -46,6 +46,7 @@
 	)
 );
 WP_CLI::add_command( 'post meta', 'Post_Meta_Command' );
+WP_CLI::add_command( 'post revision', 'Post_Revision_Command' );
 WP_CLI::add_command( 'post term', 'Post_Term_Command' );
 WP_CLI::add_command( 'post-type', 'Post_Type_Command' );
 WP_CLI::add_command( 'site', 'Site_Command' );

features/post-revision.feature

@@ -0,0 +1,256 @@
+Feature: Manage WordPress post revisions
+
+  Background:
+    Given a WP install
+
+  # Creating a published post doesn't create an initial revision,
+  # so we update it twice here and restore the middle version.
+  # See https://github.com/wp-cli/entity-command/issues/564.
+  Scenario: Restore a post revision
+    When I run `wp post create --post_title='Original Post' --post_content='Original content' --porcelain`
+    Then STDOUT should be a number
+    And save STDOUT as {POST_ID}
+
+    When I run `wp post update {POST_ID} --post_content='Updated content'`
+    Then STDOUT should contain:
+      """
+      Success: Updated post {POST_ID}.
+      """
+
+    When I run `wp post list --post_type=revision --post_parent={POST_ID} --format=ids`
+    Then STDOUT should not be empty
+    And save STDOUT as {REVISION_ID}
+
+    When I run `wp post update {POST_ID} --post_content='Another one'`
+    Then STDOUT should contain:
+      """
+      Success: Updated post {POST_ID}.
+      """
+
+    When I run `wp post get {POST_ID} --field=post_content`
+    Then STDOUT should contain:
+      """
+      Another one
+      """
+
+    When I run `wp post revision restore {REVISION_ID}`
+    Then STDOUT should contain:
+      """
+      Success: Restored revision
+      """
+
+    When I run `wp post get {POST_ID} --field=post_content`
+    Then STDOUT should contain:
+      """
+      Updated content
+      """
+
+  Scenario: Restore invalid revision should fail
+    When I try `wp post revision restore 99999`
+    Then STDERR should contain:
+      """
+      Error: Invalid revision ID
+      """
+    And the return code should be 1
+
+  Scenario: Show diff between two revisions
+    When I run `wp post create --post_title='Test Post' --post_content='First version' --porcelain`
+    Then STDOUT should be a number
+    And save STDOUT as {POST_ID}
+
+    When I run `wp post update {POST_ID} --post_content='Second version'`
+    Then STDOUT should contain:
+      """
+      Success: Updated post {POST_ID}.
+      """
+
+    When I run `wp post update {POST_ID} --post_title='New Title' --post_content='Third version'`
+    Then STDOUT should contain:
+      """
+      Success: Updated post {POST_ID}.
+      """
+
+    When I run `wp post list --post_type=revision --post_parent={POST_ID} --fields=ID --format=ids --orderby=ID --order=ASC`
+    Then STDOUT should not be empty
+    And save STDOUT as {REVISION_IDS}
+
+    When I run `echo "{REVISION_IDS}" | awk '{print $1}'`
+    Then save STDOUT as {REVISION_ID_1}
+
+    When I run `echo "{REVISION_IDS}" | awk '{print $2}'`
+    Then save STDOUT as {REVISION_ID_2}
+
+    When I run `wp post revision diff {REVISION_ID_1} {REVISION_ID_2}`
+    Then STDOUT should contain:
+      """
+      - Second version
+      + Third version
+      """
+    And STDOUT should contain:
+      """
+      --- Test Post
+      """
+    And STDOUT should contain:
+      """
+      +++ New Title
+      """
+
+  Scenario: Show diff between revision and current post
+    When I run `wp post create --post_title='Diff Test' --post_content='Original text' --porcelain`
+    Then STDOUT should be a number
+    And save STDOUT as {POST_ID}
+
+    When I run `wp post update {POST_ID} --post_content='Modified text'`
+    Then STDOUT should contain:
+      """
+      Success: Updated post {POST_ID}.
+      """
+
+    When I run `wp post list --post_type=revision --post_parent={POST_ID} --fields=ID --format=ids --orderby=ID --order=ASC`
+    Then STDOUT should not be empty
+    And save STDOUT as {REVISION_ID}
+
+    When I run `wp post revision diff {REVISION_ID}`
+    Then STDOUT should contain:
+      """
+      Success: No difference found.
+      """
+
+  Scenario: Diff with invalid revision should fail
+    When I try `wp post revision diff 99999`
+    Then STDERR should contain:
+      """
+      Error: Invalid 'from' ID
+      """
+    And the return code should be 1
+
+  Scenario: Diff between two invalid revisions should fail
+    When I try `wp post revision diff 99998 99999`
+    Then STDERR should contain:
+      """
+      Error: Invalid 'from' ID
+      """
+    And the return code should be 1
+
+  Scenario: Diff with specific field
+    When I run `wp post create --post_title='Field Test' --post_content='Some content' --porcelain`
+    Then STDOUT should be a number
+    And save STDOUT as {POST_ID}
+
+    When I run `wp post update {POST_ID} --post_title='Modified Field Test'`
+    Then STDOUT should contain:
+      """
+      Success: Updated post {POST_ID}.
+      """
+
+    When I run `wp post list --post_type=revision --post_parent={POST_ID} --fields=ID --format=ids --orderby=ID --order=ASC`
+    Then STDOUT should not be empty
+    And save STDOUT as {REVISION_ID}
+
+    When I run `wp post revision diff {REVISION_ID} --field=post_title`
+    Then the return code should be 0
+
+  Scenario: Prune revisions keeping latest N
+    When I run `wp post create --post_title='Prune Test' --post_content='Version 1' --porcelain`
+    Then STDOUT should be a number
+    And save STDOUT as {POST_ID}
+
+    When I run `wp post update {POST_ID} --post_content='Version 2'`
+    And I run `wp post update {POST_ID} --post_content='Version 3'`
+    And I run `wp post update {POST_ID} --post_content='Version 4'`
+    And I run `wp post update {POST_ID} --post_content='Version 5'`
+
+    # The initial post does not create a revision.
+    # See https://core.trac.wordpress.org/ticket/30854
+    And I run `wp post list --post_type=revision --post_parent={POST_ID} --format=count`
+    Then STDOUT should be:
+      """
+      4
+      """
+
+    When I run `wp post revision prune {POST_ID} --latest=2 --yes`
+    Then STDOUT should contain:
+      """
+      Success: Deleted 2 revisions for post {POST_ID}.
+      """
+
+    When I run `wp post list --post_type=revision --post_parent={POST_ID} --format=count`
+    Then STDOUT should be:
+      """
+      2
+      """
+
+  Scenario: Prune revisions keeping earliest N
+    When I run `wp post create --post_title='Prune Earliest Test' --post_content='Version 1' --porcelain`
+    Then STDOUT should be a number
+    And save STDOUT as {POST_ID}
+
+    When I run `wp post update {POST_ID} --post_content='Version 2'`
+    And I run `wp post update {POST_ID} --post_content='Version 3'`
+    And I run `wp post update {POST_ID} --post_content='Version 4'`
+
+    # The initial post does not create a revision.
+    # See https://core.trac.wordpress.org/ticket/30854
+    And I run `wp post list --post_type=revision --post_parent={POST_ID} --format=count`
+    Then STDOUT should be:
+      """
+      3
+      """
+
+    When I run `wp post revision prune {POST_ID} --earliest=2 --yes`
+    Then STDOUT should contain:
+      """
+      Success: Deleted 1 revision for post {POST_ID}.
+      """
+
+    When I run `wp post list --post_type=revision --post_parent={POST_ID} --format=count`
+    Then STDOUT should be:
+      """
+      2
+      """
+
+  Scenario: Prune revisions for all posts
+    When I run `wp post create --post_title='Post 1' --post_content='Content 1' --porcelain`
+    Then save STDOUT as {POST_ID_1}
+
+    When I run `wp post update {POST_ID_1} --post_content='Update 1'`
+    And I run `wp post update {POST_ID_1} --post_content='Update 2'`
+    And I run `wp post update {POST_ID_1} --post_content='Update 3'`
+
+    And I run `wp post create --post_title='Post 2' --post_content='Content 2' --porcelain`
+    Then save STDOUT as {POST_ID_2}
+
+    When I run `wp post update {POST_ID_2} --post_content='Update 1'`
+    And I run `wp post update {POST_ID_2} --post_content='Update 2'`
+
+    And I run `wp post revision prune --latest=1 --yes`
+    Then STDOUT should contain:
+      """
+      Success: Deleted
+      """
+    And STDOUT should contain:
+      """
+      revisions across
+      """
+
+  Scenario: Prune with no flags should fail
+    When I run `wp post create --post_title='Test' --post_content='Content' --porcelain`
+    Then save STDOUT as {POST_ID}
+
+    When I try `wp post revision prune {POST_ID}`
+    Then STDERR should contain:
+      """
+      Error: Please specify either --latest or --earliest flag.
+      """
+    And the return code should be 1
+
+  Scenario: Prune with both flags should fail
+    When I run `wp post create --post_title='Test' --post_content='Content' --porcelain`
+    Then save STDOUT as {POST_ID}
+
+    When I try `wp post revision prune {POST_ID} --latest=5 --earliest=5`
+    Then STDERR should contain:
+      """
+      Error: Cannot specify both --latest and --earliest flags.
+      """
+    And the return code should be 1

phpcs.xml.dist

@@ -65,7 +65,7 @@
 		<exclude-pattern>*/src/Network_Meta_Command\.php$</exclude-pattern>
 		<exclude-pattern>*/src/Network_Namespace\.php$</exclude-pattern>
 		<exclude-pattern>*/src/Option_Command\.php$</exclude-pattern>
-		<exclude-pattern>*/src/Post(_Block|_Meta|_Term|_Type)?_Command\.php$</exclude-pattern>
+		<exclude-pattern>*/src/Post(_Block|_Meta|_Revision|_Term|_Type)?_Command\.php$</exclude-pattern>
 		<exclude-pattern>*/src/Signup_Command\.php$</exclude-pattern>
 		<exclude-pattern>*/src/Site(_Meta|_Option)?_Command\.php$</exclude-pattern>
 		<exclude-pattern>*/src/Term(_Meta)?_Command\.php$</exclude-pattern>