CkEditorContext::getContent() - Code Metrics - Inspection of "Updated layout saving behaviour in PanelsInPlaceCo..." - acquia/df - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — 8.x-2.x ( bdb6af...21ed67 )

by Devin

created 2017-03-16 06:45 UTC

CkEditorContext::getContent() A

↳ Parent: CkEditorContext

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	3

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	1
eloc	3
nc	1
nop	1
dl	0
loc	4
rs	10
c	0
b	0
f	0

<?php

namespace Acquia\DFExtension\Context;

use Behat\Mink\Exception\ExpectationException;
use Drupal\Component\Serialization\Json;
use Drupal\DrupalExtension\Context\DrupalSubContextBase;

/**
 * Contains step definitions for working with CKEditor instances.
 */
class CkEditorContext extends DrupalSubContextBase {

  /**
   * Asserts that a CKEditor instance exists and is fully loaded.
   *
   * @param string $id
   *   (optional) The editor instance ID. Defaults to the first available
   *   instance.
   *
   * @return string
   *   A snippet of JavaScript for calling instance methods.
   *
   * @Given CKEditor :id exists
   *
   * @Then CKEditor :id should exist
   */
  public function assertEditor($id = NULL) {
    $js = "CKEDITOR.instances['" . ($id ?: $this->getDefault()) . "']";

    $this->getSession()->wait(10000, "$js.status === 'ready'");

    return $js;
  }

  /**
   * Puts text or HTML into a CKEditor instance.
   *
   * @param string $text
   *   The text (or HTML) to insert into the editor.
   * @param string $id
   *   (optional) The editor instance ID.
   *
   * @When I put :text into CKEditor
   * @When I put :text into CKEditor :id
   */
  public function insert($text, $id = NULL) {
    $js = $this->assertEditor($id);
    $this->getSession()->executeScript("$js.insertHtml('$text');");
  }

  /**
   * Asserts that a CKEditor's content contains a snippet of text.
   *
   * @param string $text
   *   The text (or HTML) snippet to look for.
   * @param string $id
   *   (optional) The editor instance ID.
   *
   * @throws ExpectationException
   *   If the editor does not contain the specified text.
   *
   * @Then CKEditor should contain :text
   * @Then CKEditor :id should contain :text
   */
  public function assertEditorContains($text, $id = NULL) {

    $position = strpos($this->getContent($id), $text);

    if ($position == FALSE) {

      throw new ExpectationException(
        'Expected CKEditor ' . $id . ' to contain "' . $text . '".',
        $this->getSession()->getDriver()
      );
    }
  }

  /**
   * Assert that a CKEditor's content matches a regular expression.
   *
   * @param string $expr
   *   The regular expression to match.
   * @param string $id
   *   (optional) The editor instance ID.
   *
   * @throws ExpectationException
   *   If the expression does not match.
   *
   * @Then CKEditor should match :expression
   * @Then CKEditor :id should match :expression
   */
  public function assertEditorMatch($expr, $id = NULL) {

    $match = preg_match($expr, $this->getContent($id));

    if ($match == 0) {
      throw new ExpectationException(
        'Expected CKEditor ' . $id . ' to match "' . $expr . '".',
        $this->getSession()->getDriver()
      );
    }
  }

  /**
   * Gets the content of a CKEditor instance.
   *
   * @param string $id
   *   (optional) The editor instance ID.
   *
   * @return string
   *   The HTML content of the editor.
   */
  protected function getContent($id = NULL) {
    $js = $this->assertEditor($id);
    return $this->getSession()->evaluateScript("$js.getData()");
  }

  /**
   * Executes a CKEditor command.
   *
   * @param string $command
   *   The command ID, as known to CKEditor's API.
   * @param string $id
   *   (optional) The editor instance ID.
   * @param mixed $data
   *   Additional data to pass to the executed command.
   *
   * @throws ExpectationException
   *   If the command cannot be executed (i.e., returns a falsy value).
   *
   * @When I execute the :command command in CKEditor
   * @When I execute the :command command in CKEditor :id
   */
  public function execute($command, $id = NULL, $data = NULL) {
    $js = $this->assertEditor($id);

    $session = $this->getSession();

    $return = Json::decode($session->evaluateScript("$js.execCommand('$command', " . Json::encode($data) . ')'));

    if (empty($return)) {
      throw new ExpectationException(
        'CKEditor command ' . $command . ' returned ' . var_export($return, TRUE) . ', expected truthy.',
        $session->getDriver()
      );
    }
  }

  /**
   * Returns the first available CKEditor instance ID.
   *
   * @return string|false
   *   The first CKEditor instance ID, or FALSE if there are no instances.
   */
  protected function getDefault() {
    $keys = $this->getKeys();
    return reset($keys);
  }

  /**
   * Returns all CKEditor instance IDs.
   *
   * @return string[]
   *   The CKEditor instance IDs.
   */
  protected function getKeys() {
    $keys = $this
      ->getSession()
      ->evaluateScript('Object.keys(CKEDITOR.instances).join(",")');

    return explode(',', $keys);
  }

}


