ApplicationValidator::experienceValidator() - Code Metrics - Inspection of "Validate that experience is saved on app" - GCTC-NTGC/TalentCloud - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — feature/application_tracker_va... ( b06851...be6d1a )

by Tristan

created 2018-12-13 22:02 UTC

ApplicationValidator::experienceValidator() A

↳ Parent: ApplicationValidator

Complexity

Conditions	1
Paths	1

Size

Total Lines	3
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	2

Importance

Changes

Metric	Value
eloc	2
dl	0
loc	3
ccs	0
cts	3
cp	0
rs	10
c	0
b	0
f	0
cc	1
nc	1
nop	1
crap	2

<?php


namespace App\Services\Validation;

use App\Models\JobApplication;
use Illuminate\Support\Facades\Validator;
use Illuminate\Validation\Rule;
use Illuminate\Validation\Validator as BaseValidator;
use App\Models\Lookup\CitizenshipDeclaration;
use App\Models\Lookup\CriteriaType;
use App\Models\Lookup\VeteranStatus;
use App\Models\Lookup\PreferredLanguage;
use App\Services\Validation\Rules\ContainsObjectWithAttributeRule;
use App\Services\Validation\JobApplicationAnswerValidator;

class ApplicationValidator {


    protected $citizenship_ids;
    protected $veteran_status_ids;
    protected $preferred_language_ids;

    public function __construct() {

        $this->citizenship_ids = CitizenshipDeclaration::all()->pluck('id')->toArray();
        $this->veteran_status_ids = VeteranStatus::all()->pluck('id')->toArray();
        $this->preferred_language_ids = PreferredLanguage::all()->pluck('id')->toArray();
    }

    public function validate(JobApplication $application) {


        $backendRules = [
            'job_poster_id' => 'required',
            'application_status_id' => 'required',
            'applicant_id' => 'required'
        ];

        $rules = array_merge(
            $backendRules,
            $this->basicsValidator($application)->getRules(),
            $this->experienceValidator($application)->getRules(),
            $this->essentialSkillsValidator($application)->getRules(),
            $this->affirmationValidator($application)->getRules()
        );

        //Validate basic data is filled in
        Validator::make($application->toArray(), $rules)->validate();
    }

    protected function arrayMapKeys($fn, $array) {

        $newArray = [];
        foreach($array as $key => $value) {

            $newArray[$fn($key)] = $value;
        }
        return $newArray;
    }

    protected function addNestedValidatorRules($nestedAttribute, $validatorRules, $rules = []) {

        // prepend the attribute name of each validator rule with the nested attribute name
        $newRules = $this->arrayMapKeys(function($key) use ($nestedAttribute) {

                return implode('.', [$nestedAttribute, $key]);
            },

            $validatorRules);
someFunctionCall(
    $firstArgument,
    $secondArgument,
    $thirdArgument
); // Closing parenthesis on a new line.
        //Merge new rules with old rules
        $rules = array_merge($rules, $newRules);
        return $rules;
    }

    public function basicsValidator(JobApplication $application) {

        // Validate the fields common to every application
        $rules = [
            'citizenship_declaration_id' => ['required', Rule::in($this->citizenship_ids)],
            'veteran_status_id' => ['required', Rule::in($this->veteran_status_ids)],
            'preferred_language_id' => ['required', Rule::in($this->preferred_language_ids)],
        ];

        //Load application answers so they are included in application->toArray()
        $application->load('job_application_answers');

        // Validate that each question has been answered
        $jobPosterQuestionRules = [];
        foreach($application->job_poster->job_poster_questions as $question) {

            $jobPosterQuestionRules[] = new ContainsObjectWithAttributeRule('job_poster_question_id', $question->id);
        }
        $rules['job_application_answers'] = $jobPosterQuestionRules;
        $answerValidatorFactory = new JobApplicationAnswerValidator($application);

        //Validate that each answer is complete
        foreach($application->job_application_answers as $key=>$answer) {

            $attribute = implode('.', ['job_application_answers', $key]);
            $rules = $this->addNestedValidatorRules($attribute, $answerValidatorFactory->rules(), $rules);
        }

        $validator = Validator::make($application->toArray(), $rules);
        return $validator;
    }

    public function basicsComplete(JobApplication $application) {

        $validator = $this->basicsValidator($application);
        return $validator->passes();
    }

    public function experienceValidator(JobApplication $application) {

        $rules = ['experience_saved' => 'required|boolean|accepted'];
        return Validator::make($application->toArray(), $rules);
    }

    public function experinceComplete(JobApplication $application) {

        return $this->experienceValidator($application)->passes();
    }

