InteractsWithMailCatcher::cleanEmailMessages() - Code Metrics - Inspection of "Tests and Assertions" - drakakisgeo/mailtester - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( a9ac44...3461ec )

by Drakakis

created 2017-02-23 18:46 UTC

InteractsWithMailCatcher::cleanEmailMessages() A

↳ Parent: InteractsWithMailCatcher

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Importance

Changes

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

<?php

namespace Drakakisgeo\Mailtester;

use GuzzleHttp\Client;

trait InteractsWithMailCatcher
{
    use InteractsWithSwiftEmailer;

    /**
     * Init setup
     */
    public function setUp()
    {
        parent::setUp();
        $this->initCatcher();
    }

    /**
     * Init client and clean the messages
     */
    public function initCatcher()
    {
        $this->mailcatcher = new Client(['base_uri' => config('mailtester.url')]);
class MyClass { }

$x = new MyClass();
$x->foo = true;
        $this->cleanEmailMessages();
    }

    /**
     * Clear the list from all emails
     */
    public function cleanEmailMessages()
    {
        $this->mailcatcher->delete('/messages');
    }

    /**
     * Assert one email was send so list is not empty
     */
    public function assertEmailIsSent($description = '')
    {
        $this->assertNotEmpty($this->getEmailMessages(), $description);
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
    }

    /**
     * Assert that First Email's subject contains a string
     *
     * @param        $needle
     * @param string $description
     */
    public function assertEmailFirstSubjectContains($needle, $description = '')
    {
        $this->assertContains($needle, $this->getEmailFirstMessage()->subject, $description);
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
    }

    /**
     * Assert that Last Email's subject contains a string
     *
     * @param        $needle
     * @param string $description
     */
    public function assertEmailLastSubjectContains($needle, $description = '')
    {
        $this->assertContains($needle, $this->getEmailLastMessage()->subject, $description);
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
    }

    /**
     * Assert that certain Email's subject contains a string
     *
     * @param        $needle
     * @param string $description
     */
    public function assertEmailNthSubjectContains($needle, $nth, $description = '')
    {
        $this->assertContains($needle, $this->getEmailMessage($nth)->subject, $description);
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
    }


    /**
     * Assert that the subject in the first Email is equal to a string
     * @param $expected
     * @param string $description
     */
    public function assertEmailFirstSubjectEquals($expected, $description = '')
    {
        $this->assertEmailSubjectEquals($expected, $this->getEmailFirstMessage(), $description);
    }

    /**
     * Assert that the subject in the last Email is equal to a string
     * @param $expected
     * @param string $description
     */
    public function assertEmailLastSubjectEquals($expected, $description = '')
    {
        $this->assertEmailSubjectEquals($expected, $this->getEmailLastMessage(), $description);
    }

    /**
     * Assert that the subject in the Nth Email is equal to a string
     * @param $expected
     * @param $nth
     * @param string $description
     */
    public function assertEmailNthSubjectEquals($expected, $nth, $description = '')
    {
        $this->assertEmailSubjectEquals($expected, $this->getEmailMessage($nth), $description);
    }


    /**
     * Assert that the subject of an Email is equal to a string
     * @param $expected
     * @param $email
     * @param string $description
     */
    public function assertEmailSubjectEquals($expected, $email, $description = '')
    {
        $this->assertEquals($expected, $email->subject, $description);
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
    }

    /**
     * Assert HTML body of First Email contains a certain text
     *
     * @param        $needle
     * @param string $description
     */
    public function assertEmailFirstHtmlContains($needle, $description = '')
    {
        $this->assertEmailHtmlContains($needle, $this->getEmailFirstMessage(), $description);
    }

    /**
     * Assert HTML body of Last Email contains a certain text
     *
     * @param        $needle
     * @param string $description
     */
    public function assertEmailLastHtmlContains($needle, $description = '')
    {
        $this->assertEmailHtmlContains($needle, $this->getEmailLastMessage(), $description);
    }


    /**
     * Assert HTML body of certain Nth Email contains a certain text
     *
     * @param $needle
     * @param $nth
     * @param string $description
     */
    public function assertEmailNthHtmlContains($needle, $nth, $description = '')
    {
        $this->assertEmailHtmlContains($needle, $this->getEmailMessage($nth), $description);
    }

    /**
     * Assert HTML body of Email contains a certain text
     *
     * @param        $needle
     * @param        $email
     * @param string $description
     */
    public function assertEmailHtmlContains($needle, $email, $description = '')
    {
        $response = $this->mailcatcher->get("/messages/{$email->id}.html");
        $this->assertContains($needle, (string)$response->getBody(), $description);
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
    }

