DeviceController - Code Metrics - Inspection of "Refactor dashboard" - uidaho/smartsettia - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#96)

by Brandon

created 2017-10-30 18:49 UTC

DeviceController A

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	185
Duplicated Lines	16.76 %

Coupling/Cohesion

Components	0
Dependencies	7

Test Coverage

Coverage

Importance

Changes

Metric	Value
wmc	16
c	0
b	0
f	0
lcom	0
cbo	7
dl	31
loc	185
ccs	0
cts	66
cp	0
rs	10

8 Methods

Rating	Name	Duplication	Size	Complexity
A	restore()	9	9	1
A	__construct()	0	4	1
A	index()	0	5	1
A	create()	0	4	1
A	show()	0	5	1
A	edit()	0	20	1
B	update()	0	60	8
A	destroy()	22	22	2

How to fix Duplicated Code

<?php

namespace App\Http\Controllers;

use App\Http\Requests\EditDevice;
use Validator;
use Illuminate\Http\Request;
use App\DataTables\DevicesDataTable;
use Illuminate\Support\Facades\Route;
use App\Device;
use App\Site;
use App\Location;

class DeviceController extends Controller
{
    /**
     * Create a new controller instance.
     *
     */
    public function __construct()
    {
        $this->middleware('auth');
    }

    /**
     * Display index page and process dataTable ajax request.
     *
     * @param \App\DataTables\DevicesDataTable $dataTable
     * @return \Illuminate\Http\JsonResponse|\Illuminate\View\View
     */
    public function index(DevicesDataTable $dataTable)
    {
        $trashed = Device::onlyTrashed()->get();
        return $dataTable->render('device.index', compact('trashed'));
    }

    /**
     * Show create device page.
     *
     * @return \BladeView|bool|\Illuminate\Contracts\View\Factory|\Illuminate\View\View
     */
    public function create()
    {
        return view('device.index');
    }

    /**
     * Show the given device.
     *
     * @param  string  $id
     * @return \BladeView|bool|\Illuminate\Contracts\View\Factory|\Illuminate\View\View
     */
    public function show($id)
    {
        $device = Device::findOrFail($id);
        return view('device.show', [ 'device' => $device ]);
    }

    /**
     * View the edit device page
     *
     * @param  string  $id
     * @return \BladeView|bool|\Illuminate\Contracts\View\Factory|\Illuminate\View\View
     */
    public function edit($id)
    {
        //Get the device with the given id
        $device = Device::publicDashData()->findOrFail($id);
        //Get the devices location
        $location = $device->location()->select('id', 'name', 'site_id')->first();
    
        //Get the site id and location id if they exist and if not assign 0
        $site_id = $location->site_id ?? 0;
        $location_id = $location->id ?? 0;
    
        //Get all sites with the current site first
        $sites = Site::select('id', 'name')->orderByRaw("id = ? DESC", $site_id)
            ->orderBy('name', 'ASC')->get();
        //Get all locations for the selected site with the selected location first
        $locations = Location::select('id', 'name')->where('site_id', '=', $sites[0]->id ?? 0)
            ->orderByRaw("id = ? DESC", $location_id)->orderBy('name', 'ASC')->get();
        
        return view('device.edit', [ 'device' => $device, 'locations' => $locations, 'sites' => $sites ]);
    }

    /**
     * Update the given device.
     *
     * @param  EditDevice  $request
     * @param  string  $id
     * @return \Illuminate\Http\RedirectResponse
     */
    public function update(EditDevice $request, $id)
    {
        $device = Device::findOrFail($id);
        
        //Get the site id of the old or newly created site
        if (!empty($request->input('new_site_name')))
        {
            //Create a new site
            $site = Site::create(['name' => $request->input('new_site_name')]);
            $site_id = $site->id;
        }
        else
            $site_id = $request->input('site_id');
        
        //Get the location id of the old or newly created location
        if (!empty($request->input('new_location_name')))
        {
            //Create a new location
            $location = Location::create(['name' => $request->input('new_location_name'), 'site_id' => $site_id]);
            $location_id = $location->id;
        }
        else
            $location_id = $request->input('location_id');
        
        //Update the device
        $device->location_id = $location_id;
        $device->name = $request->input('name');
        $device->open_time = $request->input('open_time');
        $device->close_time = $request->input('close_time');
        $device->update_rate = $request->input('update_rate');
        $device->image_rate = $request->input('image_rate');
        $device->sensor_rate = $request->input('sensor_rate');
        //Check if the cover_command needs to be updated
        if ($request->input('command') != null)
        {
            //If device is currently opening, closing or in an error state don't update command
            if (!$device->isReadyForCommand())
                return response()->json("Device is currently in use.", 403);
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());
}
    
            $command = $request->input('command');
            
