VoteBuilder::voteUp() - Code Metrics - Inspection of "test get voters" - yoeunes/voteable - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( 4708a1...2e0f39 )

by Younes

created 2018-02-02 21:39 UTC

VoteBuilder::voteUp() A

↳ Parent: VoteBuilder

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 Yoeunes\Voteable;

use Yoeunes\Voteable\Models\Vote;
use Yoeunes\Voteable\Traits\Voteable;
use Illuminate\Database\Eloquent\Model;
use Yoeunes\Voteable\Exceptions\EmptyUser;
use Yoeunes\Voteable\Exceptions\UserDoestNotHaveID;
use Illuminate\Database\Eloquent\Relations\Relation;
use Yoeunes\Voteable\Exceptions\VoteableModelNotFound;
use Yoeunes\Voteable\Exceptions\ModelDoesNotUseVoteableTrait;

class VoteBuilder
{
    protected $user;

    protected $voteable;

    protected $uniqueVoteForUsers = true;

    public function __construct()
    {
        if (config('voteable.auth_user')) {
            $this->user = auth()->id();
class A
{
    public function foo() { }
}

class B extends A
{
    public function bar() { }
}

/**
 * @param A|B $x
 */
function someFunction($x)
{
    $x->foo(); // This call is fine as the method exists in A and B.
    $x->bar(); // This method only exists in B and might cause an error.
}
        }

        if (config('voteable.user_vote_once')) {
            $this->uniqueVoteForUsers = true;
        }
    }

    /**
     * @param Model|int $user
     *
     * @return VoteBuilder
     *
     * @throws \Throwable
     */
    public function user($user)
    {
        throw_if($user instanceof Model && empty($user->id), UserDoestNotHaveID::class, 'User object does not have ID');

        $this->user = $user instanceof Model ? $user->id : $user;

        return $this;
    }

    /**
     * @param Model $voteable
     *
     * @return VoteBuilder
     *
     * @throws \Throwable
     */
    public function voteable(Model $voteable)
    {
        throw_unless(in_array(Voteable::class, class_uses_recursive($voteable)), ModelDoesNotUseVoteableTrait::class, get_class($voteable).' does not use the Voteable Trait');

        $this->voteable = $voteable;

        return $this;
    }

    /**
     * @param bool $unique
     *
     * @return VoteBuilder
     */
    public function uniqueVoteForUsers(bool $unique)
    {
        $this->uniqueVoteForUsers = $unique;

        return $this;
    }

    /**
     * @param int $amount
     *
     * @return Vote
     *
     * @throws \Throwable
     */
    public function amount(int $amount)
    {
        throw_if(empty($this->user), EmptyUser::class, 'Empty user');

        throw_if(empty($this->voteable->id), VoteableModelNotFound::class, 'Voteable model not found');

        $data = [
            'user_id'       => $this->user,
            'voteable_id'   => $this->voteable->id,
            'voteable_type' => Relation::getMorphedModel(get_class($this->voteable)) ?? get_class($this->voteable),
        ];

        $vote = $this->uniqueVoteForUsers ? Vote::firstOrNew($data) : (new Vote())->fill($data);

        $vote->amount = $amount;

        $vote->save();

        return $vote;
    }

    /**
     * @return Vote
     *
     * @throws \Throwable
     */
    public function voteUp()
    {
        return $this->amount(config('voteable.amount.up'));
    }

    /**
     * @return Vote
     *
     * @throws \Throwable
     */
    public function voteDown()
    {
        return $this->amount(config('voteable.amount.down'));
    }
}