    /**
     * Assert Text body of First Email contains a certain text
     *
     * @param        $needle
     * @param string $description
     */
    public function assertEmailFirstTextContains($needle, $description = '')
    {
        $this->assertEmailTextContains($needle, $this->getEmailFirstMessage(), $description);
    }

    /**
     * Assert Text body of Last Email contains a certain text
     *
     * @param        $needle
     * @param string $description
     */
    public function assertEmailLastTextContains($needle, $description = '')
    {
        $this->assertEmailTextContains($needle, $this->getEmailLastMessage(), $description);
    }

    /**
     * Assert Text body of Nth Email contains a certain text
     *
     * @param        $needle
     * @param        $nth
     * @param string $description
     */
    public function assertEmailNthTextContains($needle, $nth, $description = '')
    {
        $this->assertEmailTextContains($needle, $this->getEmailMessage($nth), $description);
    }


    /**
     * Assert Text body of Email contains a certain text
     *
     * @param        $needle
     * @param string $description
     */
    public function assertEmailTextContains($needle, $email, $description = '')
    {
        $response = $this->mailcatcher->get("/messages/{$email->id}.plain");
        $this->assertContains($needle, (string)$response->getBody(), $description);
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
    }


    /**
     * Assert that the sender of first Email is equal to a string
     *
     * @param        $expected
     * @param string $description
     */
    public function assertEmailFirstSenderEquals($expected, $description = '')
    {
        $this->assertEmailSenderEquals($expected, $this->getEmailFirstMessage(), $description);
    }

    /**
     * Assert that the sender of last Email is equal to a string
     *
     * @param        $expected
     * @param string $description
     */
    public function assertEmailLastSenderEquals($expected, $description = '')
    {
        $this->assertEmailSenderEquals($expected, $this->getEmailLastMessage(), $description);
    }

    /**
     * Assert that the sender of Nth Email is equal to a string
     *
     * @param        $expected
     * @param        $nth
     * @param string $description
     */
    public function assertEmailNthSenderEquals($expected, $nth, $description = '')
    {
        $this->assertEmailSenderEquals($expected, $this->getEmailMessage($nth), $description);
    }

    /**
     * Assert that the sender is equal to a string
     *
     * @param        $expected
     * @param        $email
     * @param string $description
     */
    public function assertEmailSenderEquals($expected, $email, $description = '')
    {
        $expected = '<' . $expected . '>';
        $this->assertEquals($expected, $email->sender, $description);
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
    }

    /**
     * Assert that the recipients list of First Email contains a certain one
     *
     * @param        $needle
     * @param string $description
     */
    public function assertEmailFirstRecipientsContain($needle, $description = '')
    {
        $this->assertEmailRecipientsContain($needle, $this->getEmailFirstMessage(), $description);
    }

    /**
     * Assert that the recipients list of Last Email contains a certain one
     *
     * @param        $needle
     * @param string $description
     */
    public function assertEmailLastRecipientsContain($needle, $description = '')
    {
        $this->assertEmailRecipientsContain($needle, $this->getEmailLastMessage(), $description);
    }

    /**
     * Assert that the recipients list of Nth Email contains a certain one
     *
     * @param        $needle
     * @param        $nth
     * @param string $description
     */
    public function assertEmailNthRecipientsContain($needle, $nth, $description = '')
    {
        $this->assertEmailRecipientsContain($needle, $this->getEmailMessage($nth), $description);
    }


    /**
     * Assert that the recipients list of Email contains a certain one
     *
     * @param        $needle
     * @param string $description
     */
    public function assertEmailRecipientsContain($needle, $email, $description = '')
    {
        $needle = '<' . $needle . '>';
        $this->assertContains($needle, $email->recipients, $description);
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
    }

    /**
     * Assert that the cc list of First Mail contains a certain one
     *
     * @param        $needle
     * @param string $description
     */
    public function assertEmailFirstCcContain($needle, $description = '')
    {
        $this->assertEmailCcContain($needle, $this->getEmailFirstMessage(), $description);
    }

    /**
     * Assert that the cc list of Last Mail contains a certain one
     *
     * @param        $needle
     * @param string $description
     */
    public function assertEmailLastCcContain($needle, $description = '')
    {
        $this->assertEmailCcContain($needle, $this->getEmailLastMessage(), $description);
    }