            //If command is to unlock the device then check if the device should be open or closed based on the schedule
            if ($request->command === 'unlock')
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
            {
                if ($device->isDuringScheduleOpen())
                    $command =  'open';
                else
                    $command =  'close';
            }
            $device->cover_command = $command;
        }
        
        $device->save();
    
        if (\Request::ajax())
            return response()->json(['success' => 'Device updated successfully']);
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());
}
        else
            return redirect()->route('device.show', $id)
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
                ->with('success', 'Device updated successfully');
    }

    /**
     * Deletes a device.
     *
     * @param  string  $id
     * @return \Illuminate\Http\RedirectResponse
     */
    public function destroy($id)
    {
        $device = Device::withTrashed()->findOrFail($id);

        if ($device->trashed())
        {
            //If the device was already deleted then permanently delete it
            $device->forceDelete($device->id);
        }
        else
        {
            //Remove the location from the device
            $device->location_id = null;
            $device->save();
            
            //Soft delete the device the first time
            $device->delete();
        }

        return redirect()->route('device.index')
            ->with('success','Device deleted successfully');
    }
    
    /**
     * Restores a device.
     *
     * @param  string  $id
     * @return \Illuminate\Http\RedirectResponse
     */
    public function restore($id)
    {
        $device = Device::onlyTrashed()->findOrFail($id);

        $device->restore();
        
        return redirect()->route('device.show', $device->id)
            ->with('success','Device restored successfully');
    }
}


