MessageResolver::addPart() - Code Metrics - johanderuijter/mailer - Measure and Improve Code Quality continuously with Scrutinizer

MessageResolver::addPart() A
last analyzed 2017-04-05 19:48 UTC

↳ Parent: MessageResolver

Complexity

Conditions	1
Paths	1

Size

Total Lines	6
Code Lines	4

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	5
CRAP Score	1

Importance

Changes

Metric	Value
dl	0
loc	6
c	0
b	0
f	0
ccs	5
cts	5
cp	1
rs	9.4285
cc	1
eloc	4
nc	1
nop	2
crap	1

<?php declare(strict_types = 1);

namespace JDR\Mailer\Part;

use JDR\Mailer\Email\Email;
use JDR\Mailer\Email\Message as EmailMessage;

class MessageResolver implements EmailPartResolver
{
    /**
     * {@inheritdoc}
     */
    public function addPart(Email $email, EmailPart $part)
    {
        $body = $this->resolveBody($part);

        $contentType = $part->getContentType();
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.
    }
}
        $email->addMessage(new EmailMessage($contentType, $body));
    }

    /**
     * Resolve the body of the message.
     *
     * @return string
     */
    private function resolveBody(Message $part)
    {
        $body = $part->getBody();
        foreach ($part->getParameters() as $search => $replace) {
            $body = str_replace($search, $replace, $body);
        }

        return $body;
    }
}


1		<?php declare(strict_types = 1);
2
3		namespace JDR\Mailer\Part;
4
5		use JDR\Mailer\Email\Email;
6		use JDR\Mailer\Email\Message as EmailMessage;
7
8		class MessageResolver implements EmailPartResolver
9		{
10		/**
11		* {@inheritdoc}
12		*/
13	3	public function addPart(Email $email, EmailPart $part)
14		{
15	3	$body = $this->resolveBody($part);
		0 ignored issues – show Compatibility introduced 2016-02-15 22:10 UTC by Report Bug Copy Issue Report `$part` of type `object<JDR\Mailer\Part\EmailPart>` is not a sub-type of `object<JDR\Mailer\Part\Message>`. It seems like you assume a concrete implementation of the interface `JDR\Mailer\Part\EmailPart` to be always present. This check looks for parameters that are defined as one type in their type hint or doc comment but seem to be used as a narrower type, i.e an implementation of an interface or a subclass. Consider changing the type of the parameter or doing an instanceof check before assuming your parameter is of the expected type. Loading history...
16	3	$contentType = $part->getContentType();
		0 ignored issues – show Bug introduced 2016-02-15 22:10 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `JDR\Mailer\Part\EmailPart` as the method `getContentType()` does only exist in the following implementations of said interface: `JDR\Mailer\Part\Message`, `JDR\Mailer\Part\Template`. 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...
17	3	$email->addMessage(new EmailMessage($contentType, $body));
18	3	}
19
20		/**
21		* Resolve the body of the message.
22		*
23		* @return string
24		*/
25	3	private function resolveBody(Message $part)
26		{
27	3	$body = $part->getBody();
28	3	foreach ($part->getParameters() as $search => $replace) {
29	2	$body = str_replace($search, $replace, $body);
30		}
31
32	3	return $body;
33		}
34		}
35

johanderuijter / mailer

MessageResolver::addPart() A last analyzed 2017-04-05 19:48 UTC

Complexity

Size

Duplication

Code Coverage

Importance

Available Fixes

Duplication Side-by-Side

Filter issues like

MessageResolver::addPart() A
last analyzed 2017-04-05 19:48 UTC