DiscussConversationRepository::update() - Code Metrics - Inspection of "Discuss Forum" - XetaIO/Xetaravel - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#34)

by Fèvre

created 2017-07-03 11:05 UTC

DiscussConversationRepository::update() D

↳ Parent: DiscussConversationRepository

Complexity

Conditions	10
Paths	68

Size

Total Lines	34
Code Lines	18

Duplication

Lines	6
Ratio	17.65 %

Importance

Changes

Metric	Value
dl	6
loc	34
rs	4.8196
c	0
b	0
f	0
cc	10
eloc	18
nc	68
nop	2

How to fix Complexity

<?php
namespace Xetaravel\Models\Repositories;

use Illuminate\Support\Collection;
use Illuminate\Support\Facades\Auth;
use Xetaravel\Events\Discuss\CategoryWasChangedEvent;
use Xetaravel\Events\Discuss\ConversationWasLockedEvent;
use Xetaravel\Events\Discuss\ConversationWasPinnedEvent;
use Xetaravel\Events\Discuss\TitleWasChangedEvent;
use Xetaravel\Models\DiscussConversation;
use Xetaravel\Models\DiscussPost;
use Xetaravel\Models\DiscussUser;

class DiscussConversationRepository
{

    /**
     * Create the new conversation and save it.
     *
     * @param array $data The data used to create the conversation.
     *
     * @return \Xetaravel\Models\DiscussConversation
     */
    public static function create(array $data): DiscussConversation
    {
        $conversation = [
            'title' => $data['title'],
            'category_id' => $data['category_id']
        ];

        $user = Auth::user();

        if ($user->hasPermission('manage.discuss.conversations')) {
            $conversation += [
                'is_locked' => isset($data['is_locked']) ? true : false,
                'is_pinned' => isset($data['is_pinned']) ? true : false,
            ];
        }

        $conversation = DiscussConversation::create($conversation);

        $comment = DiscussPost::create([
            'conversation_id' => $conversation->id,
            'content' => $data['content']
        ]);

        $participant = DiscussUser::create([
$myVar = 'Value';
$higher = false;

if (rand(1, 6) > 3) {
    $higher = true;
} else {
    $higher = false;
}
            'conversation_id' => $conversation->id,
            'is_read' => 1
        ]);

        $conversation->first_post_id = $comment->id;
        $conversation->last_post_id = $comment->id;
        $conversation->save();

        return $conversation;
    }

    /**
     * Update the conversation data and save it.
     *
     * @param array $data The data used to update the conversation.
     * @param \Xetaravel\Models\DiscussConversation $conversation The conversation to update.
     *
     * @return \Xetaravel\Models\DiscussConversation
     */
    public static function update(array $data, DiscussConversation $conversation): DiscussConversation
    {
        if (Auth::user()->hasPermission('manage.discuss.conversations')) {
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.
    }
}
            $data['is_pinned'] = isset($data['is_pinned']) ? true : false;
            $data['is_locked'] = isset($data['is_locked']) ? true : false;

            if ($conversation->is_pinned != $data['is_pinned'] && $data['is_pinned'] == true) {

                event(new ConversationWasPinnedEvent($conversation, Auth::user()));

            }

            if ($conversation->is_locked != $data['is_locked'] && $data['is_locked'] == true) {

                event(new ConversationWasLockedEvent($conversation, Auth::user()));

            }

            $conversation->is_locked = $data['is_locked'];
            $conversation->is_pinned = $data['is_pinned'];
        }

        if ($conversation->title != $data['title']) {
            event(new TitleWasChangedEvent($conversation, $data['title'], $conversation->title));

            $conversation->title = $data['title'];
        }

        if ($conversation->category_id != $data['category_id']) {
            event(new CategoryWasChangedEvent($conversation, $data['category_id'], $conversation->category_id));

            $conversation->category_id = $data['category_id'];
        }

        $conversation->save();

        return $conversation;
    }
}


