Add Notice Recommending Official Add-On

convertkit.php

@@ -40,6 +40,7 @@
 // Load files that are always used.
 require_once CKGF_PLUGIN_PATH . '/includes/functions.php';
 require_once CKGF_PLUGIN_PATH . '/includes/class-ckgf-api.php';
+require_once CKGF_PLUGIN_PATH . '/includes/class-ckgf-notices.php';
 require_once CKGF_PLUGIN_PATH . '/includes/class-wp-ckgf.php';
 
 /**

includes/class-ckgf-notices.php

@@ -0,0 +1,84 @@
+<?php
+/**
+ * Notices class.
+ *
+ * @package CKWC
+ * @author ConvertKit
+ */
+
+/**
+ * Notices class.
+ *
+ * @package CKWC
+ * @author ConvertKit
+ */
+class CKGF_Notices {
+
+	/**
+	 * Constructor.
+	 *
+	 * @since   1.4.2
+	 */
+	public function __construct() {
+
+		add_action( 'admin_init', array( $this, 'maybe_deactivate_plugin' ) );
+
+	}
+
+	/**
+	 * Deactivates this Plugin if the official Gravity Forms ConvertKit Add-On is active.
+	 *
+	 * @since   1.4.2
+	 */
+	public function maybe_deactivate_plugin() {
+
+		// If the official Gravity Forms ConvertKit Add-On is active, deactivate
+		// our Plugin.
+		if ( is_plugin_active( 'gravityformsconvertkit/convertkit.php' ) ) {
+			deactivate_plugins( 'convertkit-gravity-forms/convertkit.php' );
+			return;
+		}
+
+		// The official Gravity Forms ConvertKit Add-On is not installed.
+		// Recommend the user install it by showing a notice.
+		add_action( 'admin_notices', array( $this, 'output_notice' ) );
+
+	}
+
+	/**
+	 * Output a persistent notice in the WordPress Administration
+	 * telling users to migrate to the official Add-on.
+	 *
+	 * @since   1.4.2
+	 */
+	public function output_notice() {
+
+		?>
+		<div class="notice notice-warning">
+			<p>
+				<?php
+				printf(
+					'%s <a href="%s" target="_blank">%s</a>. %s',
+					esc_html__( 'ConvertKit Gravity Forms Add-On: Please install the official', 'convertkit' ),
+					esc_url( 'https://www.gravityforms.com/blog/convertkit-add-on/' ),
+					esc_html__( 'Gravity Forms ConvertKit Add-On', 'convertkit' ),
+					esc_html__( 'Your existing settings will automatically migrate once installed and active.', 'convertkit' )
+				);
+				?>
+			</p>
+		</div>
+		<?php
+
+	}
+
+}
+
+// Initialize class.
+add_action(
+	'convertkit_gravity_forms_initialize_admin',
+	function () {
+
+		new CKGF_Notices();
+
+	}
+);

readme.txt

@@ -13,6 +13,8 @@ ConvertKit is an email marketing platform for capturing leads from your WordPres
 
 == Description ==
 