    protected function skillsValidator(JobApplication $application, $criteria_type) {

        $rules = [];

        $skillDeclarationRules = [];
        $criteriaTypeId = CriteriaType::where('name', $criteria_type)->firstOrFail()->id;
        foreach($application->job_poster->criteria->where('criteria_type_id', $criteriaTypeId) as $criteria) {

            //Validate that every essential skill has a corresponding declaration
            $skillDeclarationRules[] = new ContainsObjectWithAttributeRule('skill_id', $criteria->skill_id);
        }
        $rules['skill_declarations'] = $skillDeclarationRules;
        $application->applicant->load('skill_declarations');

        //Validate that those declarations are complete
        $skilDeclarationValidatorFactory = new SkillDeclarationValidator($application->applicant);
        $relevantSkillIds = $application->job_poster->criteria->where('criteria_type_id', $criteriaTypeId)->pluck('skill_id');
        foreach( $application->skill_declarations as $key=>$declaration) {

            if ($relevantSkillIds->contains($declaration->skill_id)) {
                $attribute = implode('.', ['skill_declarations', $key]);
                $skillDeclarationValidator = $skilDeclarationValidatorFactory->validator($declaration);
                $rules = $this->addNestedValidatorRules($attribute, $skillDeclarationValidator->getRules(), $rules);
            }
        }

        $validator = Validator::make($application->toArray(), $rules);
        return $validator;
    }

    public function essentialSkillsValidator(JobApplication $application) {

        return $this->skillsValidator($application, 'essential');
    }

    public function essentialSkillsComplete(JobApplication $application) {

        return $this->essentialSkillsValidator($application)->passes();
    }

    public function assetSkillsValidator(JobApplication $application) {

        return $this->skillsValidator($application, 'asset');
    }

    public function assetSkillsComplete(JobApplication $application) {

        return $this->assetSkillsValidator($application)->passes();
    }

    public function affirmationValidator(JobApplication $application) {

        $rules = [
            'submission_signature' => [
                'required',
                'string',
                'max:191',
            ],
            'submission_date' => [
                'required',
                'string',
                'max:191',
           ]
        ];
        return Validator::make($application->toArray(), $rules);
    }

    public function affirmationComplete(JobApplication $application) {

        return $this->affirmationValidator($application)->passes();
    }
}


1			<?php
2
			0 ignored issues – show Coding Style introduced 2018-10-14 23:32 UTC by Report Bug Copy Issue Report Missing file doc comment Loading history...
