Audit\Notifications\Logs\LogWritten

Complexity

Total Complexity

20

Size/Duplication

Total Lines	170
Duplicated Lines	14.12 %

Coupling/Cohesion

Components	1
Dependencies	3

Importance

Changes

0

5 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	29	3
A	via()	14	14	4
B	toMail()	5	44	6
B	toSlack()	5	39	6
A	toArray()	0	6	1

<?php

namespace Audit\Notifications\Logs;

use Illuminate\Bus\Queueable;
use Illuminate\Notifications\Notification;
use Illuminate\Contracts\Queue\ShouldQueue;
use Illuminate\Notifications\Messages\MailMessage;
use Illuminate\Notifications\Messages\SlackMessage;
use Audit\Models\Logs\Finger;

class LogWritten extends Notification implements ShouldQueue
{
    use Queueable;

    private $laraLogsLog;

    private $requestInfo;

    private $notificationLevels;

    /**
     * Create a new notification instance.
     *
     * @return void

Adding a @return annotation to constructors is generally not recommended as a constructor does not have a meaningful return value.

     */
    public function __construct(Finger $laraLogsLog)
    {
        $this->laraLogsLog = $laraLogsLog;

        $this->requestInfo = array(
            'id' => $laraLogsLog->id,
            'level' => $laraLogsLog->level,
            'message' => $laraLogsLog->message,
            'user_id' => $laraLogsLog->user_id ? $laraLogsLog->user_id : null,
            'email' => $laraLogsLog->email ? $laraLogsLog->email : null
        );

        $this->notificationLevels = array(
            'error' => [
                'emergency',
                'alert',
                'critical',
                'error'
            ],
            'warning' => [
                'warning',
                'notice'
            ],
            'success' => [
                'info',
                'debug'
            ]
        );
    }

    /**
     * Get the notification's delivery channels.
     *
     * @param  mixed $notifiable
     * @return array
     */
    public function via($notifiable)

This method seems to be duplicated in your project.

    {
        switch($notifiable->notify_by) {
        case 'email':
            return ['mail'];
            break;

break is not strictly necessary here and could be removed.

        case 'slack':
            return ['slack'];
            break;

break is not strictly necessary here and could be removed.

        case 'email_slack':
            return ['mail', 'slack'];
            break;

break is not strictly necessary here and could be removed.

        }
    }

    /**
     * Get the mail representation of the notification.
     *
     * @param  mixed $notifiable
     * @return \Illuminate\Notifications\Messages\MailMessage
     */
    public function toMail($notifiable)
    {
        $content = 'A log on ' . url('/') . ' has been written to.';
        if($notifiable->filter !== '*') {
            $content .= " You're being notified because the log contains `" . $notifiable->filter . "`";
        }

        $status = 'success';
        foreach($this->notificationLevels as $triggerLevel => $childLevels) {

This code seems to be duplicated across your project.

            if(in_array($this->requestInfo['level'], $childLevels)) {
                $status = $triggerLevel;
            }
        }

        $fields = array(
            'Level' => $this->requestInfo['level'],
            'Message' => $this->requestInfo['message']
        );

        if($this->requestInfo['user_id']) {
            $fields['User ID'] = $this->requestInfo['user_id'];
        }

        if($this->requestInfo['email']) {
            $fields['Associated Email'] = $this->requestInfo['email'];
        }

        $statusColors = array(
            'success' => '#00B945',
            'warning' => '#ff9f00',
            'error' => '#BC001A'
        );

        return (new MailMessage)
            ->subject(env('LARALogs_LOG_SUBJECT', '[LaraLogs Alert] The application log has been written to'))
            ->from(env('LARALogs_FROM_EMAIL', 'alerts@laraLogs.com'), env('LARALogs_FROM_NAME', 'LaraLogs Alerts'))
            ->view(
                'laraLogs::emails.log-written', [
                'requestInfo' => $this->requestInfo,
                'content' => $content,
                'alertColor' => $statusColors[$status]
                ]
            );
    }

    public function toSlack($notifiable)
    {
        $content = 'A log on ' . url('/') . ' has been written to.';
        if($notifiable->filter !== '*') {
            $content .= " You're being notified because the log contains `" . $notifiable->filter . "`";
        }

        $status = 'success';
        foreach($this->notificationLevels as $triggerLevel => $childLevels) {

This code seems to be duplicated across your project.

            if(in_array($this->requestInfo['level'], $childLevels)) {
                $status = $triggerLevel;
            }
        }

        $fields = array(
            'Level' => $this->requestInfo['level'],
            'Message' => $this->requestInfo['message']
        );

        if($this->requestInfo['user_id']) {
            $fields['User ID'] = $this->requestInfo['user_id'];
        }

        if($this->requestInfo['email']) {
            $fields['Associated Email'] = $this->requestInfo['email'];
        }

        $requestInfo = $this->requestInfo;

        return (new SlackMessage)
            ->{ $status }()
            ->attachment(
                function ($attachment) use ($requestInfo, $fields, $content) {
                    $attachment->title('Log #' . $requestInfo['id'], route('laraLogs::logs.show', $requestInfo['id']))
                        ->content($content)
                        ->fields($fields);
                }
            );
    }

    /**
     * Get the array representation of the notification.
     *
     * @param  mixed $notifiable
     * @return array
     */
    public function toArray($notifiable)

The parameter $notifiable is not used and could be removed.

    {
        return [
            //
        ];
    }
}