GCTC-NTGC / TalentCloud

app/Models/JobApplication.php

<?php

/**
 * Created by Reliese Model.
 * Date: Thu, 12 Jul 2018 22:39:27 +0000.
 */

namespace App\Models;

use App\Events\ApplicationRetrieved;
use App\Events\ApplicationSaved;
use App\Models\Applicant;
use App\Models\ApplicationReview;
use App\Models\Lookup\JobApplicationStep;
use App\Services\Validation\ApplicationTimelineValidator;
use App\Services\Validation\ApplicationValidator;
use Illuminate\Notifications\Notifiable;
use App\Traits\TalentCloudCrudTrait as CrudTrait;

/**
 * Class JobApplication
 *
 * @property int $id
 * @property int $job_poster_id
 * @property int $application_status_id
 * @property int $citizenship_declaration_id
 * @property int $veteran_status_id
 * @property int $preferred_language_id
 * @property int $applicant_id
 * @property int $applicant_snapshot_id
 * @property string $submission_signature
 * @property string $submission_date
 * @property boolean $experience_saved
 * @property boolean $language_requirement_confirmed
 * @property boolean $language_test_confirmed
 * @property boolean $education_requirement_confirmed
 * @property string $user_name
 * @property string $user_email
 * @property int $version_id
 * @property string $director_name
 * @property string $director_title
 * @property string $director_email
 * @property string $reference_name
 * @property string $reference_title
 * @property string $reference_email
 * @property string $gov_email
 * @property boolean $physical_office_willing
 * @property int $security_clearance_id
 * @property boolean $share_with_managers
 * @property \Jenssegers\Date\Date $created_at
 * @property \Jenssegers\Date\Date $updated_at
 *
 * @property \App\Models\Applicant $applicant
 * @property \App\Models\Applicant $applicant_snapshot
 * @property \App\Models\Lookup\ApplicationStatus $application_status
 * @property \App\Models\Lookup\CitizenshipDeclaration $citizenship_declaration
 * @property \App\Models\Lookup\VeteranStatus $veteran_status
 * @property \App\Models\Lookup\PreferredLanguage $preferred_language
 * @property \App\Models\JobPoster $job_poster
 * @property \Illuminate\Database\Eloquent\Collection $job_application_answers
 * @property \Illuminate\Database\Eloquent\Collection $skill_declarations
 * @property \App\Models\ApplicationReview $application_review
 * @property \Illuminate\Database\Eloquent\Collection $degrees
 * @property \Illuminate\Database\Eloquent\Collection $courses
 * @property \Illuminate\Database\Eloquent\Collection $work_experiences
 * @property \Illuminate\Database\Eloquent\Collection $references
 * @property \Illuminate\Database\Eloquent\Collection $work_samples
 * @property \Illuminate\Database\Eloquent\Collection $projects
 * @property \App\Models\JobApplicationVersion $job_application_version
 * @property \App\Models\Lookup\SecurityClearance $security_clearance
 *
 * Version 2 application models.
 * @property \Illuminate\Database\Eloquent\Collection $experiences_work
 * @property \Illuminate\Database\Eloquent\Collection $experiences_personal
 * @property \Illuminate\Database\Eloquent\Collection $experiences_education
 * @property \Illuminate\Database\Eloquent\Collection $experiences_award
 * @property \Illuminate\Database\Eloquent\Collection $experiences_community
 * @property \Illuminate\Database\Eloquent\Collection $touched_application_steps
 */
class JobApplication extends BaseModel
{
    // Trait for Backpack.
    use CrudTrait;

    use Notifiable;

    protected $dispatchesEvents = [
        'retrieved' => ApplicationRetrieved::class,
        'saved' => ApplicationSaved::class,
    ];