1			<?php
2
3			namespace Yoeunes\Voteable;
4
5			use Yoeunes\Voteable\Models\Vote;
6			use Yoeunes\Voteable\Traits\Voteable;
7			use Illuminate\Database\Eloquent\Model;
8			use Yoeunes\Voteable\Exceptions\EmptyUser;
9			use Yoeunes\Voteable\Exceptions\UserDoestNotHaveID;
10			use Illuminate\Database\Eloquent\Relations\Relation;
11			use Yoeunes\Voteable\Exceptions\VoteableModelNotFound;
12			use Yoeunes\Voteable\Exceptions\ModelDoesNotUseVoteableTrait;
13
14			class VoteBuilder
15			{
16			protected $user;
17
18			protected $voteable;
19
20			protected $uniqueVoteForUsers = true;
21
22			public function __construct()
23			{
24			if (config('voteable.auth_user')) {
25			$this->user = auth()->id();
			0 ignored issues – show Bug introduced 2018-02-02 20:03 UTC by Report Bug Copy Issue Report The method `id` does only exist in `Illuminate\Contracts\Auth\Guard`, but not in `Illuminate\Contracts\Auth\Factory`. It seems like the method you are trying to call exists only in some of the possible types. Let’s take a look at an example: class A { public function foo() { } } class B extends A { public function bar() { } } /** * @param A\|B $x / function someFunction($x) { $x->foo(); // This call is fine as the method exists in A and B. $x->bar(); // This method only exists in B and might cause an error. } Available Fixes Add an additional type-check: /* * @param A\|B $x / function someFunction($x) { $x->foo(); if ($x instanceof B) { $x->bar(); } } Only allow a single type to be passed if the variable comes from a parameter: function someFunction(B $x) { /* ... */ } Loading history...
26			}
27
28			if (config('voteable.user_vote_once')) {
29			$this->uniqueVoteForUsers = true;
30			}
31			}
32
33			/**
34			* @param Model\|int $user
35			*
36			* @return VoteBuilder
37			*
38			* @throws \Throwable
39			*/
40			public function user($user)
41			{
42			throw_if($user instanceof Model && empty($user->id), UserDoestNotHaveID::class, 'User object does not have ID');
43
44			$this->user = $user instanceof Model ? $user->id : $user;
45
46			return $this;
47			}
48
49			/**
50			* @param Model $voteable
51			*
52			* @return VoteBuilder
53			*
54			* @throws \Throwable
55			*/
56			public function voteable(Model $voteable)
57			{
58			throw_unless(in_array(Voteable::class, class_uses_recursive($voteable)), ModelDoesNotUseVoteableTrait::class, get_class($voteable).' does not use the Voteable Trait');
59
60			$this->voteable = $voteable;
61
62			return $this;
63			}
64
65			/**
66			* @param bool $unique
67			*
68			* @return VoteBuilder
69			*/
70			public function uniqueVoteForUsers(bool $unique)
71			{
72			$this->uniqueVoteForUsers = $unique;
73
74			return $this;
75			}
76
77			/**
78			* @param int $amount
79			*
80			* @return Vote
81			*
82			* @throws \Throwable
83			*/
84			public function amount(int $amount)
85			{
86			throw_if(empty($this->user), EmptyUser::class, 'Empty user');
87
88			throw_if(empty($this->voteable->id), VoteableModelNotFound::class, 'Voteable model not found');
89
90			$data = [
91			'user_id' => $this->user,
92			'voteable_id' => $this->voteable->id,
93			'voteable_type' => Relation::getMorphedModel(get_class($this->voteable)) ?? get_class($this->voteable),
94			];
95
96			$vote = $this->uniqueVoteForUsers ? Vote::firstOrNew($data) : (new Vote())->fill($data);
97
98			$vote->amount = $amount;
99
100			$vote->save();
101
102			return $vote;
103			}
104
105			/**
106			* @return Vote
107			*
108			* @throws \Throwable
109			*/
110			public function voteUp()
111			{
112			return $this->amount(config('voteable.amount.up'));
113			}
114
115			/**
116			* @return Vote
117			*
118			* @throws \Throwable
119			*/
120			public function voteDown()
121			{
122			return $this->amount(config('voteable.amount.down'));
123			}
124			}
125

yoeunes / voteable

Push — master ( 4708a1...2e0f39 )

VoteBuilder::voteUp() A

Complexity

Size

Duplication

Importance

Available Fixes

Duplication Side-by-Side

Filter issues like