Notifier - Code Metrics - Inspection of "Possible fix for #56" - tylercd100/lern - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — fix/56 ( 314f60 )

by Tyler

created 2018-07-03 17:41 UTC

Notifier A

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	241
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	5

Test Coverage

Coverage

98.72%

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
wmc	31
c	1
b	0
f	0
lcom	1
cbo	5
dl	0
loc	241
ccs	77
cts	78
cp	0.9872
rs	9.92

15 Methods

Rating	Name	Size	Complexity
A	__construct()	9	2
A	wrapValueInClosure()	8	2
A	setMessage()	5	1
A	getMessage()	14	3
A	getMessageViaDefault()	8	2
A	getMessageViaCallback()	7	2
A	getMessageViaView()	14	3
A	setSubject()	5	1
A	getSubject()	8	2
A	setContext()	5	1
A	getContext()	14	3
A	getLogLevel()	4	1
A	setLogLevel()	5	1
A	pushHandler()	5	1
B	send()	25	6

<?php

namespace Tylercd100\LERN\Components;

use Auth;
use Exception;
use Illuminate\Support\Facades\Input;
use Monolog\Handler\HandlerInterface;
use Monolog\Logger;
use Request;
use Tylercd100\LERN\Exceptions\NotifierFailedException;
use Tylercd100\Notify\Drivers\FromConfig as Notify;
use View;

class Notifier extends Component
{
    protected $config;
    protected $log;
    protected $messageCb;
    protected $subjectCb;
    protected $contextCb;

    /**
     * @var array
     */
    private $absolutelyDontHandle = [

        \Tylercd100\LERN\Exceptions\NotifierFailedException::class,
    ];

    /**
     * You can provide a Monolog Logger instance to use in the constructor
     * @param Logger|null $log Logger instance to use
     */
    public function __construct(Logger $log = null)
    {
        if ($log === null) {
            $log = new Logger(config('lern.notify.channel'));
        }

        $this->config = config('lern.notify');
        $this->log = $log;
    }

    /**
     * Transforms a value into a closure that returns itself when called
     * @param  callable|string $cb The value that you want to wrap in a closure
     * @return callable
     */
    private function wrapValueInClosure($cb)
    {
        if (is_callable($cb)) {
            return $cb;
        } else {
            return function () use ($cb) { return $cb; };
        }
    }

    /**
     * Set a string or a closure to be called that will generate the message body for the notification
     * @param callable|string $cb A closure or string that will be set for the message
     * @return $this
     */
    public function setMessage($cb)
    {
        $this->messageCb = $this->wrapValueInClosure($cb);
        return $this;
    }

    /**
     * Returns the result of the message closure
     * @param  Exception $e The Exception instance that you want to build the message around
     * @return string       The message string
     */
    public function getMessage(Exception $e)
    {
        $msg = $this->getMessageViaView($e);

        if ($msg === false) {
            $msg = $this->getMessageViaCallback($e);
        }

        if ($msg === false) {
            $msg = $this->getMessageViaDefault($e);
        }
        
        return $msg;
    }

    /**
     * Gets a basic Exception message
     * @param  Exception $e The Exception instance that you want to build the message around
     * @return String       Returns the message string
     */
    public function getMessageViaDefault(Exception $e)
    {
        $msg = get_class($e)." was thrown! \n".$e->getMessage();
        if ($this->config['includeExceptionStackTrace'] === true) {
            $msg .= "\n\n".$e->getTraceAsString();
        }
        return $msg;
    }

    /**
     * Gets the Exception message using a callback if it is set
     * @param  Exception    $e The Exception instance that you want to build the message around
     * @return String|false    Returns the message string or false
     */
    public function getMessageViaCallback(Exception $e)
    {
        if (is_callable($this->messageCb)) {
            return $this->messageCb->__invoke($e);
        }
        return false;
    }

    /**
     * Gets the Exception message using a Laravel view file
     * @param  Exception    $e The Exception instance that you want to build the message around
     * @return String|false    Returns the message string or false
     */
    public function getMessageViaView(Exception $e)
    {
        $path = @$this->config["view"];
        if (!empty($path) && View::exists($path)) {
            return View::make($path, [
                "exception" => $e,
                "url" => Request::url(),
                "method" => Request::method(),
                "input" => Input::all(),
                "user" => Auth::user(),
            ])->render();
        }
        return false;
    }

    /**
     * Set a string or a closure to be called that will generate the subject line for the notification
     * @param callable|string $cb A closure or string that will be set for the subject line
     * @return $this
     */
    public function setSubject($cb)
    {
        $this->subjectCb = $this->wrapValueInClosure($cb);
        return $this;
    }

    /**
     * Returns the result of the subject closure
     * @param  Exception $e The Exception instance that you want to build the subject around
     * @return string       The subject string
     */
    public function getSubject(Exception $e)
    {
        if (is_callable($this->subjectCb)) {
            return $this->subjectCb->__invoke($e);
        } else {
            return get_class($e);
        }
    }