    protected $casts = [
        'job_poster_id' => 'int',
        'application_status_id' => 'int',
        'citizenship_declaration_id' => 'int',
        'veteran_status_id' => 'int',
        'preferred_language_id' => 'int',
        'applicant_id' => 'int',
        'applicant_snapshot_id' => 'int',
        'submission_signature' => 'string',
        'submission_date' => 'string',
        'experience_saved' => 'boolean',
        'language_requirement_confirmed' => 'boolean',
        'language_test_confirmed' => 'boolean',
        'education_requirement_confirmed' => 'boolean',
        'version_id' => 'int',
        'director_name' => 'string',
        'director_title' => 'string',
        'director_email' => 'string',
        'reference_name' => 'string',
        'reference_title' => 'string',
        'reference_email' => 'string',
        'gov_email' => 'string',
        'physical_office_willing' => 'boolean',
        'security_clearance_id' => 'int',
        'share_with_managers' => 'boolean',
    ];
    protected $fillable = [
        'citizenship_declaration_id',
        'veteran_status_id',
        'preferred_language_id',
        'language_requirement_confirmed',
        'language_test_confirmed',
        'education_requirement_confirmed',
        'version_id',
        'veteran_status_id',
        'preferred_language_id',
        'submission_signature',
        'submission_date',
        'experience_saved',
        'director_name',
        'director_title',
        'director_email',
        'reference_name',
        'reference_title',
        'reference_email',
        'gov_email',
        'physical_office_willing',
        'security_clearance_id',
        'share_with_managers',
    ];

    /**
     * The accessors to append to the model's array/json form.
     *
     * @var array
     */
    protected $appends = ['meets_essential_criteria'];

    protected function createApplicantSnapshot($applicant_id)
    {
        $applicant = Applicant::where('id', $applicant_id)->firstOrFail();

        $snapshot = $applicant->replicate();

The assignment to $snapshot is dead and can be removed.

    }

    public function applicant()
    {
        return $this->belongsTo(\App\Models\Applicant::class);
    }

    public function applicant_snapshot() //phpcs:ignore
    {
        return $this->belongsTo(\App\Models\Applicant::class, 'applicant_snapshot_id');
    }

    public function application_status() //phpcs:ignore
    {
        return $this->belongsTo(\App\Models\Lookup\ApplicationStatus::class);
    }

    public function citizenship_declaration() //phpcs:ignore
    {
        return $this->belongsTo(\App\Models\Lookup\CitizenshipDeclaration::class);
    }

    public function veteran_status() //phpcs:ignore
    {
        return $this->belongsTo(\App\Models\Lookup\VeteranStatus::class);
    }

    public function preferred_language() //phpcs:ignore
    {
        return $this->belongsTo(\App\Models\Lookup\PreferredLanguage::class);
    }

    public function job_poster() //phpcs:ignore
    {
        return $this->belongsTo(\App\Models\JobPoster::class);
    }

    public function job_application_answers() //phpcs:ignore
    {
        return $this->hasMany(\App\Models\JobApplicationAnswer::class);
    }

    public function skill_declarations() //phpcs:ignore
    {
        return $this->morphMany(\App\Models\SkillDeclaration::class, 'skillable');
    }

    public function application_review() //phpcs:ignore
    {
        return $this->hasOne(ApplicationReview::class);
    }

    public function degrees()
    {
        return $this->morphMany(\App\Models\Degree::class, 'degreeable')->orderBy('end_date', 'desc');
    }

    public function courses()
    {
        return $this->morphMany(\App\Models\Course::class, 'courseable')->orderBy('end_date', 'desc');
    }

    public function work_experiences() //phpcs:ignore
    {
        return $this->morphMany(\App\Models\WorkExperience::class, 'experienceable')->orderBy('end_date', 'desc');
    }

    public function references()
    {
        return $this->morphMany(\App\Models\Reference::class, 'referenceable');
    }

    public function projects()
    {
        return $this->morphMany(\App\Models\Project::class, 'projectable');
    }

    public function work_samples() //phpcs:ignore
    {
        return $this->morphMany(\App\Models\WorkSample::class, 'work_sampleable');
    }

    public function job_application_version() //phpcs:ignore
    {
        return $this->hasOne(\App\Models\JobApplicationVersion::class, 'version_id');
    }

    public function security_clearance() //phpcs:ignore
    {
        return $this->belongsTo(\App\Models\Lookup\SecurityClearance::class);
    }

    // Version 2 application models.
    public function experiences_work() //phpcs:ignore
    {
        return $this->morphMany(\App\Models\ExperienceWork::class, 'experienceable')
            ->orderBy('end_date', 'desc');
    }

    public function experiences_personal() //phpcs:ignore
    {
        return $this->morphMany(\App\Models\ExperiencePersonal::class, 'experienceable')
            ->orderBy('end_date', 'desc');
    }