3			namespace App\Services\Validation;
4
5			use App\Models\JobApplication;
6			use Illuminate\Support\Facades\Validator;
7			use Illuminate\Validation\Rule;
8			use Illuminate\Validation\Validator as BaseValidator;
9			use App\Models\Lookup\CitizenshipDeclaration;
10			use App\Models\Lookup\CriteriaType;
11			use App\Models\Lookup\VeteranStatus;
12			use App\Models\Lookup\PreferredLanguage;
13			use App\Services\Validation\Rules\ContainsObjectWithAttributeRule;
14			use App\Services\Validation\JobApplicationAnswerValidator;
15
16			class ApplicationValidator {
			0 ignored issues – show Coding Style introduced 2018-12-07 23:36 UTC by Report Bug Copy Issue Report Missing doc comment for class ApplicationValidator Loading history... Coding Style introduced 2018-12-07 23:36 UTC by Report Bug Copy Issue Report Opening brace of a class must be on the line after the definition Loading history...
17
18			protected $citizenship_ids;
19			protected $veteran_status_ids;
20			protected $preferred_language_ids;
21
22			public function __construct() {
			0 ignored issues – show Coding Style introduced 2018-12-07 23:36 UTC by Report Bug Copy Issue Report Missing doc comment for function __construct() Loading history...
23			$this->citizenship_ids = CitizenshipDeclaration::all()->pluck('id')->toArray();
24			$this->veteran_status_ids = VeteranStatus::all()->pluck('id')->toArray();
25			$this->preferred_language_ids = PreferredLanguage::all()->pluck('id')->toArray();
26			}
27
28			public function validate(JobApplication $application) {
			0 ignored issues – show Coding Style introduced 2018-10-14 23:32 UTC by Report Bug Copy Issue Report Missing doc comment for function validate() Loading history...
29
30			$backendRules = [
31			'job_poster_id' => 'required',
32			'application_status_id' => 'required',
33			'applicant_id' => 'required'
34			];
35
36			$rules = array_merge(
37			$backendRules,
38			$this->basicsValidator($application)->getRules(),
39			$this->experienceValidator($application)->getRules(),
40			$this->essentialSkillsValidator($application)->getRules(),
41			$this->affirmationValidator($application)->getRules()
42			);
43
44			//Validate basic data is filled in
45			Validator::make($application->toArray(), $rules)->validate();
46			}
47
48			protected function arrayMapKeys($fn, $array) {
			0 ignored issues – show Coding Style introduced 2018-12-13 21:45 UTC by Report Bug Copy Issue Report Missing doc comment for function arrayMapKeys() Loading history...
49			$newArray = [];
50			foreach($array as $key => $value) {
			0 ignored issues – show Coding Style introduced 2018-12-07 23:36 UTC by Report Bug Copy Issue Report Expected "foreach (...) {\n"; found "foreach(...) {\n" Loading history...
51			$newArray[$fn($key)] = $value;
52			}
53			return $newArray;
54			}
55
56			protected function addNestedValidatorRules($nestedAttribute, $validatorRules, $rules = []) {
			0 ignored issues – show Coding Style introduced 2018-12-13 20:56 UTC by Report Bug Copy Issue Report Missing doc comment for function addNestedValidatorRules() Loading history...
57			// prepend the attribute name of each validator rule with the nested attribute name
58			$newRules = $this->arrayMapKeys(function($key) use ($nestedAttribute) {
			0 ignored issues – show Coding Style introduced 2018-12-07 23:36 UTC by Report Bug Copy Issue Report The opening parenthesis of a multi-line function call should be the last content on the line. Loading history...
59			return implode('.', [$nestedAttribute, $key]);
60			},
			0 ignored issues – show Coding Style introduced 2018-12-13 20:56 UTC by Report Bug Copy Issue Report Closing brace indented incorrectly; expected 8 spaces, found 12 Loading history...
61			$validatorRules);
			0 ignored issues – show Coding Style introduced 2018-12-13 20:56 UTC by Report Bug Copy Issue Report For multi-line function calls, the closing parenthesis should be on a new line. If a function call spawns multiple lines, the coding standard suggests to move the closing parenthesis to a new line: someFunctionCall( $firstArgument, $secondArgument, $thirdArgument ); // Closing parenthesis on a new line. Loading history...
62			//Merge new rules with old rules
63			$rules = array_merge($rules, $newRules);
64			return $rules;
65			}
66
67			public function basicsValidator(JobApplication $application) {
			0 ignored issues – show Coding Style introduced 2018-12-07 23:36 UTC by Report Bug Copy Issue Report Missing doc comment for function basicsValidator() Loading history...
68			// Validate the fields common to every application
69			$rules = [
70			'citizenship_declaration_id' => ['required', Rule::in($this->citizenship_ids)],
71			'veteran_status_id' => ['required', Rule::in($this->veteran_status_ids)],
72			'preferred_language_id' => ['required', Rule::in($this->preferred_language_ids)],
73			];
74
75			//Load application answers so they are included in application->toArray()
76			$application->load('job_application_answers');
77
78			// Validate that each question has been answered
79			$jobPosterQuestionRules = [];
80			foreach($application->job_poster->job_poster_questions as $question) {
			0 ignored issues – show Coding Style introduced 2018-12-07 23:36 UTC by Report Bug Copy Issue Report Expected "foreach (...) {\n"; found "foreach(...) {\n" Loading history...
81			$jobPosterQuestionRules[] = new ContainsObjectWithAttributeRule('job_poster_question_id', $question->id);
82			}
83			$rules['job_application_answers'] = $jobPosterQuestionRules;
84			$answerValidatorFactory = new JobApplicationAnswerValidator($application);
85
86			//Validate that each answer is complete
87			foreach($application->job_application_answers as $key=>$answer) {
			0 ignored issues – show Coding Style introduced 2018-12-07 23:36 UTC by Report Bug Copy Issue Report Expected "foreach (...) {\n"; found "foreach(...) {\n" Loading history...
88			$attribute = implode('.', ['job_application_answers', $key]);
89			$rules = $this->addNestedValidatorRules($attribute, $answerValidatorFactory->rules(), $rules);
90			}
91
92			$validator = Validator::make($application->toArray(), $rules);
93			return $validator;
94			}
95
96			public function basicsComplete(JobApplication $application) {
			0 ignored issues – show Coding Style introduced 2018-12-07 23:36 UTC by Report Bug Copy Issue Report Missing doc comment for function basicsComplete() Loading history...
97			$validator = $this->basicsValidator($application);
98			return $validator->passes();
99			}
100
101			public function experienceValidator(JobApplication $application) {
			0 ignored issues – show Coding Style introduced 2018-12-13 22:08 UTC by Report Bug Copy Issue Report Missing doc comment for function experienceValidator() Loading history...
102			$rules = ['experience_saved' => 'required\|boolean\|accepted'];
103			return Validator::make($application->toArray(), $rules);
104			}
105
106			public function experinceComplete(JobApplication $application) {
			0 ignored issues – show Coding Style introduced 2018-12-13 22:08 UTC by Report Bug Copy Issue Report Missing doc comment for function experinceComplete() Loading history...
107			return $this->experienceValidator($application)->passes();
108			}
109
110			protected function skillsValidator(JobApplication $application, $criteria_type) {
			0 ignored issues – show Coding Style introduced 2018-12-13 20:56 UTC by Report Bug Copy Issue Report Missing doc comment for function skillsValidator() Loading history...
111			$rules = [];
112
113			$skillDeclarationRules = [];
114			$criteriaTypeId = CriteriaType::where('name', $criteria_type)->firstOrFail()->id;
115			foreach($application->job_poster->criteria->where('criteria_type_id', $criteriaTypeId) as $criteria) {
			0 ignored issues – show Coding Style introduced 2018-12-13 19:34 UTC by Report Bug Copy Issue Report Expected "foreach (...) {\n"; found "foreach(...) {\n" Loading history...
116			//Validate that every essential skill has a corresponding declaration
117			$skillDeclarationRules[] = new ContainsObjectWithAttributeRule('skill_id', $criteria->skill_id);
118			}
119			$rules['skill_declarations'] = $skillDeclarationRules;
120			$application->applicant->load('skill_declarations');
121
122			//Validate that those declarations are complete
123			$skilDeclarationValidatorFactory = new SkillDeclarationValidator($application->applicant);
124			$relevantSkillIds = $application->job_poster->criteria->where('criteria_type_id', $criteriaTypeId)->pluck('skill_id');
125			foreach( $application->skill_declarations as $key=>$declaration) {
			0 ignored issues – show Coding Style introduced 2018-12-13 21:45 UTC by Report Bug Copy Issue Report Expected "foreach (...) {\n"; found "foreach(...) {\n" Loading history...
126			if ($relevantSkillIds->contains($declaration->skill_id)) {
127			$attribute = implode('.', ['skill_declarations', $key]);
128			$skillDeclarationValidator = $skilDeclarationValidatorFactory->validator($declaration);
129			$rules = $this->addNestedValidatorRules($attribute, $skillDeclarationValidator->getRules(), $rules);
130			}
131			}
132
133			$validator = Validator::make($application->toArray(), $rules);
134			return $validator;
135			}
136
137			public function essentialSkillsValidator(JobApplication $application) {
			0 ignored issues – show Coding Style introduced 2018-12-13 19:34 UTC by Report Bug Copy Issue Report Missing doc comment for function essentialSkillsValidator() Loading history...
138			return $this->skillsValidator($application, 'essential');
139			}
140
141			public function essentialSkillsComplete(JobApplication $application) {
			0 ignored issues – show Coding Style introduced 2018-12-13 20:56 UTC by Report Bug Copy Issue Report Missing doc comment for function essentialSkillsComplete() Loading history...
142			return $this->essentialSkillsValidator($application)->passes();
143			}
144
145			public function assetSkillsValidator(JobApplication $application) {
			0 ignored issues – show Coding Style introduced 2018-12-13 20:56 UTC by Report Bug Copy Issue Report Missing doc comment for function assetSkillsValidator() Loading history...
146			return $this->skillsValidator($application, 'asset');
147			}
148
149			public function assetSkillsComplete(JobApplication $application) {
			0 ignored issues – show Coding Style introduced 2018-12-13 20:56 UTC by Report Bug Copy Issue Report Missing doc comment for function assetSkillsComplete() Loading history...
150			return $this->assetSkillsValidator($application)->passes();
151			}
152
153			public function affirmationValidator(JobApplication $application) {
			0 ignored issues – show Coding Style introduced 2018-12-13 20:56 UTC by Report Bug Copy Issue Report Missing doc comment for function affirmationValidator() Loading history...
154			$rules = [
155			'submission_signature' => [
156			'required',
157			'string',
158			'max:191',
159			],
160			'submission_date' => [
161			'required',
162			'string',
163			'max:191',
164			]
165			];
166			return Validator::make($application->toArray(), $rules);
167			}
168
169			public function affirmationComplete(JobApplication $application) {
			0 ignored issues – show Coding Style introduced 2018-12-13 20:56 UTC by Report Bug Copy Issue Report Missing doc comment for function affirmationComplete() Loading history...
170			return $this->affirmationValidator($application)->passes();
171			}
172			}
173

GCTC-NTGC / TalentCloud

Push — feature/application_tracker_va... ( b06851...be6d1a )

ApplicationValidator::experienceValidator() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like