AuthServiceProvider::defineGates() - Code Metrics - Inspection of "Merge branch 'dev' into feature/resources" - GCTC-NTGC/TalentCloud - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — feature/resources ( 00a731...ac736e )

by Yonathan

created 2020-02-19 20:10 UTC

AuthServiceProvider::defineGates() D

↳ Parent: Project

Complexity

Conditions	21
Paths	1

Size

Total Lines	77
Code Lines	36

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
eloc	36
dl	0
loc	77
rs	4.1666
c	1
b	0
f	0
cc	21
nc	1
nop	0

How to fix Long Method Complexity

<?php

namespace App\Providers;

use Illuminate\Support\Facades\Auth;
use Illuminate\Foundation\Support\Providers\AuthServiceProvider as ServiceProvider;
use Illuminate\Support\Facades\Gate;
use App\Models\Applicant;
use App\Models\Course;
use App\Models\Degree;
use App\Models\Manager;
use App\Models\JobPoster;
use App\Models\Reference;
use App\Models\WorkSample;
use App\Models\JobApplication;
use App\Models\WorkExperience;
use App\Models\SkillDeclaration;
use App\Models\Assessment;
use App\Models\RatingGuideQuestion;
use App\Models\RatingGuideAnswer;
use App\Models\AssessmentPlanNotification;
use App\Models\HrAdvisor;
use App\Models\User;
use App\Policies\UserPolicy;
use App\Policies\JobPolicy;
use App\Policies\CoursePolicy;
use App\Policies\DegreePolicy;
use App\Policies\ManagerPolicy;
use App\Policies\ApplicantPolicy;
use App\Policies\ReferencePolicy;
use App\Policies\ApplicationPolicy;
use App\Policies\SkillDeclarationPolicy;
use App\Policies\WorkExperiencePolicy;
use App\Policies\WorkSamplePolicy;
use App\Policies\AssessmentPolicy;
use App\Policies\RatingGuideQuestionPolicy;
use App\Policies\RatingGuideAnswerPolicy;
use App\Policies\AssessmentPlanNotificationPolicy;
use App\Policies\HrAdvisorPolicy;

class AuthServiceProvider extends ServiceProvider
{
    /**
     * The policy mappings for the application.
     *
     * @var array
     */
    protected $policies = [
        User::class => UserPolicy::class,
        Applicant::class => ApplicantPolicy::class,
        Manager::class => ManagerPolicy::class,
        JobPoster::class => JobPolicy::class,
        JobApplication::class => ApplicationPolicy::class,
        Course::class => CoursePolicy::class,
        Degree::class => DegreePolicy::class,
        Reference::class => ReferencePolicy::class,
        SkillDeclaration::class => SkillDeclarationPolicy::class,
        WorkExperience::class => WorkExperiencePolicy::class,
        WorkSample::class => WorkSamplePolicy::class,
        Assessment::class => AssessmentPolicy::class,
        RatingGuideQuestion::class => RatingGuideQuestionPolicy::class,
        RatingGuideAnswer::class => RatingGuideAnswerPolicy::class,
        AssessmentPlanNotification::class =>  AssessmentPlanNotificationPolicy::class,
        HrAdvisor::class => HrAdvisorPolicy::class,
    ];

