Acquia\DFExtension\Context\PanelsInPlaceContext

Complexity

Total Complexity

18

Size/Duplication

Total Lines	259
Duplicated Lines	6.18 %

Coupling/Cohesion

Components	1
Dependencies	5

Importance

Changes	1
Bugs	0	Features	0

13 Methods

Rating	Name	Duplication	Size	Complexity
A	gatherContexts()	0	3	1
A	getActiveTab()	0	4	1
A	assertTray()	0	3	1
A	openTab()	0	18	2
A	openCategory()	0	18	2
A	assertBlockPluginExists()	8	8	2
A	assertBlockPluginNotExists()	8	8	2
A	instantiateBlock()	0	9	1
A	saveLayout()	0	11	1
A	placeBlock()	0	6	1
A	revertLayout()	0	7	1
A	openModerationSidebar()	0	16	2
A	closeEditor()	0	14	1

<?php

namespace Acquia\DFExtension\Context;

use Drupal\DrupalExtension\Context\DrupalSubContextBase;
use Drupal\DrupalExtension\Context\MinkContext;

/**
 * A context for working with the Panels in-place editor.
 */
class PanelsInPlaceContext extends DrupalSubContextBase {

  /**
   * The Mink context.
   *
   * @var MinkContext
   */
  protected $minkContext;

  /**
   * Gathers required contexts.
   *
   * @BeforeScenario
   */
  public function gatherContexts() {
    $this->minkContext = $this->getContext(MinkContext::class);

It seems like $this->getContext(\Drupal\DrupalExtension\Context\MinkContext::class) of type object<Behat\Behat\Context\Context> or false is incompatible with the declared type object<Drupal\DrupalExtension\Context\MinkContext> of property $minkContext.

  }

  /**
   * Returns the active Panels IPE tab's contents.
   *
   * @return \Behat\Mink\Element\NodeElement
   *   The active tab's contents.
   */
  protected function getActiveTab() {
    return $this->assertSession()
      ->elementExists('css', '.ipe-tabs-content', $this->assertTray());
  }

  /**
   * Asserts the presence of the Panels IPE tray.
   *
   * @return \Behat\Mink\Element\NodeElement
   *   The Panels IPE tray element.
   *
   * @Then I should see the Panels IPE tray
   */
  public function assertTray() {
    return $this->assertSession()->elementExists('css', '#panels-ipe-tray');
  }

  /**
   * Opens a tab of the Panels IPE tray.
   *
   * @param string $tab
   *   The title of the tab to activate.
   *
   * @return \Behat\Mink\Element\NodeElement
   *   The tab contents.
   *
   * @When I open the :tab tab
   */
  public function openTab($tab) {
    $assert = $this->assertSession();

    // Assert that the tab exists...
    $link = $assert->elementExists(
      'named',
      ['link', $tab],
      $assert->elementExists('css', '.ipe-tabs', $this->assertTray())
    );

    // ...but only open it if not already active.
    if ($link->getParent()->hasClass('active') == FALSE) {
      $link->click();
      $this->minkContext->iWaitForAjaxToFinish();
    }

    return $this->getActiveTab();
  }

  /**
   * Opens a particular block category of the "Manage Content" tab.
   *
   * @param string $category
   *   The category to open.
   *
   * @return \Behat\Mink\Element\NodeElement
   *   The tab contents.
   *
   * @When I open the :category category
   */
  public function openCategory($category) {
    $tab = $this->openTab('Manage Content');

    // Assert that the category exists...
    $link = $this->assertSession()
      ->elementExists('css',
        '.ipe-category[data-category="' . $category . '"]',
        $tab
      );

    // ...but only open it if not already active.
    if ($link->hasClass('active') == FALSE) {

It seems like you are loosely comparing two booleans. Considering using the strict comparison === instead.

      $link->click();
      $this->minkContext->iWaitForAjaxToFinish();
    }

    return $tab;
  }

  /**
   * Asserts that a particular block plugin is available.
   *
   * @param string $plugin_id
   *   The block plugin ID.
   * @param string $category
   *   (optional) The category to open.
   *
   * @return \Behat\Mink\Element\NodeElement
   *   The link to instantiate the block plugin.
   *
   * @Then I should see the :plugin_id plugin
   * @Then I should see the :plugin_id plugin in the :category category
   */
  public function assertBlockPluginExists($plugin_id, $category = NULL) {

This method seems to be duplicated in your project.

    return $this->assertSession()
      ->elementExists(
        'css',
        '.ipe-block-plugin a[data-plugin-id="' . $plugin_id . '"]',
        $category ? $this->openCategory($category) : $this->getActiveTab()
      );
  }