1		<?php
2
3		namespace App\Http\Controllers;
4
5		use App\Http\Requests\EditDevice;
6		use Validator;
7		use Illuminate\Http\Request;
8		use App\DataTables\DevicesDataTable;
9		use Illuminate\Support\Facades\Route;
10		use App\Device;
11		use App\Site;
12		use App\Location;
13
14		class DeviceController extends Controller
15		{
16		/**
17		* Create a new controller instance.
18		*
19		*/
20		public function __construct()
21		{
22		$this->middleware('auth');
23		}
24
25		/**
26		* Display index page and process dataTable ajax request.
27		*
28		* @param \App\DataTables\DevicesDataTable $dataTable
29		* @return \Illuminate\Http\JsonResponse\|\Illuminate\View\View
30		*/
31		public function index(DevicesDataTable $dataTable)
32		{
33		$trashed = Device::onlyTrashed()->get();
34		return $dataTable->render('device.index', compact('trashed'));
35		}
36
37		/**
38		* Show create device page.
39		*
40		* @return \BladeView\|bool\|\Illuminate\Contracts\View\Factory\|\Illuminate\View\View
41		*/
42		public function create()
43		{
44		return view('device.index');
45		}
46
47		/**
48		* Show the given device.
49		*
50		* @param string $id
51		* @return \BladeView\|bool\|\Illuminate\Contracts\View\Factory\|\Illuminate\View\View
52		*/
53		public function show($id)
54		{
55		$device = Device::findOrFail($id);
56		return view('device.show', [ 'device' => $device ]);
57		}
58
59		/**
60		* View the edit device page
61		*
62		* @param string $id
63		* @return \BladeView\|bool\|\Illuminate\Contracts\View\Factory\|\Illuminate\View\View
64		*/
65		public function edit($id)
66		{
67		//Get the device with the given id
68		$device = Device::publicDashData()->findOrFail($id);
69		//Get the devices location
70		$location = $device->location()->select('id', 'name', 'site_id')->first();
71
72		//Get the site id and location id if they exist and if not assign 0
73		$site_id = $location->site_id ?? 0;
74		$location_id = $location->id ?? 0;
75
76		//Get all sites with the current site first
77		$sites = Site::select('id', 'name')->orderByRaw("id = ? DESC", $site_id)
78		->orderBy('name', 'ASC')->get();
79		//Get all locations for the selected site with the selected location first
80		$locations = Location::select('id', 'name')->where('site_id', '=', $sites[0]->id ?? 0)
81		->orderByRaw("id = ? DESC", $location_id)->orderBy('name', 'ASC')->get();
82
83		return view('device.edit', [ 'device' => $device, 'locations' => $locations, 'sites' => $sites ]);
84		}
85
86		/**
87		* Update the given device.
88		*
89		* @param EditDevice $request
90		* @param string $id
91		* @return \Illuminate\Http\RedirectResponse
92		*/
93		public function update(EditDevice $request, $id)
94		{
95		$device = Device::findOrFail($id);
96
97		//Get the site id of the old or newly created site
98		if (!empty($request->input('new_site_name')))
99		{
100		//Create a new site
101		$site = Site::create(['name' => $request->input('new_site_name')]);
102		$site_id = $site->id;
103		}
104		else
105		$site_id = $request->input('site_id');
106
107		//Get the location id of the old or newly created location
108		if (!empty($request->input('new_location_name')))
109		{
110		//Create a new location
111		$location = Location::create(['name' => $request->input('new_location_name'), 'site_id' => $site_id]);
112		$location_id = $location->id;
113		}
114		else
115		$location_id = $request->input('location_id');
116
117		//Update the device
118		$device->location_id = $location_id;
119		$device->name = $request->input('name');
120		$device->open_time = $request->input('open_time');
121		$device->close_time = $request->input('close_time');
122		$device->update_rate = $request->input('update_rate');
123		$device->image_rate = $request->input('image_rate');
124		$device->sensor_rate = $request->input('sensor_rate');
125		//Check if the cover_command needs to be updated
126		if ($request->input('command') != null)
127		{
128		//If device is currently opening, closing or in an error state don't update command
129		if (!$device->isReadyForCommand())
130		return response()->json("Device is currently in use.", 403);
		0 ignored issues – show Bug Best Practice introduced 2017-10-25 18:11 UTC by Report Bug Copy Issue Report The return type of `return response()->json(...rrently in use.', 403);` (`Illuminate\Http\JsonResponse`) is incompatible with the return type documented by `App\Http\Controllers\DeviceController::update` of type `Illuminate\Http\RedirectResponse`. 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...
131
132		$command = $request->input('command');
133
134		//If command is to unlock the device then check if the device should be open or closed based on the schedule
135		if ($request->command === 'unlock')
		0 ignored issues – show Documentation introduced 2017-10-25 18:11 UTC by Report Bug Copy Issue Report The property `command` does not exist on `object<App\Http\Requests\EditDevice>`. Since you implemented `__get`, maybe consider adding a @property annotation. Since your code implements the magic getter `_get`, this function will be called for any read access on an undefined variable. You can add the `@property` annotation to your class or interface to document the existence of this variable. <?php /** * @property int $x * @property int $y * @property string $text */ class MyLabel { private $properties; private $allowedProperties = array('x', 'y', 'text'); public function __get($name) { if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) { return $properties[$name]; } else { return null; } } public function __set($name, $value) { if (in_array($name, $this->allowedProperties)) { $properties[$name] = $value; } else { throw new \LogicException("Property $name is not defined."); } } } If the property has read access only, you can use the @property-read annotation instead. Of course, you may also just have mistyped another name, in which case you should fix the error. See also the PhpDoc documentation for @property. Loading history...
136		{
137		if ($device->isDuringScheduleOpen())
138		$command = 'open';
139		else
140		$command = 'close';
141		}
142		$device->cover_command = $command;
143		}
144
145		$device->save();
146
147		if (\Request::ajax())
148		return response()->json(['success' => 'Device updated successfully']);
		0 ignored issues – show Bug Best Practice introduced 2017-10-25 18:11 UTC by Report Bug Copy Issue Report The return type of `return response()->json(...pdated successfully'));` (`Illuminate\Http\JsonResponse`) is incompatible with the return type documented by `App\Http\Controllers\DeviceController::update` of type `Illuminate\Http\RedirectResponse`. 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...
149		else
150		return redirect()->route('device.show', $id)
		1 ignored issue – show Documentation introduced 2017-10-22 22:36 UTC by Report Bug Copy Issue Report `$id` is of type `string`, but the function expects a `array`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
151		->with('success', 'Device updated successfully');
152		}
153
154		/**
155		* Deletes a device.
156		*
157		* @param string $id
158		* @return \Illuminate\Http\RedirectResponse
159		*/
160	View Code Duplication	public function destroy($id)
161		{
162		$device = Device::withTrashed()->findOrFail($id);
163
164		if ($device->trashed())
165		{
166		//If the device was already deleted then permanently delete it
167		$device->forceDelete($device->id);
168		}
169		else
170		{
171		//Remove the location from the device
172		$device->location_id = null;
173		$device->save();
174
175		//Soft delete the device the first time
176		$device->delete();
177		}
178
179		return redirect()->route('device.index')
180		->with('success','Device deleted successfully');
181		}
182
183		/**
184		* Restores a device.
185		*
186		* @param string $id
187		* @return \Illuminate\Http\RedirectResponse
188		*/
189	View Code Duplication	public function restore($id)
190		{
191		$device = Device::onlyTrashed()->findOrFail($id);
192
193		$device->restore();
194
195		return redirect()->route('device.show', $device->id)
196		->with('success','Device restored successfully');
197		}
198		}
199

uidaho / smartsettia

Pull Request — master (#96)

DeviceController A

Complexity

Size/Duplication

Coupling/Cohesion

Test Coverage

Importance

8 Methods

How to fix Duplicated Code

Duplicated Code

Duplication Side-by-Side

Filter issues like