PageContentTrait - Code Metrics - Inspection of "Issue 38 W.I.P" - jcalderonzumba/MinkPhantomJSDriver - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#50)

by Juan Francisco

created 2015-12-10 14:14 UTC

PageContentTrait A

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	68
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	1

Importance

Changes	5
Bugs	0	Features	0

Metric	Value
wmc	7
c	5
b	0
f	0
lcom	1
cbo	1
dl	0
loc	68
rs	10

5 Methods

Rating	Name	Size	Complexity
A	getContent()	9	2
A	getText()	8	1
A	getHtml()	5	1
A	getOuterHtml()	5	1
A	getScreenshot()	8	2

<?php

namespace Zumba\Mink\Driver;

use Behat\Mink\Exception\DriverException;

/**
 * Class PageContentTrait
 * @package Zumba\Mink\Driver
 */
trait PageContentTrait {

  /**
   * @return string
   */
  public function getContent() {
    $bodyRegexp = "#<body>(.*)</body>#is";
    $content = $this->browser->getBody();
class MyClass { }

$x = new MyClass();
$x->foo = true;
    if (preg_match($bodyRegexp, $content, $bodyMatch) !== 1) {
      //Fail safe in case we don't get body enclosed info
      return $content;
    }
    return trim($bodyMatch[1]);
  }

  /**
   * Given xpath, will try to get ALL the text, visible and not visible from such xpath
   * @param string $xpath
   * @return string
   * @throws DriverException
   */
  public function getText($xpath) {
    $elements = $this->findElement($xpath, 1);
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
    //allText works only with ONE element so it will be the first one and also returns new lines that we will remove
    $text = $this->browser->allText($elements["page_id"], $elements["ids"][0]);
    $text = trim(str_replace(array("\r", "\r\n", "\n"), ' ', $text));
    $text = preg_replace('/ {2,}/', ' ', $text);
    return $text;
  }

  /**
   * Returns the inner html of a given xpath
   * @param string $xpath
   * @return string
   * @throws DriverException
   */
  public function getHtml($xpath) {
    $elements = $this->findElement($xpath, 1);
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
    //allText works only with ONE element so it will be the first one
    return $this->browser->allHtml($elements["page_id"], $elements["ids"][0], "inner");
  }

  /**
   * Gets the outer html of a given xpath
   * @param string $xpath
   * @return string
   * @throws DriverException
   */
  public function getOuterHtml($xpath) {
    $elements = $this->findElement($xpath, 1);
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
    //allText works only with ONE element so it will be the first one
    return $this->browser->allHtml($elements["page_id"], $elements["ids"][0], "outer");
  }

  /**
   * Returns the binary representation of the current page we are in
   * @throws DriverException
   * @return string
   */
  public function getScreenshot() {
    $options = array("full" => true, "selector" => null);
    $b64ScreenShot = $this->browser->renderBase64("JPEG", $options);
    if (($binaryScreenShot = base64_decode($b64ScreenShot, true)) === false) {
      throw new DriverException("There was a problem while doing the screenshot of the current page");
    }
    return $binaryScreenShot;
  }
}


1			<?php
2
3			namespace Zumba\Mink\Driver;
4
5			use Behat\Mink\Exception\DriverException;
6
7			/**
8			* Class PageContentTrait
9			* @package Zumba\Mink\Driver
10			*/
11			trait PageContentTrait {
12
13			/**
14			* @return string
15			*/
16			public function getContent() {
17			$bodyRegexp = "#<body>(.*)</body>#is";
18			$content = $this->browser->getBody();
			0 ignored issues – show Bug introduced 2015-12-10 14:17 UTC by Report Bug Copy Issue Report The property `browser` does not exist. Did you maybe forget to declare it? In PHP it is possible to write to properties without declaring them. For example, the following is perfectly valid PHP code: class MyClass { } $x = new MyClass(); $x->foo = true; Generally, it is a good practice to explictly declare properties to avoid accidental typos and provide IDE auto-completion: class MyClass { public $foo; } $x = new MyClass(); $x->foo = true; Loading history...
19			if (preg_match($bodyRegexp, $content, $bodyMatch) !== 1) {
20			//Fail safe in case we don't get body enclosed info
21			return $content;
22			}
23			return trim($bodyMatch[1]);
24			}
25
26			/**
27			* Given xpath, will try to get ALL the text, visible and not visible from such xpath
28			* @param string $xpath
29			* @return string
30			* @throws DriverException
31			*/
32			public function getText($xpath) {
33			$elements = $this->findElement($xpath, 1);
			0 ignored issues – show Bug introduced 2015-12-10 14:17 UTC by Report Bug Copy Issue Report It seems like `findElement()` 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...
34			//allText works only with ONE element so it will be the first one and also returns new lines that we will remove
35			$text = $this->browser->allText($elements["page_id"], $elements["ids"][0]);
36			$text = trim(str_replace(array("\r", "\r\n", "\n"), ' ', $text));
37			$text = preg_replace('/ {2,}/', ' ', $text);
38			return $text;
39			}
40
41			/**
42			* Returns the inner html of a given xpath
43			* @param string $xpath
44			* @return string
45			* @throws DriverException
46			*/
47			public function getHtml($xpath) {
48			$elements = $this->findElement($xpath, 1);
			0 ignored issues – show Bug introduced 2015-12-10 14:17 UTC by Report Bug Copy Issue Report It seems like `findElement()` 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...
49			//allText works only with ONE element so it will be the first one
50			return $this->browser->allHtml($elements["page_id"], $elements["ids"][0], "inner");
51			}
52
53			/**
54			* Gets the outer html of a given xpath
55			* @param string $xpath
56			* @return string
57			* @throws DriverException
58			*/
59			public function getOuterHtml($xpath) {
60			$elements = $this->findElement($xpath, 1);
			0 ignored issues – show Bug introduced 2015-12-10 14:17 UTC by Report Bug Copy Issue Report It seems like `findElement()` 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...
61			//allText works only with ONE element so it will be the first one
62			return $this->browser->allHtml($elements["page_id"], $elements["ids"][0], "outer");
63			}
64
65			/**
66			* Returns the binary representation of the current page we are in
67			* @throws DriverException
68			* @return string
69			*/
70			public function getScreenshot() {
71			$options = array("full" => true, "selector" => null);
72			$b64ScreenShot = $this->browser->renderBase64("JPEG", $options);
73			if (($binaryScreenShot = base64_decode($b64ScreenShot, true)) === false) {
74			throw new DriverException("There was a problem while doing the screenshot of the current page");
75			}
76			return $binaryScreenShot;
77			}
78			}
79

jcalderonzumba / MinkPhantomJSDriver

Pull Request — master (#50)

PageContentTrait A

Complexity

Size/Duplication

Coupling/Cohesion

Importance

5 Methods

Duplication Side-by-Side

Filter issues like