MustVerifyNewEmail::createPendingUserEmailModel() - Code Metrics - Inspection of "Refactor + publish migration only once" - protonemedia/laravel-verify-new-email - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 31c604...718d40 )

by Pascal

created 2020-01-05 20:51 UTC

MustVerifyNewEmail::createPendingUserEmailModel() A

↳ Parent: MustVerifyNewEmail

Complexity

Conditions	1
Paths	1

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	9
rs	9.9666
c	0
b	0
f	0
cc	1
nc	1
nop	1

<?php

namespace ProtoneMedia\LaravelVerifyNewEmail;

use Illuminate\Support\Facades\Mail;
use Illuminate\Support\Facades\Password;
use ProtoneMedia\LaravelVerifyNewEmail\Mail\VerifyNewEmail;

trait MustVerifyNewEmail
{
    /**
     * Deletes all previous attempts for this user, creates a new model/token
     * to verify the given email address and send the verification URL
     * to the new email address.
     *
     * @param string $email
     * @return \ProtoneMedia\LaravelVerifyNewEmail\PendingUserEmail|null
     */
    public function newEmail(string $email):?PendingUserEmail
    {
        $this->clearPendingEmail();

        if ($this->getEmailForVerification() === $email && $this->hasVerifiedEmail()) {
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
            return null;
        }

        return $this->createPendingUserEmailModel($email)->tap(function (PendingUserEmail $model) {
            $this->sendPendingEmailVerificationMail($model);
        });
    }

    /**
     * Createsa new PendingUserModel model for the given email.
     *
     * @param string $email
     * @return \ProtoneMedia\LaravelVerifyNewEmail\PendingUserEmail
     */
    public function createPendingUserEmailModel(string $email): PendingUserEmail
    {
        return PendingUserEmail::create([
            'user_type' => get_class($this),
            'user_id'   => $this->getKey(),
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
            'email'     => $email,
            'token'     => Password::broker()->getRepository()->createNewToken(),
        ]);
    }

    /**
     * Returns the pending email address.
     *
     * @return string|null
     */
    public function getPendingEmail():?string
    {
        return PendingUserEmail::forUser($this)->value('email');
    }

    /**
     * Deletes the pending email address models for this user.
     *
     * @return void
     */
    public function clearPendingEmail()
    {
        PendingUserEmail::forUser($this)->get()->each->delete();
    }

    /**
     * Sends the VerifyNewEmail Mailable to the new email address.
     *
     * @param \ProtoneMedia\LaravelVerifyNewEmail\PendingUserEmail $pendingUserEmail
     * @return mixed
     */
    public function sendPendingEmailVerificationMail(PendingUserEmail $pendingUserEmail)
    {
        $mailableClass = config('verify-new-email.mailable_for_first_verification');

        if ($pendingUserEmail->User->hasVerifiedEmail()) {
            $mailableClass = config('verify-new-email.mailable_for_new_email');
        }

        $mailable = new $mailableClass($pendingUserEmail);

        return Mail::to($pendingUserEmail->email)->send($mailable);
    }

    /**
     * Grabs the pending user email address, generates a new token and sends the Mailable.
     *
     * @return \ProtoneMedia\LaravelVerifyNewEmail\PendingUserEmail|null
     */
    public function resendPendingEmailVerificationMail():?PendingUserEmail
    {
        $pendingUserEmail = PendingUserEmail::forUser($this)->firstOrFail();

        return $this->newEmail($pendingUserEmail->email);
    }
}


1			<?php
2
3			namespace ProtoneMedia\LaravelVerifyNewEmail;
4
5			use Illuminate\Support\Facades\Mail;
6			use Illuminate\Support\Facades\Password;
7			use ProtoneMedia\LaravelVerifyNewEmail\Mail\VerifyNewEmail;
8
9			trait MustVerifyNewEmail
10			{
11			/**
12			* Deletes all previous attempts for this user, creates a new model/token
13			* to verify the given email address and send the verification URL
14			* to the new email address.
15			*
16			* @param string $email
17			* @return \ProtoneMedia\LaravelVerifyNewEmail\PendingUserEmail\|null
18			*/
19			public function newEmail(string $email):?PendingUserEmail
20			{
21			$this->clearPendingEmail();
22
23			if ($this->getEmailForVerification() === $email && $this->hasVerifiedEmail()) {
			0 ignored issues – show Bug introduced 2019-12-30 07:42 UTC by Report Bug Copy Issue Report It seems like `getEmailForVerification()` 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... Bug introduced 2019-12-30 07:42 UTC by Report Bug Copy Issue Report It seems like `hasVerifiedEmail()` 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...
24			return null;
25			}
26
27			return $this->createPendingUserEmailModel($email)->tap(function (PendingUserEmail $model) {
28			$this->sendPendingEmailVerificationMail($model);
29			});
30			}
31
32			/**
33			* Createsa new PendingUserModel model for the given email.
34			*
35			* @param string $email
36			* @return \ProtoneMedia\LaravelVerifyNewEmail\PendingUserEmail
37			*/
38			public function createPendingUserEmailModel(string $email): PendingUserEmail
39			{
40			return PendingUserEmail::create([
41			'user_type' => get_class($this),
42			'user_id' => $this->getKey(),
			0 ignored issues – show Bug introduced 2019-12-29 12:45 UTC by Report Bug Copy Issue Report It seems like `getKey()` 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...
43			'email' => $email,
44			'token' => Password::broker()->getRepository()->createNewToken(),
45			]);
46			}
47
48			/**
49			* Returns the pending email address.
50			*
51			* @return string\|null
52			*/
53			public function getPendingEmail():?string
54			{
55			return PendingUserEmail::forUser($this)->value('email');
56			}
57
58			/**
59			* Deletes the pending email address models for this user.
60			*
61			* @return void
62			*/
63			public function clearPendingEmail()
64			{
65			PendingUserEmail::forUser($this)->get()->each->delete();
66			}
67
68			/**
69			* Sends the VerifyNewEmail Mailable to the new email address.
70			*
71			* @param \ProtoneMedia\LaravelVerifyNewEmail\PendingUserEmail $pendingUserEmail
72			* @return mixed
73			*/
74			public function sendPendingEmailVerificationMail(PendingUserEmail $pendingUserEmail)
75			{
76			$mailableClass = config('verify-new-email.mailable_for_first_verification');
77
78			if ($pendingUserEmail->User->hasVerifiedEmail()) {
79			$mailableClass = config('verify-new-email.mailable_for_new_email');
80			}
81
82			$mailable = new $mailableClass($pendingUserEmail);
83
84			return Mail::to($pendingUserEmail->email)->send($mailable);
85			}
86
87			/**
88			* Grabs the pending user email address, generates a new token and sends the Mailable.
89			*
90			* @return \ProtoneMedia\LaravelVerifyNewEmail\PendingUserEmail\|null
91			*/
92			public function resendPendingEmailVerificationMail():?PendingUserEmail
93			{
94			$pendingUserEmail = PendingUserEmail::forUser($this)->firstOrFail();
95
96			return $this->newEmail($pendingUserEmail->email);
97			}
98			}
99

protonemedia / laravel-verify-new-email

GitHub Access Token became invalid

Push — master ( 31c604...718d40 )

MustVerifyNewEmail::createPendingUserEmailModel() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like