SET\Console\Commands\RenewTraining

Complexity

Total Complexity

13

Size/Duplication

Total Lines	167
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	5

Test Coverage

Coverage

100%

Importance

Changes

0

7 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	5	1
A	handle()	0	21	4
A	getList()	0	4	1
A	renewedAlready()	0	14	2
A	timeToRenew()	0	17	3
B	processRenewal()	0	24	1
A	createRecord()	0	12	1

<?php

namespace SET\Console\Commands;

use Carbon\Carbon;
use Illuminate\Console\Command;
use Illuminate\Database\Eloquent\Collection;
use Illuminate\Support\Facades\DB;
use Illuminate\Support\Facades\Event;
use Illuminate\Support\Facades\Log;
use SET\Events\TrainingAssigned;
use SET\TrainingUser;

class RenewTraining extends Command
{
    /**
     * The number of days to renew a training before it expires.
     *
     * @var int
     */
    protected $offset = 30;

    /**
     * List of all renewed notes.
     *
     * @var Collection
     */
    protected $trainingAdminRecord;

    /**
     * The name and signature of the console command.
     *
     * @var string
     */
    protected $signature = 'training:renew';

    /**
     * The console command description.
     *
     * @var string
     */
    protected $description = 'Renews training before it expires.';

    /**
     * Create a new command instance.
     */
    public function __construct()
    {
        parent::__construct();
        $this->trainingAdminRecord = new Collection();
    }

    /**
     * Execute the console command.
     *
     * @return RenewTraining
     */
    public function handle()
    {
        $trainingUsers = TrainingUser::with('user', 'training')
            ->where('due_date', '<', Carbon::today())
            ->RenewableTrainings()  // Training is renewed (positive renews_in)
            ->activeUsers()
            ->orderBy(DB::raw('CASE WHEN completed_date IS NULL THEN 0 ELSE 1 END'))
            ->orderBy('completed_date', 'desc')
            ->get()
            ->unique(function ($item) {
                return $item['user_id'].'-'.$item['training_id'];
            });

        foreach ($trainingUsers as $trainingUser) {
            if (!$this->renewedAlready($trainingUser) && $this->timeToRenew($trainingUser)) {
                $this->processRenewal($trainingUser);
            }
        }

        return $this;
    }

    public function getList()
    {
        return $this->trainingAdminRecord->sortBy('userFullName');
    }

    /**
     * Check if training note has been renewed already.
     *
     * @param $trainingUser
     *
     * @return bool
     */
    private function renewedAlready($trainingUser)
    {
        if (is_null($trainingUser->completed_date)) {
            return true;
        }

        // Where due_date is in future or withing past renewal period
        $trainingRecord = TrainingUser::where('training_id', $trainingUser->training_id)
            ->where('user_id', $trainingUser->user_id)
            ->where('due_date', '>', Carbon::today()->subDays($trainingUser->training->renews_in))
            ->get();

        return !$trainingRecord->isEmpty();
    }

    /**
     * Check if the training is past the renews_in value.
     *
     * @param $trainingUser
     *
     * @return bool
     */
    private function timeToRenew($trainingUser)
    {
        if ($trainingUser->training->renews_in == 0) {
            return false;
        }
        if (!$trainingUser->completed_date) {
            return false;
        }

        $today = Carbon::today();

        $renewalDate = Carbon::createFromFormat('Y-m-d', $trainingUser->completed_date)
            ->addDays($trainingUser->training->renews_in)
            ->subDays($this->offset);

        return !($renewalDate >= $today);
    }

    /**
     * Generate a new Training note that will be due $this->offset days from now.
     *
     * @param $trainingUser
     */
    private function processRenewal($trainingUser)
    {
        $dueDate = Carbon::createFromFormat('Y-m-d', $trainingUser->completed_date)
            ->addDays($trainingUser->training->renews_in);

        $assignedTraining = $this->createRecord($trainingUser, $dueDate);

        //Email user of new training is due
        Event::fire(new TrainingAssigned($assignedTraining));
        Log::info('User training renewal notification.', [
            'user_id'       => $assignedTraining->user_id,
            'user_name'     => $assignedTraining->user->userFullName,
            'training_id'   => $assignedTraining->training_id,
            'training_name' => $assignedTraining->training->name,
            'due_date'      => $assignedTraining->due_date,
        ]);

        //
        $this->trainingAdminRecord->push([
            'name'     => $assignedTraining->user->userFullName,
            'training' => $assignedTraining->training->name,
            'due_date' => $dueDate->toDateString(),
        ]);
    }

    /**
     * @param $trainingUser
     * @param Carbon $dueDate
     *
     * @return TrainingUser
     */
    private function createRecord($trainingUser, $dueDate)
    {
        $newNote = TrainingUser::create([
            'user_id'        => $trainingUser->user_id,
            'author_id'      => 1,
            'training_id'    => $trainingUser->training_id,
            'due_date'       => $dueDate->toDateString(),
            'completed_date' => null,
        ]);

        return $newNote;
    }
}