+** Please use the official [Gravity Forms ConvertKit Add-On](https://www.gravityforms.com/blog/convertkit-add-on/). Your existing settings will automatically migrate once installed and active. This Add-on will only receive security updates. **
+
 [ConvertKit](https://convertkit.com) makes it easy to capture more leads and sell more products by easily embedding email capture forms anywhere.
 
 This Plugin integrates Gravity Forms with ConvertKit, allowing form submissions to be automatically sent to your ConvertKit account.

tests/_support/Helper/Acceptance/GravityForms.php

@@ -112,10 +112,6 @@ public function createGravityFormsForm($I)
 		// Wait for the Form Edit screen to load.
 		$I->waitForElementVisible('#no-fields');
 
-		// Open Advanced Fields Panel.
-		$I->click('button[aria-controls="add_advanced_fields"]');
-		$I->wait(2);
-
 		// Add Name Field.
 		$I->click('#add_advanced_fields button[data-type="name"]');
 		$I->wait(2);

tests/_support/Helper/Acceptance/ThirdPartyPlugin.php

@@ -39,6 +39,10 @@ public function activateThirdPartyPlugin($I, $name)
 				$I->seePluginActivated('gravityforms');
 				break;
 
+			case 'gravity-forms-convertkit-add-on':
+				$I->seePluginActivated('gravityformsconvertkit');
+				break;
+
 			default:
 				$I->seePluginActivated($name);
 				break;
@@ -72,6 +76,10 @@ public function deactivateThirdPartyPlugin($I, $name)
 				$I->deactivatePlugin('gravityforms');
 				break;
 
+			case 'gravity-forms-convertkit-add-on':
+				$I->deactivatePlugin('gravityformsconvertkit');
+				break;
+
 			default:
 				$I->deactivatePlugin($name);
 				break;

tests/acceptance/forms/FormCest.php

@@ -62,7 +62,7 @@ public function testCreateFormAndFeed(AcceptanceTester $I)
 		// Complete Form Fields.
 		$I->fillField('.name_first input[type=text]', $firstName);
 		$I->fillField('.name_last input[type=text]', $lastName);
-		$I->fillField('.ginput_container_email input[type=text]', $emailAddress);
+		$I->fillField('.ginput_container_email input[type=email]', $emailAddress);
 
 		// Submit Form.
 		$I->click('Submit');
@@ -135,7 +135,7 @@ public function testCreateFormAndFeedWithNoConvertKitFormSelected(AcceptanceTest
 		// Complete Form Fields.
 		$I->fillField('.name_first input[type=text]', $firstName);
 		$I->fillField('.name_last input[type=text]', $lastName);
-		$I->fillField('.ginput_container_email input[type=text]', $emailAddress);
+		$I->fillField('.ginput_container_email input[type=email]', $emailAddress);
 
 		// Submit Form.
 		$I->click('Submit');
@@ -320,7 +320,7 @@ public function testCreateFormAndFeedWithTagAndFieldTagSelected(AcceptanceTester
 		// Complete Form Fields.
 		$I->fillField('.name_first input[type=text]', $firstName);
 		$I->fillField('.name_last input[type=text]', $lastName);
-		$I->fillField('.ginput_container_email input[type=text]', $emailAddress);
+		$I->fillField('.ginput_container_email input[type=email]', $emailAddress);
 		$I->selectOption('select.gfield_select', $_ENV['CONVERTKIT_API_ADDITIONAL_TAG_NAME']);
 
 		// Submit Form.
@@ -399,7 +399,7 @@ public function testCreateFormAndFeedWithFieldTagSelected(AcceptanceTester $I)
 		// Complete Form Fields.
 		$I->fillField('.name_first input[type=text]', $firstName);
 		$I->fillField('.name_last input[type=text]', $lastName);
-		$I->fillField('.ginput_container_email input[type=text]', $emailAddress);
+		$I->fillField('.ginput_container_email input[type=email]', $emailAddress);
 		$I->selectOption('select.gfield_select', $_ENV['CONVERTKIT_API_ADDITIONAL_TAG_NAME']);
 
 		// Submit Form.
@@ -478,7 +478,7 @@ public function testCreateFormAndFeedWithInvalidFieldTagSelected(AcceptanceTeste
 		// Complete Form Fields.
 		$I->fillField('.name_first input[type=text]', $firstName);
 		$I->fillField('.name_last input[type=text]', $lastName);
-		$I->fillField('.ginput_container_email input[type=text]', $emailAddress);
+		$I->fillField('.ginput_container_email input[type=email]', $emailAddress);
 		$I->selectOption( 'select.gfield_select', 'fakeTagNotInConvertKit' );
 
 		// Submit Form.
@@ -557,7 +557,7 @@ public function testCreateFormAndFeedWithTagSelected(AcceptanceTester $I)
 		// Complete Form Fields.
 		$I->fillField('.name_first input[type=text]', $firstName);
 		$I->fillField('.name_last input[type=text]', $lastName);
-		$I->fillField('.ginput_container_email input[type=text]', $emailAddress);
+		$I->fillField('.ginput_container_email input[type=email]', $emailAddress);
 
 		// Submit Form.
 		$I->click('Submit');
@@ -641,7 +641,7 @@ public function testCreateFormAndFeedWithConditionalLogicMatching(AcceptanceTest
 		// Complete Form Fields.
 		$I->fillField('.name_first input[type=text]', $firstName);
 		$I->fillField('.name_last input[type=text]', $lastName);
-		$I->fillField('.ginput_container_email input[type=text]', $emailAddress);
+		$I->fillField('.ginput_container_email input[type=email]', $emailAddress);
 
 		// Submit Form.
 		$I->click('Submit');
@@ -720,7 +720,7 @@ public function testCreateFormAndFeedWithConditionalLogicDoesNotMatch(Acceptance
 		// Complete Form Fields.
 		$I->fillField('.name_first input[type=text]', $firstName);
 		$I->fillField('.name_last input[type=text]', $lastName);
-		$I->fillField('.ginput_container_email input[type=text]', $emailAddress);
+		$I->fillField('.ginput_container_email input[type=email]', $emailAddress);
 
 		// Submit Form.
 		$I->click('Submit');
@@ -790,7 +790,7 @@ public function testCreateFormAndFeedDisabled(AcceptanceTester $I)
 		// Complete Form Fields.
 		$I->fillField('.name_first input[type=text]', $firstName);
 		$I->fillField('.name_last input[type=text]', $lastName);
-		$I->fillField('.ginput_container_email input[type=text]', $emailAddress);
+		$I->fillField('.ginput_container_email input[type=email]', $emailAddress);
 
 		// Submit Form.
 		$I->click('Submit');

tests/acceptance/general/NoticesCest.php

@@ -0,0 +1,90 @@
+<?php
+/**
+ * Tests the notices output recommending the official add-on.
+ *
+ * @since   1.4.2
+ */
+class NoticesCest
+{
+	/**
+	 * Holds the expected notice text.
+	 *
+	 * @since   1.4.2
+	 *
+	 * @var     string
+	 */
+	public $expectedNoticeText = 'ConvertKit Gravity Forms Add-On: Please install the official Gravity Forms ConvertKit Add-On. Your existing settings will automatically migrate once installed and active.';
+
+	/**
+	 * Run common actions before running the test functions in this class.
+	 *
+	 * @since   1.4.2
+	 *
+	 * @param   AcceptanceTester $I  Tester.
+	 */
+	public function _before(AcceptanceTester $I)
+	{
+		$I->activateConvertKitPlugin($I);
+	}
+
+	/**
+	 * Test that the persistent notice displays with expected wording when the Plugin is active.
+	 *
+	 * @since   1.4.2
+	 *
+	 * @param   AcceptanceTester $I  Tester.
+	 */
+	public function testPersistentNoticeDisplays(AcceptanceTester $I)
+	{
+		// Confirm notice displays with expected text.
+		$I->seeElement('.notice-warning');
+		$I->see($this->expectedNoticeText);
+
+		// Confirm the link is valid.
+		$I->assertEquals(
+			$I->grabAttributeFrom('.notice-warning a', 'href'),
+			'https://www.gravityforms.com/blog/convertkit-add-on/'
+		);
+
+		// Deactivate Plugin.
+		$I->deactivateConvertKitPlugin($I);
+
+		// Confirm no notice from this Plugin displays.
+		$I->dontSee($this->expectedNoticeText);
+	}
+
+	/**
+	 * Test that the persistent notice does not display when the official add-on is active.
+	 *
+	 * @since   1.4.2
+	 *
+	 * @param   AcceptanceTester $I  Tester.
+	 */
+	public function testPersistentNoticeNotDisplayedWhenOfficialAddonActive(AcceptanceTester $I)
+	{
+		// Activate Gravity Forms and official add-on.
+		$I->activateThirdPartyPlugin($I, 'gravity-forms');
+		$I->activateThirdPartyPlugin($I, 'gravity-forms-convertkit-add-on');
+
+		// Confirm no notice from this Plugin displays.
+		$I->dontSee($this->expectedNoticeText);
+
+		// When the official add-on is activated, it checks whether this Plugin is also active, deactivating it if so.
+		// Confirm the official add-on displays its notice that it deactivated this Plugin.
+		$I->see('In order to prevent conflicts, we disabled the existing ConvertKit for Gravity Forms plugin.');
+	}
+
+	/**
+	 * Deactivate and reset Plugin(s) after each test, if the test passes.
+	 * We don't use _after, as this would provide a screenshot of the Plugin
+	 * deactivation and not the true test error.
+	 *
+	 * @since   1.2.2
+	 *
+	 * @param   AcceptanceTester $I  Tester.
+	 */
+	public function _passed(AcceptanceTester $I)
+	{
+		$I->resetConvertKitPlugin($I);
+	}
+}