MessagesAdmin::observeLinkAtInMessageModal() - Code Metrics - Inspection of "Daily Inspection: [touch:10738]{t:15}add a filter..." - eventespresso/event-espresso-core - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Branch — BUG-10738-inconsistency-in-ses... (8f6fbc)

unknown

created 2017-09-29 21:23 UTC

MessagesAdmin::observeLinkAtInMessageModal() A

↳ Parent: MessagesAdmin

Complexity

Conditions	1
Paths	1

Size

Total Lines	6
Code Lines	4

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	1
eloc	4
nc	1
nop	1
dl	0
loc	6
rs	9.4285
c	0
b	0
f	0

<?php
namespace EventEspresso\Codeception\helpers;

use Page\MessagesAdmin as MessagesPage;

/**
 * Trait MessagesAdmin
 * Helper actions for the Messages Admin Pages
 * @package EventEspresso\Codeception\helpers
 */
trait MessagesAdmin
{
    /**
     * @param string $additional_params Any additional request parameters for the generated url should be included as
     *                                  a string.
     */
    public function amOnMessagesActivityListTablePage($additional_params = '')
    {
        $this->actor()->amOnAdminPage(MessagesPage::messageActivityListTableUrl($additional_params));
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
    }

    /**
     * @param string $additional_params Any additional request parameters for the generated url should be included as
     *                                  a string.
     */
    public function amOnDefaultMessageTemplateListTablePage($additional_params = '')
    {
        $this->actor()->amOnAdminPage(MessagesPage::defaultMessageTemplateListTableUrl($additional_params));
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
    }


    /**
     * @param string $additional_params Any additional request parameters for the generated url should be included as
     *                                  a string.
     */
    public function amOnCustomMessageTemplateListTablePage($additional_params = '')
    {
        $this->actor()->amOnAdminPage(MessagesPage::customMessageTemplateListTableUrl($additional_params));
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
    }


    /**
     * Directs to message settings page
     */
    public function amOnMessageSettingsPage()
    {
        $this->actor()->amOnAdminPage(MessagesPage::messageSettingsUrl());
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
    }


    public function activateMessageTypeForMessenger($message_type_slug, $messenger_slug = 'email')
    {
        $this->actor()->dragAndDrop(
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
            MessagesPage::draggableSettingsBoxSelectorForMessageTypeAndMessenger($message_type_slug, $messenger_slug),
            MessagesPage::MESSAGES_SETTINGS_ACTIVE_MESSAGE_TYPES_CONTAINER_SELECTOR
        );
    }


    /**
     * Assumes you are already on the list table page that has the ui for editing the template.
     * @param string $message_type_slug
     * @param string $context [optional] if you want to click directly to the given context in the editor
     */
    public function clickToEditMessageTemplateByMessageType($message_type_slug, $context = '')
    {
        $this->actor()->click(MessagesPage::editMessageTemplateClassByMessageType($message_type_slug, $context));
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
    }


    /**
     * Use this action to verify that the count for the given text in the specified field is as expected.  For example
     * filling the condition of, "There should only be 1 instance of `[email protected]` in all the 'to' column.
     *
     * @param int    $expected_occurence_count
     * @param string $text_to_check_for
     * @param string $field
     * @param string $message_type_label
     * @param string $message_status
     * @param string $messenger
     * @param string $context
     */
    public function verifyMatchingCountofTextInMessageActivityListTableFor(
        $expected_occurence_count,
        $text_to_check_for,
        $field,
        $message_type_label,
        $message_status = MessagesPage::MESSAGE_STATUS_SENT,
        $messenger = 'Email',
        $context = 'Event Admin'
    ) {
        $elements = $this->actor()->grabMultiple(MessagesPage::messagesActivityListTableCellSelectorFor(
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
            $field,
            $message_type_label,
            $message_status,
            $messenger,
            $context,
            $text_to_check_for,
            0
        ));
        $actual_count = count($elements);
        $this->actor()->assertEquals(
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
            $expected_occurence_count,
            $actual_count,
            sprintf(
                'Expected %s of the %s text for the %s field but there were actually %s counted.',
                $expected_occurence_count,
                $text_to_check_for,
                $field,
                $actual_count
            )
        );
    }