    public function experiences_education() //phpcs:ignore
    {
        return $this->morphMany(\App\Models\ExperienceEducation::class, 'experienceable')
            ->orderBy('end_date', 'desc');
    }

    public function experiences_award() //phpcs:ignore
    {
        return $this->morphMany(\App\Models\ExperienceAward::class, 'experienceable');
    }

    public function experiences_community() //phpcs:ignore
    {
        return $this->morphMany(\App\Models\ExperienceCommunity::class, 'experienceable')
            ->orderBy('end_date', 'desc');
    }

    public function touched_application_steps() //phpcs:ignore
    {
        return $this->hasMany(\App\Models\TouchedApplicationStep::class);
    }

    /**
     * Return either 'complete', 'incomplete' or 'error', depending on the
     * status of the requested section.
     *
     * @param  string $section Should be one of:
     *                              'basics'
     *                              'experience'
     *                              'essential_skills'
     *                              'asset_skills'
     *                              'preview'
     *
     * @return string $status   'complete', 'incomplete' or 'error'
     */
    public function getSectionStatus(string $section)
    {
        // TODO: determine whether sections are complete or invalid
        $jobPoster = $this->job_poster;

The assignment to $jobPoster is dead and can be removed.

        $validator = new ApplicationValidator();
        $status = 'incomplete';
        switch ($section) {
            case 'basics':
                if ($validator->basicsComplete($this)) {
                    $status = 'complete';
                }
                break;
            case 'experience':
                if ($validator->experienceComplete($this)) {
                    $status = 'complete';
                }
                break;
            case 'essential_skills':
                if ($validator->essentialSkillsComplete($this)) {
                    $status = 'complete';
                }
                break;
            case 'asset_skills':
                if ($validator->assetSkillsComplete($this)) {
                    $status = 'complete';
                }
                break;
            case 'preview':
                if ($validator->basicsComplete($this) &&
                    $validator->experienceComplete($this) &&
                    $validator->essentialSkillsComplete($this) &&
                    $validator->assetSkillsComplete($this)
                ) {
                    $status = 'complete';
                }
                break;
            case 'confirm':
                if ($validator->affirmationComplete($this)) {
                    $status = 'complete';
                }
                break;
            default:
                $status = 'error';
                break;
        }
        return $status;
    }

    /**
     * Check if the status of the application is 'draft'
     *
     * @return boolean
     */
    public function isDraft(): bool
    {
        return $this->application_status->name === 'draft';
    }

    /**
     * Returns true if this meets all the HARD SKILL essential criteria.
     * That means it has attached an SkillDeclaration for each essential criterion,
     * with a level at least as high as the required level.
     * NOTE: If this application is in draft status, it will use
     *  SkillDeclarations from the the applicants profile for this check.
     *
     * @return boolean
     */
    public function meetsEssentialCriteria(): bool
    {
        $essentialCriteria = $this->job_poster->criteria->filter(
            function ($value, $key) {
                return $value->criteria_type->name == 'essential'
                    && $value->skill->skill_type->name == 'hard';
            }
        );
        $source = $this->isDraft() ? $this->applicant : $this;
        foreach ($essentialCriteria as $criterion) {
            $skillDeclaration = $source->skill_declarations->where('skill_id', $criterion->skill_id)->first();
            if ($skillDeclaration === null ||
                $skillDeclaration->skill_level_id < $criterion->skill_level_id
            ) {
                return false;
            }
        }
        return true;
    }

    /**
     * Accessor for meetsEssentialCriteria function, which
     * allows this value to be automatically appended to array/json representation.
     *
     * @return boolean
     */
    public function getMeetsEssentialCriteriaAttribute(): bool
    {
        return $this->meetsEssentialCriteria();
    }

