Recorder - Code Metrics - Inspection of "Missing use statement!" - tylercd100/lern - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — fix/56 ( d15d50...729cbd )

by Tyler

created 2018-07-03 20:33 UTC

Recorder A

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	205
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	4

Test Coverage

Coverage

80.72%

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
wmc	40
c	1
b	0
f	0
lcom	1
cbo	4
dl	0
loc	205
ccs	67
cts	83
cp	0.8072
rs	9.2

11 Methods

Rating	Name	Size	Complexity
A	__construct()	3	1
B	record()	45	10
A	canCollect()	6	4
B	collect()	21	8
A	getUserId()	8	3
A	getMethod()	8	2
A	getData()	8	2
A	getUrl()	8	2
A	getIp()	3	1
A	getStatusCode()	7	2
A	excludeKeys()	12	5

How to fix Complexity

<?php

namespace Tylercd100\LERN\Components;

use Exception;
use Illuminate\Support\Facades\Auth;
use Illuminate\Support\Facades\Input;
use Illuminate\Support\Facades\Request;
use Illuminate\Support\Facades\Cache;
use Symfony\Component\HttpKernel\Exception\HttpExceptionInterface;
use Tylercd100\LERN\Exceptions\RecorderFailedException;
use Tylercd100\LERN\Models\ExceptionModel;
use Carbon\Carbon;

class Recorder extends Component {

    /**
     * @var mixed
     */
    protected $config = [];

    /**
     * @var array
     */
    protected $absolutelyDontHandle = [
        \Tylercd100\LERN\Exceptions\RecorderFailedException::class,
    ];

    /**
     * The constructor
     */
    public function __construct() {
        $this->config = config('lern.record');
    }

    /**
     * Records an Exception to the database
     * @param  Exception $e The exception you want to record
     * @return false|ExceptionModel
     * @throws RecorderFailedException
     */
    public function record(Exception $e)
    {
        if ($this->shouldntHandle($e)) {
            return false;
        }

        $opts = [
            'class'       => get_class($e),
            'file'        => $e->getFile(),
            'line'        => $e->getLine(),
            'code'        => (is_int($e->getCode()) ? $e->getCode() : 0),
            'message'     => $e->getMessage(),
            'trace'       => $e->getTraceAsString(),
        ];

        $configDependant = array_keys($this->config['collect']);

        try {
            foreach ($configDependant as $key) {
                if ($this->canCollect($key)) {
                    $value = $this->collect($key, $e);
                    if ($value !== null) {
                        $opts[$key] = $value;
                    }
                }
            }

            $class = config('lern.recorder.model');
            $class = !empty($class) ? $class : ExceptionModel::class;

            $model = new $class();
            foreach($opts as $key => $value) {
                $model->{$key} = $value;
            }

            $model->save();

            Cache::forever($this->getCacheKey($e), Carbon::now());

            return $model;
        } catch (Exception $e) {
            $code = (is_int($e->getCode()) ? $e->getCode() : 0);
            throw new RecorderFailedException($e->getMessage(), $code, $e);
        }
    }

    /**
     * Checks the config to see if you can collect certain information
     * @param  string $type the config value you want to check
     * @return boolean      
     */
    private function canCollect($type) {
        if (!empty($this->config) && !empty($this->config['collect']) && !empty($this->config['collect'][$type])) {
            return $this->config['collect'][$type] === true;
        }
        return false;
    }

    /**
     * @param string $key
     * @param Exception $e
     * @return array|int|null|string
     * @throws Exception
     */
    protected function collect($key, Exception $e = null) {
        switch ($key) {
            case 'user_id':
                return $this->getUserId();
            case 'method':
                return $this->getMethod();
            case 'url':
                return $this->getUrl();
            case 'data':
                return $this->getData();
            case 'ip':
                return $this->getIp();
            case 'status_code':
                if ($e === null) {
                    return 0;
                }
                return $this->getStatusCode($e);
            default:
                throw new Exception("{$key} is not supported! Therefore it cannot be collected!");
        }
    }

    /**
     * Gets the ID of the User that is logged in
     * @return integer|null The ID of the User or Null if not logged in
     */
    protected function getUserId() {
        $user = Auth::user();
        if (is_object($user) && !empty($user->id)) {
interface SomeInterface { }
class SomeClass implements SomeInterface {
    public $a;
}

function someFunction(SomeInterface $object) {
    if ($object instanceof SomeClass) {
        $a = $object->a;
    }
}
            return $user->id;
interface SomeInterface { }
class SomeClass implements SomeInterface {
    public $a;
}

function someFunction(SomeInterface $object) {
    if ($object instanceof SomeClass) {
        $a = $object->a;
    }
}
        } else {
            return null;
        }
    }