    /**
     * This will create a custom message template for the given messenger and message type from the context of the
     * default (global) message template list table.
     * Also takes care of verifying the template was created.
     * @param string $message_type_label
     * @param string $messenger_label
     */
    public function createCustomMessageTemplateFromDefaultFor($message_type_label, $messenger_label)
    {
        $this->amOnDefaultMessageTemplateListTablePage();
        $this->actor()->click(
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
            MessagesPage::createCustomButtonForMessageTypeAndMessenger(
                $message_type_label,
                $messenger_label
            )
        );
        $this->actor()->seeInField('#title', 'New Custom Template');
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
    }


    /**
     * This switches the context of the current messages template to the given reference.
     * @param string $context_reference  This should be the visible label for the option.
     */
    public function switchContextTo($context_reference)
    {
        $this->actor()->selectOption(MessagesPage::MESSAGES_CONTEXT_SWITCHER_SELECTOR, $context_reference);
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
        $this->actor()->click(MessagesPage::MESSAGES_CONTEXT_SWITCHER_BUTTON_SELECTOR);
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
        $this->actor()->waitForText($context_reference, 10, 'h1');
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
    }


    /**
     * Toggles Context so its turned off or on (depending on where it started) and verifies the expected state after
     * toggling.
     *
     * @param string $context_string           What context is being switched (used for the expected state text)
     * @param bool   $expected_state_is_active Used to indicate whether the expected state is active (true) or inactive
     *                                         (false)
     */
    public function toggleContextState($context_string, $expected_state_is_active = true)
    {
        $this->actor()->click(MessagesPage::MESSAGES_CONTEXT_ACTIVE_STATE_TOGGLE);
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
        if ($expected_state_is_active) {
            $this->actor()->waitForText("The template for $context_string is currently active.");
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
        } else {
            $this->actor()->waitForText("The template for $context_string is currently inactive");
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
        }
    }


    /**
     * Triggers saving the message template.
     * @param bool $and_close   Use to indicate to click the Save and Close button.
     */
    public function saveMessageTemplate($and_close = false)
    {
        if ($and_close) {
            $this->actor()->click('Save and Close');
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
        } else {
            $this->actor()->click('Save');
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
        }
        $this->actor()->waitForText('successfully updated');
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
    }


    /**
     * This takes care of clicking the View Message icon for the given parameters.
     * Assumes you are already viewing the messages activity list table.
     * @param        $message_type_label
     * @param        $message_status
     * @param string $messenger
     * @param string $context
     * @param int    $number_in_set
     */
    public function viewMessageInMessagesListTableFor(
        $message_type_label,
        $message_status = MessagesPage::MESSAGE_STATUS_SENT,
        $messenger = 'Email',
        $context = 'Event Admin',
        $number_in_set = 1
    ) {
        $this->actor()->click(MessagesPage::messagesActivityListTableViewButtonSelectorFor(
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
            $message_type_label,
            $message_status,
            $messenger,
            $context,
            $number_in_set
        ));
    }


    /**
     * Takes care of deleting a message matching the given parameters via the message activity list table.
     * Assumes you are already viewing the messages activity list table.
     * @param        $message_type_label
     * @param        $message_status
     * @param string $messenger
     * @param string $context
     * @param int    $number_in_set
     */
    public function deleteMessageInMessagesListTableFor(
        $message_type_label,
        $message_status = MessagesPage::MESSAGE_STATUS_SENT,
        $messenger = 'Email',
        $context = 'Event Admin',
        $number_in_set = 1
    ) {
        $delete_action_selector = MessagesPage::messagesActivityListTableDeleteActionSelectorFor(
            $message_type_label,
            $message_status,
            $messenger,
            $context,
            $number_in_set
        );
        $this->actor()->moveMouseOver(
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
            MessagesPage::messagesActivityListTableCellSelectorFor(
                'to',
                $message_type_label,
                $message_status,
                $messenger,
                $context,
                '',
                $number_in_set
            ),
            5,
            5
        );
        $this->actor()->waitForElementVisible(
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
            $delete_action_selector
        );
        $this->actor()->click(
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
            $delete_action_selector
        );
        $this->actor()->waitForText('successfully deleted');
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
    }


