Fix update command using GF version for add-on slugs (#32)

* Add GF_CLI_Root::get_addon()

* Fix update command using GF version for add-on slugs

* bump version; update change log

Author: richardW8k

change_log.txt

@@ -1,3 +1,7 @@
+= 1.3.2 =
+- Fixed an issue where the version comparison performed when using `wp gf update` with an add-on slug uses the Gravity Forms version number.
+
+
 = 1.3.1 =
 - Added support for using `--version=beta` with the `wp gf install` and `wp gf update` commands. Add-On beta releases are not currently supported.
 - Fixed a fatal error which can occur when using the `wp gf version` command with an add-on slug when Gravity Forms is not active or not installed.

cli.php

@@ -3,7 +3,7 @@
 Plugin Name: Gravity Forms CLI
 Plugin URI: https://gravityforms.com
 Description: Manage Gravity Forms with the WP CLI.
-Version: 1.3.1
+Version: 1.3.2
 Author: Rocketgenius
 Author URI: https://gravityforms.com
 License: GPL-2.0+
@@ -30,7 +30,7 @@
 defined( 'ABSPATH' ) || die();
 
 // Defines the current version of the CLI add-on
-define( 'GF_CLI_VERSION', '1.3.1' );
+define( 'GF_CLI_VERSION', '1.3.2' );
 
 define( 'GF_CLI_MIN_GF_VERSION', '1.9.17.8' );
 

includes/class-gf-cli-root.php

@@ -38,21 +38,8 @@ public function version( $args, $assoc_args ) {
 		if ( $slug == 'gravityforms' ) {
 			WP_CLI::log( GFForms::$version );
 		} else {
-			$addon_class_names = GFAddOn::get_registered_addons();
-			$addon_found = false;
-			foreach ( $addon_class_names as $addon_class_name ) {
-				/* @var GFAddon $addon */
-				$addon = call_user_func( array( $addon_class_name, 'get_instance' ) );
-				if ( $addon->get_slug() == $slug ) {
-					WP_CLI::log( $addon->get_version() );
-					$addon_found = true;
-					break;
-				}
-			}
-
-			if ( ! $addon_found ) {
-				WP_CLI::error( 'Invalid plugin slug: ' . $slug );
-			}
+			$addon = $this->get_addon( $slug );
+			WP_CLI::log( $addon->get_version() );
 		}
 	}
 
@@ -199,24 +186,32 @@ public function update( $args, $assoc_args ) {
 			WP_CLI::error( 'A valid license key must be saved in the settings or specified in the GF_LICENSE_KEY constant or the --key option.' );
 		}
 
+		if ( $slug === 'gravityforms' ) {
+			$current_version = GFForms::$version;
+		} else {
+			$addon           = $this->get_addon( $slug );
+			$current_version = $addon->get_version();
+		}
+
 		$version     = isset( $assoc_args['version'] ) ? $assoc_args['version'] : 'hotfix';
 		$plugin_info = $version === 'beta' ? $this->get_beta_plugin_info( $slug, $key ) : $this->get_plugin_info( $slug, $key );
 
 		if ( $version == 'hotfix' ) {
 			$available_version = isset( $plugin_info['version_latest'] ) ? $plugin_info['version_latest'] : '';
-			$download_url = isset( $plugin_info['download_url_latest'] ) ? $plugin_info['download_url_latest'] : '';
+			$download_url      = isset( $plugin_info['download_url_latest'] ) ? $plugin_info['download_url_latest'] : '';
 		} else {
 			$available_version = isset( $plugin_info['version'] ) ? $plugin_info['version'] : '';
-			$download_url = isset( $plugin_info['download_url'] ) ? $plugin_info['download_url'] : '';
-		}
-
-		if ( version_compare( GFForms::$version, $available_version, '>=' ) ) {
-			WP_CLI::success( 'Plugin already updated' );
-			return;
+			$download_url      = isset( $plugin_info['download_url'] ) ? $plugin_info['download_url'] : '';
 		}
 
 		if ( $plugin_info && ! empty( $download_url ) ) {
 
+			if ( version_compare( $current_version, $available_version, '>=' ) ) {
+				WP_CLI::success( 'Plugin already updated' );
+
+				return;
+			}
+
 			$download_url .= '&key=' . $key;
 
 			$command = sprintf( 'plugin install "%s" --force', $download_url );
@@ -282,15 +277,9 @@ public function setup( $args, $assoc_args ) {
 				}
 			}
 		} else {
-			$addon_class_names = GFAddOn::get_registered_addons();
-			foreach ( $addon_class_names as $addon_class_name ) {
-				$addon = call_user_func( array( $addon_class_name, 'get_instance' ) );
-				if ( $addon->get_slug() == $slug ) {
-					$addon->setup();
-					WP_CLI::success( 'setup ' . $slug );
-					break;
-				}
-			}
+			$addon = $this->get_addon( $slug );
+			$addon->setup();
+			WP_CLI::success( 'setup ' . $slug );
 		}
 	}
 
@@ -437,4 +426,29 @@ private function get_slug( $args, $beta_check = false ) {
 		return $slug;
 	}
 
+	/**
+	 * Returns the add-on instance for the given slug.
+	 *
+	 * @since 1.4
+	 *
+	 * @param string $slug The add-on slug.
+	 *
+	 * @return GFAddon
+	 * @throws \WP_CLI\ExitException
+	 */
+	private function get_addon( $slug ) {
+		$addon_class_names = GFAddOn::get_registered_addons();
+
+		foreach ( $addon_class_names as $addon_class_name ) {
+			/* @var GFAddon $addon */
+			$addon = call_user_func( array( $addon_class_name, 'get_instance' ) );
+			if ( $addon->get_slug() == $slug ) {
+
+				return $addon;
+			}
+		}
+
+		WP_CLI::error( 'Invalid slug or plugin not active: ' . $slug );
+	}
+
 }

readme.txt

@@ -185,6 +185,9 @@ If you have any ideas for improvements please submit your idea at https://www.gr
 
 == ChangeLog ==
 
+= 1.3.2 =
+- Fixed an issue where the version comparison performed when using `wp gf update` with an add-on slug uses the Gravity Forms version number.
+
 = 1.3.1 =
 - Added support for using `--version=beta` with the `wp gf install` and `wp gf update` commands. Add-On beta releases are not currently supported.
 - Fixed a fatal error which can occur when using the `wp gf version` command with an add-on slug when Gravity Forms is not active or not installed.