1		<?php
2
3		namespace Acquia\DFExtension\Context;
4
5		use Behat\Mink\Exception\ExpectationException;
6		use Drupal\Component\Serialization\Json;
7		use Drupal\DrupalExtension\Context\DrupalSubContextBase;
8
9		/**
10		* Contains step definitions for working with CKEditor instances.
11		*/
12		class CkEditorContext extends DrupalSubContextBase {
13
14		/**
15		* Asserts that a CKEditor instance exists and is fully loaded.
16		*
17		* @param string $id
18		* (optional) The editor instance ID. Defaults to the first available
19		* instance.
20		*
21		* @return string
22		* A snippet of JavaScript for calling instance methods.
23		*
24		* @Given CKEditor :id exists
25		*
26		* @Then CKEditor :id should exist
27		*/
28		public function assertEditor($id = NULL) {
29		$js = "CKEDITOR.instances['" . ($id ?: $this->getDefault()) . "']";
30
31		$this->getSession()->wait(10000, "$js.status === 'ready'");
32
33		return $js;
34		}
35
36		/**
37		* Puts text or HTML into a CKEditor instance.
38		*
39		* @param string $text
40		* The text (or HTML) to insert into the editor.
41		* @param string $id
42		* (optional) The editor instance ID.
43		*
44		* @When I put :text into CKEditor
45		* @When I put :text into CKEditor :id
46		*/
47		public function insert($text, $id = NULL) {
48		$js = $this->assertEditor($id);
49		$this->getSession()->executeScript("$js.insertHtml('$text');");
50		}
51
52		/**
53		* Asserts that a CKEditor's content contains a snippet of text.
54		*
55		* @param string $text
56		* The text (or HTML) snippet to look for.
57		* @param string $id
58		* (optional) The editor instance ID.
59		*
60		* @throws ExpectationException
61		* If the editor does not contain the specified text.
62		*
63		* @Then CKEditor should contain :text
64		* @Then CKEditor :id should contain :text
65		*/
66	View Code Duplication	public function assertEditorContains($text, $id = NULL) {
		0 ignored issues – show Duplication introduced 2017-03-16 07:41 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
67		$position = strpos($this->getContent($id), $text);
68
69		if ($position == FALSE) {
		0 ignored issues – show Bug Best Practice introduced 2017-03-16 07:41 UTC by Report Bug Copy Issue Report It seems like you are loosely comparing `$position` of type `integer` to the boolean `FALSE`. If you are specifically checking for 0, consider using something more explicit like `=== 0` instead. Loading history...
70		throw new ExpectationException(
71		'Expected CKEditor ' . $id . ' to contain "' . $text . '".',
72		$this->getSession()->getDriver()
73		);
74		}
75		}
76
77		/**
78		* Assert that a CKEditor's content matches a regular expression.
79		*
80		* @param string $expr
81		* The regular expression to match.
82		* @param string $id
83		* (optional) The editor instance ID.
84		*
85		* @throws ExpectationException
86		* If the expression does not match.
87		*
88		* @Then CKEditor should match :expression
89		* @Then CKEditor :id should match :expression
90		*/
91	View Code Duplication	public function assertEditorMatch($expr, $id = NULL) {
		0 ignored issues – show Duplication introduced 2017-03-16 07:41 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
92		$match = preg_match($expr, $this->getContent($id));
93
94		if ($match == 0) {
95		throw new ExpectationException(
96		'Expected CKEditor ' . $id . ' to match "' . $expr . '".',
97		$this->getSession()->getDriver()
98		);
99		}
100		}
101
102		/**
103		* Gets the content of a CKEditor instance.
104		*
105		* @param string $id
106		* (optional) The editor instance ID.
107		*
108		* @return string
109		* The HTML content of the editor.
110		*/
111		protected function getContent($id = NULL) {
112		$js = $this->assertEditor($id);
113		return $this->getSession()->evaluateScript("$js.getData()");
114		}
115
116		/**
117		* Executes a CKEditor command.
118		*
119		* @param string $command
120		* The command ID, as known to CKEditor's API.
121		* @param string $id
122		* (optional) The editor instance ID.
123		* @param mixed $data
124		* Additional data to pass to the executed command.
125		*
126		* @throws ExpectationException
127		* If the command cannot be executed (i.e., returns a falsy value).
128		*
129		* @When I execute the :command command in CKEditor
130		* @When I execute the :command command in CKEditor :id
131		*/
132		public function execute($command, $id = NULL, $data = NULL) {
133		$js = $this->assertEditor($id);
134
135		$session = $this->getSession();
136
137		$return = Json::decode($session->evaluateScript("$js.execCommand('$command', " . Json::encode($data) . ')'));
138
139		if (empty($return)) {
140		throw new ExpectationException(
141		'CKEditor command ' . $command . ' returned ' . var_export($return, TRUE) . ', expected truthy.',
142		$session->getDriver()
143		);
144		}
145		}
146
147		/**
148		* Returns the first available CKEditor instance ID.
149		*
150		* @return string\|false
151		* The first CKEditor instance ID, or FALSE if there are no instances.
152		*/
153		protected function getDefault() {
154		$keys = $this->getKeys();
155		return reset($keys);
156		}
157
158		/**
159		* Returns all CKEditor instance IDs.
160		*
161		* @return string[]
162		* The CKEditor instance IDs.
163		*/
164		protected function getKeys() {
165		$keys = $this
166		->getSession()
167		->evaluateScript('Object.keys(CKEDITOR.instances).join(",")');
168
169		return explode(',', $keys);
170		}
171
172		}
173

acquia / df

GitHub Access Token became invalid

Push — 8.x-2.x ( bdb6af...21ed67 )

CkEditorContext::getContent() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like