    /**
     * Gets the Method of the Request
     * @return string|null Possible values are null or GET, POST, DELETE, PUT, etc...
     */
    protected function getMethod() {
        $method = Request::method();
        if (!empty($method)) {
            return $method;
        } else {
            return null;
        }
    }

    /**
     * Gets the input data of the Request
     * @return array|null The Input data or null
     */
    protected function getData() {
        $data = Input::all();
        if (is_array($data)) {
            return $this->excludeKeys($data);
        } else {
            return null;
        }
    }

    /**
     * Gets the URL of the Request
     * @return string|null Returns a URL string or null
     */
    protected function getUrl() {
        $url = Request::url();
        if (is_string($url)) {
            return $url;
        } else {
            return null;
        }
    }

    /**
     * Returns the IP from the request
     *
     * @return string
     */
    protected function getIp() {
        return Request::ip();
    }

    /**
     * Gets the status code of the Exception
     * @param  Exception $e The Exception to check
     * @return string|integer The status code value
     */
    protected function getStatusCode(Exception $e) {
        if ($e instanceof HttpExceptionInterface) {
            return $e->getStatusCode();
        } else {
            return 0;
        }
    }

    /**
     * This function will remove all keys from an array recursively as defined in the config file
     * @param  array $data The array to remove keys from
     * @return void
     */
    protected function excludeKeys(array $data) {
        $keys = isset($this->config['excludeKeys']) ? $this->config['excludeKeys'] : [];
        foreach ($data as $key => &$value) {
            if (in_array($key, $keys)) {
                unset($data[$key]);
            } else if (is_array($value)) {
                $value = $this->excludeKeys($value);
            }
        }

        return $data;
    }
}


Push — fix/56 ( d15d50...729cbd )

Recorder A

Complexity

Size/Duplication

Coupling/Cohesion

Test Coverage

Importance

11 Methods

How to fix Complexity

Complex Class

Available Fixes

Available Fixes