    /**
     * Define any authorization gates
     *
     * @return void
     */
    protected function defineGates(): void
    {
        Gate::define('view-assessment-plan', function ($user, $jobPoster) {
            return $user->isAdmin() ||
                $user->isManager() && $jobPoster->manager->user_id === $user->id;
        });

        /*
         * Returns true if $user owns a job to which $applicant has applied.
         */
        Gate::define('owns-job-applicant-applied-to', function ($user, $applicant) {
            $applicant_id = $applicant->id;
            $user_id = $user->id;
            return JobPoster::whereHas(
                'manager',
                function ($q) use ($user_id): void {
                    $q->where('user_id', $user_id);
                }
            )->whereHas(
                'submitted_applications',
                function ($q) use ($applicant_id): void {
                    $q->where('applicant_id', $applicant_id);
                }
            )->get()->isNotEmpty();
        });

        /*
         * Returns true if the $user is an hr_advisor which has claimed a job the applicant has applied to,
         * where the job is closed.
         */
        Gate::define('claims-job-applicant-applied-to', function ($user, $applicant) {
            if ($user->isHrAdvisor()) {
                return $applicant->submitted_applications->some(function ($application) use ($user) {
                    return $user->can('manage', $application->job_poster) && $application->job_poster->isClosed();
                });
            }
            return false;
        });

        /* Logged-in Users can view themselves. Admins can view everyone. Managers can view
         * Applicants of their Job Posters. HR Advisors can view Managers
         * within their department, and any Applicants of Job Posters created
         * by those managers.
         */

        /* TODO: User roles/permissions are getting a little unruly. I needed to add an
         * additional check alongside isUpgradedManager() because we have an isAdmin()
         * passthrough on that method, which was causing issues on the hr_advisor/manager
         * reference.
         */
        Gate::define('view-user', function ($user, $userProfile) {
            return (
                    // Any user can view themselves.
                    $user->id === $userProfile->id
                ) ||
                (
                    // Admins can view anyone.
                    $user->isAdmin()
                ) ||
                (
                    // Managers should be able to view HR Advisors within their department.
                    ($user->isUpgradedManager() && !$user->isAdmin() && $userProfile->isHrAdvisor() && !$userProfile->isAdmin()) &&
                        ($user->manager->department_id === $userProfile->hr_advisor->department_id)
                ) ||
                (
                    // HR Advisors can view applicants that have applied to Job Posters that have been claimed.
                    ($user->isHrAdvisor() && $userProfile->applicant !== null) &&
                    Gate::forUser($user)->allows('claims-job-applicant-applied-to', $userProfile->applicant)
                ) ||
                (
                    // Managers can view Applicants who have applied to their Job Posters.
                    (!$user->isAdmin() && $user->isUpgradedManager() && $userProfile->applicant !== null) &&
                    Gate::forUser($user)->allows('owns-job-applicant-applied-to', $userProfile->applicant)
                ) ||
                (
                    // Manager profiles are viewable by any logged in User.
                    $user !== null && !$userProfile->isAdmin() && $userProfile->isUpgradedManager()
                );
        });
    }

    public function register(): void
    {
    }

    /**
     * Register any authentication / authorization services.
     *
     * @return void
     */
    public function boot(): void
    {
        $this->registerPolicies();

        $this->defineGates();
    }
}