    /**
     * Save copies of all relevant profile data to this application.
     *
     *
     * @return void
     */
    public function saveProfileSnapshot(): void
    {
        $applicant = $this->applicant->fresh();

        $this->user_name = $applicant->user->full_name;
        $this->user_email = $applicant->user->email;
        $this->save();

        // Delete previous snapshot.
        $this->degrees()->delete();
        $this->courses()->delete();
        $this->work_experiences()->delete();
        $this->projects()->delete();
        $this->references()->delete();
        $this->work_samples()->delete();
        $this->skill_declarations()->delete();

        $this->degrees()->saveMany($applicant->degrees->map->replicate());
        $this->courses()->saveMany($applicant->courses->map->replicate());
        $this->work_experiences()->saveMany($applicant->work_experiences->map->replicate());

        $copyWithHistory = function ($model) {
            return [
                'old' => $model,
                'new' => $model->replicate()
            ];
        };

        $projectMap = $applicant->projects->map($copyWithHistory);
        $referenceMap = $applicant->references->map($copyWithHistory);
        $workSampleMap = $applicant->work_samples->map($copyWithHistory);
        $skillDeclarationMap = $applicant->skill_declarations->map($copyWithHistory);

        // First link new projects, references, work samples and skill declarations to this application.
        $this->projects()->saveMany($projectMap->pluck('new'));
        $this->references()->saveMany($referenceMap->pluck('new'));
        $this->work_samples()->saveMany($workSampleMap->pluck('new'));
        $this->skill_declarations()->saveMany($skillDeclarationMap->pluck('new'));

        $findNewFromOld = function ($mapping, $old) {
            $matchingItem = $mapping->first(function ($value) use ($old) {
                return $value['old']->id === $old->id;
            });
            return $matchingItem['new'];
        };

        // Replicate copies shallow attributes, but not relationships. We have to copy those ourselves.
        $findNewReferenceFromOld = function ($old) use ($findNewFromOld, $referenceMap) {
            return $findNewFromOld($referenceMap, $old);
        };

        $findNewSkillDeclarationFromOld = function ($old) use ($findNewFromOld, $skillDeclarationMap) {
            return $findNewFromOld($skillDeclarationMap, $old);
        };

        // Link projects and references.
        foreach ($projectMap as $item) {
            $old = $item['old'];
            $newProj = $item['new'];
            $newReferences = $old->references->map($findNewReferenceFromOld);
            $newProj->references()->sync($newReferences);
        }

        // Link references and skills.
        foreach ($referenceMap as $item) {
            $old = $item['old'];
            $newRef = $item['new'];
            $newSkillDecs = $old->skill_declarations->map($findNewSkillDeclarationFromOld);
            $newRef->skill_declarations()->sync($newSkillDecs);
        }

        // Link work samples and skills.
        foreach ($workSampleMap as $item) {
            $old = $item['old'];
            $newSample = $item['new'];
            $newSkillDecs = $old->skill_declarations->map($findNewSkillDeclarationFromOld);
            $newSample->skill_declarations()->sync($newSkillDecs);
        }
    }

    /**
     * Save copies of Experiences and its linked skills (ExperienceSkills) to this application.
     *
     * @return void
     */
    public function saveProfileSnapshotTimeline(): void
    {
        $this->refresh();
        $applicant = $this->applicant->fresh();
        $this->user_name = $applicant->user->full_name;
        $this->user_email = $applicant->user->email;
        $this->save();

        $deleteExperiences = function ($experiences) {
            foreach ($experiences as $experience) {
                $experience->delete();
            }
        };

        // Delete experiences in previous snapshot.
        $deleteExperiences($this->experiences_award);
        $deleteExperiences($this->experiences_community);
        $deleteExperiences($this->experiences_education);
        $deleteExperiences($this->experiences_personal);
        $deleteExperiences($this->experiences_work);

        // Assemble a list of skill ids relevant to this application.
        // That means skills for essential AND asset criteria of job, but only Hard skills.
        $this->job_poster->load('criteria.skill.skill_type'); // Preemptively load criteria and skill relationships to minimize queries.
        $applicationSkillIds = $this->job_poster->criteria
            ->where('skill.skill_type.name', 'hard')
            ->pluck('skill_id')
            ->all();

        $replicateAndSaveExperience = function ($experiences, $experience_type) use ($applicationSkillIds) {
            // Iterate through applicant experiences, replicate the experience, and save to the application.
            foreach ($experiences as $experience) {
                $experienceCopy = $experience->replicate();
                $this->{$experience_type}()->save($experienceCopy);

                // Get only the ExperienceSkills relevant to this application.
                $experienceSkills = $experience->experience_skills->whereIn('skill_id', $applicationSkillIds);

                // Iterate through original experience experienceSkills list, replicate it, and save to the new copy.
                foreach ($experienceSkills as $experienceSkill) {
                    $experienceSkillCopy = $experienceSkill->replicate();
                    $experienceCopy->experience_skills()->save($experienceSkillCopy);
                }
            }
        };

        $replicateAndSaveExperience($applicant->experiences_award, 'experiences_award');
        $replicateAndSaveExperience($applicant->experiences_community, 'experiences_community');
        $replicateAndSaveExperience($applicant->experiences_education, 'experiences_education');
        $replicateAndSaveExperience($applicant->experiences_personal, 'experiences_personal');
        $replicateAndSaveExperience($applicant->experiences_work, 'experiences_work');
    }