    /**
     * Assuming you have already triggered the view modal for a single message from the context of the message activity
     * list table, this will take care of validating the given text is in that window.
     * @param string $text_to_view
     */
    public function seeTextInViewMessageModal($text_to_view, $should_not_see = false)
    {
        $this->actor()->waitForElementVisible('.ee-admin-dialog-container-inner-content');
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
        $this->actor()->switchToIframe('message-view-window');
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
        $should_not_see ? $this->actor()->dontSee($text_to_view) : $this->actor()->see($text_to_view);
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
        $this->actor()->switchToIframe();
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
    }


    /**
     * This returns the value for the link at the given selector in the message modal.
     * @param string $selector (any selector string accepted by WebDriver)
     */
    public function observeLinkAtInMessageModal($selector)
    {
        $this->actor()->waitForElementVisible('.ee-admin-dialog-container-inner-content');
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
        $this->actor()->switchToIframe('message-view-window');
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
        return $this->actor()->observeLinkUrlAt($selector);
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
    }


    /**
     * Assuming you have already triggered the view modal for a single message from the context of the message activity
     * list table, this will take care of validating the given text is NOT that window.
     * @param string $text_to_view
     */
    public function dontSeeTextInViewMessageModal($text_to_view)
    {
        $this->seeTextInViewMessageModal($text_to_view, true);
    }


    public function dismissMessageModal()
    {
        $this->actor()->click('#espresso-admin-page-overlay-dv');
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
        //this is needed otherwise phantom js gets stuck in the wrong context and any future element events will fail.
        $this->actor()->click('form#EE_Message_List_Table-table-frm');
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
    }
}


1			<?php
2			namespace EventEspresso\Codeception\helpers;
3
4			use Page\MessagesAdmin as MessagesPage;
5
6			/**
7			* Trait MessagesAdmin
8			* Helper actions for the Messages Admin Pages
9			* @package EventEspresso\Codeception\helpers
10			*/
11			trait MessagesAdmin
12			{
13			/**
14			* @param string $additional_params Any additional request parameters for the generated url should be included as
15			* a string.
16			*/
17			public function amOnMessagesActivityListTablePage($additional_params = '')
18			{
19			$this->actor()->amOnAdminPage(MessagesPage::messageActivityListTableUrl($additional_params));
			0 ignored issues – show Bug introduced 2017-05-15 22:28 UTC by Report Bug Copy Issue Report It seems like `actor()` must be provided by classes using this trait. How about adding it as abstract method to this trait? This check looks for methods that are used by a trait but not required by it. To illustrate, let’s look at the following code example trait Idable { public function equalIds(Idable $other) { return $this->getId() === $other->getId(); } } The trait `Idable` provides a method `equalsId` that in turn relies on the method `getId()`. If this method does not exist on a class mixing in this trait, the method will fail. Adding the `getId()` as an abstract method to the trait will make sure it is available. Loading history...
20			}
21
22			/**
23			* @param string $additional_params Any additional request parameters for the generated url should be included as
24			* a string.
25			*/
26			public function amOnDefaultMessageTemplateListTablePage($additional_params = '')
27			{
28			$this->actor()->amOnAdminPage(MessagesPage::defaultMessageTemplateListTableUrl($additional_params));
			0 ignored issues – show Bug introduced 2017-05-15 22:28 UTC by Report Bug Copy Issue Report It seems like `actor()` must be provided by classes using this trait. How about adding it as abstract method to this trait? This check looks for methods that are used by a trait but not required by it. To illustrate, let’s look at the following code example trait Idable { public function equalIds(Idable $other) { return $this->getId() === $other->getId(); } } The trait `Idable` provides a method `equalsId` that in turn relies on the method `getId()`. If this method does not exist on a class mixing in this trait, the method will fail. Adding the `getId()` as an abstract method to the trait will make sure it is available. Loading history...
29			}
30
31
32			/**
33			* @param string $additional_params Any additional request parameters for the generated url should be included as
34			* a string.
35			*/
36			public function amOnCustomMessageTemplateListTablePage($additional_params = '')
37			{
38			$this->actor()->amOnAdminPage(MessagesPage::customMessageTemplateListTableUrl($additional_params));

eventespresso / event-espresso-core

Branch — BUG-10738-inconsistency-in-ses... (8f6fbc)

MessagesAdmin::observeLinkAtInMessageModal() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like