1		<?php
2
3		namespace Tylercd100\LERN\Components;
4
5		use Exception;
6		use Illuminate\Support\Facades\Auth;
7		use Illuminate\Support\Facades\Input;
8		use Illuminate\Support\Facades\Request;
9		use Illuminate\Support\Facades\Cache;
10		use Symfony\Component\HttpKernel\Exception\HttpExceptionInterface;
11		use Tylercd100\LERN\Exceptions\RecorderFailedException;
12		use Tylercd100\LERN\Models\ExceptionModel;
13		use Carbon\Carbon;
14
15		class Recorder extends Component {
16
17		/**
18		* @var mixed
19		*/
20		protected $config = [];
21
22		/**
23		* @var array
24		*/
25		protected $absolutelyDontHandle = [
26		\Tylercd100\LERN\Exceptions\RecorderFailedException::class,
27		];
28
29		/**
30		* The constructor
31		*/
32	36	public function __construct() {
33	36	$this->config = config('lern.record');
34	36	}
35
36		/**
37		* Records an Exception to the database
38		* @param Exception $e The exception you want to record
39		* @return false\|ExceptionModel
40		* @throws RecorderFailedException
41		*/
42	6	public function record(Exception $e)
43		{
44	6	if ($this->shouldntHandle($e)) {
45		return false;
46		}
47
48		$opts = [
49	6	'class' => get_class($e),
50	6	'file' => $e->getFile(),
51	6	'line' => $e->getLine(),
52	6	'code' => (is_int($e->getCode()) ? $e->getCode() : 0),
53	6	'message' => $e->getMessage(),
54	6	'trace' => $e->getTraceAsString(),
55		];
56
57	6	$configDependant = array_keys($this->config['collect']);
58
59		try {
60	6	foreach ($configDependant as $key) {
61	6	if ($this->canCollect($key)) {
62	6	$value = $this->collect($key, $e);
63	6	if ($value !== null) {
64	6	$opts[$key] = $value;
65		}
66		}
67		}
68
69	6	$class = config('lern.recorder.model');
70	6	$class = !empty($class) ? $class : ExceptionModel::class;
71
72	6	$model = new $class();
73	6	foreach($opts as $key => $value) {
74	6	$model->{$key} = $value;
75		}
76
77	6	$model->save();
78
79	3	Cache::forever($this->getCacheKey($e), Carbon::now());
80
81	3	return $model;
82	3	} catch (Exception $e) {
83	3	$code = (is_int($e->getCode()) ? $e->getCode() : 0);
84	3	throw new RecorderFailedException($e->getMessage(), $code, $e);
85		}
86		}
87
88		/**
89		* Checks the config to see if you can collect certain information
90		* @param string $type the config value you want to check
91		* @return boolean
92		*/
93	6	private function canCollect($type) {
94	6	if (!empty($this->config) && !empty($this->config['collect']) && !empty($this->config['collect'][$type])) {
95	6	return $this->config['collect'][$type] === true;
96		}
97		return false;
98		}
99
100		/**
101		* @param string $key
102		* @param Exception $e
103		* @return array\|int\|null\|string
104		* @throws Exception
105		*/
106	6	protected function collect($key, Exception $e = null) {
107		switch ($key) {
108	6	case 'user_id':
109	6	return $this->getUserId();
110	6	case 'method':
111	6	return $this->getMethod();
112	6	case 'url':
113	6	return $this->getUrl();
114	6	case 'data':
115	6	return $this->getData();
116	6	case 'ip':
117		return $this->getIp();
118	6	case 'status_code':
119	6	if ($e === null) {
120		return 0;
121		}
122	6	return $this->getStatusCode($e);
123		default:
124		throw new Exception("{$key} is not supported! Therefore it cannot be collected!");
125		}
126		}
127
128		/**
129		* Gets the ID of the User that is logged in
130		* @return integer\|null The ID of the User or Null if not logged in
131		*/
132	6	protected function getUserId() {
133	6	$user = Auth::user();
134	6	if (is_object($user) && !empty($user->id)) {
		0 ignored issues – show Bug introduced 2017-02-01 16:20 UTC by Report Bug Copy Issue Report Accessing `id` on the interface `Illuminate\Contracts\Auth\Authenticatable` suggest that you code against a concrete implementation. How about adding an `instanceof` check? If you access a property on an interface, you most likely code against a concrete implementation of the interface. Available Fixes Adding an additional type check: interface SomeInterface { } class SomeClass implements SomeInterface { public $a; } function someFunction(SomeInterface $object) { if ($object instanceof SomeClass) { $a = $object->a; } } Changing the type hint: interface SomeInterface { } class SomeClass implements SomeInterface { public $a; } function someFunction(SomeClass $object) { $a = $object->a; } Loading history...
135		return $user->id;
		0 ignored issues – show Bug introduced 2017-02-01 16:20 UTC by Report Bug Copy Issue Report Accessing `id` on the interface `Illuminate\Contracts\Auth\Authenticatable` suggest that you code against a concrete implementation. How about adding an `instanceof` check? If you access a property on an interface, you most likely code against a concrete implementation of the interface. Available Fixes Adding an additional type check: interface SomeInterface { } class SomeClass implements SomeInterface { public $a; } function someFunction(SomeInterface $object) { if ($object instanceof SomeClass) { $a = $object->a; } } Changing the type hint: interface SomeInterface { } class SomeClass implements SomeInterface { public $a; } function someFunction(SomeClass $object) { $a = $object->a; } Loading history...
136		} else {
137	6	return null;
138		}
139		}
140
141		/**
142		* Gets the Method of the Request
143		* @return string\|null Possible values are null or GET, POST, DELETE, PUT, etc...
144		*/
145	6	protected function getMethod() {
146	6	$method = Request::method();
147	6	if (!empty($method)) {
148	6	return $method;
149		} else {
150		return null;
151		}
152		}
153
154		/**
155		* Gets the input data of the Request
156		* @return array\|null The Input data or null
157		*/
158	6	protected function getData() {
159	6	$data = Input::all();
160	6	if (is_array($data)) {
161	6	return $this->excludeKeys($data);
162		} else {
163		return null;
164		}
165		}
166
167		/**
168		* Gets the URL of the Request
169		* @return string\|null Returns a URL string or null
170		*/
171	6	protected function getUrl() {
172	6	$url = Request::url();
173	6	if (is_string($url)) {
174	6	return $url;
175		} else {
176		return null;
177		}
178		}
179
180		/**
181		* Returns the IP from the request
182		*
183		* @return string
184		*/
185		protected function getIp() {
186		return Request::ip();
187		}
188
189		/**
190		* Gets the status code of the Exception
191		* @param Exception $e The Exception to check
192		* @return string\|integer The status code value
193		*/
194	6	protected function getStatusCode(Exception $e) {
195	6	if ($e instanceof HttpExceptionInterface) {
196		return $e->getStatusCode();
197		} else {
198	6	return 0;
199		}
200		}
201
202		/**
203		* This function will remove all keys from an array recursively as defined in the config file
204		* @param array $data The array to remove keys from
205		* @return void
206		*/
207	6	protected function excludeKeys(array $data) {
208	6	$keys = isset($this->config['excludeKeys']) ? $this->config['excludeKeys'] : [];
209	6	foreach ($data as $key => &$value) {
210		if (in_array($key, $keys)) {
211		unset($data[$key]);
212		} else if (is_array($value)) {
213		$value = $this->excludeKeys($value);
214		}
215		}
216
217	6	return $data;
218		}
219		}
220

tylercd100 / lern

Push — fix/56 ( d15d50...729cbd )

Recorder A

Complexity

Size/Duplication

Coupling/Cohesion

Test Coverage

Importance

11 Methods

How to fix Complexity

Complex Class

Available Fixes

Available Fixes

Duplication Side-by-Side

Filter issues like