bristol-su / assign-roles

app/CompletionConditions/RequiredPositionsFilled.php

<?php

namespace BristolSU\Module\AssignRoles\CompletionConditions;

use BristolSU\ControlDB\Contracts\Models\Group;
use BristolSU\ControlDB\Contracts\Models\Role;
use BristolSU\ControlDB\Contracts\Repositories\Position;
use BristolSU\ControlDB\Contracts\Repositories\Role as RoleRepository;
use BristolSU\Module\AssignRoles\Fields\RequiredPositions;
use BristolSU\Module\AssignRoles\Support\LogicRoleRepository;
use BristolSU\Module\AssignRoles\Support\RequiredSettingRetrieval;
use BristolSU\Module\AssignRoles\Support\SettingRetrievalException;
use BristolSU\Support\ActivityInstance\ActivityInstance;
use BristolSU\Support\Completion\Contracts\CompletionCondition;
use BristolSU\Support\Logic\Contracts\Audience\LogicAudience;
use BristolSU\Support\Logic\Contracts\LogicRepository;
use BristolSU\Support\Logic\Facade\LogicTester;
use BristolSU\Support\ModuleInstance\Contracts\ModuleInstance;
use FormSchema\Generator\Field;
use FormSchema\Schema\Form;
use Illuminate\Support\Collection;

class RequiredPositionsFilled extends CompletionCondition
{

    /**
     * @var RoleRepository
     */
    private $roleRepository;

Private member variable "roleRepository" must be prefixed with an underscore

    public function __construct(string $moduleAlias, RoleRepository $roleRepository)

Missing doc comment for function __construct()

    {
        parent::__construct($moduleAlias);
        $this->roleRepository = $roleRepository;
    }

    /**

Missing short description in doc comment

Parameter $settings should have a doc-comment as per coding-style.

Parameter $activityInstance should have a doc-comment as per coding-style.

Parameter $moduleInstance should have a doc-comment as per coding-style.

     * @inheritDoc
     */
    public function isComplete($settings, ActivityInstance $activityInstance, ModuleInstance $moduleInstance): bool
    {
        try {
            $remainingPositions = $this->positionsStillToFill($settings, $activityInstance, $moduleInstance);
        } catch (SettingRetrievalException $e) {
            return false;
        }
       
       return count($remainingPositions) === 0;

Line indented incorrectly; expected at least 8 spaces, found 7

    }
    
    public function percentage($settings, ActivityInstance $activityInstance, ModuleInstance $moduleInstance): int
    {
        $group = $this->getGroup($activityInstance);

        try {
            $requiredPositions = $this->getRequiredPositions($settings, $group);
            $remainingPositions = $this->positionsStillToFill($settings, $activityInstance, $moduleInstance);
        } catch (SettingRetrievalException $e) {
            return false;
        }
        
        if(count($requiredPositions) === 0) {
            return 100;
        }
        
        $filled = count($requiredPositions) - count($remainingPositions);
        
        $percentage = (int) round(($filled/count($requiredPositions)) * 100, 0);

        if($percentage > 100) {
            return 100;
        }
        return $percentage;
    }

    protected function positionsStillToFill($settings, ActivityInstance $activityInstance, ModuleInstance $moduleInstance)

Missing doc comment for function positionsStillToFill()

    {
        $group = $this->getGroup($activityInstance);
        $roles = $this->rolesThroughGroup($group, $moduleInstance)->filter(function(Role $role) {

The opening parenthesis of a multi-line function call should be the last content on the line.

Expected 1 space after FUNCTION keyword; 0 found

            return $role->users()->count() > 0;
        });
        
        return collect($this->getRequiredPositions($settings, $group))->filter(function(int $positionId) use ($roles) {

The opening parenthesis of a multi-line function call should be the last content on the line.

Expected 1 space after FUNCTION keyword; 0 found

            return $roles->filter(function(Role $role) use ($positionId) {
                return $role->positionId() === $positionId;
            })->count() === 0;
        });
    }
    