    /**
     * Set an array or a closure to be called that will generate the context array for the notification
     * @param callable|array $cb A closure or array that will be set for the context
     * @return $this
     */
    public function setContext($cb)
    {
        $this->contextCb = $this->wrapValueInClosure($cb);
        return $this;
    }

    /**
     * Returns the result of the context closure
     * @param  Exception $e The Exception instance that you want to build the context around
     * @return array        The context array
     */
    public function getContext(Exception $e, $context = [])
    {
        //This needs a better solution. How do I set specific context needs for different drivers?
        if (in_array('pushover', $this->config['drivers'])) {
            $context['sound'] = $this->config['pushover']['sound'];
        }

        // Call the callback or return the default
        if (is_callable($this->contextCb)) {
            return $this->contextCb->__invoke($e, $context);
        } else {
            return $context;
        }
    }

    /**
     * Get the log level
     * @return string 
     */
    public function getLogLevel()
    {
        return $this->config['log_level'];
    }

    /**
     * Set the log level
     * @param string $level The log level
     * @return \Tylercd100\LERN\LERN
     */
    public function setLogLevel($level)
    {
        $this->config['log_level'] = $level;
        return $this;
    }

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

    /**
     * Triggers the Monolog Logger instance to log an error to all handlers
     * @param  Exception $e The exception to use
     * @param  array $context Additional information that you would like to pass to Monolog
     * @return bool
     * @throws NotifierFailedException
     */
    public function send(Exception $e, array $context = [])
    {
        if ($this->shouldntHandle($e)) {
            return false;
        }

        $message = $this->getMessage($e);
        $subject = $this->getSubject($e);
        $context = $this->getContext($e, $context);

        try {
            $notify = new Notify($this->config, $this->log, $subject);

            $level = (array_key_exists('log_level', $this->config) && !empty($this->config['log_level']))
                ? $this->config['log_level']
                : 'critical';

            $notify->{$level}($message, $context);

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


1		<?php
2
3		namespace Tylercd100\LERN\Components;
4
5		use Auth;
6		use Exception;
7		use Illuminate\Support\Facades\Input;
8		use Monolog\Handler\HandlerInterface;
9		use Monolog\Logger;
10		use Request;
11		use Tylercd100\LERN\Exceptions\NotifierFailedException;
12		use Tylercd100\Notify\Drivers\FromConfig as Notify;
13		use View;
14
15		class Notifier extends Component
16		{
17		protected $config;
18		protected $log;
19		protected $messageCb;
20		protected $subjectCb;
21		protected $contextCb;
22
23		/**
24		* @var array
25		*/
26		private $absolutelyDontHandle = [
		0 ignored issues – show Comprehensibility introduced 2018-07-03 17:55 UTC by Report Bug Copy Issue Report Consider using a different property name as you override a private property of the parent class. Loading history... Unused Code introduced 2018-07-03 17:55 UTC by Report Bug Copy Issue Report The property `$absolutelyDontHandle` is not used and could be removed. This check marks private properties in classes that are never used. Those properties can be removed. Loading history...
27		\Tylercd100\LERN\Exceptions\NotifierFailedException::class,
28		];
29
30		/**
31		* You can provide a Monolog Logger instance to use in the constructor
32		* @param Logger\|null $log Logger instance to use
33		*/
34	75	public function __construct(Logger $log = null)
35		{
36	75	if ($log === null) {
37	75	$log = new Logger(config('lern.notify.channel'));
38		}
39
40	75	$this->config = config('lern.notify');
41	75	$this->log = $log;
42	75	}
43
44		/**
45		* Transforms a value into a closure that returns itself when called
46		* @param callable\|string $cb The value that you want to wrap in a closure
47		* @return callable
48		*/
49	15	private function wrapValueInClosure($cb)
50		{
51	15	if (is_callable($cb)) {
52	9	return $cb;
53		} else {
54		return function () use ($cb) { return $cb; };
55		}
56		}
57
58		/**
59		* Set a string or a closure to be called that will generate the message body for the notification
60		* @param callable\|string $cb A closure or string that will be set for the message
61		* @return $this
62		*/
63	6	public function setMessage($cb)
64		{
65	6	$this->messageCb = $this->wrapValueInClosure($cb);
66	6	return $this;
67		}
68
69		/**
70		* Returns the result of the message closure
71		* @param Exception $e The Exception instance that you want to build the message around
72		* @return string The message string
73		*/
74	30	public function getMessage(Exception $e)
75		{
76	30	$msg = $this->getMessageViaView($e);
77
78	30	if ($msg === false) {
79	9	$msg = $this->getMessageViaCallback($e);
80		}
81
82	30	if ($msg === false) {
83	3	$msg = $this->getMessageViaDefault($e);
84		}
85
86	30	return $msg;
87		}
88
89		/**
90		* Gets a basic Exception message
91		* @param Exception $e The Exception instance that you want to build the message around
92		* @return String Returns the message string
93		*/
94	3	public function getMessageViaDefault(Exception $e)
95		{
96	3	$msg = get_class($e)." was thrown! \n".$e->getMessage();
97	3	if ($this->config['includeExceptionStackTrace'] === true) {
98	3	$msg .= "\n\n".$e->getTraceAsString();
99		}
100	3	return $msg;
101		}
102
103		/**
104		* Gets the Exception message using a callback if it is set
105		* @param Exception $e The Exception instance that you want to build the message around
106		* @return String\|false Returns the message string or false
107		*/
108	9	public function getMessageViaCallback(Exception $e)
109		{
110	9	if (is_callable($this->messageCb)) {
111	6	return $this->messageCb->__invoke($e);
112		}
113	3	return false;
114		}
115
116		/**
117		* Gets the Exception message using a Laravel view file
118		* @param Exception $e The Exception instance that you want to build the message around
119		* @return String\|false Returns the message string or false
120		*/
121	30	public function getMessageViaView(Exception $e)
122		{
123	30	$path = @$this->config["view"];
124	30	if (!empty($path) && View::exists($path)) {
125	21	return View::make($path, [
126	21	"exception" => $e,
127	21	"url" => Request::url(),
128	21	"method" => Request::method(),
129	21	"input" => Input::all(),
130	21	"user" => Auth::user(),
131	21	])->render();
132		}
133	9	return false;
134		}
135
136		/**
137		* Set a string or a closure to be called that will generate the subject line for the notification
138		* @param callable\|string $cb A closure or string that will be set for the subject line
139		* @return $this
140		*/
141	6	public function setSubject($cb)
142		{
143	6	$this->subjectCb = $this->wrapValueInClosure($cb);
144	6	return $this;
145		}
146
147		/**
148		* Returns the result of the subject closure
149		* @param Exception $e The Exception instance that you want to build the subject around
150		* @return string The subject string
151		*/
152	21	public function getSubject(Exception $e)
153		{
154	21	if (is_callable($this->subjectCb)) {
155	6	return $this->subjectCb->__invoke($e);
156		} else {
157	15	return get_class($e);
158		}
159		}
160
161		/**
162		* Set an array or a closure to be called that will generate the context array for the notification
163		* @param callable\|array $cb A closure or array that will be set for the context
164		* @return $this
165		*/
166	3	public function setContext($cb)
167		{
168	3	$this->contextCb = $this->wrapValueInClosure($cb);
169	3	return $this;
170		}
171
172		/**
173		* Returns the result of the context closure
174		* @param Exception $e The Exception instance that you want to build the context around
175		* @return array The context array
176		*/
177	18	public function getContext(Exception $e, $context = [])
178		{
179		//This needs a better solution. How do I set specific context needs for different drivers?
180	18	if (in_array('pushover', $this->config['drivers'])) {
181	15	$context['sound'] = $this->config['pushover']['sound'];
182		}
183
184		// Call the callback or return the default
185	18	if (is_callable($this->contextCb)) {
186	3	return $this->contextCb->__invoke($e, $context);
187		} else {
188	15	return $context;
189		}
190		}
191
192		/**
193		* Get the log level
194		* @return string
195		*/
196	3	public function getLogLevel()
197		{
198	3	return $this->config['log_level'];
199		}
200
201		/**
202		* Set the log level
203		* @param string $level The log level
204		* @return \Tylercd100\LERN\LERN
205		*/
206	3	public function setLogLevel($level)
207		{
208	3	$this->config['log_level'] = $level;
209	3	return $this;
210		}
211
212		/**
213		* Pushes on another Monolog Handler
214		* @param HandlerInterface $handler The handler instance to add on
215		* @return Notifier Returns this
216		*/
217	6	public function pushHandler(HandlerInterface $handler)
218		{
219	6	$this->log->pushHandler($handler);
220	6	return $this;
221		}
222
223		/**
224		* Triggers the Monolog Logger instance to log an error to all handlers
225		* @param Exception $e The exception to use
226		* @param array $context Additional information that you would like to pass to Monolog
227		* @return bool
228		* @throws NotifierFailedException
229		*/
230	15	public function send(Exception $e, array $context = [])
231		{
232	15	if ($this->shouldntHandle($e)) {
233		return false;
234		}
235
236	15	$message = $this->getMessage($e);
237	15	$subject = $this->getSubject($e);
238	15	$context = $this->getContext($e, $context);
239
240		try {
241	15	$notify = new Notify($this->config, $this->log, $subject);
242
243	15	$level = (array_key_exists('log_level', $this->config) && !empty($this->config['log_level']))
244	15	? $this->config['log_level']
245	15	: 'critical';
246
247	15	$notify->{$level}($message, $context);
248
249	12	return true;
250	3	} catch (Exception $e) {
251	3	$code = (is_int($e->getCode()) ? $e->getCode() : 0);
252	3	throw new NotifierFailedException($e->getMessage(), $code, $e);
253		}
254		}
255		}
256

tylercd100 / lern

Push — fix/56 ( 314f60 )

Notifier A

Complexity

Size/Duplication

Coupling/Cohesion

Test Coverage

Importance

15 Methods

Duplication Side-by-Side

Filter issues like