    /**
     * Attach steps to new application (version 2).
     *
     * @return void
    */
    public function attachSteps(): void
    {
        if ($this->touched_application_steps->isEmpty()) {
            $basicStep = new TouchedApplicationStep();
            $basicStep->step_id = JobApplicationStep::where('name', 'basic')->first()->id;
            $this->touched_application_steps()->save($basicStep);

            $experienceStep = new TouchedApplicationStep();
            $experienceStep->step_id = JobApplicationStep::where('name', 'experience')->first()->id;
            $this->touched_application_steps()->save($experienceStep);

            $skillsStep = new TouchedApplicationStep();
            $skillsStep->step_id = JobApplicationStep::where('name', 'skills')->first()->id;
            $this->touched_application_steps()->save($skillsStep);

            $fitStep = new TouchedApplicationStep();
            $fitStep->step_id = JobApplicationStep::where('name', 'fit')->first()->id;
            $this->touched_application_steps()->save($fitStep);

            $reviewStep = new TouchedApplicationStep();
            $reviewStep->step_id = JobApplicationStep::where('name', 'review')->first()->id;
            $this->touched_application_steps()->save($reviewStep);

            $submissionStep = new TouchedApplicationStep();
            $submissionStep->step_id = JobApplicationStep::where('name', 'submission')->first()->id;
            $this->touched_application_steps()->save($submissionStep);
            $this->save();
            $this->refresh();
        };
    }

    /**
     * Calculates and returns an associative array of application steps (version 2) with the value equal
     * to it's status ('default', 'complete', 'error').
     *
     * @return string $jobApplicationSteps
     */
    public function jobApplicationSteps(): array
    {
        $this->attachSteps();
        $setState = function (bool $touched, bool $isValid) {
            return !$touched ? 'default' : ($isValid ? 'complete' : 'error');
        };

        $validator = new ApplicationTimelineValidator();

        $basicValidator = $validator->basicsComplete($this);
        $experienceValidator = $validator->experienceComplete($this);
        $skillsValidator = $validator->skillsComplete($this);
        $fitValidator = $validator->fitComplete($this);
        $reviewValidator = $basicValidator && $experienceValidator && $skillsValidator && $fitValidator;
        $submissionValidator = $validator->affirmationComplete($this);

        $basicTouched = $this->touched_application_steps
            ->where('step_id', JobApplicationStep::where('name', 'basic')->first()->id)
            ->first()->touched;
        $experienceTouched = $this->touched_application_steps
            ->where('step_id', JobApplicationStep::where('name', 'experience')->first()->id)
            ->first()->touched;
        $skillsTouched = $this->touched_application_steps
            ->where('step_id', JobApplicationStep::where('name', 'skills')->first()->id)
            ->first()->touched;
        $fitTouched = $this->touched_application_steps
            ->where('step_id', JobApplicationStep::where('name', 'fit')->first()->id)
            ->first()->touched;
        $reviewTouched = $this->touched_application_steps
            ->where('step_id', JobApplicationStep::where('name', 'review')->first()->id)
            ->first()->touched;
        $submissionTouched = $this->touched_application_steps
            ->where('step_id', JobApplicationStep::where('name', 'submission')->first()->id)
            ->first()->touched;

        $jobApplicationSteps = [
            'basic' => $setState($basicTouched, $basicValidator),
            'experience' => $setState($experienceTouched, $experienceValidator),
            'skills' => $setState($skillsTouched, $skillsValidator),
            'fit' => $setState($fitTouched, $fitValidator),
            'review' => $setState($reviewTouched, $reviewValidator),
            'submission' => $setState($submissionTouched, $submissionValidator)
        ];

        return $jobApplicationSteps;
    }
}