EmailContext - Code Metrics - Inspection of "Add new step to click the http link address in ema..." - silverstripe/silverstripe-behat-extension - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#121)

unknown

created 2016-08-04 23:58 UTC

EmailContext B

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	322
Duplicated Lines	17.08 %

Coupling/Cohesion

Components	1
Dependencies	7

Importance

Changes	8
Bugs	0	Features	3

Metric	Value
c	8
b	0
f	3
dl	55
loc	322
rs	8.439
wmc	47
lcom	1
cbo	7

16 Methods

Rating	Name	Duplication	Size	Complexity
A	thereTheEmailContainsPlainText()	0	13	3
A	iGoToInTheEmailToTitled()	14	14	3
B	theEmailContainFollowingData()	0	28	6
A	thereIsAnEmailTitled()	0	14	2
A	theEmailSentFrom()	13	13	3
A	theEmailSentTo()	13	13	3
A	__construct()	0	5	1
A	getSession()	0	4	1
A	before()	0	8	1
A	iGoToInTheEmailTo()	15	15	3
A	thereIsAnEmailFromTo()	0	12	4
B	thereIsAnEmailFromToTitled()	0	23	6
A	thereTheEmailContains()	0	20	4
A	iGoToInTheEmail()	0	15	2
A	iClearAllEmails()	0	5	1
B	iClickOnHttpLinkInEmail()	0	23	4

How to fix Duplicated Code Complexity

Duplicated Code

Duplicate code is one of the most pungent code smells. A rule that is often used is to re-structure code once it is duplicated in three or more places.

Common duplication problems, and corresponding solutions are:

If you have the same expression in different places: Extract expression to a method
If you have the same method in different sub-classes: Extract method, and pull up field to the parent class
If you have the same code in unrelated classes: Consider extracting the code to a new class, and injecting that class

Complex Class

Tip: Before tackling complexity, make sure that you eliminate any duplication first. This often can reduce the size of classes significantly.

Complex classes like EmailContext often do a lot of different things. To break such a class down, we need to identify a cohesive component within that class. A common approach to find such a component is to look for fields/methods that share the same prefixes, or suffixes. You can also have a look at the cohesion graph to spot any un-connected, or weakly-connected components.

Once you have determined the fields that belong together, you can apply the Extract Class refactoring. If the component makes sense as a sub-class, Extract Subclass is also a candidate, and is often faster.

While breaking up the class, it is a good idea to analyze how other classes use EmailContext, and based on these observations, apply Extract Interface, too.

<?php

namespace SilverStripe\BehatExtension\Context;

use Behat\Behat\Context\ClosuredContextInterface,
Behat\Behat\Context\TranslatedContextInterface,
Behat\Behat\Context\BehatContext,
Behat\Behat\Context\Step,
Behat\Behat\Event\FeatureEvent,
Behat\Behat\Event\ScenarioEvent,
Behat\Behat\Exception\PendingException;
use Behat\Gherkin\Node\PyStringNode,
Behat\Gherkin\Node\TableNode;
use Symfony\Component\DomCrawler\Crawler;

// PHPUnit
require_once BASE_PATH . '/vendor/phpunit/phpunit/src/Framework/Assert/Functions.php';

/**
 * Context used to define steps related to email sending.
 */
class EmailContext extends BehatContext
{
    protected $context;

    protected $mailer;

    /**
     * Stored to simplify later assertions
     */
    protected $lastMatchedEmail;

    /**
     * Initializes context.
     * Every scenario gets it's own context object.
     *
     * @param array $parameters context parameters (set them up through behat.yml)
     */
    public function __construct(array $parameters)
    {
        // Initialize your context here
        $this->context = $parameters;
    }

