KitBroadcasts.php

<?php
namespace Tests\Support\Helper;

/**
 * Helper methods and actions related to the Kit Plugin's Broadcasts
 * functionality, which are then available using $I->{yourFunctionName}.
 *
 * @since   1.9.7.5
 */
class KitBroadcasts extends \Codeception\Module
{
	/**
	 * Helper method to setup the Plugin's Broadcasts to Posts settings.
	 *
	 * @since   2.2.8
	 *
	 * @param   EndToEndTester $I          EndToEndTester.
	 * @param   bool|array     $settings   Array of key/value settings. If not defined, uses expected defaults.
	 */
	public function setupKitPluginBroadcasts($I, $settings = false)
	{
		// Go to the Plugin's Broadcasts screen.
		$I->loadKitSettingsBroadcastsScreen($I);

		// Complete fields.
		if ( $settings ) {
			foreach ( $settings as $key => $value ) {
				switch ( $key ) {
					case 'enabled':
					case 'import_thumbnail':
					case 'import_images':
					case 'enabled_export':
					case 'no_styles':
						if ( $value ) {
							$I->checkOption('_wp_convertkit_settings_broadcasts[' . $key . ']');
						} else {
							$I->uncheckOption('_wp_convertkit_settings_broadcasts[' . $key . ']');
						}
						break;

					case 'post_status':
					case 'category_id':
					case 'author_id':
						$I->fillSelect2Field($I, '#select2-_wp_convertkit_settings_broadcasts_' . $key . '-container', $value);

						break;
					default:
						$I->fillField('_wp_convertkit_settings_broadcasts[' . $key . ']', $value);
						break;
				}
			}
		}

		// Click the Save Changes button.
		$I->click('Save Changes');

		// Confirm that the settings were saved.
		$I->waitForElementVisible('.notice-success');

		// Check that no PHP warnings or notices were output.
		$I->checkNoWarningsAndNoticesOnScreen($I);
	}

	/**
	 * Helper method to load the Plugin's Settings > Broadcasts screen.
	 *
	 * @since   2.2.8
	 *
	 * @param   EndToEndTester $I     EndToEndTester.
	 */
	public function loadKitSettingsBroadcastsScreen($I)
	{
		$I->amOnAdminPage('options-general.php?page=_wp_convertkit_settings&tab=broadcasts');

		// Check that no PHP warnings or notices were output.
		$I->checkNoWarningsAndNoticesOnScreen($I);
	}

	/**
	 * Check that expected HTML exists in the DOM of the page we're viewing for
	 * a Broadcasts block or shortcode, based on its configuration.
	 *
	 * @since   1.9.7.5
	 *
	 * @param   EndToEndTester $I                      Tester.
	 * @param   bool|array     $options {
	 *         Optional. An array of settings.
	 *
	 *     @type bool|int    $number_posts              Number of Broadcasts listed.
	 *     @type bool|string $see_prev_pagination_label Test if the "previous" pagination link is output and matches expected label.
	 *     @type bool|string $see_next_pagination_label Test if the "next" pagination link is output and matches expected label.
	 *     @type bool        $see_grid                  Test if the broadcasts are displayed in grid view (false = list view).
	 *     @type bool        $see_image                 Test if the broadcasts display images.
	 *     @type bool        $see_description           Test if the broadcasts display descriptions.
	 *     @type bool|string $see_read_more             Test if the broadcasts display a read more link matching the given text.
	 * }
	 */
	public function seeBroadcastsOutput($I, $options = false)
	{
		// Define default options.
		$defaults = [
			'number_posts'              => false,
			'see_prev_pagination_label' => false,
			'see_next_pagination_label' => false,
			'see_grid'                  => false,
			'see_display_order'         => false,
			'see_image'                 => false,
			'see_description'           => false,
			'see_read_more'             => false,
		];

		// If supplied options are an array, merge them with the defaults.
		if (is_array($options)) {
			$options = array_merge($defaults, $options);
		} else {
			$options = $defaults;
		}

		// Confirm that the block displays.
		$I->seeElementInDOM('div.convertkit-broadcasts');
		$I->seeElementInDOM('div.convertkit-broadcasts ul.convertkit-broadcasts-list');
		$I->seeElementInDOM('div.convertkit-broadcasts ul.convertkit-broadcasts-list li.convertkit-broadcast');
		$I->seeElementInDOM('div.convertkit-broadcasts ul.convertkit-broadcasts-list li.convertkit-broadcast a.convertkit-broadcast-title');

		// Confirm that UTM parameters exist on a broadcast link.
		$I->assertStringContainsString(
			'utm_source=wordpress&utm_term=en_US&utm_content=convertkit',
			$I->grabAttributeFrom('a.convertkit-broadcast-title', 'href')
		);

		// If Display as grid is enabled, confirm the applicable HTML exists so that CSS can style this layout.
		if ($options['see_grid']) {
			$I->seeElementInDOM('div.convertkit-broadcasts[data-display-grid="1"]');
		} else {
			$I->dontSeeElementInDOM('div.convertkit-broadcasts[data-display-grid="1"]');
		}

		// If Display order is set to broadcast-date, confirm the applicable HTML exists so that CSS can style this layout.
		if ($options['see_display_order']) {
			$I->seeElementInDOM('div.convertkit-broadcasts[data-display-order="' . $options['see_display_order'] . '"]');
		}

		// If Display image is enabled, confirm the image is displayed.
		if ($options['see_image']) {
			$I->seeElementInDOM('a.convertkit-broadcast-image img');
			$I->assertStringContainsString(
				'utm_source=wordpress&utm_term=en_US&utm_content=convertkit',
				$I->grabAttributeFrom('a.convertkit-broadcast-image', 'href')
			);
		} else {
			$I->dontSeeElementInDOM('a.convertkit-broadcast-image img');
		}

		// If Display description is enabled, confirm the description is displayed.
		if ($options['see_description']) {
			$I->seeElementInDOM('.convertkit-broadcast-description');
		} else {
			$I->dontSeeElementInDOM('.convertkit-broadcast-description');
		}

		// If Display read more link is enabled, confirm the read more link is displayed and matches the given text.
		if ($options['see_read_more']) {
			$I->seeElementInDOM('a.convertkit-broadcast-read-more');
			$I->assertStringContainsString(
				'utm_source=wordpress&utm_term=en_US&utm_content=convertkit',
				$I->grabAttributeFrom('a.convertkit-broadcast-read-more', 'href')
			);
		} else {
			$I->dontSeeElementInDOM('a.convertkit-broadcast-read-more');
		}

		// Confirm that the number of expected broadcasts displays.
		if ($options['number_posts'] !== false) {
			$I->seeNumberOfElements('li.convertkit-broadcast', (int) $options['number_posts']);
		}

		// Confirm that previous pagination displays, if expected.
		if ($options['see_prev_pagination_label'] !== false) {
			$I->seeElementInDOM('div.convertkit-broadcasts ul.convertkit-broadcasts-pagination li.convertkit-broadcasts-pagination-prev a');
			$I->seeInSource($options['see_prev_pagination_label']);
		}

		// Confirm that next pagination displays, if expected.
		if ($options['see_next_pagination_label'] !== false) {
			$I->seeElementInDOM('div.convertkit-broadcasts ul.convertkit-broadcasts-pagination li.convertkit-broadcasts-pagination-next a');
			$I->seeInSource($options['see_next_pagination_label']);
		}
	}

