LERN - Code Metrics - Inspection of "Use a different Exception Model" - tylercd100/lern - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#63)

by Tyler

created 2018-02-16 23:18 UTC

LERN A

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	193
Duplicated Lines	13.47 %

Coupling/Cohesion

Components	1
Dependencies	4

Test Coverage

Coverage

96.92%

Importance

Changes	5
Bugs	0	Features	0

Metric	Value
wmc	21
c	5
b	0
f	0
lcom	1
cbo	4
dl	26
loc	193
ccs	63
cts	65
cp	0.9692
rs	10

15 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	5	1
A	handle()	0	6	1
A	record()	0	5	1
A	notify()	0	5	1
A	pushHandler()	0	4	1
A	getNotifier()	0	4	1
A	setNotifier()	0	5	1
A	getRecorder()	0	4	1
A	setRecorder()	0	5	1
A	setMessage()	0	5	1
A	setSubject()	0	5	1
A	buildNotifier()	13	13	4
A	buildRecorder()	13	13	4
A	getLogLevel()	0	4	1
A	setLogLevel()	0	5	1

How to fix Duplicated Code

<?php

namespace Tylercd100\LERN;

use Exception;
use Monolog\Handler\HandlerInterface;
use Tylercd100\LERN\Components\Notifier;
use Tylercd100\LERN\Components\Recorder;
use Tylercd100\LERN\Exceptions\NotifierFailedException;
use Tylercd100\LERN\Exceptions\RecorderFailedException;

/**
* The master class
*/
class LERN 
{
    /**
     * @var Exception
     */
    private $exception;

    /**
     * @var Notifier
     */
    private $notifier;

    /**
     * @var Recorder
     */
    private $recorder;
    
    /**
     * @param Notifier|null $notifier Notifier instance
     * @param Recorder|null $recorder Recorder instance
     */
    public function __construct(Notifier $notifier = null, Recorder $recorder = null)
    {
        $this->notifier = $this->buildNotifier($notifier);
        $this->recorder = $this->buildRecorder($recorder);
    }

    /**
     * Will execute record and notify methods
     * @param  Exception $e   The exception to use
     * @return ExceptionModel the recorded Eloquent Model
     */
    public function handle(Exception $e)
    {
        $this->exception = $e;
        $this->notify($e);
        return $this->record($e);

    }

    /**
     * Stores the exception in the database
     * @param  Exception $e   The exception to use
     * @return \Tylercd100\LERN\Models\ExceptionModel|false The recorded Exception as an Eloquent Model
     */
    public function record(Exception $e)
    {
        $this->exception = $e;
        return $this->recorder->record($e);
    }

    /**
     * Will send the exception to all monolog handlers
     * @param  Exception $e The exception to use
     * @return void
     */
    public function notify(Exception $e)
    {
        $this->exception = $e;
        $this->notifier->send($e);
    }

    /**
     * Pushes on another Monolog Handler
     * @param  HandlerInterface $handler The handler instance to add on
     * @return $this
     */
    public function pushHandler(HandlerInterface $handler) {
        $this->notifier->pushHandler($handler);
        return $this;
    }

    /**
     * Get Notifier
     * @return \Tylercd100\LERN\Components\Notifier 
     */
    public function getNotifier()
    {
        return $this->notifier;
    }

    /**
     * Set Notifier
     * @param \Tylercd100\LERN\Components\Notifier $notifier A Notifier instance to use
     * @return \Tylercd100\LERN\LERN
     */
    public function setNotifier(Notifier $notifier)
    {
        $this->notifier = $notifier;
        return $this;
    }

    /**
     * Get Recorder
     * @return \Tylercd100\LERN\Components\Recorder 
     */
    public function getRecorder()
    {
        return $this->recorder;
    }

    /**
     * Set Recorder
     * @param \Tylercd100\LERN\Components\Recorder $recorder A Recorder instance to use
     * @return \Tylercd100\LERN\LERN
     */
    public function setRecorder(Recorder $recorder)
    {
        $this->recorder = $recorder;
        return $this;
    }

    /**
     * Get the log level
     * @return string 
     */
    public function getLogLevel()
    {
        return $this->notifier->getLogLevel();
    }