    /**
     * Get Mink session from MinkContext
     */
    public function getSession($name = null)
    {
        return $this->getMainContext()->getSession($name);
interface User
{
    /** @return string */
    public function getPassword();
}

class MyUser implements User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}
    }

    /**
     * @BeforeScenario
     */
    public function before(ScenarioEvent $event)

    {
        // Also set through the 'supportbehat' extension
        // to ensure its available both in CLI execution and the tested browser session
        $this->mailer = new \SilverStripe\BehatExtension\Utility\TestMailer();
        \Email::set_mailer($this->mailer);

        \Config::inst()->update("Email","send_all_emails_to", null);
    }

    /**
     * @Given /^there should (not |)be an email (to|from) "([^"]*)"$/
     */
    public function thereIsAnEmailFromTo($negate, $direction, $email)
    {
        $to = ($direction == 'to') ? $email : null;
        $from = ($direction == 'from') ? $email : null;
        $match = $this->mailer->findEmail($to, $from);
        if(trim($negate)) {
            assertNull($match);
        } else {
            assertNotNull($match);
        }
        $this->lastMatchedEmail = $match;
    }

    /**
     * @Given /^there should (not |)be an email (to|from) "([^"]*)" titled "([^"]*)"$/
     */
    public function thereIsAnEmailFromToTitled($negate, $direction, $email, $subject)
    {
        $to = ($direction == 'to') ? $email : null;
        $from = ($direction == 'from') ? $email : null;
        $match = $this->mailer->findEmail($to, $from, $subject);
        $allMails = $this->mailer->findEmails($to, $from);
        $allTitles = $allMails ? '"' . implode('","', array_map(function($email) {return $email->Subject;}, $allMails)) . '"' : null;
        if(trim($negate)) {
            assertNull($match);
        } else {
            $msg = sprintf(
                'Could not find email %s "%s" titled "%s".',
                $direction,
                $email,
                $subject
            );
            if($allTitles) {
''   == false // true
''   == null  // true
'ab' == false // false
'ab' == null  // false

// It is often better to use strict comparison
'' === false // false
'' === null  // false
                $msg .= ' Existing emails: ' . $allTitles;
            }
            assertNotNull($match,$msg);
        }
        $this->lastMatchedEmail = $match;
    }

    /**
     * Example: Given the email should contain "Thank you for registering!".
     * Assumes an email has been identified by a previous step,
     * e.g. through 'Given there should be an email to "[email protected]"'.
     * 
	 * @Given /^the email should (not |)contain "([^"]*)"$/
	 */
	public function thereTheEmailContains($negate, $content)
	{
		if(!$this->lastMatchedEmail) {
			throw new \LogicException('No matched email found from previous step');
		}

		$email = $this->lastMatchedEmail;
		$emailContent = null;
$myVar = 'Value';
$higher = false;

if (rand(1, 6) > 3) {
    $higher = true;
} else {
    $higher = false;
}
		if($email->Content) {
			$emailContent = $email->Content;
		} else {
			$emailContent = $email->PlainContent;
		}

		if(trim($negate)) {
			assertNotContains($content, $emailContent);
		} else {
			assertContains($content, $emailContent);
		}
	}

	/**
	 * Example: Given the email contains "Thank you for <strong>registering!<strong>".
	 * Then the email should contain plain text "Thank you for registering!"
	 * Assumes an email has been identified by a previous step,
	 * e.g. through 'Given there should be an email to "[email protected]"'.
	 * 
	 * @Given /^the email should contain plain text "([^"]*)"$/
	 */
	public function thereTheEmailContainsPlainText($content)
	{
		if(!$this->lastMatchedEmail) {
			throw new \LogicException('No matched email found from previous step');
		}

		$email = $this->lastMatchedEmail;
		$emailContent = ($email->Content) ? ($email->Content) : ($email->PlainContent);
		$emailPlainText = strip_tags($emailContent);
		$emailPlainText = preg_replace("/\h+/", " ", $emailPlainText);

		assertContains($content, $emailPlainText);
	}

    /**
     * @When /^I click on the "([^"]*)" link in the email (to|from) "([^"]*)"$/
     */
    public function iGoToInTheEmailTo($linkSelector, $direction, $email)

    {
        $to = ($direction == 'to') ? $email : null;
        $from = ($direction == 'from') ? $email : null;
        $match = $this->mailer->findEmail($to, $from);
        assertNotNull($match);

        $crawler = new Crawler($match->Content);
        $linkEl = $crawler->selectLink($linkSelector);
        assertNotNull($linkEl);
        $link = $linkEl->attr('href');
        assertNotNull($link);
        
        return new Step\When(sprintf('I go to "%s"', $link));
    }

    /**
     * @When /^I click on the "([^"]*)" link in the email (to|from) "([^"]*)" titled "([^"]*)"$/
     */
    public function iGoToInTheEmailToTitled($linkSelector, $direction, $email, $title)

    {
        $to = ($direction == 'to') ? $email : null;
        $from = ($direction == 'from') ? $email : null;
        $match = $this->mailer->findEmail($to, $from, $title);
        assertNotNull($match);

        $crawler = new Crawler($match->Content);
        $linkEl = $crawler->selectLink($linkSelector);
        assertNotNull($linkEl);
        $link = $linkEl->attr('href');
        assertNotNull($link);
        return new Step\When(sprintf('I go to "%s"', $link));
    }
    
    /**
     * Assumes an email has been identified by a previous step,
     * e.g. through 'Given there should be an email to "[email protected]"'.
     * 
     * @When /^I click on the "([^"]*)" link in the email"$/
     */
    public function iGoToInTheEmail($linkSelector)
    {
        if(!$this->lastMatchedEmail) {
            throw new \LogicException('No matched email found from previous step');
        }

        $match = $this->lastMatchedEmail;
        $crawler = new Crawler($match->Content);
        $linkEl = $crawler->selectLink($linkSelector);
        assertNotNull($linkEl);
        $link = $linkEl->attr('href');
        assertNotNull($link);

        return new Step\When(sprintf('I go to "%s"', $link));
    }

    /**
     * @Given /^I clear all emails$/
     */
    public function iClearAllEmails()
    {
        $this->lastMatchedEmail = null;
        return $this->mailer->clearEmails();
    }

	/**
	 * Example: Then the email should contain the following data:
	 * | row1 |
	 * | row2 |
	 * Assumes an email has been identified by a previous step.
	 * @Then /^the email should (not |)contain the following data:$/
	 */
	public function theEmailContainFollowingData($negate, TableNode $table) {
		if(!$this->lastMatchedEmail) {
			throw new \LogicException('No matched email found from previous step');
		}

		$email = $this->lastMatchedEmail;
		$emailContent = null;
$myVar = 'Value';
$higher = false;

if (rand(1, 6) > 3) {
    $higher = true;
} else {
    $higher = false;
}
		if($email->Content) {
			$emailContent = $email->Content;
		} else {
			$emailContent = $email->PlainContent;
		}
		// Convert html content to plain text
		$emailContent = strip_tags($emailContent);
		$emailContent = preg_replace("/\h+/", " ", $emailContent);
		$rows = $table->getRows();
		
		// For "should not contain"
		if(trim($negate)) {
			foreach($rows as $row) {
				assertNotContains($row[0], $emailContent);
			}
		} else {
			foreach($rows as $row) {
				assertContains($row[0], $emailContent);
			}
		}
	}

	/**
	 * @Then /^there should (not |)be an email titled "([^"]*)"$/
	 */
	public function thereIsAnEmailTitled($negate, $subject)
	{
		$match = $this->mailer->findEmail(null, null, $subject);
		if(trim($negate)) {
			assertNull($match);
		} else {
			$msg = sprintf(
				'Could not find email titled "%s".',
				$subject
			);
			assertNotNull($match,$msg);
		}
		$this->lastMatchedEmail = $match;
	}

	/**
	 * @Then /^the email should (not |)be sent from "([^"]*)"$/
	 */
	public function theEmailSentFrom($negate, $from)

	{
		if(!$this->lastMatchedEmail) {
			throw new \LogicException('No matched email found from previous step');
		}

		$match = $this->lastMatchedEmail;
		if(trim($negate)) {
			assertNotContains($from, $match->From);
		} else {
			assertContains($from, $match->From);
		}
	}

	/**
	 * @Then /^the email should (not |)be sent to "([^"]*)"$/
	 */
	public function theEmailSentTo($negate, $to)

	{
		if(!$this->lastMatchedEmail) {
			throw new \LogicException('No matched email found from previous step');
		}

		$match = $this->lastMatchedEmail;
		if(trim($negate)) {
			assertNotContains($to, $match->To);
		} else {
			assertContains($to, $match->To);
		}
	}

    /**
     * The link text is the link address itself which contains special characters
     * e.g. http://localhost/Security/changepassword?m=199&title=reset
     * Example: When I click on the http link "changepassword" in the email
     * @When /^I click on the http link "([^"]*)" in the email$/
     */
    public function iClickOnHttpLinkInEmail($httpText) {
        if(!$this->lastMatchedEmail) {
            throw new \LogicException('No matched email found from previous step');
        }

        $email = $this->lastMatchedEmail;
        $html = $email->Content;
        $dom = new \DOMDocument();
        $dom->loadHTML($html);

        $tags = $dom->getElementsByTagName('a');
        $href = null;
        foreach ($tags as $tag) {
            $linkText = $tag->nodeValue;
            if(strpos($linkText, $httpText) !== false) {
                $href = $linkText;
                break;
            }
        }
        assertNotNull($href);

        return new Step\When(sprintf('I go to "%s"', $href));
    }
}


