DashboardController - Code Metrics - Inspection of "Merge pull request #188 from murrant/api-touchup" - murrant/librenmsv2 - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 7d9761...77615c )

by Tony

created 2016-11-23 19:44 UTC

DashboardController A

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	149
Duplicated Lines	4.7 %

Coupling/Cohesion

Components	1
Dependencies	8

Importance

Changes

Metric	Value
dl	7
loc	149
rs	10
c	0
b	0
f	0
wmc	18
lcom	1
cbo	8

9 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	3	1
A	create()	0	4	1
A	index()	0	5	1
B	store()	0	31	5
A	show()	0	7	1
A	edit()	0	4	1
A	destroy()	7	12	3
A	clear()	0	8	2
A	update()	0	20	3

How to fix Duplicated Code

<?php

namespace App\Api\Controllers;

use App\Models\Dashboard;
use App\Models\UsersWidgets;
use Dingo\Api\Routing\Helpers;
use Illuminate\Http\Request;
use Validator;

class DashboardController extends Controller
{

    use Helpers;

    public function __construct()
    {
    }

    /**
     * Display a listing of all authorized devices
     *
     * @return \Illuminate\Http\Response
     */
    public function index(Request $request)
    {
        $dashboards = Dashboard::allAvailable($request->user())->get();
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.
}
        return $dashboards;
    }

    /**
     * Show the form for creating a new resource.
     *
     * @return \Illuminate\Http\Response|null
     */
    public function create(Request $request)
    {
        //
    }

    /**
     * Store a newly created resource in storage.
     *
     * @param  \Illuminate\Http\Request  $request
     * @return \Illuminate\Http\Response
     */
    public function store(Request $request)
    {
        $validation = Validator::make($request->all(), [
            'name' => 'required|max:255',
            'access' => 'required',
        ]);
        if ($validation->passes()) {
            $dashboard = new Dashboard;
            $dashboard->dashboard_name = $request->name;
            $dashboard->access         = $request->access;
            if ($request->user()->dashboards()->save($dashboard)) {
                if (is_numeric($request->copy_from)) {
                    $duplicate_widgets = Dashboard::find($request->copy_from)->widgets()->get();
                    foreach ($duplicate_widgets as $tmp_widget) {
                        /** @var UsersWidgets $tmp_widget */
                        $new_widget               = $tmp_widget->replicate();
                        $new_widget->user_id      = $request->user()->user_id;
                        $new_widget->dashboard_id = $dashboard->dashboard_id;
                        unset($new_widget->user_widget_id);
                        $new_widget->save();
                    }
                }
                return $this->response->array(array('statusText' => 'OK', 'dashboard_id' => $dashboard->dashboard_id));
            } else {
                return $this->response->errorInternal();
            }
        } else {
            $errors = $validation->errors();
            return response()->json($errors, 422);
class Author {
    private $name;

    public function __construct($name) {
        $this->name = $name;
    }

    public function getName() {
        return $this->name;
    }
}

abstract class Post {
    public function getAuthor() {
        return 'Johannes';
    }
}

class BlogPost extends Post {
    public function getAuthor() {
        return new Author('Johannes');
    }
}

class ForumPost extends Post { /* ... */ }

function my_function(Post $post) {
    echo strtoupper($post->getAuthor());
}
        }
    }

    /**
     * Display the specified resource.
     *
     * @param  int  $id
     * @return \Illuminate\Http\Response
     */
    public function show(Request $request, $id)
    {
        $dashboard = Dashboard::find($id);
        $widgets   = $dashboard->widgets()->get();

        return array('dashboard' => $dashboard, 'widgets' => $widgets);
    }

    /**
     * Show the form for editing the specified resource.
     *
     * @param  int  $id
     * @return \Illuminate\Http\Response
     */
    public function edit($id)

    {
        //
    }

    /**
     * Update the specified resource in storage.
     *
     * @param  \Illuminate\Http\Request  $request
     * @param  int  $id
     * @return \Illuminate\Http\Response
     */
    public function update(Request $request, $id)
    {
        $validation = Validator::make($request->all(), [
            'name' => 'required|max:255',
            'access' => 'required',
        ]);
        if ($validation->passes()) {
            $dashboard = Dashboard::find($id);
            $dashboard->dashboard_name = $request->name;
            $dashboard->access         = $request->access;
            if ($dashboard->save()) {
                return $this->response->array(array('statusText' => 'OK'));
            } else {
                return $this->response->errorInternal();
            }
        } else {
            $errors = $validation->errors();
            return response()->json($errors, 422);
class Author {
    private $name;

    public function __construct($name) {
        $this->name = $name;
    }

    public function getName() {
        return $this->name;
    }
}

abstract class Post {
    public function getAuthor() {
        return 'Johannes';
    }
}

class BlogPost extends Post {
    public function getAuthor() {
        return new Author('Johannes');
    }
}

class ForumPost extends Post { /* ... */ }

function my_function(Post $post) {
    echo strtoupper($post->getAuthor());
}
        }
    }

    /**
     * Remove the specified resource from storage.
     *
     * @param  int  $id
     * @return \Illuminate\Http\Response
     */
    public function destroy(Request $request, $id)
    {
        if (Dashboard::where('user_id', $request->user()->user_id)->where('dashboard_id', $id)->delete()) {
            if (UsersWidgets::where('dashboard_id', $id)->delete() >= 0) {

                return $this->response->array(array('statusText' => 'OK'));
            } else {
                return $this->response->errorInternal();
            }
        } else {
            return $this->response->errorInternal();
        }
    }

    public function clear($id)
    {
        if (Dashboard::find($id)->widgets()->delete() >= 0) {
            return $this->response->array(array('statusText' => 'OK'));
        } else {
            return $this->response->errorInternal();
        }
    }
}