1		<?php
2		namespace Xetaravel\Models\Repositories;
3
4		use Illuminate\Support\Collection;
5		use Illuminate\Support\Facades\Auth;
6		use Xetaravel\Events\Discuss\CategoryWasChangedEvent;
7		use Xetaravel\Events\Discuss\ConversationWasLockedEvent;
8		use Xetaravel\Events\Discuss\ConversationWasPinnedEvent;
9		use Xetaravel\Events\Discuss\TitleWasChangedEvent;
10		use Xetaravel\Models\DiscussConversation;
11		use Xetaravel\Models\DiscussPost;
12		use Xetaravel\Models\DiscussUser;
13
14		class DiscussConversationRepository
15		{
16
17		/**
18		* Create the new conversation and save it.
19		*
20		* @param array $data The data used to create the conversation.
21		*
22		* @return \Xetaravel\Models\DiscussConversation
23		*/
24		public static function create(array $data): DiscussConversation
25		{
26		$conversation = [
27		'title' => $data['title'],
28		'category_id' => $data['category_id']
29		];
30
31		$user = Auth::user();
32
33		if ($user->hasPermission('manage.discuss.conversations')) {
34		$conversation += [
35		'is_locked' => isset($data['is_locked']) ? true : false,
36		'is_pinned' => isset($data['is_pinned']) ? true : false,
37		];
38		}
39
40		$conversation = DiscussConversation::create($conversation);
41
42		$comment = DiscussPost::create([
43		'conversation_id' => $conversation->id,
44		'content' => $data['content']
45		]);
46
47		$participant = DiscussUser::create([
		0 ignored issues – show Unused Code introduced 2017-06-14 23:44 UTC by Report Bug Copy Issue Report `$participant` 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...
48		'conversation_id' => $conversation->id,
49		'is_read' => 1
50		]);
51
52		$conversation->first_post_id = $comment->id;
53		$conversation->last_post_id = $comment->id;
54		$conversation->save();
55
56		return $conversation;
57		}
58
59		/**
60		* Update the conversation data and save it.
61		*
62		* @param array $data The data used to update the conversation.
63		* @param \Xetaravel\Models\DiscussConversation $conversation The conversation to update.
64		*
65		* @return \Xetaravel\Models\DiscussConversation
66		*/
67		public static function update(array $data, DiscussConversation $conversation): DiscussConversation
68		{
69		if (Auth::user()->hasPermission('manage.discuss.conversations')) {
		0 ignored issues – show Bug introduced 2017-06-14 23:44 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `Illuminate\Contracts\Auth\Authenticatable` as the method `hasPermission()` does only exist in the following implementations of said interface: `Xetaravel\Models\User`. 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...
70		$data['is_pinned'] = isset($data['is_pinned']) ? true : false;
71		$data['is_locked'] = isset($data['is_locked']) ? true : false;
72
73	View Code Duplication	if ($conversation->is_pinned != $data['is_pinned'] && $data['is_pinned'] == true) {
		0 ignored issues – show Coding Style Best Practice introduced 2017-06-14 23:44 UTC by Report Bug Copy Issue Report It seems like you are loosely comparing two booleans. Considering using the strict comparison `===` instead. When comparing two booleans, it is generally considered safer to use the strict comparison operator. Loading history... Duplication introduced 2017-06-14 23:44 UTC by Report Bug Copy Issue Report This code seems to be duplicated across 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...
74		event(new ConversationWasPinnedEvent($conversation, Auth::user()));
		0 ignored issues – show Unused Code introduced 2017-06-14 23:44 UTC by Report Bug Copy Issue Report The call to `ConversationWasPinnedEvent::__construct()` has too many arguments starting with `\Illuminate\Support\Facades\Auth::user()`. This check compares calls to functions or methods with their respective definitions. If the call has more arguments than are defined, it raises an issue. If a function is defined several times with a different number of parameters, the check may pick up the wrong definition and report false positives. One codebase where this has been known to happen is Wordpress. In this case you can add the `@ignore` PhpDoc annotation to the duplicate definition and it will be ignored. Loading history...
75		}
76
77	View Code Duplication	if ($conversation->is_locked != $data['is_locked'] && $data['is_locked'] == true) {
		0 ignored issues – show Coding Style Best Practice introduced 2017-06-14 23:44 UTC by Report Bug Copy Issue Report It seems like you are loosely comparing two booleans. Considering using the strict comparison `===` instead. When comparing two booleans, it is generally considered safer to use the strict comparison operator. Loading history... Duplication introduced 2017-06-14 23:44 UTC by Report Bug Copy Issue Report This code seems to be duplicated across 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...
78		event(new ConversationWasLockedEvent($conversation, Auth::user()));
		0 ignored issues – show Unused Code introduced 2017-06-14 23:44 UTC by Report Bug Copy Issue Report The call to `ConversationWasLockedEvent::__construct()` has too many arguments starting with `\Illuminate\Support\Facades\Auth::user()`. This check compares calls to functions or methods with their respective definitions. If the call has more arguments than are defined, it raises an issue. If a function is defined several times with a different number of parameters, the check may pick up the wrong definition and report false positives. One codebase where this has been known to happen is Wordpress. In this case you can add the `@ignore` PhpDoc annotation to the duplicate definition and it will be ignored. Loading history...
79		}
80
81		$conversation->is_locked = $data['is_locked'];
82		$conversation->is_pinned = $data['is_pinned'];
83		}
84
85		if ($conversation->title != $data['title']) {
86		event(new TitleWasChangedEvent($conversation, $data['title'], $conversation->title));
87
88		$conversation->title = $data['title'];
89		}
90
91		if ($conversation->category_id != $data['category_id']) {
92		event(new CategoryWasChangedEvent($conversation, $data['category_id'], $conversation->category_id));
93
94		$conversation->category_id = $data['category_id'];
95		}
96
97		$conversation->save();
98
99		return $conversation;
100		}
101		}
102

XetaIO / Xetaravel

Pull Request — master (#34)

DiscussConversationRepository::update() D

Complexity

Size

Duplication

Importance

How to fix Complexity

Long Method

Available Fixes

Duplication Side-by-Side

Filter issues like