    /**
     * Assert that the cc list of Nth Mail contains a certain one
     *
     * @param        $needle
     * $param        $nth
     * @param string $description
     */
    public function assertEmailNthCcContain($needle, $nth, $description = '')
    {
        $this->assertEmailCcContain($needle, $this->getEmailMessage($nth), $description);
    }

    /**
     * Assert that the cc list of Email contains a certain one
     *
     * @param        $needle
     * @param string $description
     */
    public function assertEmailCcContain($needle, $email, $description = '')
    {
        $needle = '<' . $needle . '>';
        $this->assertContains($needle, $email->recipients, $description);
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
    }

    /**
     * Assert that the Bcc exists on the First Email
     * Mailcatcher doesn't add a seperate bcc field, it creates a new email
     * with the bcc address as the recipient.
     *
     * @param        $needle
     * @param string $description
     */
    public function assertEmailFirstBccContain($needle, $description = '')
    {
        return $this->fetchEmailWithBcc($needle, $this->getEmailMessages(), $description);
    }


    /**
     * Assert that the Bcc list of the Last Email contains a certain one
     *
     * @param        $needle
     * @param string $description
     */
    public function assertEmailLastBccContain($needle, $description = '')
    {
        return $this->fetchEmailWithBcc($needle, array_reverse($this->getEmailMessages()), $description);
    }

    /**
     * Assert that the Bcc list of the Nth Email contains a certain one
     *
     * @param        $needle
     * @param        $nth
     * @param string $description
     */
    public function assertEmailNthtBccContain($needle, $nth, $description = '')
    {
        return $this->fetchEmailWithBcc($needle, array_slice($this->getEmailMessages(), $nth - 1), $description);
    }

    /**
     * Assert that the Bcc list of Email contains a certain one
     *
     * @param        $needle
     * @param string $description
     */
    public function assertEmailBccContain($needle, $email, $description = '')
    {
        $this->assertContains($needle, $email->recipients, $description);
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
    }

    /**
     * Helper in order to hack the mailcatcher issue with Bcc field
     * @param $needle
     * @param $description
     * @param $messages
     */
    private function fetchEmailWithBcc($needle, $messages, $description)
    {
        $needle = '<' . $needle . '>';

        if (empty($messages)) {
            $this->fail("No messages received");
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
        }
        foreach ($messages as $message) {
            if (in_array($needle, $message->recipients)) {
                return $this->assertEmailBccContain($needle, $message, $description);
            }
        }

        $this->fail("No bcc found");
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
    }

    /**
     * Get the first message
     */
    private function getEmailFirstMessage()
    {
        $messages = $this->getEmailMessages();
        if (empty($messages)) {
            $this->fail("No messages received");
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
        }

        return array_shift($messages);
    }

    /**
     * Get the last message
     */
    private function getEmailLastMessage()
    {
        $messages = $this->getEmailMessages();
        if (empty($messages)) {
            $this->fail("No messages received");
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
        }

        return end($messages);
    }

    /**
     * Get a certain message
     */
    private function getEmailMessage($nth)
    {
        $messages = $this->getEmailMessages();
        if (empty($messages)) {
            $this->fail("No messages received");
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
        }

        return array_values($messages)[$nth - 1];
    }


    /**
     * Get all messages
     */
    private function getEmailMessages()
    {
        $jsonResponse = $this->mailcatcher->get('/messages');
        return json_decode($jsonResponse->getBody());
    }
}


1			<?php
2
3			namespace Drakakisgeo\Mailtester;
4
5			use GuzzleHttp\Client;
6
7			trait InteractsWithMailCatcher
8			{
9			use InteractsWithSwiftEmailer;
10
11			/**
12			* Init setup
13			*/
14			public function setUp()
15			{
16			parent::setUp();
17			$this->initCatcher();
18			}
19
20			/**
21			* Init client and clean the messages
22			*/
23			public function initCatcher()
24			{
25			$this->mailcatcher = new Client(['base_uri' => config('mailtester.url')]);
			0 ignored issues – show Bug introduced 2017-02-21 15:19 UTC by Report Bug Copy Issue Report The property `mailcatcher` 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...
26			$this->cleanEmailMessages();
27			}
28
29			/**
30			* Clear the list from all emails
31			*/
32			public function cleanEmailMessages()
33			{
34			$this->mailcatcher->delete('/messages');
35			}
36
37			/**
38			* Assert one email was send so list is not empty
39			*/

drakakisgeo / mailtester

GitHub Access Token became invalid

Push — master ( a9ac44...3461ec )

InteractsWithMailCatcher::cleanEmailMessages() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like