1		<?php
2
3		namespace App\Api\Controllers;
4
5		use App\Models\Dashboard;
6		use App\Models\UsersWidgets;
7		use Dingo\Api\Routing\Helpers;
8		use Illuminate\Http\Request;
9		use Validator;
10
11		class DashboardController extends Controller
12		{
13
14		use Helpers;
15
16		public function __construct()
17		{
18		}
19
20		/**
21		* Display a listing of all authorized devices
22		*
23		* @return \Illuminate\Http\Response
24		*/
25		public function index(Request $request)
26		{
27		$dashboards = Dashboard::allAvailable($request->user())->get();
		0 ignored issues – show Bug introduced 2016-04-16 03:44 UTC by Report Bug Copy Issue Report The method `get` does only exist in `Illuminate\Database\Query\Builder`, but not in `App\Models\Dashboard`. 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...
28		return $dashboards;
29		}
30
31		/**
32		* Show the form for creating a new resource.
33		*
34		* @return \Illuminate\Http\Response\|null
35		*/
36		public function create(Request $request)
37		{
38		//
39		}
40
41		/**
42		* Store a newly created resource in storage.
43		*
44		* @param \Illuminate\Http\Request $request
45		* @return \Illuminate\Http\Response
46		*/
47		public function store(Request $request)
48		{
49		$validation = Validator::make($request->all(), [
50		'name' => 'required\|max:255',
51		'access' => 'required',
52		]);
53		if ($validation->passes()) {
54		$dashboard = new Dashboard;
55		$dashboard->dashboard_name = $request->name;
56		$dashboard->access = $request->access;
57		if ($request->user()->dashboards()->save($dashboard)) {
58		if (is_numeric($request->copy_from)) {
59		$duplicate_widgets = Dashboard::find($request->copy_from)->widgets()->get();
60		foreach ($duplicate_widgets as $tmp_widget) {
61		/** @var UsersWidgets $tmp_widget */
62		$new_widget = $tmp_widget->replicate();
63		$new_widget->user_id = $request->user()->user_id;
64		$new_widget->dashboard_id = $dashboard->dashboard_id;
65		unset($new_widget->user_widget_id);
66		$new_widget->save();
67		}
68		}
69		return $this->response->array(array('statusText' => 'OK', 'dashboard_id' => $dashboard->dashboard_id));
70		} else {
71		return $this->response->errorInternal();
72		}
73		} else {
74		$errors = $validation->errors();
75		return response()->json($errors, 422);
		0 ignored issues – show Bug Best Practice introduced 2016-04-16 03:29 UTC by Report Bug Copy Issue Report The return type of `return response()->json($errors, 422);` (`Illuminate\Http\JsonResponse`) is incompatible with the return type documented by `App\Api\Controllers\DashboardController::store` of type `Illuminate\Http\Response`. If you return a value from a function or method, it should be a sub-type of the type that is given by the parent type f.e. an interface, or abstract method. This is more formally defined by the Lizkov substitution principle, and guarantees that classes that depend on the parent type can use any instance of a child type interchangably. This principle also belongs to the SOLID principles for object oriented design. Let’s take a look at an example: class Author { private $name; public function __construct($name) { $this->name = $name; } public function getName() { return $this->name; } } abstract class Post { public function getAuthor() { return 'Johannes'; } } class BlogPost extends Post { public function getAuthor() { return new Author('Johannes'); } } class ForumPost extends Post { /* ... */ } function my_function(Post $post) { echo strtoupper($post->getAuthor()); } Our function `my_function` expects a `Post` object, and outputs the author of the post. The base class `Post` returns a simple string and outputting a simple string will work just fine. However, the child class `BlogPost` which is a sub-type of `Post` instead decided to return an `object`, and is therefore violating the SOLID principles. If a `BlogPost` were passed to `my_function`, PHP would not complain, but ultimately fail when executing the `strtoupper` call in its body. Loading history...
76		}
77		}
78
79		/**
80		* Display the specified resource.
81		*
82		* @param int $id
83		* @return \Illuminate\Http\Response
84		*/
85		public function show(Request $request, $id)
86		{
87		$dashboard = Dashboard::find($id);
88		$widgets = $dashboard->widgets()->get();
89
90		return array('dashboard' => $dashboard, 'widgets' => $widgets);
91		}
92
93		/**
94		* Show the form for editing the specified resource.
95		*
96		* @param int $id
97		* @return \Illuminate\Http\Response
98		*/
99		public function edit($id)
		0 ignored issues – show Unused Code introduced 2016-04-16 03:29 UTC by Report Bug Copy Issue Report The parameter `$id` is not used and could be removed. This check looks from parameters that have been defined for a function or method, but which are not used in the method body. Loading history...
100		{
101		//
102		}
103
104		/**
105		* Update the specified resource in storage.
106		*
107		* @param \Illuminate\Http\Request $request
108		* @param int $id
109		* @return \Illuminate\Http\Response
110		*/
111		public function update(Request $request, $id)
112		{
113		$validation = Validator::make($request->all(), [
114		'name' => 'required\|max:255',
115		'access' => 'required',
116		]);
117		if ($validation->passes()) {
118		$dashboard = Dashboard::find($id);
119		$dashboard->dashboard_name = $request->name;
120		$dashboard->access = $request->access;
121		if ($dashboard->save()) {
122		return $this->response->array(array('statusText' => 'OK'));
123		} else {
124		return $this->response->errorInternal();
125		}
126		} else {
127		$errors = $validation->errors();
128		return response()->json($errors, 422);
		0 ignored issues – show Bug Best Practice introduced 2016-04-16 03:29 UTC by Report Bug Copy Issue Report The return type of `return response()->json($errors, 422);` (`Illuminate\Http\JsonResponse`) is incompatible with the return type documented by `App\Api\Controllers\DashboardController::update` of type `Illuminate\Http\Response`. If you return a value from a function or method, it should be a sub-type of the type that is given by the parent type f.e. an interface, or abstract method. This is more formally defined by the Lizkov substitution principle, and guarantees that classes that depend on the parent type can use any instance of a child type interchangably. This principle also belongs to the SOLID principles for object oriented design. Let’s take a look at an example: class Author { private $name; public function __construct($name) { $this->name = $name; } public function getName() { return $this->name; } } abstract class Post { public function getAuthor() { return 'Johannes'; } } class BlogPost extends Post { public function getAuthor() { return new Author('Johannes'); } } class ForumPost extends Post { /* ... */ } function my_function(Post $post) { echo strtoupper($post->getAuthor()); } Our function `my_function` expects a `Post` object, and outputs the author of the post. The base class `Post` returns a simple string and outputting a simple string will work just fine. However, the child class `BlogPost` which is a sub-type of `Post` instead decided to return an `object`, and is therefore violating the SOLID principles. If a `BlogPost` were passed to `my_function`, PHP would not complain, but ultimately fail when executing the `strtoupper` call in its body. Loading history...
129		}
130		}
131
132		/**
133		* Remove the specified resource from storage.
134		*
135		* @param int $id
136		* @return \Illuminate\Http\Response
137		*/
138		public function destroy(Request $request, $id)
139		{
140		if (Dashboard::where('user_id', $request->user()->user_id)->where('dashboard_id', $id)->delete()) {
141	View Code Duplication	if (UsersWidgets::where('dashboard_id', $id)->delete() >= 0) {
		0 ignored issues – show Duplication introduced 2016-04-16 03:29 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...
142		return $this->response->array(array('statusText' => 'OK'));
143		} else {
144		return $this->response->errorInternal();
145		}
146		} else {
147		return $this->response->errorInternal();
148		}
149		}
150
151		public function clear($id)
152		{
153		if (Dashboard::find($id)->widgets()->delete() >= 0) {
154		return $this->response->array(array('statusText' => 'OK'));
155		} else {
156		return $this->response->errorInternal();
157		}
158		}
159		}
160

murrant / librenmsv2

Push — master ( 7d9761...77615c )

DashboardController A

Complexity

Size/Duplication

Coupling/Cohesion

Importance

9 Methods

How to fix Duplicated Code

Duplicated Code

Available Fixes

Duplication Side-by-Side

Filter issues like