  /**
   * Asserts that a particular block plugin is not available.
   *
   * @param string $plugin_id
   *   The block plugin ID.
   * @param string $category
   *   (optional) The category to open.
   *
   * @Then I should not see the :plugin_id plugin
   * @Then I should not see the :plugin_id plugin in the :category category
   */
  public function assertBlockPluginNotExists($plugin_id, $category = NULL) {

This method seems to be duplicated in your project.

    $this->assertSession()
      ->elementNotExists(
        'css',
        '.ipe-block-plugin a[data-plugin-id="' . $plugin_id . '"]',
        $category ? $this->openCategory($category) : $this->getActiveTab()
      );
  }

  /**
   * Instantiates a block plugin.
   *
   * @param string $plugin_id
   *   The block plugin ID.
   * @param string $category
   *   (optional) The category in which the block plugin resides.
   *
   * @return \Behat\Mink\Element\NodeElement
   *   The block plugin configuration form.
   *
   * @When I instantiate the :plugin_id block
   * @When I instantiate the :plugin_id block from the :category category
   */
  public function instantiateBlock($plugin_id, $category = NULL) {
    $this->assertBlockPluginExists($plugin_id, $category)
      ->click();

    $this->minkContext->iWaitForAjaxToFinish();

    return $this->assertSession()
      ->elementExists('css', '.panels-ipe-block-plugin-form', $this->getActiveTab());
  }

  /**
   * Saves the current IPE layout as a custom layout.
   *
   * @When I save the layout
   */
  public function saveLayout() {
    $this->assertSession()
      ->elementExists(
        'named',
        ['link', 'Save'],
        $this->assertTray()
      )
      ->click();

    $this->minkContext->iWaitForAjaxToFinish();
  }

  /**
   * Places a block into a Panels IPE layout.
   *
   * @param string $plugin_id
   *   The block plugin ID.
   * @param string $category
   *   (optional) The category in which the block plugin resides.
   *
   * @When I place the :plugin_id block from the :category category
   * @When I place the :plugin_id block
   */
  public function placeBlock($plugin_id, $category = NULL) {
    $this->instantiateBlock($plugin_id, $category)
      ->pressButton('Add');

    $this->minkContext->iWaitForAjaxToFinish();
  }

  /**
   * Reverts a panelized layout to its default state.
   *
   * @When I revert the layout
   */
  public function revertLayout() {
    $this->assertSession()
      ->elementExists('named', ['link', 'Revert to default'], $this->assertTray())
      ->click();

    $this->minkContext->iWaitForAjaxToFinish();
  }

  /**
   * Opens the moderation sidebar.
   *
   * @When I open the moderation sidebar
   */
  public function openModerationSidebar() {
    $assert = $this->assertSession();

    // Assert that the tab exists...
    $link = $assert->elementExists(
      'named',
      ['link', 'Tasks'],
      $assert->elementExists('css', '.moderation-sidebar-toolbar-tab')
    );

    // ...but only open it if not already active.
    if ($link->hasClass('sidebar-open') == FALSE) {

It seems like you are loosely comparing two booleans. Considering using the strict comparison === instead.

      $link->click();
      $this->minkContext->iWaitForAjaxToFinish();
    }
  }

  /**
   * Close the Panels IPE tray.
   *
   * @When I close the editor
   */
  public function closeEditor() {
    $assert = $this->assertSession();

    // Assert that the tab exists...
    $link = $assert->elementExists(
      'named',
      ['link', 'Cancel'],
      $assert->elementExists('css', '.ipe-tabs', $this->assertTray())
    );

    $link->click();
    $this->getSession()->getDriver()->getWebDriverSession()->accept_alert();

It seems like you code against a concrete implementation and not the interface Behat\Mink\Driver\DriverInterface as the method getWebDriverSession() does only exist in the following implementations of said interface: Behat\Mink\Driver\Selenium2Driver.

    $this->minkContext->iWaitForAjaxToFinish();
  }

}