1		<?php
2
3		namespace SilverStripe\BehatExtension\Context;
4
5		use Behat\Behat\Context\ClosuredContextInterface,
6		Behat\Behat\Context\TranslatedContextInterface,
7		Behat\Behat\Context\BehatContext,
8		Behat\Behat\Context\Step,
9		Behat\Behat\Event\FeatureEvent,
10		Behat\Behat\Event\ScenarioEvent,
11		Behat\Behat\Exception\PendingException;
12		use Behat\Gherkin\Node\PyStringNode,
13		Behat\Gherkin\Node\TableNode;
14		use Symfony\Component\DomCrawler\Crawler;
15
16		// PHPUnit
17		require_once BASE_PATH . '/vendor/phpunit/phpunit/src/Framework/Assert/Functions.php';
18
19		/**
20		* Context used to define steps related to email sending.
21		*/
22		class EmailContext extends BehatContext
23		{
24		protected $context;
25
26		protected $mailer;
27
28		/**
29		* Stored to simplify later assertions
30		*/
31		protected $lastMatchedEmail;
32
33		/**
34		* Initializes context.
35		* Every scenario gets it's own context object.
36		*
37		* @param array $parameters context parameters (set them up through behat.yml)
38		*/
39		public function __construct(array $parameters)
40		{
41		// Initialize your context here
42		$this->context = $parameters;
43		}
44
45		/**
46		* Get Mink session from MinkContext
47		*/
48		public function getSession($name = null)
49		{
50		return $this->getMainContext()->getSession($name);
		0 ignored issues – show Bug introduced 2015-12-02 23:27 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `Behat\Behat\Context\ExtendedContextInterface` as the method `getSession()` does only exist in the following implementations of said interface: `Behat\MinkExtension\Context\MinkContext`, `Behat\MinkExtension\Context\RawMinkContext`, `SilverStripe\BehatExtension\Context\BasicContext`, `SilverStripe\BehatExtension\Context\EmailContext`, `SilverStripe\BehatExtension\Context\FixtureContext`, `SilverStripe\BehatExtension\Context\LoginContext`, `SilverStripe\BehatExtens...ext\SilverStripeContext`. Let’s take a look at an example: interface User { /** @return string / public function getPassword(); } class MyUser implements User { public function getPassword() { // return something } public function getDisplayName() { // return some name. } } class AuthSystem { public function authenticate(User $user) { $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName())); // do something. } } In the above example, the authenticate() method works fine as long as you just pass instances of MyUser. However, if you now also want to pass a different implementation of User which does not have a getDisplayName() method, the code will break. Available Fixes Change the type-hint for the parameter: class AuthSystem { public function authenticate(MyUser $user) { / ... / } } Add an additional type-check: class AuthSystem { public function authenticate(User $user) { if ($user instanceof MyUser) { $this->logger->info(/* ... /); } // or alternatively if ( ! $user instanceof MyUser) { throw new \LogicException( '$user must be an instance of MyUser, ' .'other instances are not supported.' ); } } } Note:* PHP Analyzer uses reverse abstract interpretation to narrow down the types inside the if block in such a case. Add the method to the interface: interface User { /** @return string / public function getPassword(); /* @return string */ public function getDisplayName(); } Loading history...
51		}
52
53		/**
54		* @BeforeScenario
55		*/
56		public function before(ScenarioEvent $event)
		0 ignored issues – show Unused Code introduced 2015-12-02 23:27 UTC by Report Bug Copy Issue Report The parameter `$event` is not used and could be removed. This check looks from parameters that have been defined for a function or method, but which are not used in the method body. Loading history...
57		{
58		// Also set through the 'supportbehat' extension
59		// to ensure its available both in CLI execution and the tested browser session
60		$this->mailer = new \SilverStripe\BehatExtension\Utility\TestMailer();
61		\Email::set_mailer($this->mailer);
		0 ignored issues – show Deprecated Code introduced 2015-12-02 23:27 UTC by Report Bug Copy Issue Report The method `Email::set_mailer()` has been deprecated with message: since version 4.0 This method has been deprecated. The supplier of the class has supplied an explanatory message. The explanatory message should give you some clue as to whether and when the method will be removed from the class and what other method or class to use instead. Loading history...
62		\Config::inst()->update("Email","send_all_emails_to", null);
63		}
64
65		/**
66		* @Given /^there should (not \|)be an email (to\|from) "([^"]*)"$/
67		*/
68		public function thereIsAnEmailFromTo($negate, $direction, $email)
69		{
70		$to = ($direction == 'to') ? $email : null;
71		$from = ($direction == 'from') ? $email : null;
72		$match = $this->mailer->findEmail($to, $from);
73		if(trim($negate)) {
74		assertNull($match);
75		} else {
76		assertNotNull($match);
77		}
78		$this->lastMatchedEmail = $match;
79		}
80
81		/**
82		* @Given /^there should (not \|)be an email (to\|from) "([^"])" titled "([^"])"$/
83		*/
84		public function thereIsAnEmailFromToTitled($negate, $direction, $email, $subject)
85		{
86		$to = ($direction == 'to') ? $email : null;
87		$from = ($direction == 'from') ? $email : null;
88		$match = $this->mailer->findEmail($to, $from, $subject);
89		$allMails = $this->mailer->findEmails($to, $from);
90		$allTitles = $allMails ? '"' . implode('","', array_map(function($email) {return $email->Subject;}, $allMails)) . '"' : null;
91		if(trim($negate)) {
92		assertNull($match);
93		} else {
94		$msg = sprintf(
95		'Could not find email %s "%s" titled "%s".',
96		$direction,
97		$email,
98		$subject
99		);
100		if($allTitles) {
		0 ignored issues – show Bug Best Practice introduced 2015-12-02 23:27 UTC by Report Bug Copy Issue Report The expression `$allTitles` of type `string\|null` is loosely compared to `true`; this is ambiguous if the string can be empty. You might want to explicitly use `!== null` instead. In PHP, under loose comparison (like `==`, or `!=`, or `switch` conditions), values of different types might be equal. For `string` values, the empty string `''` is a special case, in particular the following results might be unexpected: '' == false // true '' == null // true 'ab' == false // false 'ab' == null // false // It is often better to use strict comparison '' === false // false '' === null // false Loading history...
101		$msg .= ' Existing emails: ' . $allTitles;
102		}
103		assertNotNull($match,$msg);
104		}
105		$this->lastMatchedEmail = $match;
106		}
107
108		/**
109		* Example: Given the email should contain "Thank you for registering!".
110		* Assumes an email has been identified by a previous step,
111		* e.g. through 'Given there should be an email to "[email protected]"'.
112		*
113		* @Given /^the email should (not \|)contain "([^"]*)"$/
114		*/
115		public function thereTheEmailContains($negate, $content)
116		{
117		if(!$this->lastMatchedEmail) {
118		throw new \LogicException('No matched email found from previous step');
119		}
120
121		$email = $this->lastMatchedEmail;
122		$emailContent = null;
		0 ignored issues – show Unused Code introduced 2015-12-02 23:27 UTC by Report Bug Copy Issue Report `$emailContent` is not used, you could remove the assignment. This check looks for variable assignements that are either overwritten by other assignments or where the variable is not used subsequently. $myVar = 'Value'; $higher = false; if (rand(1, 6) > 3) { $higher = true; } else { $higher = false; } Both the `$myVar` assignment in line 1 and the `$higher` assignment in line 2 are dead. The first because `$myVar` is never used and the second because `$higher` is always overwritten for every possible time line. Loading history...
123		if($email->Content) {
124		$emailContent = $email->Content;
125		} else {
126		$emailContent = $email->PlainContent;
127		}
128
129		if(trim($negate)) {
130		assertNotContains($content, $emailContent);
131		} else {
132		assertContains($content, $emailContent);
133		}
134		}
135
136		/**
137		* Example: Given the email contains "Thank you for <strong>registering!<strong>".
138		* Then the email should contain plain text "Thank you for registering!"
139		* Assumes an email has been identified by a previous step,
140		* e.g. through 'Given there should be an email to "[email protected]"'.
141		*
142		* @Given /^the email should contain plain text "([^"]*)"$/
143		*/
144		public function thereTheEmailContainsPlainText($content)
145		{
146		if(!$this->lastMatchedEmail) {
147		throw new \LogicException('No matched email found from previous step');
148		}
149
150		$email = $this->lastMatchedEmail;
151		$emailContent = ($email->Content) ? ($email->Content) : ($email->PlainContent);
152		$emailPlainText = strip_tags($emailContent);
153		$emailPlainText = preg_replace("/\h+/", " ", $emailPlainText);
154
155		assertContains($content, $emailPlainText);
156		}
157
158		/**
159		* @When /^I click on the "([^"])" link in the email (to\|from) "([^"])"$/
160		*/
161	View Code Duplication	public function iGoToInTheEmailTo($linkSelector, $direction, $email)
		0 ignored issues – show Duplication introduced 2015-12-02 23:27 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...
162		{
163		$to = ($direction == 'to') ? $email : null;
164		$from = ($direction == 'from') ? $email : null;
165		$match = $this->mailer->findEmail($to, $from);
166		assertNotNull($match);
167
168		$crawler = new Crawler($match->Content);
169		$linkEl = $crawler->selectLink($linkSelector);
170		assertNotNull($linkEl);
171		$link = $linkEl->attr('href');
172		assertNotNull($link);
173
174		return new Step\When(sprintf('I go to "%s"', $link));
175		}
176
177		/**
178		* @When /^I click on the "([^"])" link in the email (to\|from) "([^"])" titled "([^"]*)"$/
179		*/
180	View Code Duplication	public function iGoToInTheEmailToTitled($linkSelector, $direction, $email, $title)
		0 ignored issues – show Duplication introduced 2015-12-02 23:27 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...
181		{
182		$to = ($direction == 'to') ? $email : null;
183		$from = ($direction == 'from') ? $email : null;
184		$match = $this->mailer->findEmail($to, $from, $title);
185		assertNotNull($match);
186
187		$crawler = new Crawler($match->Content);
188		$linkEl = $crawler->selectLink($linkSelector);
189		assertNotNull($linkEl);
190		$link = $linkEl->attr('href');
191		assertNotNull($link);
192		return new Step\When(sprintf('I go to "%s"', $link));
193		}
194
195		/**
196		* Assumes an email has been identified by a previous step,
197		* e.g. through 'Given there should be an email to "[email protected]"'.
198		*
199		* @When /^I click on the "([^"]*)" link in the email"$/
200		*/
201		public function iGoToInTheEmail($linkSelector)
202		{
203		if(!$this->lastMatchedEmail) {
204		throw new \LogicException('No matched email found from previous step');
205		}
206
207		$match = $this->lastMatchedEmail;
208		$crawler = new Crawler($match->Content);
209		$linkEl = $crawler->selectLink($linkSelector);
210		assertNotNull($linkEl);
211		$link = $linkEl->attr('href');
212		assertNotNull($link);
213
214		return new Step\When(sprintf('I go to "%s"', $link));
215		}
216
217		/**
218		* @Given /^I clear all emails$/
219		*/
220		public function iClearAllEmails()
221		{
222		$this->lastMatchedEmail = null;
223		return $this->mailer->clearEmails();
224		}
225
226		/**
227		* Example: Then the email should contain the following data:
228		* \| row1 \|
229		* \| row2 \|
230		* Assumes an email has been identified by a previous step.
231		* @Then /^the email should (not \|)contain the following data:$/
232		*/
233		public function theEmailContainFollowingData($negate, TableNode $table) {
234		if(!$this->lastMatchedEmail) {
235		throw new \LogicException('No matched email found from previous step');
236		}
237
238		$email = $this->lastMatchedEmail;
239		$emailContent = null;
		0 ignored issues – show Unused Code introduced 2015-12-02 23:27 UTC by Report Bug Copy Issue Report `$emailContent` is not used, you could remove the assignment. This check looks for variable assignements that are either overwritten by other assignments or where the variable is not used subsequently. $myVar = 'Value'; $higher = false; if (rand(1, 6) > 3) { $higher = true; } else { $higher = false; } Both the `$myVar` assignment in line 1 and the `$higher` assignment in line 2 are dead. The first because `$myVar` is never used and the second because `$higher` is always overwritten for every possible time line. Loading history...
240		if($email->Content) {
241		$emailContent = $email->Content;
242		} else {
243		$emailContent = $email->PlainContent;
244		}
245		// Convert html content to plain text
246		$emailContent = strip_tags($emailContent);
247		$emailContent = preg_replace("/\h+/", " ", $emailContent);
248		$rows = $table->getRows();
249
250		// For "should not contain"
251		if(trim($negate)) {
252		foreach($rows as $row) {
253		assertNotContains($row[0], $emailContent);
254		}
255		} else {
256		foreach($rows as $row) {
257		assertContains($row[0], $emailContent);
258		}
259		}
260		}
261
262		/**
263		* @Then /^there should (not \|)be an email titled "([^"]*)"$/
264		*/
265		public function thereIsAnEmailTitled($negate, $subject)
266		{
267		$match = $this->mailer->findEmail(null, null, $subject);
268		if(trim($negate)) {
269		assertNull($match);
270		} else {
271		$msg = sprintf(
272		'Could not find email titled "%s".',
273		$subject
274		);
275		assertNotNull($match,$msg);
276		}
277		$this->lastMatchedEmail = $match;
278		}
279
280		/**
281		* @Then /^the email should (not \|)be sent from "([^"]*)"$/
282		*/
283	View Code Duplication	public function theEmailSentFrom($negate, $from)
		0 ignored issues – show Duplication introduced 2016-01-07 21:46 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...
284		{
285		if(!$this->lastMatchedEmail) {
286		throw new \LogicException('No matched email found from previous step');
287		}
288
289		$match = $this->lastMatchedEmail;
290		if(trim($negate)) {
291		assertNotContains($from, $match->From);
292		} else {
293		assertContains($from, $match->From);
294		}
295		}
296
297		/**
298		* @Then /^the email should (not \|)be sent to "([^"]*)"$/
299		*/
300	View Code Duplication	public function theEmailSentTo($negate, $to)
		0 ignored issues – show Duplication introduced 2016-01-07 21:46 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...
301		{
302		if(!$this->lastMatchedEmail) {
303		throw new \LogicException('No matched email found from previous step');
304		}
305
306		$match = $this->lastMatchedEmail;
307		if(trim($negate)) {
308		assertNotContains($to, $match->To);
309		} else {
310		assertContains($to, $match->To);
311		}
312		}
313
314		/**
315		* The link text is the link address itself which contains special characters
316		* e.g. http://localhost/Security/changepassword?m=199&title=reset
317		* Example: When I click on the http link "changepassword" in the email
318		* @When /^I click on the http link "([^"]*)" in the email$/
319		*/
320		public function iClickOnHttpLinkInEmail($httpText) {
321		if(!$this->lastMatchedEmail) {
322		throw new \LogicException('No matched email found from previous step');
323		}
324
325		$email = $this->lastMatchedEmail;
326		$html = $email->Content;
327		$dom = new \DOMDocument();
328		$dom->loadHTML($html);
329
330		$tags = $dom->getElementsByTagName('a');
331		$href = null;
332		foreach ($tags as $tag) {
333		$linkText = $tag->nodeValue;
334		if(strpos($linkText, $httpText) !== false) {
335		$href = $linkText;
336		break;
337		}
338		}
339		assertNotNull($href);
340
341		return new Step\When(sprintf('I go to "%s"', $href));
342		}
343		}
344

silverstripe / silverstripe-behat-extension

Pull Request — master (#121)

EmailContext B

Complexity

Size/Duplication

Coupling/Cohesion

Importance

16 Methods

How to fix Duplicated Code Complexity

Duplicated Code

Complex Class

Available Fixes

Duplication Side-by-Side

Filter issues like