	/**
	 * Tests that the Broadcasts pagination works, and that the expected Broadcast
	 * is displayed after using previous and next links.
	 *
	 * @since   2.0.0
	 *
	 * @param   EndToEndTester $I                      Tester.
	 * @param   string         $previousLabel          Previous / Newer Broadcasts Label.
	 * @param   string         $nextLabel              Next / Older Broadcasts Label.
	 */
	public function testBroadcastsPagination($I, $previousLabel, $nextLabel)
	{
		// Confirm that the block displays one broadcast with a pagination link to older broadcasts.
		$I->seeBroadcastsOutput(
			$I,
			[
				'number_posts'              => 2,
				'see_next_pagination_label' => $nextLabel,
			]
		);

		// Click the Older Posts link.
		$I->click('li.convertkit-broadcasts-pagination-next a');

		// Wait for the AJAX request to complete, by checking if the convertkit-broadcasts-loading class has been
		// removed from the block.
		$I->waitForBroadcastsToLoad($I);

		// Confirm that the block displays one broadcast with a pagination link to newer broadcasts.
		$I->seeBroadcastsOutput(
			$I,
			[
				'number_posts'              => 2,
				'see_prev_pagination_label' => $previousLabel,
			]
		);

		// Confirm that the expected Broadcast name is displayed and links to the expected URL, with UTM parameters.
		$I->seeInSource('<a href="' . $_ENV['CONVERTKIT_API_BROADCAST_SECOND_URL'] . '?utm_source=wordpress&amp;utm_term=en_US&amp;utm_content=convertkit" target="_blank" rel="nofollow noopener"');
		$I->seeInSource($_ENV['CONVERTKIT_API_BROADCAST_SECOND_TITLE']);

		// Click the Newer Posts link.
		$I->click('li.convertkit-broadcasts-pagination-prev a');

		// Wait for the AJAX request to complete, by checking if the convertkit-broadcasts-loading class has been
		// removed from the block.
		$I->waitForBroadcastsToLoad($I);

		// Confirm that the block displays one broadcast with a pagination link to older broadcasts.
		$I->seeBroadcastsOutput(
			$I,
			[
				'number_posts'              => 2,
				'see_next_pagination_label' => $nextLabel,
			]
		);

		// Confirm that the expected Broadcast name is displayed and links to the expected URL, with UTM parameters.
		$I->seeInSource('<a href="' . $_ENV['CONVERTKIT_API_BROADCAST_FIRST_URL'] . '?utm_source=wordpress&amp;utm_term=en_US&amp;utm_content=convertkit" target="_blank" rel="nofollow noopener"');
		$I->seeInSource($_ENV['CONVERTKIT_API_BROADCAST_FIRST_TITLE']);
	}

	/**
	 * Wait for the AJAX request to complete, by checking if the convertkit-broadcasts-loading class has been
	 * removed from the block.
	 *
	 * @since   1.9.7.6
	 *
	 * @param   EndToEndTester $I                      Tester.
	 */
	public function waitForBroadcastsToLoad($I)
	{
		$I->waitForElementChange(
			'div.convertkit-broadcasts',
			function(\Facebook\WebDriver\WebDriverElement $el) {
				return ( strpos($el->getAttribute('class'), 'convertkit-broadcasts-loading') === false ? true : false );
			},
			5
		);
	}
}