AdministrationController::getIndex() - Code Metrics - Inspection of "Misc: update dependencies" - satrun77/tinyissue - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — develop ( f7252d...97603d )

by Mohamed

created 2015-12-25 19:38 UTC

AdministrationController::getIndex() A

↳ Parent: AdministrationController

Complexity

Conditions	1
Paths	1

Size

Total Lines	12
Code Lines	9

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	2

Importance

Changes	3
Bugs	0	Features	0

Metric	Value
c	3
b	0
f	0
dl	0
loc	12
ccs	0
cts	12
cp	0
rs	9.4286
cc	1
eloc	9
nc	1
nop	3
crap	2

<?php

/*
 * This file is part of the Tinyissue package.
 *
 * (c) Mohamed Alsharaf <[email protected]>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace Tinyissue\Http\Controllers;

use Tinyissue\Model\Project;
use Tinyissue\Model\Tag;
use Tinyissue\Model\User;

/**
 * AdministrationController is the controller class for managing request related the application system admin
 *
 * @author Mohamed Alsharaf <[email protected]>
 */
class AdministrationController extends Controller
{
    /**
     * Show general application stats
     *
     * @param Tag     $tag
     * @param Project $project
     * @param User    $user
     *
     * @return \Illuminate\View\View
     */
    public function getIndex(Tag $tag, Project $project, User $user)
    {
        return view('administration.index', [

            'users'             => $user->countUsers(),
            'active_projects'   => $project->countOpenProjects(),
            'archived_projects' => $project->countArchivedProjects(),
            'open_issues'       => $project->countOpenIssues(),
            'closed_issues'     => $project->countClosedIssues(),
            'projects'          => $this->auth->user()->projects()->get(),
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.
    }
}
            'tags'              => $tag->count(),
        ]);
    }
}


1			<?php
2
3			/*
4			* This file is part of the Tinyissue package.
5			*
6			* (c) Mohamed Alsharaf <[email protected]>
7			*
8			* For the full copyright and license information, please view the LICENSE
9			* file that was distributed with this source code.
10			*/
11
12			namespace Tinyissue\Http\Controllers;
13
14			use Tinyissue\Model\Project;
15			use Tinyissue\Model\Tag;
16			use Tinyissue\Model\User;
17
18			/**
19			* AdministrationController is the controller class for managing request related the application system admin
20			*
21			* @author Mohamed Alsharaf <[email protected]>
22			*/
23			class AdministrationController extends Controller
24			{
25			/**
26			* Show general application stats
27			*
28			* @param Tag $tag
29			* @param Project $project
30			* @param User $user
31			*
32			* @return \Illuminate\View\View
33			*/
34			public function getIndex(Tag $tag, Project $project, User $user)
35			{
36			return view('administration.index', [
			0 ignored issues – show Bug Compatibility introduced 2015-12-25 19:42 UTC by Report Bug Copy Issue Report The expression `view('administration.ind...gs' => $tag->count()));` of type `Illuminate\View\View\|Ill...\Contracts\View\Factory` adds the type `Illuminate\Contracts\View\Factory` to the return on line 36 which is incompatible with the return type documented by `Tinyissue\Http\Controlle...ionController::getIndex` of type `Illuminate\View\View`. Loading history...
37			'users' => $user->countUsers(),
38			'active_projects' => $project->countOpenProjects(),
39			'archived_projects' => $project->countArchivedProjects(),
40			'open_issues' => $project->countOpenIssues(),
41			'closed_issues' => $project->countClosedIssues(),
42			'projects' => $this->auth->user()->projects()->get(),
			0 ignored issues – show Bug introduced 2015-12-15 16:27 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 `projects()` does only exist in the following implementations of said interface: `Tinyissue\Model\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...
43			'tags' => $tag->count(),
44			]);
45			}
46			}
47

satrun77 / tinyissue

Push — develop ( f7252d...97603d )

AdministrationController::getIndex() A

Complexity

Size

Duplication

Code Coverage

Importance

Available Fixes

Duplication Side-by-Side

Filter issues like