1			<?php
2
3			namespace App\Providers;
4
5			use Illuminate\Support\Facades\Auth;
6			use Illuminate\Foundation\Support\Providers\AuthServiceProvider as ServiceProvider;
7			use Illuminate\Support\Facades\Gate;
8			use App\Models\Applicant;
9			use App\Models\Course;
10			use App\Models\Degree;
11			use App\Models\Manager;
12			use App\Models\JobPoster;
13			use App\Models\Reference;
14			use App\Models\WorkSample;
15			use App\Models\JobApplication;
16			use App\Models\WorkExperience;
17			use App\Models\SkillDeclaration;
18			use App\Models\Assessment;
19			use App\Models\RatingGuideQuestion;
20			use App\Models\RatingGuideAnswer;
21			use App\Models\AssessmentPlanNotification;
22			use App\Models\HrAdvisor;
23			use App\Models\User;
24			use App\Policies\UserPolicy;
25			use App\Policies\JobPolicy;
26			use App\Policies\CoursePolicy;
27			use App\Policies\DegreePolicy;
28			use App\Policies\ManagerPolicy;
29			use App\Policies\ApplicantPolicy;
30			use App\Policies\ReferencePolicy;
31			use App\Policies\ApplicationPolicy;
32			use App\Policies\SkillDeclarationPolicy;
33			use App\Policies\WorkExperiencePolicy;
34			use App\Policies\WorkSamplePolicy;
35			use App\Policies\AssessmentPolicy;
36			use App\Policies\RatingGuideQuestionPolicy;
37			use App\Policies\RatingGuideAnswerPolicy;
38			use App\Policies\AssessmentPlanNotificationPolicy;
39			use App\Policies\HrAdvisorPolicy;
40
41			class AuthServiceProvider extends ServiceProvider
42			{
43			/**
44			* The policy mappings for the application.
45			*
46			* @var array
47			*/
48			protected $policies = [
49			User::class => UserPolicy::class,
50			Applicant::class => ApplicantPolicy::class,
51			Manager::class => ManagerPolicy::class,
52			JobPoster::class => JobPolicy::class,
53			JobApplication::class => ApplicationPolicy::class,
54			Course::class => CoursePolicy::class,
55			Degree::class => DegreePolicy::class,
56			Reference::class => ReferencePolicy::class,
57			SkillDeclaration::class => SkillDeclarationPolicy::class,
58			WorkExperience::class => WorkExperiencePolicy::class,
59			WorkSample::class => WorkSamplePolicy::class,
60			Assessment::class => AssessmentPolicy::class,
61			RatingGuideQuestion::class => RatingGuideQuestionPolicy::class,
62			RatingGuideAnswer::class => RatingGuideAnswerPolicy::class,
63			AssessmentPlanNotification::class => AssessmentPlanNotificationPolicy::class,
64			HrAdvisor::class => HrAdvisorPolicy::class,
65			];
66
67			/**
68			* Define any authorization gates
69			*
70			* @return void
71			*/
72			protected function defineGates(): void
73			{
74			Gate::define('view-assessment-plan', function ($user, $jobPoster) {
75			return $user->isAdmin() \|\|
76			$user->isManager() && $jobPoster->manager->user_id === $user->id;
77			});
78
79			/*
80			* Returns true if $user owns a job to which $applicant has applied.
81			*/
82			Gate::define('owns-job-applicant-applied-to', function ($user, $applicant) {
83			$applicant_id = $applicant->id;
84			$user_id = $user->id;
85			return JobPoster::whereHas(
86			'manager',
87			function ($q) use ($user_id): void {
88			$q->where('user_id', $user_id);
89			}
90			)->whereHas(
91			'submitted_applications',
92			function ($q) use ($applicant_id): void {
93			$q->where('applicant_id', $applicant_id);
94			}
95			)->get()->isNotEmpty();
96			});
97
98			/*
99			* Returns true if the $user is an hr_advisor which has claimed a job the applicant has applied to,
100			* where the job is closed.
101			*/
102			Gate::define('claims-job-applicant-applied-to', function ($user, $applicant) {
103			if ($user->isHrAdvisor()) {
104			return $applicant->submitted_applications->some(function ($application) use ($user) {
105			return $user->can('manage', $application->job_poster) && $application->job_poster->isClosed();
106			});
107			}
108			return false;
109			});
110
111			/* Logged-in Users can view themselves. Admins can view everyone. Managers can view
112			* Applicants of their Job Posters. HR Advisors can view Managers
113			* within their department, and any Applicants of Job Posters created
114			* by those managers.
115			*/
116
117			/* TODO: User roles/permissions are getting a little unruly. I needed to add an
118			* additional check alongside isUpgradedManager() because we have an isAdmin()
119			* passthrough on that method, which was causing issues on the hr_advisor/manager
120			* reference.
121			*/
122			Gate::define('view-user', function ($user, $userProfile) {
123			return (
124			// Any user can view themselves.
125			$user->id === $userProfile->id
126			) \|\|
127			(
128			// Admins can view anyone.
129			$user->isAdmin()
130			) \|\|
131			(
132			// Managers should be able to view HR Advisors within their department.
133			($user->isUpgradedManager() && !$user->isAdmin() && $userProfile->isHrAdvisor() && !$userProfile->isAdmin()) &&
134			($user->manager->department_id === $userProfile->hr_advisor->department_id)
135			) \|\|
136			(
137			// HR Advisors can view applicants that have applied to Job Posters that have been claimed.
138			($user->isHrAdvisor() && $userProfile->applicant !== null) &&
139			Gate::forUser($user)->allows('claims-job-applicant-applied-to', $userProfile->applicant)
140			) \|\|
141			(
142			// Managers can view Applicants who have applied to their Job Posters.
143			(!$user->isAdmin() && $user->isUpgradedManager() && $userProfile->applicant !== null) &&
144			Gate::forUser($user)->allows('owns-job-applicant-applied-to', $userProfile->applicant)
145			) \|\|
146			(
147			// Manager profiles are viewable by any logged in User.
148			$user !== null && !$userProfile->isAdmin() && $userProfile->isUpgradedManager()
149			);
150			});
151			}
152
153			public function register(): void
154			{
155			}
156
157			/**
158			* Register any authentication / authorization services.
159			*
160			* @return void
161			*/
162			public function boot(): void
163			{
164			$this->registerPolicies();
165
166			$this->defineGates();
167			}
168			}
169

GCTC-NTGC / TalentCloud

Push — feature/resources ( 00a731...ac736e )

AuthServiceProvider::defineGates() D

Complexity

Size

Duplication

Importance

How to fix Long Method Complexity

Long Method

Duplication Side-by-Side

Filter issues like