    /**
     * @inheritDoc
     */
    public function options(): Form
    {
        return \FormSchema\Generator\Form::make()->withField(
            Field::make(RequiredPositions::class, 'required')
                ->label('Required Positions')->featured(true)->required(true)
                ->default([])->hint('Define which positions are required')
                ->help('Define the positions that are required for any given logic group')
                ->logic($this->getLogic())
                ->positions($this->getPositions())
        )->getSchema();
    }

    /**
     * @inheritDoc
     */
    public function name(): string
    {
        return 'Required Positions are filled';
    }

    /**
     * @inheritDoc
     */
    public function description(): string
    {
        return 'Positions that are marked as required for a group have been filled';
    }

    /**
     * @inheritDoc
     */
    public function alias(): string
    {
        return 'required_positions_are_filled';
    }

    private function getLogic()
    {
        try {
            return collect(app(LogicRepository::class)->all());
        } catch (\Exception $e) {
            return collect();
        }
    }

    private function getPositions()
    {
        try {
            return collect(app(Position::class)->all());
        } catch (\Exception $e) {
            return collect();
        }
    }

    /**
     * Get the group from an activity instance
     * 
     * @param ActivityInstance $activityInstance

Missing parameter comment

Tag value for @param tag indented incorrectly; expected 2 spaces but found 1

     * @return Group|\BristolSU\ControlDB\Models\Group

Tag @return cannot be grouped with parameter tags in a doc comment

     */
    private function getGroup(ActivityInstance $activityInstance)

Private method name "RequiredPositionsFilled::getGroup" must be prefixed with an underscore

    {
        if($activityInstance->resource_type === 'group') {
            return $activityInstance->participant();

The expression return $activityInstance->participant() also could return the type BristolSU\ControlDB\Models\Role|BristolSU\ControlDB\Models\User which is incompatible with the documented return type BristolSU\ControlDB\Contracts\Models\Group|BristolSU\ControlDB\Models\Group.

        }
        return $activityInstance->participant()->group();

The expression return $activityInstance->participant()->group() also could return the type Illuminate\Database\Eloquent\Builder which is incompatible with the documented return type BristolSU\ControlDB\Contracts\Models\Group|BristolSU\ControlDB\Models\Group.

    }

    private function getRequiredPositions(array $settings, Group $group)
    {
        return app(RequiredSettingRetrieval::class)->getSettings($group, $settings);
    }

    private function rolesThroughGroup(Group $group, ModuleInstance $moduleInstance)

Private method name "RequiredPositionsFilled::rolesThroughGroup" must be prefixed with an underscore

Missing doc comment for function rolesThroughGroup()

    {
        $roles = $group->roles();
        if($this->logicGroupId($moduleInstance) !== null) {

Expected "if (...) {\n"; found "if(...) {\n"

            $logicGroup = app(LogicRepository::class)->getById($this->logicGroupId($moduleInstance));

It seems like $this->logicGroupId($moduleInstance) can also be of type null; however, parameter $id of BristolSU\Support\Logic\Contracts\LogicRepository::getById() does only seem to accept integer, maybe add an additional type check?

            return $roles->filter(function(\BristolSU\ControlDB\Contracts\Models\Role $role) use ($moduleInstance, $logicGroup) {

The import $moduleInstance is not used and could be removed.

The opening parenthesis of a multi-line function call should be the last content on the line.

Expected 1 space after FUNCTION keyword; 0 found

                return LogicTester::evaluate($logicGroup, null, $role->group(), $role);
            })->values();

For multi-line function calls, the closing parenthesis should be on a new line.

        }
        return $roles;
    }

    private function logicGroupId(ModuleInstance $moduleInstance)

Private method name "RequiredPositionsFilled::logicGroupId" must be prefixed with an underscore

Missing doc comment for function logicGroupId()

    {
        $id = $moduleInstance->setting('logic_group', null);
        if($id === null) {
            return null;
        }
        return (int) $id;
    }
    
}