    /**
     * Set the log level
     * @param string $level The log level
     * @return \Tylercd100\LERN\LERN
     */
    public function setLogLevel($level)
    {
        $this->notifier->setLogLevel($level);
        return $this;
    }

    /**
     * Set a string or a closure to be called that will generate the message body for the notification
     * @param function|string $cb This closure function will be passed an Exception and must return a string
     * @return $this
     */
    public function setMessage($cb)
    {
        $this->notifier->setMessage($cb);
        return $this;
    }

    /**
     * Set a string or a closure to be called that will generate the subject line for the notification
     * @param function|string $cb This closure function will be passed an Exception and must return a string
     * @return $this
     */
    public function setSubject($cb)
    {
        $this->notifier->setSubject($cb);
        return $this;
    }

    /**
     * Constructs a Notifier
     *
     * @param Notifier $notifier
     * @return Notifier
     */
    protected function buildNotifier(Notifier $notifier = null)

    {
        $class = config('lern.notify.class');
        $class = !empty($class) ? $class : Notifier::class;
        if (empty($notifier)) {
            $notifier = new $class();
        }
        if ($notifier instanceof Notifier) {
            return $notifier;
        } else {
            throw new NotifierFailedException("LERN was expecting an instance of ".Notifier::class);
        }
    }

    /**
     * Constructs a Recorder
     *
     * @param Recorder $recorder
     * @return Recorder
     */
    protected function buildRecorder(Recorder $recorder = null)

    {
        $class = config('lern.record.class');
        $class = !empty($class) ? $class : Recorder::class;
        if (empty($recorder)) {
            $recorder = new $class();
        }
        if ($recorder instanceof Recorder) {
            return $recorder;
        } else {
            throw new RecorderFailedException("LERN was expecting an instance of ".Recorder::class);
        }
    }
}


1			<?php
2
3			namespace Tylercd100\LERN;
4
5			use Exception;
6			use Monolog\Handler\HandlerInterface;
7			use Tylercd100\LERN\Components\Notifier;
8			use Tylercd100\LERN\Components\Recorder;
9			use Tylercd100\LERN\Exceptions\NotifierFailedException;
10			use Tylercd100\LERN\Exceptions\RecorderFailedException;
11
12			/**
13			* The master class
14			*/
15			class LERN
16			{
17			/**
18			* @var Exception
19			*/
20			private $exception;
21
22			/**
23			* @var Notifier
24			*/
25			private $notifier;
26
27			/**
28			* @var Recorder
29			*/
30			private $recorder;
31
32			/**
33			* @param Notifier\|null $notifier Notifier instance
34			* @param Recorder\|null $recorder Recorder instance
35			*/
36	29		public function __construct(Notifier $notifier = null, Recorder $recorder = null)
37			{
38	29		$this->notifier = $this->buildNotifier($notifier);
39	29		$this->recorder = $this->buildRecorder($recorder);
40	29		}
41
42			/**
43			* Will execute record and notify methods
44			* @param Exception $e The exception to use
45			* @return ExceptionModel the recorded Eloquent Model
46			*/
47	3		public function handle(Exception $e)
48			{
49	3		$this->exception = $e;
50	3		$this->notify($e);
51	3		return $this->record($e);
			0 ignored issues – show Comprehensibility Best Practice introduced 2018-02-16 22:59 UTC by Report Bug Copy Issue Report The expression `$this->record($e);` of type `false\|object` adds `false` to the return on line 51 which is incompatible with the return type documented by `Tylercd100\LERN\LERN::handle` of type `Tylercd100\LERN\ExceptionModel`. It seems like you forgot to handle an error condition. Loading history...
52			}
53
54			/**
55			* Stores the exception in the database
56			* @param Exception $e The exception to use
57			* @return \Tylercd100\LERN\Models\ExceptionModel\|false The recorded Exception as an Eloquent Model
58			*/
59	3		public function record(Exception $e)
60			{
61	3		$this->exception = $e;
62	3		return $this->recorder->record($e);
63			}
64
65			/**
66			* Will send the exception to all monolog handlers
67			* @param Exception $e The exception to use
68			* @return void
69			*/
70	3		public function notify(Exception $e)
71			{
72	3		$this->exception = $e;
73	3		$this->notifier->send($e);
74	3		}
75
76			/**
77			* Pushes on another Monolog Handler
78			* @param HandlerInterface $handler The handler instance to add on
79			* @return $this
80			*/
81	3		public function pushHandler(HandlerInterface $handler) {
82	3		$this->notifier->pushHandler($handler);
83	3		return $this;
84			}
85
86			/**
87			* Get Notifier
88			* @return \Tylercd100\LERN\Components\Notifier
89			*/
90	3		public function getNotifier()
91			{
92	3		return $this->notifier;
93			}
94
95			/**
96			* Set Notifier
97			* @param \Tylercd100\LERN\Components\Notifier $notifier A Notifier instance to use
98			* @return \Tylercd100\LERN\LERN
99			*/
100	3		public function setNotifier(Notifier $notifier)
101			{
102	3		$this->notifier = $notifier;
103	3		return $this;
104			}
105
106			/**
107			* Get Recorder
108			* @return \Tylercd100\LERN\Components\Recorder
109			*/
110	3		public function getRecorder()
111			{
112	3		return $this->recorder;
113			}
114
115			/**
116			* Set Recorder
117			* @param \Tylercd100\LERN\Components\Recorder $recorder A Recorder instance to use
118			* @return \Tylercd100\LERN\LERN
119			*/
120	3		public function setRecorder(Recorder $recorder)
121			{
122	3		$this->recorder = $recorder;
123	3		return $this;
124			}
125
126			/**
127			* Get the log level
128			* @return string
129			*/
130	1		public function getLogLevel()
131	2		{
132	1		return $this->notifier->getLogLevel();
133	2		}
134	2
135			/**
136			* Set the log level
137			* @param string $level The log level
138			* @return \Tylercd100\LERN\LERN
139			*/
140	2		public function setLogLevel($level)
141			{
142	4		$this->notifier->setLogLevel($level);
143	2		return $this;
144	2		}
145	2
146			/**
147			* Set a string or a closure to be called that will generate the message body for the notification
148			* @param function\|string $cb This closure function will be passed an Exception and must return a string
149			* @return $this
150			*/
151	1		public function setMessage($cb)
152			{
153	1		$this->notifier->setMessage($cb);
154	19		return $this;
155			}
156	18
157	18		/**
158	18		* Set a string or a closure to be called that will generate the subject line for the notification
159	10		* @param function\|string $cb This closure function will be passed an Exception and must return a string
160			* @return $this
161	18		*/
162	19		public function setSubject($cb)
163			{
164	1		$this->notifier->setSubject($cb);
165	1		return $this;
166			}
167
168			/**
169			* Constructs a Notifier
170			*
171			* @param Notifier $notifier
172			* @return Notifier
173			*/
174	29	View Code Duplication	protected function buildNotifier(Notifier $notifier = null)
			0 ignored issues – show Duplication introduced 2018-02-02 17:03 UTC by Report Bug Copy Issue Report This method seems to be duplicated in 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...
175			{
176	29		$class = config('lern.notify.class');
177	29		$class = !empty($class) ? $class : Notifier::class;
178	29		if (empty($notifier)) {
179	24		$notifier = new $class();
180			}
181	29		if ($notifier instanceof Notifier) {
182	29		return $notifier;
183			} else {
184			throw new NotifierFailedException("LERN was expecting an instance of ".Notifier::class);
185			}
186			}
187
188			/**
189			* Constructs a Recorder
190			*
191			* @param Recorder $recorder
192			* @return Recorder
193			*/
194	11	View Code Duplication	protected function buildRecorder(Recorder $recorder = null)
			0 ignored issues – show Duplication introduced 2018-02-02 17:03 UTC by Report Bug Copy Issue Report This method seems to be duplicated in 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...
195			{
196	11		$class = config('lern.record.class');
197	11		$class = !empty($class) ? $class : Recorder::class;
198	11		if (empty($recorder)) {
199	11		$recorder = new $class();
200			}
201	11		if ($recorder instanceof Recorder) {
202	11		return $recorder;
203			} else {
204			throw new RecorderFailedException("LERN was expecting an instance of ".Recorder::class);
205			}
206			}
207			}
208

tylercd100 / lern

Pull Request — master (#63)

LERN A

Complexity

Size/Duplication

Coupling/Cohesion

Test Coverage

Importance

15 Methods

How to fix Duplicated Code

Duplicated Code

Duplication Side-by-Side

Filter issues like